@chrt-inc/typescript-sdk 1.319.0 → 1.321.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +38 -28
- package/dist/cjs/api/resources/cargos/client/Client.d.ts +48 -0
- package/dist/cjs/api/resources/cargos/client/Client.js +131 -0
- package/dist/cjs/api/resources/connections/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/connections/client/Client.js +4 -4
- package/dist/cjs/api/resources/courierPayDriverPayouts/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/courierPayDriverPayouts/client/Client.js +2 -2
- package/dist/cjs/api/resources/courierPayDriverRateSheets/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/courierPayDriverRateSheets/client/Client.js +3 -3
- package/dist/cjs/api/resources/courierPayDriverStatements/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/courierPayDriverStatements/client/Client.js +2 -2
- package/dist/cjs/api/resources/dev/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/dev/client/Client.js +4 -4
- package/dist/cjs/api/resources/drivers/client/Client.d.ts +59 -61
- package/dist/cjs/api/resources/drivers/client/Client.js +140 -139
- package/dist/cjs/api/resources/drivers/client/requests/DriverClientCreate1.d.ts +20 -0
- package/dist/cjs/api/resources/drivers/client/requests/{UpdateDriverDetailsReq.d.ts → DriverClientUpdate1.d.ts} +4 -5
- package/dist/cjs/api/resources/drivers/client/requests/DriverLastSeenReq.d.ts +1 -0
- package/dist/cjs/api/resources/drivers/client/requests/index.d.ts +2 -3
- package/dist/cjs/api/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/index.js +4 -1
- package/dist/cjs/api/resources/notifications/resources/courier/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/notifications/resources/courier/client/Client.js +2 -2
- package/dist/cjs/api/resources/notifications/resources/shipper/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/notifications/resources/shipper/client/Client.js +2 -2
- package/dist/cjs/api/resources/offChrtShipperOrg/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/offChrtShipperOrg/client/Client.js +3 -3
- package/dist/cjs/api/resources/orders/client/Client.d.ts +13 -0
- package/dist/cjs/api/resources/orders/client/Client.js +59 -0
- package/dist/cjs/api/resources/orgInfoForConnections/resources/courier/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orgInfoForConnections/resources/courier/client/Client.js +1 -1
- package/dist/cjs/api/resources/orgInfoForConnections/resources/forwarder/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orgInfoForConnections/resources/forwarder/client/Client.js +1 -1
- package/dist/cjs/api/resources/orgInfoForConnections/resources/shipper/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orgInfoForConnections/resources/shipper/client/Client.js +1 -1
- package/dist/cjs/api/resources/orgProfiles/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orgProfiles/client/Client.js +1 -1
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/orgs/client/Client.js +5 -5
- package/dist/cjs/api/resources/shipperContactInfo/client/Client.d.ts +36 -23
- package/dist/cjs/api/resources/shipperContactInfo/client/Client.js +94 -35
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/client/Client.js +2 -2
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.js +3 -3
- package/dist/cjs/api/resources/taskArtifactNotifications/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/taskArtifactNotifications/client/Client.js +2 -2
- package/dist/cjs/api/resources/taskArtifacts/client/Client.d.ts +37 -24
- package/dist/cjs/api/resources/taskArtifacts/client/Client.js +96 -40
- package/dist/cjs/api/resources/taskArtifacts/client/requests/AddTaskArtifactReq.d.ts +19 -0
- package/dist/cjs/api/resources/taskArtifacts/client/requests/index.d.ts +1 -2
- package/dist/cjs/api/resources/taskArtifacts/resources/index.d.ts +2 -3
- package/dist/cjs/api/resources/taskArtifacts/resources/index.js +3 -7
- package/dist/cjs/api/resources/taskArtifacts/resources/{blurhash → s3Object}/client/Client.d.ts +9 -9
- package/dist/cjs/api/resources/taskArtifacts/resources/{blurhash → s3Object}/client/Client.js +11 -11
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.d.ts +47 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.js +127 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/index.js +2 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.js +17 -0
- package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +79 -33
- package/dist/cjs/api/resources/taskGroups/client/Client.js +220 -67
- package/dist/cjs/api/resources/taskGroups/client/requests/AddMessageReq.d.ts +13 -0
- package/dist/cjs/api/resources/{taskArtifacts/resources/images/client/requests/BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost.d.ts → taskGroups/client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.d.ts} +2 -2
- package/dist/cjs/api/resources/taskGroups/client/requests/SetFlightNumberReq.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/SetTaskOrderingReq.d.ts +3 -2
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateCourierOrgReq.d.ts +13 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateDriverReq.d.ts +13 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/index.d.ts +4 -2
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.d.ts +4 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.js +18 -2
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.ts +4 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.ts +4 -0
- package/dist/cjs/api/resources/taskGroups/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/taskGroups/resources/index.js +4 -1
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/Client.d.ts +46 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/Client.js +127 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/index.js +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/index.js +17 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.d.ts +47 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.js +127 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/client/index.js +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/index.js +17 -0
- package/dist/cjs/api/resources/taskGroups/resources/taskGroupId/client/Client.d.ts +59 -0
- package/dist/cjs/api/resources/{taskArtifacts/resources/images → taskGroups/resources/taskGroupId}/client/Client.js +24 -87
- package/dist/cjs/api/resources/taskGroups/resources/taskGroupId/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/taskGroupId/client/index.js +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/taskGroupId/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/taskGroupId/index.js +17 -0
- package/dist/cjs/api/resources/tasks/client/Client.d.ts +107 -0
- package/dist/cjs/api/resources/tasks/client/Client.js +377 -0
- package/dist/cjs/api/resources/tasks/client/requests/AddTaskToGroupReq.d.ts +21 -0
- package/dist/cjs/api/resources/tasks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/tasks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tasks/index.d.ts +1 -0
- package/dist/cjs/api/resources/tasks/index.js +17 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +3 -3
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.js +3 -3
- package/dist/cjs/api/resources/users/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/users/client/Client.js +1 -1
- package/dist/cjs/api/types/Cargo1.d.ts +1 -0
- package/dist/cjs/api/types/CargoStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/CargoStatusEnum1.js +1 -0
- package/dist/cjs/api/types/ChrtGroundCourierTaskActionEnum1.d.ts +3 -3
- package/dist/cjs/api/types/ChrtGroundCourierTaskActionEnum1.js +2 -2
- package/dist/cjs/api/types/Driver1.d.ts +6 -4
- package/dist/cjs/api/types/DriverStatusEnum.d.ts +3 -3
- package/dist/cjs/api/types/DriverStatusEnum.js +2 -2
- package/dist/cjs/api/types/DriverUpdateAvailabilityReq.d.ts +6 -0
- package/dist/cjs/api/types/DriverUpdateAvailabilityReq.js +5 -0
- package/dist/cjs/api/types/Task1.d.ts +1 -0
- package/dist/cjs/api/types/TaskArtifact1.d.ts +1 -0
- package/dist/cjs/api/types/TaskArtifactClientCreate1.d.ts +8 -0
- package/dist/cjs/api/types/TaskArtifactClientCreate1.js +5 -0
- package/dist/cjs/api/types/TaskArtifactS3ObjectMetadata1.d.ts +15 -0
- package/dist/cjs/api/types/TaskArtifactS3ObjectMetadata1.js +5 -0
- package/dist/cjs/api/types/TaskArtifactStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/TaskArtifactStatusEnum1.js +1 -0
- package/dist/cjs/api/types/TaskClientUpdate1.d.ts +0 -1
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
- package/dist/cjs/api/types/TaskGroupS3ObjectMetadata1.d.ts +15 -0
- package/dist/cjs/api/types/TaskGroupS3ObjectMetadata1.js +5 -0
- package/dist/cjs/api/types/TaskGroupSortByEnum.d.ts +2 -1
- package/dist/cjs/api/types/TaskGroupSortByEnum.js +1 -0
- package/dist/cjs/api/types/TaskGroupStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/TaskGroupStatusEnum1.js +1 -0
- package/dist/cjs/api/types/TaskStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/TaskStatusEnum1.js +1 -0
- package/dist/cjs/api/types/index.d.ts +4 -0
- package/dist/cjs/api/types/index.js +4 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +12 -2
- package/dist/esm/api/resources/cargos/client/Client.d.mts +48 -0
- package/dist/esm/api/resources/cargos/client/Client.mjs +94 -0
- package/dist/esm/api/resources/cargos/client/index.d.mts +1 -0
- package/dist/esm/api/resources/cargos/client/index.mjs +1 -0
- package/dist/esm/api/resources/connections/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/connections/client/Client.mjs +4 -4
- package/dist/esm/api/resources/courierPayDriverPayouts/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/courierPayDriverPayouts/client/Client.mjs +2 -2
- package/dist/esm/api/resources/courierPayDriverRateSheets/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/courierPayDriverRateSheets/client/Client.mjs +3 -3
- package/dist/esm/api/resources/courierPayDriverStatements/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/courierPayDriverStatements/client/Client.mjs +2 -2
- package/dist/esm/api/resources/dev/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/dev/client/Client.mjs +4 -4
- package/dist/esm/api/resources/drivers/client/Client.d.mts +59 -61
- package/dist/esm/api/resources/drivers/client/Client.mjs +140 -139
- package/dist/esm/api/resources/drivers/client/requests/DriverClientCreate1.d.mts +20 -0
- package/dist/esm/api/resources/drivers/client/requests/{UpdateDriverDetailsReq.d.mts → DriverClientUpdate1.d.mts} +4 -5
- package/dist/esm/api/resources/drivers/client/requests/DriverLastSeenReq.d.mts +1 -0
- package/dist/esm/api/resources/drivers/client/requests/index.d.mts +2 -3
- package/dist/esm/api/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/index.mjs +3 -0
- package/dist/esm/api/resources/notifications/resources/courier/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/notifications/resources/courier/client/Client.mjs +2 -2
- package/dist/esm/api/resources/notifications/resources/shipper/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/notifications/resources/shipper/client/Client.mjs +2 -2
- package/dist/esm/api/resources/offChrtShipperOrg/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/offChrtShipperOrg/client/Client.mjs +3 -3
- package/dist/esm/api/resources/orders/client/Client.d.mts +13 -0
- package/dist/esm/api/resources/orders/client/Client.mjs +59 -0
- package/dist/esm/api/resources/orgInfoForConnections/resources/courier/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orgInfoForConnections/resources/courier/client/Client.mjs +1 -1
- package/dist/esm/api/resources/orgInfoForConnections/resources/forwarder/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orgInfoForConnections/resources/forwarder/client/Client.mjs +1 -1
- package/dist/esm/api/resources/orgInfoForConnections/resources/shipper/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orgInfoForConnections/resources/shipper/client/Client.mjs +1 -1
- package/dist/esm/api/resources/orgProfiles/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orgProfiles/client/Client.mjs +1 -1
- package/dist/esm/api/resources/orgs/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/orgs/client/Client.mjs +5 -5
- package/dist/esm/api/resources/shipperContactInfo/client/Client.d.mts +36 -23
- package/dist/esm/api/resources/shipperContactInfo/client/Client.mjs +94 -35
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/client/Client.mjs +2 -2
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.mjs +3 -3
- package/dist/esm/api/resources/taskArtifactNotifications/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/taskArtifactNotifications/client/Client.mjs +2 -2
- package/dist/esm/api/resources/taskArtifacts/client/Client.d.mts +37 -24
- package/dist/esm/api/resources/taskArtifacts/client/Client.mjs +96 -40
- package/dist/esm/api/resources/taskArtifacts/client/requests/AddTaskArtifactReq.d.mts +19 -0
- package/dist/esm/api/resources/taskArtifacts/client/requests/index.d.mts +1 -2
- package/dist/esm/api/resources/taskArtifacts/resources/index.d.mts +2 -3
- package/dist/esm/api/resources/taskArtifacts/resources/index.mjs +2 -3
- package/dist/esm/api/resources/taskArtifacts/resources/{blurhash → s3Object}/client/Client.d.mts +9 -9
- package/dist/esm/api/resources/taskArtifacts/resources/{blurhash → s3Object}/client/Client.mjs +9 -9
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/index.d.mts +1 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/index.mjs +1 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.d.mts +47 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.mjs +90 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/index.d.mts +1 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/index.mjs +1 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.d.mts +1 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/client/Client.d.mts +79 -33
- package/dist/esm/api/resources/taskGroups/client/Client.mjs +218 -65
- package/dist/esm/api/resources/taskGroups/client/requests/AddMessageReq.d.mts +13 -0
- package/dist/esm/api/resources/{taskArtifacts/resources/images/client/requests/BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost.d.mts → taskGroups/client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.d.mts} +2 -2
- package/dist/esm/api/resources/taskGroups/client/requests/SetFlightNumberReq.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/client/requests/SetTaskOrderingReq.d.mts +3 -2
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateCourierOrgReq.d.mts +13 -0
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateDriverReq.d.mts +13 -0
- package/dist/esm/api/resources/taskGroups/client/requests/index.d.mts +4 -2
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.d.mts +4 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.mjs +18 -2
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.mts +4 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.mts +4 -0
- package/dist/esm/api/resources/taskGroups/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/taskGroups/resources/index.mjs +3 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/Client.d.mts +46 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/Client.mjs +90 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.d.mts +47 -0
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.mjs +90 -0
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/client/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/client/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/taskGroupId/client/Client.d.mts +59 -0
- package/dist/esm/api/resources/{taskArtifacts/resources/images → taskGroups/resources/taskGroupId}/client/Client.mjs +22 -85
- package/dist/esm/api/resources/taskGroups/resources/taskGroupId/client/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/taskGroupId/client/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/taskGroupId/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/taskGroupId/index.mjs +1 -0
- package/dist/esm/api/resources/tasks/client/Client.d.mts +107 -0
- package/dist/esm/api/resources/tasks/client/Client.mjs +340 -0
- package/dist/esm/api/resources/tasks/client/requests/AddTaskToGroupReq.d.mts +21 -0
- package/dist/esm/api/resources/tasks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/tasks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tasks/index.d.mts +1 -0
- package/dist/esm/api/resources/tasks/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +3 -3
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.mjs +3 -3
- package/dist/esm/api/resources/users/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/users/client/Client.mjs +1 -1
- package/dist/esm/api/types/Cargo1.d.mts +1 -0
- package/dist/esm/api/types/CargoStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/CargoStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/ChrtGroundCourierTaskActionEnum1.d.mts +3 -3
- package/dist/esm/api/types/ChrtGroundCourierTaskActionEnum1.mjs +2 -2
- package/dist/esm/api/types/Driver1.d.mts +6 -4
- package/dist/esm/api/types/DriverStatusEnum.d.mts +3 -3
- package/dist/esm/api/types/DriverStatusEnum.mjs +2 -2
- package/dist/esm/api/types/DriverUpdateAvailabilityReq.d.mts +6 -0
- package/dist/esm/api/types/DriverUpdateAvailabilityReq.mjs +4 -0
- package/dist/esm/api/types/Task1.d.mts +1 -0
- package/dist/esm/api/types/TaskArtifact1.d.mts +1 -0
- package/dist/esm/api/types/TaskArtifactClientCreate1.d.mts +8 -0
- package/dist/esm/api/types/TaskArtifactClientCreate1.mjs +4 -0
- package/dist/esm/api/types/TaskArtifactS3ObjectMetadata1.d.mts +15 -0
- package/dist/esm/api/types/TaskArtifactS3ObjectMetadata1.mjs +4 -0
- package/dist/esm/api/types/TaskArtifactStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/TaskArtifactStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/TaskClientUpdate1.d.mts +0 -1
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
- package/dist/esm/api/types/TaskGroupS3ObjectMetadata1.d.mts +15 -0
- package/dist/esm/api/types/TaskGroupS3ObjectMetadata1.mjs +4 -0
- package/dist/esm/api/types/TaskGroupSortByEnum.d.mts +2 -1
- package/dist/esm/api/types/TaskGroupSortByEnum.mjs +1 -0
- package/dist/esm/api/types/TaskGroupStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/TaskGroupStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/TaskStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/TaskStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/index.d.mts +4 -0
- package/dist/esm/api/types/index.mjs +4 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1163 -267
- package/dist/cjs/api/resources/drivers/client/requests/DriverCreateReq.d.ts +0 -17
- package/dist/cjs/api/resources/drivers/client/requests/SetDriverActivationReq.d.ts +0 -14
- package/dist/cjs/api/resources/taskArtifacts/client/requests/TaskArtifactAddToTaskReq.d.ts +0 -19
- package/dist/cjs/api/resources/taskArtifacts/client/requests/TaskArtifactUpdateCommentsReq.d.ts +0 -14
- package/dist/cjs/api/resources/taskArtifacts/resources/images/client/Client.d.ts +0 -70
- package/dist/cjs/api/resources/taskArtifacts/resources/images/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateTaskGroupCourierOrgReq.d.ts +0 -12
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateTaskGroupDriverReq.d.ts +0 -11
- package/dist/esm/api/resources/drivers/client/requests/DriverCreateReq.d.mts +0 -17
- package/dist/esm/api/resources/drivers/client/requests/SetDriverActivationReq.d.mts +0 -14
- package/dist/esm/api/resources/taskArtifacts/client/requests/TaskArtifactAddToTaskReq.d.mts +0 -19
- package/dist/esm/api/resources/taskArtifacts/client/requests/TaskArtifactUpdateCommentsReq.d.mts +0 -14
- package/dist/esm/api/resources/taskArtifacts/resources/images/client/Client.d.mts +0 -70
- package/dist/esm/api/resources/taskArtifacts/resources/images/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateTaskGroupCourierOrgReq.d.mts +0 -12
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateTaskGroupDriverReq.d.mts +0 -11
- /package/dist/cjs/api/resources/{taskArtifacts/resources/blurhash → cargos}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{taskArtifacts/resources/blurhash → cargos}/client/index.js +0 -0
- /package/dist/cjs/api/resources/{taskArtifacts/resources/blurhash → cargos}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{taskArtifacts/resources/blurhash → cargos}/index.js +0 -0
- /package/dist/cjs/api/resources/drivers/client/requests/{DriverCreateReq.js → DriverClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/drivers/client/requests/{SetDriverActivationReq.js → DriverClientUpdate1.js} +0 -0
- /package/dist/cjs/api/resources/{drivers/client/requests/UpdateDriverDetailsReq.js → taskArtifacts/client/requests/AddTaskArtifactReq.js} +0 -0
- /package/dist/{esm/api/resources/taskArtifacts/resources/blurhash/client/index.d.mts → cjs/api/resources/taskArtifacts/resources/s3Object/client/index.d.ts} +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{images/client/requests → s3Object/client}/index.js +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{images → s3Object}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{images → s3Object}/index.js +0 -0
- /package/dist/{esm/api/resources/taskArtifacts/resources/blurhash/client/index.mjs → cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/index.d.ts} +0 -0
- /package/dist/cjs/api/resources/{taskArtifacts/client/requests/TaskArtifactAddToTaskReq.js → taskGroups/client/requests/AddMessageReq.js} +0 -0
- /package/dist/cjs/api/resources/{taskArtifacts/client/requests/TaskArtifactUpdateCommentsReq.js → taskGroups/client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.js} +0 -0
- /package/dist/cjs/api/resources/{taskArtifacts/resources/images/client/requests/BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost.js → taskGroups/client/requests/UpdateCourierOrgReq.js} +0 -0
- /package/dist/cjs/api/resources/taskGroups/client/requests/{UpdateTaskGroupCourierOrgReq.js → UpdateDriverReq.js} +0 -0
- /package/dist/{esm/api/resources/taskArtifacts/resources/images/client/requests/index.mjs → cjs/api/resources/taskGroups/resources/s3Object/client/index.d.ts} +0 -0
- /package/dist/cjs/api/resources/{taskArtifacts/resources/images → tasks}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{taskArtifacts/resources/images → tasks}/client/index.js +0 -0
- /package/dist/cjs/api/resources/{taskGroups/client/requests/UpdateTaskGroupDriverReq.js → tasks/client/requests/AddTaskToGroupReq.js} +0 -0
- /package/dist/esm/api/resources/{taskArtifacts/resources/blurhash → cargos}/index.d.mts +0 -0
- /package/dist/esm/api/resources/{taskArtifacts/resources/blurhash → cargos}/index.mjs +0 -0
- /package/dist/esm/api/resources/drivers/client/requests/{DriverCreateReq.mjs → DriverClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/drivers/client/requests/{SetDriverActivationReq.mjs → DriverClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/resources/{drivers/client/requests/UpdateDriverDetailsReq.mjs → taskArtifacts/client/requests/AddTaskArtifactReq.mjs} +0 -0
- /package/dist/esm/api/resources/taskArtifacts/resources/{images → s3Object}/index.d.mts +0 -0
- /package/dist/esm/api/resources/taskArtifacts/resources/{images → s3Object}/index.mjs +0 -0
- /package/dist/esm/api/resources/{taskArtifacts/client/requests/TaskArtifactAddToTaskReq.mjs → taskGroups/client/requests/AddMessageReq.mjs} +0 -0
- /package/dist/esm/api/resources/{taskArtifacts/client/requests/TaskArtifactUpdateCommentsReq.mjs → taskGroups/client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.mjs} +0 -0
- /package/dist/esm/api/resources/{taskArtifacts/resources/images/client/requests/BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost.mjs → taskGroups/client/requests/UpdateCourierOrgReq.mjs} +0 -0
- /package/dist/esm/api/resources/taskGroups/client/requests/{UpdateTaskGroupCourierOrgReq.mjs → UpdateDriverReq.mjs} +0 -0
- /package/dist/esm/api/resources/{taskArtifacts/resources/images → tasks}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/{taskArtifacts/resources/images → tasks}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/{taskGroups/client/requests/UpdateTaskGroupDriverReq.mjs → tasks/client/requests/AddTaskToGroupReq.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -579,7 +579,7 @@ await client.courierPayDriverLineItemGroups.createV1({
|
|
|
579
579
|
<dl>
|
|
580
580
|
<dd>
|
|
581
581
|
|
|
582
|
-
Retrieves a specific courier driver payout by ID for the
|
|
582
|
+
Retrieves a specific courier driver payout by ID for the caller's organization.
|
|
583
583
|
|
|
584
584
|
</dd>
|
|
585
585
|
</dl>
|
|
@@ -642,7 +642,7 @@ await client.courierPayDriverPayouts.getByIdV1("id");
|
|
|
642
642
|
<dl>
|
|
643
643
|
<dd>
|
|
644
644
|
|
|
645
|
-
Lists all payouts for a specific driver within the
|
|
645
|
+
Lists all payouts for a specific driver within the caller's organization.
|
|
646
646
|
|
|
647
647
|
</dd>
|
|
648
648
|
</dl>
|
|
@@ -844,7 +844,7 @@ await client.courierPayDriverPayouts.updateStatusV1("id", {});
|
|
|
844
844
|
<dl>
|
|
845
845
|
<dd>
|
|
846
846
|
|
|
847
|
-
Lists all driver rate sheets for the
|
|
847
|
+
Lists all driver rate sheets for the caller's courier organization.
|
|
848
848
|
|
|
849
849
|
</dd>
|
|
850
850
|
</dl>
|
|
@@ -1104,7 +1104,7 @@ await client.courierPayDriverRateSheets.getV1("id");
|
|
|
1104
1104
|
<dl>
|
|
1105
1105
|
<dd>
|
|
1106
1106
|
|
|
1107
|
-
Deletes a driver rate sheet owned by the
|
|
1107
|
+
Deletes a driver rate sheet owned by the caller's organization.
|
|
1108
1108
|
|
|
1109
1109
|
</dd>
|
|
1110
1110
|
</dl>
|
|
@@ -1167,7 +1167,7 @@ await client.courierPayDriverRateSheets.deleteByIdV1("id");
|
|
|
1167
1167
|
<dl>
|
|
1168
1168
|
<dd>
|
|
1169
1169
|
|
|
1170
|
-
Updates an existing driver rate sheet owned by the
|
|
1170
|
+
Updates an existing driver rate sheet owned by the caller's organization.
|
|
1171
1171
|
|
|
1172
1172
|
</dd>
|
|
1173
1173
|
</dl>
|
|
@@ -1240,7 +1240,7 @@ await client.courierPayDriverRateSheets.updateByIdV1("id");
|
|
|
1240
1240
|
<dl>
|
|
1241
1241
|
<dd>
|
|
1242
1242
|
|
|
1243
|
-
Retrieves a specific courier driver statement by ID for the
|
|
1243
|
+
Retrieves a specific courier driver statement by ID for the caller's organization.
|
|
1244
1244
|
|
|
1245
1245
|
</dd>
|
|
1246
1246
|
</dl>
|
|
@@ -1303,7 +1303,7 @@ await client.courierPayDriverStatements.getByIdV1("id");
|
|
|
1303
1303
|
<dl>
|
|
1304
1304
|
<dd>
|
|
1305
1305
|
|
|
1306
|
-
Lists all statements for a specific driver within the
|
|
1306
|
+
Lists all statements for a specific driver within the caller's organization.
|
|
1307
1307
|
|
|
1308
1308
|
</dd>
|
|
1309
1309
|
</dl>
|
|
@@ -1505,7 +1505,7 @@ await client.courierPayDriverStatements.updateStatusV1("id", {});
|
|
|
1505
1505
|
<dl>
|
|
1506
1506
|
<dd>
|
|
1507
1507
|
|
|
1508
|
-
Retrieves a shipper pay courier line item group by its ID for the
|
|
1508
|
+
Retrieves a shipper pay courier line item group by its ID for the caller's courier organization.
|
|
1509
1509
|
|
|
1510
1510
|
</dd>
|
|
1511
1511
|
</dl>
|
|
@@ -1631,7 +1631,7 @@ await client.shipperPayCourierLineItemGroups.deleteByIdV1("id");
|
|
|
1631
1631
|
<dl>
|
|
1632
1632
|
<dd>
|
|
1633
1633
|
|
|
1634
|
-
Retrieves a shipper pay courier line item group by its associated task group ID for the
|
|
1634
|
+
Retrieves a shipper pay courier line item group by its associated task group ID for the caller's courier organization.
|
|
1635
1635
|
|
|
1636
1636
|
</dd>
|
|
1637
1637
|
</dl>
|
|
@@ -3062,7 +3062,7 @@ await client.shipperPayCourierStatements.previewV1({
|
|
|
3062
3062
|
<dl>
|
|
3063
3063
|
<dd>
|
|
3064
3064
|
|
|
3065
|
-
Lists shipper organizations based on the
|
|
3065
|
+
Lists shipper organizations based on the caller's organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (list[ShipperConnectionRes])
|
|
3066
3066
|
|
|
3067
3067
|
</dd>
|
|
3068
3068
|
</dl>
|
|
@@ -3117,7 +3117,7 @@ await client.connections.listShippersV1();
|
|
|
3117
3117
|
<dl>
|
|
3118
3118
|
<dd>
|
|
3119
3119
|
|
|
3120
|
-
Lists courier organizations based on the
|
|
3120
|
+
Lists courier organizations based on the caller's organization type. Shippers see connected couriers, forwarders see connected couriers. | () -> (list[CourierConnectionRes])
|
|
3121
3121
|
|
|
3122
3122
|
</dd>
|
|
3123
3123
|
</dl>
|
|
@@ -3172,7 +3172,7 @@ await client.connections.listCouriersV1();
|
|
|
3172
3172
|
<dl>
|
|
3173
3173
|
<dd>
|
|
3174
3174
|
|
|
3175
|
-
Lists forwarder organizations based on the
|
|
3175
|
+
Lists forwarder organizations based on the caller's organization type. Shippers see connected forwarders, couriers see connected forwarders. | () -> (list[ForwarderConnectionRes])
|
|
3176
3176
|
|
|
3177
3177
|
</dd>
|
|
3178
3178
|
</dl>
|
|
@@ -3227,7 +3227,7 @@ await client.connections.listForwardersV1();
|
|
|
3227
3227
|
<dl>
|
|
3228
3228
|
<dd>
|
|
3229
3229
|
|
|
3230
|
-
Gets connection between
|
|
3230
|
+
Gets connection between caller's org and org with specified handle. | () -> (ShipperCourierConnection1 | ShipperForwarderConnection1 | ForwarderCourierConnection1 | None)
|
|
3231
3231
|
|
|
3232
3232
|
</dd>
|
|
3233
3233
|
</dl>
|
|
@@ -3292,7 +3292,7 @@ await client.connections.getByHandleV1("handle");
|
|
|
3292
3292
|
<dl>
|
|
3293
3293
|
<dd>
|
|
3294
3294
|
|
|
3295
|
-
Retrieves the courier or forwarder organization profile for the
|
|
3295
|
+
Retrieves the courier or forwarder organization profile for the caller's organization. | () -> (OrgProfileRes1)
|
|
3296
3296
|
|
|
3297
3297
|
</dd>
|
|
3298
3298
|
</dl>
|
|
@@ -3737,7 +3737,7 @@ await client.orgProfiles.getAvatarV1("handle");
|
|
|
3737
3737
|
<dl>
|
|
3738
3738
|
<dd>
|
|
3739
3739
|
|
|
3740
|
-
Experimental endpoint for running AI agentic workflows. Returns the
|
|
3740
|
+
Experimental endpoint for running AI agentic workflows. Returns the caller's ID for testing purposes. | () -> (str)
|
|
3741
3741
|
|
|
3742
3742
|
</dd>
|
|
3743
3743
|
</dl>
|
|
@@ -3957,7 +3957,7 @@ await client.dev.getDecodedJwtV1();
|
|
|
3957
3957
|
<dl>
|
|
3958
3958
|
<dd>
|
|
3959
3959
|
|
|
3960
|
-
Retrieves the primary email address for the
|
|
3960
|
+
Retrieves the primary email address for the caller from the authentication service. | () -> (str)
|
|
3961
3961
|
|
|
3962
3962
|
</dd>
|
|
3963
3963
|
</dl>
|
|
@@ -4012,7 +4012,7 @@ await client.dev.getEmailV1();
|
|
|
4012
4012
|
<dl>
|
|
4013
4013
|
<dd>
|
|
4014
4014
|
|
|
4015
|
-
Experimental endpoint for running durable execution workflows. Returns the
|
|
4015
|
+
Experimental endpoint for running durable execution workflows. Returns the caller's ID for testing purposes. | () -> (dict[str, Any])
|
|
4016
4016
|
|
|
4017
4017
|
</dd>
|
|
4018
4018
|
</dl>
|
|
@@ -4067,7 +4067,7 @@ await client.dev.getDurableV1();
|
|
|
4067
4067
|
<dl>
|
|
4068
4068
|
<dd>
|
|
4069
4069
|
|
|
4070
|
-
Development template endpoint that returns the
|
|
4070
|
+
Development template endpoint that returns the caller's ID for testing. | () -> (str)
|
|
4071
4071
|
|
|
4072
4072
|
</dd>
|
|
4073
4073
|
</dl>
|
|
@@ -4246,7 +4246,7 @@ await client.dev.getGitInfoV1();
|
|
|
4246
4246
|
<dl>
|
|
4247
4247
|
<dd>
|
|
4248
4248
|
|
|
4249
|
-
Retrieves task_artifact notification preferences for the
|
|
4249
|
+
Retrieves task_artifact notification preferences for the caller's organization. | () -> (TaskArtifactNotificationPreferences1)
|
|
4250
4250
|
|
|
4251
4251
|
</dd>
|
|
4252
4252
|
</dl>
|
|
@@ -4301,7 +4301,7 @@ await client.taskArtifactNotifications.getPreferencesV1();
|
|
|
4301
4301
|
<dl>
|
|
4302
4302
|
<dd>
|
|
4303
4303
|
|
|
4304
|
-
Creates or updates task_artifact notification preferences for the
|
|
4304
|
+
Creates or updates task_artifact notification preferences for the caller's organization. | (TaskArtifactNotificationPreferencesClientCreate1) -> (PydanticObjectId)
|
|
4305
4305
|
|
|
4306
4306
|
</dd>
|
|
4307
4307
|
</dl>
|
|
@@ -4356,7 +4356,7 @@ await client.taskArtifactNotifications.upsertPreferencesV1({
|
|
|
4356
4356
|
|
|
4357
4357
|
## Drivers
|
|
4358
4358
|
|
|
4359
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4359
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
|
|
4360
4360
|
<dl>
|
|
4361
4361
|
<dd>
|
|
4362
4362
|
|
|
@@ -4368,7 +4368,7 @@ await client.taskArtifactNotifications.upsertPreferencesV1({
|
|
|
4368
4368
|
<dl>
|
|
4369
4369
|
<dd>
|
|
4370
4370
|
|
|
4371
|
-
|
|
4371
|
+
Retrieves driver information for the caller within their organization. | () -> (Driver1)
|
|
4372
4372
|
|
|
4373
4373
|
</dd>
|
|
4374
4374
|
</dl>
|
|
@@ -4384,7 +4384,7 @@ Lists all organization members paired with their driver information if they are
|
|
|
4384
4384
|
<dd>
|
|
4385
4385
|
|
|
4386
4386
|
```typescript
|
|
4387
|
-
await client.drivers.
|
|
4387
|
+
await client.drivers.getForCallerV1();
|
|
4388
4388
|
```
|
|
4389
4389
|
|
|
4390
4390
|
</dd>
|
|
@@ -4411,7 +4411,7 @@ await client.drivers.listOrgMembersAndDriversV1();
|
|
|
4411
4411
|
</dl>
|
|
4412
4412
|
</details>
|
|
4413
4413
|
|
|
4414
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4414
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.Driver1</code></summary>
|
|
4415
4415
|
<dl>
|
|
4416
4416
|
<dd>
|
|
4417
4417
|
|
|
@@ -4423,7 +4423,7 @@ await client.drivers.listOrgMembersAndDriversV1();
|
|
|
4423
4423
|
<dl>
|
|
4424
4424
|
<dd>
|
|
4425
4425
|
|
|
4426
|
-
|
|
4426
|
+
Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
|
|
4427
4427
|
|
|
4428
4428
|
</dd>
|
|
4429
4429
|
</dl>
|
|
@@ -4439,7 +4439,7 @@ Lists all drivers belonging to the authenticated organization. | () -> (list[Dri
|
|
|
4439
4439
|
<dd>
|
|
4440
4440
|
|
|
4441
4441
|
```typescript
|
|
4442
|
-
await client.drivers.
|
|
4442
|
+
await client.drivers.getByDriverIdV1("driver_id");
|
|
4443
4443
|
```
|
|
4444
4444
|
|
|
4445
4445
|
</dd>
|
|
@@ -4455,6 +4455,14 @@ await client.drivers.listV1();
|
|
|
4455
4455
|
<dl>
|
|
4456
4456
|
<dd>
|
|
4457
4457
|
|
|
4458
|
+
**driverId:** `string`
|
|
4459
|
+
|
|
4460
|
+
</dd>
|
|
4461
|
+
</dl>
|
|
4462
|
+
|
|
4463
|
+
<dl>
|
|
4464
|
+
<dd>
|
|
4465
|
+
|
|
4458
4466
|
**requestOptions:** `Drivers.RequestOptions`
|
|
4459
4467
|
|
|
4460
4468
|
</dd>
|
|
@@ -4466,7 +4474,7 @@ await client.drivers.listV1();
|
|
|
4466
4474
|
</dl>
|
|
4467
4475
|
</details>
|
|
4468
4476
|
|
|
4469
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4477
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>() -> Chrt.OrgMembersAndDrivers[]</code></summary>
|
|
4470
4478
|
<dl>
|
|
4471
4479
|
<dd>
|
|
4472
4480
|
|
|
@@ -4478,7 +4486,7 @@ await client.drivers.listV1();
|
|
|
4478
4486
|
<dl>
|
|
4479
4487
|
<dd>
|
|
4480
4488
|
|
|
4481
|
-
|
|
4489
|
+
Lists all organization members paired with their driver information if they are drivers. | () -> (list[OrgMembersAndDrivers])
|
|
4482
4490
|
|
|
4483
4491
|
</dd>
|
|
4484
4492
|
</dl>
|
|
@@ -4494,12 +4502,7 @@ Creates a new driver profile for an organization member with optional vehicle ty
|
|
|
4494
4502
|
<dd>
|
|
4495
4503
|
|
|
4496
4504
|
```typescript
|
|
4497
|
-
await client.drivers.
|
|
4498
|
-
org_member: {
|
|
4499
|
-
role: "owner",
|
|
4500
|
-
user_id: "user_id",
|
|
4501
|
-
},
|
|
4502
|
-
});
|
|
4505
|
+
await client.drivers.listOrgMembersAndDriversV1();
|
|
4503
4506
|
```
|
|
4504
4507
|
|
|
4505
4508
|
</dd>
|
|
@@ -4515,10 +4518,57 @@ await client.drivers.createV1({
|
|
|
4515
4518
|
<dl>
|
|
4516
4519
|
<dd>
|
|
4517
4520
|
|
|
4518
|
-
**
|
|
4521
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
4522
|
+
|
|
4523
|
+
</dd>
|
|
4524
|
+
</dl>
|
|
4525
|
+
</dd>
|
|
4526
|
+
</dl>
|
|
4527
|
+
|
|
4528
|
+
</dd>
|
|
4529
|
+
</dl>
|
|
4530
|
+
</details>
|
|
4531
|
+
|
|
4532
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listV1</a>() -> Chrt.Driver1[]</code></summary>
|
|
4533
|
+
<dl>
|
|
4534
|
+
<dd>
|
|
4535
|
+
|
|
4536
|
+
#### 📝 Description
|
|
4537
|
+
|
|
4538
|
+
<dl>
|
|
4539
|
+
<dd>
|
|
4540
|
+
|
|
4541
|
+
<dl>
|
|
4542
|
+
<dd>
|
|
4543
|
+
|
|
4544
|
+
Lists all drivers belonging to the caller's organization. | () -> (list[Driver1])
|
|
4545
|
+
|
|
4546
|
+
</dd>
|
|
4547
|
+
</dl>
|
|
4548
|
+
</dd>
|
|
4549
|
+
</dl>
|
|
4550
|
+
|
|
4551
|
+
#### 🔌 Usage
|
|
4552
|
+
|
|
4553
|
+
<dl>
|
|
4554
|
+
<dd>
|
|
4555
|
+
|
|
4556
|
+
<dl>
|
|
4557
|
+
<dd>
|
|
4558
|
+
|
|
4559
|
+
```typescript
|
|
4560
|
+
await client.drivers.listV1();
|
|
4561
|
+
```
|
|
4519
4562
|
|
|
4520
4563
|
</dd>
|
|
4521
4564
|
</dl>
|
|
4565
|
+
</dd>
|
|
4566
|
+
</dl>
|
|
4567
|
+
|
|
4568
|
+
#### ⚙️ Parameters
|
|
4569
|
+
|
|
4570
|
+
<dl>
|
|
4571
|
+
<dd>
|
|
4522
4572
|
|
|
4523
4573
|
<dl>
|
|
4524
4574
|
<dd>
|
|
@@ -4534,7 +4584,7 @@ await client.drivers.createV1({
|
|
|
4534
4584
|
</dl>
|
|
4535
4585
|
</details>
|
|
4536
4586
|
|
|
4537
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4587
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
4538
4588
|
<dl>
|
|
4539
4589
|
<dd>
|
|
4540
4590
|
|
|
@@ -4546,7 +4596,7 @@ await client.drivers.createV1({
|
|
|
4546
4596
|
<dl>
|
|
4547
4597
|
<dd>
|
|
4548
4598
|
|
|
4549
|
-
|
|
4599
|
+
Creates a new driver profile for the caller. Returns existing driver ID if one already exists. Courier orgs only, min role: operator. | (DriverClientCreate1) -> (PydanticObjectId)
|
|
4550
4600
|
|
|
4551
4601
|
</dd>
|
|
4552
4602
|
</dl>
|
|
@@ -4562,7 +4612,9 @@ Retrieves driver information for the authenticated user within their organizatio
|
|
|
4562
4612
|
<dd>
|
|
4563
4613
|
|
|
4564
4614
|
```typescript
|
|
4565
|
-
await client.drivers.
|
|
4615
|
+
await client.drivers.createV1({
|
|
4616
|
+
schema_version: 1,
|
|
4617
|
+
});
|
|
4566
4618
|
```
|
|
4567
4619
|
|
|
4568
4620
|
</dd>
|
|
@@ -4578,6 +4630,14 @@ await client.drivers.getV1();
|
|
|
4578
4630
|
<dl>
|
|
4579
4631
|
<dd>
|
|
4580
4632
|
|
|
4633
|
+
**request:** `Chrt.DriverClientCreate1`
|
|
4634
|
+
|
|
4635
|
+
</dd>
|
|
4636
|
+
</dl>
|
|
4637
|
+
|
|
4638
|
+
<dl>
|
|
4639
|
+
<dd>
|
|
4640
|
+
|
|
4581
4641
|
**requestOptions:** `Drivers.RequestOptions`
|
|
4582
4642
|
|
|
4583
4643
|
</dd>
|
|
@@ -4589,7 +4649,7 @@ await client.drivers.getV1();
|
|
|
4589
4649
|
</dl>
|
|
4590
4650
|
</details>
|
|
4591
4651
|
|
|
4592
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4652
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">updateV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
4593
4653
|
<dl>
|
|
4594
4654
|
<dd>
|
|
4595
4655
|
|
|
@@ -4601,7 +4661,7 @@ await client.drivers.getV1();
|
|
|
4601
4661
|
<dl>
|
|
4602
4662
|
<dd>
|
|
4603
4663
|
|
|
4604
|
-
|
|
4664
|
+
Updates driver contact details and vehicle type assignments. Courier orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)
|
|
4605
4665
|
|
|
4606
4666
|
</dd>
|
|
4607
4667
|
</dl>
|
|
@@ -4617,7 +4677,7 @@ Retrieves detailed driver information by driver ID within the organization. | ()
|
|
|
4617
4677
|
<dd>
|
|
4618
4678
|
|
|
4619
4679
|
```typescript
|
|
4620
|
-
await client.drivers.
|
|
4680
|
+
await client.drivers.updateV1("driver_id");
|
|
4621
4681
|
```
|
|
4622
4682
|
|
|
4623
4683
|
</dd>
|
|
@@ -4641,6 +4701,14 @@ await client.drivers.getByDriverIdV1("driver_id");
|
|
|
4641
4701
|
<dl>
|
|
4642
4702
|
<dd>
|
|
4643
4703
|
|
|
4704
|
+
**request:** `Chrt.DriverClientUpdate1`
|
|
4705
|
+
|
|
4706
|
+
</dd>
|
|
4707
|
+
</dl>
|
|
4708
|
+
|
|
4709
|
+
<dl>
|
|
4710
|
+
<dd>
|
|
4711
|
+
|
|
4644
4712
|
**requestOptions:** `Drivers.RequestOptions`
|
|
4645
4713
|
|
|
4646
4714
|
</dd>
|
|
@@ -4652,7 +4720,7 @@ await client.drivers.getByDriverIdV1("driver_id");
|
|
|
4652
4720
|
</dl>
|
|
4653
4721
|
</details>
|
|
4654
4722
|
|
|
4655
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4723
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">updateLastSeenV1</a>({ ...params }) -> boolean</code></summary>
|
|
4656
4724
|
<dl>
|
|
4657
4725
|
<dd>
|
|
4658
4726
|
|
|
@@ -4664,7 +4732,7 @@ await client.drivers.getByDriverIdV1("driver_id");
|
|
|
4664
4732
|
<dl>
|
|
4665
4733
|
<dd>
|
|
4666
4734
|
|
|
4667
|
-
|
|
4735
|
+
Updates the caller's driver last known location and timestamp for tracking. Only updates if timestamp is newer than existing (DB-side validation). Returns False if driver not found or timestamp is stale. | (DriverLastSeenReq) -> (bool)
|
|
4668
4736
|
|
|
4669
4737
|
</dd>
|
|
4670
4738
|
</dl>
|
|
@@ -4680,7 +4748,20 @@ Deletes a driver from the organization and removes them from associated rate she
|
|
|
4680
4748
|
<dd>
|
|
4681
4749
|
|
|
4682
4750
|
```typescript
|
|
4683
|
-
await client.drivers.
|
|
4751
|
+
await client.drivers.updateLastSeenV1({
|
|
4752
|
+
location: {
|
|
4753
|
+
type: "Feature",
|
|
4754
|
+
geometry: {
|
|
4755
|
+
type: "GeometryCollection",
|
|
4756
|
+
geometries: [
|
|
4757
|
+
{
|
|
4758
|
+
type: "LineString",
|
|
4759
|
+
coordinates: [[]],
|
|
4760
|
+
},
|
|
4761
|
+
],
|
|
4762
|
+
},
|
|
4763
|
+
},
|
|
4764
|
+
});
|
|
4684
4765
|
```
|
|
4685
4766
|
|
|
4686
4767
|
</dd>
|
|
@@ -4696,10 +4777,65 @@ await client.drivers.deleteV1("driver_id");
|
|
|
4696
4777
|
<dl>
|
|
4697
4778
|
<dd>
|
|
4698
4779
|
|
|
4699
|
-
**
|
|
4780
|
+
**request:** `Chrt.DriverLastSeenReq`
|
|
4781
|
+
|
|
4782
|
+
</dd>
|
|
4783
|
+
</dl>
|
|
4784
|
+
|
|
4785
|
+
<dl>
|
|
4786
|
+
<dd>
|
|
4787
|
+
|
|
4788
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
4789
|
+
|
|
4790
|
+
</dd>
|
|
4791
|
+
</dl>
|
|
4792
|
+
</dd>
|
|
4793
|
+
</dl>
|
|
4794
|
+
|
|
4795
|
+
</dd>
|
|
4796
|
+
</dl>
|
|
4797
|
+
</details>
|
|
4798
|
+
|
|
4799
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">clearLastSeenV1</a>() -> boolean</code></summary>
|
|
4800
|
+
<dl>
|
|
4801
|
+
<dd>
|
|
4802
|
+
|
|
4803
|
+
#### 📝 Description
|
|
4804
|
+
|
|
4805
|
+
<dl>
|
|
4806
|
+
<dd>
|
|
4807
|
+
|
|
4808
|
+
<dl>
|
|
4809
|
+
<dd>
|
|
4810
|
+
|
|
4811
|
+
Clears the driver's last known location and timestamp. | () -> (bool)
|
|
4812
|
+
|
|
4813
|
+
</dd>
|
|
4814
|
+
</dl>
|
|
4815
|
+
</dd>
|
|
4816
|
+
</dl>
|
|
4817
|
+
|
|
4818
|
+
#### 🔌 Usage
|
|
4819
|
+
|
|
4820
|
+
<dl>
|
|
4821
|
+
<dd>
|
|
4822
|
+
|
|
4823
|
+
<dl>
|
|
4824
|
+
<dd>
|
|
4825
|
+
|
|
4826
|
+
```typescript
|
|
4827
|
+
await client.drivers.clearLastSeenV1();
|
|
4828
|
+
```
|
|
4700
4829
|
|
|
4701
4830
|
</dd>
|
|
4702
4831
|
</dl>
|
|
4832
|
+
</dd>
|
|
4833
|
+
</dl>
|
|
4834
|
+
|
|
4835
|
+
#### ⚙️ Parameters
|
|
4836
|
+
|
|
4837
|
+
<dl>
|
|
4838
|
+
<dd>
|
|
4703
4839
|
|
|
4704
4840
|
<dl>
|
|
4705
4841
|
<dd>
|
|
@@ -4715,7 +4851,7 @@ await client.drivers.deleteV1("driver_id");
|
|
|
4715
4851
|
</dl>
|
|
4716
4852
|
</details>
|
|
4717
4853
|
|
|
4718
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4854
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">updateAvailabilityAccordingToDriverV1</a>({ ...params }) -> boolean</code></summary>
|
|
4719
4855
|
<dl>
|
|
4720
4856
|
<dd>
|
|
4721
4857
|
|
|
@@ -4727,7 +4863,7 @@ await client.drivers.deleteV1("driver_id");
|
|
|
4727
4863
|
<dl>
|
|
4728
4864
|
<dd>
|
|
4729
4865
|
|
|
4730
|
-
|
|
4866
|
+
Updates the caller's driver availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Courier orgs only. | (DriverUpdateAvailabilityReq) -> (bool)
|
|
4731
4867
|
|
|
4732
4868
|
</dd>
|
|
4733
4869
|
</dl>
|
|
@@ -4743,9 +4879,8 @@ Sets the activation status of a driver (active/inactive) within the organization
|
|
|
4743
4879
|
<dd>
|
|
4744
4880
|
|
|
4745
4881
|
```typescript
|
|
4746
|
-
await client.drivers.
|
|
4747
|
-
|
|
4748
|
-
active: true,
|
|
4882
|
+
await client.drivers.updateAvailabilityAccordingToDriverV1({
|
|
4883
|
+
available: true,
|
|
4749
4884
|
});
|
|
4750
4885
|
```
|
|
4751
4886
|
|
|
@@ -4762,7 +4897,7 @@ await client.drivers.setActivationV1({
|
|
|
4762
4897
|
<dl>
|
|
4763
4898
|
<dd>
|
|
4764
4899
|
|
|
4765
|
-
**request:** `Chrt.
|
|
4900
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
4766
4901
|
|
|
4767
4902
|
</dd>
|
|
4768
4903
|
</dl>
|
|
@@ -4781,7 +4916,7 @@ await client.drivers.setActivationV1({
|
|
|
4781
4916
|
</dl>
|
|
4782
4917
|
</details>
|
|
4783
4918
|
|
|
4784
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4919
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">updateAvailabilityAccordingToOperatorsV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
4785
4920
|
<dl>
|
|
4786
4921
|
<dd>
|
|
4787
4922
|
|
|
@@ -4793,7 +4928,7 @@ await client.drivers.setActivationV1({
|
|
|
4793
4928
|
<dl>
|
|
4794
4929
|
<dd>
|
|
4795
4930
|
|
|
4796
|
-
Updates
|
|
4931
|
+
Updates a driver's availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Courier orgs only, min role: operator. | (DriverUpdateAvailabilityReq) -> (bool)
|
|
4797
4932
|
|
|
4798
4933
|
</dd>
|
|
4799
4934
|
</dl>
|
|
@@ -4809,19 +4944,8 @@ Updates the driver's last known location and timestamp for tracking purposes. |
|
|
|
4809
4944
|
<dd>
|
|
4810
4945
|
|
|
4811
4946
|
```typescript
|
|
4812
|
-
await client.drivers.
|
|
4813
|
-
|
|
4814
|
-
type: "Feature",
|
|
4815
|
-
geometry: {
|
|
4816
|
-
type: "GeometryCollection",
|
|
4817
|
-
geometries: [
|
|
4818
|
-
{
|
|
4819
|
-
type: "LineString",
|
|
4820
|
-
coordinates: [[]],
|
|
4821
|
-
},
|
|
4822
|
-
],
|
|
4823
|
-
},
|
|
4824
|
-
},
|
|
4947
|
+
await client.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
|
|
4948
|
+
available: true,
|
|
4825
4949
|
});
|
|
4826
4950
|
```
|
|
4827
4951
|
|
|
@@ -4838,7 +4962,15 @@ await client.drivers.lastSeenV1({
|
|
|
4838
4962
|
<dl>
|
|
4839
4963
|
<dd>
|
|
4840
4964
|
|
|
4841
|
-
**
|
|
4965
|
+
**driverId:** `string`
|
|
4966
|
+
|
|
4967
|
+
</dd>
|
|
4968
|
+
</dl>
|
|
4969
|
+
|
|
4970
|
+
<dl>
|
|
4971
|
+
<dd>
|
|
4972
|
+
|
|
4973
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
4842
4974
|
|
|
4843
4975
|
</dd>
|
|
4844
4976
|
</dl>
|
|
@@ -4857,7 +4989,9 @@ await client.drivers.lastSeenV1({
|
|
|
4857
4989
|
</dl>
|
|
4858
4990
|
</details>
|
|
4859
4991
|
|
|
4860
|
-
|
|
4992
|
+
## Cargos
|
|
4993
|
+
|
|
4994
|
+
<details><summary><code>client.cargos.<a href="/src/api/resources/cargos/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
|
|
4861
4995
|
<dl>
|
|
4862
4996
|
<dd>
|
|
4863
4997
|
|
|
@@ -4869,7 +5003,7 @@ await client.drivers.lastSeenV1({
|
|
|
4869
5003
|
<dl>
|
|
4870
5004
|
<dd>
|
|
4871
5005
|
|
|
4872
|
-
|
|
5006
|
+
Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
4873
5007
|
|
|
4874
5008
|
</dd>
|
|
4875
5009
|
</dl>
|
|
@@ -4885,7 +5019,7 @@ Clears the driver's last known location and timestamp. | () -> (bool)
|
|
|
4885
5019
|
<dd>
|
|
4886
5020
|
|
|
4887
5021
|
```typescript
|
|
4888
|
-
await client.
|
|
5022
|
+
await client.cargos.updateV1("cargo_id", {});
|
|
4889
5023
|
```
|
|
4890
5024
|
|
|
4891
5025
|
</dd>
|
|
@@ -4901,7 +5035,23 @@ await client.drivers.lastSeenClearV1();
|
|
|
4901
5035
|
<dl>
|
|
4902
5036
|
<dd>
|
|
4903
5037
|
|
|
4904
|
-
**
|
|
5038
|
+
**cargoId:** `string`
|
|
5039
|
+
|
|
5040
|
+
</dd>
|
|
5041
|
+
</dl>
|
|
5042
|
+
|
|
5043
|
+
<dl>
|
|
5044
|
+
<dd>
|
|
5045
|
+
|
|
5046
|
+
**request:** `Chrt.CargoClientUpdate1`
|
|
5047
|
+
|
|
5048
|
+
</dd>
|
|
5049
|
+
</dl>
|
|
5050
|
+
|
|
5051
|
+
<dl>
|
|
5052
|
+
<dd>
|
|
5053
|
+
|
|
5054
|
+
**requestOptions:** `Cargos.RequestOptions`
|
|
4905
5055
|
|
|
4906
5056
|
</dd>
|
|
4907
5057
|
</dl>
|
|
@@ -4912,7 +5062,9 @@ await client.drivers.lastSeenClearV1();
|
|
|
4912
5062
|
</dl>
|
|
4913
5063
|
</details>
|
|
4914
5064
|
|
|
4915
|
-
|
|
5065
|
+
## TaskArtifacts
|
|
5066
|
+
|
|
5067
|
+
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">addToTaskV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
4916
5068
|
<dl>
|
|
4917
5069
|
<dd>
|
|
4918
5070
|
|
|
@@ -4924,7 +5076,7 @@ await client.drivers.lastSeenClearV1();
|
|
|
4924
5076
|
<dl>
|
|
4925
5077
|
<dd>
|
|
4926
5078
|
|
|
4927
|
-
|
|
5079
|
+
Adds a new task artifact to a task. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
|
|
4928
5080
|
|
|
4929
5081
|
</dd>
|
|
4930
5082
|
</dl>
|
|
@@ -4940,8 +5092,12 @@ Updates driver contact details and vehicle type assignments within the organizat
|
|
|
4940
5092
|
<dd>
|
|
4941
5093
|
|
|
4942
5094
|
```typescript
|
|
4943
|
-
await client.
|
|
4944
|
-
|
|
5095
|
+
await client.taskArtifacts.addToTaskV1("task_id", {
|
|
5096
|
+
task_artifact: {
|
|
5097
|
+
schema_version: 1,
|
|
5098
|
+
type: "image",
|
|
5099
|
+
},
|
|
5100
|
+
status: "draft",
|
|
4945
5101
|
});
|
|
4946
5102
|
```
|
|
4947
5103
|
|
|
@@ -4958,7 +5114,7 @@ await client.drivers.updateDriverV1({
|
|
|
4958
5114
|
<dl>
|
|
4959
5115
|
<dd>
|
|
4960
5116
|
|
|
4961
|
-
**
|
|
5117
|
+
**taskId:** `string`
|
|
4962
5118
|
|
|
4963
5119
|
</dd>
|
|
4964
5120
|
</dl>
|
|
@@ -4966,7 +5122,15 @@ await client.drivers.updateDriverV1({
|
|
|
4966
5122
|
<dl>
|
|
4967
5123
|
<dd>
|
|
4968
5124
|
|
|
4969
|
-
**
|
|
5125
|
+
**request:** `Chrt.AddTaskArtifactReq`
|
|
5126
|
+
|
|
5127
|
+
</dd>
|
|
5128
|
+
</dl>
|
|
5129
|
+
|
|
5130
|
+
<dl>
|
|
5131
|
+
<dd>
|
|
5132
|
+
|
|
5133
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
4970
5134
|
|
|
4971
5135
|
</dd>
|
|
4972
5136
|
</dl>
|
|
@@ -4977,8 +5141,6 @@ await client.drivers.updateDriverV1({
|
|
|
4977
5141
|
</dl>
|
|
4978
5142
|
</details>
|
|
4979
5143
|
|
|
4980
|
-
## TaskArtifacts
|
|
4981
|
-
|
|
4982
5144
|
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">completeV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
4983
5145
|
<dl>
|
|
4984
5146
|
<dd>
|
|
@@ -4991,7 +5153,7 @@ await client.drivers.updateDriverV1({
|
|
|
4991
5153
|
<dl>
|
|
4992
5154
|
<dd>
|
|
4993
5155
|
|
|
4994
|
-
|
|
5156
|
+
Marks a task artifact as COMPLETED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)
|
|
4995
5157
|
|
|
4996
5158
|
</dd>
|
|
4997
5159
|
</dl>
|
|
@@ -5042,7 +5204,7 @@ await client.taskArtifacts.completeV1("task_artifact_id");
|
|
|
5042
5204
|
</dl>
|
|
5043
5205
|
</details>
|
|
5044
5206
|
|
|
5045
|
-
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">
|
|
5207
|
+
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">skipV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
5046
5208
|
<dl>
|
|
5047
5209
|
<dd>
|
|
5048
5210
|
|
|
@@ -5054,7 +5216,7 @@ await client.taskArtifacts.completeV1("task_artifact_id");
|
|
|
5054
5216
|
<dl>
|
|
5055
5217
|
<dd>
|
|
5056
5218
|
|
|
5057
|
-
|
|
5219
|
+
Marks a task artifact as SKIPPED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)
|
|
5058
5220
|
|
|
5059
5221
|
</dd>
|
|
5060
5222
|
</dl>
|
|
@@ -5070,10 +5232,7 @@ Updates the completor comments on a task_artifact without affecting completion s
|
|
|
5070
5232
|
<dd>
|
|
5071
5233
|
|
|
5072
5234
|
```typescript
|
|
5073
|
-
await client.taskArtifacts.
|
|
5074
|
-
task_artifact_id: "task_artifact_id",
|
|
5075
|
-
completor_comments: "completor_comments",
|
|
5076
|
-
});
|
|
5235
|
+
await client.taskArtifacts.skipV1("task_artifact_id");
|
|
5077
5236
|
```
|
|
5078
5237
|
|
|
5079
5238
|
</dd>
|
|
@@ -5089,7 +5248,7 @@ await client.taskArtifacts.updateCommentsV1({
|
|
|
5089
5248
|
<dl>
|
|
5090
5249
|
<dd>
|
|
5091
5250
|
|
|
5092
|
-
**
|
|
5251
|
+
**taskArtifactId:** `string`
|
|
5093
5252
|
|
|
5094
5253
|
</dd>
|
|
5095
5254
|
</dl>
|
|
@@ -5108,7 +5267,7 @@ await client.taskArtifacts.updateCommentsV1({
|
|
|
5108
5267
|
</dl>
|
|
5109
5268
|
</details>
|
|
5110
5269
|
|
|
5111
|
-
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">
|
|
5270
|
+
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
5112
5271
|
<dl>
|
|
5113
5272
|
<dd>
|
|
5114
5273
|
|
|
@@ -5120,7 +5279,7 @@ await client.taskArtifacts.updateCommentsV1({
|
|
|
5120
5279
|
<dl>
|
|
5121
5280
|
<dd>
|
|
5122
5281
|
|
|
5123
|
-
|
|
5282
|
+
Deletes a task artifact. | authz_personas=[lig_org_operators] | () -> (bool)
|
|
5124
5283
|
|
|
5125
5284
|
</dd>
|
|
5126
5285
|
</dl>
|
|
@@ -5136,11 +5295,7 @@ Adds a new task_artifact to an existing task. | (TaskArtifactAddToTaskReq) -> (P
|
|
|
5136
5295
|
<dd>
|
|
5137
5296
|
|
|
5138
5297
|
```typescript
|
|
5139
|
-
await client.taskArtifacts.
|
|
5140
|
-
task_id: "task_id",
|
|
5141
|
-
task_artifact_type: "image",
|
|
5142
|
-
task_artifact_is_completed: true,
|
|
5143
|
-
});
|
|
5298
|
+
await client.taskArtifacts.deleteV1("task_artifact_id");
|
|
5144
5299
|
```
|
|
5145
5300
|
|
|
5146
5301
|
</dd>
|
|
@@ -5156,7 +5311,7 @@ await client.taskArtifacts.addToTaskV1({
|
|
|
5156
5311
|
<dl>
|
|
5157
5312
|
<dd>
|
|
5158
5313
|
|
|
5159
|
-
**
|
|
5314
|
+
**taskArtifactId:** `string`
|
|
5160
5315
|
|
|
5161
5316
|
</dd>
|
|
5162
5317
|
</dl>
|
|
@@ -5255,7 +5410,7 @@ await client.offChrtShipperOrg.createV1({
|
|
|
5255
5410
|
<dl>
|
|
5256
5411
|
<dd>
|
|
5257
5412
|
|
|
5258
|
-
Lists all off-platform shipper organizations created by the
|
|
5413
|
+
Lists all off-platform shipper organizations created by the caller's organization. | () -> (list[OffChrtShipperOrg1])
|
|
5259
5414
|
|
|
5260
5415
|
</dd>
|
|
5261
5416
|
</dl>
|
|
@@ -5373,7 +5528,7 @@ await client.offChrtShipperOrg.getByIdV1("id");
|
|
|
5373
5528
|
<dl>
|
|
5374
5529
|
<dd>
|
|
5375
5530
|
|
|
5376
|
-
Deletes off-platform shipper organization owned by the
|
|
5531
|
+
Deletes off-platform shipper organization owned by the caller's organization. | () -> (bool)
|
|
5377
5532
|
|
|
5378
5533
|
</dd>
|
|
5379
5534
|
</dl>
|
|
@@ -5436,7 +5591,7 @@ await client.offChrtShipperOrg.deleteByIdV1("id");
|
|
|
5436
5591
|
<dl>
|
|
5437
5592
|
<dd>
|
|
5438
5593
|
|
|
5439
|
-
Updates existing off-platform shipper organization owned by the
|
|
5594
|
+
Updates existing off-platform shipper organization owned by the caller's organization. | (OffChrtShipperOrgClientUpdate1) -> (bool)
|
|
5440
5595
|
|
|
5441
5596
|
</dd>
|
|
5442
5597
|
</dl>
|
|
@@ -5560,9 +5715,7 @@ await client.orders.stageV1("order_id");
|
|
|
5560
5715
|
</dl>
|
|
5561
5716
|
</details>
|
|
5562
5717
|
|
|
5563
|
-
|
|
5564
|
-
|
|
5565
|
-
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
5718
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">cancelV1</a>(orderId) -> boolean</code></summary>
|
|
5566
5719
|
<dl>
|
|
5567
5720
|
<dd>
|
|
5568
5721
|
|
|
@@ -5574,7 +5727,7 @@ await client.orders.stageV1("order_id");
|
|
|
5574
5727
|
<dl>
|
|
5575
5728
|
<dd>
|
|
5576
5729
|
|
|
5577
|
-
|
|
5730
|
+
Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_org_operators] | () -> (bool)
|
|
5578
5731
|
|
|
5579
5732
|
</dd>
|
|
5580
5733
|
</dl>
|
|
@@ -5590,7 +5743,7 @@ Creates a new draft order with org assignments based on caller's organization ty
|
|
|
5590
5743
|
<dd>
|
|
5591
5744
|
|
|
5592
5745
|
```typescript
|
|
5593
|
-
await client.
|
|
5746
|
+
await client.orders.cancelV1("order_id");
|
|
5594
5747
|
```
|
|
5595
5748
|
|
|
5596
5749
|
</dd>
|
|
@@ -5606,7 +5759,7 @@ await client.orderDrafts.newV1();
|
|
|
5606
5759
|
<dl>
|
|
5607
5760
|
<dd>
|
|
5608
5761
|
|
|
5609
|
-
**
|
|
5762
|
+
**orderId:** `string`
|
|
5610
5763
|
|
|
5611
5764
|
</dd>
|
|
5612
5765
|
</dl>
|
|
@@ -5614,7 +5767,7 @@ await client.orderDrafts.newV1();
|
|
|
5614
5767
|
<dl>
|
|
5615
5768
|
<dd>
|
|
5616
5769
|
|
|
5617
|
-
**requestOptions:** `
|
|
5770
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
5618
5771
|
|
|
5619
5772
|
</dd>
|
|
5620
5773
|
</dl>
|
|
@@ -5625,7 +5778,9 @@ await client.orderDrafts.newV1();
|
|
|
5625
5778
|
</dl>
|
|
5626
5779
|
</details>
|
|
5627
5780
|
|
|
5628
|
-
|
|
5781
|
+
## OrderDrafts
|
|
5782
|
+
|
|
5783
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
5629
5784
|
<dl>
|
|
5630
5785
|
<dd>
|
|
5631
5786
|
|
|
@@ -5637,7 +5792,616 @@ await client.orderDrafts.newV1();
|
|
|
5637
5792
|
<dl>
|
|
5638
5793
|
<dd>
|
|
5639
5794
|
|
|
5640
|
-
|
|
5795
|
+
Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
5796
|
+
|
|
5797
|
+
</dd>
|
|
5798
|
+
</dl>
|
|
5799
|
+
</dd>
|
|
5800
|
+
</dl>
|
|
5801
|
+
|
|
5802
|
+
#### 🔌 Usage
|
|
5803
|
+
|
|
5804
|
+
<dl>
|
|
5805
|
+
<dd>
|
|
5806
|
+
|
|
5807
|
+
<dl>
|
|
5808
|
+
<dd>
|
|
5809
|
+
|
|
5810
|
+
```typescript
|
|
5811
|
+
await client.orderDrafts.newV1();
|
|
5812
|
+
```
|
|
5813
|
+
|
|
5814
|
+
</dd>
|
|
5815
|
+
</dl>
|
|
5816
|
+
</dd>
|
|
5817
|
+
</dl>
|
|
5818
|
+
|
|
5819
|
+
#### ⚙️ Parameters
|
|
5820
|
+
|
|
5821
|
+
<dl>
|
|
5822
|
+
<dd>
|
|
5823
|
+
|
|
5824
|
+
<dl>
|
|
5825
|
+
<dd>
|
|
5826
|
+
|
|
5827
|
+
**request:** `Chrt.OrdersNewDraftReq`
|
|
5828
|
+
|
|
5829
|
+
</dd>
|
|
5830
|
+
</dl>
|
|
5831
|
+
|
|
5832
|
+
<dl>
|
|
5833
|
+
<dd>
|
|
5834
|
+
|
|
5835
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
5836
|
+
|
|
5837
|
+
</dd>
|
|
5838
|
+
</dl>
|
|
5839
|
+
</dd>
|
|
5840
|
+
</dl>
|
|
5841
|
+
|
|
5842
|
+
</dd>
|
|
5843
|
+
</dl>
|
|
5844
|
+
</details>
|
|
5845
|
+
|
|
5846
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
|
|
5847
|
+
<dl>
|
|
5848
|
+
<dd>
|
|
5849
|
+
|
|
5850
|
+
#### 📝 Description
|
|
5851
|
+
|
|
5852
|
+
<dl>
|
|
5853
|
+
<dd>
|
|
5854
|
+
|
|
5855
|
+
<dl>
|
|
5856
|
+
<dd>
|
|
5857
|
+
|
|
5858
|
+
Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
5859
|
+
|
|
5860
|
+
</dd>
|
|
5861
|
+
</dl>
|
|
5862
|
+
</dd>
|
|
5863
|
+
</dl>
|
|
5864
|
+
|
|
5865
|
+
#### 🔌 Usage
|
|
5866
|
+
|
|
5867
|
+
<dl>
|
|
5868
|
+
<dd>
|
|
5869
|
+
|
|
5870
|
+
<dl>
|
|
5871
|
+
<dd>
|
|
5872
|
+
|
|
5873
|
+
```typescript
|
|
5874
|
+
await client.orderDrafts.updateV1({
|
|
5875
|
+
order_id: "order_id",
|
|
5876
|
+
});
|
|
5877
|
+
```
|
|
5878
|
+
|
|
5879
|
+
</dd>
|
|
5880
|
+
</dl>
|
|
5881
|
+
</dd>
|
|
5882
|
+
</dl>
|
|
5883
|
+
|
|
5884
|
+
#### ⚙️ Parameters
|
|
5885
|
+
|
|
5886
|
+
<dl>
|
|
5887
|
+
<dd>
|
|
5888
|
+
|
|
5889
|
+
<dl>
|
|
5890
|
+
<dd>
|
|
5891
|
+
|
|
5892
|
+
**request:** `Chrt.OrdersDraftUpdateReq`
|
|
5893
|
+
|
|
5894
|
+
</dd>
|
|
5895
|
+
</dl>
|
|
5896
|
+
|
|
5897
|
+
<dl>
|
|
5898
|
+
<dd>
|
|
5899
|
+
|
|
5900
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
5901
|
+
|
|
5902
|
+
</dd>
|
|
5903
|
+
</dl>
|
|
5904
|
+
</dd>
|
|
5905
|
+
</dl>
|
|
5906
|
+
|
|
5907
|
+
</dd>
|
|
5908
|
+
</dl>
|
|
5909
|
+
</details>
|
|
5910
|
+
|
|
5911
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
|
|
5912
|
+
<dl>
|
|
5913
|
+
<dd>
|
|
5914
|
+
|
|
5915
|
+
#### 📝 Description
|
|
5916
|
+
|
|
5917
|
+
<dl>
|
|
5918
|
+
<dd>
|
|
5919
|
+
|
|
5920
|
+
<dl>
|
|
5921
|
+
<dd>
|
|
5922
|
+
|
|
5923
|
+
Deletes a draft order and all associated entities. | () -> (bool)
|
|
5924
|
+
|
|
5925
|
+
</dd>
|
|
5926
|
+
</dl>
|
|
5927
|
+
</dd>
|
|
5928
|
+
</dl>
|
|
5929
|
+
|
|
5930
|
+
#### 🔌 Usage
|
|
5931
|
+
|
|
5932
|
+
<dl>
|
|
5933
|
+
<dd>
|
|
5934
|
+
|
|
5935
|
+
<dl>
|
|
5936
|
+
<dd>
|
|
5937
|
+
|
|
5938
|
+
```typescript
|
|
5939
|
+
await client.orderDrafts.deleteV1("order_id");
|
|
5940
|
+
```
|
|
5941
|
+
|
|
5942
|
+
</dd>
|
|
5943
|
+
</dl>
|
|
5944
|
+
</dd>
|
|
5945
|
+
</dl>
|
|
5946
|
+
|
|
5947
|
+
#### ⚙️ Parameters
|
|
5948
|
+
|
|
5949
|
+
<dl>
|
|
5950
|
+
<dd>
|
|
5951
|
+
|
|
5952
|
+
<dl>
|
|
5953
|
+
<dd>
|
|
5954
|
+
|
|
5955
|
+
**orderId:** `string`
|
|
5956
|
+
|
|
5957
|
+
</dd>
|
|
5958
|
+
</dl>
|
|
5959
|
+
|
|
5960
|
+
<dl>
|
|
5961
|
+
<dd>
|
|
5962
|
+
|
|
5963
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
5964
|
+
|
|
5965
|
+
</dd>
|
|
5966
|
+
</dl>
|
|
5967
|
+
</dd>
|
|
5968
|
+
</dl>
|
|
5969
|
+
|
|
5970
|
+
</dd>
|
|
5971
|
+
</dl>
|
|
5972
|
+
</details>
|
|
5973
|
+
|
|
5974
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">expandedV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderDraftExpanded</code></summary>
|
|
5975
|
+
<dl>
|
|
5976
|
+
<dd>
|
|
5977
|
+
|
|
5978
|
+
#### 📝 Description
|
|
5979
|
+
|
|
5980
|
+
<dl>
|
|
5981
|
+
<dd>
|
|
5982
|
+
|
|
5983
|
+
<dl>
|
|
5984
|
+
<dd>
|
|
5985
|
+
|
|
5986
|
+
Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
|
|
5987
|
+
|
|
5988
|
+
</dd>
|
|
5989
|
+
</dl>
|
|
5990
|
+
</dd>
|
|
5991
|
+
</dl>
|
|
5992
|
+
|
|
5993
|
+
#### 🔌 Usage
|
|
5994
|
+
|
|
5995
|
+
<dl>
|
|
5996
|
+
<dd>
|
|
5997
|
+
|
|
5998
|
+
<dl>
|
|
5999
|
+
<dd>
|
|
6000
|
+
|
|
6001
|
+
```typescript
|
|
6002
|
+
await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
6003
|
+
```
|
|
6004
|
+
|
|
6005
|
+
</dd>
|
|
6006
|
+
</dl>
|
|
6007
|
+
</dd>
|
|
6008
|
+
</dl>
|
|
6009
|
+
|
|
6010
|
+
#### ⚙️ Parameters
|
|
6011
|
+
|
|
6012
|
+
<dl>
|
|
6013
|
+
<dd>
|
|
6014
|
+
|
|
6015
|
+
<dl>
|
|
6016
|
+
<dd>
|
|
6017
|
+
|
|
6018
|
+
**orderIdOrShortId:** `string`
|
|
6019
|
+
|
|
6020
|
+
</dd>
|
|
6021
|
+
</dl>
|
|
6022
|
+
|
|
6023
|
+
<dl>
|
|
6024
|
+
<dd>
|
|
6025
|
+
|
|
6026
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
6027
|
+
|
|
6028
|
+
</dd>
|
|
6029
|
+
</dl>
|
|
6030
|
+
|
|
6031
|
+
<dl>
|
|
6032
|
+
<dd>
|
|
6033
|
+
|
|
6034
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
6035
|
+
|
|
6036
|
+
</dd>
|
|
6037
|
+
</dl>
|
|
6038
|
+
</dd>
|
|
6039
|
+
</dl>
|
|
6040
|
+
|
|
6041
|
+
</dd>
|
|
6042
|
+
</dl>
|
|
6043
|
+
</details>
|
|
6044
|
+
|
|
6045
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> boolean</code></summary>
|
|
6046
|
+
<dl>
|
|
6047
|
+
<dd>
|
|
6048
|
+
|
|
6049
|
+
#### 📝 Description
|
|
6050
|
+
|
|
6051
|
+
<dl>
|
|
6052
|
+
<dd>
|
|
6053
|
+
|
|
6054
|
+
<dl>
|
|
6055
|
+
<dd>
|
|
6056
|
+
|
|
6057
|
+
Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
|
|
6058
|
+
|
|
6059
|
+
</dd>
|
|
6060
|
+
</dl>
|
|
6061
|
+
</dd>
|
|
6062
|
+
</dl>
|
|
6063
|
+
|
|
6064
|
+
#### 🔌 Usage
|
|
6065
|
+
|
|
6066
|
+
<dl>
|
|
6067
|
+
<dd>
|
|
6068
|
+
|
|
6069
|
+
<dl>
|
|
6070
|
+
<dd>
|
|
6071
|
+
|
|
6072
|
+
```typescript
|
|
6073
|
+
await client.orderDrafts.validateV1("order_id");
|
|
6074
|
+
```
|
|
6075
|
+
|
|
6076
|
+
</dd>
|
|
6077
|
+
</dl>
|
|
6078
|
+
</dd>
|
|
6079
|
+
</dl>
|
|
6080
|
+
|
|
6081
|
+
#### ⚙️ Parameters
|
|
6082
|
+
|
|
6083
|
+
<dl>
|
|
6084
|
+
<dd>
|
|
6085
|
+
|
|
6086
|
+
<dl>
|
|
6087
|
+
<dd>
|
|
6088
|
+
|
|
6089
|
+
**orderId:** `string`
|
|
6090
|
+
|
|
6091
|
+
</dd>
|
|
6092
|
+
</dl>
|
|
6093
|
+
|
|
6094
|
+
<dl>
|
|
6095
|
+
<dd>
|
|
6096
|
+
|
|
6097
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
6098
|
+
|
|
6099
|
+
</dd>
|
|
6100
|
+
</dl>
|
|
6101
|
+
</dd>
|
|
6102
|
+
</dl>
|
|
6103
|
+
|
|
6104
|
+
</dd>
|
|
6105
|
+
</dl>
|
|
6106
|
+
</details>
|
|
6107
|
+
|
|
6108
|
+
## TaskGroups
|
|
6109
|
+
|
|
6110
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
6111
|
+
<dl>
|
|
6112
|
+
<dd>
|
|
6113
|
+
|
|
6114
|
+
#### 📝 Description
|
|
6115
|
+
|
|
6116
|
+
<dl>
|
|
6117
|
+
<dd>
|
|
6118
|
+
|
|
6119
|
+
<dl>
|
|
6120
|
+
<dd>
|
|
6121
|
+
|
|
6122
|
+
Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state. | authz_personas=[courier_driver, lig_org_operators] | () -> (bool)
|
|
6123
|
+
|
|
6124
|
+
</dd>
|
|
6125
|
+
</dl>
|
|
6126
|
+
</dd>
|
|
6127
|
+
</dl>
|
|
6128
|
+
|
|
6129
|
+
#### 🔌 Usage
|
|
6130
|
+
|
|
6131
|
+
<dl>
|
|
6132
|
+
<dd>
|
|
6133
|
+
|
|
6134
|
+
<dl>
|
|
6135
|
+
<dd>
|
|
6136
|
+
|
|
6137
|
+
```typescript
|
|
6138
|
+
await client.taskGroups.startV1("task_group_id");
|
|
6139
|
+
```
|
|
6140
|
+
|
|
6141
|
+
</dd>
|
|
6142
|
+
</dl>
|
|
6143
|
+
</dd>
|
|
6144
|
+
</dl>
|
|
6145
|
+
|
|
6146
|
+
#### ⚙️ Parameters
|
|
6147
|
+
|
|
6148
|
+
<dl>
|
|
6149
|
+
<dd>
|
|
6150
|
+
|
|
6151
|
+
<dl>
|
|
6152
|
+
<dd>
|
|
6153
|
+
|
|
6154
|
+
**taskGroupId:** `string`
|
|
6155
|
+
|
|
6156
|
+
</dd>
|
|
6157
|
+
</dl>
|
|
6158
|
+
|
|
6159
|
+
<dl>
|
|
6160
|
+
<dd>
|
|
6161
|
+
|
|
6162
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6163
|
+
|
|
6164
|
+
</dd>
|
|
6165
|
+
</dl>
|
|
6166
|
+
</dd>
|
|
6167
|
+
</dl>
|
|
6168
|
+
|
|
6169
|
+
</dd>
|
|
6170
|
+
</dl>
|
|
6171
|
+
</details>
|
|
6172
|
+
|
|
6173
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6174
|
+
<dl>
|
|
6175
|
+
<dd>
|
|
6176
|
+
|
|
6177
|
+
#### 📝 Description
|
|
6178
|
+
|
|
6179
|
+
<dl>
|
|
6180
|
+
<dd>
|
|
6181
|
+
|
|
6182
|
+
<dl>
|
|
6183
|
+
<dd>
|
|
6184
|
+
|
|
6185
|
+
Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_org_operators] | (SetTaskOrderingReq) -> (bool)
|
|
6186
|
+
|
|
6187
|
+
</dd>
|
|
6188
|
+
</dl>
|
|
6189
|
+
</dd>
|
|
6190
|
+
</dl>
|
|
6191
|
+
|
|
6192
|
+
#### 🔌 Usage
|
|
6193
|
+
|
|
6194
|
+
<dl>
|
|
6195
|
+
<dd>
|
|
6196
|
+
|
|
6197
|
+
<dl>
|
|
6198
|
+
<dd>
|
|
6199
|
+
|
|
6200
|
+
```typescript
|
|
6201
|
+
await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
6202
|
+
task_ids: ["task_ids"],
|
|
6203
|
+
});
|
|
6204
|
+
```
|
|
6205
|
+
|
|
6206
|
+
</dd>
|
|
6207
|
+
</dl>
|
|
6208
|
+
</dd>
|
|
6209
|
+
</dl>
|
|
6210
|
+
|
|
6211
|
+
#### ⚙️ Parameters
|
|
6212
|
+
|
|
6213
|
+
<dl>
|
|
6214
|
+
<dd>
|
|
6215
|
+
|
|
6216
|
+
<dl>
|
|
6217
|
+
<dd>
|
|
6218
|
+
|
|
6219
|
+
**taskGroupId:** `string`
|
|
6220
|
+
|
|
6221
|
+
</dd>
|
|
6222
|
+
</dl>
|
|
6223
|
+
|
|
6224
|
+
<dl>
|
|
6225
|
+
<dd>
|
|
6226
|
+
|
|
6227
|
+
**request:** `Chrt.SetTaskOrderingReq`
|
|
6228
|
+
|
|
6229
|
+
</dd>
|
|
6230
|
+
</dl>
|
|
6231
|
+
|
|
6232
|
+
<dl>
|
|
6233
|
+
<dd>
|
|
6234
|
+
|
|
6235
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6236
|
+
|
|
6237
|
+
</dd>
|
|
6238
|
+
</dl>
|
|
6239
|
+
</dd>
|
|
6240
|
+
</dl>
|
|
6241
|
+
|
|
6242
|
+
</dd>
|
|
6243
|
+
</dl>
|
|
6244
|
+
</details>
|
|
6245
|
+
|
|
6246
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setFlightNumberV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6247
|
+
<dl>
|
|
6248
|
+
<dd>
|
|
6249
|
+
|
|
6250
|
+
#### 📝 Description
|
|
6251
|
+
|
|
6252
|
+
<dl>
|
|
6253
|
+
<dd>
|
|
6254
|
+
|
|
6255
|
+
<dl>
|
|
6256
|
+
<dd>
|
|
6257
|
+
|
|
6258
|
+
Sets the flight number on a task group, plus any TENDER_TO_AIRLINE tasks in the immediately preceding task group and RECOVER_FROM_AIRLINE tasks in the immediately following task group. | authz_personas=[lig_org_operators] | (SetFlightNumberReq) -> (bool)
|
|
6259
|
+
|
|
6260
|
+
</dd>
|
|
6261
|
+
</dl>
|
|
6262
|
+
</dd>
|
|
6263
|
+
</dl>
|
|
6264
|
+
|
|
6265
|
+
#### 🔌 Usage
|
|
6266
|
+
|
|
6267
|
+
<dl>
|
|
6268
|
+
<dd>
|
|
6269
|
+
|
|
6270
|
+
<dl>
|
|
6271
|
+
<dd>
|
|
6272
|
+
|
|
6273
|
+
```typescript
|
|
6274
|
+
await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
6275
|
+
flight_number: "flight_number",
|
|
6276
|
+
});
|
|
6277
|
+
```
|
|
6278
|
+
|
|
6279
|
+
</dd>
|
|
6280
|
+
</dl>
|
|
6281
|
+
</dd>
|
|
6282
|
+
</dl>
|
|
6283
|
+
|
|
6284
|
+
#### ⚙️ Parameters
|
|
6285
|
+
|
|
6286
|
+
<dl>
|
|
6287
|
+
<dd>
|
|
6288
|
+
|
|
6289
|
+
<dl>
|
|
6290
|
+
<dd>
|
|
6291
|
+
|
|
6292
|
+
**taskGroupId:** `string`
|
|
6293
|
+
|
|
6294
|
+
</dd>
|
|
6295
|
+
</dl>
|
|
6296
|
+
|
|
6297
|
+
<dl>
|
|
6298
|
+
<dd>
|
|
6299
|
+
|
|
6300
|
+
**request:** `Chrt.SetFlightNumberReq`
|
|
6301
|
+
|
|
6302
|
+
</dd>
|
|
6303
|
+
</dl>
|
|
6304
|
+
|
|
6305
|
+
<dl>
|
|
6306
|
+
<dd>
|
|
6307
|
+
|
|
6308
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6309
|
+
|
|
6310
|
+
</dd>
|
|
6311
|
+
</dl>
|
|
6312
|
+
</dd>
|
|
6313
|
+
</dl>
|
|
6314
|
+
|
|
6315
|
+
</dd>
|
|
6316
|
+
</dl>
|
|
6317
|
+
</details>
|
|
6318
|
+
|
|
6319
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6320
|
+
<dl>
|
|
6321
|
+
<dd>
|
|
6322
|
+
|
|
6323
|
+
#### 📝 Description
|
|
6324
|
+
|
|
6325
|
+
<dl>
|
|
6326
|
+
<dd>
|
|
6327
|
+
|
|
6328
|
+
<dl>
|
|
6329
|
+
<dd>
|
|
6330
|
+
|
|
6331
|
+
Updates the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateDriverReq) -> (bool)
|
|
6332
|
+
|
|
6333
|
+
</dd>
|
|
6334
|
+
</dl>
|
|
6335
|
+
</dd>
|
|
6336
|
+
</dl>
|
|
6337
|
+
|
|
6338
|
+
#### 🔌 Usage
|
|
6339
|
+
|
|
6340
|
+
<dl>
|
|
6341
|
+
<dd>
|
|
6342
|
+
|
|
6343
|
+
<dl>
|
|
6344
|
+
<dd>
|
|
6345
|
+
|
|
6346
|
+
```typescript
|
|
6347
|
+
await client.taskGroups.updateDriverV1("task_group_id", {
|
|
6348
|
+
driver_id: "driver_id",
|
|
6349
|
+
});
|
|
6350
|
+
```
|
|
6351
|
+
|
|
6352
|
+
</dd>
|
|
6353
|
+
</dl>
|
|
6354
|
+
</dd>
|
|
6355
|
+
</dl>
|
|
6356
|
+
|
|
6357
|
+
#### ⚙️ Parameters
|
|
6358
|
+
|
|
6359
|
+
<dl>
|
|
6360
|
+
<dd>
|
|
6361
|
+
|
|
6362
|
+
<dl>
|
|
6363
|
+
<dd>
|
|
6364
|
+
|
|
6365
|
+
**taskGroupId:** `string`
|
|
6366
|
+
|
|
6367
|
+
</dd>
|
|
6368
|
+
</dl>
|
|
6369
|
+
|
|
6370
|
+
<dl>
|
|
6371
|
+
<dd>
|
|
6372
|
+
|
|
6373
|
+
**request:** `Chrt.UpdateDriverReq`
|
|
6374
|
+
|
|
6375
|
+
</dd>
|
|
6376
|
+
</dl>
|
|
6377
|
+
|
|
6378
|
+
<dl>
|
|
6379
|
+
<dd>
|
|
6380
|
+
|
|
6381
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6382
|
+
|
|
6383
|
+
</dd>
|
|
6384
|
+
</dl>
|
|
6385
|
+
</dd>
|
|
6386
|
+
</dl>
|
|
6387
|
+
|
|
6388
|
+
</dd>
|
|
6389
|
+
</dl>
|
|
6390
|
+
</details>
|
|
6391
|
+
|
|
6392
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">removeDriverV1</a>(taskGroupId) -> boolean</code></summary>
|
|
6393
|
+
<dl>
|
|
6394
|
+
<dd>
|
|
6395
|
+
|
|
6396
|
+
#### 📝 Description
|
|
6397
|
+
|
|
6398
|
+
<dl>
|
|
6399
|
+
<dd>
|
|
6400
|
+
|
|
6401
|
+
<dl>
|
|
6402
|
+
<dd>
|
|
6403
|
+
|
|
6404
|
+
Removes the driver from a task group (sets driver_id to null). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
|
|
5641
6405
|
|
|
5642
6406
|
</dd>
|
|
5643
6407
|
</dl>
|
|
@@ -5653,9 +6417,7 @@ Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDra
|
|
|
5653
6417
|
<dd>
|
|
5654
6418
|
|
|
5655
6419
|
```typescript
|
|
5656
|
-
await client.
|
|
5657
|
-
order_id: "order_id",
|
|
5658
|
-
});
|
|
6420
|
+
await client.taskGroups.removeDriverV1("task_group_id");
|
|
5659
6421
|
```
|
|
5660
6422
|
|
|
5661
6423
|
</dd>
|
|
@@ -5671,7 +6433,7 @@ await client.orderDrafts.updateV1({
|
|
|
5671
6433
|
<dl>
|
|
5672
6434
|
<dd>
|
|
5673
6435
|
|
|
5674
|
-
**
|
|
6436
|
+
**taskGroupId:** `string`
|
|
5675
6437
|
|
|
5676
6438
|
</dd>
|
|
5677
6439
|
</dl>
|
|
@@ -5679,7 +6441,7 @@ await client.orderDrafts.updateV1({
|
|
|
5679
6441
|
<dl>
|
|
5680
6442
|
<dd>
|
|
5681
6443
|
|
|
5682
|
-
**requestOptions:** `
|
|
6444
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
5683
6445
|
|
|
5684
6446
|
</dd>
|
|
5685
6447
|
</dl>
|
|
@@ -5690,7 +6452,7 @@ await client.orderDrafts.updateV1({
|
|
|
5690
6452
|
</dl>
|
|
5691
6453
|
</details>
|
|
5692
6454
|
|
|
5693
|
-
<details><summary><code>client.
|
|
6455
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateCourierOrgV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
5694
6456
|
<dl>
|
|
5695
6457
|
<dd>
|
|
5696
6458
|
|
|
@@ -5702,7 +6464,7 @@ await client.orderDrafts.updateV1({
|
|
|
5702
6464
|
<dl>
|
|
5703
6465
|
<dd>
|
|
5704
6466
|
|
|
5705
|
-
|
|
6467
|
+
Updates the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateCourierOrgReq) -> (bool)
|
|
5706
6468
|
|
|
5707
6469
|
</dd>
|
|
5708
6470
|
</dl>
|
|
@@ -5718,7 +6480,9 @@ Deletes a draft order and all associated entities. | () -> (bool)
|
|
|
5718
6480
|
<dd>
|
|
5719
6481
|
|
|
5720
6482
|
```typescript
|
|
5721
|
-
await client.
|
|
6483
|
+
await client.taskGroups.updateCourierOrgV1("task_group_id", {
|
|
6484
|
+
courier_org_id: "courier_org_id",
|
|
6485
|
+
});
|
|
5722
6486
|
```
|
|
5723
6487
|
|
|
5724
6488
|
</dd>
|
|
@@ -5734,7 +6498,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5734
6498
|
<dl>
|
|
5735
6499
|
<dd>
|
|
5736
6500
|
|
|
5737
|
-
**
|
|
6501
|
+
**taskGroupId:** `string`
|
|
5738
6502
|
|
|
5739
6503
|
</dd>
|
|
5740
6504
|
</dl>
|
|
@@ -5742,7 +6506,15 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5742
6506
|
<dl>
|
|
5743
6507
|
<dd>
|
|
5744
6508
|
|
|
5745
|
-
**
|
|
6509
|
+
**request:** `Chrt.UpdateCourierOrgReq`
|
|
6510
|
+
|
|
6511
|
+
</dd>
|
|
6512
|
+
</dl>
|
|
6513
|
+
|
|
6514
|
+
<dl>
|
|
6515
|
+
<dd>
|
|
6516
|
+
|
|
6517
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
5746
6518
|
|
|
5747
6519
|
</dd>
|
|
5748
6520
|
</dl>
|
|
@@ -5753,7 +6525,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5753
6525
|
</dl>
|
|
5754
6526
|
</details>
|
|
5755
6527
|
|
|
5756
|
-
<details><summary><code>client.
|
|
6528
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">addMessageV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
5757
6529
|
<dl>
|
|
5758
6530
|
<dd>
|
|
5759
6531
|
|
|
@@ -5765,7 +6537,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5765
6537
|
<dl>
|
|
5766
6538
|
<dd>
|
|
5767
6539
|
|
|
5768
|
-
|
|
6540
|
+
Adds a message to a task group's message log. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
|
|
5769
6541
|
|
|
5770
6542
|
</dd>
|
|
5771
6543
|
</dl>
|
|
@@ -5781,7 +6553,9 @@ Fetches a single draft order with optional expanded related data. Only the creat
|
|
|
5781
6553
|
<dd>
|
|
5782
6554
|
|
|
5783
6555
|
```typescript
|
|
5784
|
-
await client.
|
|
6556
|
+
await client.taskGroups.addMessageV1("task_group_id", {
|
|
6557
|
+
message: "message",
|
|
6558
|
+
});
|
|
5785
6559
|
```
|
|
5786
6560
|
|
|
5787
6561
|
</dd>
|
|
@@ -5797,7 +6571,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
|
5797
6571
|
<dl>
|
|
5798
6572
|
<dd>
|
|
5799
6573
|
|
|
5800
|
-
**
|
|
6574
|
+
**taskGroupId:** `string`
|
|
5801
6575
|
|
|
5802
6576
|
</dd>
|
|
5803
6577
|
</dl>
|
|
@@ -5805,7 +6579,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
|
5805
6579
|
<dl>
|
|
5806
6580
|
<dd>
|
|
5807
6581
|
|
|
5808
|
-
**request:** `Chrt.
|
|
6582
|
+
**request:** `Chrt.AddMessageReq`
|
|
5809
6583
|
|
|
5810
6584
|
</dd>
|
|
5811
6585
|
</dl>
|
|
@@ -5813,7 +6587,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
|
5813
6587
|
<dl>
|
|
5814
6588
|
<dd>
|
|
5815
6589
|
|
|
5816
|
-
**requestOptions:** `
|
|
6590
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
5817
6591
|
|
|
5818
6592
|
</dd>
|
|
5819
6593
|
</dl>
|
|
@@ -5824,7 +6598,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
|
5824
6598
|
</dl>
|
|
5825
6599
|
</details>
|
|
5826
6600
|
|
|
5827
|
-
<details><summary><code>client.
|
|
6601
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">addS3ObjectV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
5828
6602
|
<dl>
|
|
5829
6603
|
<dd>
|
|
5830
6604
|
|
|
@@ -5836,7 +6610,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
|
5836
6610
|
<dl>
|
|
5837
6611
|
<dd>
|
|
5838
6612
|
|
|
5839
|
-
|
|
6613
|
+
Uploads an image file to a task group with automatic blurhash generation. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
5840
6614
|
|
|
5841
6615
|
</dd>
|
|
5842
6616
|
</dl>
|
|
@@ -5852,7 +6626,9 @@ Checks whether the draft order satisfies all requirements to move into staging.
|
|
|
5852
6626
|
<dd>
|
|
5853
6627
|
|
|
5854
6628
|
```typescript
|
|
5855
|
-
await client.
|
|
6629
|
+
await client.taskGroups.addS3ObjectV1("task_group_id", {
|
|
6630
|
+
image: fs.createReadStream("/path/to/your/file"),
|
|
6631
|
+
});
|
|
5856
6632
|
```
|
|
5857
6633
|
|
|
5858
6634
|
</dd>
|
|
@@ -5868,7 +6644,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5868
6644
|
<dl>
|
|
5869
6645
|
<dd>
|
|
5870
6646
|
|
|
5871
|
-
**
|
|
6647
|
+
**taskGroupId:** `string`
|
|
5872
6648
|
|
|
5873
6649
|
</dd>
|
|
5874
6650
|
</dl>
|
|
@@ -5876,7 +6652,15 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5876
6652
|
<dl>
|
|
5877
6653
|
<dd>
|
|
5878
6654
|
|
|
5879
|
-
**
|
|
6655
|
+
**request:** `Chrt.BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost`
|
|
6656
|
+
|
|
6657
|
+
</dd>
|
|
6658
|
+
</dl>
|
|
6659
|
+
|
|
6660
|
+
<dl>
|
|
6661
|
+
<dd>
|
|
6662
|
+
|
|
6663
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
5880
6664
|
|
|
5881
6665
|
</dd>
|
|
5882
6666
|
</dl>
|
|
@@ -5887,9 +6671,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5887
6671
|
</dl>
|
|
5888
6672
|
</details>
|
|
5889
6673
|
|
|
5890
|
-
|
|
5891
|
-
|
|
5892
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getTaskGroupIdForCourierOperatorsV1</a>(byOrderIdOrShortId) -> string</code></summary>
|
|
6674
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">deleteS3ObjectV1</a>(taskGroupS3ObjectMetadataId) -> boolean</code></summary>
|
|
5893
6675
|
<dl>
|
|
5894
6676
|
<dd>
|
|
5895
6677
|
|
|
@@ -5901,7 +6683,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5901
6683
|
<dl>
|
|
5902
6684
|
<dd>
|
|
5903
6685
|
|
|
5904
|
-
|
|
6686
|
+
Deletes an S3 object metadata and the associated S3 object from a task group. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
|
|
5905
6687
|
|
|
5906
6688
|
</dd>
|
|
5907
6689
|
</dl>
|
|
@@ -5917,7 +6699,7 @@ Retrieves the task group ID for the courier organization assigned to an order. |
|
|
|
5917
6699
|
<dd>
|
|
5918
6700
|
|
|
5919
6701
|
```typescript
|
|
5920
|
-
await client.taskGroups.
|
|
6702
|
+
await client.taskGroups.deleteS3ObjectV1("task_group_s3_object_metadata_id");
|
|
5921
6703
|
```
|
|
5922
6704
|
|
|
5923
6705
|
</dd>
|
|
@@ -5933,7 +6715,7 @@ await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_shor
|
|
|
5933
6715
|
<dl>
|
|
5934
6716
|
<dd>
|
|
5935
6717
|
|
|
5936
|
-
**
|
|
6718
|
+
**taskGroupS3ObjectMetadataId:** `string`
|
|
5937
6719
|
|
|
5938
6720
|
</dd>
|
|
5939
6721
|
</dl>
|
|
@@ -5952,7 +6734,9 @@ await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_shor
|
|
|
5952
6734
|
</dl>
|
|
5953
6735
|
</details>
|
|
5954
6736
|
|
|
5955
|
-
|
|
6737
|
+
## Tasks
|
|
6738
|
+
|
|
6739
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">addToTaskGroupV1</a>(taskGroupId, { ...params }) -> string</code></summary>
|
|
5956
6740
|
<dl>
|
|
5957
6741
|
<dd>
|
|
5958
6742
|
|
|
@@ -5964,7 +6748,7 @@ await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_shor
|
|
|
5964
6748
|
<dl>
|
|
5965
6749
|
<dd>
|
|
5966
6750
|
|
|
5967
|
-
|
|
6751
|
+
Adds a new task to a task group at a specific index. | authz_personas=[lig_org_operators] | (AddTaskToGroupReq) -> (PydanticObjectId)
|
|
5968
6752
|
|
|
5969
6753
|
</dd>
|
|
5970
6754
|
</dl>
|
|
@@ -5980,7 +6764,13 @@ Retrieves the task group ID for the courier driver assigned to an order. | authz
|
|
|
5980
6764
|
<dd>
|
|
5981
6765
|
|
|
5982
6766
|
```typescript
|
|
5983
|
-
await client.
|
|
6767
|
+
await client.tasks.addToTaskGroupV1("task_group_id", {
|
|
6768
|
+
task: {
|
|
6769
|
+
schema_version: 1,
|
|
6770
|
+
},
|
|
6771
|
+
status: "draft",
|
|
6772
|
+
index: 1,
|
|
6773
|
+
});
|
|
5984
6774
|
```
|
|
5985
6775
|
|
|
5986
6776
|
</dd>
|
|
@@ -5996,7 +6786,7 @@ await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_i
|
|
|
5996
6786
|
<dl>
|
|
5997
6787
|
<dd>
|
|
5998
6788
|
|
|
5999
|
-
**
|
|
6789
|
+
**taskGroupId:** `string`
|
|
6000
6790
|
|
|
6001
6791
|
</dd>
|
|
6002
6792
|
</dl>
|
|
@@ -6004,7 +6794,15 @@ await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_i
|
|
|
6004
6794
|
<dl>
|
|
6005
6795
|
<dd>
|
|
6006
6796
|
|
|
6007
|
-
**
|
|
6797
|
+
**request:** `Chrt.AddTaskToGroupReq`
|
|
6798
|
+
|
|
6799
|
+
</dd>
|
|
6800
|
+
</dl>
|
|
6801
|
+
|
|
6802
|
+
<dl>
|
|
6803
|
+
<dd>
|
|
6804
|
+
|
|
6805
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6008
6806
|
|
|
6009
6807
|
</dd>
|
|
6010
6808
|
</dl>
|
|
@@ -6015,7 +6813,7 @@ await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_i
|
|
|
6015
6813
|
</dl>
|
|
6016
6814
|
</details>
|
|
6017
6815
|
|
|
6018
|
-
<details><summary><code>client.
|
|
6816
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">updateV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
6019
6817
|
<dl>
|
|
6020
6818
|
<dd>
|
|
6021
6819
|
|
|
@@ -6027,7 +6825,7 @@ await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_i
|
|
|
6027
6825
|
<dl>
|
|
6028
6826
|
<dd>
|
|
6029
6827
|
|
|
6030
|
-
Updates
|
|
6828
|
+
Updates a task. Task must be in STAGED status. | authz_personas=[lig_org_operators] | (TaskClientUpdate1) -> (PydanticObjectId)
|
|
6031
6829
|
|
|
6032
6830
|
</dd>
|
|
6033
6831
|
</dl>
|
|
@@ -6043,9 +6841,7 @@ Updates the ordering of tasks in a task group. Task group must be in STAGED or I
|
|
|
6043
6841
|
<dd>
|
|
6044
6842
|
|
|
6045
6843
|
```typescript
|
|
6046
|
-
await client.
|
|
6047
|
-
task_ordering: ["task_ordering"],
|
|
6048
|
-
});
|
|
6844
|
+
await client.tasks.updateV1("task_id", {});
|
|
6049
6845
|
```
|
|
6050
6846
|
|
|
6051
6847
|
</dd>
|
|
@@ -6061,7 +6857,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6061
6857
|
<dl>
|
|
6062
6858
|
<dd>
|
|
6063
6859
|
|
|
6064
|
-
**
|
|
6860
|
+
**taskId:** `string`
|
|
6065
6861
|
|
|
6066
6862
|
</dd>
|
|
6067
6863
|
</dl>
|
|
@@ -6069,7 +6865,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6069
6865
|
<dl>
|
|
6070
6866
|
<dd>
|
|
6071
6867
|
|
|
6072
|
-
**request:** `Chrt.
|
|
6868
|
+
**request:** `Chrt.TaskClientUpdate1`
|
|
6073
6869
|
|
|
6074
6870
|
</dd>
|
|
6075
6871
|
</dl>
|
|
@@ -6077,7 +6873,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6077
6873
|
<dl>
|
|
6078
6874
|
<dd>
|
|
6079
6875
|
|
|
6080
|
-
**requestOptions:** `
|
|
6876
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6081
6877
|
|
|
6082
6878
|
</dd>
|
|
6083
6879
|
</dl>
|
|
@@ -6088,7 +6884,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6088
6884
|
</dl>
|
|
6089
6885
|
</details>
|
|
6090
6886
|
|
|
6091
|
-
<details><summary><code>client.
|
|
6887
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">completeV1</a>(taskId) -> boolean</code></summary>
|
|
6092
6888
|
<dl>
|
|
6093
6889
|
<dd>
|
|
6094
6890
|
|
|
@@ -6100,7 +6896,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6100
6896
|
<dl>
|
|
6101
6897
|
<dd>
|
|
6102
6898
|
|
|
6103
|
-
|
|
6899
|
+
Marks a task as COMPLETED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)
|
|
6104
6900
|
|
|
6105
6901
|
</dd>
|
|
6106
6902
|
</dl>
|
|
@@ -6116,9 +6912,7 @@ Updates the flight number on both task group and all its tasks. Task group must
|
|
|
6116
6912
|
<dd>
|
|
6117
6913
|
|
|
6118
6914
|
```typescript
|
|
6119
|
-
await client.
|
|
6120
|
-
flight_number: "flight_number",
|
|
6121
|
-
});
|
|
6915
|
+
await client.tasks.completeV1("task_id");
|
|
6122
6916
|
```
|
|
6123
6917
|
|
|
6124
6918
|
</dd>
|
|
@@ -6134,15 +6928,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6134
6928
|
<dl>
|
|
6135
6929
|
<dd>
|
|
6136
6930
|
|
|
6137
|
-
**
|
|
6138
|
-
|
|
6139
|
-
</dd>
|
|
6140
|
-
</dl>
|
|
6141
|
-
|
|
6142
|
-
<dl>
|
|
6143
|
-
<dd>
|
|
6144
|
-
|
|
6145
|
-
**request:** `Chrt.SetFlightNumberReq`
|
|
6931
|
+
**taskId:** `string`
|
|
6146
6932
|
|
|
6147
6933
|
</dd>
|
|
6148
6934
|
</dl>
|
|
@@ -6150,7 +6936,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6150
6936
|
<dl>
|
|
6151
6937
|
<dd>
|
|
6152
6938
|
|
|
6153
|
-
**requestOptions:** `
|
|
6939
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6154
6940
|
|
|
6155
6941
|
</dd>
|
|
6156
6942
|
</dl>
|
|
@@ -6161,7 +6947,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6161
6947
|
</dl>
|
|
6162
6948
|
</details>
|
|
6163
6949
|
|
|
6164
|
-
<details><summary><code>client.
|
|
6950
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">skipV1</a>(taskId) -> boolean</code></summary>
|
|
6165
6951
|
<dl>
|
|
6166
6952
|
<dd>
|
|
6167
6953
|
|
|
@@ -6173,7 +6959,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6173
6959
|
<dl>
|
|
6174
6960
|
<dd>
|
|
6175
6961
|
|
|
6176
|
-
|
|
6962
|
+
Marks a task as SKIPPED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)
|
|
6177
6963
|
|
|
6178
6964
|
</dd>
|
|
6179
6965
|
</dl>
|
|
@@ -6189,7 +6975,7 @@ Sets or removes the driver assigned to a task group. | authz_personas=[courier_o
|
|
|
6189
6975
|
<dd>
|
|
6190
6976
|
|
|
6191
6977
|
```typescript
|
|
6192
|
-
await client.
|
|
6978
|
+
await client.tasks.skipV1("task_id");
|
|
6193
6979
|
```
|
|
6194
6980
|
|
|
6195
6981
|
</dd>
|
|
@@ -6205,15 +6991,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6205
6991
|
<dl>
|
|
6206
6992
|
<dd>
|
|
6207
6993
|
|
|
6208
|
-
**
|
|
6209
|
-
|
|
6210
|
-
</dd>
|
|
6211
|
-
</dl>
|
|
6212
|
-
|
|
6213
|
-
<dl>
|
|
6214
|
-
<dd>
|
|
6215
|
-
|
|
6216
|
-
**request:** `Chrt.UpdateTaskGroupDriverReq`
|
|
6994
|
+
**taskId:** `string`
|
|
6217
6995
|
|
|
6218
6996
|
</dd>
|
|
6219
6997
|
</dl>
|
|
@@ -6221,7 +6999,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6221
6999
|
<dl>
|
|
6222
7000
|
<dd>
|
|
6223
7001
|
|
|
6224
|
-
**requestOptions:** `
|
|
7002
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6225
7003
|
|
|
6226
7004
|
</dd>
|
|
6227
7005
|
</dl>
|
|
@@ -6232,7 +7010,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6232
7010
|
</dl>
|
|
6233
7011
|
</details>
|
|
6234
7012
|
|
|
6235
|
-
<details><summary><code>client.
|
|
7013
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
|
|
6236
7014
|
<dl>
|
|
6237
7015
|
<dd>
|
|
6238
7016
|
|
|
@@ -6244,7 +7022,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6244
7022
|
<dl>
|
|
6245
7023
|
<dd>
|
|
6246
7024
|
|
|
6247
|
-
|
|
7025
|
+
Deletes a task. Task must be in STAGED status. | authz_personas=[lig_org_operators] | () -> (bool)
|
|
6248
7026
|
|
|
6249
7027
|
</dd>
|
|
6250
7028
|
</dl>
|
|
@@ -6260,7 +7038,7 @@ Sets or removes the courier organization assigned to a task group. | authz_perso
|
|
|
6260
7038
|
<dd>
|
|
6261
7039
|
|
|
6262
7040
|
```typescript
|
|
6263
|
-
await client.
|
|
7041
|
+
await client.tasks.deleteV1("task_id");
|
|
6264
7042
|
```
|
|
6265
7043
|
|
|
6266
7044
|
</dd>
|
|
@@ -6276,15 +7054,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6276
7054
|
<dl>
|
|
6277
7055
|
<dd>
|
|
6278
7056
|
|
|
6279
|
-
**
|
|
6280
|
-
|
|
6281
|
-
</dd>
|
|
6282
|
-
</dl>
|
|
6283
|
-
|
|
6284
|
-
<dl>
|
|
6285
|
-
<dd>
|
|
6286
|
-
|
|
6287
|
-
**request:** `Chrt.UpdateTaskGroupCourierOrgReq`
|
|
7057
|
+
**taskId:** `string`
|
|
6288
7058
|
|
|
6289
7059
|
</dd>
|
|
6290
7060
|
</dl>
|
|
@@ -6292,7 +7062,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6292
7062
|
<dl>
|
|
6293
7063
|
<dd>
|
|
6294
7064
|
|
|
6295
|
-
**requestOptions:** `
|
|
7065
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6296
7066
|
|
|
6297
7067
|
</dd>
|
|
6298
7068
|
</dl>
|
|
@@ -6303,7 +7073,9 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6303
7073
|
</dl>
|
|
6304
7074
|
</details>
|
|
6305
7075
|
|
|
6306
|
-
|
|
7076
|
+
## ShipperContactInfo
|
|
7077
|
+
|
|
7078
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getCallerV1</a>() -> Chrt.ShipperContact1</code></summary>
|
|
6307
7079
|
<dl>
|
|
6308
7080
|
<dd>
|
|
6309
7081
|
|
|
@@ -6315,7 +7087,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6315
7087
|
<dl>
|
|
6316
7088
|
<dd>
|
|
6317
7089
|
|
|
6318
|
-
|
|
7090
|
+
Retrieves the shipper contact information associated with the caller's ID. | () -> (ShipperContact1)
|
|
6319
7091
|
|
|
6320
7092
|
</dd>
|
|
6321
7093
|
</dl>
|
|
@@ -6331,7 +7103,7 @@ Starts a task group by changing its status to in-progress and updating the order
|
|
|
6331
7103
|
<dd>
|
|
6332
7104
|
|
|
6333
7105
|
```typescript
|
|
6334
|
-
await client.
|
|
7106
|
+
await client.shipperContactInfo.getCallerV1();
|
|
6335
7107
|
```
|
|
6336
7108
|
|
|
6337
7109
|
</dd>
|
|
@@ -6347,15 +7119,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6347
7119
|
<dl>
|
|
6348
7120
|
<dd>
|
|
6349
7121
|
|
|
6350
|
-
**
|
|
6351
|
-
|
|
6352
|
-
</dd>
|
|
6353
|
-
</dl>
|
|
6354
|
-
|
|
6355
|
-
<dl>
|
|
6356
|
-
<dd>
|
|
6357
|
-
|
|
6358
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
7122
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6359
7123
|
|
|
6360
7124
|
</dd>
|
|
6361
7125
|
</dl>
|
|
@@ -6366,9 +7130,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6366
7130
|
</dl>
|
|
6367
7131
|
</details>
|
|
6368
7132
|
|
|
6369
|
-
|
|
6370
|
-
|
|
6371
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByJwtUserIdV1</a>() -> Chrt.ShipperContact1</code></summary>
|
|
7133
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listV1</a>() -> Chrt.ShipperContact1[]</code></summary>
|
|
6372
7134
|
<dl>
|
|
6373
7135
|
<dd>
|
|
6374
7136
|
|
|
@@ -6380,7 +7142,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6380
7142
|
<dl>
|
|
6381
7143
|
<dd>
|
|
6382
7144
|
|
|
6383
|
-
|
|
7145
|
+
Lists all shipper contacts for the caller's organization. | () -> (list[ShipperContact1])
|
|
6384
7146
|
|
|
6385
7147
|
</dd>
|
|
6386
7148
|
</dl>
|
|
@@ -6396,7 +7158,7 @@ Retrieves the authenticated user's own shipper contact information. | () -> (Shi
|
|
|
6396
7158
|
<dd>
|
|
6397
7159
|
|
|
6398
7160
|
```typescript
|
|
6399
|
-
await client.shipperContactInfo.
|
|
7161
|
+
await client.shipperContactInfo.listV1();
|
|
6400
7162
|
```
|
|
6401
7163
|
|
|
6402
7164
|
</dd>
|
|
@@ -6423,7 +7185,7 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
6423
7185
|
</dl>
|
|
6424
7186
|
</details>
|
|
6425
7187
|
|
|
6426
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">
|
|
7188
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listCourierContactsV1</a>(shipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
|
|
6427
7189
|
<dl>
|
|
6428
7190
|
<dd>
|
|
6429
7191
|
|
|
@@ -6435,7 +7197,7 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
6435
7197
|
<dl>
|
|
6436
7198
|
<dd>
|
|
6437
7199
|
|
|
6438
|
-
Lists all shipper contacts
|
|
7200
|
+
Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])
|
|
6439
7201
|
|
|
6440
7202
|
</dd>
|
|
6441
7203
|
</dl>
|
|
@@ -6451,7 +7213,7 @@ Lists all shipper contacts created by the authenticated organization. | () -> (l
|
|
|
6451
7213
|
<dd>
|
|
6452
7214
|
|
|
6453
7215
|
```typescript
|
|
6454
|
-
await client.shipperContactInfo.
|
|
7216
|
+
await client.shipperContactInfo.listCourierContactsV1("shipper_org_id");
|
|
6455
7217
|
```
|
|
6456
7218
|
|
|
6457
7219
|
</dd>
|
|
@@ -6467,6 +7229,14 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
6467
7229
|
<dl>
|
|
6468
7230
|
<dd>
|
|
6469
7231
|
|
|
7232
|
+
**shipperOrgId:** `string`
|
|
7233
|
+
|
|
7234
|
+
</dd>
|
|
7235
|
+
</dl>
|
|
7236
|
+
|
|
7237
|
+
<dl>
|
|
7238
|
+
<dd>
|
|
7239
|
+
|
|
6470
7240
|
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6471
7241
|
|
|
6472
7242
|
</dd>
|
|
@@ -6478,7 +7248,7 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
6478
7248
|
</dl>
|
|
6479
7249
|
</details>
|
|
6480
7250
|
|
|
6481
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">
|
|
7251
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listForwarderContactsV1</a>(shipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
|
|
6482
7252
|
<dl>
|
|
6483
7253
|
<dd>
|
|
6484
7254
|
|
|
@@ -6490,7 +7260,7 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
6490
7260
|
<dl>
|
|
6491
7261
|
<dd>
|
|
6492
7262
|
|
|
6493
|
-
Lists all shipper contacts accessible to the
|
|
7263
|
+
Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper. | () -> (list[ShipperContact1])
|
|
6494
7264
|
|
|
6495
7265
|
</dd>
|
|
6496
7266
|
</dl>
|
|
@@ -6506,7 +7276,7 @@ Lists all shipper contacts accessible to the courier organization for a specific
|
|
|
6506
7276
|
<dd>
|
|
6507
7277
|
|
|
6508
7278
|
```typescript
|
|
6509
|
-
await client.shipperContactInfo.
|
|
7279
|
+
await client.shipperContactInfo.listForwarderContactsV1("shipper_org_id");
|
|
6510
7280
|
```
|
|
6511
7281
|
|
|
6512
7282
|
</dd>
|
|
@@ -6541,7 +7311,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
6541
7311
|
</dl>
|
|
6542
7312
|
</details>
|
|
6543
7313
|
|
|
6544
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">
|
|
7314
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listOffPlatformContactsV1</a>(offChrtShipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
|
|
6545
7315
|
<dl>
|
|
6546
7316
|
<dd>
|
|
6547
7317
|
|
|
@@ -6553,7 +7323,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
6553
7323
|
<dl>
|
|
6554
7324
|
<dd>
|
|
6555
7325
|
|
|
6556
|
-
Lists all shipper contacts for a specific off-platform shipper
|
|
7326
|
+
Lists all shipper contacts for a specific off-platform shipper. | () -> (list[ShipperContact1])
|
|
6557
7327
|
|
|
6558
7328
|
</dd>
|
|
6559
7329
|
</dl>
|
|
@@ -6569,7 +7339,7 @@ Lists all shipper contacts for a specific off-platform shipper connection. | ()
|
|
|
6569
7339
|
<dd>
|
|
6570
7340
|
|
|
6571
7341
|
```typescript
|
|
6572
|
-
await client.shipperContactInfo.
|
|
7342
|
+
await client.shipperContactInfo.listOffPlatformContactsV1("off_chrt_shipper_org_id");
|
|
6573
7343
|
```
|
|
6574
7344
|
|
|
6575
7345
|
</dd>
|
|
@@ -6604,7 +7374,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
6604
7374
|
</dl>
|
|
6605
7375
|
</details>
|
|
6606
7376
|
|
|
6607
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">
|
|
7377
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getV1</a>(id) -> Chrt.ShipperContact1</code></summary>
|
|
6608
7378
|
<dl>
|
|
6609
7379
|
<dd>
|
|
6610
7380
|
|
|
@@ -6632,7 +7402,7 @@ Retrieves a specific shipper contact by ID if authorized to access it. | () -> (
|
|
|
6632
7402
|
<dd>
|
|
6633
7403
|
|
|
6634
7404
|
```typescript
|
|
6635
|
-
await client.shipperContactInfo.
|
|
7405
|
+
await client.shipperContactInfo.getV1("id");
|
|
6636
7406
|
```
|
|
6637
7407
|
|
|
6638
7408
|
</dd>
|
|
@@ -6809,7 +7579,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
6809
7579
|
<dl>
|
|
6810
7580
|
<dd>
|
|
6811
7581
|
|
|
6812
|
-
Updates existing shipper contact information owned by the
|
|
7582
|
+
Updates existing shipper contact information owned by the caller's organization. | (ShipperContactClientUpdate1) -> (bool)
|
|
6813
7583
|
|
|
6814
7584
|
</dd>
|
|
6815
7585
|
</dl>
|
|
@@ -6868,7 +7638,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
6868
7638
|
</dl>
|
|
6869
7639
|
</details>
|
|
6870
7640
|
|
|
6871
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">
|
|
7641
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">deleteV1</a>(id) -> boolean</code></summary>
|
|
6872
7642
|
<dl>
|
|
6873
7643
|
<dd>
|
|
6874
7644
|
|
|
@@ -6880,7 +7650,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
6880
7650
|
<dl>
|
|
6881
7651
|
<dd>
|
|
6882
7652
|
|
|
6883
|
-
Deletes shipper contact information owned by the
|
|
7653
|
+
Deletes shipper contact information owned by the caller's organization. | () -> (bool)
|
|
6884
7654
|
|
|
6885
7655
|
</dd>
|
|
6886
7656
|
</dl>
|
|
@@ -6896,7 +7666,7 @@ Deletes shipper contact information owned by the authenticated organization. | (
|
|
|
6896
7666
|
<dd>
|
|
6897
7667
|
|
|
6898
7668
|
```typescript
|
|
6899
|
-
await client.shipperContactInfo.
|
|
7669
|
+
await client.shipperContactInfo.deleteV1("id");
|
|
6900
7670
|
```
|
|
6901
7671
|
|
|
6902
7672
|
</dd>
|
|
@@ -7000,7 +7770,7 @@ await client.orgs.getInfoV1();
|
|
|
7000
7770
|
<dl>
|
|
7001
7771
|
<dd>
|
|
7002
7772
|
|
|
7003
|
-
Lists all members of the
|
|
7773
|
+
Lists all members of the caller's organization with their roles and details. | () -> (list[OrgMemberDetails])
|
|
7004
7774
|
|
|
7005
7775
|
</dd>
|
|
7006
7776
|
</dl>
|
|
@@ -7055,7 +7825,7 @@ await client.orgs.listMembersV1();
|
|
|
7055
7825
|
<dl>
|
|
7056
7826
|
<dd>
|
|
7057
7827
|
|
|
7058
|
-
Retrieves public organization data for the
|
|
7828
|
+
Retrieves public organization data for the caller's organization. | () -> (OrgPublicData1)
|
|
7059
7829
|
|
|
7060
7830
|
</dd>
|
|
7061
7831
|
</dl>
|
|
@@ -7110,7 +7880,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
7110
7880
|
<dl>
|
|
7111
7881
|
<dd>
|
|
7112
7882
|
|
|
7113
|
-
Creates org_public_data and org_private_data documents for the
|
|
7883
|
+
Creates org_public_data and org_private_data documents for the caller's organization using org_type from JWT. | (CreateOrgPublicDataReq) -> (CreateOrgPublicDataRes)
|
|
7114
7884
|
|
|
7115
7885
|
</dd>
|
|
7116
7886
|
</dl>
|
|
@@ -7173,7 +7943,7 @@ await client.orgs.createOrgPublicDataV1();
|
|
|
7173
7943
|
<dl>
|
|
7174
7944
|
<dd>
|
|
7175
7945
|
|
|
7176
|
-
Updates the handle and/or company_name for the
|
|
7946
|
+
Updates the handle and/or company_name for the caller's organization. | (UpdateOrgPublicDataReq) -> (bool)
|
|
7177
7947
|
|
|
7178
7948
|
</dd>
|
|
7179
7949
|
</dl>
|
|
@@ -7427,7 +8197,7 @@ await client.orgs.setOrgTypeV1({
|
|
|
7427
8197
|
<dl>
|
|
7428
8198
|
<dd>
|
|
7429
8199
|
|
|
7430
|
-
Retrieves the Stripe Connect account ID for the
|
|
8200
|
+
Retrieves the Stripe Connect account ID for the caller's organization. Returns 404 if not set. | () -> (str)
|
|
7431
8201
|
|
|
7432
8202
|
</dd>
|
|
7433
8203
|
</dl>
|
|
@@ -7761,7 +8531,7 @@ await client.root.failure();
|
|
|
7761
8531
|
<dl>
|
|
7762
8532
|
<dd>
|
|
7763
8533
|
|
|
7764
|
-
Retrieves public user data for the
|
|
8534
|
+
Retrieves public user data for the caller. | () -> (UserPublicData1)
|
|
7765
8535
|
|
|
7766
8536
|
</dd>
|
|
7767
8537
|
</dl>
|
|
@@ -8244,7 +9014,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8244
9014
|
<dl>
|
|
8245
9015
|
<dd>
|
|
8246
9016
|
|
|
8247
|
-
Retrieves notification preferences for the
|
|
9017
|
+
Retrieves notification preferences for the caller's shipper organization. | () -> (ShipperNotificationPreferences1)
|
|
8248
9018
|
|
|
8249
9019
|
</dd>
|
|
8250
9020
|
</dl>
|
|
@@ -8299,7 +9069,7 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
8299
9069
|
<dl>
|
|
8300
9070
|
<dd>
|
|
8301
9071
|
|
|
8302
|
-
Creates or updates notification preferences for the
|
|
9072
|
+
Creates or updates notification preferences for the caller's shipper organization. | (ShipperNotificationPreferencesClientCreate1) -> (PydanticObjectId)
|
|
8303
9073
|
|
|
8304
9074
|
</dd>
|
|
8305
9075
|
</dl>
|
|
@@ -8366,7 +9136,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
8366
9136
|
<dl>
|
|
8367
9137
|
<dd>
|
|
8368
9138
|
|
|
8369
|
-
Retrieves notification preferences for the
|
|
9139
|
+
Retrieves notification preferences for the caller's courier organization. | () -> (CourierNotificationPreferences1)
|
|
8370
9140
|
|
|
8371
9141
|
</dd>
|
|
8372
9142
|
</dl>
|
|
@@ -8421,7 +9191,7 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
8421
9191
|
<dl>
|
|
8422
9192
|
<dd>
|
|
8423
9193
|
|
|
8424
|
-
Creates or updates notification preferences for the
|
|
9194
|
+
Creates or updates notification preferences for the caller's courier organization. | (CourierNotificationPreferencesClientCreate1) -> (PydanticObjectId)
|
|
8425
9195
|
|
|
8426
9196
|
</dd>
|
|
8427
9197
|
</dl>
|
|
@@ -9666,7 +10436,7 @@ await client.orders.expanded.listForShipperOperatorsV1({
|
|
|
9666
10436
|
<dl>
|
|
9667
10437
|
<dd>
|
|
9668
10438
|
|
|
9669
|
-
Retrieves shipper organization connection information for the
|
|
10439
|
+
Retrieves shipper organization connection information for the caller's organization. | () -> (ShipperOrgInfoForConnections1)
|
|
9670
10440
|
|
|
9671
10441
|
</dd>
|
|
9672
10442
|
</dl>
|
|
@@ -9852,7 +10622,7 @@ await client.orgInfoForConnections.shipper.updateV1();
|
|
|
9852
10622
|
<dl>
|
|
9853
10623
|
<dd>
|
|
9854
10624
|
|
|
9855
|
-
Retrieves courier organization connection information for the
|
|
10625
|
+
Retrieves courier organization connection information for the caller's organization. | () -> (CourierOrgInfoForConnections1)
|
|
9856
10626
|
|
|
9857
10627
|
</dd>
|
|
9858
10628
|
</dl>
|
|
@@ -10093,7 +10863,7 @@ await client.orgInfoForConnections.courier.updateV1();
|
|
|
10093
10863
|
<dl>
|
|
10094
10864
|
<dd>
|
|
10095
10865
|
|
|
10096
|
-
Retrieves forwarder organization connection information for the
|
|
10866
|
+
Retrieves forwarder organization connection information for the caller's organization. | () -> (ForwarderOrgInfoForConnections1)
|
|
10097
10867
|
|
|
10098
10868
|
</dd>
|
|
10099
10869
|
</dl>
|
|
@@ -10279,7 +11049,7 @@ await client.orgInfoForConnections.forwarder.updateV1();
|
|
|
10279
11049
|
<dl>
|
|
10280
11050
|
<dd>
|
|
10281
11051
|
|
|
10282
|
-
Lists all shipper pay courier line item groups for the
|
|
11052
|
+
Lists all shipper pay courier line item groups for the caller's shipper organization.
|
|
10283
11053
|
|
|
10284
11054
|
</dd>
|
|
10285
11055
|
</dl>
|
|
@@ -10334,7 +11104,7 @@ await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
|
10334
11104
|
<dl>
|
|
10335
11105
|
<dd>
|
|
10336
11106
|
|
|
10337
|
-
Retrieves a shipper pay courier line item group by its ID for the
|
|
11107
|
+
Retrieves a shipper pay courier line item group by its ID for the caller's shipper organization.
|
|
10338
11108
|
|
|
10339
11109
|
</dd>
|
|
10340
11110
|
</dl>
|
|
@@ -10397,7 +11167,7 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
10397
11167
|
<dl>
|
|
10398
11168
|
<dd>
|
|
10399
11169
|
|
|
10400
|
-
Retrieves a shipper pay courier line item group by its associated task group ID for the
|
|
11170
|
+
Retrieves a shipper pay courier line item group by its associated task group ID for the caller's shipper organization.
|
|
10401
11171
|
|
|
10402
11172
|
</dd>
|
|
10403
11173
|
</dl>
|
|
@@ -10462,7 +11232,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
10462
11232
|
<dl>
|
|
10463
11233
|
<dd>
|
|
10464
11234
|
|
|
10465
|
-
Lists all shipper pay courier line item groups for the
|
|
11235
|
+
Lists all shipper pay courier line item groups for the caller's courier organization.
|
|
10466
11236
|
|
|
10467
11237
|
</dd>
|
|
10468
11238
|
</dl>
|
|
@@ -10662,9 +11432,9 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
10662
11432
|
</dl>
|
|
10663
11433
|
</details>
|
|
10664
11434
|
|
|
10665
|
-
## TaskArtifacts
|
|
11435
|
+
## TaskArtifacts S3ObjectMetadata
|
|
10666
11436
|
|
|
10667
|
-
<details><summary><code>client.taskArtifacts.
|
|
11437
|
+
<details><summary><code>client.taskArtifacts.s3ObjectMetadata.<a href="/src/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) -> Chrt.TaskArtifactS3ObjectMetadata1</code></summary>
|
|
10668
11438
|
<dl>
|
|
10669
11439
|
<dd>
|
|
10670
11440
|
|
|
@@ -10676,7 +11446,7 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
10676
11446
|
<dl>
|
|
10677
11447
|
<dd>
|
|
10678
11448
|
|
|
10679
|
-
|
|
11449
|
+
Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (TaskArtifactS3ObjectMetadata1)
|
|
10680
11450
|
|
|
10681
11451
|
</dd>
|
|
10682
11452
|
</dl>
|
|
@@ -10692,7 +11462,7 @@ Streams a task_artifact image file from S3 storage. | () -> (StreamingResponse)
|
|
|
10692
11462
|
<dd>
|
|
10693
11463
|
|
|
10694
11464
|
```typescript
|
|
10695
|
-
await client.taskArtifacts.
|
|
11465
|
+
await client.taskArtifacts.s3ObjectMetadata.getV1("task_artifact_s3_object_metadata_id");
|
|
10696
11466
|
```
|
|
10697
11467
|
|
|
10698
11468
|
</dd>
|
|
@@ -10716,7 +11486,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10716
11486
|
<dl>
|
|
10717
11487
|
<dd>
|
|
10718
11488
|
|
|
10719
|
-
**requestOptions:** `
|
|
11489
|
+
**requestOptions:** `S3ObjectMetadata.RequestOptions`
|
|
10720
11490
|
|
|
10721
11491
|
</dd>
|
|
10722
11492
|
</dl>
|
|
@@ -10727,7 +11497,9 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10727
11497
|
</dl>
|
|
10728
11498
|
</details>
|
|
10729
11499
|
|
|
10730
|
-
|
|
11500
|
+
## TaskArtifacts S3Object
|
|
11501
|
+
|
|
11502
|
+
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) -> unknown</code></summary>
|
|
10731
11503
|
<dl>
|
|
10732
11504
|
<dd>
|
|
10733
11505
|
|
|
@@ -10739,7 +11511,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10739
11511
|
<dl>
|
|
10740
11512
|
<dd>
|
|
10741
11513
|
|
|
10742
|
-
|
|
11514
|
+
Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (StreamingResponse)
|
|
10743
11515
|
|
|
10744
11516
|
</dd>
|
|
10745
11517
|
</dl>
|
|
@@ -10755,9 +11527,7 @@ Uploads an image file to a task_artifact with automatic blurhash generation. | (
|
|
|
10755
11527
|
<dd>
|
|
10756
11528
|
|
|
10757
11529
|
```typescript
|
|
10758
|
-
await client.taskArtifacts.
|
|
10759
|
-
image: fs.createReadStream("/path/to/your/file"),
|
|
10760
|
-
});
|
|
11530
|
+
await client.taskArtifacts.s3Object.getV1("task_artifact_s3_object_metadata_id");
|
|
10761
11531
|
```
|
|
10762
11532
|
|
|
10763
11533
|
</dd>
|
|
@@ -10773,15 +11543,135 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
10773
11543
|
<dl>
|
|
10774
11544
|
<dd>
|
|
10775
11545
|
|
|
10776
|
-
**
|
|
11546
|
+
**taskArtifactS3ObjectMetadataId:** `string`
|
|
11547
|
+
|
|
11548
|
+
</dd>
|
|
11549
|
+
</dl>
|
|
11550
|
+
|
|
11551
|
+
<dl>
|
|
11552
|
+
<dd>
|
|
11553
|
+
|
|
11554
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
11555
|
+
|
|
11556
|
+
</dd>
|
|
11557
|
+
</dl>
|
|
11558
|
+
</dd>
|
|
11559
|
+
</dl>
|
|
11560
|
+
|
|
11561
|
+
</dd>
|
|
11562
|
+
</dl>
|
|
11563
|
+
</details>
|
|
11564
|
+
|
|
11565
|
+
## TaskGroups TaskGroupId
|
|
11566
|
+
|
|
11567
|
+
<details><summary><code>client.taskGroups.taskGroupId.<a href="/src/api/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierOperatorsV1</a>(orderIdOrShortId) -> string</code></summary>
|
|
11568
|
+
<dl>
|
|
11569
|
+
<dd>
|
|
11570
|
+
|
|
11571
|
+
#### 📝 Description
|
|
11572
|
+
|
|
11573
|
+
<dl>
|
|
11574
|
+
<dd>
|
|
11575
|
+
|
|
11576
|
+
<dl>
|
|
11577
|
+
<dd>
|
|
11578
|
+
|
|
11579
|
+
Retrieves the task group ID for the courier organization assigned to an order's task group. | authz_personas=[courier_org_operators] | () -> (PydanticObjectId)
|
|
11580
|
+
|
|
11581
|
+
</dd>
|
|
11582
|
+
</dl>
|
|
11583
|
+
</dd>
|
|
11584
|
+
</dl>
|
|
11585
|
+
|
|
11586
|
+
#### 🔌 Usage
|
|
11587
|
+
|
|
11588
|
+
<dl>
|
|
11589
|
+
<dd>
|
|
11590
|
+
|
|
11591
|
+
<dl>
|
|
11592
|
+
<dd>
|
|
11593
|
+
|
|
11594
|
+
```typescript
|
|
11595
|
+
await client.taskGroups.taskGroupId.forCourierOperatorsV1("order_id_or_short_id");
|
|
11596
|
+
```
|
|
11597
|
+
|
|
11598
|
+
</dd>
|
|
11599
|
+
</dl>
|
|
11600
|
+
</dd>
|
|
11601
|
+
</dl>
|
|
11602
|
+
|
|
11603
|
+
#### ⚙️ Parameters
|
|
11604
|
+
|
|
11605
|
+
<dl>
|
|
11606
|
+
<dd>
|
|
11607
|
+
|
|
11608
|
+
<dl>
|
|
11609
|
+
<dd>
|
|
11610
|
+
|
|
11611
|
+
**orderIdOrShortId:** `string`
|
|
11612
|
+
|
|
11613
|
+
</dd>
|
|
11614
|
+
</dl>
|
|
11615
|
+
|
|
11616
|
+
<dl>
|
|
11617
|
+
<dd>
|
|
11618
|
+
|
|
11619
|
+
**requestOptions:** `TaskGroupId.RequestOptions`
|
|
11620
|
+
|
|
11621
|
+
</dd>
|
|
11622
|
+
</dl>
|
|
11623
|
+
</dd>
|
|
11624
|
+
</dl>
|
|
11625
|
+
|
|
11626
|
+
</dd>
|
|
11627
|
+
</dl>
|
|
11628
|
+
</details>
|
|
11629
|
+
|
|
11630
|
+
<details><summary><code>client.taskGroups.taskGroupId.<a href="/src/api/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierDriverV1</a>(orderIdOrShortId) -> string</code></summary>
|
|
11631
|
+
<dl>
|
|
11632
|
+
<dd>
|
|
11633
|
+
|
|
11634
|
+
#### 📝 Description
|
|
11635
|
+
|
|
11636
|
+
<dl>
|
|
11637
|
+
<dd>
|
|
11638
|
+
|
|
11639
|
+
<dl>
|
|
11640
|
+
<dd>
|
|
11641
|
+
|
|
11642
|
+
Retrieves the task group ID for the courier driver assigned to an order's task group. | authz_personas=[courier_driver] | () -> (PydanticObjectId)
|
|
11643
|
+
|
|
11644
|
+
</dd>
|
|
11645
|
+
</dl>
|
|
11646
|
+
</dd>
|
|
11647
|
+
</dl>
|
|
11648
|
+
|
|
11649
|
+
#### 🔌 Usage
|
|
11650
|
+
|
|
11651
|
+
<dl>
|
|
11652
|
+
<dd>
|
|
11653
|
+
|
|
11654
|
+
<dl>
|
|
11655
|
+
<dd>
|
|
11656
|
+
|
|
11657
|
+
```typescript
|
|
11658
|
+
await client.taskGroups.taskGroupId.forCourierDriverV1("order_id_or_short_id");
|
|
11659
|
+
```
|
|
10777
11660
|
|
|
10778
11661
|
</dd>
|
|
10779
11662
|
</dl>
|
|
11663
|
+
</dd>
|
|
11664
|
+
</dl>
|
|
11665
|
+
|
|
11666
|
+
#### ⚙️ Parameters
|
|
11667
|
+
|
|
11668
|
+
<dl>
|
|
11669
|
+
<dd>
|
|
10780
11670
|
|
|
10781
11671
|
<dl>
|
|
10782
11672
|
<dd>
|
|
10783
11673
|
|
|
10784
|
-
**
|
|
11674
|
+
**orderIdOrShortId:** `string`
|
|
10785
11675
|
|
|
10786
11676
|
</dd>
|
|
10787
11677
|
</dl>
|
|
@@ -10789,7 +11679,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
10789
11679
|
<dl>
|
|
10790
11680
|
<dd>
|
|
10791
11681
|
|
|
10792
|
-
**requestOptions:** `
|
|
11682
|
+
**requestOptions:** `TaskGroupId.RequestOptions`
|
|
10793
11683
|
|
|
10794
11684
|
</dd>
|
|
10795
11685
|
</dl>
|
|
@@ -10800,7 +11690,9 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
10800
11690
|
</dl>
|
|
10801
11691
|
</details>
|
|
10802
11692
|
|
|
10803
|
-
|
|
11693
|
+
## TaskGroups S3ObjectMetadata
|
|
11694
|
+
|
|
11695
|
+
<details><summary><code>client.taskGroups.s3ObjectMetadata.<a href="/src/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) -> Chrt.TaskGroupS3ObjectMetadata1</code></summary>
|
|
10804
11696
|
<dl>
|
|
10805
11697
|
<dd>
|
|
10806
11698
|
|
|
@@ -10812,7 +11704,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
10812
11704
|
<dl>
|
|
10813
11705
|
<dd>
|
|
10814
11706
|
|
|
10815
|
-
|
|
11707
|
+
Retrieves the metadata for a task group S3 object, including blurhash for placeholder loading. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (TaskGroupS3ObjectMetadata1)
|
|
10816
11708
|
|
|
10817
11709
|
</dd>
|
|
10818
11710
|
</dl>
|
|
@@ -10828,7 +11720,7 @@ Deletes a task_artifact image from both S3 storage and database metadata. | () -
|
|
|
10828
11720
|
<dd>
|
|
10829
11721
|
|
|
10830
11722
|
```typescript
|
|
10831
|
-
await client.
|
|
11723
|
+
await client.taskGroups.s3ObjectMetadata.getV1("task_group_s3_object_metadata_id");
|
|
10832
11724
|
```
|
|
10833
11725
|
|
|
10834
11726
|
</dd>
|
|
@@ -10844,7 +11736,7 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
10844
11736
|
<dl>
|
|
10845
11737
|
<dd>
|
|
10846
11738
|
|
|
10847
|
-
**
|
|
11739
|
+
**taskGroupS3ObjectMetadataId:** `string`
|
|
10848
11740
|
|
|
10849
11741
|
</dd>
|
|
10850
11742
|
</dl>
|
|
@@ -10852,7 +11744,7 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
10852
11744
|
<dl>
|
|
10853
11745
|
<dd>
|
|
10854
11746
|
|
|
10855
|
-
**requestOptions:** `
|
|
11747
|
+
**requestOptions:** `S3ObjectMetadata.RequestOptions`
|
|
10856
11748
|
|
|
10857
11749
|
</dd>
|
|
10858
11750
|
</dl>
|
|
@@ -10863,9 +11755,9 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
10863
11755
|
</dl>
|
|
10864
11756
|
</details>
|
|
10865
11757
|
|
|
10866
|
-
##
|
|
11758
|
+
## TaskGroups S3Object
|
|
10867
11759
|
|
|
10868
|
-
<details><summary><code>client.
|
|
11760
|
+
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) -> unknown</code></summary>
|
|
10869
11761
|
<dl>
|
|
10870
11762
|
<dd>
|
|
10871
11763
|
|
|
@@ -10877,7 +11769,7 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
10877
11769
|
<dl>
|
|
10878
11770
|
<dd>
|
|
10879
11771
|
|
|
10880
|
-
|
|
11772
|
+
Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (StreamingResponse)
|
|
10881
11773
|
|
|
10882
11774
|
</dd>
|
|
10883
11775
|
</dl>
|
|
@@ -10893,7 +11785,7 @@ Retrieves the blurhash string for a task_artifact image for fast placeholder loa
|
|
|
10893
11785
|
<dd>
|
|
10894
11786
|
|
|
10895
11787
|
```typescript
|
|
10896
|
-
await client.
|
|
11788
|
+
await client.taskGroups.s3Object.getV1("task_group_s3_object_metadata_id");
|
|
10897
11789
|
```
|
|
10898
11790
|
|
|
10899
11791
|
</dd>
|
|
@@ -10909,7 +11801,7 @@ await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_m
|
|
|
10909
11801
|
<dl>
|
|
10910
11802
|
<dd>
|
|
10911
11803
|
|
|
10912
|
-
**
|
|
11804
|
+
**taskGroupS3ObjectMetadataId:** `string`
|
|
10913
11805
|
|
|
10914
11806
|
</dd>
|
|
10915
11807
|
</dl>
|
|
@@ -10917,7 +11809,7 @@ await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_m
|
|
|
10917
11809
|
<dl>
|
|
10918
11810
|
<dd>
|
|
10919
11811
|
|
|
10920
|
-
**requestOptions:** `
|
|
11812
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
10921
11813
|
|
|
10922
11814
|
</dd>
|
|
10923
11815
|
</dl>
|
|
@@ -11255,6 +12147,8 @@ await client.taskGroups.expanded.listForCourierOperatorsV1({
|
|
|
11255
12147
|
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11256
12148
|
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11257
12149
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
12150
|
+
filter_skipped_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
12151
|
+
filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11258
12152
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11259
12153
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11260
12154
|
body: {},
|
|
@@ -11334,6 +12228,8 @@ await client.taskGroups.expanded.listForCourierDriverV1({
|
|
|
11334
12228
|
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11335
12229
|
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11336
12230
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
12231
|
+
filter_skipped_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
12232
|
+
filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11337
12233
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11338
12234
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11339
12235
|
body: {},
|
|
@@ -11522,7 +12418,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
|
|
|
11522
12418
|
<dl>
|
|
11523
12419
|
<dd>
|
|
11524
12420
|
|
|
11525
|
-
Registers a tracking device to the
|
|
12421
|
+
Registers a tracking device to the caller's organization. If device is already registered to a different organization, registration is blocked. | (DevicesRegisterToOrgReq1) -> (PydanticObjectId)
|
|
11526
12422
|
|
|
11527
12423
|
</dd>
|
|
11528
12424
|
</dl>
|
|
@@ -11716,7 +12612,7 @@ await client.tracking.devices.deleteV1({
|
|
|
11716
12612
|
<dl>
|
|
11717
12613
|
<dd>
|
|
11718
12614
|
|
|
11719
|
-
Retrieves a single device by its MAC address or ID. Access restricted to the
|
|
12615
|
+
Retrieves a single device by its MAC address or ID. Access restricted to the caller's organization. | () -> (Device1)
|
|
11720
12616
|
|
|
11721
12617
|
</dd>
|
|
11722
12618
|
</dl>
|
|
@@ -11782,7 +12678,7 @@ await client.tracking.devices.getV1({
|
|
|
11782
12678
|
<dl>
|
|
11783
12679
|
<dd>
|
|
11784
12680
|
|
|
11785
|
-
Returns all tracking devices registered to the
|
|
12681
|
+
Returns all tracking devices registered to the caller's organization. | () -> (list[Device1])
|
|
11786
12682
|
|
|
11787
12683
|
</dd>
|
|
11788
12684
|
</dl>
|
|
@@ -12050,7 +12946,7 @@ await client.tracking.driver.updateV1({
|
|
|
12050
12946
|
<dl>
|
|
12051
12947
|
<dd>
|
|
12052
12948
|
|
|
12053
|
-
Returns all tracking sessions for the
|
|
12949
|
+
Returns all tracking sessions for the caller's organization. | () -> (list[Session1])
|
|
12054
12950
|
|
|
12055
12951
|
</dd>
|
|
12056
12952
|
</dl>
|
|
@@ -12105,7 +13001,7 @@ await client.tracking.sessionByDevice.listV1();
|
|
|
12105
13001
|
<dl>
|
|
12106
13002
|
<dd>
|
|
12107
13003
|
|
|
12108
|
-
Retrieves a single session by its ID. Access restricted to the
|
|
13004
|
+
Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)
|
|
12109
13005
|
|
|
12110
13006
|
</dd>
|
|
12111
13007
|
</dl>
|
|
@@ -12170,7 +13066,7 @@ await client.tracking.sessionByDevice.getV1({
|
|
|
12170
13066
|
<dl>
|
|
12171
13067
|
<dd>
|
|
12172
13068
|
|
|
12173
|
-
Returns the most recent data point for a session, excluding outliers. Access restricted to the
|
|
13069
|
+
Returns the most recent data point for a session, excluding outliers. Access restricted to the caller's organization. | () -> (TrackingSessionByDeviceDataPoint1 | None)
|
|
12174
13070
|
|
|
12175
13071
|
</dd>
|
|
12176
13072
|
</dl>
|