dockware-core/ai.dockware.core.documents.models

Package-level declarations

Types

data class Document(val id: String? = null, val shipmentId: String, val documentType: String, val title: String? = null, val scanId: String? = null, val jobId: String? = null, val imagesPaths: List<String> = emptyList(), val data: Map<String, Any>? = null, val createdAt: String? = null, val updatedAt: String? = null, val createdById: String? = null)

Public document model without serialization annotations

DocumentInput

data class DocumentInput(val shipmentId: String, val documentType: String, val scanId: String? = null, val jobId: String? = null, val title: String? = null, val imagesPaths: List<String> = emptyList(), val data: Map<String, Any>? = null)

Public document input model without serialization annotations

DocumentUploadJob

data class DocumentUploadJob(val jobId: String, val message: String)

A pick ticket upload job.

DocumentUploadJobStatus

data class DocumentUploadJobStatus(val jobType: String, val organizationId: String? = null, val createdById: String? = null, val inputParams: Map<String, Any?> = emptyMap(), val metadata: Map<String, Any?>? = null, val id: String, val status: String, val progressPercent: Int = 0, val progressCurrent: Int = 0, val progressTotal: Int = 0, val progressMessage: String? = null, val createdAt: String? = null, val startedAt: String? = null, val completedAt: String? = null, val updatedAt: String? = null, val resultData: PickTicketData? = null, val errorDetails: Map<String, Any?>? = null)

Public job status without serialization

HandlingUnit

data class HandlingUnit(val id: String = "", val weight: Float? = null, val type: String? = null, val height: Float? = null, val length: Float? = null, val width: Float? = null, val freightClass: String? = null, val description: String? = null, val quantity: Int? = 1, val imageUrl: String? = null)

Represents a handling unit (pallet/package) with dimensions

PickTicketData

data class PickTicketData(val referenceId: String = "", val originLocationId: String = "", val proNumber: String? = null, val bolNumber: String? = null, val carrierName: String? = null, val totalWeight: Float? = null, val destination: PickTicketData.DestinationDetails = DestinationDetails(), val handlingUnits: List<HandlingUnit> = emptyList(), val createdAt: String? = null, val updatedAt: String? = null)

Represents a Pick Ticket with all associated data