Zync SDK/zync.api.project.models

Package-level declarations

Types

data class ZyncAssociatedProject(val projectUid: String, val prefix: String?, val projectNumber: Int, val projectImageUrl: String?, val projectName: String, val projectPriority: ZyncProjectPriority, val statusUid: String, val statusName: String, val statusType: ZyncProjectStatusType, val statusColor: String?, val categoryName: String?, val projectStartDate: String?, val projectEndDate: String?, val dueDate: String?, val projectConfig: ZyncProjectConfig?)

ZyncProject

data class ZyncProject(val projectUid: String, val projectPrefix: String? = null, val projectNumber: Int, val projectName: String, val projectPriority: ZyncProjectPriority = ZyncProjectPriority.MEDIUM, val projectDescription: String? = null, val projectImageUrl: String? = null, val projectStartDate: String? = null, val projectEndDate: String? = null, val projectDueDate: String? = null, val customerUid: String? = null, val customer: ZyncCustomer? = null, val organizationUid: String? = null, val organization: ZyncOrganization? = null, val projectManagerUid: String? = null, val projectManager: User? = null, val projectCategoryUid: String? = null, val projectCategory: ZyncProjectCategory? = null, val pricelistUid: String? = null, val currentStatusUid: String? = null, val currentStatusName: String? = null, val currentStatusType: ZyncProjectStatusType = ZyncProjectStatusType.PENDING, val currentStatusColor: String? = null, val isActive: Boolean = true, val isBillable: Boolean = true, val restrictToProjectProducts: Boolean = false, val syncProductsToJobs: Boolean = false, val projectTags: List<String> = emptyList(), val projectDependencies: List<ZyncProjectDependency> = emptyList(), val serviceAddress: ZyncProjectAddress? = null, val billingAddress: ZyncProjectAddress? = null, val customFields: List<ZyncProjectCustomField> = emptyList(), val progressiveInvoice: ZyncProjectProgressiveInvoice? = null, val projectConfig: ZyncProjectConfig? = null, val assignments: List<ZyncProjectAssignment> = emptyList(), val statusHistory: List<ZyncProjectStatusHistory> = emptyList(), val phases: List<ZyncProjectPhase> = emptyList(), val milestones: List<ZyncProjectMilestone> = emptyList(), val properties: List<ZyncProjectPropertyAssociation> = emptyList(), val assets: List<ZyncProjectAssetAssociation> = emptyList(), val contracts: List<ZyncProjectContractAssociation> = emptyList(), val jobs: List<ZyncProjectJobAssociation> = emptyList(), val products: List<ZyncProjectProductAssociation> = emptyList(), val attachments: List<String> = emptyList(), val companyUid: String, val createdAt: String, val updatedAt: String? = null, val syncedAt: String? = null)

Domain model representing a Project in the Zuper system.

ZyncProjectAddress

data class ZyncProjectAddress(val label: String? = null, val street: String? = null, val city: String? = null, val state: String? = null, val country: String? = null, val landmark: String? = null, val zipCode: String? = null, val latitude: Double? = null, val longitude: Double? = null, val contactFirstName: String? = null, val contactLastName: String? = null, val contactPhoneNumber: String? = null, val contactEmail: String? = null, val isPrimary: Boolean = false)

Domain model representing project address.

ZyncProjectAssetAssociation

data class ZyncProjectAssetAssociation(val projectUid: String, val assetUid: String, val asset: ZyncAsset? = null, val serviceLevel: String? = null, val maintenanceSchedule: String? = null, val warrantyCoverage: Boolean = false, val notes: String? = null, val createdAt: String)

Domain model representing project asset association.

ZyncProjectAssignment

data class ZyncProjectAssignment(val projectUid: String, val userUid: String? = null, val user: User? = null, val teamUid: String? = null, val team: Team? = null, val assignmentType: ZyncProjectAssignmentType, val projectRole: ZyncProjectRole = ZyncProjectRole.MEMBER, val isPrimary: Boolean = false, val assignedAt: String, val assignedByUid: String? = null, val assignedBy: User? = null, val acceptanceStatus: ZyncProjectAssignmentStatus = ZyncProjectAssignmentStatus.PENDING)

