Zync SDK/zync.api.job.models

Package-level declarations

Types

GetJobResult

sealed class GetJobResult

Result type for getting a single job.

JobsResult

sealed class JobsResult

Result type for getting multiple jobs.

ZyncJob

data class ZyncJob(val jobUid: String, val jobTitle: String, val prefix: String?, val workOrderNumber: Int, val scheduledStartTime: String?, val scheduledEndTime: String?, val dueDate: String?, val jobPriority: ZyncJobPriority, val jobCategory: ZyncJobCategory?, val jobStatus: ZyncJobStatus?, val statusHistory: List<ZyncJobStatusHistory>?, val isRecurringJob: Boolean, val customer: ZyncCustomer?, val organization: ZyncOrganization?, val serviceAddress: ZyncAddress?, val billingAddress: ZyncAddress?, val assignedUsers: List<ZyncJobAssignedUser>?, val isSyncPending: Boolean, val timezone: String?)

ZyncJobAsset

data class ZyncJobAsset(val asset: ZyncAsset, val remarks: String?, val submittedFormUid: String?)

ZyncJobAssignedUser

data class ZyncJobAssignedUser(val user: User, val team: Team, val acceptanceStatus: String?, val isPrimary: Boolean)

ZyncJobCategory

data class ZyncJobCategory(val uid: String, val name: String, val description: String?, val slaDuration: ZyncSlaDuration?, val color: String?, val timeLogConfig: ZyncJobCategoryTimeLogConfig?)

Domain model representing a Job Category in the Zuper system.

ZyncJobCategoryTimeLogConfig

data class ZyncJobCategoryTimeLogConfig(val isJobTimerEnabled: Boolean, val isBreakTimerEnabled: Boolean, val isTravelTimer: Boolean)

ZyncJobDetail

data class ZyncJobDetail(val workOrderNumber: Int, val jobCategory: ZyncJobCategory?, val jobUid: String, val jobTitle: String, val jobPriority: ZyncJobPriority, val jobTimezone: String?, val scheduledStartTime: String?, val scheduledEndTime: String?, val dueDate: String?, val customer: ZyncCustomer?, val isRecurringJob: Boolean, val billingAddress: ZyncAddress?, val serviceAddress: ZyncAddress?, val statusHistory: List<ZyncJobStatusHistory>?, val jobTags: List<String>?, val assignedUsers: List<ZyncJobAssignedUser>?, val jobStatus: ZyncJobStatus?, val products: List<ZyncJobProduct>?, val customFields: List<ZyncFormField>, val jobDescription: String?, val parentJob: ZyncJob?, val prefix: String?, val contract: ZyncContract?, val assets: List<ZyncJobAsset>?, val ppm: ZyncPpm?, val organization: ZyncOrganization?, val property: ZyncProperty?, val hasChildJobs: Boolean, val route: ZyncJobRoute?, val skills: List<ZyncSkill>?, val serviceTask: ZyncJobDetailServiceTask?, val isSyncPending: Boolean, val isAssetsSyncPending: Boolean, val attachments: List<ZyncAttachment>, val jobRequest: ZyncJobRequest?, val secondaryContacts: List<ZyncJobSecondaryContact>, val hideToFe: Boolean = false, val hideToUsers: List<String> = emptyList(), val priceList: ZyncPriceList?, val associatedProject: ZyncAssociatedProject?)

Domain model representing a Job in the Zuper system. This is the primary model used throughout the SDK for job operations.

ZyncJobPriority

enum ZyncJobPriority : Enum<ZyncJobPriority>

ZyncJobProduct

data class ZyncJobProduct(val lineItemUid: String?, val productId: String?, val productUid: String?, val productDescription: String?, val brand: String?, val specification: String?, val productName: String, val prefix: String?, val productImage: String?, val quantity: Double?, val currency: String?, val price: Double?, val purchasePrice: Double?, val locationUid: String?, val locationName: String?, val productType: ZyncProductType, val groupId: String?, val uom: String?, val serialNumbers: List<String>?, val markup: ZyncProductMarkup?, val unitPricePreMarkup: Double?, val category: ZyncProductCategory?, val projectLineItemUid: String?, val bundlePricingLevel: ZyncBundlePricingLevel, val bundleItems: List<ZyncAssociatedBundleItem>, val isBillable: Boolean, val discount: Double?, val discountType: String?, val lineItemType: String)

ZyncJobRequest

data class ZyncJobRequest(val requestUid: String, val title: String, val description: String?, val requestStatus: ZyncRequestStatus?, val requestId: Int)

ZyncJobRoute

data class ZyncJobRoute(val isOptimized: Boolean?, val routeName: String, val routeUid: String, val jobs: List<ZyncRouteJob>?, val totalDistance: Int?, val totalJobs: Int?, val totalTime: Int?, val transportMode: ZyncTransportMode, val color: String?, val startLocation: ZyncRouteStartEndLocation?, val endLocation: ZyncRouteStartEndLocation?, val departureDateTime: String?, val polyline: List<ZyncRoutePolyline>?, val isRecurringRoute: Boolean, val assignedUsers: List<ZyncJobRouteAssignedUser>)

ZyncJobRouteAssignedUser

data class ZyncJobRouteAssignedUser(val user: User, val team: Team)

ZyncJobSecondaryContact

data class ZyncJobSecondaryContact(val customerUid: String, val firstName: String, val lastName: String?, val email: String?, val contactNo: ZyncContactNumber?, val isActive: Boolean)

ZyncJobStatus

data class ZyncJobStatus(val statusUid: String, val statusName: String, val statusType: ZyncJobStatusType, val statusColor: String?)

ZyncJobStatusHistory

data class ZyncJobStatusHistory(val localStatusUid: String, val statusUid: String, val statusHistoryUid: String?, val statusName: String, val statusType: ZyncJobStatusType, val statusColor: String?, val remarks: String?, val remarksFreeText: String?, val createdAt: String?, val updatedAt: String?, val customerSignature: String?, val customerSignatureName: String?, val doneBy: User?, val checkList: List<ZyncFormField>?, val isOffline: Boolean, val syncedAt: String?)

ZyncJobStatusType

enum ZyncJobStatusType : Enum<ZyncJobStatusType>

ZyncRecurringRoute

data class ZyncRecurringRoute(val recurringRouteUid: String?)

ZyncRouteJob

data class ZyncRouteJob(val distance: Int?, val geoCords: List<Double>?, val time: Int?, val jobUid: String?, val job: ZyncJob?, val sequence: Int?)

ZyncRoutePolyline

data class ZyncRoutePolyline(val points: List<String>, val jobUid: String?)

ZyncRouteStartEndLocation

data class ZyncRouteStartEndLocation(val geoCords: List<Double>?, val name: String?, val street: String?, val distance: Int?, val time: Int?)

ZyncTransportMode

enum ZyncTransportMode : Enum<ZyncTransportMode>

Functions

forConstant

fun ZyncTransportMode.forConstant(mode: String?): ZyncTransportMode