Zync SDK/zync.api.user.models

Package-level declarations

Types

GetUserCountResult

sealed class GetUserCountResult

Result type for getting user count.

GetUserDetailResult

sealed class GetUserDetailResult

Result type for getting a single user.

GetUsersResult

sealed class GetUsersResult

Result type for getting paginated users list. Contains pagination metadata and partial data indicator.

UserAccessRole

data class UserAccessRole(val accessRoleUid: String, val roleName: String)

Domain model representing a user's access role.

UserRole

data class UserRole(val roleUid: String, val roleKey: String, val roleName: String)

Domain model representing a user role with permissions.

ZyncCreatedByUser

data class ZyncCreatedByUser(val userUid: String, val firstName: String, val lastName: String?, val email: String, val homePhoneNumber: String?, val designation: String?, val empCode: String?, val prefix: String?, val workPhoneNumber: String?, val mobilePhoneNumber: String?, val profilePicture: String?, val isActive: Boolean?, val isDeleted: Boolean?, val createdAt: String?, val updatedAt: String?)

ZyncUser

data class ZyncUser(val userUid: String, val firstName: String, val lastName: String?, val email: String, val designation: String?, val empCode: String?, val prefix: String?, val externalLoginId: String?, val profilePicture: String?, val hourlyLaborCharge: Double?, val role: UserRole?, val accessRole: UserAccessRole?, val homePhoneNumber: String?, val mobilePhoneNumber: String?, val workPhoneNumber: String?, val isActive: Boolean, val isDeleted: Boolean, val createdAt: String?, val updatedAt: String?)

Domain model representing a User in the Zuper system.

ZyncUserDetail

data class ZyncUserDetail(val userUid: String, val firstName: String, val lastName: String?, val email: String?, val profilePicture: String?, val homePhoneNumber: String?, val workPhoneNumber: String?, val mobilePhoneNumber: String?, val designation: String?, val empCode: String?, val userRole: UserRole?, val hourlyLaborCharge: Double?, val isActive: Boolean, val customFields: List<ZyncFormField>)

Represents comprehensive user detail with all related information. This model follows the offline-first approach, providing immediate access to cached data.

ZyncUserRole

enum ZyncUserRole : Enum<ZyncUserRole>

ZyncUserSortAndFilter

data class ZyncUserSortAndFilter(val sortType: ZyncSortType = ZyncSortType.Ascending, val sortBy: ZyncUserSortBy = ZyncUserSortBy.FirstName, val keyword: String? = null, val team: List<ZyncFilterModule>? = null, val isAssignedToTeam: Boolean? = null, val role: ZyncUserRole? = null, val skillSets: List<String>? = null, val isActive: Boolean? = null, val customField: ZyncFilterByCustomField? = null, val populateSkills: Boolean? = null, val populateTeams: Boolean? = null, val usersId: List<String>? = null, val accessRoleUid: List<String>? = null)

ZyncUserSortBy

enum ZyncUserSortBy : Enum<ZyncUserSortBy>

Functions

toZyncCreatedByUser

fun ZyncUser.toZyncCreatedByUser(): ZyncCreatedByUser

toZyncUserDetail

fun ZyncUser.toZyncUserDetail(customFields: List<ZyncFormField> = emptyList()): ZyncUserDetail