Domain model representing project assignment.

ZyncProjectAssignmentStatus

enum ZyncProjectAssignmentStatus : Enum<ZyncProjectAssignmentStatus>

Enum representing project assignment statuses.

ZyncProjectAssignmentType

enum ZyncProjectAssignmentType : Enum<ZyncProjectAssignmentType>

Enum representing project assignment types.

ZyncProjectBillingConfig

data class ZyncProjectBillingConfig(val invoicingFrequency: String? = null, val paymentTerms: String? = null, val taxConfiguration: Map<String, String> = emptyMap())

Domain model representing project billing configuration.

ZyncProjectCategory

data class ZyncProjectCategory(val categoryUid: String, val categoryName: String, val categoryDescription: String? = null, val categoryColor: String? = null, val isActive: Boolean = true, val parentCategoryUid: String? = null, val parentCategory: ZyncProjectCategory? = null, val companyUid: String, val createdAt: String, val updatedAt: String? = null)

Domain model representing a project category.

ZyncProjectChangeEvent

sealed class ZyncProjectChangeEvent

Event types for project change notifications.

ZyncProjectConfig

data class ZyncProjectConfig(val projectProductConfig: ZyncProjectProductConfig? = null, val billingConfig: ZyncProjectBillingConfig? = null, val notificationConfig: ZyncProjectNotificationConfig? = null)

Domain model representing project configuration.

ZyncProjectContractAssociation

data class ZyncProjectContractAssociation(val projectUid: String, val contractUid: String, val contract: ZyncContract? = null, val contractRole: String? = null, val billingResponsibility: Boolean = false, val notes: String? = null, val createdAt: String)

Domain model representing project contract association.

ZyncProjectCustomField

data class ZyncProjectCustomField(val label: String, val value: String? = null, val type: String? = null, val isRequired: Boolean = false, val isReadOnly: Boolean = false, val isHidden: Boolean = false, val groupUid: String? = null, val groupName: String? = null, val moduleRef: String? = null)

Domain model representing project custom field.

ZyncProjectDependency

data class ZyncProjectDependency(val dependencyUid: String, val dependentProjectUid: String? = null, val dependentPhaseUid: String? = null, val dependentMilestoneUid: String? = null, val dependencyType: ZyncProjectDependencyType, val description: String? = null)

Domain model representing project dependency.

ZyncProjectDependencyType

enum ZyncProjectDependencyType : Enum<ZyncProjectDependencyType>

Enum representing project dependency types.

ZyncProjectError

sealed class ZyncProjectError : Exception

Sealed class representing different types of project-related errors.

ZyncProjectInvoiceConfiguration

data class ZyncProjectInvoiceConfiguration(val autoGenerate: Boolean = false, val billingSchedule: String? = null, val paymentTerms: String? = null)

Domain model representing project invoice configuration.

ZyncProjectJobAssociation

data class ZyncProjectJobAssociation(val projectUid: String, val jobUid: String, val phaseUid: String? = null, val isMilestoneJob: Boolean = false, val milestoneUid: String? = null, val jobSequence: Int? = null, val notes: String? = null, val createdAt: String)

Domain model representing project job association.

ZyncProjectMilestone

data class ZyncProjectMilestone(val milestoneUid: String, val projectUid: String, val phaseUid: String? = null, val milestoneTitle: String, val milestoneDescription: String? = null, val milestoneType: ZyncProjectMilestoneType = ZyncProjectMilestoneType.DELIVERABLE, val dueDate: String? = null, val completedDate: String? = null, val milestoneStatus: ZyncProjectMilestoneStatus = ZyncProjectMilestoneStatus.PENDING, val completionPercentage: Int = 0, val progressiveInvoiceUid: String? = null, val invoiceAmount: Double? = null, val createdAt: String, val updatedAt: String? = null)

Domain model representing a project milestone.

ZyncProjectMilestoneInvoice

data class ZyncProjectMilestoneInvoice(val milestoneUid: String, val invoiceUid: String? = null, val amount: Double, val dueDate: String? = null, val status: String? = null)

Domain model representing project milestone invoice.

ZyncProjectMilestoneStatus

