Zync SDK/zync.api.user.models

Package-level declarations

Types

GetUserCountResult

sealed class GetUserCountResult

Result type for getting user count.

GetUserResult

sealed class GetUserResult

Result type for getting a single user.

GetUsersResult

sealed class GetUsersResult

Result type for getting multiple users.

SkillSet

data class SkillSet(val skillSetUid: String?, val skillSetName: String)

User

data class User(val userUid: String, val firstName: String, val lastName: String? = null, val email: String, val empCode: String? = null, val designation: String? = null, val prefix: String? = null, val externalLoginId: String? = null, val profilePicture: String? = null, val hourlyLaborCharge: Double? = null, val isActive: Boolean = true, val role: UserRole? = null, val contacts: List<UserContact> = emptyList(), val skills: List<UserSkillSet>?, val teams: List<Team>?, val createdAt: String, val updatedAt: String, val syncedAt: String? = null)

Domain model representing a User in the Zuper system.

UserChangeEvent

sealed class UserChangeEvent

Event types for user change notifications.

UserContact

data class UserContact(val type: UserContactType, val value: String, val isPrimary: Boolean = false)

Domain model representing user contact information.

UserContactType

enum UserContactType : Enum<UserContactType>

Enum representing different types of user contacts.

UserError

sealed class UserError : Exception

Sealed class representing different types of user-related errors.

UserPermission

data class UserPermission(val permissionKey: String, val permissionName: String, val permissionDescription: String? = null, val module: String? = null)

Domain model representing a permission within a role.

UserResult

sealed class UserResult

Result wrapper for user operations.

UserRole

data class UserRole(val roleUid: String, val roleKey: String, val roleName: String, val roleDescription: String?, val permissions: List<UserPermission>)

Domain model representing a user role with permissions.

UserRoleType

enum UserRoleType : Enum<UserRoleType>

Enum representing common user role types in Zuper.

UserSkillSet

data class UserSkillSet(val userSkillsUid: String, val skillLevel: Int?, val startDate: String?, val endDate: String?, val skillSet: SkillSet)

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?)

Functions

toZyncCreatedByUser

fun User.toZyncCreatedByUser(): ZyncCreatedByUser

Convert User domain model to ZyncCreatedByUser. This extension function can be reused across the codebase wherever User → ZyncCreatedByUser conversion is needed.