dockware-core/ai.dockware.core.shipments.models

Package-level declarations

Types

data class Barcode(val text: String = "", val type: String = "", val scan_id: String = "", val max_confidence: Float = 0.0f, val recognition_count: Int? = null, val symbol: String? = null, val created_at: String? = null, val position: Array<Float> = emptyArray())

Dimensions

data class Dimensions(val length: Float, val width: Float, val height: Float)

LocationData

@Serializable

data class LocationData(val latitude: Double, val longitude: Double)

ParsedDocument

data class ParsedDocument(val jobId: String, val shipmentId: String, val shipmentScanId: String, val bolNumber: String?, val proNumber: String?, val carrierName: String?, val destination: ParsedDocument.Destination?, val totalWeight: Float?, val totalHandlingPieces: Float?)

Shipment

data class Shipment(val id: String = "", val title: String = "", val created_by_id: String = "", val created_at: String = "", val updated_at: String? = null, val archived: String? = null, val barcodes: Map<String, List<Barcode>>? = null, val organization_id: String? = null, val status: String? = null, val description: String? = null, val metadata: Map<String, Any?>? = null)

ShipmentEntry

data class ShipmentEntry(val id: String = "", val shipment_id: String = "", val shipment_scan_id: String = "", val organization_id: String = "", val storage_path: String = "", val type: ShipmentEntryType, val file_name: String = "", val file_size: Long? = null, val created_at: String = "", val created_by_id: String = "")

ShipmentEntryStatus

enum ShipmentEntryStatus : Enum<ShipmentEntryStatus>

ShipmentEntryType

enum ShipmentEntryType : Enum<ShipmentEntryType>

ShipmentScan

data class ShipmentScan(val id: String = "", val shipment_id: String = "", val organization_id: String = "", val title: String = "", reviewedWidth: Float? = null, reviewedHeight: Float? = null, reviewedDepth: Float? = null, user_width: Float? = null, user_height: Float? = null, user_depth: Float? = null, val user_center: Point3? = null, manual_width: Float? = null, manual_height: Float? = null, manual_depth: Float? = null, val weight: Float? = null, val freight_class: String? = null, val latitude: Float? = null, val longitude: Float? = null, val userNotes: String? = null, val status: String? = null, val created_at: String = "", val created_by_id: String = "", val updated_at: String? = null, val updated_by_id: String? = null, val metadata: Map<String, Any?>? = null, val scan_type: ShipmentScanType? = null, val recent_entry_presigned_url: String? = null)

ShipmentScanType

sealed class ShipmentScanType

ShipmentSharing

data class ShipmentSharing(val id: String = "", val created_by_id: String = "", val created_at: String = "", val shipment_id: String = "", val recipient_user_id: String = "", val expiration: String = "", val raw_email: String? = null, val creator_display_info: ShipmentSharing.DisplayInfo? = null, val recipient_display_info: ShipmentSharing.DisplayInfo? = null)

ShipmentSharingLinks

data class ShipmentSharingLinks(val sharedWithMe: List<ShipmentSharing>, val sharedByMe: List<ShipmentSharing>)

ShipmentStorageEntry

data class ShipmentStorageEntry(val entry: ShipmentEntry, val storageObject: StorageObject)

ShipmentTree

data class ShipmentTree(val shipment: Shipment, val scans: List<ShipmentScan> = emptyList(), val recentEntries: List<ShipmentEntry> = emptyList(), val isShared: Boolean = false, val sharedByMeLinks: List<ShipmentSharing> = emptyList(), val sharedWithMeLinks: List<ShipmentSharing> = emptyList())

ShipmentWithSharing

data class ShipmentWithSharing(val shipments: List<Shipment>? = null, val shared_with_user_shipments: List<Shipment>? = null)

StorageObject

data class StorageObject(val key: String, val url: String)

Functions

fetchPlyBytes

suspend fun ShipmentScan.fetchPlyBytes(): ByteArray

Downloads the PLY point cloud bytes for this scan.

fetchPlyBytesWithProgress

fun ShipmentScan.fetchPlyBytesWithProgress(): Flow<DownloadResult>

Downloads the PLY point cloud bytes for this scan, emitting progress updates.

review

suspend fun ShipmentScan.review(approved: Boolean, disapprovalReasons: List<String>? = null): ShipmentScan