enum ZyncProjectMilestoneStatus : Enum<ZyncProjectMilestoneStatus>

Enum representing project milestone statuses.

ZyncProjectMilestoneType

enum ZyncProjectMilestoneType : Enum<ZyncProjectMilestoneType>

Enum representing project milestone types.

ZyncProjectNotificationConfig

data class ZyncProjectNotificationConfig(val milestoneReminders: Boolean = true, val overdueAlerts: Boolean = true, val statusChangeNotifications: Boolean = true, val recipientUids: List<String> = emptyList())

Domain model representing project notification configuration.

ZyncProjectPhase

data class ZyncProjectPhase(val phaseUid: String, val projectUid: String, val phaseName: String, val phaseDescription: String? = null, val phaseColor: String? = null, val sequenceNo: Int = 0, val isDefault: Boolean = false, val startDate: String? = null, val endDate: String? = null, val phaseStatus: ZyncProjectPhaseStatus = ZyncProjectPhaseStatus.PENDING, val isActive: Boolean = true, val createdAt: String, val updatedAt: String? = null)

Domain model representing a project phase.

ZyncProjectPhaseStatus

enum ZyncProjectPhaseStatus : Enum<ZyncProjectPhaseStatus>

Enum representing project phase statuses.

ZyncProjectPriority

enum ZyncProjectPriority : Enum<ZyncProjectPriority>

Enum representing different project priorities.

ZyncProjectProductAssociation

data class ZyncProjectProductAssociation(val projectUid: String, val productUid: String, val product: Product? = null, val projectQuantity: Double = 1.0, val projectUnitPrice: Double? = null, val projectDiscountPercentage: Double = 0.0, val isRestrictedToProject: Boolean = false, val autoSyncToJobs: Boolean = false, val projectProductNotes: String? = null, val productConfiguration: ZyncProjectProductConfiguration? = null, val createdAt: String, val updatedAt: String? = null)

Domain model representing project product association.

ZyncProjectProductConfig

data class ZyncProjectProductConfig(val restrictToProject: Boolean = false, val syncToProject: Boolean = false)

Domain model representing project product configuration.

ZyncProjectProductConfiguration

data class ZyncProjectProductConfiguration(val allowOverride: Boolean = true, val requireApproval: Boolean = false, val maxQuantity: Double? = null, val customProperties: Map<String, String> = emptyMap())

Domain model representing project product configuration details.

ZyncProjectProgressiveInvoice

data class ZyncProjectProgressiveInvoice(val invoiceConfiguration: ZyncProjectInvoiceConfiguration? = null, val milestoneInvoices: List<ZyncProjectMilestoneInvoice> = emptyList())

Domain model representing project progressive invoice.

ZyncProjectPropertyAssociation

data class ZyncProjectPropertyAssociation(val projectUid: String, val propertyUid: String, val property: ZyncProperty? = null, val isPrimary: Boolean = false, val serviceType: String? = null, val notes: String? = null, val createdAt: String)

Domain model representing project property association.

ZyncProjectResult

sealed class ZyncProjectResult

Result wrapper for project operations.

ZyncProjectRole

enum ZyncProjectRole : Enum<ZyncProjectRole>

Enum representing project roles.

ZyncProjectStats

data class ZyncProjectStats(val totalProjects: Int, val activeProjects: Int, val completedProjects: Int, val overdueProjects: Int, val totalProjectValue: Double? = null, val averageProjectDuration: Double? = null, val completionRate: Double? = null, val statusDistribution: Map<ZyncProjectStatusType, Int>? = null, val topManagers: List<String>? = null)

Data class for project statistics and metrics.

ZyncProjectStatusHistory

data class ZyncProjectStatusHistory(val projectUid: String, val statusUid: String? = null, val statusName: String, val statusType: String, val statusColor: String? = null, val remarks: String? = null, val remarksFreText: String? = null, val changedByUid: String? = null, val changedBy: User? = null, val changedAt: String, val isOffline: Boolean = false, val syncedAt: String? = null)

Domain model representing project status history.

ZyncProjectStatusType

enum ZyncProjectStatusType : Enum<ZyncProjectStatusType>

Enum representing different project status types.