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

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)

Constructors

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

Properties

val created_at: String

val created_by_id: String

val depth: Float?

Depth/length saved for the scan. Always the largest horizontal dimension.

dimensioningPipelineConfidence

val dimensioningPipelineConfidence: Double?

dimensioningPipelineVersion

val dimensioningPipelineVersion: String?

val dimensions: Dimensions?

finalDimensions

val finalDimensions: String?

finalDimensionsCertified

val finalDimensionsCertified: Boolean

val freight_class: String?

hasBeenReviewed

val hasBeenReviewed: Boolean

hasProcessingError

val hasProcessingError: Boolean

val height: Float?

Height saved for the scan.

val isDocumentScan: Boolean

isPickTicketScan

val isPickTicketScan: Boolean

val isProcessed: Boolean

val isProcessing: Boolean

val latitude: Float?

val longitude: Float?

manualDimensions

val manualDimensions: Dimensions?

val metadata: Map<String, Any?>?

organization_id

val organization_id: String

recent_entry_presigned_url

val recent_entry_presigned_url: String?

val scan_type: ShipmentScanType?

val shipment_id: String

val status: String?

val title: String

val updated_at: String?

val updated_by_id: String?

val user_center: Point3?

val userDepth: Float?

The user depth/length for the scan. Always the largest of the horizontal dimensions.

val userDimensions: Dimensions?

val userHeight: Float?

val userNotes: String?

val userVolume: Float?

userVolumeDisplay

val userVolumeDisplay: String?

val userWidth: Float?

val volume: Float?

Calculate cubic volume in cubic feet.

val weight: Float?

val width: Float?

Width saved for the scan. Always the smallest horizontal dimension.

Functions

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.

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