FortressApiService

Inheritors

Functions

abstract suspend fun archiveShipment(shipmentId: String, updatedById: String, archived: Boolean = true): Result<ShipmentRO>

archiveShipmentScan

abstract suspend fun archiveShipmentScan(shipmentScanId: String, updatedById: String, archived: Boolean = true): Result<ShipmentScanRO>

createDocument

abstract suspend fun createDocument(documentInput: DocumentInput): Result<DocumentResponse>

createPickTicketShipmentEntry

abstract suspend fun createPickTicketShipmentEntry(shipmentId: String, shipmentScanId: String, jobId: String, fileName: String, createdById: String): Result<ShipmentEntryRO>

createShipment

abstract suspend fun createShipment(body: CreateShipmentRequest): Result<ShipmentRO>

createShipmentScan

abstract suspend fun createShipmentScan(request: CreateShipmentScanRequest): Result<ShipmentScanRO>

createShipmentSharingRecord

abstract suspend fun createShipmentSharingRecord(userId: String, shipmentId: String, recipientEmail: String, expiration: String? = null): Result<ShipmentSharingRO>

delete

abstract suspend fun <T : Any> delete(endpoint: String, body: Any, kClass: KClass<T>): Result<T>

downloadImageFile

abstract suspend fun downloadImageFile(storageKey: String): Result<ByteArray>

downloadPLYFile

abstract suspend fun downloadPLYFile(storageKey: String): Result<ByteArray>

downloadPresignedUrl

abstract suspend fun downloadPresignedUrl(url: String): Result<ByteArray>

fetchApiVersions

abstract suspend fun fetchApiVersions(): Result<ApiVersions>

fetchMinimumApiVersions

abstract suspend fun fetchMinimumApiVersions(): Result<MinimumApiVersionsRO>

fetchMostRecentShipmentEntries

abstract suspend fun fetchMostRecentShipmentEntries(shipmentIds: List<String>, entryType: String): Result<Map<String, ShipmentEntryRO>>

fetchMostRecentShipmentSnapshots

abstract suspend fun fetchMostRecentShipmentSnapshots(shipmentIds: List<String>): Result<Map<String, List<ShipmentEntryRO>>>

fetchOrganization

abstract suspend fun fetchOrganization(organizationId: String): Result<OrganizationRO>

fetchOrganizationMembers

abstract suspend fun fetchOrganizationMembers(profileId: String, organizationId: String): Result<List<UserProfileRO>>

fetchShipmentEntries

abstract suspend fun fetchShipmentEntries(shipmentScanId: String): Result<List<ShipmentEntryRO>>

fetchShipments

abstract suspend fun fetchShipments(userId: String): Result<ShipmentWithSharingRO>

fetchShipmentScans

abstract suspend fun fetchShipmentScans(shipmentId: String): Result<List<ShipmentScanRO>>

abstract suspend fun fetchShipmentScans(shipmentIds: List<String>): Result<Map<String, List<ShipmentScanRO>>>

fetchShipmentSharedRecords

abstract suspend fun fetchShipmentSharedRecords(userId: String): Result<List<ShipmentSharingRO>>

fetchShipmentSharedWithMeRecords

abstract suspend fun fetchShipmentSharedWithMeRecords(userId: String): Result<List<ShipmentSharingRO>>

fetchUserProfile

abstract suspend fun fetchUserProfile(authUserId: String): Result<UserProfileRO>

get

abstract suspend fun <T : Any> get(endpoint: String, kClass: KClass<T>): Result<T>

getJobStatus

abstract suspend fun getJobStatus(jobId: String): Result<JobStatusResponse>

patch

abstract suspend fun <T : Any> patch(endpoint: String, body: Any, kClass: KClass<T>): Result<T>

patchShipment

abstract suspend fun patchShipment(shipmentId: String, request: UpdateShipmentRequest, operationName: String): Result<ShipmentRO>

post

abstract suspend fun <T : Any> post(endpoint: String, body: Any, kClass: KClass<T>): Result<T>

queueProcessingJob

abstract suspend fun queueProcessingJob(shipmentId: String, shipmentScanId: String, data: ByteArray): Result<SnapshotsRO>

renameShipment

abstract suspend fun renameShipment(shipmentId: String, updatedById: String, newTitle: String): Result<ShipmentRO>

setBearerToken

abstract fun setBearerToken(token: String?)

setMyCarrierApiKey

abstract suspend fun setMyCarrierApiKey(mycarrierKey: String?, originLocationId: String?): Result<String>

submitMyCarrierOrder

abstract suspend fun submitMyCarrierOrder(orderRequest: MyCarrierOrderRequest): Result<MyCarrierOrderResponse>

updateDocument

abstract suspend fun updateDocument(documentId: String, data: JsonObject): Result<DocumentResponse>

updateShipmentBarcodes

abstract suspend fun updateShipmentBarcodes(shipmentId: String, updatedById: String, barcodesDto: Map<String, List<BarcodeItemRO>>): Result<ShipmentRO>

updateShipmentScan

abstract suspend fun updateShipmentScan(scanId: String, body: UpdateShipmentScanBaseRequest): Result<ShipmentScanRO>

uploadLogLines

abstract suspend fun uploadLogLines(logList: List<LogEntry>): Result<String>

uploadPickTicketDocument

abstract suspend fun uploadPickTicketDocument(imageData: ByteArray): Result<PickTicketUploadResponse>

uploadShipmentEntry

abstract suspend fun uploadShipmentEntry(organizationId: String, shipmentId: String, shipmentScanId: String, fileName: String, data: ByteArray, type: ShipmentEntryType, createdById: String): Result<Pair<StorageRO, ShipmentEntryRO>>

uploadShipmentScanZip

abstract suspend fun uploadShipmentScanZip(organizationId: String, shipmentId: String, shipmentScanId: String, data: ByteArray): Result<SnapshotsRO>

verifyMyCarrierStatus

abstract suspend fun verifyMyCarrierStatus(overrideAccessToken: String? = null): Result<Boolean>