dockware-core/api/FortressApiServiceImpl

FortressApiServiceImpl

class FortressApiServiceImpl : FortressApiService

Constructors

constructor()

Types

Companion

object Companion

Functions

archiveShipment

open suspend override fun archiveShipment(shipmentId: String, updatedById: String, archived: Boolean): Result<ShipmentRO>

archiveShipmentScan

open suspend override fun archiveShipmentScan(shipmentScanId: String, updatedById: String, archived: Boolean): Result<ShipmentScanRO>

createDocument

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

createPickTicketShipmentEntry

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

createShipment

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

createShipmentScan

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

createShipmentSharingRecord

open suspend override fun createShipmentSharingRecord(userId: String, shipmentId: String, recipientEmail: String, expiration: String?): Result<ShipmentSharingRO>

delete

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

downloadImageFile

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

downloadPLYFile

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

downloadPresignedUrl

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

fetchApiVersions

open suspend override fun fetchApiVersions(): Result<ApiVersions>

fetchMinimumApiVersions

open suspend override fun fetchMinimumApiVersions(): Result<MinimumApiVersionsRO>

fetchMostRecentShipmentEntries

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

fetchMostRecentShipmentSnapshots

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

fetchOrganization

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

fetchOrganizationMembers

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

fetchShipmentEntries

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

fetchShipments

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

fetchShipmentScans

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

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

fetchShipmentSharedRecords

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

fetchShipmentSharedWithMeRecords

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

fetchUserProfile

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

get

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

getJobStatus

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

patch

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

patchShipment

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

post

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

queueProcessingJob

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

renameShipment

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

setBearerToken

open override fun setBearerToken(token: String?)

setMyCarrierApiKey

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

submitMyCarrierOrder

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

updateDocument

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

updateShipmentBarcodes

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

updateShipmentScan

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

uploadLogLines

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

uploadPickTicketDocument

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

uploadShipmentEntry

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

uploadShipmentScanZip

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

verifyMyCarrierStatus

open suspend override fun verifyMyCarrierStatus(overrideAccessToken: String?): Result<Boolean>