@chrt-inc/typescript-sdk 1.320.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 -3
- package/dist/cjs/Client.js +36 -31
- 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 +4 -1
- package/dist/cjs/api/resources/index.js +5 -2
- 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/taskArtifacts/client/Client.d.ts +79 -6
- package/dist/cjs/api/resources/taskArtifacts/client/Client.js +308 -6
- package/dist/cjs/api/resources/taskArtifacts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskArtifacts/client/index.js +15 -0
- 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 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/index.d.ts +2 -2
- package/dist/cjs/api/resources/taskArtifacts/resources/index.js +3 -3
- 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/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/taskGroups/client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.d.ts +13 -0
- 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/UpdateCourierOrgReq.js +5 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateDriverReq.d.ts +13 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateDriverReq.js +5 -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/{taskArtifacts/resources/images → taskGroups/resources/s3Object}/client/Client.d.ts +14 -7
- package/dist/cjs/api/resources/{taskArtifacts/resources/images → taskGroups/resources/s3Object}/client/Client.js +16 -10
- 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.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/taskGroups/resources/taskGroupId/client/Client.js +186 -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/index.d.ts +2 -0
- package/dist/cjs/api/resources/tasks/client/index.js +17 -0
- package/dist/cjs/api/resources/tasks/client/requests/AddTaskToGroupReq.d.ts +21 -0
- package/dist/cjs/api/resources/tasks/client/requests/AddTaskToGroupReq.js +5 -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/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 +2 -2
- package/dist/cjs/api/types/ChrtGroundCourierTaskActionEnum1.js +1 -1
- 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/core/exports.d.ts +1 -0
- package/dist/cjs/core/exports.js +17 -0
- package/dist/cjs/core/file/exports.d.ts +1 -0
- package/dist/cjs/core/file/exports.js +2 -0
- package/dist/cjs/core/file/file.d.ts +5 -0
- package/dist/cjs/core/file/file.js +203 -0
- package/dist/cjs/core/file/index.d.ts +2 -0
- package/dist/cjs/core/file/index.js +18 -0
- package/dist/cjs/core/file/types.d.ts +66 -0
- package/dist/cjs/core/file/types.js +2 -0
- package/dist/cjs/core/form-data-utils/FormDataWrapper.d.ts +16 -0
- package/dist/cjs/core/form-data-utils/FormDataWrapper.js +208 -0
- package/dist/cjs/core/form-data-utils/encodeAsFormParameter.d.ts +1 -0
- package/dist/cjs/core/form-data-utils/encodeAsFormParameter.js +12 -0
- package/dist/cjs/core/form-data-utils/index.d.ts +2 -0
- package/dist/cjs/core/form-data-utils/index.js +20 -0
- package/dist/cjs/core/index.d.ts +2 -0
- package/dist/cjs/core/index.js +3 -1
- package/dist/cjs/exports.d.ts +1 -0
- package/dist/cjs/exports.js +17 -0
- package/dist/cjs/index.d.ts +1 -0
- package/dist/cjs/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 -3
- package/dist/esm/Client.mjs +12 -7
- 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 +4 -1
- package/dist/esm/api/resources/index.mjs +4 -1
- 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/taskArtifacts/client/Client.d.mts +79 -6
- package/dist/esm/api/resources/taskArtifacts/client/Client.mjs +275 -6
- package/dist/esm/api/resources/taskArtifacts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/taskArtifacts/client/index.mjs +1 -1
- 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 -0
- package/dist/esm/api/resources/taskArtifacts/resources/index.d.mts +2 -2
- package/dist/esm/api/resources/taskArtifacts/resources/index.mjs +2 -2
- 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/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/taskGroups/client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.d.mts +13 -0
- 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/UpdateCourierOrgReq.mjs +4 -0
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateDriverReq.d.mts +13 -0
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateDriverReq.mjs +4 -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/{taskArtifacts/resources/images → taskGroups/resources/s3Object}/client/Client.d.mts +14 -7
- package/dist/esm/api/resources/{taskArtifacts/resources/images → taskGroups/resources/s3Object}/client/Client.mjs +14 -8
- 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/taskGroups/resources/taskGroupId/client/Client.mjs +149 -0
- 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/index.d.mts +2 -0
- package/dist/esm/api/resources/tasks/client/index.mjs +1 -0
- package/dist/esm/api/resources/tasks/client/requests/AddTaskToGroupReq.d.mts +21 -0
- package/dist/esm/api/resources/tasks/client/requests/AddTaskToGroupReq.mjs +4 -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/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 +2 -2
- package/dist/esm/api/types/ChrtGroundCourierTaskActionEnum1.mjs +1 -1
- 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/core/exports.d.mts +1 -0
- package/dist/esm/core/exports.mjs +1 -0
- package/dist/esm/core/file/exports.d.mts +1 -0
- package/dist/esm/core/file/exports.mjs +1 -0
- package/dist/esm/core/file/file.d.mts +5 -0
- package/dist/esm/core/file/file.mjs +167 -0
- package/dist/esm/core/file/index.d.mts +2 -0
- package/dist/esm/core/file/index.mjs +2 -0
- package/dist/esm/core/file/types.d.mts +66 -0
- package/dist/esm/core/file/types.mjs +1 -0
- package/dist/esm/core/form-data-utils/FormDataWrapper.d.mts +16 -0
- package/dist/esm/core/form-data-utils/FormDataWrapper.mjs +170 -0
- package/dist/esm/core/form-data-utils/encodeAsFormParameter.d.mts +1 -0
- package/dist/esm/core/form-data-utils/encodeAsFormParameter.mjs +9 -0
- package/dist/esm/core/form-data-utils/index.d.mts +2 -0
- package/dist/esm/core/form-data-utils/index.mjs +2 -0
- package/dist/esm/core/index.d.mts +2 -0
- package/dist/esm/core/index.mjs +2 -0
- package/dist/esm/exports.d.mts +1 -0
- package/dist/esm/exports.mjs +1 -0
- package/dist/esm/index.d.mts +1 -0
- package/dist/esm/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1300 -206
- 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/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/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/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/cjs/api/resources/taskArtifacts/{resources/blurhash/client → client/requests}/index.js +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{blurhash → s3Object}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{images → s3Object}/client/index.js +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{blurhash → s3Object}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{blurhash → s3Object}/index.js +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{images → s3ObjectMetadata}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{images → s3ObjectMetadata}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{images → s3ObjectMetadata}/index.js +0 -0
- /package/dist/cjs/api/resources/taskGroups/client/requests/{UpdateTaskGroupCourierOrgReq.js → AddMessageReq.js} +0 -0
- /package/dist/cjs/api/resources/taskGroups/client/requests/{UpdateTaskGroupDriverReq.js → BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.js} +0 -0
- /package/dist/{esm/api/resources/taskArtifacts/resources/blurhash/client/index.d.mts → cjs/api/resources/taskGroups/resources/s3Object/client/index.d.ts} +0 -0
- /package/dist/{esm/api/resources/taskArtifacts/resources/blurhash/client/index.mjs → cjs/api/resources/taskGroups/resources/s3ObjectMetadata/client/index.d.ts} +0 -0
- /package/dist/{esm/api/resources/taskArtifacts/resources/images/client/index.d.mts → cjs/api/resources/taskGroups/resources/taskGroupId/client/index.d.ts} +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/client → client/requests}/index.mjs +0 -0
- /package/dist/esm/api/resources/taskArtifacts/resources/{blurhash → s3Object}/index.d.mts +0 -0
- /package/dist/esm/api/resources/taskArtifacts/resources/{blurhash → s3Object}/index.mjs +0 -0
- /package/dist/esm/api/resources/taskArtifacts/resources/{images → s3ObjectMetadata}/index.d.mts +0 -0
- /package/dist/esm/api/resources/taskArtifacts/resources/{images → s3ObjectMetadata}/index.mjs +0 -0
- /package/dist/esm/api/resources/taskGroups/client/requests/{UpdateTaskGroupCourierOrgReq.mjs → AddMessageReq.mjs} +0 -0
- /package/dist/esm/api/resources/taskGroups/client/requests/{UpdateTaskGroupDriverReq.mjs → BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -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 caller's organization. | () -> (list[Driver1]
|
|
|
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,14 +4518,6 @@ await client.drivers.createV1({
|
|
|
4515
4518
|
<dl>
|
|
4516
4519
|
<dd>
|
|
4517
4520
|
|
|
4518
|
-
**request:** `Chrt.DriverCreateReq`
|
|
4519
|
-
|
|
4520
|
-
</dd>
|
|
4521
|
-
</dl>
|
|
4522
|
-
|
|
4523
|
-
<dl>
|
|
4524
|
-
<dd>
|
|
4525
|
-
|
|
4526
4521
|
**requestOptions:** `Drivers.RequestOptions`
|
|
4527
4522
|
|
|
4528
4523
|
</dd>
|
|
@@ -4534,7 +4529,7 @@ await client.drivers.createV1({
|
|
|
4534
4529
|
</dl>
|
|
4535
4530
|
</details>
|
|
4536
4531
|
|
|
4537
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4532
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listV1</a>() -> Chrt.Driver1[]</code></summary>
|
|
4538
4533
|
<dl>
|
|
4539
4534
|
<dd>
|
|
4540
4535
|
|
|
@@ -4546,7 +4541,7 @@ await client.drivers.createV1({
|
|
|
4546
4541
|
<dl>
|
|
4547
4542
|
<dd>
|
|
4548
4543
|
|
|
4549
|
-
|
|
4544
|
+
Lists all drivers belonging to the caller's organization. | () -> (list[Driver1])
|
|
4550
4545
|
|
|
4551
4546
|
</dd>
|
|
4552
4547
|
</dl>
|
|
@@ -4562,7 +4557,7 @@ Retrieves driver information for the caller within their organization. | () -> (
|
|
|
4562
4557
|
<dd>
|
|
4563
4558
|
|
|
4564
4559
|
```typescript
|
|
4565
|
-
await client.drivers.
|
|
4560
|
+
await client.drivers.listV1();
|
|
4566
4561
|
```
|
|
4567
4562
|
|
|
4568
4563
|
</dd>
|
|
@@ -4589,7 +4584,7 @@ await client.drivers.getV1();
|
|
|
4589
4584
|
</dl>
|
|
4590
4585
|
</details>
|
|
4591
4586
|
|
|
4592
|
-
<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>
|
|
4593
4588
|
<dl>
|
|
4594
4589
|
<dd>
|
|
4595
4590
|
|
|
@@ -4601,7 +4596,7 @@ await client.drivers.getV1();
|
|
|
4601
4596
|
<dl>
|
|
4602
4597
|
<dd>
|
|
4603
4598
|
|
|
4604
|
-
|
|
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)
|
|
4605
4600
|
|
|
4606
4601
|
</dd>
|
|
4607
4602
|
</dl>
|
|
@@ -4617,7 +4612,9 @@ Retrieves detailed driver information by driver ID within the organization. | ()
|
|
|
4617
4612
|
<dd>
|
|
4618
4613
|
|
|
4619
4614
|
```typescript
|
|
4620
|
-
await client.drivers.
|
|
4615
|
+
await client.drivers.createV1({
|
|
4616
|
+
schema_version: 1,
|
|
4617
|
+
});
|
|
4621
4618
|
```
|
|
4622
4619
|
|
|
4623
4620
|
</dd>
|
|
@@ -4633,7 +4630,7 @@ await client.drivers.getByDriverIdV1("driver_id");
|
|
|
4633
4630
|
<dl>
|
|
4634
4631
|
<dd>
|
|
4635
4632
|
|
|
4636
|
-
**
|
|
4633
|
+
**request:** `Chrt.DriverClientCreate1`
|
|
4637
4634
|
|
|
4638
4635
|
</dd>
|
|
4639
4636
|
</dl>
|
|
@@ -4652,7 +4649,7 @@ await client.drivers.getByDriverIdV1("driver_id");
|
|
|
4652
4649
|
</dl>
|
|
4653
4650
|
</details>
|
|
4654
4651
|
|
|
4655
|
-
<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>
|
|
4656
4653
|
<dl>
|
|
4657
4654
|
<dd>
|
|
4658
4655
|
|
|
@@ -4664,7 +4661,7 @@ await client.drivers.getByDriverIdV1("driver_id");
|
|
|
4664
4661
|
<dl>
|
|
4665
4662
|
<dd>
|
|
4666
4663
|
|
|
4667
|
-
|
|
4664
|
+
Updates driver contact details and vehicle type assignments. Courier orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)
|
|
4668
4665
|
|
|
4669
4666
|
</dd>
|
|
4670
4667
|
</dl>
|
|
@@ -4680,7 +4677,7 @@ Deletes a driver from the organization and removes them from associated rate she
|
|
|
4680
4677
|
<dd>
|
|
4681
4678
|
|
|
4682
4679
|
```typescript
|
|
4683
|
-
await client.drivers.
|
|
4680
|
+
await client.drivers.updateV1("driver_id");
|
|
4684
4681
|
```
|
|
4685
4682
|
|
|
4686
4683
|
</dd>
|
|
@@ -4704,6 +4701,14 @@ await client.drivers.deleteV1("driver_id");
|
|
|
4704
4701
|
<dl>
|
|
4705
4702
|
<dd>
|
|
4706
4703
|
|
|
4704
|
+
**request:** `Chrt.DriverClientUpdate1`
|
|
4705
|
+
|
|
4706
|
+
</dd>
|
|
4707
|
+
</dl>
|
|
4708
|
+
|
|
4709
|
+
<dl>
|
|
4710
|
+
<dd>
|
|
4711
|
+
|
|
4707
4712
|
**requestOptions:** `Drivers.RequestOptions`
|
|
4708
4713
|
|
|
4709
4714
|
</dd>
|
|
@@ -4715,7 +4720,7 @@ await client.drivers.deleteV1("driver_id");
|
|
|
4715
4720
|
</dl>
|
|
4716
4721
|
</details>
|
|
4717
4722
|
|
|
4718
|
-
<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>
|
|
4719
4724
|
<dl>
|
|
4720
4725
|
<dd>
|
|
4721
4726
|
|
|
@@ -4727,7 +4732,7 @@ await client.drivers.deleteV1("driver_id");
|
|
|
4727
4732
|
<dl>
|
|
4728
4733
|
<dd>
|
|
4729
4734
|
|
|
4730
|
-
|
|
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)
|
|
4731
4736
|
|
|
4732
4737
|
</dd>
|
|
4733
4738
|
</dl>
|
|
@@ -4743,9 +4748,19 @@ Sets the activation status of a driver (active/inactive) within the organization
|
|
|
4743
4748
|
<dd>
|
|
4744
4749
|
|
|
4745
4750
|
```typescript
|
|
4746
|
-
await client.drivers.
|
|
4747
|
-
|
|
4748
|
-
|
|
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
|
+
},
|
|
4749
4764
|
});
|
|
4750
4765
|
```
|
|
4751
4766
|
|
|
@@ -4762,7 +4777,7 @@ await client.drivers.setActivationV1({
|
|
|
4762
4777
|
<dl>
|
|
4763
4778
|
<dd>
|
|
4764
4779
|
|
|
4765
|
-
**request:** `Chrt.
|
|
4780
|
+
**request:** `Chrt.DriverLastSeenReq`
|
|
4766
4781
|
|
|
4767
4782
|
</dd>
|
|
4768
4783
|
</dl>
|
|
@@ -4781,7 +4796,7 @@ await client.drivers.setActivationV1({
|
|
|
4781
4796
|
</dl>
|
|
4782
4797
|
</details>
|
|
4783
4798
|
|
|
4784
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">
|
|
4799
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">clearLastSeenV1</a>() -> boolean</code></summary>
|
|
4785
4800
|
<dl>
|
|
4786
4801
|
<dd>
|
|
4787
4802
|
|
|
@@ -4793,7 +4808,7 @@ await client.drivers.setActivationV1({
|
|
|
4793
4808
|
<dl>
|
|
4794
4809
|
<dd>
|
|
4795
4810
|
|
|
4796
|
-
|
|
4811
|
+
Clears the driver's last known location and timestamp. | () -> (bool)
|
|
4797
4812
|
|
|
4798
4813
|
</dd>
|
|
4799
4814
|
</dl>
|
|
@@ -4809,20 +4824,7 @@ Updates the driver's last known location and timestamp for tracking purposes. |
|
|
|
4809
4824
|
<dd>
|
|
4810
4825
|
|
|
4811
4826
|
```typescript
|
|
4812
|
-
await client.drivers.
|
|
4813
|
-
location: {
|
|
4814
|
-
type: "Feature",
|
|
4815
|
-
geometry: {
|
|
4816
|
-
type: "GeometryCollection",
|
|
4817
|
-
geometries: [
|
|
4818
|
-
{
|
|
4819
|
-
type: "LineString",
|
|
4820
|
-
coordinates: [[]],
|
|
4821
|
-
},
|
|
4822
|
-
],
|
|
4823
|
-
},
|
|
4824
|
-
},
|
|
4825
|
-
});
|
|
4827
|
+
await client.drivers.clearLastSeenV1();
|
|
4826
4828
|
```
|
|
4827
4829
|
|
|
4828
4830
|
</dd>
|
|
@@ -4838,14 +4840,6 @@ await client.drivers.lastSeenV1({
|
|
|
4838
4840
|
<dl>
|
|
4839
4841
|
<dd>
|
|
4840
4842
|
|
|
4841
|
-
**request:** `Chrt.DriverLastSeenReq`
|
|
4842
|
-
|
|
4843
|
-
</dd>
|
|
4844
|
-
</dl>
|
|
4845
|
-
|
|
4846
|
-
<dl>
|
|
4847
|
-
<dd>
|
|
4848
|
-
|
|
4849
4843
|
**requestOptions:** `Drivers.RequestOptions`
|
|
4850
4844
|
|
|
4851
4845
|
</dd>
|
|
@@ -4857,7 +4851,7 @@ await client.drivers.lastSeenV1({
|
|
|
4857
4851
|
</dl>
|
|
4858
4852
|
</details>
|
|
4859
4853
|
|
|
4860
|
-
<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>
|
|
4861
4855
|
<dl>
|
|
4862
4856
|
<dd>
|
|
4863
4857
|
|
|
@@ -4869,7 +4863,7 @@ await client.drivers.lastSeenV1({
|
|
|
4869
4863
|
<dl>
|
|
4870
4864
|
<dd>
|
|
4871
4865
|
|
|
4872
|
-
|
|
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)
|
|
4873
4867
|
|
|
4874
4868
|
</dd>
|
|
4875
4869
|
</dl>
|
|
@@ -4885,7 +4879,9 @@ Clears the driver's last known location and timestamp. | () -> (bool)
|
|
|
4885
4879
|
<dd>
|
|
4886
4880
|
|
|
4887
4881
|
```typescript
|
|
4888
|
-
await client.drivers.
|
|
4882
|
+
await client.drivers.updateAvailabilityAccordingToDriverV1({
|
|
4883
|
+
available: true,
|
|
4884
|
+
});
|
|
4889
4885
|
```
|
|
4890
4886
|
|
|
4891
4887
|
</dd>
|
|
@@ -4901,6 +4897,14 @@ await client.drivers.lastSeenClearV1();
|
|
|
4901
4897
|
<dl>
|
|
4902
4898
|
<dd>
|
|
4903
4899
|
|
|
4900
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
4901
|
+
|
|
4902
|
+
</dd>
|
|
4903
|
+
</dl>
|
|
4904
|
+
|
|
4905
|
+
<dl>
|
|
4906
|
+
<dd>
|
|
4907
|
+
|
|
4904
4908
|
**requestOptions:** `Drivers.RequestOptions`
|
|
4905
4909
|
|
|
4906
4910
|
</dd>
|
|
@@ -4912,7 +4916,7 @@ await client.drivers.lastSeenClearV1();
|
|
|
4912
4916
|
</dl>
|
|
4913
4917
|
</details>
|
|
4914
4918
|
|
|
4915
|
-
<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>
|
|
4916
4920
|
<dl>
|
|
4917
4921
|
<dd>
|
|
4918
4922
|
|
|
@@ -4924,7 +4928,7 @@ await client.drivers.lastSeenClearV1();
|
|
|
4924
4928
|
<dl>
|
|
4925
4929
|
<dd>
|
|
4926
4930
|
|
|
4927
|
-
Updates driver
|
|
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)
|
|
4928
4932
|
|
|
4929
4933
|
</dd>
|
|
4930
4934
|
</dl>
|
|
@@ -4940,8 +4944,8 @@ Updates driver contact details and vehicle type assignments within the organizat
|
|
|
4940
4944
|
<dd>
|
|
4941
4945
|
|
|
4942
4946
|
```typescript
|
|
4943
|
-
await client.drivers.
|
|
4944
|
-
|
|
4947
|
+
await client.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
|
|
4948
|
+
available: true,
|
|
4945
4949
|
});
|
|
4946
4950
|
```
|
|
4947
4951
|
|
|
@@ -4958,7 +4962,15 @@ await client.drivers.updateDriverV1({
|
|
|
4958
4962
|
<dl>
|
|
4959
4963
|
<dd>
|
|
4960
4964
|
|
|
4961
|
-
**
|
|
4965
|
+
**driverId:** `string`
|
|
4966
|
+
|
|
4967
|
+
</dd>
|
|
4968
|
+
</dl>
|
|
4969
|
+
|
|
4970
|
+
<dl>
|
|
4971
|
+
<dd>
|
|
4972
|
+
|
|
4973
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
4962
4974
|
|
|
4963
4975
|
</dd>
|
|
4964
4976
|
</dl>
|
|
@@ -5050,9 +5062,9 @@ await client.cargos.updateV1("cargo_id", {});
|
|
|
5050
5062
|
</dl>
|
|
5051
5063
|
</details>
|
|
5052
5064
|
|
|
5053
|
-
##
|
|
5065
|
+
## TaskArtifacts
|
|
5054
5066
|
|
|
5055
|
-
<details><summary><code>client.
|
|
5067
|
+
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">addToTaskV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
5056
5068
|
<dl>
|
|
5057
5069
|
<dd>
|
|
5058
5070
|
|
|
@@ -5064,7 +5076,7 @@ await client.cargos.updateV1("cargo_id", {});
|
|
|
5064
5076
|
<dl>
|
|
5065
5077
|
<dd>
|
|
5066
5078
|
|
|
5067
|
-
|
|
5079
|
+
Adds a new task artifact to a task. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
|
|
5068
5080
|
|
|
5069
5081
|
</dd>
|
|
5070
5082
|
</dl>
|
|
@@ -5080,9 +5092,12 @@ Creates an off-platform shipper organization record. | (OffChrtShipperOrgClientC
|
|
|
5080
5092
|
<dd>
|
|
5081
5093
|
|
|
5082
5094
|
```typescript
|
|
5083
|
-
await client.
|
|
5084
|
-
|
|
5085
|
-
|
|
5095
|
+
await client.taskArtifacts.addToTaskV1("task_id", {
|
|
5096
|
+
task_artifact: {
|
|
5097
|
+
schema_version: 1,
|
|
5098
|
+
type: "image",
|
|
5099
|
+
},
|
|
5100
|
+
status: "draft",
|
|
5086
5101
|
});
|
|
5087
5102
|
```
|
|
5088
5103
|
|
|
@@ -5099,7 +5114,7 @@ await client.offChrtShipperOrg.createV1({
|
|
|
5099
5114
|
<dl>
|
|
5100
5115
|
<dd>
|
|
5101
5116
|
|
|
5102
|
-
**
|
|
5117
|
+
**taskId:** `string`
|
|
5103
5118
|
|
|
5104
5119
|
</dd>
|
|
5105
5120
|
</dl>
|
|
@@ -5107,7 +5122,15 @@ await client.offChrtShipperOrg.createV1({
|
|
|
5107
5122
|
<dl>
|
|
5108
5123
|
<dd>
|
|
5109
5124
|
|
|
5110
|
-
**
|
|
5125
|
+
**request:** `Chrt.AddTaskArtifactReq`
|
|
5126
|
+
|
|
5127
|
+
</dd>
|
|
5128
|
+
</dl>
|
|
5129
|
+
|
|
5130
|
+
<dl>
|
|
5131
|
+
<dd>
|
|
5132
|
+
|
|
5133
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
5111
5134
|
|
|
5112
5135
|
</dd>
|
|
5113
5136
|
</dl>
|
|
@@ -5118,7 +5141,7 @@ await client.offChrtShipperOrg.createV1({
|
|
|
5118
5141
|
</dl>
|
|
5119
5142
|
</details>
|
|
5120
5143
|
|
|
5121
|
-
<details><summary><code>client.
|
|
5144
|
+
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">completeV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
5122
5145
|
<dl>
|
|
5123
5146
|
<dd>
|
|
5124
5147
|
|
|
@@ -5130,7 +5153,7 @@ await client.offChrtShipperOrg.createV1({
|
|
|
5130
5153
|
<dl>
|
|
5131
5154
|
<dd>
|
|
5132
5155
|
|
|
5133
|
-
|
|
5156
|
+
Marks a task artifact as COMPLETED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)
|
|
5134
5157
|
|
|
5135
5158
|
</dd>
|
|
5136
5159
|
</dl>
|
|
@@ -5146,7 +5169,7 @@ Lists all off-platform shipper organizations created by the caller's organizatio
|
|
|
5146
5169
|
<dd>
|
|
5147
5170
|
|
|
5148
5171
|
```typescript
|
|
5149
|
-
await client.
|
|
5172
|
+
await client.taskArtifacts.completeV1("task_artifact_id");
|
|
5150
5173
|
```
|
|
5151
5174
|
|
|
5152
5175
|
</dd>
|
|
@@ -5162,7 +5185,15 @@ await client.offChrtShipperOrg.listV1();
|
|
|
5162
5185
|
<dl>
|
|
5163
5186
|
<dd>
|
|
5164
5187
|
|
|
5165
|
-
**
|
|
5188
|
+
**taskArtifactId:** `string`
|
|
5189
|
+
|
|
5190
|
+
</dd>
|
|
5191
|
+
</dl>
|
|
5192
|
+
|
|
5193
|
+
<dl>
|
|
5194
|
+
<dd>
|
|
5195
|
+
|
|
5196
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
5166
5197
|
|
|
5167
5198
|
</dd>
|
|
5168
5199
|
</dl>
|
|
@@ -5173,7 +5204,7 @@ await client.offChrtShipperOrg.listV1();
|
|
|
5173
5204
|
</dl>
|
|
5174
5205
|
</details>
|
|
5175
5206
|
|
|
5176
|
-
<details><summary><code>client.
|
|
5207
|
+
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">skipV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
5177
5208
|
<dl>
|
|
5178
5209
|
<dd>
|
|
5179
5210
|
|
|
@@ -5185,7 +5216,7 @@ await client.offChrtShipperOrg.listV1();
|
|
|
5185
5216
|
<dl>
|
|
5186
5217
|
<dd>
|
|
5187
5218
|
|
|
5188
|
-
|
|
5219
|
+
Marks a task artifact as SKIPPED. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators] | () -> (bool)
|
|
5189
5220
|
|
|
5190
5221
|
</dd>
|
|
5191
5222
|
</dl>
|
|
@@ -5201,7 +5232,7 @@ Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShip
|
|
|
5201
5232
|
<dd>
|
|
5202
5233
|
|
|
5203
5234
|
```typescript
|
|
5204
|
-
await client.
|
|
5235
|
+
await client.taskArtifacts.skipV1("task_artifact_id");
|
|
5205
5236
|
```
|
|
5206
5237
|
|
|
5207
5238
|
</dd>
|
|
@@ -5217,7 +5248,7 @@ await client.offChrtShipperOrg.getByIdV1("id");
|
|
|
5217
5248
|
<dl>
|
|
5218
5249
|
<dd>
|
|
5219
5250
|
|
|
5220
|
-
**
|
|
5251
|
+
**taskArtifactId:** `string`
|
|
5221
5252
|
|
|
5222
5253
|
</dd>
|
|
5223
5254
|
</dl>
|
|
@@ -5225,7 +5256,7 @@ await client.offChrtShipperOrg.getByIdV1("id");
|
|
|
5225
5256
|
<dl>
|
|
5226
5257
|
<dd>
|
|
5227
5258
|
|
|
5228
|
-
**requestOptions:** `
|
|
5259
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
5229
5260
|
|
|
5230
5261
|
</dd>
|
|
5231
5262
|
</dl>
|
|
@@ -5236,7 +5267,7 @@ await client.offChrtShipperOrg.getByIdV1("id");
|
|
|
5236
5267
|
</dl>
|
|
5237
5268
|
</details>
|
|
5238
5269
|
|
|
5239
|
-
<details><summary><code>client.
|
|
5270
|
+
<details><summary><code>client.taskArtifacts.<a href="/src/api/resources/taskArtifacts/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
5240
5271
|
<dl>
|
|
5241
5272
|
<dd>
|
|
5242
5273
|
|
|
@@ -5248,7 +5279,7 @@ await client.offChrtShipperOrg.getByIdV1("id");
|
|
|
5248
5279
|
<dl>
|
|
5249
5280
|
<dd>
|
|
5250
5281
|
|
|
5251
|
-
Deletes
|
|
5282
|
+
Deletes a task artifact. | authz_personas=[lig_org_operators] | () -> (bool)
|
|
5252
5283
|
|
|
5253
5284
|
</dd>
|
|
5254
5285
|
</dl>
|
|
@@ -5264,7 +5295,7 @@ Deletes off-platform shipper organization owned by the caller's organization. |
|
|
|
5264
5295
|
<dd>
|
|
5265
5296
|
|
|
5266
5297
|
```typescript
|
|
5267
|
-
await client.
|
|
5298
|
+
await client.taskArtifacts.deleteV1("task_artifact_id");
|
|
5268
5299
|
```
|
|
5269
5300
|
|
|
5270
5301
|
</dd>
|
|
@@ -5280,7 +5311,7 @@ await client.offChrtShipperOrg.deleteByIdV1("id");
|
|
|
5280
5311
|
<dl>
|
|
5281
5312
|
<dd>
|
|
5282
5313
|
|
|
5283
|
-
**
|
|
5314
|
+
**taskArtifactId:** `string`
|
|
5284
5315
|
|
|
5285
5316
|
</dd>
|
|
5286
5317
|
</dl>
|
|
@@ -5288,7 +5319,7 @@ await client.offChrtShipperOrg.deleteByIdV1("id");
|
|
|
5288
5319
|
<dl>
|
|
5289
5320
|
<dd>
|
|
5290
5321
|
|
|
5291
|
-
**requestOptions:** `
|
|
5322
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
5292
5323
|
|
|
5293
5324
|
</dd>
|
|
5294
5325
|
</dl>
|
|
@@ -5299,7 +5330,9 @@ await client.offChrtShipperOrg.deleteByIdV1("id");
|
|
|
5299
5330
|
</dl>
|
|
5300
5331
|
</details>
|
|
5301
5332
|
|
|
5302
|
-
|
|
5333
|
+
## OffChrtShipperOrg
|
|
5334
|
+
|
|
5335
|
+
<details><summary><code>client.offChrtShipperOrg.<a href="/src/api/resources/offChrtShipperOrg/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
5303
5336
|
<dl>
|
|
5304
5337
|
<dd>
|
|
5305
5338
|
|
|
@@ -5311,7 +5344,7 @@ await client.offChrtShipperOrg.deleteByIdV1("id");
|
|
|
5311
5344
|
<dl>
|
|
5312
5345
|
<dd>
|
|
5313
5346
|
|
|
5314
|
-
|
|
5347
|
+
Creates an off-platform shipper organization record. | (OffChrtShipperOrgClientCreate1) -> (PydanticObjectId)
|
|
5315
5348
|
|
|
5316
5349
|
</dd>
|
|
5317
5350
|
</dl>
|
|
@@ -5327,7 +5360,10 @@ Updates existing off-platform shipper organization owned by the caller's organiz
|
|
|
5327
5360
|
<dd>
|
|
5328
5361
|
|
|
5329
5362
|
```typescript
|
|
5330
|
-
await client.offChrtShipperOrg.
|
|
5363
|
+
await client.offChrtShipperOrg.createV1({
|
|
5364
|
+
schema_version: 1,
|
|
5365
|
+
email_address_primary: "email_address_primary",
|
|
5366
|
+
});
|
|
5331
5367
|
```
|
|
5332
5368
|
|
|
5333
5369
|
</dd>
|
|
@@ -5343,15 +5379,7 @@ await client.offChrtShipperOrg.updateByIdV1("id");
|
|
|
5343
5379
|
<dl>
|
|
5344
5380
|
<dd>
|
|
5345
5381
|
|
|
5346
|
-
**
|
|
5347
|
-
|
|
5348
|
-
</dd>
|
|
5349
|
-
</dl>
|
|
5350
|
-
|
|
5351
|
-
<dl>
|
|
5352
|
-
<dd>
|
|
5353
|
-
|
|
5354
|
-
**request:** `Chrt.OffChrtShipperOrgClientUpdate1`
|
|
5382
|
+
**request:** `Chrt.OffChrtShipperOrgClientCreate1`
|
|
5355
5383
|
|
|
5356
5384
|
</dd>
|
|
5357
5385
|
</dl>
|
|
@@ -5370,9 +5398,7 @@ await client.offChrtShipperOrg.updateByIdV1("id");
|
|
|
5370
5398
|
</dl>
|
|
5371
5399
|
</details>
|
|
5372
5400
|
|
|
5373
|
-
|
|
5374
|
-
|
|
5375
|
-
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
5401
|
+
<details><summary><code>client.offChrtShipperOrg.<a href="/src/api/resources/offChrtShipperOrg/client/Client.ts">listV1</a>() -> Chrt.OffChrtShipperOrg1[]</code></summary>
|
|
5376
5402
|
<dl>
|
|
5377
5403
|
<dd>
|
|
5378
5404
|
|
|
@@ -5384,7 +5410,7 @@ await client.offChrtShipperOrg.updateByIdV1("id");
|
|
|
5384
5410
|
<dl>
|
|
5385
5411
|
<dd>
|
|
5386
5412
|
|
|
5387
|
-
|
|
5413
|
+
Lists all off-platform shipper organizations created by the caller's organization. | () -> (list[OffChrtShipperOrg1])
|
|
5388
5414
|
|
|
5389
5415
|
</dd>
|
|
5390
5416
|
</dl>
|
|
@@ -5400,7 +5426,7 @@ Validates a draft order and stages all related entities in a transaction. | () -
|
|
|
5400
5426
|
<dd>
|
|
5401
5427
|
|
|
5402
5428
|
```typescript
|
|
5403
|
-
await client.
|
|
5429
|
+
await client.offChrtShipperOrg.listV1();
|
|
5404
5430
|
```
|
|
5405
5431
|
|
|
5406
5432
|
</dd>
|
|
@@ -5416,15 +5442,7 @@ await client.orders.stageV1("order_id");
|
|
|
5416
5442
|
<dl>
|
|
5417
5443
|
<dd>
|
|
5418
5444
|
|
|
5419
|
-
**
|
|
5420
|
-
|
|
5421
|
-
</dd>
|
|
5422
|
-
</dl>
|
|
5423
|
-
|
|
5424
|
-
<dl>
|
|
5425
|
-
<dd>
|
|
5426
|
-
|
|
5427
|
-
**requestOptions:** `Orders.RequestOptions`
|
|
5445
|
+
**requestOptions:** `OffChrtShipperOrg.RequestOptions`
|
|
5428
5446
|
|
|
5429
5447
|
</dd>
|
|
5430
5448
|
</dl>
|
|
@@ -5435,9 +5453,7 @@ await client.orders.stageV1("order_id");
|
|
|
5435
5453
|
</dl>
|
|
5436
5454
|
</details>
|
|
5437
5455
|
|
|
5438
|
-
|
|
5439
|
-
|
|
5440
|
-
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
5456
|
+
<details><summary><code>client.offChrtShipperOrg.<a href="/src/api/resources/offChrtShipperOrg/client/Client.ts">getByIdV1</a>(id) -> Chrt.OffChrtShipperOrg1</code></summary>
|
|
5441
5457
|
<dl>
|
|
5442
5458
|
<dd>
|
|
5443
5459
|
|
|
@@ -5449,7 +5465,7 @@ await client.orders.stageV1("order_id");
|
|
|
5449
5465
|
<dl>
|
|
5450
5466
|
<dd>
|
|
5451
5467
|
|
|
5452
|
-
|
|
5468
|
+
Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShipperOrg1)
|
|
5453
5469
|
|
|
5454
5470
|
</dd>
|
|
5455
5471
|
</dl>
|
|
@@ -5465,7 +5481,7 @@ Creates a new draft order with org assignments based on caller's organization ty
|
|
|
5465
5481
|
<dd>
|
|
5466
5482
|
|
|
5467
5483
|
```typescript
|
|
5468
|
-
await client.
|
|
5484
|
+
await client.offChrtShipperOrg.getByIdV1("id");
|
|
5469
5485
|
```
|
|
5470
5486
|
|
|
5471
5487
|
</dd>
|
|
@@ -5481,7 +5497,7 @@ await client.orderDrafts.newV1();
|
|
|
5481
5497
|
<dl>
|
|
5482
5498
|
<dd>
|
|
5483
5499
|
|
|
5484
|
-
**
|
|
5500
|
+
**id:** `string`
|
|
5485
5501
|
|
|
5486
5502
|
</dd>
|
|
5487
5503
|
</dl>
|
|
@@ -5489,7 +5505,7 @@ await client.orderDrafts.newV1();
|
|
|
5489
5505
|
<dl>
|
|
5490
5506
|
<dd>
|
|
5491
5507
|
|
|
5492
|
-
**requestOptions:** `
|
|
5508
|
+
**requestOptions:** `OffChrtShipperOrg.RequestOptions`
|
|
5493
5509
|
|
|
5494
5510
|
</dd>
|
|
5495
5511
|
</dl>
|
|
@@ -5500,7 +5516,7 @@ await client.orderDrafts.newV1();
|
|
|
5500
5516
|
</dl>
|
|
5501
5517
|
</details>
|
|
5502
5518
|
|
|
5503
|
-
<details><summary><code>client.
|
|
5519
|
+
<details><summary><code>client.offChrtShipperOrg.<a href="/src/api/resources/offChrtShipperOrg/client/Client.ts">deleteByIdV1</a>(id) -> boolean</code></summary>
|
|
5504
5520
|
<dl>
|
|
5505
5521
|
<dd>
|
|
5506
5522
|
|
|
@@ -5512,7 +5528,7 @@ await client.orderDrafts.newV1();
|
|
|
5512
5528
|
<dl>
|
|
5513
5529
|
<dd>
|
|
5514
5530
|
|
|
5515
|
-
|
|
5531
|
+
Deletes off-platform shipper organization owned by the caller's organization. | () -> (bool)
|
|
5516
5532
|
|
|
5517
5533
|
</dd>
|
|
5518
5534
|
</dl>
|
|
@@ -5528,9 +5544,7 @@ Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDra
|
|
|
5528
5544
|
<dd>
|
|
5529
5545
|
|
|
5530
5546
|
```typescript
|
|
5531
|
-
await client.
|
|
5532
|
-
order_id: "order_id",
|
|
5533
|
-
});
|
|
5547
|
+
await client.offChrtShipperOrg.deleteByIdV1("id");
|
|
5534
5548
|
```
|
|
5535
5549
|
|
|
5536
5550
|
</dd>
|
|
@@ -5546,7 +5560,7 @@ await client.orderDrafts.updateV1({
|
|
|
5546
5560
|
<dl>
|
|
5547
5561
|
<dd>
|
|
5548
5562
|
|
|
5549
|
-
**
|
|
5563
|
+
**id:** `string`
|
|
5550
5564
|
|
|
5551
5565
|
</dd>
|
|
5552
5566
|
</dl>
|
|
@@ -5554,7 +5568,7 @@ await client.orderDrafts.updateV1({
|
|
|
5554
5568
|
<dl>
|
|
5555
5569
|
<dd>
|
|
5556
5570
|
|
|
5557
|
-
**requestOptions:** `
|
|
5571
|
+
**requestOptions:** `OffChrtShipperOrg.RequestOptions`
|
|
5558
5572
|
|
|
5559
5573
|
</dd>
|
|
5560
5574
|
</dl>
|
|
@@ -5565,7 +5579,7 @@ await client.orderDrafts.updateV1({
|
|
|
5565
5579
|
</dl>
|
|
5566
5580
|
</details>
|
|
5567
5581
|
|
|
5568
|
-
<details><summary><code>client.
|
|
5582
|
+
<details><summary><code>client.offChrtShipperOrg.<a href="/src/api/resources/offChrtShipperOrg/client/Client.ts">updateByIdV1</a>(id, { ...params }) -> boolean</code></summary>
|
|
5569
5583
|
<dl>
|
|
5570
5584
|
<dd>
|
|
5571
5585
|
|
|
@@ -5577,7 +5591,7 @@ await client.orderDrafts.updateV1({
|
|
|
5577
5591
|
<dl>
|
|
5578
5592
|
<dd>
|
|
5579
5593
|
|
|
5580
|
-
|
|
5594
|
+
Updates existing off-platform shipper organization owned by the caller's organization. | (OffChrtShipperOrgClientUpdate1) -> (bool)
|
|
5581
5595
|
|
|
5582
5596
|
</dd>
|
|
5583
5597
|
</dl>
|
|
@@ -5593,7 +5607,7 @@ Deletes a draft order and all associated entities. | () -> (bool)
|
|
|
5593
5607
|
<dd>
|
|
5594
5608
|
|
|
5595
5609
|
```typescript
|
|
5596
|
-
await client.
|
|
5610
|
+
await client.offChrtShipperOrg.updateByIdV1("id");
|
|
5597
5611
|
```
|
|
5598
5612
|
|
|
5599
5613
|
</dd>
|
|
@@ -5609,7 +5623,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5609
5623
|
<dl>
|
|
5610
5624
|
<dd>
|
|
5611
5625
|
|
|
5612
|
-
**
|
|
5626
|
+
**id:** `string`
|
|
5613
5627
|
|
|
5614
5628
|
</dd>
|
|
5615
5629
|
</dl>
|
|
@@ -5617,7 +5631,15 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5617
5631
|
<dl>
|
|
5618
5632
|
<dd>
|
|
5619
5633
|
|
|
5620
|
-
**
|
|
5634
|
+
**request:** `Chrt.OffChrtShipperOrgClientUpdate1`
|
|
5635
|
+
|
|
5636
|
+
</dd>
|
|
5637
|
+
</dl>
|
|
5638
|
+
|
|
5639
|
+
<dl>
|
|
5640
|
+
<dd>
|
|
5641
|
+
|
|
5642
|
+
**requestOptions:** `OffChrtShipperOrg.RequestOptions`
|
|
5621
5643
|
|
|
5622
5644
|
</dd>
|
|
5623
5645
|
</dl>
|
|
@@ -5628,7 +5650,9 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5628
5650
|
</dl>
|
|
5629
5651
|
</details>
|
|
5630
5652
|
|
|
5631
|
-
|
|
5653
|
+
## Orders
|
|
5654
|
+
|
|
5655
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
5632
5656
|
<dl>
|
|
5633
5657
|
<dd>
|
|
5634
5658
|
|
|
@@ -5640,7 +5664,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5640
5664
|
<dl>
|
|
5641
5665
|
<dd>
|
|
5642
5666
|
|
|
5643
|
-
|
|
5667
|
+
Validates a draft order and stages all related entities in a transaction. | () -> (bool)
|
|
5644
5668
|
|
|
5645
5669
|
</dd>
|
|
5646
5670
|
</dl>
|
|
@@ -5656,7 +5680,7 @@ Fetches a single draft order with optional expanded related data. Only the creat
|
|
|
5656
5680
|
<dd>
|
|
5657
5681
|
|
|
5658
5682
|
```typescript
|
|
5659
|
-
await client.
|
|
5683
|
+
await client.orders.stageV1("order_id");
|
|
5660
5684
|
```
|
|
5661
5685
|
|
|
5662
5686
|
</dd>
|
|
@@ -5672,15 +5696,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
|
5672
5696
|
<dl>
|
|
5673
5697
|
<dd>
|
|
5674
5698
|
|
|
5675
|
-
**
|
|
5676
|
-
|
|
5677
|
-
</dd>
|
|
5678
|
-
</dl>
|
|
5679
|
-
|
|
5680
|
-
<dl>
|
|
5681
|
-
<dd>
|
|
5682
|
-
|
|
5683
|
-
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
5699
|
+
**orderId:** `string`
|
|
5684
5700
|
|
|
5685
5701
|
</dd>
|
|
5686
5702
|
</dl>
|
|
@@ -5688,7 +5704,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
|
5688
5704
|
<dl>
|
|
5689
5705
|
<dd>
|
|
5690
5706
|
|
|
5691
|
-
**requestOptions:** `
|
|
5707
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
5692
5708
|
|
|
5693
5709
|
</dd>
|
|
5694
5710
|
</dl>
|
|
@@ -5699,7 +5715,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
|
5699
5715
|
</dl>
|
|
5700
5716
|
</details>
|
|
5701
5717
|
|
|
5702
|
-
<details><summary><code>client.
|
|
5718
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">cancelV1</a>(orderId) -> boolean</code></summary>
|
|
5703
5719
|
<dl>
|
|
5704
5720
|
<dd>
|
|
5705
5721
|
|
|
@@ -5711,7 +5727,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id", {});
|
|
|
5711
5727
|
<dl>
|
|
5712
5728
|
<dd>
|
|
5713
5729
|
|
|
5714
|
-
|
|
5730
|
+
Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_org_operators] | () -> (bool)
|
|
5715
5731
|
|
|
5716
5732
|
</dd>
|
|
5717
5733
|
</dl>
|
|
@@ -5727,7 +5743,7 @@ Checks whether the draft order satisfies all requirements to move into staging.
|
|
|
5727
5743
|
<dd>
|
|
5728
5744
|
|
|
5729
5745
|
```typescript
|
|
5730
|
-
await client.
|
|
5746
|
+
await client.orders.cancelV1("order_id");
|
|
5731
5747
|
```
|
|
5732
5748
|
|
|
5733
5749
|
</dd>
|
|
@@ -5751,7 +5767,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5751
5767
|
<dl>
|
|
5752
5768
|
<dd>
|
|
5753
5769
|
|
|
5754
|
-
**requestOptions:** `
|
|
5770
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
5755
5771
|
|
|
5756
5772
|
</dd>
|
|
5757
5773
|
</dl>
|
|
@@ -5762,9 +5778,9 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5762
5778
|
</dl>
|
|
5763
5779
|
</details>
|
|
5764
5780
|
|
|
5765
|
-
##
|
|
5781
|
+
## OrderDrafts
|
|
5766
5782
|
|
|
5767
|
-
<details><summary><code>client.
|
|
5783
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
5768
5784
|
<dl>
|
|
5769
5785
|
<dd>
|
|
5770
5786
|
|
|
@@ -5776,7 +5792,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5776
5792
|
<dl>
|
|
5777
5793
|
<dd>
|
|
5778
5794
|
|
|
5779
|
-
|
|
5795
|
+
Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
5780
5796
|
|
|
5781
5797
|
</dd>
|
|
5782
5798
|
</dl>
|
|
@@ -5792,7 +5808,7 @@ Retrieves the task group ID for the courier organization assigned to an order. |
|
|
|
5792
5808
|
<dd>
|
|
5793
5809
|
|
|
5794
5810
|
```typescript
|
|
5795
|
-
await client.
|
|
5811
|
+
await client.orderDrafts.newV1();
|
|
5796
5812
|
```
|
|
5797
5813
|
|
|
5798
5814
|
</dd>
|
|
@@ -5808,7 +5824,616 @@ await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_shor
|
|
|
5808
5824
|
<dl>
|
|
5809
5825
|
<dd>
|
|
5810
5826
|
|
|
5811
|
-
**
|
|
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)
|
|
6405
|
+
|
|
6406
|
+
</dd>
|
|
6407
|
+
</dl>
|
|
6408
|
+
</dd>
|
|
6409
|
+
</dl>
|
|
6410
|
+
|
|
6411
|
+
#### 🔌 Usage
|
|
6412
|
+
|
|
6413
|
+
<dl>
|
|
6414
|
+
<dd>
|
|
6415
|
+
|
|
6416
|
+
<dl>
|
|
6417
|
+
<dd>
|
|
6418
|
+
|
|
6419
|
+
```typescript
|
|
6420
|
+
await client.taskGroups.removeDriverV1("task_group_id");
|
|
6421
|
+
```
|
|
6422
|
+
|
|
6423
|
+
</dd>
|
|
6424
|
+
</dl>
|
|
6425
|
+
</dd>
|
|
6426
|
+
</dl>
|
|
6427
|
+
|
|
6428
|
+
#### ⚙️ Parameters
|
|
6429
|
+
|
|
6430
|
+
<dl>
|
|
6431
|
+
<dd>
|
|
6432
|
+
|
|
6433
|
+
<dl>
|
|
6434
|
+
<dd>
|
|
6435
|
+
|
|
6436
|
+
**taskGroupId:** `string`
|
|
5812
6437
|
|
|
5813
6438
|
</dd>
|
|
5814
6439
|
</dl>
|
|
@@ -5827,7 +6452,7 @@ await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_shor
|
|
|
5827
6452
|
</dl>
|
|
5828
6453
|
</details>
|
|
5829
6454
|
|
|
5830
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6455
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateCourierOrgV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
5831
6456
|
<dl>
|
|
5832
6457
|
<dd>
|
|
5833
6458
|
|
|
@@ -5839,7 +6464,7 @@ await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_shor
|
|
|
5839
6464
|
<dl>
|
|
5840
6465
|
<dd>
|
|
5841
6466
|
|
|
5842
|
-
|
|
6467
|
+
Updates the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateCourierOrgReq) -> (bool)
|
|
5843
6468
|
|
|
5844
6469
|
</dd>
|
|
5845
6470
|
</dl>
|
|
@@ -5855,7 +6480,9 @@ Retrieves the task group ID for the courier driver assigned to an order. | authz
|
|
|
5855
6480
|
<dd>
|
|
5856
6481
|
|
|
5857
6482
|
```typescript
|
|
5858
|
-
await client.taskGroups.
|
|
6483
|
+
await client.taskGroups.updateCourierOrgV1("task_group_id", {
|
|
6484
|
+
courier_org_id: "courier_org_id",
|
|
6485
|
+
});
|
|
5859
6486
|
```
|
|
5860
6487
|
|
|
5861
6488
|
</dd>
|
|
@@ -5871,7 +6498,15 @@ await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_i
|
|
|
5871
6498
|
<dl>
|
|
5872
6499
|
<dd>
|
|
5873
6500
|
|
|
5874
|
-
**
|
|
6501
|
+
**taskGroupId:** `string`
|
|
6502
|
+
|
|
6503
|
+
</dd>
|
|
6504
|
+
</dl>
|
|
6505
|
+
|
|
6506
|
+
<dl>
|
|
6507
|
+
<dd>
|
|
6508
|
+
|
|
6509
|
+
**request:** `Chrt.UpdateCourierOrgReq`
|
|
5875
6510
|
|
|
5876
6511
|
</dd>
|
|
5877
6512
|
</dl>
|
|
@@ -5890,7 +6525,7 @@ await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_i
|
|
|
5890
6525
|
</dl>
|
|
5891
6526
|
</details>
|
|
5892
6527
|
|
|
5893
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6528
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">addMessageV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
5894
6529
|
<dl>
|
|
5895
6530
|
<dd>
|
|
5896
6531
|
|
|
@@ -5902,7 +6537,7 @@ await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_i
|
|
|
5902
6537
|
<dl>
|
|
5903
6538
|
<dd>
|
|
5904
6539
|
|
|
5905
|
-
|
|
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)
|
|
5906
6541
|
|
|
5907
6542
|
</dd>
|
|
5908
6543
|
</dl>
|
|
@@ -5918,8 +6553,8 @@ Updates the ordering of tasks in a task group. Task group must be in STAGED or I
|
|
|
5918
6553
|
<dd>
|
|
5919
6554
|
|
|
5920
6555
|
```typescript
|
|
5921
|
-
await client.taskGroups.
|
|
5922
|
-
|
|
6556
|
+
await client.taskGroups.addMessageV1("task_group_id", {
|
|
6557
|
+
message: "message",
|
|
5923
6558
|
});
|
|
5924
6559
|
```
|
|
5925
6560
|
|
|
@@ -5944,7 +6579,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
5944
6579
|
<dl>
|
|
5945
6580
|
<dd>
|
|
5946
6581
|
|
|
5947
|
-
**request:** `Chrt.
|
|
6582
|
+
**request:** `Chrt.AddMessageReq`
|
|
5948
6583
|
|
|
5949
6584
|
</dd>
|
|
5950
6585
|
</dl>
|
|
@@ -5963,7 +6598,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
5963
6598
|
</dl>
|
|
5964
6599
|
</details>
|
|
5965
6600
|
|
|
5966
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6601
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">addS3ObjectV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
5967
6602
|
<dl>
|
|
5968
6603
|
<dd>
|
|
5969
6604
|
|
|
@@ -5975,7 +6610,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
5975
6610
|
<dl>
|
|
5976
6611
|
<dd>
|
|
5977
6612
|
|
|
5978
|
-
|
|
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)
|
|
5979
6614
|
|
|
5980
6615
|
</dd>
|
|
5981
6616
|
</dl>
|
|
@@ -5991,8 +6626,8 @@ Updates the flight number on both task group and all its tasks. Task group must
|
|
|
5991
6626
|
<dd>
|
|
5992
6627
|
|
|
5993
6628
|
```typescript
|
|
5994
|
-
await client.taskGroups.
|
|
5995
|
-
|
|
6629
|
+
await client.taskGroups.addS3ObjectV1("task_group_id", {
|
|
6630
|
+
image: fs.createReadStream("/path/to/your/file"),
|
|
5996
6631
|
});
|
|
5997
6632
|
```
|
|
5998
6633
|
|
|
@@ -6017,7 +6652,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6017
6652
|
<dl>
|
|
6018
6653
|
<dd>
|
|
6019
6654
|
|
|
6020
|
-
**request:** `Chrt.
|
|
6655
|
+
**request:** `Chrt.BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost`
|
|
6021
6656
|
|
|
6022
6657
|
</dd>
|
|
6023
6658
|
</dl>
|
|
@@ -6036,7 +6671,72 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6036
6671
|
</dl>
|
|
6037
6672
|
</details>
|
|
6038
6673
|
|
|
6039
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6674
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">deleteS3ObjectV1</a>(taskGroupS3ObjectMetadataId) -> boolean</code></summary>
|
|
6675
|
+
<dl>
|
|
6676
|
+
<dd>
|
|
6677
|
+
|
|
6678
|
+
#### 📝 Description
|
|
6679
|
+
|
|
6680
|
+
<dl>
|
|
6681
|
+
<dd>
|
|
6682
|
+
|
|
6683
|
+
<dl>
|
|
6684
|
+
<dd>
|
|
6685
|
+
|
|
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)
|
|
6687
|
+
|
|
6688
|
+
</dd>
|
|
6689
|
+
</dl>
|
|
6690
|
+
</dd>
|
|
6691
|
+
</dl>
|
|
6692
|
+
|
|
6693
|
+
#### 🔌 Usage
|
|
6694
|
+
|
|
6695
|
+
<dl>
|
|
6696
|
+
<dd>
|
|
6697
|
+
|
|
6698
|
+
<dl>
|
|
6699
|
+
<dd>
|
|
6700
|
+
|
|
6701
|
+
```typescript
|
|
6702
|
+
await client.taskGroups.deleteS3ObjectV1("task_group_s3_object_metadata_id");
|
|
6703
|
+
```
|
|
6704
|
+
|
|
6705
|
+
</dd>
|
|
6706
|
+
</dl>
|
|
6707
|
+
</dd>
|
|
6708
|
+
</dl>
|
|
6709
|
+
|
|
6710
|
+
#### ⚙️ Parameters
|
|
6711
|
+
|
|
6712
|
+
<dl>
|
|
6713
|
+
<dd>
|
|
6714
|
+
|
|
6715
|
+
<dl>
|
|
6716
|
+
<dd>
|
|
6717
|
+
|
|
6718
|
+
**taskGroupS3ObjectMetadataId:** `string`
|
|
6719
|
+
|
|
6720
|
+
</dd>
|
|
6721
|
+
</dl>
|
|
6722
|
+
|
|
6723
|
+
<dl>
|
|
6724
|
+
<dd>
|
|
6725
|
+
|
|
6726
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6727
|
+
|
|
6728
|
+
</dd>
|
|
6729
|
+
</dl>
|
|
6730
|
+
</dd>
|
|
6731
|
+
</dl>
|
|
6732
|
+
|
|
6733
|
+
</dd>
|
|
6734
|
+
</dl>
|
|
6735
|
+
</details>
|
|
6736
|
+
|
|
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>
|
|
6040
6740
|
<dl>
|
|
6041
6741
|
<dd>
|
|
6042
6742
|
|
|
@@ -6048,7 +6748,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6048
6748
|
<dl>
|
|
6049
6749
|
<dd>
|
|
6050
6750
|
|
|
6051
|
-
|
|
6751
|
+
Adds a new task to a task group at a specific index. | authz_personas=[lig_org_operators] | (AddTaskToGroupReq) -> (PydanticObjectId)
|
|
6052
6752
|
|
|
6053
6753
|
</dd>
|
|
6054
6754
|
</dl>
|
|
@@ -6064,7 +6764,13 @@ Sets or removes the driver assigned to a task group. | authz_personas=[courier_o
|
|
|
6064
6764
|
<dd>
|
|
6065
6765
|
|
|
6066
6766
|
```typescript
|
|
6067
|
-
await client.
|
|
6767
|
+
await client.tasks.addToTaskGroupV1("task_group_id", {
|
|
6768
|
+
task: {
|
|
6769
|
+
schema_version: 1,
|
|
6770
|
+
},
|
|
6771
|
+
status: "draft",
|
|
6772
|
+
index: 1,
|
|
6773
|
+
});
|
|
6068
6774
|
```
|
|
6069
6775
|
|
|
6070
6776
|
</dd>
|
|
@@ -6088,7 +6794,141 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6088
6794
|
<dl>
|
|
6089
6795
|
<dd>
|
|
6090
6796
|
|
|
6091
|
-
**request:** `Chrt.
|
|
6797
|
+
**request:** `Chrt.AddTaskToGroupReq`
|
|
6798
|
+
|
|
6799
|
+
</dd>
|
|
6800
|
+
</dl>
|
|
6801
|
+
|
|
6802
|
+
<dl>
|
|
6803
|
+
<dd>
|
|
6804
|
+
|
|
6805
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6806
|
+
|
|
6807
|
+
</dd>
|
|
6808
|
+
</dl>
|
|
6809
|
+
</dd>
|
|
6810
|
+
</dl>
|
|
6811
|
+
|
|
6812
|
+
</dd>
|
|
6813
|
+
</dl>
|
|
6814
|
+
</details>
|
|
6815
|
+
|
|
6816
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">updateV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
6817
|
+
<dl>
|
|
6818
|
+
<dd>
|
|
6819
|
+
|
|
6820
|
+
#### 📝 Description
|
|
6821
|
+
|
|
6822
|
+
<dl>
|
|
6823
|
+
<dd>
|
|
6824
|
+
|
|
6825
|
+
<dl>
|
|
6826
|
+
<dd>
|
|
6827
|
+
|
|
6828
|
+
Updates a task. Task must be in STAGED status. | authz_personas=[lig_org_operators] | (TaskClientUpdate1) -> (PydanticObjectId)
|
|
6829
|
+
|
|
6830
|
+
</dd>
|
|
6831
|
+
</dl>
|
|
6832
|
+
</dd>
|
|
6833
|
+
</dl>
|
|
6834
|
+
|
|
6835
|
+
#### 🔌 Usage
|
|
6836
|
+
|
|
6837
|
+
<dl>
|
|
6838
|
+
<dd>
|
|
6839
|
+
|
|
6840
|
+
<dl>
|
|
6841
|
+
<dd>
|
|
6842
|
+
|
|
6843
|
+
```typescript
|
|
6844
|
+
await client.tasks.updateV1("task_id", {});
|
|
6845
|
+
```
|
|
6846
|
+
|
|
6847
|
+
</dd>
|
|
6848
|
+
</dl>
|
|
6849
|
+
</dd>
|
|
6850
|
+
</dl>
|
|
6851
|
+
|
|
6852
|
+
#### ⚙️ Parameters
|
|
6853
|
+
|
|
6854
|
+
<dl>
|
|
6855
|
+
<dd>
|
|
6856
|
+
|
|
6857
|
+
<dl>
|
|
6858
|
+
<dd>
|
|
6859
|
+
|
|
6860
|
+
**taskId:** `string`
|
|
6861
|
+
|
|
6862
|
+
</dd>
|
|
6863
|
+
</dl>
|
|
6864
|
+
|
|
6865
|
+
<dl>
|
|
6866
|
+
<dd>
|
|
6867
|
+
|
|
6868
|
+
**request:** `Chrt.TaskClientUpdate1`
|
|
6869
|
+
|
|
6870
|
+
</dd>
|
|
6871
|
+
</dl>
|
|
6872
|
+
|
|
6873
|
+
<dl>
|
|
6874
|
+
<dd>
|
|
6875
|
+
|
|
6876
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6877
|
+
|
|
6878
|
+
</dd>
|
|
6879
|
+
</dl>
|
|
6880
|
+
</dd>
|
|
6881
|
+
</dl>
|
|
6882
|
+
|
|
6883
|
+
</dd>
|
|
6884
|
+
</dl>
|
|
6885
|
+
</details>
|
|
6886
|
+
|
|
6887
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">completeV1</a>(taskId) -> boolean</code></summary>
|
|
6888
|
+
<dl>
|
|
6889
|
+
<dd>
|
|
6890
|
+
|
|
6891
|
+
#### 📝 Description
|
|
6892
|
+
|
|
6893
|
+
<dl>
|
|
6894
|
+
<dd>
|
|
6895
|
+
|
|
6896
|
+
<dl>
|
|
6897
|
+
<dd>
|
|
6898
|
+
|
|
6899
|
+
Marks a task as COMPLETED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)
|
|
6900
|
+
|
|
6901
|
+
</dd>
|
|
6902
|
+
</dl>
|
|
6903
|
+
</dd>
|
|
6904
|
+
</dl>
|
|
6905
|
+
|
|
6906
|
+
#### 🔌 Usage
|
|
6907
|
+
|
|
6908
|
+
<dl>
|
|
6909
|
+
<dd>
|
|
6910
|
+
|
|
6911
|
+
<dl>
|
|
6912
|
+
<dd>
|
|
6913
|
+
|
|
6914
|
+
```typescript
|
|
6915
|
+
await client.tasks.completeV1("task_id");
|
|
6916
|
+
```
|
|
6917
|
+
|
|
6918
|
+
</dd>
|
|
6919
|
+
</dl>
|
|
6920
|
+
</dd>
|
|
6921
|
+
</dl>
|
|
6922
|
+
|
|
6923
|
+
#### ⚙️ Parameters
|
|
6924
|
+
|
|
6925
|
+
<dl>
|
|
6926
|
+
<dd>
|
|
6927
|
+
|
|
6928
|
+
<dl>
|
|
6929
|
+
<dd>
|
|
6930
|
+
|
|
6931
|
+
**taskId:** `string`
|
|
6092
6932
|
|
|
6093
6933
|
</dd>
|
|
6094
6934
|
</dl>
|
|
@@ -6096,7 +6936,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6096
6936
|
<dl>
|
|
6097
6937
|
<dd>
|
|
6098
6938
|
|
|
6099
|
-
**requestOptions:** `
|
|
6939
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6100
6940
|
|
|
6101
6941
|
</dd>
|
|
6102
6942
|
</dl>
|
|
@@ -6107,7 +6947,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6107
6947
|
</dl>
|
|
6108
6948
|
</details>
|
|
6109
6949
|
|
|
6110
|
-
<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>
|
|
6111
6951
|
<dl>
|
|
6112
6952
|
<dd>
|
|
6113
6953
|
|
|
@@ -6119,7 +6959,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6119
6959
|
<dl>
|
|
6120
6960
|
<dd>
|
|
6121
6961
|
|
|
6122
|
-
|
|
6962
|
+
Marks a task as SKIPPED. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators] (depending on type) | () -> (bool)
|
|
6123
6963
|
|
|
6124
6964
|
</dd>
|
|
6125
6965
|
</dl>
|
|
@@ -6135,7 +6975,7 @@ Sets or removes the courier organization assigned to a task group. | authz_perso
|
|
|
6135
6975
|
<dd>
|
|
6136
6976
|
|
|
6137
6977
|
```typescript
|
|
6138
|
-
await client.
|
|
6978
|
+
await client.tasks.skipV1("task_id");
|
|
6139
6979
|
```
|
|
6140
6980
|
|
|
6141
6981
|
</dd>
|
|
@@ -6151,15 +6991,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6151
6991
|
<dl>
|
|
6152
6992
|
<dd>
|
|
6153
6993
|
|
|
6154
|
-
**
|
|
6155
|
-
|
|
6156
|
-
</dd>
|
|
6157
|
-
</dl>
|
|
6158
|
-
|
|
6159
|
-
<dl>
|
|
6160
|
-
<dd>
|
|
6161
|
-
|
|
6162
|
-
**request:** `Chrt.UpdateTaskGroupCourierOrgReq`
|
|
6994
|
+
**taskId:** `string`
|
|
6163
6995
|
|
|
6164
6996
|
</dd>
|
|
6165
6997
|
</dl>
|
|
@@ -6167,7 +6999,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6167
6999
|
<dl>
|
|
6168
7000
|
<dd>
|
|
6169
7001
|
|
|
6170
|
-
**requestOptions:** `
|
|
7002
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6171
7003
|
|
|
6172
7004
|
</dd>
|
|
6173
7005
|
</dl>
|
|
@@ -6178,7 +7010,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6178
7010
|
</dl>
|
|
6179
7011
|
</details>
|
|
6180
7012
|
|
|
6181
|
-
<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>
|
|
6182
7014
|
<dl>
|
|
6183
7015
|
<dd>
|
|
6184
7016
|
|
|
@@ -6190,7 +7022,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6190
7022
|
<dl>
|
|
6191
7023
|
<dd>
|
|
6192
7024
|
|
|
6193
|
-
|
|
7025
|
+
Deletes a task. Task must be in STAGED status. | authz_personas=[lig_org_operators] | () -> (bool)
|
|
6194
7026
|
|
|
6195
7027
|
</dd>
|
|
6196
7028
|
</dl>
|
|
@@ -6206,7 +7038,7 @@ Starts a task group by changing its status to in-progress and updating the order
|
|
|
6206
7038
|
<dd>
|
|
6207
7039
|
|
|
6208
7040
|
```typescript
|
|
6209
|
-
await client.
|
|
7041
|
+
await client.tasks.deleteV1("task_id");
|
|
6210
7042
|
```
|
|
6211
7043
|
|
|
6212
7044
|
</dd>
|
|
@@ -6222,7 +7054,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6222
7054
|
<dl>
|
|
6223
7055
|
<dd>
|
|
6224
7056
|
|
|
6225
|
-
**
|
|
7057
|
+
**taskId:** `string`
|
|
6226
7058
|
|
|
6227
7059
|
</dd>
|
|
6228
7060
|
</dl>
|
|
@@ -6230,7 +7062,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6230
7062
|
<dl>
|
|
6231
7063
|
<dd>
|
|
6232
7064
|
|
|
6233
|
-
**requestOptions:** `
|
|
7065
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
6234
7066
|
|
|
6235
7067
|
</dd>
|
|
6236
7068
|
</dl>
|
|
@@ -10600,9 +11432,9 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
10600
11432
|
</dl>
|
|
10601
11433
|
</details>
|
|
10602
11434
|
|
|
10603
|
-
## TaskArtifacts
|
|
11435
|
+
## TaskArtifacts S3ObjectMetadata
|
|
10604
11436
|
|
|
10605
|
-
<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>
|
|
10606
11438
|
<dl>
|
|
10607
11439
|
<dd>
|
|
10608
11440
|
|
|
@@ -10614,7 +11446,7 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
10614
11446
|
<dl>
|
|
10615
11447
|
<dd>
|
|
10616
11448
|
|
|
10617
|
-
|
|
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)
|
|
10618
11450
|
|
|
10619
11451
|
</dd>
|
|
10620
11452
|
</dl>
|
|
@@ -10630,7 +11462,7 @@ Streams a task_artifact image file from S3 storage. | () -> (StreamingResponse)
|
|
|
10630
11462
|
<dd>
|
|
10631
11463
|
|
|
10632
11464
|
```typescript
|
|
10633
|
-
await client.taskArtifacts.
|
|
11465
|
+
await client.taskArtifacts.s3ObjectMetadata.getV1("task_artifact_s3_object_metadata_id");
|
|
10634
11466
|
```
|
|
10635
11467
|
|
|
10636
11468
|
</dd>
|
|
@@ -10654,7 +11486,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10654
11486
|
<dl>
|
|
10655
11487
|
<dd>
|
|
10656
11488
|
|
|
10657
|
-
**requestOptions:** `
|
|
11489
|
+
**requestOptions:** `S3ObjectMetadata.RequestOptions`
|
|
10658
11490
|
|
|
10659
11491
|
</dd>
|
|
10660
11492
|
</dl>
|
|
@@ -10665,9 +11497,9 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10665
11497
|
</dl>
|
|
10666
11498
|
</details>
|
|
10667
11499
|
|
|
10668
|
-
## TaskArtifacts
|
|
11500
|
+
## TaskArtifacts S3Object
|
|
10669
11501
|
|
|
10670
|
-
<details><summary><code>client.taskArtifacts.
|
|
11502
|
+
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) -> unknown</code></summary>
|
|
10671
11503
|
<dl>
|
|
10672
11504
|
<dd>
|
|
10673
11505
|
|
|
@@ -10679,7 +11511,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10679
11511
|
<dl>
|
|
10680
11512
|
<dd>
|
|
10681
11513
|
|
|
10682
|
-
|
|
11514
|
+
Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (StreamingResponse)
|
|
10683
11515
|
|
|
10684
11516
|
</dd>
|
|
10685
11517
|
</dl>
|
|
@@ -10695,7 +11527,7 @@ Retrieves the blurhash string for a task_artifact image for fast placeholder loa
|
|
|
10695
11527
|
<dd>
|
|
10696
11528
|
|
|
10697
11529
|
```typescript
|
|
10698
|
-
await client.taskArtifacts.
|
|
11530
|
+
await client.taskArtifacts.s3Object.getV1("task_artifact_s3_object_metadata_id");
|
|
10699
11531
|
```
|
|
10700
11532
|
|
|
10701
11533
|
</dd>
|
|
@@ -10719,7 +11551,265 @@ await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_m
|
|
|
10719
11551
|
<dl>
|
|
10720
11552
|
<dd>
|
|
10721
11553
|
|
|
10722
|
-
**requestOptions:** `
|
|
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
|
+
```
|
|
11660
|
+
|
|
11661
|
+
</dd>
|
|
11662
|
+
</dl>
|
|
11663
|
+
</dd>
|
|
11664
|
+
</dl>
|
|
11665
|
+
|
|
11666
|
+
#### ⚙️ Parameters
|
|
11667
|
+
|
|
11668
|
+
<dl>
|
|
11669
|
+
<dd>
|
|
11670
|
+
|
|
11671
|
+
<dl>
|
|
11672
|
+
<dd>
|
|
11673
|
+
|
|
11674
|
+
**orderIdOrShortId:** `string`
|
|
11675
|
+
|
|
11676
|
+
</dd>
|
|
11677
|
+
</dl>
|
|
11678
|
+
|
|
11679
|
+
<dl>
|
|
11680
|
+
<dd>
|
|
11681
|
+
|
|
11682
|
+
**requestOptions:** `TaskGroupId.RequestOptions`
|
|
11683
|
+
|
|
11684
|
+
</dd>
|
|
11685
|
+
</dl>
|
|
11686
|
+
</dd>
|
|
11687
|
+
</dl>
|
|
11688
|
+
|
|
11689
|
+
</dd>
|
|
11690
|
+
</dl>
|
|
11691
|
+
</details>
|
|
11692
|
+
|
|
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>
|
|
11696
|
+
<dl>
|
|
11697
|
+
<dd>
|
|
11698
|
+
|
|
11699
|
+
#### 📝 Description
|
|
11700
|
+
|
|
11701
|
+
<dl>
|
|
11702
|
+
<dd>
|
|
11703
|
+
|
|
11704
|
+
<dl>
|
|
11705
|
+
<dd>
|
|
11706
|
+
|
|
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)
|
|
11708
|
+
|
|
11709
|
+
</dd>
|
|
11710
|
+
</dl>
|
|
11711
|
+
</dd>
|
|
11712
|
+
</dl>
|
|
11713
|
+
|
|
11714
|
+
#### 🔌 Usage
|
|
11715
|
+
|
|
11716
|
+
<dl>
|
|
11717
|
+
<dd>
|
|
11718
|
+
|
|
11719
|
+
<dl>
|
|
11720
|
+
<dd>
|
|
11721
|
+
|
|
11722
|
+
```typescript
|
|
11723
|
+
await client.taskGroups.s3ObjectMetadata.getV1("task_group_s3_object_metadata_id");
|
|
11724
|
+
```
|
|
11725
|
+
|
|
11726
|
+
</dd>
|
|
11727
|
+
</dl>
|
|
11728
|
+
</dd>
|
|
11729
|
+
</dl>
|
|
11730
|
+
|
|
11731
|
+
#### ⚙️ Parameters
|
|
11732
|
+
|
|
11733
|
+
<dl>
|
|
11734
|
+
<dd>
|
|
11735
|
+
|
|
11736
|
+
<dl>
|
|
11737
|
+
<dd>
|
|
11738
|
+
|
|
11739
|
+
**taskGroupS3ObjectMetadataId:** `string`
|
|
11740
|
+
|
|
11741
|
+
</dd>
|
|
11742
|
+
</dl>
|
|
11743
|
+
|
|
11744
|
+
<dl>
|
|
11745
|
+
<dd>
|
|
11746
|
+
|
|
11747
|
+
**requestOptions:** `S3ObjectMetadata.RequestOptions`
|
|
11748
|
+
|
|
11749
|
+
</dd>
|
|
11750
|
+
</dl>
|
|
11751
|
+
</dd>
|
|
11752
|
+
</dl>
|
|
11753
|
+
|
|
11754
|
+
</dd>
|
|
11755
|
+
</dl>
|
|
11756
|
+
</details>
|
|
11757
|
+
|
|
11758
|
+
## TaskGroups S3Object
|
|
11759
|
+
|
|
11760
|
+
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) -> unknown</code></summary>
|
|
11761
|
+
<dl>
|
|
11762
|
+
<dd>
|
|
11763
|
+
|
|
11764
|
+
#### 📝 Description
|
|
11765
|
+
|
|
11766
|
+
<dl>
|
|
11767
|
+
<dd>
|
|
11768
|
+
|
|
11769
|
+
<dl>
|
|
11770
|
+
<dd>
|
|
11771
|
+
|
|
11772
|
+
Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (StreamingResponse)
|
|
11773
|
+
|
|
11774
|
+
</dd>
|
|
11775
|
+
</dl>
|
|
11776
|
+
</dd>
|
|
11777
|
+
</dl>
|
|
11778
|
+
|
|
11779
|
+
#### 🔌 Usage
|
|
11780
|
+
|
|
11781
|
+
<dl>
|
|
11782
|
+
<dd>
|
|
11783
|
+
|
|
11784
|
+
<dl>
|
|
11785
|
+
<dd>
|
|
11786
|
+
|
|
11787
|
+
```typescript
|
|
11788
|
+
await client.taskGroups.s3Object.getV1("task_group_s3_object_metadata_id");
|
|
11789
|
+
```
|
|
11790
|
+
|
|
11791
|
+
</dd>
|
|
11792
|
+
</dl>
|
|
11793
|
+
</dd>
|
|
11794
|
+
</dl>
|
|
11795
|
+
|
|
11796
|
+
#### ⚙️ Parameters
|
|
11797
|
+
|
|
11798
|
+
<dl>
|
|
11799
|
+
<dd>
|
|
11800
|
+
|
|
11801
|
+
<dl>
|
|
11802
|
+
<dd>
|
|
11803
|
+
|
|
11804
|
+
**taskGroupS3ObjectMetadataId:** `string`
|
|
11805
|
+
|
|
11806
|
+
</dd>
|
|
11807
|
+
</dl>
|
|
11808
|
+
|
|
11809
|
+
<dl>
|
|
11810
|
+
<dd>
|
|
11811
|
+
|
|
11812
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
10723
11813
|
|
|
10724
11814
|
</dd>
|
|
10725
11815
|
</dl>
|
|
@@ -11057,6 +12147,8 @@ await client.taskGroups.expanded.listForCourierOperatorsV1({
|
|
|
11057
12147
|
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11058
12148
|
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11059
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",
|
|
11060
12152
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11061
12153
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11062
12154
|
body: {},
|
|
@@ -11136,6 +12228,8 @@ await client.taskGroups.expanded.listForCourierDriverV1({
|
|
|
11136
12228
|
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11137
12229
|
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11138
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",
|
|
11139
12233
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11140
12234
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11141
12235
|
body: {},
|