@chrt-inc/typescript-sdk 1.312.0 → 1.313.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.js +2 -2
- package/dist/cjs/api/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.js +1 -0
- package/dist/cjs/api/resources/orders/client/Client.d.ts +53 -6
- package/dist/cjs/api/resources/orders/client/Client.js +240 -8
- package/dist/cjs/api/resources/orders/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/client/index.js +15 -0
- package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedListForForwarderReq.d.ts +28 -0
- package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedListForShipperReq.d.ts +28 -0
- package/dist/cjs/api/resources/orders/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/orders/index.d.ts +0 -1
- package/dist/cjs/api/resources/orders/index.js +0 -1
- package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +117 -6
- package/dist/cjs/api/resources/taskGroups/client/Client.js +538 -8
- package/dist/cjs/api/resources/taskGroups/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskGroups/index.js +0 -1
- package/dist/cjs/api/types/OrderAndTaskGroupExpandedReq.d.ts +16 -0
- package/dist/cjs/api/types/OrderExpanded.d.ts +12 -0
- package/dist/cjs/api/types/OrdersExpandedListRes.d.ts +8 -0
- package/dist/cjs/api/types/Task1.d.ts +1 -1
- package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -1
- package/dist/cjs/api/types/TaskClientUpdate1.d.ts +1 -1
- package/dist/cjs/api/types/TaskExpanded.d.ts +1 -4
- package/dist/cjs/api/types/TaskGroupExpanded.d.ts +15 -0
- package/dist/cjs/api/types/TaskGroupExpandedListReq.d.ts +26 -0
- package/dist/cjs/api/types/TaskGroupExpandedListRes.d.ts +8 -0
- package/dist/cjs/api/types/index.d.ts +6 -16
- package/dist/cjs/api/types/index.js +6 -16
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/index.mjs +1 -0
- package/dist/esm/api/resources/orders/client/Client.d.mts +53 -6
- package/dist/esm/api/resources/orders/client/Client.mjs +240 -8
- package/dist/esm/api/resources/orders/client/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/client/index.mjs +1 -1
- package/dist/esm/api/resources/orders/client/requests/OrdersExpandedListForForwarderReq.d.mts +28 -0
- package/dist/esm/api/resources/orders/client/requests/OrdersExpandedListForShipperReq.d.mts +28 -0
- package/dist/esm/api/resources/orders/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/orders/index.d.mts +0 -1
- package/dist/esm/api/resources/orders/index.mjs +0 -1
- package/dist/esm/api/resources/taskGroups/client/Client.d.mts +117 -6
- package/dist/esm/api/resources/taskGroups/client/Client.mjs +538 -8
- package/dist/esm/api/resources/taskGroups/index.d.mts +0 -1
- package/dist/esm/api/resources/taskGroups/index.mjs +0 -1
- package/dist/esm/api/types/OrderAndTaskGroupExpandedReq.d.mts +16 -0
- package/dist/esm/api/types/OrderExpanded.d.mts +12 -0
- package/dist/esm/api/types/OrdersExpandedListRes.d.mts +8 -0
- package/dist/esm/api/types/Task1.d.mts +1 -1
- package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -1
- package/dist/esm/api/types/TaskClientUpdate1.d.mts +1 -1
- package/dist/esm/api/types/TaskExpanded.d.mts +1 -4
- package/dist/esm/api/types/TaskGroupExpanded.d.mts +15 -0
- package/dist/esm/api/types/TaskGroupExpandedListReq.d.mts +26 -0
- package/dist/esm/api/types/TaskGroupExpandedListRes.d.mts +8 -0
- package/dist/esm/api/types/index.d.mts +6 -16
- package/dist/esm/api/types/index.mjs +6 -16
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +913 -757
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.d.ts +0 -62
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.js +0 -194
- package/dist/cjs/api/resources/orders/resources/expanded/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/orders/resources/expanded/index.d.ts +0 -1
- package/dist/cjs/api/resources/orders/resources/expanded/index.js +0 -17
- package/dist/cjs/api/resources/orders/resources/expandedList/client/Client.d.ts +0 -78
- package/dist/cjs/api/resources/orders/resources/expandedList/client/Client.js +0 -291
- package/dist/cjs/api/resources/orders/resources/expandedList/client/index.d.ts +0 -2
- package/dist/cjs/api/resources/orders/resources/expandedList/client/index.js +0 -17
- package/dist/cjs/api/resources/orders/resources/expandedList/client/requests/ExpandedListPostOrderCreatorExpandedListV1Request.d.ts +0 -30
- package/dist/cjs/api/resources/orders/resources/expandedList/client/requests/ExpandedListPostShipperExpandedListV1Request.d.ts +0 -28
- package/dist/cjs/api/resources/orders/resources/expandedList/client/requests/index.d.ts +0 -2
- package/dist/cjs/api/resources/orders/resources/expandedList/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/orders/resources/expandedList/index.d.ts +0 -1
- package/dist/cjs/api/resources/orders/resources/expandedList/index.js +0 -17
- package/dist/cjs/api/resources/orders/resources/index.d.ts +0 -3
- package/dist/cjs/api/resources/orders/resources/index.js +0 -42
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.d.ts +0 -76
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.js +0 -263
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/index.d.ts +0 -2
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/index.js +0 -17
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/TaskGroupExpandedForShipperReq.d.ts +0 -20
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/taskGroups/resources/expanded/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskGroups/resources/expanded/index.js +0 -17
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/Client.d.ts +0 -90
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/Client.js +0 -326
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/index.d.ts +0 -2
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/index.js +0 -17
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierAdministratorV1Request.d.ts +0 -40
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierDriverV1Request.d.ts +0 -40
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/requests/index.d.ts +0 -2
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/index.js +0 -17
- package/dist/cjs/api/resources/taskGroups/resources/index.d.ts +0 -4
- package/dist/cjs/api/resources/taskGroups/resources/index.js +0 -43
- package/dist/cjs/api/types/OrderExpandedForOrderCreator.d.ts +0 -16
- package/dist/cjs/api/types/OrderExpandedForOrderCreatorReq.d.ts +0 -14
- package/dist/cjs/api/types/OrderExpandedForShipper.d.ts +0 -16
- package/dist/cjs/api/types/OrderExpandedForShipperReq.d.ts +0 -14
- package/dist/cjs/api/types/OrderExpandedForShipperReq.js +0 -5
- package/dist/cjs/api/types/OrderExpandedListSortFieldEnum.d.ts +0 -11
- package/dist/cjs/api/types/OrderExpandedListSortFieldEnum.js +0 -10
- package/dist/cjs/api/types/OrdersExpandedForOrderCreatorRes.d.ts +0 -11
- package/dist/cjs/api/types/OrdersExpandedForOrderCreatorRes.js +0 -5
- package/dist/cjs/api/types/OrdersExpandedForShipperRes.d.ts +0 -11
- package/dist/cjs/api/types/OrdersExpandedForShipperRes.js +0 -5
- package/dist/cjs/api/types/SortOrderEnum.d.ts +0 -11
- package/dist/cjs/api/types/SortOrderEnum.js +0 -10
- package/dist/cjs/api/types/TaskGroupExpandedForCourierAdministrator.d.ts +0 -18
- package/dist/cjs/api/types/TaskGroupExpandedForCourierAdministrator.js +0 -5
- package/dist/cjs/api/types/TaskGroupExpandedForCourierAdministratorReq.d.ts +0 -19
- package/dist/cjs/api/types/TaskGroupExpandedForCourierAdministratorReq.js +0 -5
- package/dist/cjs/api/types/TaskGroupExpandedForCourierDriver.d.ts +0 -18
- package/dist/cjs/api/types/TaskGroupExpandedForCourierDriver.js +0 -5
- package/dist/cjs/api/types/TaskGroupExpandedForCourierDriverReq.d.ts +0 -19
- package/dist/cjs/api/types/TaskGroupExpandedForCourierDriverReq.js +0 -5
- package/dist/cjs/api/types/TaskGroupExpandedForShipper.d.ts +0 -18
- package/dist/cjs/api/types/TaskGroupExpandedForShipper.js +0 -5
- package/dist/cjs/api/types/TaskGroupExpandedSortFieldEnum.d.ts +0 -12
- package/dist/cjs/api/types/TaskGroupExpandedSortFieldEnum.js +0 -11
- package/dist/cjs/api/types/TaskGroupsExpandedForCourierAdministratorRes.d.ts +0 -11
- package/dist/cjs/api/types/TaskGroupsExpandedForCourierAdministratorRes.js +0 -5
- package/dist/cjs/api/types/TaskGroupsExpandedForCourierDriverRes.d.ts +0 -11
- package/dist/cjs/api/types/TaskGroupsExpandedForCourierDriverRes.js +0 -5
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.d.mts +0 -62
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.mjs +0 -157
- package/dist/esm/api/resources/orders/resources/expanded/client/index.d.mts +0 -1
- package/dist/esm/api/resources/orders/resources/expanded/index.d.mts +0 -1
- package/dist/esm/api/resources/orders/resources/expanded/index.mjs +0 -1
- package/dist/esm/api/resources/orders/resources/expandedList/client/Client.d.mts +0 -78
- package/dist/esm/api/resources/orders/resources/expandedList/client/Client.mjs +0 -254
- package/dist/esm/api/resources/orders/resources/expandedList/client/index.d.mts +0 -2
- package/dist/esm/api/resources/orders/resources/expandedList/client/index.mjs +0 -1
- package/dist/esm/api/resources/orders/resources/expandedList/client/requests/ExpandedListPostOrderCreatorExpandedListV1Request.d.mts +0 -30
- package/dist/esm/api/resources/orders/resources/expandedList/client/requests/ExpandedListPostShipperExpandedListV1Request.d.mts +0 -28
- package/dist/esm/api/resources/orders/resources/expandedList/client/requests/index.d.mts +0 -2
- package/dist/esm/api/resources/orders/resources/expandedList/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/orders/resources/expandedList/index.d.mts +0 -1
- package/dist/esm/api/resources/orders/resources/expandedList/index.mjs +0 -1
- package/dist/esm/api/resources/orders/resources/index.d.mts +0 -3
- package/dist/esm/api/resources/orders/resources/index.mjs +0 -3
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.d.mts +0 -76
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.mjs +0 -226
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/index.d.mts +0 -2
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/index.mjs +0 -1
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/TaskGroupExpandedForShipperReq.d.mts +0 -20
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/taskGroups/resources/expanded/index.d.mts +0 -1
- package/dist/esm/api/resources/taskGroups/resources/expanded/index.mjs +0 -1
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/Client.d.mts +0 -90
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/Client.mjs +0 -289
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/index.d.mts +0 -2
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/index.mjs +0 -1
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierAdministratorV1Request.d.mts +0 -40
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierDriverV1Request.d.mts +0 -40
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/requests/index.d.mts +0 -2
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/taskGroups/resources/expandedList/index.d.mts +0 -1
- package/dist/esm/api/resources/taskGroups/resources/expandedList/index.mjs +0 -1
- package/dist/esm/api/resources/taskGroups/resources/index.d.mts +0 -4
- package/dist/esm/api/resources/taskGroups/resources/index.mjs +0 -4
- package/dist/esm/api/types/OrderExpandedForOrderCreator.d.mts +0 -16
- package/dist/esm/api/types/OrderExpandedForOrderCreatorReq.d.mts +0 -14
- package/dist/esm/api/types/OrderExpandedForShipper.d.mts +0 -16
- package/dist/esm/api/types/OrderExpandedForShipperReq.d.mts +0 -14
- package/dist/esm/api/types/OrderExpandedForShipperReq.mjs +0 -4
- package/dist/esm/api/types/OrderExpandedListSortFieldEnum.d.mts +0 -11
- package/dist/esm/api/types/OrderExpandedListSortFieldEnum.mjs +0 -7
- package/dist/esm/api/types/OrdersExpandedForOrderCreatorRes.d.mts +0 -11
- package/dist/esm/api/types/OrdersExpandedForOrderCreatorRes.mjs +0 -4
- package/dist/esm/api/types/OrdersExpandedForShipperRes.d.mts +0 -11
- package/dist/esm/api/types/OrdersExpandedForShipperRes.mjs +0 -4
- package/dist/esm/api/types/SortOrderEnum.d.mts +0 -11
- package/dist/esm/api/types/SortOrderEnum.mjs +0 -7
- package/dist/esm/api/types/TaskGroupExpandedForCourierAdministrator.d.mts +0 -18
- package/dist/esm/api/types/TaskGroupExpandedForCourierAdministrator.mjs +0 -4
- package/dist/esm/api/types/TaskGroupExpandedForCourierAdministratorReq.d.mts +0 -19
- package/dist/esm/api/types/TaskGroupExpandedForCourierAdministratorReq.mjs +0 -4
- package/dist/esm/api/types/TaskGroupExpandedForCourierDriver.d.mts +0 -18
- package/dist/esm/api/types/TaskGroupExpandedForCourierDriver.mjs +0 -4
- package/dist/esm/api/types/TaskGroupExpandedForCourierDriverReq.d.mts +0 -19
- package/dist/esm/api/types/TaskGroupExpandedForCourierDriverReq.mjs +0 -4
- package/dist/esm/api/types/TaskGroupExpandedForShipper.d.mts +0 -18
- package/dist/esm/api/types/TaskGroupExpandedForShipper.mjs +0 -4
- package/dist/esm/api/types/TaskGroupExpandedSortFieldEnum.d.mts +0 -12
- package/dist/esm/api/types/TaskGroupExpandedSortFieldEnum.mjs +0 -8
- package/dist/esm/api/types/TaskGroupsExpandedForCourierAdministratorRes.d.mts +0 -11
- package/dist/esm/api/types/TaskGroupsExpandedForCourierAdministratorRes.mjs +0 -4
- package/dist/esm/api/types/TaskGroupsExpandedForCourierDriverRes.d.mts +0 -11
- package/dist/esm/api/types/TaskGroupsExpandedForCourierDriverRes.mjs +0 -4
- /package/dist/cjs/api/resources/orders/{resources/expandedList/client/requests/ExpandedListPostOrderCreatorExpandedListV1Request.js → client/requests/OrdersExpandedListForForwarderReq.js} +0 -0
- /package/dist/cjs/api/resources/orders/{resources/expandedList/client/requests/ExpandedListPostShipperExpandedListV1Request.js → client/requests/OrdersExpandedListForShipperReq.js} +0 -0
- /package/dist/cjs/api/resources/orders/{resources/expanded/client → client/requests}/index.js +0 -0
- /package/dist/cjs/api/{resources/taskGroups/resources/expanded/client/requests/TaskGroupExpandedForShipperReq.js → types/OrderAndTaskGroupExpandedReq.js} +0 -0
- /package/dist/cjs/api/{resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierAdministratorV1Request.js → types/OrderExpanded.js} +0 -0
- /package/dist/cjs/api/{resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierDriverV1Request.js → types/OrdersExpandedListRes.js} +0 -0
- /package/dist/cjs/api/types/{OrderExpandedForOrderCreator.js → TaskGroupExpanded.js} +0 -0
- /package/dist/cjs/api/types/{OrderExpandedForOrderCreatorReq.js → TaskGroupExpandedListReq.js} +0 -0
- /package/dist/cjs/api/types/{OrderExpandedForShipper.js → TaskGroupExpandedListRes.js} +0 -0
- /package/dist/esm/api/resources/orders/{resources/expandedList/client/requests/ExpandedListPostOrderCreatorExpandedListV1Request.mjs → client/requests/OrdersExpandedListForForwarderReq.mjs} +0 -0
- /package/dist/esm/api/resources/orders/{resources/expandedList/client/requests/ExpandedListPostShipperExpandedListV1Request.mjs → client/requests/OrdersExpandedListForShipperReq.mjs} +0 -0
- /package/dist/esm/api/resources/orders/{resources/expanded/client → client/requests}/index.mjs +0 -0
- /package/dist/esm/api/{resources/taskGroups/resources/expanded/client/requests/TaskGroupExpandedForShipperReq.mjs → types/OrderAndTaskGroupExpandedReq.mjs} +0 -0
- /package/dist/esm/api/{resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierAdministratorV1Request.mjs → types/OrderExpanded.mjs} +0 -0
- /package/dist/esm/api/{resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierDriverV1Request.mjs → types/OrdersExpandedListRes.mjs} +0 -0
- /package/dist/esm/api/types/{OrderExpandedForOrderCreator.mjs → TaskGroupExpanded.mjs} +0 -0
- /package/dist/esm/api/types/{OrderExpandedForOrderCreatorReq.mjs → TaskGroupExpandedListReq.mjs} +0 -0
- /package/dist/esm/api/types/{OrderExpandedForShipper.mjs → TaskGroupExpandedListRes.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -5497,7 +5497,7 @@ await client.offChrtShipperOrg.updateByIdV1("id");
|
|
|
5497
5497
|
|
|
5498
5498
|
## Orders
|
|
5499
5499
|
|
|
5500
|
-
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">
|
|
5500
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">getExpandedForShipperOperatorsV1</a>(orderId) -> Chrt.OrderExpanded</code></summary>
|
|
5501
5501
|
<dl>
|
|
5502
5502
|
<dd>
|
|
5503
5503
|
|
|
@@ -5509,7 +5509,7 @@ await client.offChrtShipperOrg.updateByIdV1("id");
|
|
|
5509
5509
|
<dl>
|
|
5510
5510
|
<dd>
|
|
5511
5511
|
|
|
5512
|
-
|
|
5512
|
+
Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
|
|
5513
5513
|
|
|
5514
5514
|
</dd>
|
|
5515
5515
|
</dl>
|
|
@@ -5525,7 +5525,7 @@ Validates a draft order and stages all related entities in a transaction. | () -
|
|
|
5525
5525
|
<dd>
|
|
5526
5526
|
|
|
5527
5527
|
```typescript
|
|
5528
|
-
await client.orders.
|
|
5528
|
+
await client.orders.getExpandedForShipperOperatorsV1("order_id");
|
|
5529
5529
|
```
|
|
5530
5530
|
|
|
5531
5531
|
</dd>
|
|
@@ -5560,9 +5560,7 @@ await client.orders.stageV1("order_id");
|
|
|
5560
5560
|
</dl>
|
|
5561
5561
|
</details>
|
|
5562
5562
|
|
|
5563
|
-
|
|
5564
|
-
|
|
5565
|
-
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
5563
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">getExpandedForForwarderOperatorsV1</a>(orderId) -> Chrt.OrderExpanded</code></summary>
|
|
5566
5564
|
<dl>
|
|
5567
5565
|
<dd>
|
|
5568
5566
|
|
|
@@ -5574,7 +5572,7 @@ await client.orders.stageV1("order_id");
|
|
|
5574
5572
|
<dl>
|
|
5575
5573
|
<dd>
|
|
5576
5574
|
|
|
5577
|
-
|
|
5575
|
+
Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
|
|
5578
5576
|
|
|
5579
5577
|
</dd>
|
|
5580
5578
|
</dl>
|
|
@@ -5590,7 +5588,7 @@ Creates a new draft order with org assignments based on caller's organization ty
|
|
|
5590
5588
|
<dd>
|
|
5591
5589
|
|
|
5592
5590
|
```typescript
|
|
5593
|
-
await client.
|
|
5591
|
+
await client.orders.getExpandedForForwarderOperatorsV1("order_id");
|
|
5594
5592
|
```
|
|
5595
5593
|
|
|
5596
5594
|
</dd>
|
|
@@ -5606,7 +5604,7 @@ await client.orderDrafts.newV1();
|
|
|
5606
5604
|
<dl>
|
|
5607
5605
|
<dd>
|
|
5608
5606
|
|
|
5609
|
-
**
|
|
5607
|
+
**orderId:** `string`
|
|
5610
5608
|
|
|
5611
5609
|
</dd>
|
|
5612
5610
|
</dl>
|
|
@@ -5614,7 +5612,7 @@ await client.orderDrafts.newV1();
|
|
|
5614
5612
|
<dl>
|
|
5615
5613
|
<dd>
|
|
5616
5614
|
|
|
5617
|
-
**requestOptions:** `
|
|
5615
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
5618
5616
|
|
|
5619
5617
|
</dd>
|
|
5620
5618
|
</dl>
|
|
@@ -5625,7 +5623,7 @@ await client.orderDrafts.newV1();
|
|
|
5625
5623
|
</dl>
|
|
5626
5624
|
</details>
|
|
5627
5625
|
|
|
5628
|
-
<details><summary><code>client.
|
|
5626
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">postExpandedListForShipperOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
|
|
5629
5627
|
<dl>
|
|
5630
5628
|
<dd>
|
|
5631
5629
|
|
|
@@ -5637,7 +5635,7 @@ await client.orderDrafts.newV1();
|
|
|
5637
5635
|
<dl>
|
|
5638
5636
|
<dd>
|
|
5639
5637
|
|
|
5640
|
-
|
|
5638
|
+
Retrieves a list of expanded orders with optional filters and related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrdersExpandedListForShipperReq) -> (OrdersExpandedListRes)
|
|
5641
5639
|
|
|
5642
5640
|
</dd>
|
|
5643
5641
|
</dl>
|
|
@@ -5653,9 +5651,7 @@ Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDra
|
|
|
5653
5651
|
<dd>
|
|
5654
5652
|
|
|
5655
5653
|
```typescript
|
|
5656
|
-
await client.
|
|
5657
|
-
order_id: "order_id",
|
|
5658
|
-
});
|
|
5654
|
+
await client.orders.postExpandedListForShipperOperatorsV1();
|
|
5659
5655
|
```
|
|
5660
5656
|
|
|
5661
5657
|
</dd>
|
|
@@ -5671,7 +5667,7 @@ await client.orderDrafts.updateV1({
|
|
|
5671
5667
|
<dl>
|
|
5672
5668
|
<dd>
|
|
5673
5669
|
|
|
5674
|
-
**request:** `Chrt.
|
|
5670
|
+
**request:** `Chrt.OrdersExpandedListForShipperReq`
|
|
5675
5671
|
|
|
5676
5672
|
</dd>
|
|
5677
5673
|
</dl>
|
|
@@ -5679,7 +5675,7 @@ await client.orderDrafts.updateV1({
|
|
|
5679
5675
|
<dl>
|
|
5680
5676
|
<dd>
|
|
5681
5677
|
|
|
5682
|
-
**requestOptions:** `
|
|
5678
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
5683
5679
|
|
|
5684
5680
|
</dd>
|
|
5685
5681
|
</dl>
|
|
@@ -5690,7 +5686,7 @@ await client.orderDrafts.updateV1({
|
|
|
5690
5686
|
</dl>
|
|
5691
5687
|
</details>
|
|
5692
5688
|
|
|
5693
|
-
<details><summary><code>client.
|
|
5689
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">postExpandedListForForwarderOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
|
|
5694
5690
|
<dl>
|
|
5695
5691
|
<dd>
|
|
5696
5692
|
|
|
@@ -5702,7 +5698,7 @@ await client.orderDrafts.updateV1({
|
|
|
5702
5698
|
<dl>
|
|
5703
5699
|
<dd>
|
|
5704
5700
|
|
|
5705
|
-
|
|
5701
|
+
Retrieves a list of expanded orders with optional filters and related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrdersExpandedListForForwarderReq) -> (OrdersExpandedListRes)
|
|
5706
5702
|
|
|
5707
5703
|
</dd>
|
|
5708
5704
|
</dl>
|
|
@@ -5718,7 +5714,7 @@ Deletes a draft order and all associated entities. | () -> (bool)
|
|
|
5718
5714
|
<dd>
|
|
5719
5715
|
|
|
5720
5716
|
```typescript
|
|
5721
|
-
await client.
|
|
5717
|
+
await client.orders.postExpandedListForForwarderOperatorsV1();
|
|
5722
5718
|
```
|
|
5723
5719
|
|
|
5724
5720
|
</dd>
|
|
@@ -5734,7 +5730,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5734
5730
|
<dl>
|
|
5735
5731
|
<dd>
|
|
5736
5732
|
|
|
5737
|
-
**
|
|
5733
|
+
**request:** `Chrt.OrdersExpandedListForForwarderReq`
|
|
5738
5734
|
|
|
5739
5735
|
</dd>
|
|
5740
5736
|
</dl>
|
|
@@ -5742,7 +5738,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5742
5738
|
<dl>
|
|
5743
5739
|
<dd>
|
|
5744
5740
|
|
|
5745
|
-
**requestOptions:** `
|
|
5741
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
5746
5742
|
|
|
5747
5743
|
</dd>
|
|
5748
5744
|
</dl>
|
|
@@ -5753,7 +5749,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5753
5749
|
</dl>
|
|
5754
5750
|
</details>
|
|
5755
5751
|
|
|
5756
|
-
<details><summary><code>client.
|
|
5752
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
5757
5753
|
<dl>
|
|
5758
5754
|
<dd>
|
|
5759
5755
|
|
|
@@ -5765,7 +5761,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5765
5761
|
<dl>
|
|
5766
5762
|
<dd>
|
|
5767
5763
|
|
|
5768
|
-
|
|
5764
|
+
Validates a draft order and stages all related entities in a transaction. | () -> (bool)
|
|
5769
5765
|
|
|
5770
5766
|
</dd>
|
|
5771
5767
|
</dl>
|
|
@@ -5781,7 +5777,7 @@ Fetches a single draft order with optional expanded related data. Only the creat
|
|
|
5781
5777
|
<dd>
|
|
5782
5778
|
|
|
5783
5779
|
```typescript
|
|
5784
|
-
await client.
|
|
5780
|
+
await client.orders.stageV1("order_id");
|
|
5785
5781
|
```
|
|
5786
5782
|
|
|
5787
5783
|
</dd>
|
|
@@ -5797,15 +5793,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id");
|
|
|
5797
5793
|
<dl>
|
|
5798
5794
|
<dd>
|
|
5799
5795
|
|
|
5800
|
-
**
|
|
5801
|
-
|
|
5802
|
-
</dd>
|
|
5803
|
-
</dl>
|
|
5804
|
-
|
|
5805
|
-
<dl>
|
|
5806
|
-
<dd>
|
|
5807
|
-
|
|
5808
|
-
**request:** `Chrt.OrderDraftExpandedReq`
|
|
5796
|
+
**orderId:** `string`
|
|
5809
5797
|
|
|
5810
5798
|
</dd>
|
|
5811
5799
|
</dl>
|
|
@@ -5813,7 +5801,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id");
|
|
|
5813
5801
|
<dl>
|
|
5814
5802
|
<dd>
|
|
5815
5803
|
|
|
5816
|
-
**requestOptions:** `
|
|
5804
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
5817
5805
|
|
|
5818
5806
|
</dd>
|
|
5819
5807
|
</dl>
|
|
@@ -5824,7 +5812,9 @@ await client.orderDrafts.expandedV1("order_id_or_short_id");
|
|
|
5824
5812
|
</dl>
|
|
5825
5813
|
</details>
|
|
5826
5814
|
|
|
5827
|
-
|
|
5815
|
+
## OrderDrafts
|
|
5816
|
+
|
|
5817
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
5828
5818
|
<dl>
|
|
5829
5819
|
<dd>
|
|
5830
5820
|
|
|
@@ -5836,7 +5826,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id");
|
|
|
5836
5826
|
<dl>
|
|
5837
5827
|
<dd>
|
|
5838
5828
|
|
|
5839
|
-
|
|
5829
|
+
Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
5840
5830
|
|
|
5841
5831
|
</dd>
|
|
5842
5832
|
</dl>
|
|
@@ -5852,7 +5842,7 @@ Lists all draft orders created by the authenticated user with optional expanded
|
|
|
5852
5842
|
<dd>
|
|
5853
5843
|
|
|
5854
5844
|
```typescript
|
|
5855
|
-
await client.orderDrafts.
|
|
5845
|
+
await client.orderDrafts.newV1();
|
|
5856
5846
|
```
|
|
5857
5847
|
|
|
5858
5848
|
</dd>
|
|
@@ -5868,7 +5858,7 @@ await client.orderDrafts.expandedListV1();
|
|
|
5868
5858
|
<dl>
|
|
5869
5859
|
<dd>
|
|
5870
5860
|
|
|
5871
|
-
**request:** `Chrt.
|
|
5861
|
+
**request:** `Chrt.OrdersNewDraftReq`
|
|
5872
5862
|
|
|
5873
5863
|
</dd>
|
|
5874
5864
|
</dl>
|
|
@@ -5887,7 +5877,7 @@ await client.orderDrafts.expandedListV1();
|
|
|
5887
5877
|
</dl>
|
|
5888
5878
|
</details>
|
|
5889
5879
|
|
|
5890
|
-
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">
|
|
5880
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
|
|
5891
5881
|
<dl>
|
|
5892
5882
|
<dd>
|
|
5893
5883
|
|
|
@@ -5899,7 +5889,7 @@ await client.orderDrafts.expandedListV1();
|
|
|
5899
5889
|
<dl>
|
|
5900
5890
|
<dd>
|
|
5901
5891
|
|
|
5902
|
-
|
|
5892
|
+
Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
5903
5893
|
|
|
5904
5894
|
</dd>
|
|
5905
5895
|
</dl>
|
|
@@ -5915,7 +5905,9 @@ Checks whether the draft order satisfies all requirements to move into staging.
|
|
|
5915
5905
|
<dd>
|
|
5916
5906
|
|
|
5917
5907
|
```typescript
|
|
5918
|
-
await client.orderDrafts.
|
|
5908
|
+
await client.orderDrafts.updateV1({
|
|
5909
|
+
order_id: "order_id",
|
|
5910
|
+
});
|
|
5919
5911
|
```
|
|
5920
5912
|
|
|
5921
5913
|
</dd>
|
|
@@ -5931,7 +5923,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5931
5923
|
<dl>
|
|
5932
5924
|
<dd>
|
|
5933
5925
|
|
|
5934
|
-
**
|
|
5926
|
+
**request:** `Chrt.OrdersDraftUpdateReq`
|
|
5935
5927
|
|
|
5936
5928
|
</dd>
|
|
5937
5929
|
</dl>
|
|
@@ -5950,9 +5942,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5950
5942
|
</dl>
|
|
5951
5943
|
</details>
|
|
5952
5944
|
|
|
5953
|
-
|
|
5954
|
-
|
|
5955
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
5945
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
|
|
5956
5946
|
<dl>
|
|
5957
5947
|
<dd>
|
|
5958
5948
|
|
|
@@ -5964,7 +5954,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5964
5954
|
<dl>
|
|
5965
5955
|
<dd>
|
|
5966
5956
|
|
|
5967
|
-
|
|
5957
|
+
Deletes a draft order and all associated entities. | () -> (bool)
|
|
5968
5958
|
|
|
5969
5959
|
</dd>
|
|
5970
5960
|
</dl>
|
|
@@ -5980,9 +5970,7 @@ Updates the ordering of tasks in a task group. Task group must be in STAGED or I
|
|
|
5980
5970
|
<dd>
|
|
5981
5971
|
|
|
5982
5972
|
```typescript
|
|
5983
|
-
await client.
|
|
5984
|
-
task_ordering: ["task_ordering"],
|
|
5985
|
-
});
|
|
5973
|
+
await client.orderDrafts.deleteV1("order_id");
|
|
5986
5974
|
```
|
|
5987
5975
|
|
|
5988
5976
|
</dd>
|
|
@@ -5998,15 +5986,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
5998
5986
|
<dl>
|
|
5999
5987
|
<dd>
|
|
6000
5988
|
|
|
6001
|
-
**
|
|
6002
|
-
|
|
6003
|
-
</dd>
|
|
6004
|
-
</dl>
|
|
6005
|
-
|
|
6006
|
-
<dl>
|
|
6007
|
-
<dd>
|
|
6008
|
-
|
|
6009
|
-
**request:** `Chrt.SetTaskOrderingReq`
|
|
5989
|
+
**orderId:** `string`
|
|
6010
5990
|
|
|
6011
5991
|
</dd>
|
|
6012
5992
|
</dl>
|
|
@@ -6014,7 +5994,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6014
5994
|
<dl>
|
|
6015
5995
|
<dd>
|
|
6016
5996
|
|
|
6017
|
-
**requestOptions:** `
|
|
5997
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
6018
5998
|
|
|
6019
5999
|
</dd>
|
|
6020
6000
|
</dl>
|
|
@@ -6025,7 +6005,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6025
6005
|
</dl>
|
|
6026
6006
|
</details>
|
|
6027
6007
|
|
|
6028
|
-
<details><summary><code>client.
|
|
6008
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">expandedV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderDraftExpandedRes</code></summary>
|
|
6029
6009
|
<dl>
|
|
6030
6010
|
<dd>
|
|
6031
6011
|
|
|
@@ -6037,7 +6017,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6037
6017
|
<dl>
|
|
6038
6018
|
<dd>
|
|
6039
6019
|
|
|
6040
|
-
|
|
6020
|
+
Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderDraftExpandedReq) -> (OrderDraftExpandedRes)
|
|
6041
6021
|
|
|
6042
6022
|
</dd>
|
|
6043
6023
|
</dl>
|
|
@@ -6053,9 +6033,7 @@ Updates the flight number on both task group and all its tasks. Task group must
|
|
|
6053
6033
|
<dd>
|
|
6054
6034
|
|
|
6055
6035
|
```typescript
|
|
6056
|
-
await client.
|
|
6057
|
-
flight_number: "flight_number",
|
|
6058
|
-
});
|
|
6036
|
+
await client.orderDrafts.expandedV1("order_id_or_short_id");
|
|
6059
6037
|
```
|
|
6060
6038
|
|
|
6061
6039
|
</dd>
|
|
@@ -6071,7 +6049,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6071
6049
|
<dl>
|
|
6072
6050
|
<dd>
|
|
6073
6051
|
|
|
6074
|
-
**
|
|
6052
|
+
**orderIdOrShortId:** `string`
|
|
6075
6053
|
|
|
6076
6054
|
</dd>
|
|
6077
6055
|
</dl>
|
|
@@ -6079,7 +6057,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6079
6057
|
<dl>
|
|
6080
6058
|
<dd>
|
|
6081
6059
|
|
|
6082
|
-
**request:** `Chrt.
|
|
6060
|
+
**request:** `Chrt.OrderDraftExpandedReq`
|
|
6083
6061
|
|
|
6084
6062
|
</dd>
|
|
6085
6063
|
</dl>
|
|
@@ -6087,7 +6065,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6087
6065
|
<dl>
|
|
6088
6066
|
<dd>
|
|
6089
6067
|
|
|
6090
|
-
**requestOptions:** `
|
|
6068
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
6091
6069
|
|
|
6092
6070
|
</dd>
|
|
6093
6071
|
</dl>
|
|
@@ -6098,7 +6076,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6098
6076
|
</dl>
|
|
6099
6077
|
</details>
|
|
6100
6078
|
|
|
6101
|
-
<details><summary><code>client.
|
|
6079
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">expandedListV1</a>({ ...params }) -> Chrt.OrderDraftExpandedListRes</code></summary>
|
|
6102
6080
|
<dl>
|
|
6103
6081
|
<dd>
|
|
6104
6082
|
|
|
@@ -6110,7 +6088,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6110
6088
|
<dl>
|
|
6111
6089
|
<dd>
|
|
6112
6090
|
|
|
6113
|
-
|
|
6091
|
+
Lists all draft orders created by the authenticated user with optional expanded related data. | (OrderDraftExpandedListReq) -> (OrderDraftExpandedListRes)
|
|
6114
6092
|
|
|
6115
6093
|
</dd>
|
|
6116
6094
|
</dl>
|
|
@@ -6126,7 +6104,7 @@ Sets or removes the driver assigned to a task group. | authz_personas=[courier_o
|
|
|
6126
6104
|
<dd>
|
|
6127
6105
|
|
|
6128
6106
|
```typescript
|
|
6129
|
-
await client.
|
|
6107
|
+
await client.orderDrafts.expandedListV1();
|
|
6130
6108
|
```
|
|
6131
6109
|
|
|
6132
6110
|
</dd>
|
|
@@ -6142,15 +6120,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6142
6120
|
<dl>
|
|
6143
6121
|
<dd>
|
|
6144
6122
|
|
|
6145
|
-
**
|
|
6146
|
-
|
|
6147
|
-
</dd>
|
|
6148
|
-
</dl>
|
|
6149
|
-
|
|
6150
|
-
<dl>
|
|
6151
|
-
<dd>
|
|
6152
|
-
|
|
6153
|
-
**request:** `Chrt.UpdateTaskGroupDriverReq`
|
|
6123
|
+
**request:** `Chrt.OrderDraftExpandedListReq`
|
|
6154
6124
|
|
|
6155
6125
|
</dd>
|
|
6156
6126
|
</dl>
|
|
@@ -6158,7 +6128,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6158
6128
|
<dl>
|
|
6159
6129
|
<dd>
|
|
6160
6130
|
|
|
6161
|
-
**requestOptions:** `
|
|
6131
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
6162
6132
|
|
|
6163
6133
|
</dd>
|
|
6164
6134
|
</dl>
|
|
@@ -6169,7 +6139,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6169
6139
|
</dl>
|
|
6170
6140
|
</details>
|
|
6171
6141
|
|
|
6172
|
-
<details><summary><code>client.
|
|
6142
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> boolean</code></summary>
|
|
6173
6143
|
<dl>
|
|
6174
6144
|
<dd>
|
|
6175
6145
|
|
|
@@ -6181,7 +6151,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6181
6151
|
<dl>
|
|
6182
6152
|
<dd>
|
|
6183
6153
|
|
|
6184
|
-
|
|
6154
|
+
Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
|
|
6185
6155
|
|
|
6186
6156
|
</dd>
|
|
6187
6157
|
</dl>
|
|
@@ -6197,7 +6167,7 @@ Sets or removes the courier organization assigned to a task group. | authz_perso
|
|
|
6197
6167
|
<dd>
|
|
6198
6168
|
|
|
6199
6169
|
```typescript
|
|
6200
|
-
await client.
|
|
6170
|
+
await client.orderDrafts.validateV1("order_id");
|
|
6201
6171
|
```
|
|
6202
6172
|
|
|
6203
6173
|
</dd>
|
|
@@ -6213,15 +6183,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6213
6183
|
<dl>
|
|
6214
6184
|
<dd>
|
|
6215
6185
|
|
|
6216
|
-
**
|
|
6217
|
-
|
|
6218
|
-
</dd>
|
|
6219
|
-
</dl>
|
|
6220
|
-
|
|
6221
|
-
<dl>
|
|
6222
|
-
<dd>
|
|
6223
|
-
|
|
6224
|
-
**request:** `Chrt.UpdateTaskGroupCourierOrgReq`
|
|
6186
|
+
**orderId:** `string`
|
|
6225
6187
|
|
|
6226
6188
|
</dd>
|
|
6227
6189
|
</dl>
|
|
@@ -6229,7 +6191,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6229
6191
|
<dl>
|
|
6230
6192
|
<dd>
|
|
6231
6193
|
|
|
6232
|
-
**requestOptions:** `
|
|
6194
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
6233
6195
|
|
|
6234
6196
|
</dd>
|
|
6235
6197
|
</dl>
|
|
@@ -6240,7 +6202,9 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6240
6202
|
</dl>
|
|
6241
6203
|
</details>
|
|
6242
6204
|
|
|
6243
|
-
|
|
6205
|
+
## TaskGroups
|
|
6206
|
+
|
|
6207
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getExpandedForCourierOperatorsV1</a>(taskGroupId) -> Chrt.TaskGroupExpanded</code></summary>
|
|
6244
6208
|
<dl>
|
|
6245
6209
|
<dd>
|
|
6246
6210
|
|
|
@@ -6252,7 +6216,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
6252
6216
|
<dl>
|
|
6253
6217
|
<dd>
|
|
6254
6218
|
|
|
6255
|
-
|
|
6219
|
+
Retrieves an expanded task group with optional related data for courier operators. | authz_personas=[courier_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
6256
6220
|
|
|
6257
6221
|
</dd>
|
|
6258
6222
|
</dl>
|
|
@@ -6268,7 +6232,7 @@ Starts a task group by changing its status to in-progress and updating the order
|
|
|
6268
6232
|
<dd>
|
|
6269
6233
|
|
|
6270
6234
|
```typescript
|
|
6271
|
-
await client.taskGroups.
|
|
6235
|
+
await client.taskGroups.getExpandedForCourierOperatorsV1("task_group_id");
|
|
6272
6236
|
```
|
|
6273
6237
|
|
|
6274
6238
|
</dd>
|
|
@@ -6303,9 +6267,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6303
6267
|
</dl>
|
|
6304
6268
|
</details>
|
|
6305
6269
|
|
|
6306
|
-
|
|
6307
|
-
|
|
6308
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByJwtUserIdV1</a>() -> Chrt.ShipperContact1</code></summary>
|
|
6270
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getExpandedForCourierOperatorsByOrderV1</a>(orderIdOrShortId) -> Chrt.TaskGroupExpanded[]</code></summary>
|
|
6309
6271
|
<dl>
|
|
6310
6272
|
<dd>
|
|
6311
6273
|
|
|
@@ -6317,7 +6279,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6317
6279
|
<dl>
|
|
6318
6280
|
<dd>
|
|
6319
6281
|
|
|
6320
|
-
Retrieves
|
|
6282
|
+
Retrieves expanded task groups by order ID or short ID for courier operators. | authz_personas=[courier_org_operators] | (OrderAndTaskGroupExpandedReq) -> (list[TaskGroupExpanded])
|
|
6321
6283
|
|
|
6322
6284
|
</dd>
|
|
6323
6285
|
</dl>
|
|
@@ -6333,7 +6295,7 @@ Retrieves the authenticated user's own shipper contact information. | () -> (Shi
|
|
|
6333
6295
|
<dd>
|
|
6334
6296
|
|
|
6335
6297
|
```typescript
|
|
6336
|
-
await client.
|
|
6298
|
+
await client.taskGroups.getExpandedForCourierOperatorsByOrderV1("order_id_or_short_id");
|
|
6337
6299
|
```
|
|
6338
6300
|
|
|
6339
6301
|
</dd>
|
|
@@ -6349,7 +6311,15 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
6349
6311
|
<dl>
|
|
6350
6312
|
<dd>
|
|
6351
6313
|
|
|
6352
|
-
**
|
|
6314
|
+
**orderIdOrShortId:** `string`
|
|
6315
|
+
|
|
6316
|
+
</dd>
|
|
6317
|
+
</dl>
|
|
6318
|
+
|
|
6319
|
+
<dl>
|
|
6320
|
+
<dd>
|
|
6321
|
+
|
|
6322
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6353
6323
|
|
|
6354
6324
|
</dd>
|
|
6355
6325
|
</dl>
|
|
@@ -6360,7 +6330,7 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
6360
6330
|
</dl>
|
|
6361
6331
|
</details>
|
|
6362
6332
|
|
|
6363
|
-
<details><summary><code>client.
|
|
6333
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getExpandedForCourierDriverV1</a>(taskGroupId) -> Chrt.TaskGroupExpanded</code></summary>
|
|
6364
6334
|
<dl>
|
|
6365
6335
|
<dd>
|
|
6366
6336
|
|
|
@@ -6372,7 +6342,7 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
6372
6342
|
<dl>
|
|
6373
6343
|
<dd>
|
|
6374
6344
|
|
|
6375
|
-
|
|
6345
|
+
Retrieves an expanded task group with optional related data for courier drivers. | authz_personas=[courier_driver] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
6376
6346
|
|
|
6377
6347
|
</dd>
|
|
6378
6348
|
</dl>
|
|
@@ -6388,7 +6358,7 @@ Lists all shipper contacts created by the authenticated organization. | () -> (l
|
|
|
6388
6358
|
<dd>
|
|
6389
6359
|
|
|
6390
6360
|
```typescript
|
|
6391
|
-
await client.
|
|
6361
|
+
await client.taskGroups.getExpandedForCourierDriverV1("task_group_id");
|
|
6392
6362
|
```
|
|
6393
6363
|
|
|
6394
6364
|
</dd>
|
|
@@ -6404,7 +6374,15 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
6404
6374
|
<dl>
|
|
6405
6375
|
<dd>
|
|
6406
6376
|
|
|
6407
|
-
**
|
|
6377
|
+
**taskGroupId:** `string`
|
|
6378
|
+
|
|
6379
|
+
</dd>
|
|
6380
|
+
</dl>
|
|
6381
|
+
|
|
6382
|
+
<dl>
|
|
6383
|
+
<dd>
|
|
6384
|
+
|
|
6385
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6408
6386
|
|
|
6409
6387
|
</dd>
|
|
6410
6388
|
</dl>
|
|
@@ -6415,7 +6393,7 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
6415
6393
|
</dl>
|
|
6416
6394
|
</details>
|
|
6417
6395
|
|
|
6418
|
-
<details><summary><code>client.
|
|
6396
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getExpandedForCourierDriverByOrderV1</a>(orderIdOrShortId) -> Chrt.TaskGroupExpanded[]</code></summary>
|
|
6419
6397
|
<dl>
|
|
6420
6398
|
<dd>
|
|
6421
6399
|
|
|
@@ -6427,7 +6405,7 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
6427
6405
|
<dl>
|
|
6428
6406
|
<dd>
|
|
6429
6407
|
|
|
6430
|
-
|
|
6408
|
+
Retrieves expanded task groups by order ID or short ID for courier drivers. | authz_personas=[courier_driver] | (OrderAndTaskGroupExpandedReq) -> (list[TaskGroupExpanded])
|
|
6431
6409
|
|
|
6432
6410
|
</dd>
|
|
6433
6411
|
</dl>
|
|
@@ -6443,7 +6421,7 @@ Lists all shipper contacts accessible to the courier organization for a specific
|
|
|
6443
6421
|
<dd>
|
|
6444
6422
|
|
|
6445
6423
|
```typescript
|
|
6446
|
-
await client.
|
|
6424
|
+
await client.taskGroups.getExpandedForCourierDriverByOrderV1("order_id_or_short_id");
|
|
6447
6425
|
```
|
|
6448
6426
|
|
|
6449
6427
|
</dd>
|
|
@@ -6459,7 +6437,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
6459
6437
|
<dl>
|
|
6460
6438
|
<dd>
|
|
6461
6439
|
|
|
6462
|
-
**
|
|
6440
|
+
**orderIdOrShortId:** `string`
|
|
6463
6441
|
|
|
6464
6442
|
</dd>
|
|
6465
6443
|
</dl>
|
|
@@ -6467,7 +6445,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
6467
6445
|
<dl>
|
|
6468
6446
|
<dd>
|
|
6469
6447
|
|
|
6470
|
-
**requestOptions:** `
|
|
6448
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6471
6449
|
|
|
6472
6450
|
</dd>
|
|
6473
6451
|
</dl>
|
|
@@ -6478,7 +6456,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
6478
6456
|
</dl>
|
|
6479
6457
|
</details>
|
|
6480
6458
|
|
|
6481
|
-
<details><summary><code>client.
|
|
6459
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getExpandedForShipperOperatorsV1</a>(taskGroupId) -> Chrt.TaskGroupExpanded</code></summary>
|
|
6482
6460
|
<dl>
|
|
6483
6461
|
<dd>
|
|
6484
6462
|
|
|
@@ -6490,7 +6468,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
6490
6468
|
<dl>
|
|
6491
6469
|
<dd>
|
|
6492
6470
|
|
|
6493
|
-
|
|
6471
|
+
Retrieves an expanded task group with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
6494
6472
|
|
|
6495
6473
|
</dd>
|
|
6496
6474
|
</dl>
|
|
@@ -6506,7 +6484,7 @@ Lists all shipper contacts for a specific off-platform shipper connection. | ()
|
|
|
6506
6484
|
<dd>
|
|
6507
6485
|
|
|
6508
6486
|
```typescript
|
|
6509
|
-
await client.
|
|
6487
|
+
await client.taskGroups.getExpandedForShipperOperatorsV1("task_group_id");
|
|
6510
6488
|
```
|
|
6511
6489
|
|
|
6512
6490
|
</dd>
|
|
@@ -6522,7 +6500,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
6522
6500
|
<dl>
|
|
6523
6501
|
<dd>
|
|
6524
6502
|
|
|
6525
|
-
**
|
|
6503
|
+
**taskGroupId:** `string`
|
|
6526
6504
|
|
|
6527
6505
|
</dd>
|
|
6528
6506
|
</dl>
|
|
@@ -6530,7 +6508,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
6530
6508
|
<dl>
|
|
6531
6509
|
<dd>
|
|
6532
6510
|
|
|
6533
|
-
**requestOptions:** `
|
|
6511
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6534
6512
|
|
|
6535
6513
|
</dd>
|
|
6536
6514
|
</dl>
|
|
@@ -6541,7 +6519,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
6541
6519
|
</dl>
|
|
6542
6520
|
</details>
|
|
6543
6521
|
|
|
6544
|
-
<details><summary><code>client.
|
|
6522
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getExpandedForForwarderOperatorsV1</a>(taskGroupId) -> Chrt.TaskGroupExpanded</code></summary>
|
|
6545
6523
|
<dl>
|
|
6546
6524
|
<dd>
|
|
6547
6525
|
|
|
@@ -6553,7 +6531,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
6553
6531
|
<dl>
|
|
6554
6532
|
<dd>
|
|
6555
6533
|
|
|
6556
|
-
Retrieves
|
|
6534
|
+
Retrieves an expanded task group with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
6557
6535
|
|
|
6558
6536
|
</dd>
|
|
6559
6537
|
</dl>
|
|
@@ -6569,7 +6547,7 @@ Retrieves a specific shipper contact by ID if authorized to access it. | () -> (
|
|
|
6569
6547
|
<dd>
|
|
6570
6548
|
|
|
6571
6549
|
```typescript
|
|
6572
|
-
await client.
|
|
6550
|
+
await client.taskGroups.getExpandedForForwarderOperatorsV1("task_group_id");
|
|
6573
6551
|
```
|
|
6574
6552
|
|
|
6575
6553
|
</dd>
|
|
@@ -6585,7 +6563,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
6585
6563
|
<dl>
|
|
6586
6564
|
<dd>
|
|
6587
6565
|
|
|
6588
|
-
**
|
|
6566
|
+
**taskGroupId:** `string`
|
|
6589
6567
|
|
|
6590
6568
|
</dd>
|
|
6591
6569
|
</dl>
|
|
@@ -6593,7 +6571,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
6593
6571
|
<dl>
|
|
6594
6572
|
<dd>
|
|
6595
6573
|
|
|
6596
|
-
**requestOptions:** `
|
|
6574
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6597
6575
|
|
|
6598
6576
|
</dd>
|
|
6599
6577
|
</dl>
|
|
@@ -6604,7 +6582,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
6604
6582
|
</dl>
|
|
6605
6583
|
</details>
|
|
6606
6584
|
|
|
6607
|
-
<details><summary><code>client.
|
|
6585
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForCourierOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
6608
6586
|
<dl>
|
|
6609
6587
|
<dd>
|
|
6610
6588
|
|
|
@@ -6616,7 +6594,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
6616
6594
|
<dl>
|
|
6617
6595
|
<dd>
|
|
6618
6596
|
|
|
6619
|
-
|
|
6597
|
+
Retrieves a list of expanded task groups with optional filters and related data for courier operators. | authz_personas=[courier_org_operators] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
|
|
6620
6598
|
|
|
6621
6599
|
</dd>
|
|
6622
6600
|
</dl>
|
|
@@ -6632,9 +6610,7 @@ Creates contact information for an on-platform shipper organization or user. | (
|
|
|
6632
6610
|
<dd>
|
|
6633
6611
|
|
|
6634
6612
|
```typescript
|
|
6635
|
-
await client.
|
|
6636
|
-
schema_version: 1,
|
|
6637
|
-
});
|
|
6613
|
+
await client.taskGroups.postExpandedListForCourierOperatorsV1({});
|
|
6638
6614
|
```
|
|
6639
6615
|
|
|
6640
6616
|
</dd>
|
|
@@ -6650,7 +6626,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
6650
6626
|
<dl>
|
|
6651
6627
|
<dd>
|
|
6652
6628
|
|
|
6653
|
-
**request:** `Chrt.
|
|
6629
|
+
**request:** `Chrt.TaskGroupExpandedListReq`
|
|
6654
6630
|
|
|
6655
6631
|
</dd>
|
|
6656
6632
|
</dl>
|
|
@@ -6658,7 +6634,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
6658
6634
|
<dl>
|
|
6659
6635
|
<dd>
|
|
6660
6636
|
|
|
6661
|
-
**requestOptions:** `
|
|
6637
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6662
6638
|
|
|
6663
6639
|
</dd>
|
|
6664
6640
|
</dl>
|
|
@@ -6669,7 +6645,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
6669
6645
|
</dl>
|
|
6670
6646
|
</details>
|
|
6671
6647
|
|
|
6672
|
-
<details><summary><code>client.
|
|
6648
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForCourierDriverV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
6673
6649
|
<dl>
|
|
6674
6650
|
<dd>
|
|
6675
6651
|
|
|
@@ -6681,7 +6657,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
6681
6657
|
<dl>
|
|
6682
6658
|
<dd>
|
|
6683
6659
|
|
|
6684
|
-
|
|
6660
|
+
Retrieves a list of expanded task groups with optional filters and related data for courier drivers. | authz_personas=[courier_driver] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
|
|
6685
6661
|
|
|
6686
6662
|
</dd>
|
|
6687
6663
|
</dl>
|
|
@@ -6697,9 +6673,7 @@ Creates contact information for an off-platform shipper using connection info. |
|
|
|
6697
6673
|
<dd>
|
|
6698
6674
|
|
|
6699
6675
|
```typescript
|
|
6700
|
-
await client.
|
|
6701
|
-
schema_version: 1,
|
|
6702
|
-
});
|
|
6676
|
+
await client.taskGroups.postExpandedListForCourierDriverV1({});
|
|
6703
6677
|
```
|
|
6704
6678
|
|
|
6705
6679
|
</dd>
|
|
@@ -6715,7 +6689,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
6715
6689
|
<dl>
|
|
6716
6690
|
<dd>
|
|
6717
6691
|
|
|
6718
|
-
**request:** `Chrt.
|
|
6692
|
+
**request:** `Chrt.TaskGroupExpandedListReq`
|
|
6719
6693
|
|
|
6720
6694
|
</dd>
|
|
6721
6695
|
</dl>
|
|
@@ -6723,7 +6697,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
6723
6697
|
<dl>
|
|
6724
6698
|
<dd>
|
|
6725
6699
|
|
|
6726
|
-
**requestOptions:** `
|
|
6700
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6727
6701
|
|
|
6728
6702
|
</dd>
|
|
6729
6703
|
</dl>
|
|
@@ -6734,7 +6708,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
6734
6708
|
</dl>
|
|
6735
6709
|
</details>
|
|
6736
6710
|
|
|
6737
|
-
<details><summary><code>client.
|
|
6711
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForForwarderOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
6738
6712
|
<dl>
|
|
6739
6713
|
<dd>
|
|
6740
6714
|
|
|
@@ -6746,7 +6720,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
6746
6720
|
<dl>
|
|
6747
6721
|
<dd>
|
|
6748
6722
|
|
|
6749
|
-
|
|
6723
|
+
Retrieves a list of expanded task groups with optional filters and related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
|
|
6750
6724
|
|
|
6751
6725
|
</dd>
|
|
6752
6726
|
</dl>
|
|
@@ -6762,7 +6736,7 @@ Updates existing shipper contact information owned by the authenticated organiza
|
|
|
6762
6736
|
<dd>
|
|
6763
6737
|
|
|
6764
6738
|
```typescript
|
|
6765
|
-
await client.
|
|
6739
|
+
await client.taskGroups.postExpandedListForForwarderOperatorsV1({});
|
|
6766
6740
|
```
|
|
6767
6741
|
|
|
6768
6742
|
</dd>
|
|
@@ -6778,15 +6752,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
6778
6752
|
<dl>
|
|
6779
6753
|
<dd>
|
|
6780
6754
|
|
|
6781
|
-
**
|
|
6782
|
-
|
|
6783
|
-
</dd>
|
|
6784
|
-
</dl>
|
|
6785
|
-
|
|
6786
|
-
<dl>
|
|
6787
|
-
<dd>
|
|
6788
|
-
|
|
6789
|
-
**request:** `Chrt.ShipperContactClientUpdate1`
|
|
6755
|
+
**request:** `Chrt.TaskGroupExpandedListReq`
|
|
6790
6756
|
|
|
6791
6757
|
</dd>
|
|
6792
6758
|
</dl>
|
|
@@ -6794,7 +6760,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
6794
6760
|
<dl>
|
|
6795
6761
|
<dd>
|
|
6796
6762
|
|
|
6797
|
-
**requestOptions:** `
|
|
6763
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6798
6764
|
|
|
6799
6765
|
</dd>
|
|
6800
6766
|
</dl>
|
|
@@ -6805,7 +6771,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
6805
6771
|
</dl>
|
|
6806
6772
|
</details>
|
|
6807
6773
|
|
|
6808
|
-
<details><summary><code>client.
|
|
6774
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6809
6775
|
<dl>
|
|
6810
6776
|
<dd>
|
|
6811
6777
|
|
|
@@ -6817,7 +6783,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
6817
6783
|
<dl>
|
|
6818
6784
|
<dd>
|
|
6819
6785
|
|
|
6820
|
-
|
|
6786
|
+
Updates the ordering of tasks in a task group. Task group must be in STAGED or IN_PROGRESS status. | authz_personas=[lig_org_operators] | (SetTaskOrderingReq) -> (bool)
|
|
6821
6787
|
|
|
6822
6788
|
</dd>
|
|
6823
6789
|
</dl>
|
|
@@ -6833,7 +6799,9 @@ Deletes shipper contact information owned by the authenticated organization. | (
|
|
|
6833
6799
|
<dd>
|
|
6834
6800
|
|
|
6835
6801
|
```typescript
|
|
6836
|
-
await client.
|
|
6802
|
+
await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
6803
|
+
task_ordering: ["task_ordering"],
|
|
6804
|
+
});
|
|
6837
6805
|
```
|
|
6838
6806
|
|
|
6839
6807
|
</dd>
|
|
@@ -6849,7 +6817,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
6849
6817
|
<dl>
|
|
6850
6818
|
<dd>
|
|
6851
6819
|
|
|
6852
|
-
**
|
|
6820
|
+
**taskGroupId:** `string`
|
|
6853
6821
|
|
|
6854
6822
|
</dd>
|
|
6855
6823
|
</dl>
|
|
@@ -6857,7 +6825,15 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
6857
6825
|
<dl>
|
|
6858
6826
|
<dd>
|
|
6859
6827
|
|
|
6860
|
-
**
|
|
6828
|
+
**request:** `Chrt.SetTaskOrderingReq`
|
|
6829
|
+
|
|
6830
|
+
</dd>
|
|
6831
|
+
</dl>
|
|
6832
|
+
|
|
6833
|
+
<dl>
|
|
6834
|
+
<dd>
|
|
6835
|
+
|
|
6836
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6861
6837
|
|
|
6862
6838
|
</dd>
|
|
6863
6839
|
</dl>
|
|
@@ -6868,9 +6844,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
6868
6844
|
</dl>
|
|
6869
6845
|
</details>
|
|
6870
6846
|
|
|
6871
|
-
|
|
6872
|
-
|
|
6873
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> Record<string, unknown></code></summary>
|
|
6847
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setFlightNumberV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6874
6848
|
<dl>
|
|
6875
6849
|
<dd>
|
|
6876
6850
|
|
|
@@ -6882,7 +6856,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
6882
6856
|
<dl>
|
|
6883
6857
|
<dd>
|
|
6884
6858
|
|
|
6885
|
-
|
|
6859
|
+
Updates the flight number on both task group and all its tasks. Task group must be in STAGED or IN_PROGRESS status. | authz_personas=[lig_org_operators] | (SetFlightNumberReq) -> (bool)
|
|
6886
6860
|
|
|
6887
6861
|
</dd>
|
|
6888
6862
|
</dl>
|
|
@@ -6898,7 +6872,9 @@ Retrieves basic organization information from the authentication service. | () -
|
|
|
6898
6872
|
<dd>
|
|
6899
6873
|
|
|
6900
6874
|
```typescript
|
|
6901
|
-
await client.
|
|
6875
|
+
await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
6876
|
+
flight_number: "flight_number",
|
|
6877
|
+
});
|
|
6902
6878
|
```
|
|
6903
6879
|
|
|
6904
6880
|
</dd>
|
|
@@ -6914,18 +6890,34 @@ await client.orgs.getInfoV1();
|
|
|
6914
6890
|
<dl>
|
|
6915
6891
|
<dd>
|
|
6916
6892
|
|
|
6917
|
-
**
|
|
6893
|
+
**taskGroupId:** `string`
|
|
6918
6894
|
|
|
6919
|
-
</dd>
|
|
6920
|
-
</dl>
|
|
6921
6895
|
</dd>
|
|
6922
6896
|
</dl>
|
|
6923
6897
|
|
|
6924
|
-
|
|
6925
|
-
|
|
6898
|
+
<dl>
|
|
6899
|
+
<dd>
|
|
6900
|
+
|
|
6901
|
+
**request:** `Chrt.SetFlightNumberReq`
|
|
6902
|
+
|
|
6903
|
+
</dd>
|
|
6904
|
+
</dl>
|
|
6905
|
+
|
|
6906
|
+
<dl>
|
|
6907
|
+
<dd>
|
|
6908
|
+
|
|
6909
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6910
|
+
|
|
6911
|
+
</dd>
|
|
6912
|
+
</dl>
|
|
6913
|
+
</dd>
|
|
6914
|
+
</dl>
|
|
6915
|
+
|
|
6916
|
+
</dd>
|
|
6917
|
+
</dl>
|
|
6926
6918
|
</details>
|
|
6927
6919
|
|
|
6928
|
-
<details><summary><code>client.
|
|
6920
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6929
6921
|
<dl>
|
|
6930
6922
|
<dd>
|
|
6931
6923
|
|
|
@@ -6937,7 +6929,7 @@ await client.orgs.getInfoV1();
|
|
|
6937
6929
|
<dl>
|
|
6938
6930
|
<dd>
|
|
6939
6931
|
|
|
6940
|
-
|
|
6932
|
+
Sets or removes the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateTaskGroupDriverReq) -> (bool)
|
|
6941
6933
|
|
|
6942
6934
|
</dd>
|
|
6943
6935
|
</dl>
|
|
@@ -6953,7 +6945,7 @@ Lists all members of the authenticated organization with their roles and details
|
|
|
6953
6945
|
<dd>
|
|
6954
6946
|
|
|
6955
6947
|
```typescript
|
|
6956
|
-
await client.
|
|
6948
|
+
await client.taskGroups.updateDriverV1("task_group_id");
|
|
6957
6949
|
```
|
|
6958
6950
|
|
|
6959
6951
|
</dd>
|
|
@@ -6969,7 +6961,23 @@ await client.orgs.listMembersV1();
|
|
|
6969
6961
|
<dl>
|
|
6970
6962
|
<dd>
|
|
6971
6963
|
|
|
6972
|
-
**
|
|
6964
|
+
**taskGroupId:** `string`
|
|
6965
|
+
|
|
6966
|
+
</dd>
|
|
6967
|
+
</dl>
|
|
6968
|
+
|
|
6969
|
+
<dl>
|
|
6970
|
+
<dd>
|
|
6971
|
+
|
|
6972
|
+
**request:** `Chrt.UpdateTaskGroupDriverReq`
|
|
6973
|
+
|
|
6974
|
+
</dd>
|
|
6975
|
+
</dl>
|
|
6976
|
+
|
|
6977
|
+
<dl>
|
|
6978
|
+
<dd>
|
|
6979
|
+
|
|
6980
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6973
6981
|
|
|
6974
6982
|
</dd>
|
|
6975
6983
|
</dl>
|
|
@@ -6980,7 +6988,7 @@ await client.orgs.listMembersV1();
|
|
|
6980
6988
|
</dl>
|
|
6981
6989
|
</details>
|
|
6982
6990
|
|
|
6983
|
-
<details><summary><code>client.
|
|
6991
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateCourierOrgV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6984
6992
|
<dl>
|
|
6985
6993
|
<dd>
|
|
6986
6994
|
|
|
@@ -6992,7 +7000,7 @@ await client.orgs.listMembersV1();
|
|
|
6992
7000
|
<dl>
|
|
6993
7001
|
<dd>
|
|
6994
7002
|
|
|
6995
|
-
|
|
7003
|
+
Sets or removes the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateTaskGroupCourierOrgReq) -> (bool)
|
|
6996
7004
|
|
|
6997
7005
|
</dd>
|
|
6998
7006
|
</dl>
|
|
@@ -7008,7 +7016,7 @@ Retrieves public organization data for the authenticated organization. | () -> (
|
|
|
7008
7016
|
<dd>
|
|
7009
7017
|
|
|
7010
7018
|
```typescript
|
|
7011
|
-
await client.
|
|
7019
|
+
await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
7012
7020
|
```
|
|
7013
7021
|
|
|
7014
7022
|
</dd>
|
|
@@ -7024,7 +7032,23 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
7024
7032
|
<dl>
|
|
7025
7033
|
<dd>
|
|
7026
7034
|
|
|
7027
|
-
**
|
|
7035
|
+
**taskGroupId:** `string`
|
|
7036
|
+
|
|
7037
|
+
</dd>
|
|
7038
|
+
</dl>
|
|
7039
|
+
|
|
7040
|
+
<dl>
|
|
7041
|
+
<dd>
|
|
7042
|
+
|
|
7043
|
+
**request:** `Chrt.UpdateTaskGroupCourierOrgReq`
|
|
7044
|
+
|
|
7045
|
+
</dd>
|
|
7046
|
+
</dl>
|
|
7047
|
+
|
|
7048
|
+
<dl>
|
|
7049
|
+
<dd>
|
|
7050
|
+
|
|
7051
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
7028
7052
|
|
|
7029
7053
|
</dd>
|
|
7030
7054
|
</dl>
|
|
@@ -7035,7 +7059,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
7035
7059
|
</dl>
|
|
7036
7060
|
</details>
|
|
7037
7061
|
|
|
7038
|
-
<details><summary><code>client.
|
|
7062
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
7039
7063
|
<dl>
|
|
7040
7064
|
<dd>
|
|
7041
7065
|
|
|
@@ -7047,7 +7071,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
7047
7071
|
<dl>
|
|
7048
7072
|
<dd>
|
|
7049
7073
|
|
|
7050
|
-
|
|
7074
|
+
Starts a task group by changing its status to in-progress and updating the order status. | authz_personas=[courier_driver, lig_org_operators] | () -> (bool)
|
|
7051
7075
|
|
|
7052
7076
|
</dd>
|
|
7053
7077
|
</dl>
|
|
@@ -7063,7 +7087,7 @@ Creates org_public_data and org_private_data documents for the authenticated org
|
|
|
7063
7087
|
<dd>
|
|
7064
7088
|
|
|
7065
7089
|
```typescript
|
|
7066
|
-
await client.
|
|
7090
|
+
await client.taskGroups.startV1("task_group_id");
|
|
7067
7091
|
```
|
|
7068
7092
|
|
|
7069
7093
|
</dd>
|
|
@@ -7079,7 +7103,7 @@ await client.orgs.createOrgPublicDataV1();
|
|
|
7079
7103
|
<dl>
|
|
7080
7104
|
<dd>
|
|
7081
7105
|
|
|
7082
|
-
**
|
|
7106
|
+
**taskGroupId:** `string`
|
|
7083
7107
|
|
|
7084
7108
|
</dd>
|
|
7085
7109
|
</dl>
|
|
@@ -7087,7 +7111,7 @@ await client.orgs.createOrgPublicDataV1();
|
|
|
7087
7111
|
<dl>
|
|
7088
7112
|
<dd>
|
|
7089
7113
|
|
|
7090
|
-
**requestOptions:** `
|
|
7114
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
7091
7115
|
|
|
7092
7116
|
</dd>
|
|
7093
7117
|
</dl>
|
|
@@ -7098,7 +7122,9 @@ await client.orgs.createOrgPublicDataV1();
|
|
|
7098
7122
|
</dl>
|
|
7099
7123
|
</details>
|
|
7100
7124
|
|
|
7101
|
-
|
|
7125
|
+
## ShipperContactInfo
|
|
7126
|
+
|
|
7127
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByJwtUserIdV1</a>() -> Chrt.ShipperContact1</code></summary>
|
|
7102
7128
|
<dl>
|
|
7103
7129
|
<dd>
|
|
7104
7130
|
|
|
@@ -7110,7 +7136,7 @@ await client.orgs.createOrgPublicDataV1();
|
|
|
7110
7136
|
<dl>
|
|
7111
7137
|
<dd>
|
|
7112
7138
|
|
|
7113
|
-
|
|
7139
|
+
Retrieves the authenticated user's own shipper contact information. | () -> (ShipperContact1)
|
|
7114
7140
|
|
|
7115
7141
|
</dd>
|
|
7116
7142
|
</dl>
|
|
@@ -7126,7 +7152,7 @@ Updates the handle and/or company_name for the authenticated organization. | (Up
|
|
|
7126
7152
|
<dd>
|
|
7127
7153
|
|
|
7128
7154
|
```typescript
|
|
7129
|
-
await client.
|
|
7155
|
+
await client.shipperContactInfo.getByJwtUserIdV1();
|
|
7130
7156
|
```
|
|
7131
7157
|
|
|
7132
7158
|
</dd>
|
|
@@ -7142,15 +7168,62 @@ await client.orgs.updateOrgPublicDataV1();
|
|
|
7142
7168
|
<dl>
|
|
7143
7169
|
<dd>
|
|
7144
7170
|
|
|
7145
|
-
**
|
|
7171
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7146
7172
|
|
|
7147
7173
|
</dd>
|
|
7148
7174
|
</dl>
|
|
7175
|
+
</dd>
|
|
7176
|
+
</dl>
|
|
7177
|
+
|
|
7178
|
+
</dd>
|
|
7179
|
+
</dl>
|
|
7180
|
+
</details>
|
|
7149
7181
|
|
|
7182
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByJwtOrgIdV1</a>() -> Chrt.ShipperContact1[]</code></summary>
|
|
7150
7183
|
<dl>
|
|
7151
7184
|
<dd>
|
|
7152
7185
|
|
|
7153
|
-
|
|
7186
|
+
#### 📝 Description
|
|
7187
|
+
|
|
7188
|
+
<dl>
|
|
7189
|
+
<dd>
|
|
7190
|
+
|
|
7191
|
+
<dl>
|
|
7192
|
+
<dd>
|
|
7193
|
+
|
|
7194
|
+
Lists all shipper contacts created by the authenticated organization. | () -> (list[ShipperContact1])
|
|
7195
|
+
|
|
7196
|
+
</dd>
|
|
7197
|
+
</dl>
|
|
7198
|
+
</dd>
|
|
7199
|
+
</dl>
|
|
7200
|
+
|
|
7201
|
+
#### 🔌 Usage
|
|
7202
|
+
|
|
7203
|
+
<dl>
|
|
7204
|
+
<dd>
|
|
7205
|
+
|
|
7206
|
+
<dl>
|
|
7207
|
+
<dd>
|
|
7208
|
+
|
|
7209
|
+
```typescript
|
|
7210
|
+
await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
7211
|
+
```
|
|
7212
|
+
|
|
7213
|
+
</dd>
|
|
7214
|
+
</dl>
|
|
7215
|
+
</dd>
|
|
7216
|
+
</dl>
|
|
7217
|
+
|
|
7218
|
+
#### ⚙️ Parameters
|
|
7219
|
+
|
|
7220
|
+
<dl>
|
|
7221
|
+
<dd>
|
|
7222
|
+
|
|
7223
|
+
<dl>
|
|
7224
|
+
<dd>
|
|
7225
|
+
|
|
7226
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7154
7227
|
|
|
7155
7228
|
</dd>
|
|
7156
7229
|
</dl>
|
|
@@ -7161,7 +7234,7 @@ await client.orgs.updateOrgPublicDataV1();
|
|
|
7161
7234
|
</dl>
|
|
7162
7235
|
</details>
|
|
7163
7236
|
|
|
7164
|
-
<details><summary><code>client.
|
|
7237
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listCourierContactsByShipperOrgIdV1</a>(shipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
|
|
7165
7238
|
<dl>
|
|
7166
7239
|
<dd>
|
|
7167
7240
|
|
|
@@ -7173,7 +7246,7 @@ await client.orgs.updateOrgPublicDataV1();
|
|
|
7173
7246
|
<dl>
|
|
7174
7247
|
<dd>
|
|
7175
7248
|
|
|
7176
|
-
|
|
7249
|
+
Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])
|
|
7177
7250
|
|
|
7178
7251
|
</dd>
|
|
7179
7252
|
</dl>
|
|
@@ -7189,7 +7262,7 @@ Retrieves public organization data for a specific organization by ID. | () -> (O
|
|
|
7189
7262
|
<dd>
|
|
7190
7263
|
|
|
7191
7264
|
```typescript
|
|
7192
|
-
await client.
|
|
7265
|
+
await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org_id");
|
|
7193
7266
|
```
|
|
7194
7267
|
|
|
7195
7268
|
</dd>
|
|
@@ -7205,7 +7278,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
7205
7278
|
<dl>
|
|
7206
7279
|
<dd>
|
|
7207
7280
|
|
|
7208
|
-
**
|
|
7281
|
+
**shipperOrgId:** `string`
|
|
7209
7282
|
|
|
7210
7283
|
</dd>
|
|
7211
7284
|
</dl>
|
|
@@ -7213,7 +7286,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
7213
7286
|
<dl>
|
|
7214
7287
|
<dd>
|
|
7215
7288
|
|
|
7216
|
-
**requestOptions:** `
|
|
7289
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7217
7290
|
|
|
7218
7291
|
</dd>
|
|
7219
7292
|
</dl>
|
|
@@ -7224,7 +7297,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
7224
7297
|
</dl>
|
|
7225
7298
|
</details>
|
|
7226
7299
|
|
|
7227
|
-
<details><summary><code>client.
|
|
7300
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByOffChrtShipperOrgIdV1</a>(offChrtShipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
|
|
7228
7301
|
<dl>
|
|
7229
7302
|
<dd>
|
|
7230
7303
|
|
|
@@ -7236,7 +7309,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
7236
7309
|
<dl>
|
|
7237
7310
|
<dd>
|
|
7238
7311
|
|
|
7239
|
-
|
|
7312
|
+
Lists all shipper contacts for a specific off-platform shipper connection. | () -> (list[ShipperContact1])
|
|
7240
7313
|
|
|
7241
7314
|
</dd>
|
|
7242
7315
|
</dl>
|
|
@@ -7252,7 +7325,7 @@ Returns True when the provided handle is available, otherwise False. | () -> (bo
|
|
|
7252
7325
|
<dd>
|
|
7253
7326
|
|
|
7254
7327
|
```typescript
|
|
7255
|
-
await client.
|
|
7328
|
+
await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_org_id");
|
|
7256
7329
|
```
|
|
7257
7330
|
|
|
7258
7331
|
</dd>
|
|
@@ -7268,7 +7341,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
7268
7341
|
<dl>
|
|
7269
7342
|
<dd>
|
|
7270
7343
|
|
|
7271
|
-
**
|
|
7344
|
+
**offChrtShipperOrgId:** `string`
|
|
7272
7345
|
|
|
7273
7346
|
</dd>
|
|
7274
7347
|
</dl>
|
|
@@ -7276,7 +7349,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
7276
7349
|
<dl>
|
|
7277
7350
|
<dd>
|
|
7278
7351
|
|
|
7279
|
-
**requestOptions:** `
|
|
7352
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7280
7353
|
|
|
7281
7354
|
</dd>
|
|
7282
7355
|
</dl>
|
|
@@ -7287,7 +7360,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
7287
7360
|
</dl>
|
|
7288
7361
|
</details>
|
|
7289
7362
|
|
|
7290
|
-
<details><summary><code>client.
|
|
7363
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByIdV1</a>(id) -> Chrt.ShipperContact1</code></summary>
|
|
7291
7364
|
<dl>
|
|
7292
7365
|
<dd>
|
|
7293
7366
|
|
|
@@ -7299,7 +7372,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
7299
7372
|
<dl>
|
|
7300
7373
|
<dd>
|
|
7301
7374
|
|
|
7302
|
-
|
|
7375
|
+
Retrieves a specific shipper contact by ID if authorized to access it. | () -> (ShipperContact1)
|
|
7303
7376
|
|
|
7304
7377
|
</dd>
|
|
7305
7378
|
</dl>
|
|
@@ -7315,9 +7388,7 @@ Sets the org_type in Clerk's JWT public metadata. Returns True if already set an
|
|
|
7315
7388
|
<dd>
|
|
7316
7389
|
|
|
7317
7390
|
```typescript
|
|
7318
|
-
await client.
|
|
7319
|
-
org_type: "courier",
|
|
7320
|
-
});
|
|
7391
|
+
await client.shipperContactInfo.getByIdV1("id");
|
|
7321
7392
|
```
|
|
7322
7393
|
|
|
7323
7394
|
</dd>
|
|
@@ -7333,7 +7404,7 @@ await client.orgs.setOrgTypeV1({
|
|
|
7333
7404
|
<dl>
|
|
7334
7405
|
<dd>
|
|
7335
7406
|
|
|
7336
|
-
**
|
|
7407
|
+
**id:** `string`
|
|
7337
7408
|
|
|
7338
7409
|
</dd>
|
|
7339
7410
|
</dl>
|
|
@@ -7341,7 +7412,7 @@ await client.orgs.setOrgTypeV1({
|
|
|
7341
7412
|
<dl>
|
|
7342
7413
|
<dd>
|
|
7343
7414
|
|
|
7344
|
-
**requestOptions:** `
|
|
7415
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7345
7416
|
|
|
7346
7417
|
</dd>
|
|
7347
7418
|
</dl>
|
|
@@ -7352,7 +7423,7 @@ await client.orgs.setOrgTypeV1({
|
|
|
7352
7423
|
</dl>
|
|
7353
7424
|
</details>
|
|
7354
7425
|
|
|
7355
|
-
<details><summary><code>client.
|
|
7426
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOnPlatformV1</a>({ ...params }) -> string</code></summary>
|
|
7356
7427
|
<dl>
|
|
7357
7428
|
<dd>
|
|
7358
7429
|
|
|
@@ -7364,7 +7435,7 @@ await client.orgs.setOrgTypeV1({
|
|
|
7364
7435
|
<dl>
|
|
7365
7436
|
<dd>
|
|
7366
7437
|
|
|
7367
|
-
|
|
7438
|
+
Creates contact information for an on-platform shipper organization or user. | (ShipperContactClientCreate1) -> (PydanticObjectId)
|
|
7368
7439
|
|
|
7369
7440
|
</dd>
|
|
7370
7441
|
</dl>
|
|
@@ -7380,7 +7451,9 @@ Retrieves the Stripe Connect account ID for the authenticated organization. Retu
|
|
|
7380
7451
|
<dd>
|
|
7381
7452
|
|
|
7382
7453
|
```typescript
|
|
7383
|
-
await client.
|
|
7454
|
+
await client.shipperContactInfo.createOnPlatformV1({
|
|
7455
|
+
schema_version: 1,
|
|
7456
|
+
});
|
|
7384
7457
|
```
|
|
7385
7458
|
|
|
7386
7459
|
</dd>
|
|
@@ -7396,7 +7469,15 @@ await client.orgs.getStripeConnectAccountIdV1();
|
|
|
7396
7469
|
<dl>
|
|
7397
7470
|
<dd>
|
|
7398
7471
|
|
|
7399
|
-
**
|
|
7472
|
+
**request:** `Chrt.ShipperContactClientCreate1`
|
|
7473
|
+
|
|
7474
|
+
</dd>
|
|
7475
|
+
</dl>
|
|
7476
|
+
|
|
7477
|
+
<dl>
|
|
7478
|
+
<dd>
|
|
7479
|
+
|
|
7480
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7400
7481
|
|
|
7401
7482
|
</dd>
|
|
7402
7483
|
</dl>
|
|
@@ -7407,9 +7488,7 @@ await client.orgs.getStripeConnectAccountIdV1();
|
|
|
7407
7488
|
</dl>
|
|
7408
7489
|
</details>
|
|
7409
7490
|
|
|
7410
|
-
|
|
7411
|
-
|
|
7412
|
-
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingAuthd</a>() -> Record<string, string></code></summary>
|
|
7491
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOffPlatformV1</a>({ ...params }) -> string</code></summary>
|
|
7413
7492
|
<dl>
|
|
7414
7493
|
<dd>
|
|
7415
7494
|
|
|
@@ -7421,7 +7500,7 @@ await client.orgs.getStripeConnectAccountIdV1();
|
|
|
7421
7500
|
<dl>
|
|
7422
7501
|
<dd>
|
|
7423
7502
|
|
|
7424
|
-
|
|
7503
|
+
Creates contact information for an off-platform shipper using connection info. | (ShipperContactClientCreate1) -> (PydanticObjectId)
|
|
7425
7504
|
|
|
7426
7505
|
</dd>
|
|
7427
7506
|
</dl>
|
|
@@ -7437,7 +7516,9 @@ Test endpoint for authenticated requests that requires valid authentication toke
|
|
|
7437
7516
|
<dd>
|
|
7438
7517
|
|
|
7439
7518
|
```typescript
|
|
7440
|
-
await client.
|
|
7519
|
+
await client.shipperContactInfo.createOffPlatformV1({
|
|
7520
|
+
schema_version: 1,
|
|
7521
|
+
});
|
|
7441
7522
|
```
|
|
7442
7523
|
|
|
7443
7524
|
</dd>
|
|
@@ -7453,7 +7534,15 @@ await client.root.pingAuthd();
|
|
|
7453
7534
|
<dl>
|
|
7454
7535
|
<dd>
|
|
7455
7536
|
|
|
7456
|
-
**
|
|
7537
|
+
**request:** `Chrt.ShipperContactClientCreate1`
|
|
7538
|
+
|
|
7539
|
+
</dd>
|
|
7540
|
+
</dl>
|
|
7541
|
+
|
|
7542
|
+
<dl>
|
|
7543
|
+
<dd>
|
|
7544
|
+
|
|
7545
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7457
7546
|
|
|
7458
7547
|
</dd>
|
|
7459
7548
|
</dl>
|
|
@@ -7464,7 +7553,7 @@ await client.root.pingAuthd();
|
|
|
7464
7553
|
</dl>
|
|
7465
7554
|
</details>
|
|
7466
7555
|
|
|
7467
|
-
<details><summary><code>client.
|
|
7556
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">updateV1</a>(shipperContactInfoId, { ...params }) -> boolean</code></summary>
|
|
7468
7557
|
<dl>
|
|
7469
7558
|
<dd>
|
|
7470
7559
|
|
|
@@ -7476,7 +7565,7 @@ await client.root.pingAuthd();
|
|
|
7476
7565
|
<dl>
|
|
7477
7566
|
<dd>
|
|
7478
7567
|
|
|
7479
|
-
|
|
7568
|
+
Updates existing shipper contact information owned by the authenticated organization. | (ShipperContactClientUpdate1) -> (bool)
|
|
7480
7569
|
|
|
7481
7570
|
</dd>
|
|
7482
7571
|
</dl>
|
|
@@ -7492,7 +7581,7 @@ Test endpoint for optionally authenticated requests that works with or without a
|
|
|
7492
7581
|
<dd>
|
|
7493
7582
|
|
|
7494
7583
|
```typescript
|
|
7495
|
-
await client.
|
|
7584
|
+
await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
7496
7585
|
```
|
|
7497
7586
|
|
|
7498
7587
|
</dd>
|
|
@@ -7508,7 +7597,23 @@ await client.root.pingOptionallyAuthd();
|
|
|
7508
7597
|
<dl>
|
|
7509
7598
|
<dd>
|
|
7510
7599
|
|
|
7511
|
-
**
|
|
7600
|
+
**shipperContactInfoId:** `string`
|
|
7601
|
+
|
|
7602
|
+
</dd>
|
|
7603
|
+
</dl>
|
|
7604
|
+
|
|
7605
|
+
<dl>
|
|
7606
|
+
<dd>
|
|
7607
|
+
|
|
7608
|
+
**request:** `Chrt.ShipperContactClientUpdate1`
|
|
7609
|
+
|
|
7610
|
+
</dd>
|
|
7611
|
+
</dl>
|
|
7612
|
+
|
|
7613
|
+
<dl>
|
|
7614
|
+
<dd>
|
|
7615
|
+
|
|
7616
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7512
7617
|
|
|
7513
7618
|
</dd>
|
|
7514
7619
|
</dl>
|
|
@@ -7519,7 +7624,7 @@ await client.root.pingOptionallyAuthd();
|
|
|
7519
7624
|
</dl>
|
|
7520
7625
|
</details>
|
|
7521
7626
|
|
|
7522
|
-
<details><summary><code>client.
|
|
7627
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">deleteByIdV1</a>(id) -> boolean</code></summary>
|
|
7523
7628
|
<dl>
|
|
7524
7629
|
<dd>
|
|
7525
7630
|
|
|
@@ -7531,7 +7636,7 @@ await client.root.pingOptionallyAuthd();
|
|
|
7531
7636
|
<dl>
|
|
7532
7637
|
<dd>
|
|
7533
7638
|
|
|
7534
|
-
|
|
7639
|
+
Deletes shipper contact information owned by the authenticated organization. | () -> (bool)
|
|
7535
7640
|
|
|
7536
7641
|
</dd>
|
|
7537
7642
|
</dl>
|
|
@@ -7547,7 +7652,7 @@ Returns a greeting message to verify the API is accessible. | () -> (dict)
|
|
|
7547
7652
|
<dd>
|
|
7548
7653
|
|
|
7549
7654
|
```typescript
|
|
7550
|
-
await client.
|
|
7655
|
+
await client.shipperContactInfo.deleteByIdV1("id");
|
|
7551
7656
|
```
|
|
7552
7657
|
|
|
7553
7658
|
</dd>
|
|
@@ -7563,7 +7668,15 @@ await client.root.pingUnauthd();
|
|
|
7563
7668
|
<dl>
|
|
7564
7669
|
<dd>
|
|
7565
7670
|
|
|
7566
|
-
**
|
|
7671
|
+
**id:** `string`
|
|
7672
|
+
|
|
7673
|
+
</dd>
|
|
7674
|
+
</dl>
|
|
7675
|
+
|
|
7676
|
+
<dl>
|
|
7677
|
+
<dd>
|
|
7678
|
+
|
|
7679
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7567
7680
|
|
|
7568
7681
|
</dd>
|
|
7569
7682
|
</dl>
|
|
@@ -7574,7 +7687,9 @@ await client.root.pingUnauthd();
|
|
|
7574
7687
|
</dl>
|
|
7575
7688
|
</details>
|
|
7576
7689
|
|
|
7577
|
-
|
|
7690
|
+
## Orgs
|
|
7691
|
+
|
|
7692
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> Record<string, unknown></code></summary>
|
|
7578
7693
|
<dl>
|
|
7579
7694
|
<dd>
|
|
7580
7695
|
|
|
@@ -7586,7 +7701,7 @@ await client.root.pingUnauthd();
|
|
|
7586
7701
|
<dl>
|
|
7587
7702
|
<dd>
|
|
7588
7703
|
|
|
7589
|
-
|
|
7704
|
+
Retrieves basic organization information from the authentication service. | () -> (dict)
|
|
7590
7705
|
|
|
7591
7706
|
</dd>
|
|
7592
7707
|
</dl>
|
|
@@ -7602,7 +7717,7 @@ Returns a health status message used for monitoring system availability and upti
|
|
|
7602
7717
|
<dd>
|
|
7603
7718
|
|
|
7604
7719
|
```typescript
|
|
7605
|
-
await client.
|
|
7720
|
+
await client.orgs.getInfoV1();
|
|
7606
7721
|
```
|
|
7607
7722
|
|
|
7608
7723
|
</dd>
|
|
@@ -7618,7 +7733,7 @@ await client.root.health();
|
|
|
7618
7733
|
<dl>
|
|
7619
7734
|
<dd>
|
|
7620
7735
|
|
|
7621
|
-
**requestOptions:** `
|
|
7736
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7622
7737
|
|
|
7623
7738
|
</dd>
|
|
7624
7739
|
</dl>
|
|
@@ -7629,7 +7744,7 @@ await client.root.health();
|
|
|
7629
7744
|
</dl>
|
|
7630
7745
|
</details>
|
|
7631
7746
|
|
|
7632
|
-
<details><summary><code>client.
|
|
7747
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">listMembersV1</a>() -> Chrt.OrgMemberDetails[]</code></summary>
|
|
7633
7748
|
<dl>
|
|
7634
7749
|
<dd>
|
|
7635
7750
|
|
|
@@ -7641,7 +7756,7 @@ await client.root.health();
|
|
|
7641
7756
|
<dl>
|
|
7642
7757
|
<dd>
|
|
7643
7758
|
|
|
7644
|
-
|
|
7759
|
+
Lists all members of the authenticated organization with their roles and details. | () -> (list[OrgMemberDetails])
|
|
7645
7760
|
|
|
7646
7761
|
</dd>
|
|
7647
7762
|
</dl>
|
|
@@ -7657,7 +7772,7 @@ Test endpoint that intentionally fails for error handling validation and monitor
|
|
|
7657
7772
|
<dd>
|
|
7658
7773
|
|
|
7659
7774
|
```typescript
|
|
7660
|
-
await client.
|
|
7775
|
+
await client.orgs.listMembersV1();
|
|
7661
7776
|
```
|
|
7662
7777
|
|
|
7663
7778
|
</dd>
|
|
@@ -7673,7 +7788,7 @@ await client.root.failure();
|
|
|
7673
7788
|
<dl>
|
|
7674
7789
|
<dd>
|
|
7675
7790
|
|
|
7676
|
-
**requestOptions:** `
|
|
7791
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7677
7792
|
|
|
7678
7793
|
</dd>
|
|
7679
7794
|
</dl>
|
|
@@ -7684,9 +7799,7 @@ await client.root.failure();
|
|
|
7684
7799
|
</dl>
|
|
7685
7800
|
</details>
|
|
7686
7801
|
|
|
7687
|
-
|
|
7688
|
-
|
|
7689
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPublicDataV1</a>() -> Chrt.UserPublicData1</code></summary>
|
|
7802
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataV1</a>() -> Chrt.OrgPublicData1</code></summary>
|
|
7690
7803
|
<dl>
|
|
7691
7804
|
<dd>
|
|
7692
7805
|
|
|
@@ -7698,7 +7811,7 @@ await client.root.failure();
|
|
|
7698
7811
|
<dl>
|
|
7699
7812
|
<dd>
|
|
7700
7813
|
|
|
7701
|
-
Retrieves public
|
|
7814
|
+
Retrieves public organization data for the authenticated organization. | () -> (OrgPublicData1)
|
|
7702
7815
|
|
|
7703
7816
|
</dd>
|
|
7704
7817
|
</dl>
|
|
@@ -7714,7 +7827,7 @@ Retrieves public user data for the authenticated user. | () -> (UserPublicData1)
|
|
|
7714
7827
|
<dd>
|
|
7715
7828
|
|
|
7716
7829
|
```typescript
|
|
7717
|
-
await client.
|
|
7830
|
+
await client.orgs.getOrgPublicDataV1();
|
|
7718
7831
|
```
|
|
7719
7832
|
|
|
7720
7833
|
</dd>
|
|
@@ -7730,7 +7843,7 @@ await client.users.getUserPublicDataV1();
|
|
|
7730
7843
|
<dl>
|
|
7731
7844
|
<dd>
|
|
7732
7845
|
|
|
7733
|
-
**requestOptions:** `
|
|
7846
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7734
7847
|
|
|
7735
7848
|
</dd>
|
|
7736
7849
|
</dl>
|
|
@@ -7741,9 +7854,7 @@ await client.users.getUserPublicDataV1();
|
|
|
7741
7854
|
</dl>
|
|
7742
7855
|
</details>
|
|
7743
7856
|
|
|
7744
|
-
|
|
7745
|
-
|
|
7746
|
-
<details><summary><code>client.utils.<a href="/src/api/resources/utils/client/Client.ts">getTimezoneV1</a>({ ...params }) -> Chrt.TimezoneResponse</code></summary>
|
|
7857
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">createOrgPublicDataV1</a>({ ...params }) -> Chrt.CreateOrgPublicDataRes</code></summary>
|
|
7747
7858
|
<dl>
|
|
7748
7859
|
<dd>
|
|
7749
7860
|
|
|
@@ -7755,7 +7866,7 @@ await client.users.getUserPublicDataV1();
|
|
|
7755
7866
|
<dl>
|
|
7756
7867
|
<dd>
|
|
7757
7868
|
|
|
7758
|
-
|
|
7869
|
+
Creates org_public_data and org_private_data documents for the authenticated organization using org_type from JWT. | (CreateOrgPublicDataReq) -> (CreateOrgPublicDataRes)
|
|
7759
7870
|
|
|
7760
7871
|
</dd>
|
|
7761
7872
|
</dl>
|
|
@@ -7771,10 +7882,7 @@ Returns the IANA timezone identifier (e.g., 'America/Los_Angeles') for the given
|
|
|
7771
7882
|
<dd>
|
|
7772
7883
|
|
|
7773
7884
|
```typescript
|
|
7774
|
-
await client.
|
|
7775
|
-
lat: 37.7749,
|
|
7776
|
-
lng: -122.4194,
|
|
7777
|
-
});
|
|
7885
|
+
await client.orgs.createOrgPublicDataV1();
|
|
7778
7886
|
```
|
|
7779
7887
|
|
|
7780
7888
|
</dd>
|
|
@@ -7790,7 +7898,7 @@ await client.utils.getTimezoneV1({
|
|
|
7790
7898
|
<dl>
|
|
7791
7899
|
<dd>
|
|
7792
7900
|
|
|
7793
|
-
**request:** `Chrt.
|
|
7901
|
+
**request:** `Chrt.CreateOrgPublicDataReq`
|
|
7794
7902
|
|
|
7795
7903
|
</dd>
|
|
7796
7904
|
</dl>
|
|
@@ -7798,7 +7906,7 @@ await client.utils.getTimezoneV1({
|
|
|
7798
7906
|
<dl>
|
|
7799
7907
|
<dd>
|
|
7800
7908
|
|
|
7801
|
-
**requestOptions:** `
|
|
7909
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7802
7910
|
|
|
7803
7911
|
</dd>
|
|
7804
7912
|
</dl>
|
|
@@ -7809,9 +7917,7 @@ await client.utils.getTimezoneV1({
|
|
|
7809
7917
|
</dl>
|
|
7810
7918
|
</details>
|
|
7811
7919
|
|
|
7812
|
-
|
|
7813
|
-
|
|
7814
|
-
<details><summary><code>client.connections.connectionToCourier.<a href="/src/api/resources/connections/resources/connectionToCourier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
7920
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">updateOrgPublicDataV1</a>({ ...params }) -> boolean</code></summary>
|
|
7815
7921
|
<dl>
|
|
7816
7922
|
<dd>
|
|
7817
7923
|
|
|
@@ -7823,7 +7929,7 @@ await client.utils.getTimezoneV1({
|
|
|
7823
7929
|
<dl>
|
|
7824
7930
|
<dd>
|
|
7825
7931
|
|
|
7826
|
-
|
|
7932
|
+
Updates the handle and/or company_name for the authenticated organization. | (UpdateOrgPublicDataReq) -> (bool)
|
|
7827
7933
|
|
|
7828
7934
|
</dd>
|
|
7829
7935
|
</dl>
|
|
@@ -7839,9 +7945,7 @@ Creates a new connection to a courier organization. Shippers and forwarders can
|
|
|
7839
7945
|
<dd>
|
|
7840
7946
|
|
|
7841
7947
|
```typescript
|
|
7842
|
-
await client.
|
|
7843
|
-
handle: "handle",
|
|
7844
|
-
});
|
|
7948
|
+
await client.orgs.updateOrgPublicDataV1();
|
|
7845
7949
|
```
|
|
7846
7950
|
|
|
7847
7951
|
</dd>
|
|
@@ -7857,7 +7961,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
7857
7961
|
<dl>
|
|
7858
7962
|
<dd>
|
|
7859
7963
|
|
|
7860
|
-
**request:** `Chrt.
|
|
7964
|
+
**request:** `Chrt.UpdateOrgPublicDataReq`
|
|
7861
7965
|
|
|
7862
7966
|
</dd>
|
|
7863
7967
|
</dl>
|
|
@@ -7865,7 +7969,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
7865
7969
|
<dl>
|
|
7866
7970
|
<dd>
|
|
7867
7971
|
|
|
7868
|
-
**requestOptions:** `
|
|
7972
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7869
7973
|
|
|
7870
7974
|
</dd>
|
|
7871
7975
|
</dl>
|
|
@@ -7876,9 +7980,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
7876
7980
|
</dl>
|
|
7877
7981
|
</details>
|
|
7878
7982
|
|
|
7879
|
-
|
|
7880
|
-
|
|
7881
|
-
<details><summary><code>client.connections.connectionToShipper.<a href="/src/api/resources/connections/resources/connectionToShipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
7983
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataByOrgIdV1</a>(orgId) -> Chrt.OrgPublicData1</code></summary>
|
|
7882
7984
|
<dl>
|
|
7883
7985
|
<dd>
|
|
7884
7986
|
|
|
@@ -7890,7 +7992,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
7890
7992
|
<dl>
|
|
7891
7993
|
<dd>
|
|
7892
7994
|
|
|
7893
|
-
|
|
7995
|
+
Retrieves public organization data for a specific organization by ID. | () -> (OrgPublicData1)
|
|
7894
7996
|
|
|
7895
7997
|
</dd>
|
|
7896
7998
|
</dl>
|
|
@@ -7906,9 +8008,7 @@ Creates a new connection to a shipper organization. Only forwarders can initiate
|
|
|
7906
8008
|
<dd>
|
|
7907
8009
|
|
|
7908
8010
|
```typescript
|
|
7909
|
-
await client.
|
|
7910
|
-
handle: "handle",
|
|
7911
|
-
});
|
|
8011
|
+
await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
7912
8012
|
```
|
|
7913
8013
|
|
|
7914
8014
|
</dd>
|
|
@@ -7924,7 +8024,7 @@ await client.connections.connectionToShipper.createV1({
|
|
|
7924
8024
|
<dl>
|
|
7925
8025
|
<dd>
|
|
7926
8026
|
|
|
7927
|
-
**
|
|
8027
|
+
**orgId:** `string`
|
|
7928
8028
|
|
|
7929
8029
|
</dd>
|
|
7930
8030
|
</dl>
|
|
@@ -7932,7 +8032,7 @@ await client.connections.connectionToShipper.createV1({
|
|
|
7932
8032
|
<dl>
|
|
7933
8033
|
<dd>
|
|
7934
8034
|
|
|
7935
|
-
**requestOptions:** `
|
|
8035
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7936
8036
|
|
|
7937
8037
|
</dd>
|
|
7938
8038
|
</dl>
|
|
@@ -7943,9 +8043,7 @@ await client.connections.connectionToShipper.createV1({
|
|
|
7943
8043
|
</dl>
|
|
7944
8044
|
</details>
|
|
7945
8045
|
|
|
7946
|
-
|
|
7947
|
-
|
|
7948
|
-
<details><summary><code>client.connections.connectionToForwarder.<a href="/src/api/resources/connections/resources/connectionToForwarder/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
8046
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataHandleAvailabilityV1</a>(handle) -> boolean</code></summary>
|
|
7949
8047
|
<dl>
|
|
7950
8048
|
<dd>
|
|
7951
8049
|
|
|
@@ -7957,7 +8055,7 @@ await client.connections.connectionToShipper.createV1({
|
|
|
7957
8055
|
<dl>
|
|
7958
8056
|
<dd>
|
|
7959
8057
|
|
|
7960
|
-
|
|
8058
|
+
Returns True when the provided handle is available, otherwise False. | () -> (bool)
|
|
7961
8059
|
|
|
7962
8060
|
</dd>
|
|
7963
8061
|
</dl>
|
|
@@ -7973,9 +8071,7 @@ Creates a new connection to a forwarder organization. Only shippers can initiate
|
|
|
7973
8071
|
<dd>
|
|
7974
8072
|
|
|
7975
8073
|
```typescript
|
|
7976
|
-
await client.
|
|
7977
|
-
handle: "handle",
|
|
7978
|
-
});
|
|
8074
|
+
await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
7979
8075
|
```
|
|
7980
8076
|
|
|
7981
8077
|
</dd>
|
|
@@ -7991,7 +8087,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
7991
8087
|
<dl>
|
|
7992
8088
|
<dd>
|
|
7993
8089
|
|
|
7994
|
-
**
|
|
8090
|
+
**handle:** `string`
|
|
7995
8091
|
|
|
7996
8092
|
</dd>
|
|
7997
8093
|
</dl>
|
|
@@ -7999,7 +8095,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
7999
8095
|
<dl>
|
|
8000
8096
|
<dd>
|
|
8001
8097
|
|
|
8002
|
-
**requestOptions:** `
|
|
8098
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
8003
8099
|
|
|
8004
8100
|
</dd>
|
|
8005
8101
|
</dl>
|
|
@@ -8010,9 +8106,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
8010
8106
|
</dl>
|
|
8011
8107
|
</details>
|
|
8012
8108
|
|
|
8013
|
-
|
|
8014
|
-
|
|
8015
|
-
<details><summary><code>client.courierPayDriverLineItemGroups.addLineItems.<a href="/src/api/resources/courierPayDriverLineItemGroups/resources/addLineItems/client/Client.ts">byIdV1</a>(id, { ...params }) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
|
|
8109
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">setOrgTypeV1</a>({ ...params }) -> boolean</code></summary>
|
|
8016
8110
|
<dl>
|
|
8017
8111
|
<dd>
|
|
8018
8112
|
|
|
@@ -8024,7 +8118,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
8024
8118
|
<dl>
|
|
8025
8119
|
<dd>
|
|
8026
8120
|
|
|
8027
|
-
|
|
8121
|
+
Sets the org_type in Clerk's JWT public metadata. Returns True if already set and matching, sets it if not present, or raises exception if conflicting. | (SetOrgTypeReq) -> (bool)
|
|
8028
8122
|
|
|
8029
8123
|
</dd>
|
|
8030
8124
|
</dl>
|
|
@@ -8040,15 +8134,8 @@ Adds additional line items to an existing courier driver line item group.
|
|
|
8040
8134
|
<dd>
|
|
8041
8135
|
|
|
8042
8136
|
```typescript
|
|
8043
|
-
await client.
|
|
8044
|
-
|
|
8045
|
-
{
|
|
8046
|
-
schema_version: 1,
|
|
8047
|
-
item: "base_rate",
|
|
8048
|
-
quantity: 1.1,
|
|
8049
|
-
rate: 1.1,
|
|
8050
|
-
},
|
|
8051
|
-
],
|
|
8137
|
+
await client.orgs.setOrgTypeV1({
|
|
8138
|
+
org_type: "courier",
|
|
8052
8139
|
});
|
|
8053
8140
|
```
|
|
8054
8141
|
|
|
@@ -8065,7 +8152,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8065
8152
|
<dl>
|
|
8066
8153
|
<dd>
|
|
8067
8154
|
|
|
8068
|
-
**
|
|
8155
|
+
**request:** `Chrt.SetOrgTypeReq`
|
|
8069
8156
|
|
|
8070
8157
|
</dd>
|
|
8071
8158
|
</dl>
|
|
@@ -8073,15 +8160,62 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8073
8160
|
<dl>
|
|
8074
8161
|
<dd>
|
|
8075
8162
|
|
|
8076
|
-
**
|
|
8163
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
8164
|
+
|
|
8165
|
+
</dd>
|
|
8166
|
+
</dl>
|
|
8167
|
+
</dd>
|
|
8168
|
+
</dl>
|
|
8077
8169
|
|
|
8078
8170
|
</dd>
|
|
8079
8171
|
</dl>
|
|
8172
|
+
</details>
|
|
8080
8173
|
|
|
8174
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getStripeConnectAccountIdV1</a>() -> string</code></summary>
|
|
8081
8175
|
<dl>
|
|
8082
8176
|
<dd>
|
|
8083
8177
|
|
|
8084
|
-
|
|
8178
|
+
#### 📝 Description
|
|
8179
|
+
|
|
8180
|
+
<dl>
|
|
8181
|
+
<dd>
|
|
8182
|
+
|
|
8183
|
+
<dl>
|
|
8184
|
+
<dd>
|
|
8185
|
+
|
|
8186
|
+
Retrieves the Stripe Connect account ID for the authenticated organization. Returns 404 if not set. | () -> (str)
|
|
8187
|
+
|
|
8188
|
+
</dd>
|
|
8189
|
+
</dl>
|
|
8190
|
+
</dd>
|
|
8191
|
+
</dl>
|
|
8192
|
+
|
|
8193
|
+
#### 🔌 Usage
|
|
8194
|
+
|
|
8195
|
+
<dl>
|
|
8196
|
+
<dd>
|
|
8197
|
+
|
|
8198
|
+
<dl>
|
|
8199
|
+
<dd>
|
|
8200
|
+
|
|
8201
|
+
```typescript
|
|
8202
|
+
await client.orgs.getStripeConnectAccountIdV1();
|
|
8203
|
+
```
|
|
8204
|
+
|
|
8205
|
+
</dd>
|
|
8206
|
+
</dl>
|
|
8207
|
+
</dd>
|
|
8208
|
+
</dl>
|
|
8209
|
+
|
|
8210
|
+
#### ⚙️ Parameters
|
|
8211
|
+
|
|
8212
|
+
<dl>
|
|
8213
|
+
<dd>
|
|
8214
|
+
|
|
8215
|
+
<dl>
|
|
8216
|
+
<dd>
|
|
8217
|
+
|
|
8218
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
8085
8219
|
|
|
8086
8220
|
</dd>
|
|
8087
8221
|
</dl>
|
|
@@ -8092,9 +8226,9 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8092
8226
|
</dl>
|
|
8093
8227
|
</details>
|
|
8094
8228
|
|
|
8095
|
-
##
|
|
8229
|
+
## Root
|
|
8096
8230
|
|
|
8097
|
-
<details><summary><code>client.
|
|
8231
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingAuthd</a>() -> Record<string, string></code></summary>
|
|
8098
8232
|
<dl>
|
|
8099
8233
|
<dd>
|
|
8100
8234
|
|
|
@@ -8106,7 +8240,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8106
8240
|
<dl>
|
|
8107
8241
|
<dd>
|
|
8108
8242
|
|
|
8109
|
-
|
|
8243
|
+
Test endpoint for authenticated requests that requires valid authentication tokens. | () -> (dict[str, str])
|
|
8110
8244
|
|
|
8111
8245
|
</dd>
|
|
8112
8246
|
</dl>
|
|
@@ -8122,9 +8256,7 @@ Removes specific line items from a courier driver line item group by their UUID
|
|
|
8122
8256
|
<dd>
|
|
8123
8257
|
|
|
8124
8258
|
```typescript
|
|
8125
|
-
await client.
|
|
8126
|
-
line_item_uuid_strs: ["line_item_uuid_strs"],
|
|
8127
|
-
});
|
|
8259
|
+
await client.root.pingAuthd();
|
|
8128
8260
|
```
|
|
8129
8261
|
|
|
8130
8262
|
</dd>
|
|
@@ -8140,23 +8272,117 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8140
8272
|
<dl>
|
|
8141
8273
|
<dd>
|
|
8142
8274
|
|
|
8143
|
-
**
|
|
8275
|
+
**requestOptions:** `Root.RequestOptions`
|
|
8276
|
+
|
|
8277
|
+
</dd>
|
|
8278
|
+
</dl>
|
|
8279
|
+
</dd>
|
|
8280
|
+
</dl>
|
|
8281
|
+
|
|
8282
|
+
</dd>
|
|
8283
|
+
</dl>
|
|
8284
|
+
</details>
|
|
8285
|
+
|
|
8286
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingOptionallyAuthd</a>() -> Record<string, unknown></code></summary>
|
|
8287
|
+
<dl>
|
|
8288
|
+
<dd>
|
|
8289
|
+
|
|
8290
|
+
#### 📝 Description
|
|
8291
|
+
|
|
8292
|
+
<dl>
|
|
8293
|
+
<dd>
|
|
8294
|
+
|
|
8295
|
+
<dl>
|
|
8296
|
+
<dd>
|
|
8297
|
+
|
|
8298
|
+
Test endpoint for optionally authenticated requests that works with or without authentication. | () -> (dict)
|
|
8299
|
+
|
|
8300
|
+
</dd>
|
|
8301
|
+
</dl>
|
|
8302
|
+
</dd>
|
|
8303
|
+
</dl>
|
|
8304
|
+
|
|
8305
|
+
#### 🔌 Usage
|
|
8306
|
+
|
|
8307
|
+
<dl>
|
|
8308
|
+
<dd>
|
|
8309
|
+
|
|
8310
|
+
<dl>
|
|
8311
|
+
<dd>
|
|
8312
|
+
|
|
8313
|
+
```typescript
|
|
8314
|
+
await client.root.pingOptionallyAuthd();
|
|
8315
|
+
```
|
|
8316
|
+
|
|
8317
|
+
</dd>
|
|
8318
|
+
</dl>
|
|
8319
|
+
</dd>
|
|
8320
|
+
</dl>
|
|
8321
|
+
|
|
8322
|
+
#### ⚙️ Parameters
|
|
8323
|
+
|
|
8324
|
+
<dl>
|
|
8325
|
+
<dd>
|
|
8326
|
+
|
|
8327
|
+
<dl>
|
|
8328
|
+
<dd>
|
|
8329
|
+
|
|
8330
|
+
**requestOptions:** `Root.RequestOptions`
|
|
8331
|
+
|
|
8332
|
+
</dd>
|
|
8333
|
+
</dl>
|
|
8334
|
+
</dd>
|
|
8335
|
+
</dl>
|
|
8336
|
+
|
|
8337
|
+
</dd>
|
|
8338
|
+
</dl>
|
|
8339
|
+
</details>
|
|
8340
|
+
|
|
8341
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingUnauthd</a>() -> Record<string, unknown></code></summary>
|
|
8342
|
+
<dl>
|
|
8343
|
+
<dd>
|
|
8344
|
+
|
|
8345
|
+
#### 📝 Description
|
|
8346
|
+
|
|
8347
|
+
<dl>
|
|
8348
|
+
<dd>
|
|
8349
|
+
|
|
8350
|
+
<dl>
|
|
8351
|
+
<dd>
|
|
8352
|
+
|
|
8353
|
+
Returns a greeting message to verify the API is accessible. | () -> (dict)
|
|
8354
|
+
|
|
8355
|
+
</dd>
|
|
8356
|
+
</dl>
|
|
8357
|
+
</dd>
|
|
8358
|
+
</dl>
|
|
8359
|
+
|
|
8360
|
+
#### 🔌 Usage
|
|
8361
|
+
|
|
8362
|
+
<dl>
|
|
8363
|
+
<dd>
|
|
8364
|
+
|
|
8365
|
+
<dl>
|
|
8366
|
+
<dd>
|
|
8367
|
+
|
|
8368
|
+
```typescript
|
|
8369
|
+
await client.root.pingUnauthd();
|
|
8370
|
+
```
|
|
8144
8371
|
|
|
8145
8372
|
</dd>
|
|
8146
8373
|
</dl>
|
|
8374
|
+
</dd>
|
|
8375
|
+
</dl>
|
|
8376
|
+
|
|
8377
|
+
#### ⚙️ Parameters
|
|
8147
8378
|
|
|
8148
8379
|
<dl>
|
|
8149
8380
|
<dd>
|
|
8150
8381
|
|
|
8151
|
-
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupRemoveLineItemsReq`
|
|
8152
|
-
|
|
8153
|
-
</dd>
|
|
8154
|
-
</dl>
|
|
8155
|
-
|
|
8156
8382
|
<dl>
|
|
8157
8383
|
<dd>
|
|
8158
8384
|
|
|
8159
|
-
**requestOptions:** `
|
|
8385
|
+
**requestOptions:** `Root.RequestOptions`
|
|
8160
8386
|
|
|
8161
8387
|
</dd>
|
|
8162
8388
|
</dl>
|
|
@@ -8167,9 +8393,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8167
8393
|
</dl>
|
|
8168
8394
|
</details>
|
|
8169
8395
|
|
|
8170
|
-
|
|
8171
|
-
|
|
8172
|
-
<details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">getPreferencesV1</a>() -> Chrt.ShipperNotificationPreferences1</code></summary>
|
|
8396
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> Record<string, unknown></code></summary>
|
|
8173
8397
|
<dl>
|
|
8174
8398
|
<dd>
|
|
8175
8399
|
|
|
@@ -8181,7 +8405,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8181
8405
|
<dl>
|
|
8182
8406
|
<dd>
|
|
8183
8407
|
|
|
8184
|
-
|
|
8408
|
+
Returns a health status message used for monitoring system availability and uptime. | () -> (dict)
|
|
8185
8409
|
|
|
8186
8410
|
</dd>
|
|
8187
8411
|
</dl>
|
|
@@ -8197,7 +8421,7 @@ Retrieves notification preferences for the authenticated shipper organization. |
|
|
|
8197
8421
|
<dd>
|
|
8198
8422
|
|
|
8199
8423
|
```typescript
|
|
8200
|
-
await client.
|
|
8424
|
+
await client.root.health();
|
|
8201
8425
|
```
|
|
8202
8426
|
|
|
8203
8427
|
</dd>
|
|
@@ -8213,7 +8437,7 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
8213
8437
|
<dl>
|
|
8214
8438
|
<dd>
|
|
8215
8439
|
|
|
8216
|
-
**requestOptions:** `
|
|
8440
|
+
**requestOptions:** `Root.RequestOptions`
|
|
8217
8441
|
|
|
8218
8442
|
</dd>
|
|
8219
8443
|
</dl>
|
|
@@ -8224,7 +8448,7 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
8224
8448
|
</dl>
|
|
8225
8449
|
</details>
|
|
8226
8450
|
|
|
8227
|
-
<details><summary><code>client.
|
|
8451
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">failure</a>() -> unknown</code></summary>
|
|
8228
8452
|
<dl>
|
|
8229
8453
|
<dd>
|
|
8230
8454
|
|
|
@@ -8236,7 +8460,7 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
8236
8460
|
<dl>
|
|
8237
8461
|
<dd>
|
|
8238
8462
|
|
|
8239
|
-
|
|
8463
|
+
Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)
|
|
8240
8464
|
|
|
8241
8465
|
</dd>
|
|
8242
8466
|
</dl>
|
|
@@ -8252,9 +8476,7 @@ Creates or updates notification preferences for the authenticated shipper organi
|
|
|
8252
8476
|
<dd>
|
|
8253
8477
|
|
|
8254
8478
|
```typescript
|
|
8255
|
-
await client.
|
|
8256
|
-
schema_version: 1,
|
|
8257
|
-
});
|
|
8479
|
+
await client.root.failure();
|
|
8258
8480
|
```
|
|
8259
8481
|
|
|
8260
8482
|
</dd>
|
|
@@ -8270,15 +8492,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
8270
8492
|
<dl>
|
|
8271
8493
|
<dd>
|
|
8272
8494
|
|
|
8273
|
-
**
|
|
8274
|
-
|
|
8275
|
-
</dd>
|
|
8276
|
-
</dl>
|
|
8277
|
-
|
|
8278
|
-
<dl>
|
|
8279
|
-
<dd>
|
|
8280
|
-
|
|
8281
|
-
**requestOptions:** `Shipper.RequestOptions`
|
|
8495
|
+
**requestOptions:** `Root.RequestOptions`
|
|
8282
8496
|
|
|
8283
8497
|
</dd>
|
|
8284
8498
|
</dl>
|
|
@@ -8289,9 +8503,9 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
8289
8503
|
</dl>
|
|
8290
8504
|
</details>
|
|
8291
8505
|
|
|
8292
|
-
##
|
|
8506
|
+
## Users
|
|
8293
8507
|
|
|
8294
|
-
<details><summary><code>client.
|
|
8508
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPublicDataV1</a>() -> Chrt.UserPublicData1</code></summary>
|
|
8295
8509
|
<dl>
|
|
8296
8510
|
<dd>
|
|
8297
8511
|
|
|
@@ -8303,7 +8517,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
8303
8517
|
<dl>
|
|
8304
8518
|
<dd>
|
|
8305
8519
|
|
|
8306
|
-
Retrieves
|
|
8520
|
+
Retrieves public user data for the authenticated user. | () -> (UserPublicData1)
|
|
8307
8521
|
|
|
8308
8522
|
</dd>
|
|
8309
8523
|
</dl>
|
|
@@ -8319,7 +8533,7 @@ Retrieves notification preferences for the authenticated courier organization. |
|
|
|
8319
8533
|
<dd>
|
|
8320
8534
|
|
|
8321
8535
|
```typescript
|
|
8322
|
-
await client.
|
|
8536
|
+
await client.users.getUserPublicDataV1();
|
|
8323
8537
|
```
|
|
8324
8538
|
|
|
8325
8539
|
</dd>
|
|
@@ -8335,7 +8549,7 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
8335
8549
|
<dl>
|
|
8336
8550
|
<dd>
|
|
8337
8551
|
|
|
8338
|
-
**requestOptions:** `
|
|
8552
|
+
**requestOptions:** `Users.RequestOptions`
|
|
8339
8553
|
|
|
8340
8554
|
</dd>
|
|
8341
8555
|
</dl>
|
|
@@ -8346,7 +8560,9 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
8346
8560
|
</dl>
|
|
8347
8561
|
</details>
|
|
8348
8562
|
|
|
8349
|
-
|
|
8563
|
+
## Utils
|
|
8564
|
+
|
|
8565
|
+
<details><summary><code>client.utils.<a href="/src/api/resources/utils/client/Client.ts">getTimezoneV1</a>({ ...params }) -> Chrt.TimezoneResponse</code></summary>
|
|
8350
8566
|
<dl>
|
|
8351
8567
|
<dd>
|
|
8352
8568
|
|
|
@@ -8358,7 +8574,7 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
8358
8574
|
<dl>
|
|
8359
8575
|
<dd>
|
|
8360
8576
|
|
|
8361
|
-
|
|
8577
|
+
Returns the IANA timezone identifier (e.g., 'America/Los_Angeles') for the given latitude and longitude coordinates. Falls back to closest timezone if the point is in the ocean or at an edge. | () -> (TimezoneResponse)
|
|
8362
8578
|
|
|
8363
8579
|
</dd>
|
|
8364
8580
|
</dl>
|
|
@@ -8374,8 +8590,9 @@ Creates or updates notification preferences for the authenticated courier organi
|
|
|
8374
8590
|
<dd>
|
|
8375
8591
|
|
|
8376
8592
|
```typescript
|
|
8377
|
-
await client.
|
|
8378
|
-
|
|
8593
|
+
await client.utils.getTimezoneV1({
|
|
8594
|
+
lat: 37.7749,
|
|
8595
|
+
lng: -122.4194,
|
|
8379
8596
|
});
|
|
8380
8597
|
```
|
|
8381
8598
|
|
|
@@ -8392,7 +8609,7 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
8392
8609
|
<dl>
|
|
8393
8610
|
<dd>
|
|
8394
8611
|
|
|
8395
|
-
**request:** `Chrt.
|
|
8612
|
+
**request:** `Chrt.UtilsGetTimezoneV1Request`
|
|
8396
8613
|
|
|
8397
8614
|
</dd>
|
|
8398
8615
|
</dl>
|
|
@@ -8400,7 +8617,7 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
8400
8617
|
<dl>
|
|
8401
8618
|
<dd>
|
|
8402
8619
|
|
|
8403
|
-
**requestOptions:** `
|
|
8620
|
+
**requestOptions:** `Utils.RequestOptions`
|
|
8404
8621
|
|
|
8405
8622
|
</dd>
|
|
8406
8623
|
</dl>
|
|
@@ -8411,9 +8628,9 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
8411
8628
|
</dl>
|
|
8412
8629
|
</details>
|
|
8413
8630
|
|
|
8414
|
-
##
|
|
8631
|
+
## Connections ConnectionToCourier
|
|
8415
8632
|
|
|
8416
|
-
<details><summary><code>client.
|
|
8633
|
+
<details><summary><code>client.connections.connectionToCourier.<a href="/src/api/resources/connections/resources/connectionToCourier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
8417
8634
|
<dl>
|
|
8418
8635
|
<dd>
|
|
8419
8636
|
|
|
@@ -8425,7 +8642,7 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
8425
8642
|
<dl>
|
|
8426
8643
|
<dd>
|
|
8427
8644
|
|
|
8428
|
-
|
|
8645
|
+
Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers. | (CreateConnectionReq) -> (PydanticObjectId)
|
|
8429
8646
|
|
|
8430
8647
|
</dd>
|
|
8431
8648
|
</dl>
|
|
@@ -8441,9 +8658,8 @@ Adds a task group to an existing order draft. Validates order is in DRAFT status
|
|
|
8441
8658
|
<dd>
|
|
8442
8659
|
|
|
8443
8660
|
```typescript
|
|
8444
|
-
await client.
|
|
8445
|
-
|
|
8446
|
-
order_id: "order_id",
|
|
8661
|
+
await client.connections.connectionToCourier.createV1({
|
|
8662
|
+
handle: "handle",
|
|
8447
8663
|
});
|
|
8448
8664
|
```
|
|
8449
8665
|
|
|
@@ -8460,7 +8676,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
8460
8676
|
<dl>
|
|
8461
8677
|
<dd>
|
|
8462
8678
|
|
|
8463
|
-
**request:** `Chrt.
|
|
8679
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
8464
8680
|
|
|
8465
8681
|
</dd>
|
|
8466
8682
|
</dl>
|
|
@@ -8468,7 +8684,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
8468
8684
|
<dl>
|
|
8469
8685
|
<dd>
|
|
8470
8686
|
|
|
8471
|
-
**requestOptions:** `
|
|
8687
|
+
**requestOptions:** `ConnectionToCourier.RequestOptions`
|
|
8472
8688
|
|
|
8473
8689
|
</dd>
|
|
8474
8690
|
</dl>
|
|
@@ -8479,7 +8695,9 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
8479
8695
|
</dl>
|
|
8480
8696
|
</details>
|
|
8481
8697
|
|
|
8482
|
-
|
|
8698
|
+
## Connections ConnectionToShipper
|
|
8699
|
+
|
|
8700
|
+
<details><summary><code>client.connections.connectionToShipper.<a href="/src/api/resources/connections/resources/connectionToShipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
8483
8701
|
<dl>
|
|
8484
8702
|
<dd>
|
|
8485
8703
|
|
|
@@ -8491,7 +8709,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
8491
8709
|
<dl>
|
|
8492
8710
|
<dd>
|
|
8493
8711
|
|
|
8494
|
-
|
|
8712
|
+
Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)
|
|
8495
8713
|
|
|
8496
8714
|
</dd>
|
|
8497
8715
|
</dl>
|
|
@@ -8507,7 +8725,9 @@ Sets or removes courier org. Sets task ordering (must provide all task ids). | (
|
|
|
8507
8725
|
<dd>
|
|
8508
8726
|
|
|
8509
8727
|
```typescript
|
|
8510
|
-
await client.
|
|
8728
|
+
await client.connections.connectionToShipper.createV1({
|
|
8729
|
+
handle: "handle",
|
|
8730
|
+
});
|
|
8511
8731
|
```
|
|
8512
8732
|
|
|
8513
8733
|
</dd>
|
|
@@ -8523,15 +8743,7 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
8523
8743
|
<dl>
|
|
8524
8744
|
<dd>
|
|
8525
8745
|
|
|
8526
|
-
**
|
|
8527
|
-
|
|
8528
|
-
</dd>
|
|
8529
|
-
</dl>
|
|
8530
|
-
|
|
8531
|
-
<dl>
|
|
8532
|
-
<dd>
|
|
8533
|
-
|
|
8534
|
-
**request:** `Chrt.orderDrafts.UpdateTaskGroupDraftReq`
|
|
8746
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
8535
8747
|
|
|
8536
8748
|
</dd>
|
|
8537
8749
|
</dl>
|
|
@@ -8539,7 +8751,7 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
8539
8751
|
<dl>
|
|
8540
8752
|
<dd>
|
|
8541
8753
|
|
|
8542
|
-
**requestOptions:** `
|
|
8754
|
+
**requestOptions:** `ConnectionToShipper.RequestOptions`
|
|
8543
8755
|
|
|
8544
8756
|
</dd>
|
|
8545
8757
|
</dl>
|
|
@@ -8550,7 +8762,9 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
8550
8762
|
</dl>
|
|
8551
8763
|
</details>
|
|
8552
8764
|
|
|
8553
|
-
|
|
8765
|
+
## Connections ConnectionToForwarder
|
|
8766
|
+
|
|
8767
|
+
<details><summary><code>client.connections.connectionToForwarder.<a href="/src/api/resources/connections/resources/connectionToForwarder/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
8554
8768
|
<dl>
|
|
8555
8769
|
<dd>
|
|
8556
8770
|
|
|
@@ -8562,7 +8776,7 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
8562
8776
|
<dl>
|
|
8563
8777
|
<dd>
|
|
8564
8778
|
|
|
8565
|
-
|
|
8779
|
+
Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders. | (CreateConnectionReq) -> (PydanticObjectId)
|
|
8566
8780
|
|
|
8567
8781
|
</dd>
|
|
8568
8782
|
</dl>
|
|
@@ -8578,7 +8792,9 @@ Deletes a task group and all associated entities (tasks, task artifacts, S3 meta
|
|
|
8578
8792
|
<dd>
|
|
8579
8793
|
|
|
8580
8794
|
```typescript
|
|
8581
|
-
await client.
|
|
8795
|
+
await client.connections.connectionToForwarder.createV1({
|
|
8796
|
+
handle: "handle",
|
|
8797
|
+
});
|
|
8582
8798
|
```
|
|
8583
8799
|
|
|
8584
8800
|
</dd>
|
|
@@ -8594,7 +8810,7 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
8594
8810
|
<dl>
|
|
8595
8811
|
<dd>
|
|
8596
8812
|
|
|
8597
|
-
**
|
|
8813
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
8598
8814
|
|
|
8599
8815
|
</dd>
|
|
8600
8816
|
</dl>
|
|
@@ -8602,7 +8818,7 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
8602
8818
|
<dl>
|
|
8603
8819
|
<dd>
|
|
8604
8820
|
|
|
8605
|
-
**requestOptions:** `
|
|
8821
|
+
**requestOptions:** `ConnectionToForwarder.RequestOptions`
|
|
8606
8822
|
|
|
8607
8823
|
</dd>
|
|
8608
8824
|
</dl>
|
|
@@ -8613,9 +8829,9 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
8613
8829
|
</dl>
|
|
8614
8830
|
</details>
|
|
8615
8831
|
|
|
8616
|
-
##
|
|
8832
|
+
## CourierPayDriverLineItemGroups AddLineItems
|
|
8617
8833
|
|
|
8618
|
-
<details><summary><code>client.
|
|
8834
|
+
<details><summary><code>client.courierPayDriverLineItemGroups.addLineItems.<a href="/src/api/resources/courierPayDriverLineItemGroups/resources/addLineItems/client/Client.ts">byIdV1</a>(id, { ...params }) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
|
|
8619
8835
|
<dl>
|
|
8620
8836
|
<dd>
|
|
8621
8837
|
|
|
@@ -8627,7 +8843,7 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
8627
8843
|
<dl>
|
|
8628
8844
|
<dd>
|
|
8629
8845
|
|
|
8630
|
-
Adds
|
|
8846
|
+
Adds additional line items to an existing courier driver line item group.
|
|
8631
8847
|
|
|
8632
8848
|
</dd>
|
|
8633
8849
|
</dl>
|
|
@@ -8643,11 +8859,15 @@ Adds a task to an existing task group in a draft order. Validates order is in DR
|
|
|
8643
8859
|
<dd>
|
|
8644
8860
|
|
|
8645
8861
|
```typescript
|
|
8646
|
-
await client.
|
|
8647
|
-
|
|
8648
|
-
|
|
8649
|
-
|
|
8650
|
-
|
|
8862
|
+
await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
8863
|
+
line_items: [
|
|
8864
|
+
{
|
|
8865
|
+
schema_version: 1,
|
|
8866
|
+
item: "base_rate",
|
|
8867
|
+
quantity: 1.1,
|
|
8868
|
+
rate: 1.1,
|
|
8869
|
+
},
|
|
8870
|
+
],
|
|
8651
8871
|
});
|
|
8652
8872
|
```
|
|
8653
8873
|
|
|
@@ -8664,7 +8884,7 @@ await client.orderDrafts.task.addV1({
|
|
|
8664
8884
|
<dl>
|
|
8665
8885
|
<dd>
|
|
8666
8886
|
|
|
8667
|
-
**
|
|
8887
|
+
**id:** `string`
|
|
8668
8888
|
|
|
8669
8889
|
</dd>
|
|
8670
8890
|
</dl>
|
|
@@ -8672,7 +8892,15 @@ await client.orderDrafts.task.addV1({
|
|
|
8672
8892
|
<dl>
|
|
8673
8893
|
<dd>
|
|
8674
8894
|
|
|
8675
|
-
**
|
|
8895
|
+
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupAddLineItemsReq`
|
|
8896
|
+
|
|
8897
|
+
</dd>
|
|
8898
|
+
</dl>
|
|
8899
|
+
|
|
8900
|
+
<dl>
|
|
8901
|
+
<dd>
|
|
8902
|
+
|
|
8903
|
+
**requestOptions:** `AddLineItems.RequestOptions`
|
|
8676
8904
|
|
|
8677
8905
|
</dd>
|
|
8678
8906
|
</dl>
|
|
@@ -8683,7 +8911,9 @@ await client.orderDrafts.task.addV1({
|
|
|
8683
8911
|
</dl>
|
|
8684
8912
|
</details>
|
|
8685
8913
|
|
|
8686
|
-
|
|
8914
|
+
## CourierPayDriverLineItemGroups RemoveLineItems
|
|
8915
|
+
|
|
8916
|
+
<details><summary><code>client.courierPayDriverLineItemGroups.removeLineItems.<a href="/src/api/resources/courierPayDriverLineItemGroups/resources/removeLineItems/client/Client.ts">byIdV1</a>(id, { ...params }) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
|
|
8687
8917
|
<dl>
|
|
8688
8918
|
<dd>
|
|
8689
8919
|
|
|
@@ -8695,7 +8925,7 @@ await client.orderDrafts.task.addV1({
|
|
|
8695
8925
|
<dl>
|
|
8696
8926
|
<dd>
|
|
8697
8927
|
|
|
8698
|
-
|
|
8928
|
+
Removes specific line items from a courier driver line item group by their UUID identifiers.
|
|
8699
8929
|
|
|
8700
8930
|
</dd>
|
|
8701
8931
|
</dl>
|
|
@@ -8711,9 +8941,8 @@ Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (Pydan
|
|
|
8711
8941
|
<dd>
|
|
8712
8942
|
|
|
8713
8943
|
```typescript
|
|
8714
|
-
await client.
|
|
8715
|
-
|
|
8716
|
-
task_update: {},
|
|
8944
|
+
await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
8945
|
+
line_item_uuid_strs: ["line_item_uuid_strs"],
|
|
8717
8946
|
});
|
|
8718
8947
|
```
|
|
8719
8948
|
|
|
@@ -8730,7 +8959,7 @@ await client.orderDrafts.task.updateV1({
|
|
|
8730
8959
|
<dl>
|
|
8731
8960
|
<dd>
|
|
8732
8961
|
|
|
8733
|
-
**
|
|
8962
|
+
**id:** `string`
|
|
8734
8963
|
|
|
8735
8964
|
</dd>
|
|
8736
8965
|
</dl>
|
|
@@ -8738,7 +8967,15 @@ await client.orderDrafts.task.updateV1({
|
|
|
8738
8967
|
<dl>
|
|
8739
8968
|
<dd>
|
|
8740
8969
|
|
|
8741
|
-
**
|
|
8970
|
+
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupRemoveLineItemsReq`
|
|
8971
|
+
|
|
8972
|
+
</dd>
|
|
8973
|
+
</dl>
|
|
8974
|
+
|
|
8975
|
+
<dl>
|
|
8976
|
+
<dd>
|
|
8977
|
+
|
|
8978
|
+
**requestOptions:** `RemoveLineItems.RequestOptions`
|
|
8742
8979
|
|
|
8743
8980
|
</dd>
|
|
8744
8981
|
</dl>
|
|
@@ -8749,7 +8986,9 @@ await client.orderDrafts.task.updateV1({
|
|
|
8749
8986
|
</dl>
|
|
8750
8987
|
</details>
|
|
8751
8988
|
|
|
8752
|
-
|
|
8989
|
+
## Notifications Shipper
|
|
8990
|
+
|
|
8991
|
+
<details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">getPreferencesV1</a>() -> Chrt.ShipperNotificationPreferences1</code></summary>
|
|
8753
8992
|
<dl>
|
|
8754
8993
|
<dd>
|
|
8755
8994
|
|
|
@@ -8761,7 +9000,7 @@ await client.orderDrafts.task.updateV1({
|
|
|
8761
9000
|
<dl>
|
|
8762
9001
|
<dd>
|
|
8763
9002
|
|
|
8764
|
-
|
|
9003
|
+
Retrieves notification preferences for the authenticated shipper organization. | () -> (ShipperNotificationPreferences1)
|
|
8765
9004
|
|
|
8766
9005
|
</dd>
|
|
8767
9006
|
</dl>
|
|
@@ -8777,7 +9016,7 @@ Deletes a task from a draft order, including all task artifacts. Cargo is preser
|
|
|
8777
9016
|
<dd>
|
|
8778
9017
|
|
|
8779
9018
|
```typescript
|
|
8780
|
-
await client.
|
|
9019
|
+
await client.notifications.shipper.getPreferencesV1();
|
|
8781
9020
|
```
|
|
8782
9021
|
|
|
8783
9022
|
</dd>
|
|
@@ -8793,15 +9032,7 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
8793
9032
|
<dl>
|
|
8794
9033
|
<dd>
|
|
8795
9034
|
|
|
8796
|
-
**
|
|
8797
|
-
|
|
8798
|
-
</dd>
|
|
8799
|
-
</dl>
|
|
8800
|
-
|
|
8801
|
-
<dl>
|
|
8802
|
-
<dd>
|
|
8803
|
-
|
|
8804
|
-
**requestOptions:** `Task.RequestOptions`
|
|
9035
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
8805
9036
|
|
|
8806
9037
|
</dd>
|
|
8807
9038
|
</dl>
|
|
@@ -8812,9 +9043,7 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
8812
9043
|
</dl>
|
|
8813
9044
|
</details>
|
|
8814
9045
|
|
|
8815
|
-
|
|
8816
|
-
|
|
8817
|
-
<details><summary><code>client.orderDrafts.taskArtifact.<a href="/src/api/resources/orderDrafts/resources/taskArtifact/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9046
|
+
<details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">upsertPreferencesV1</a>({ ...params }) -> string</code></summary>
|
|
8818
9047
|
<dl>
|
|
8819
9048
|
<dd>
|
|
8820
9049
|
|
|
@@ -8826,7 +9055,7 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
8826
9055
|
<dl>
|
|
8827
9056
|
<dd>
|
|
8828
9057
|
|
|
8829
|
-
|
|
9058
|
+
Creates or updates notification preferences for the authenticated shipper organization. | (ShipperNotificationPreferencesClientCreate1) -> (PydanticObjectId)
|
|
8830
9059
|
|
|
8831
9060
|
</dd>
|
|
8832
9061
|
</dl>
|
|
@@ -8842,9 +9071,8 @@ Adds a task artifact to an existing task in a draft order. | (OrderDraftAddTaskA
|
|
|
8842
9071
|
<dd>
|
|
8843
9072
|
|
|
8844
9073
|
```typescript
|
|
8845
|
-
await client.
|
|
8846
|
-
|
|
8847
|
-
task_artifact_type: "image",
|
|
9074
|
+
await client.notifications.shipper.upsertPreferencesV1({
|
|
9075
|
+
schema_version: 1,
|
|
8848
9076
|
});
|
|
8849
9077
|
```
|
|
8850
9078
|
|
|
@@ -8861,7 +9089,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
8861
9089
|
<dl>
|
|
8862
9090
|
<dd>
|
|
8863
9091
|
|
|
8864
|
-
**request:** `Chrt.
|
|
9092
|
+
**request:** `Chrt.notifications.ShipperNotificationPreferencesClientCreate1`
|
|
8865
9093
|
|
|
8866
9094
|
</dd>
|
|
8867
9095
|
</dl>
|
|
@@ -8869,7 +9097,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
8869
9097
|
<dl>
|
|
8870
9098
|
<dd>
|
|
8871
9099
|
|
|
8872
|
-
**requestOptions:** `
|
|
9100
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
8873
9101
|
|
|
8874
9102
|
</dd>
|
|
8875
9103
|
</dl>
|
|
@@ -8880,7 +9108,9 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
8880
9108
|
</dl>
|
|
8881
9109
|
</details>
|
|
8882
9110
|
|
|
8883
|
-
|
|
9111
|
+
## Notifications Courier
|
|
9112
|
+
|
|
9113
|
+
<details><summary><code>client.notifications.courier.<a href="/src/api/resources/notifications/resources/courier/client/Client.ts">getPreferencesV1</a>() -> Chrt.CourierNotificationPreferences1</code></summary>
|
|
8884
9114
|
<dl>
|
|
8885
9115
|
<dd>
|
|
8886
9116
|
|
|
@@ -8892,7 +9122,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
8892
9122
|
<dl>
|
|
8893
9123
|
<dd>
|
|
8894
9124
|
|
|
8895
|
-
|
|
9125
|
+
Retrieves notification preferences for the authenticated courier organization. | () -> (CourierNotificationPreferences1)
|
|
8896
9126
|
|
|
8897
9127
|
</dd>
|
|
8898
9128
|
</dl>
|
|
@@ -8908,7 +9138,7 @@ Deletes a task artifact from a draft order and removes it from the associated ta
|
|
|
8908
9138
|
<dd>
|
|
8909
9139
|
|
|
8910
9140
|
```typescript
|
|
8911
|
-
await client.
|
|
9141
|
+
await client.notifications.courier.getPreferencesV1();
|
|
8912
9142
|
```
|
|
8913
9143
|
|
|
8914
9144
|
</dd>
|
|
@@ -8924,15 +9154,7 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
8924
9154
|
<dl>
|
|
8925
9155
|
<dd>
|
|
8926
9156
|
|
|
8927
|
-
**
|
|
8928
|
-
|
|
8929
|
-
</dd>
|
|
8930
|
-
</dl>
|
|
8931
|
-
|
|
8932
|
-
<dl>
|
|
8933
|
-
<dd>
|
|
8934
|
-
|
|
8935
|
-
**requestOptions:** `TaskArtifact.RequestOptions`
|
|
9157
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
8936
9158
|
|
|
8937
9159
|
</dd>
|
|
8938
9160
|
</dl>
|
|
@@ -8943,9 +9165,7 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
8943
9165
|
</dl>
|
|
8944
9166
|
</details>
|
|
8945
9167
|
|
|
8946
|
-
|
|
8947
|
-
|
|
8948
|
-
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9168
|
+
<details><summary><code>client.notifications.courier.<a href="/src/api/resources/notifications/resources/courier/client/Client.ts">upsertPreferencesV1</a>({ ...params }) -> string</code></summary>
|
|
8949
9169
|
<dl>
|
|
8950
9170
|
<dd>
|
|
8951
9171
|
|
|
@@ -8957,7 +9177,7 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
8957
9177
|
<dl>
|
|
8958
9178
|
<dd>
|
|
8959
9179
|
|
|
8960
|
-
|
|
9180
|
+
Creates or updates notification preferences for the authenticated courier organization. | (CourierNotificationPreferencesClientCreate1) -> (PydanticObjectId)
|
|
8961
9181
|
|
|
8962
9182
|
</dd>
|
|
8963
9183
|
</dl>
|
|
@@ -8973,12 +9193,8 @@ Adds a cargo item to an existing draft order. Validates order is in DRAFT status
|
|
|
8973
9193
|
<dd>
|
|
8974
9194
|
|
|
8975
9195
|
```typescript
|
|
8976
|
-
await client.
|
|
8977
|
-
|
|
8978
|
-
cargo: {
|
|
8979
|
-
schema_version: 1,
|
|
8980
|
-
cargo_type: "spare_parts",
|
|
8981
|
-
},
|
|
9196
|
+
await client.notifications.courier.upsertPreferencesV1({
|
|
9197
|
+
schema_version: 1,
|
|
8982
9198
|
});
|
|
8983
9199
|
```
|
|
8984
9200
|
|
|
@@ -8995,7 +9211,7 @@ await client.orderDrafts.cargo.addV1({
|
|
|
8995
9211
|
<dl>
|
|
8996
9212
|
<dd>
|
|
8997
9213
|
|
|
8998
|
-
**request:** `Chrt.
|
|
9214
|
+
**request:** `Chrt.notifications.CourierNotificationPreferencesClientCreate1`
|
|
8999
9215
|
|
|
9000
9216
|
</dd>
|
|
9001
9217
|
</dl>
|
|
@@ -9003,7 +9219,7 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9003
9219
|
<dl>
|
|
9004
9220
|
<dd>
|
|
9005
9221
|
|
|
9006
|
-
**requestOptions:** `
|
|
9222
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
9007
9223
|
|
|
9008
9224
|
</dd>
|
|
9009
9225
|
</dl>
|
|
@@ -9014,7 +9230,9 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9014
9230
|
</dl>
|
|
9015
9231
|
</details>
|
|
9016
9232
|
|
|
9017
|
-
|
|
9233
|
+
## OrderDrafts TaskGroup
|
|
9234
|
+
|
|
9235
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9018
9236
|
<dl>
|
|
9019
9237
|
<dd>
|
|
9020
9238
|
|
|
@@ -9026,7 +9244,7 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9026
9244
|
<dl>
|
|
9027
9245
|
<dd>
|
|
9028
9246
|
|
|
9029
|
-
|
|
9247
|
+
Adds a task group to an existing order draft. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddTaskGroupReq) -> (PydanticObjectId)
|
|
9030
9248
|
|
|
9031
9249
|
</dd>
|
|
9032
9250
|
</dl>
|
|
@@ -9042,10 +9260,9 @@ Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCa
|
|
|
9042
9260
|
<dd>
|
|
9043
9261
|
|
|
9044
9262
|
```typescript
|
|
9045
|
-
await client.orderDrafts.
|
|
9263
|
+
await client.orderDrafts.taskGroup.addV1({
|
|
9264
|
+
task_group_type: "chrt_ground_courier",
|
|
9046
9265
|
order_id: "order_id",
|
|
9047
|
-
task_id: "task_id",
|
|
9048
|
-
cargo_id: "cargo_id",
|
|
9049
9266
|
});
|
|
9050
9267
|
```
|
|
9051
9268
|
|
|
@@ -9062,7 +9279,7 @@ await client.orderDrafts.cargo.associateWithTaskV1({
|
|
|
9062
9279
|
<dl>
|
|
9063
9280
|
<dd>
|
|
9064
9281
|
|
|
9065
|
-
**request:** `Chrt.orderDrafts.
|
|
9282
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskGroupReq`
|
|
9066
9283
|
|
|
9067
9284
|
</dd>
|
|
9068
9285
|
</dl>
|
|
@@ -9070,7 +9287,7 @@ await client.orderDrafts.cargo.associateWithTaskV1({
|
|
|
9070
9287
|
<dl>
|
|
9071
9288
|
<dd>
|
|
9072
9289
|
|
|
9073
|
-
**requestOptions:** `
|
|
9290
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
9074
9291
|
|
|
9075
9292
|
</dd>
|
|
9076
9293
|
</dl>
|
|
@@ -9081,7 +9298,7 @@ await client.orderDrafts.cargo.associateWithTaskV1({
|
|
|
9081
9298
|
</dl>
|
|
9082
9299
|
</details>
|
|
9083
9300
|
|
|
9084
|
-
<details><summary><code>client.orderDrafts.
|
|
9301
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">updateV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
9085
9302
|
<dl>
|
|
9086
9303
|
<dd>
|
|
9087
9304
|
|
|
@@ -9093,7 +9310,7 @@ await client.orderDrafts.cargo.associateWithTaskV1({
|
|
|
9093
9310
|
<dl>
|
|
9094
9311
|
<dd>
|
|
9095
9312
|
|
|
9096
|
-
|
|
9313
|
+
Sets or removes courier org. Sets task ordering (must provide all task ids). | (UpdateTaskGroupDraftReq) -> (bool)
|
|
9097
9314
|
|
|
9098
9315
|
</dd>
|
|
9099
9316
|
</dl>
|
|
@@ -9109,10 +9326,7 @@ Updates a cargo item in an existing draft order. Validates order is in DRAFT sta
|
|
|
9109
9326
|
<dd>
|
|
9110
9327
|
|
|
9111
9328
|
```typescript
|
|
9112
|
-
await client.orderDrafts.
|
|
9113
|
-
cargo_id: "cargo_id",
|
|
9114
|
-
cargo_update: {},
|
|
9115
|
-
});
|
|
9329
|
+
await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
9116
9330
|
```
|
|
9117
9331
|
|
|
9118
9332
|
</dd>
|
|
@@ -9128,7 +9342,7 @@ await client.orderDrafts.cargo.updateV1({
|
|
|
9128
9342
|
<dl>
|
|
9129
9343
|
<dd>
|
|
9130
9344
|
|
|
9131
|
-
**
|
|
9345
|
+
**taskGroupId:** `string`
|
|
9132
9346
|
|
|
9133
9347
|
</dd>
|
|
9134
9348
|
</dl>
|
|
@@ -9136,7 +9350,15 @@ await client.orderDrafts.cargo.updateV1({
|
|
|
9136
9350
|
<dl>
|
|
9137
9351
|
<dd>
|
|
9138
9352
|
|
|
9139
|
-
**
|
|
9353
|
+
**request:** `Chrt.orderDrafts.UpdateTaskGroupDraftReq`
|
|
9354
|
+
|
|
9355
|
+
</dd>
|
|
9356
|
+
</dl>
|
|
9357
|
+
|
|
9358
|
+
<dl>
|
|
9359
|
+
<dd>
|
|
9360
|
+
|
|
9361
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
9140
9362
|
|
|
9141
9363
|
</dd>
|
|
9142
9364
|
</dl>
|
|
@@ -9147,7 +9369,7 @@ await client.orderDrafts.cargo.updateV1({
|
|
|
9147
9369
|
</dl>
|
|
9148
9370
|
</details>
|
|
9149
9371
|
|
|
9150
|
-
<details><summary><code>client.orderDrafts.
|
|
9372
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">deleteV1</a>(taskGroupId) -> boolean</code></summary>
|
|
9151
9373
|
<dl>
|
|
9152
9374
|
<dd>
|
|
9153
9375
|
|
|
@@ -9159,7 +9381,7 @@ await client.orderDrafts.cargo.updateV1({
|
|
|
9159
9381
|
<dl>
|
|
9160
9382
|
<dd>
|
|
9161
9383
|
|
|
9162
|
-
Deletes a
|
|
9384
|
+
Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order. | () -> (bool)
|
|
9163
9385
|
|
|
9164
9386
|
</dd>
|
|
9165
9387
|
</dl>
|
|
@@ -9175,7 +9397,7 @@ Deletes a cargo item from a draft order and removes references from associated t
|
|
|
9175
9397
|
<dd>
|
|
9176
9398
|
|
|
9177
9399
|
```typescript
|
|
9178
|
-
await client.orderDrafts.
|
|
9400
|
+
await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
9179
9401
|
```
|
|
9180
9402
|
|
|
9181
9403
|
</dd>
|
|
@@ -9191,7 +9413,7 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
|
9191
9413
|
<dl>
|
|
9192
9414
|
<dd>
|
|
9193
9415
|
|
|
9194
|
-
**
|
|
9416
|
+
**taskGroupId:** `string`
|
|
9195
9417
|
|
|
9196
9418
|
</dd>
|
|
9197
9419
|
</dl>
|
|
@@ -9199,7 +9421,7 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
|
9199
9421
|
<dl>
|
|
9200
9422
|
<dd>
|
|
9201
9423
|
|
|
9202
|
-
**requestOptions:** `
|
|
9424
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
9203
9425
|
|
|
9204
9426
|
</dd>
|
|
9205
9427
|
</dl>
|
|
@@ -9210,9 +9432,9 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
|
9210
9432
|
</dl>
|
|
9211
9433
|
</details>
|
|
9212
9434
|
|
|
9213
|
-
##
|
|
9435
|
+
## OrderDrafts Task
|
|
9214
9436
|
|
|
9215
|
-
<details><summary><code>client.
|
|
9437
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9216
9438
|
<dl>
|
|
9217
9439
|
<dd>
|
|
9218
9440
|
|
|
@@ -9224,7 +9446,7 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
|
9224
9446
|
<dl>
|
|
9225
9447
|
<dd>
|
|
9226
9448
|
|
|
9227
|
-
|
|
9449
|
+
Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type. | (OrderDraftAddTaskReqV1) -> (PydanticObjectId)
|
|
9228
9450
|
|
|
9229
9451
|
</dd>
|
|
9230
9452
|
</dl>
|
|
@@ -9240,7 +9462,12 @@ Fetches a single order for the shipper organization with optional expanded relat
|
|
|
9240
9462
|
<dd>
|
|
9241
9463
|
|
|
9242
9464
|
```typescript
|
|
9243
|
-
await client.
|
|
9465
|
+
await client.orderDrafts.task.addV1({
|
|
9466
|
+
task_group_id: "task_group_id",
|
|
9467
|
+
task: {
|
|
9468
|
+
schema_version: 1,
|
|
9469
|
+
},
|
|
9470
|
+
});
|
|
9244
9471
|
```
|
|
9245
9472
|
|
|
9246
9473
|
</dd>
|
|
@@ -9256,15 +9483,7 @@ await client.orders.expanded.postForShipperByOrderIdV1("order_id_or_short_id", {
|
|
|
9256
9483
|
<dl>
|
|
9257
9484
|
<dd>
|
|
9258
9485
|
|
|
9259
|
-
**
|
|
9260
|
-
|
|
9261
|
-
</dd>
|
|
9262
|
-
</dl>
|
|
9263
|
-
|
|
9264
|
-
<dl>
|
|
9265
|
-
<dd>
|
|
9266
|
-
|
|
9267
|
-
**request:** `Chrt.OrderExpandedForShipperReq`
|
|
9486
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskReqV1`
|
|
9268
9487
|
|
|
9269
9488
|
</dd>
|
|
9270
9489
|
</dl>
|
|
@@ -9272,7 +9491,7 @@ await client.orders.expanded.postForShipperByOrderIdV1("order_id_or_short_id", {
|
|
|
9272
9491
|
<dl>
|
|
9273
9492
|
<dd>
|
|
9274
9493
|
|
|
9275
|
-
**requestOptions:** `
|
|
9494
|
+
**requestOptions:** `Task.RequestOptions`
|
|
9276
9495
|
|
|
9277
9496
|
</dd>
|
|
9278
9497
|
</dl>
|
|
@@ -9283,7 +9502,7 @@ await client.orders.expanded.postForShipperByOrderIdV1("order_id_or_short_id", {
|
|
|
9283
9502
|
</dl>
|
|
9284
9503
|
</details>
|
|
9285
9504
|
|
|
9286
|
-
<details><summary><code>client.
|
|
9505
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">updateV1</a>({ ...params }) -> string</code></summary>
|
|
9287
9506
|
<dl>
|
|
9288
9507
|
<dd>
|
|
9289
9508
|
|
|
@@ -9295,7 +9514,7 @@ await client.orders.expanded.postForShipperByOrderIdV1("order_id_or_short_id", {
|
|
|
9295
9514
|
<dl>
|
|
9296
9515
|
<dd>
|
|
9297
9516
|
|
|
9298
|
-
|
|
9517
|
+
Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (PydanticObjectId)
|
|
9299
9518
|
|
|
9300
9519
|
</dd>
|
|
9301
9520
|
</dl>
|
|
@@ -9311,7 +9530,10 @@ Fetches a single order for the organization that created it with optional expand
|
|
|
9311
9530
|
<dd>
|
|
9312
9531
|
|
|
9313
9532
|
```typescript
|
|
9314
|
-
await client.
|
|
9533
|
+
await client.orderDrafts.task.updateV1({
|
|
9534
|
+
task_id: "task_id",
|
|
9535
|
+
task_update: {},
|
|
9536
|
+
});
|
|
9315
9537
|
```
|
|
9316
9538
|
|
|
9317
9539
|
</dd>
|
|
@@ -9327,15 +9549,7 @@ await client.orders.expanded.postForOrderCreatorByOrderIdV1("order_id_or_short_i
|
|
|
9327
9549
|
<dl>
|
|
9328
9550
|
<dd>
|
|
9329
9551
|
|
|
9330
|
-
**
|
|
9331
|
-
|
|
9332
|
-
</dd>
|
|
9333
|
-
</dl>
|
|
9334
|
-
|
|
9335
|
-
<dl>
|
|
9336
|
-
<dd>
|
|
9337
|
-
|
|
9338
|
-
**request:** `Chrt.OrderExpandedForOrderCreatorReq`
|
|
9552
|
+
**request:** `Chrt.orderDrafts.OrderDraftUpdateTaskReq`
|
|
9339
9553
|
|
|
9340
9554
|
</dd>
|
|
9341
9555
|
</dl>
|
|
@@ -9343,7 +9557,7 @@ await client.orders.expanded.postForOrderCreatorByOrderIdV1("order_id_or_short_i
|
|
|
9343
9557
|
<dl>
|
|
9344
9558
|
<dd>
|
|
9345
9559
|
|
|
9346
|
-
**requestOptions:** `
|
|
9560
|
+
**requestOptions:** `Task.RequestOptions`
|
|
9347
9561
|
|
|
9348
9562
|
</dd>
|
|
9349
9563
|
</dl>
|
|
@@ -9354,9 +9568,7 @@ await client.orders.expanded.postForOrderCreatorByOrderIdV1("order_id_or_short_i
|
|
|
9354
9568
|
</dl>
|
|
9355
9569
|
</details>
|
|
9356
9570
|
|
|
9357
|
-
|
|
9358
|
-
|
|
9359
|
-
<details><summary><code>client.orders.expandedList.<a href="/src/api/resources/orders/resources/expandedList/client/Client.ts">postShipperExpandedListV1</a>({ ...params }) -> Chrt.OrdersExpandedForShipperRes</code></summary>
|
|
9571
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
|
|
9360
9572
|
<dl>
|
|
9361
9573
|
<dd>
|
|
9362
9574
|
|
|
@@ -9368,7 +9580,7 @@ await client.orders.expanded.postForOrderCreatorByOrderIdV1("order_id_or_short_i
|
|
|
9368
9580
|
<dl>
|
|
9369
9581
|
<dd>
|
|
9370
9582
|
|
|
9371
|
-
|
|
9583
|
+
Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group. | () -> (bool)
|
|
9372
9584
|
|
|
9373
9585
|
</dd>
|
|
9374
9586
|
</dl>
|
|
@@ -9384,16 +9596,7 @@ Retrieves orders expanded list for the shipper organization with optional filter
|
|
|
9384
9596
|
<dd>
|
|
9385
9597
|
|
|
9386
9598
|
```typescript
|
|
9387
|
-
await client.
|
|
9388
|
-
page: 1,
|
|
9389
|
-
page_size: 1,
|
|
9390
|
-
sort_by: "draft_started_at",
|
|
9391
|
-
sort_order: "asc",
|
|
9392
|
-
filter_draft_started_at_gte: "2024-01-15T09:30:00Z",
|
|
9393
|
-
filter_draft_started_at_lte: "2024-01-15T09:30:00Z",
|
|
9394
|
-
filter_order_cancelled: true,
|
|
9395
|
-
body: {},
|
|
9396
|
-
});
|
|
9599
|
+
await client.orderDrafts.task.deleteV1("task_id");
|
|
9397
9600
|
```
|
|
9398
9601
|
|
|
9399
9602
|
</dd>
|
|
@@ -9409,7 +9612,7 @@ await client.orders.expandedList.postShipperExpandedListV1({
|
|
|
9409
9612
|
<dl>
|
|
9410
9613
|
<dd>
|
|
9411
9614
|
|
|
9412
|
-
**
|
|
9615
|
+
**taskId:** `string`
|
|
9413
9616
|
|
|
9414
9617
|
</dd>
|
|
9415
9618
|
</dl>
|
|
@@ -9417,7 +9620,7 @@ await client.orders.expandedList.postShipperExpandedListV1({
|
|
|
9417
9620
|
<dl>
|
|
9418
9621
|
<dd>
|
|
9419
9622
|
|
|
9420
|
-
**requestOptions:** `
|
|
9623
|
+
**requestOptions:** `Task.RequestOptions`
|
|
9421
9624
|
|
|
9422
9625
|
</dd>
|
|
9423
9626
|
</dl>
|
|
@@ -9428,7 +9631,9 @@ await client.orders.expandedList.postShipperExpandedListV1({
|
|
|
9428
9631
|
</dl>
|
|
9429
9632
|
</details>
|
|
9430
9633
|
|
|
9431
|
-
|
|
9634
|
+
## OrderDrafts TaskArtifact
|
|
9635
|
+
|
|
9636
|
+
<details><summary><code>client.orderDrafts.taskArtifact.<a href="/src/api/resources/orderDrafts/resources/taskArtifact/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9432
9637
|
<dl>
|
|
9433
9638
|
<dd>
|
|
9434
9639
|
|
|
@@ -9440,7 +9645,7 @@ await client.orders.expandedList.postShipperExpandedListV1({
|
|
|
9440
9645
|
<dl>
|
|
9441
9646
|
<dd>
|
|
9442
9647
|
|
|
9443
|
-
|
|
9648
|
+
Adds a task artifact to an existing task in a draft order. | (OrderDraftAddTaskArtifactReq) -> (PydanticObjectId)
|
|
9444
9649
|
|
|
9445
9650
|
</dd>
|
|
9446
9651
|
</dl>
|
|
@@ -9456,15 +9661,9 @@ Retrieves orders expanded list for order creator org with optional filters, ship
|
|
|
9456
9661
|
<dd>
|
|
9457
9662
|
|
|
9458
9663
|
```typescript
|
|
9459
|
-
await client.
|
|
9460
|
-
|
|
9461
|
-
|
|
9462
|
-
sort_by: "draft_started_at",
|
|
9463
|
-
sort_order: "asc",
|
|
9464
|
-
filter_draft_started_at_gte: "2024-01-15T09:30:00Z",
|
|
9465
|
-
filter_draft_started_at_lte: "2024-01-15T09:30:00Z",
|
|
9466
|
-
filter_order_cancelled: true,
|
|
9467
|
-
body: {},
|
|
9664
|
+
await client.orderDrafts.taskArtifact.addV1({
|
|
9665
|
+
task_id: "task_id",
|
|
9666
|
+
task_artifact_type: "image",
|
|
9468
9667
|
});
|
|
9469
9668
|
```
|
|
9470
9669
|
|
|
@@ -9481,7 +9680,7 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
|
|
|
9481
9680
|
<dl>
|
|
9482
9681
|
<dd>
|
|
9483
9682
|
|
|
9484
|
-
**request:** `Chrt.
|
|
9683
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskArtifactReq`
|
|
9485
9684
|
|
|
9486
9685
|
</dd>
|
|
9487
9686
|
</dl>
|
|
@@ -9489,7 +9688,7 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
|
|
|
9489
9688
|
<dl>
|
|
9490
9689
|
<dd>
|
|
9491
9690
|
|
|
9492
|
-
**requestOptions:** `
|
|
9691
|
+
**requestOptions:** `TaskArtifact.RequestOptions`
|
|
9493
9692
|
|
|
9494
9693
|
</dd>
|
|
9495
9694
|
</dl>
|
|
@@ -9500,9 +9699,7 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
|
|
|
9500
9699
|
</dl>
|
|
9501
9700
|
</details>
|
|
9502
9701
|
|
|
9503
|
-
|
|
9504
|
-
|
|
9505
|
-
<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
|
|
9702
|
+
<details><summary><code>client.orderDrafts.taskArtifact.<a href="/src/api/resources/orderDrafts/resources/taskArtifact/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
9506
9703
|
<dl>
|
|
9507
9704
|
<dd>
|
|
9508
9705
|
|
|
@@ -9514,7 +9711,7 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
|
|
|
9514
9711
|
<dl>
|
|
9515
9712
|
<dd>
|
|
9516
9713
|
|
|
9517
|
-
|
|
9714
|
+
Deletes a task artifact from a draft order and removes it from the associated task. | () -> (bool)
|
|
9518
9715
|
|
|
9519
9716
|
</dd>
|
|
9520
9717
|
</dl>
|
|
@@ -9530,7 +9727,7 @@ Retrieves shipper organization connection information for the authenticated orga
|
|
|
9530
9727
|
<dd>
|
|
9531
9728
|
|
|
9532
9729
|
```typescript
|
|
9533
|
-
await client.
|
|
9730
|
+
await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
9534
9731
|
```
|
|
9535
9732
|
|
|
9536
9733
|
</dd>
|
|
@@ -9546,7 +9743,15 @@ await client.orgInfoForConnections.shipper.getV1();
|
|
|
9546
9743
|
<dl>
|
|
9547
9744
|
<dd>
|
|
9548
9745
|
|
|
9549
|
-
**
|
|
9746
|
+
**taskArtifactId:** `string`
|
|
9747
|
+
|
|
9748
|
+
</dd>
|
|
9749
|
+
</dl>
|
|
9750
|
+
|
|
9751
|
+
<dl>
|
|
9752
|
+
<dd>
|
|
9753
|
+
|
|
9754
|
+
**requestOptions:** `TaskArtifact.RequestOptions`
|
|
9550
9755
|
|
|
9551
9756
|
</dd>
|
|
9552
9757
|
</dl>
|
|
@@ -9557,7 +9762,9 @@ await client.orgInfoForConnections.shipper.getV1();
|
|
|
9557
9762
|
</dl>
|
|
9558
9763
|
</details>
|
|
9559
9764
|
|
|
9560
|
-
|
|
9765
|
+
## OrderDrafts Cargo
|
|
9766
|
+
|
|
9767
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9561
9768
|
<dl>
|
|
9562
9769
|
<dd>
|
|
9563
9770
|
|
|
@@ -9569,7 +9776,7 @@ await client.orgInfoForConnections.shipper.getV1();
|
|
|
9569
9776
|
<dl>
|
|
9570
9777
|
<dd>
|
|
9571
9778
|
|
|
9572
|
-
|
|
9779
|
+
Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddCargoReq) -> (PydanticObjectId)
|
|
9573
9780
|
|
|
9574
9781
|
</dd>
|
|
9575
9782
|
</dl>
|
|
@@ -9585,9 +9792,12 @@ Creates shipper organization connection information. Fails if already exists. |
|
|
|
9585
9792
|
<dd>
|
|
9586
9793
|
|
|
9587
9794
|
```typescript
|
|
9588
|
-
await client.
|
|
9589
|
-
|
|
9590
|
-
|
|
9795
|
+
await client.orderDrafts.cargo.addV1({
|
|
9796
|
+
order_id: "order_id",
|
|
9797
|
+
cargo: {
|
|
9798
|
+
schema_version: 1,
|
|
9799
|
+
cargo_type: "spare_parts",
|
|
9800
|
+
},
|
|
9591
9801
|
});
|
|
9592
9802
|
```
|
|
9593
9803
|
|
|
@@ -9604,7 +9814,7 @@ await client.orgInfoForConnections.shipper.createV1({
|
|
|
9604
9814
|
<dl>
|
|
9605
9815
|
<dd>
|
|
9606
9816
|
|
|
9607
|
-
**request:** `Chrt.
|
|
9817
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddCargoReq`
|
|
9608
9818
|
|
|
9609
9819
|
</dd>
|
|
9610
9820
|
</dl>
|
|
@@ -9612,7 +9822,7 @@ await client.orgInfoForConnections.shipper.createV1({
|
|
|
9612
9822
|
<dl>
|
|
9613
9823
|
<dd>
|
|
9614
9824
|
|
|
9615
|
-
**requestOptions:** `
|
|
9825
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
9616
9826
|
|
|
9617
9827
|
</dd>
|
|
9618
9828
|
</dl>
|
|
@@ -9623,7 +9833,7 @@ await client.orgInfoForConnections.shipper.createV1({
|
|
|
9623
9833
|
</dl>
|
|
9624
9834
|
</details>
|
|
9625
9835
|
|
|
9626
|
-
<details><summary><code>client.
|
|
9836
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">associateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
9627
9837
|
<dl>
|
|
9628
9838
|
<dd>
|
|
9629
9839
|
|
|
@@ -9635,7 +9845,7 @@ await client.orgInfoForConnections.shipper.createV1({
|
|
|
9635
9845
|
<dl>
|
|
9636
9846
|
<dd>
|
|
9637
9847
|
|
|
9638
|
-
|
|
9848
|
+
Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCargoWithTaskReq) -> (bool)
|
|
9639
9849
|
|
|
9640
9850
|
</dd>
|
|
9641
9851
|
</dl>
|
|
@@ -9651,7 +9861,11 @@ Updates existing shipper organization connection information. | (ShipperOrgInfoF
|
|
|
9651
9861
|
<dd>
|
|
9652
9862
|
|
|
9653
9863
|
```typescript
|
|
9654
|
-
await client.
|
|
9864
|
+
await client.orderDrafts.cargo.associateWithTaskV1({
|
|
9865
|
+
order_id: "order_id",
|
|
9866
|
+
task_id: "task_id",
|
|
9867
|
+
cargo_id: "cargo_id",
|
|
9868
|
+
});
|
|
9655
9869
|
```
|
|
9656
9870
|
|
|
9657
9871
|
</dd>
|
|
@@ -9667,7 +9881,7 @@ await client.orgInfoForConnections.shipper.updateV1();
|
|
|
9667
9881
|
<dl>
|
|
9668
9882
|
<dd>
|
|
9669
9883
|
|
|
9670
|
-
**request:** `Chrt.
|
|
9884
|
+
**request:** `Chrt.orderDrafts.OrderDraftAssociateCargoWithTaskReq`
|
|
9671
9885
|
|
|
9672
9886
|
</dd>
|
|
9673
9887
|
</dl>
|
|
@@ -9675,7 +9889,7 @@ await client.orgInfoForConnections.shipper.updateV1();
|
|
|
9675
9889
|
<dl>
|
|
9676
9890
|
<dd>
|
|
9677
9891
|
|
|
9678
|
-
**requestOptions:** `
|
|
9892
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
9679
9893
|
|
|
9680
9894
|
</dd>
|
|
9681
9895
|
</dl>
|
|
@@ -9686,9 +9900,7 @@ await client.orgInfoForConnections.shipper.updateV1();
|
|
|
9686
9900
|
</dl>
|
|
9687
9901
|
</details>
|
|
9688
9902
|
|
|
9689
|
-
|
|
9690
|
-
|
|
9691
|
-
<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">getV1</a>() -> Chrt.CourierOrgInfoForConnections1</code></summary>
|
|
9903
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">updateV1</a>({ ...params }) -> string</code></summary>
|
|
9692
9904
|
<dl>
|
|
9693
9905
|
<dd>
|
|
9694
9906
|
|
|
@@ -9700,7 +9912,7 @@ await client.orgInfoForConnections.shipper.updateV1();
|
|
|
9700
9912
|
<dl>
|
|
9701
9913
|
<dd>
|
|
9702
9914
|
|
|
9703
|
-
|
|
9915
|
+
Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftUpdateCargoReq) -> (PydanticObjectId)
|
|
9704
9916
|
|
|
9705
9917
|
</dd>
|
|
9706
9918
|
</dl>
|
|
@@ -9716,7 +9928,10 @@ Retrieves courier organization connection information for the authenticated orga
|
|
|
9716
9928
|
<dd>
|
|
9717
9929
|
|
|
9718
9930
|
```typescript
|
|
9719
|
-
await client.
|
|
9931
|
+
await client.orderDrafts.cargo.updateV1({
|
|
9932
|
+
cargo_id: "cargo_id",
|
|
9933
|
+
cargo_update: {},
|
|
9934
|
+
});
|
|
9720
9935
|
```
|
|
9721
9936
|
|
|
9722
9937
|
</dd>
|
|
@@ -9732,7 +9947,15 @@ await client.orgInfoForConnections.courier.getV1();
|
|
|
9732
9947
|
<dl>
|
|
9733
9948
|
<dd>
|
|
9734
9949
|
|
|
9735
|
-
**
|
|
9950
|
+
**request:** `Chrt.orderDrafts.OrderDraftUpdateCargoReq`
|
|
9951
|
+
|
|
9952
|
+
</dd>
|
|
9953
|
+
</dl>
|
|
9954
|
+
|
|
9955
|
+
<dl>
|
|
9956
|
+
<dd>
|
|
9957
|
+
|
|
9958
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
9736
9959
|
|
|
9737
9960
|
</dd>
|
|
9738
9961
|
</dl>
|
|
@@ -9743,7 +9966,7 @@ await client.orgInfoForConnections.courier.getV1();
|
|
|
9743
9966
|
</dl>
|
|
9744
9967
|
</details>
|
|
9745
9968
|
|
|
9746
|
-
<details><summary><code>client.
|
|
9969
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">deleteV1</a>(cargoId) -> boolean</code></summary>
|
|
9747
9970
|
<dl>
|
|
9748
9971
|
<dd>
|
|
9749
9972
|
|
|
@@ -9755,7 +9978,7 @@ await client.orgInfoForConnections.courier.getV1();
|
|
|
9755
9978
|
<dl>
|
|
9756
9979
|
<dd>
|
|
9757
9980
|
|
|
9758
|
-
|
|
9981
|
+
Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)
|
|
9759
9982
|
|
|
9760
9983
|
</dd>
|
|
9761
9984
|
</dl>
|
|
@@ -9771,7 +9994,7 @@ Retrieves list of connected courier organizations for forwarder or shipper organ
|
|
|
9771
9994
|
<dd>
|
|
9772
9995
|
|
|
9773
9996
|
```typescript
|
|
9774
|
-
await client.
|
|
9997
|
+
await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
9775
9998
|
```
|
|
9776
9999
|
|
|
9777
10000
|
</dd>
|
|
@@ -9787,7 +10010,15 @@ await client.orgInfoForConnections.courier.listV1();
|
|
|
9787
10010
|
<dl>
|
|
9788
10011
|
<dd>
|
|
9789
10012
|
|
|
9790
|
-
**
|
|
10013
|
+
**cargoId:** `string`
|
|
10014
|
+
|
|
10015
|
+
</dd>
|
|
10016
|
+
</dl>
|
|
10017
|
+
|
|
10018
|
+
<dl>
|
|
10019
|
+
<dd>
|
|
10020
|
+
|
|
10021
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
9791
10022
|
|
|
9792
10023
|
</dd>
|
|
9793
10024
|
</dl>
|
|
@@ -9798,7 +10029,9 @@ await client.orgInfoForConnections.courier.listV1();
|
|
|
9798
10029
|
</dl>
|
|
9799
10030
|
</details>
|
|
9800
10031
|
|
|
9801
|
-
|
|
10032
|
+
## OrgInfoForConnections Shipper
|
|
10033
|
+
|
|
10034
|
+
<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
|
|
9802
10035
|
<dl>
|
|
9803
10036
|
<dd>
|
|
9804
10037
|
|
|
@@ -9810,7 +10043,7 @@ await client.orgInfoForConnections.courier.listV1();
|
|
|
9810
10043
|
<dl>
|
|
9811
10044
|
<dd>
|
|
9812
10045
|
|
|
9813
|
-
|
|
10046
|
+
Retrieves shipper organization connection information for the authenticated organization. | () -> (ShipperOrgInfoForConnections1)
|
|
9814
10047
|
|
|
9815
10048
|
</dd>
|
|
9816
10049
|
</dl>
|
|
@@ -9826,10 +10059,7 @@ Creates courier organization connection information. Fails if already exists. |
|
|
|
9826
10059
|
<dd>
|
|
9827
10060
|
|
|
9828
10061
|
```typescript
|
|
9829
|
-
await client.orgInfoForConnections.
|
|
9830
|
-
schema_version: 1,
|
|
9831
|
-
email_address_primary: "email_address_primary",
|
|
9832
|
-
});
|
|
10062
|
+
await client.orgInfoForConnections.shipper.getV1();
|
|
9833
10063
|
```
|
|
9834
10064
|
|
|
9835
10065
|
</dd>
|
|
@@ -9845,15 +10075,7 @@ await client.orgInfoForConnections.courier.createV1({
|
|
|
9845
10075
|
<dl>
|
|
9846
10076
|
<dd>
|
|
9847
10077
|
|
|
9848
|
-
**
|
|
9849
|
-
|
|
9850
|
-
</dd>
|
|
9851
|
-
</dl>
|
|
9852
|
-
|
|
9853
|
-
<dl>
|
|
9854
|
-
<dd>
|
|
9855
|
-
|
|
9856
|
-
**requestOptions:** `Courier.RequestOptions`
|
|
10078
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
9857
10079
|
|
|
9858
10080
|
</dd>
|
|
9859
10081
|
</dl>
|
|
@@ -9864,7 +10086,7 @@ await client.orgInfoForConnections.courier.createV1({
|
|
|
9864
10086
|
</dl>
|
|
9865
10087
|
</details>
|
|
9866
10088
|
|
|
9867
|
-
<details><summary><code>client.orgInfoForConnections.
|
|
10089
|
+
<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
9868
10090
|
<dl>
|
|
9869
10091
|
<dd>
|
|
9870
10092
|
|
|
@@ -9876,7 +10098,7 @@ await client.orgInfoForConnections.courier.createV1({
|
|
|
9876
10098
|
<dl>
|
|
9877
10099
|
<dd>
|
|
9878
10100
|
|
|
9879
|
-
|
|
10101
|
+
Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
9880
10102
|
|
|
9881
10103
|
</dd>
|
|
9882
10104
|
</dl>
|
|
@@ -9892,7 +10114,10 @@ Updates existing courier organization connection information. | (CourierOrgInfoF
|
|
|
9892
10114
|
<dd>
|
|
9893
10115
|
|
|
9894
10116
|
```typescript
|
|
9895
|
-
await client.orgInfoForConnections.
|
|
10117
|
+
await client.orgInfoForConnections.shipper.createV1({
|
|
10118
|
+
schema_version: 1,
|
|
10119
|
+
email_address_primary: "email_address_primary",
|
|
10120
|
+
});
|
|
9896
10121
|
```
|
|
9897
10122
|
|
|
9898
10123
|
</dd>
|
|
@@ -9908,7 +10133,7 @@ await client.orgInfoForConnections.courier.updateV1();
|
|
|
9908
10133
|
<dl>
|
|
9909
10134
|
<dd>
|
|
9910
10135
|
|
|
9911
|
-
**request:** `Chrt.orgInfoForConnections.
|
|
10136
|
+
**request:** `Chrt.orgInfoForConnections.ShipperOrgInfoForConnectionsClientCreate1`
|
|
9912
10137
|
|
|
9913
10138
|
</dd>
|
|
9914
10139
|
</dl>
|
|
@@ -9916,7 +10141,7 @@ await client.orgInfoForConnections.courier.updateV1();
|
|
|
9916
10141
|
<dl>
|
|
9917
10142
|
<dd>
|
|
9918
10143
|
|
|
9919
|
-
**requestOptions:** `
|
|
10144
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
9920
10145
|
|
|
9921
10146
|
</dd>
|
|
9922
10147
|
</dl>
|
|
@@ -9927,9 +10152,7 @@ await client.orgInfoForConnections.courier.updateV1();
|
|
|
9927
10152
|
</dl>
|
|
9928
10153
|
</details>
|
|
9929
10154
|
|
|
9930
|
-
|
|
9931
|
-
|
|
9932
|
-
<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">getV1</a>() -> Chrt.ForwarderOrgInfoForConnections1</code></summary>
|
|
10155
|
+
<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
9933
10156
|
<dl>
|
|
9934
10157
|
<dd>
|
|
9935
10158
|
|
|
@@ -9941,7 +10164,7 @@ await client.orgInfoForConnections.courier.updateV1();
|
|
|
9941
10164
|
<dl>
|
|
9942
10165
|
<dd>
|
|
9943
10166
|
|
|
9944
|
-
|
|
10167
|
+
Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
9945
10168
|
|
|
9946
10169
|
</dd>
|
|
9947
10170
|
</dl>
|
|
@@ -9957,7 +10180,7 @@ Retrieves forwarder organization connection information for the authenticated or
|
|
|
9957
10180
|
<dd>
|
|
9958
10181
|
|
|
9959
10182
|
```typescript
|
|
9960
|
-
await client.orgInfoForConnections.
|
|
10183
|
+
await client.orgInfoForConnections.shipper.updateV1();
|
|
9961
10184
|
```
|
|
9962
10185
|
|
|
9963
10186
|
</dd>
|
|
@@ -9973,7 +10196,15 @@ await client.orgInfoForConnections.forwarder.getV1();
|
|
|
9973
10196
|
<dl>
|
|
9974
10197
|
<dd>
|
|
9975
10198
|
|
|
9976
|
-
**
|
|
10199
|
+
**request:** `Chrt.orgInfoForConnections.ShipperOrgInfoForConnectionsClientUpdate1`
|
|
10200
|
+
|
|
10201
|
+
</dd>
|
|
10202
|
+
</dl>
|
|
10203
|
+
|
|
10204
|
+
<dl>
|
|
10205
|
+
<dd>
|
|
10206
|
+
|
|
10207
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
9977
10208
|
|
|
9978
10209
|
</dd>
|
|
9979
10210
|
</dl>
|
|
@@ -9984,7 +10215,9 @@ await client.orgInfoForConnections.forwarder.getV1();
|
|
|
9984
10215
|
</dl>
|
|
9985
10216
|
</details>
|
|
9986
10217
|
|
|
9987
|
-
|
|
10218
|
+
## OrgInfoForConnections Courier
|
|
10219
|
+
|
|
10220
|
+
<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">getV1</a>() -> Chrt.CourierOrgInfoForConnections1</code></summary>
|
|
9988
10221
|
<dl>
|
|
9989
10222
|
<dd>
|
|
9990
10223
|
|
|
@@ -9996,7 +10229,7 @@ await client.orgInfoForConnections.forwarder.getV1();
|
|
|
9996
10229
|
<dl>
|
|
9997
10230
|
<dd>
|
|
9998
10231
|
|
|
9999
|
-
|
|
10232
|
+
Retrieves courier organization connection information for the authenticated organization. | () -> (CourierOrgInfoForConnections1)
|
|
10000
10233
|
|
|
10001
10234
|
</dd>
|
|
10002
10235
|
</dl>
|
|
@@ -10012,10 +10245,7 @@ Creates forwarder organization connection information. Fails if already exists.
|
|
|
10012
10245
|
<dd>
|
|
10013
10246
|
|
|
10014
10247
|
```typescript
|
|
10015
|
-
await client.orgInfoForConnections.
|
|
10016
|
-
schema_version: 1,
|
|
10017
|
-
email_address_primary: "email_address_primary",
|
|
10018
|
-
});
|
|
10248
|
+
await client.orgInfoForConnections.courier.getV1();
|
|
10019
10249
|
```
|
|
10020
10250
|
|
|
10021
10251
|
</dd>
|
|
@@ -10031,15 +10261,7 @@ await client.orgInfoForConnections.forwarder.createV1({
|
|
|
10031
10261
|
<dl>
|
|
10032
10262
|
<dd>
|
|
10033
10263
|
|
|
10034
|
-
**
|
|
10035
|
-
|
|
10036
|
-
</dd>
|
|
10037
|
-
</dl>
|
|
10038
|
-
|
|
10039
|
-
<dl>
|
|
10040
|
-
<dd>
|
|
10041
|
-
|
|
10042
|
-
**requestOptions:** `Forwarder.RequestOptions`
|
|
10264
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10043
10265
|
|
|
10044
10266
|
</dd>
|
|
10045
10267
|
</dl>
|
|
@@ -10050,7 +10272,7 @@ await client.orgInfoForConnections.forwarder.createV1({
|
|
|
10050
10272
|
</dl>
|
|
10051
10273
|
</details>
|
|
10052
10274
|
|
|
10053
|
-
<details><summary><code>client.orgInfoForConnections.
|
|
10275
|
+
<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">listV1</a>() -> Chrt.CourierOrgInfoForConnections1[]</code></summary>
|
|
10054
10276
|
<dl>
|
|
10055
10277
|
<dd>
|
|
10056
10278
|
|
|
@@ -10062,7 +10284,7 @@ await client.orgInfoForConnections.forwarder.createV1({
|
|
|
10062
10284
|
<dl>
|
|
10063
10285
|
<dd>
|
|
10064
10286
|
|
|
10065
|
-
|
|
10287
|
+
Retrieves list of connected courier organizations for forwarder or shipper organizations. Not accessible by courier organizations. | () -> (list[CourierOrgInfoForConnections1])
|
|
10066
10288
|
|
|
10067
10289
|
</dd>
|
|
10068
10290
|
</dl>
|
|
@@ -10078,7 +10300,7 @@ Updates existing forwarder organization connection information. | (ForwarderOrgI
|
|
|
10078
10300
|
<dd>
|
|
10079
10301
|
|
|
10080
10302
|
```typescript
|
|
10081
|
-
await client.orgInfoForConnections.
|
|
10303
|
+
await client.orgInfoForConnections.courier.listV1();
|
|
10082
10304
|
```
|
|
10083
10305
|
|
|
10084
10306
|
</dd>
|
|
@@ -10089,20 +10311,12 @@ await client.orgInfoForConnections.forwarder.updateV1();
|
|
|
10089
10311
|
#### ⚙️ Parameters
|
|
10090
10312
|
|
|
10091
10313
|
<dl>
|
|
10092
|
-
<dd>
|
|
10093
|
-
|
|
10094
|
-
<dl>
|
|
10095
|
-
<dd>
|
|
10096
|
-
|
|
10097
|
-
**request:** `Chrt.orgInfoForConnections.ForwarderOrgInfoForConnectionsClientUpdate1`
|
|
10098
|
-
|
|
10099
|
-
</dd>
|
|
10100
|
-
</dl>
|
|
10314
|
+
<dd>
|
|
10101
10315
|
|
|
10102
10316
|
<dl>
|
|
10103
10317
|
<dd>
|
|
10104
10318
|
|
|
10105
|
-
**requestOptions:** `
|
|
10319
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10106
10320
|
|
|
10107
10321
|
</dd>
|
|
10108
10322
|
</dl>
|
|
@@ -10113,9 +10327,7 @@ await client.orgInfoForConnections.forwarder.updateV1();
|
|
|
10113
10327
|
</dl>
|
|
10114
10328
|
</details>
|
|
10115
10329
|
|
|
10116
|
-
|
|
10117
|
-
|
|
10118
|
-
<details><summary><code>client.shipperPayCourierLineItemGroups.shipper.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.ts">listV1</a>() -> Chrt.ShipperPayCourierLineItemGroup1[]</code></summary>
|
|
10330
|
+
<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
10119
10331
|
<dl>
|
|
10120
10332
|
<dd>
|
|
10121
10333
|
|
|
@@ -10127,7 +10339,7 @@ await client.orgInfoForConnections.forwarder.updateV1();
|
|
|
10127
10339
|
<dl>
|
|
10128
10340
|
<dd>
|
|
10129
10341
|
|
|
10130
|
-
|
|
10342
|
+
Creates courier organization connection information. Fails if already exists. | (CourierOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
10131
10343
|
|
|
10132
10344
|
</dd>
|
|
10133
10345
|
</dl>
|
|
@@ -10143,7 +10355,10 @@ Lists all shipper pay courier line item groups for the authenticated shipper org
|
|
|
10143
10355
|
<dd>
|
|
10144
10356
|
|
|
10145
10357
|
```typescript
|
|
10146
|
-
await client.
|
|
10358
|
+
await client.orgInfoForConnections.courier.createV1({
|
|
10359
|
+
schema_version: 1,
|
|
10360
|
+
email_address_primary: "email_address_primary",
|
|
10361
|
+
});
|
|
10147
10362
|
```
|
|
10148
10363
|
|
|
10149
10364
|
</dd>
|
|
@@ -10159,7 +10374,15 @@ await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
|
10159
10374
|
<dl>
|
|
10160
10375
|
<dd>
|
|
10161
10376
|
|
|
10162
|
-
**
|
|
10377
|
+
**request:** `Chrt.orgInfoForConnections.CourierOrgInfoForConnectionsClientCreate1`
|
|
10378
|
+
|
|
10379
|
+
</dd>
|
|
10380
|
+
</dl>
|
|
10381
|
+
|
|
10382
|
+
<dl>
|
|
10383
|
+
<dd>
|
|
10384
|
+
|
|
10385
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10163
10386
|
|
|
10164
10387
|
</dd>
|
|
10165
10388
|
</dl>
|
|
@@ -10170,7 +10393,7 @@ await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
|
10170
10393
|
</dl>
|
|
10171
10394
|
</details>
|
|
10172
10395
|
|
|
10173
|
-
<details><summary><code>client.
|
|
10396
|
+
<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
10174
10397
|
<dl>
|
|
10175
10398
|
<dd>
|
|
10176
10399
|
|
|
@@ -10182,7 +10405,7 @@ await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
|
10182
10405
|
<dl>
|
|
10183
10406
|
<dd>
|
|
10184
10407
|
|
|
10185
|
-
|
|
10408
|
+
Updates existing courier organization connection information. | (CourierOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
10186
10409
|
|
|
10187
10410
|
</dd>
|
|
10188
10411
|
</dl>
|
|
@@ -10198,7 +10421,7 @@ Retrieves a shipper pay courier line item group by its ID for the authenticated
|
|
|
10198
10421
|
<dd>
|
|
10199
10422
|
|
|
10200
10423
|
```typescript
|
|
10201
|
-
await client.
|
|
10424
|
+
await client.orgInfoForConnections.courier.updateV1();
|
|
10202
10425
|
```
|
|
10203
10426
|
|
|
10204
10427
|
</dd>
|
|
@@ -10214,7 +10437,7 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
10214
10437
|
<dl>
|
|
10215
10438
|
<dd>
|
|
10216
10439
|
|
|
10217
|
-
**
|
|
10440
|
+
**request:** `Chrt.orgInfoForConnections.CourierOrgInfoForConnectionsClientUpdate1`
|
|
10218
10441
|
|
|
10219
10442
|
</dd>
|
|
10220
10443
|
</dl>
|
|
@@ -10222,7 +10445,7 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
10222
10445
|
<dl>
|
|
10223
10446
|
<dd>
|
|
10224
10447
|
|
|
10225
|
-
**requestOptions:** `
|
|
10448
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10226
10449
|
|
|
10227
10450
|
</dd>
|
|
10228
10451
|
</dl>
|
|
@@ -10233,7 +10456,9 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
10233
10456
|
</dl>
|
|
10234
10457
|
</details>
|
|
10235
10458
|
|
|
10236
|
-
|
|
10459
|
+
## OrgInfoForConnections Forwarder
|
|
10460
|
+
|
|
10461
|
+
<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">getV1</a>() -> Chrt.ForwarderOrgInfoForConnections1</code></summary>
|
|
10237
10462
|
<dl>
|
|
10238
10463
|
<dd>
|
|
10239
10464
|
|
|
@@ -10245,7 +10470,7 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
10245
10470
|
<dl>
|
|
10246
10471
|
<dd>
|
|
10247
10472
|
|
|
10248
|
-
Retrieves
|
|
10473
|
+
Retrieves forwarder organization connection information for the authenticated organization. | () -> (ForwarderOrgInfoForConnections1)
|
|
10249
10474
|
|
|
10250
10475
|
</dd>
|
|
10251
10476
|
</dl>
|
|
@@ -10261,7 +10486,7 @@ Retrieves a shipper pay courier line item group by its associated task group ID
|
|
|
10261
10486
|
<dd>
|
|
10262
10487
|
|
|
10263
10488
|
```typescript
|
|
10264
|
-
await client.
|
|
10489
|
+
await client.orgInfoForConnections.forwarder.getV1();
|
|
10265
10490
|
```
|
|
10266
10491
|
|
|
10267
10492
|
</dd>
|
|
@@ -10277,15 +10502,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
10277
10502
|
<dl>
|
|
10278
10503
|
<dd>
|
|
10279
10504
|
|
|
10280
|
-
**
|
|
10281
|
-
|
|
10282
|
-
</dd>
|
|
10283
|
-
</dl>
|
|
10284
|
-
|
|
10285
|
-
<dl>
|
|
10286
|
-
<dd>
|
|
10287
|
-
|
|
10288
|
-
**requestOptions:** `Shipper.RequestOptions`
|
|
10505
|
+
**requestOptions:** `Forwarder.RequestOptions`
|
|
10289
10506
|
|
|
10290
10507
|
</dd>
|
|
10291
10508
|
</dl>
|
|
@@ -10296,9 +10513,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
10296
10513
|
</dl>
|
|
10297
10514
|
</details>
|
|
10298
10515
|
|
|
10299
|
-
|
|
10300
|
-
|
|
10301
|
-
<details><summary><code>client.shipperPayCourierLineItemGroups.courier.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.ts">listV1</a>() -> Chrt.ShipperPayCourierLineItemGroup1[]</code></summary>
|
|
10516
|
+
<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
10302
10517
|
<dl>
|
|
10303
10518
|
<dd>
|
|
10304
10519
|
|
|
@@ -10310,7 +10525,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
10310
10525
|
<dl>
|
|
10311
10526
|
<dd>
|
|
10312
10527
|
|
|
10313
|
-
|
|
10528
|
+
Creates forwarder organization connection information. Fails if already exists. | (ForwarderOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
10314
10529
|
|
|
10315
10530
|
</dd>
|
|
10316
10531
|
</dl>
|
|
@@ -10326,7 +10541,10 @@ Lists all shipper pay courier line item groups for the authenticated courier org
|
|
|
10326
10541
|
<dd>
|
|
10327
10542
|
|
|
10328
10543
|
```typescript
|
|
10329
|
-
await client.
|
|
10544
|
+
await client.orgInfoForConnections.forwarder.createV1({
|
|
10545
|
+
schema_version: 1,
|
|
10546
|
+
email_address_primary: "email_address_primary",
|
|
10547
|
+
});
|
|
10330
10548
|
```
|
|
10331
10549
|
|
|
10332
10550
|
</dd>
|
|
@@ -10342,7 +10560,15 @@ await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
|
10342
10560
|
<dl>
|
|
10343
10561
|
<dd>
|
|
10344
10562
|
|
|
10345
|
-
**
|
|
10563
|
+
**request:** `Chrt.orgInfoForConnections.ForwarderOrgInfoForConnectionsClientCreate1`
|
|
10564
|
+
|
|
10565
|
+
</dd>
|
|
10566
|
+
</dl>
|
|
10567
|
+
|
|
10568
|
+
<dl>
|
|
10569
|
+
<dd>
|
|
10570
|
+
|
|
10571
|
+
**requestOptions:** `Forwarder.RequestOptions`
|
|
10346
10572
|
|
|
10347
10573
|
</dd>
|
|
10348
10574
|
</dl>
|
|
@@ -10353,9 +10579,7 @@ await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
|
10353
10579
|
</dl>
|
|
10354
10580
|
</details>
|
|
10355
10581
|
|
|
10356
|
-
|
|
10357
|
-
|
|
10358
|
-
<details><summary><code>client.shipperPayCourierLineItemGroups.addLineItems.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/addLineItems/client/Client.ts">byIdV1</a>(id, { ...params }) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
|
|
10582
|
+
<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
10359
10583
|
<dl>
|
|
10360
10584
|
<dd>
|
|
10361
10585
|
|
|
@@ -10367,7 +10591,7 @@ await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
|
10367
10591
|
<dl>
|
|
10368
10592
|
<dd>
|
|
10369
10593
|
|
|
10370
|
-
|
|
10594
|
+
Updates existing forwarder organization connection information. | (ForwarderOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
10371
10595
|
|
|
10372
10596
|
</dd>
|
|
10373
10597
|
</dl>
|
|
@@ -10383,16 +10607,7 @@ Adds additional line items to an existing shipper pay courier line item group.
|
|
|
10383
10607
|
<dd>
|
|
10384
10608
|
|
|
10385
10609
|
```typescript
|
|
10386
|
-
await client.
|
|
10387
|
-
line_items: [
|
|
10388
|
-
{
|
|
10389
|
-
schema_version: 1,
|
|
10390
|
-
item: "base_rate",
|
|
10391
|
-
quantity: 1.1,
|
|
10392
|
-
rate: 1.1,
|
|
10393
|
-
},
|
|
10394
|
-
],
|
|
10395
|
-
});
|
|
10610
|
+
await client.orgInfoForConnections.forwarder.updateV1();
|
|
10396
10611
|
```
|
|
10397
10612
|
|
|
10398
10613
|
</dd>
|
|
@@ -10408,15 +10623,7 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
10408
10623
|
<dl>
|
|
10409
10624
|
<dd>
|
|
10410
10625
|
|
|
10411
|
-
**
|
|
10412
|
-
|
|
10413
|
-
</dd>
|
|
10414
|
-
</dl>
|
|
10415
|
-
|
|
10416
|
-
<dl>
|
|
10417
|
-
<dd>
|
|
10418
|
-
|
|
10419
|
-
**request:** `Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupAddLineItemsReq`
|
|
10626
|
+
**request:** `Chrt.orgInfoForConnections.ForwarderOrgInfoForConnectionsClientUpdate1`
|
|
10420
10627
|
|
|
10421
10628
|
</dd>
|
|
10422
10629
|
</dl>
|
|
@@ -10424,7 +10631,7 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
10424
10631
|
<dl>
|
|
10425
10632
|
<dd>
|
|
10426
10633
|
|
|
10427
|
-
**requestOptions:** `
|
|
10634
|
+
**requestOptions:** `Forwarder.RequestOptions`
|
|
10428
10635
|
|
|
10429
10636
|
</dd>
|
|
10430
10637
|
</dl>
|
|
@@ -10435,9 +10642,9 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
10435
10642
|
</dl>
|
|
10436
10643
|
</details>
|
|
10437
10644
|
|
|
10438
|
-
## ShipperPayCourierLineItemGroups
|
|
10645
|
+
## ShipperPayCourierLineItemGroups Shipper
|
|
10439
10646
|
|
|
10440
|
-
<details><summary><code>client.shipperPayCourierLineItemGroups.
|
|
10647
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.shipper.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.ts">listV1</a>() -> Chrt.ShipperPayCourierLineItemGroup1[]</code></summary>
|
|
10441
10648
|
<dl>
|
|
10442
10649
|
<dd>
|
|
10443
10650
|
|
|
@@ -10449,7 +10656,7 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
10449
10656
|
<dl>
|
|
10450
10657
|
<dd>
|
|
10451
10658
|
|
|
10452
|
-
|
|
10659
|
+
Lists all shipper pay courier line item groups for the authenticated shipper organization.
|
|
10453
10660
|
|
|
10454
10661
|
</dd>
|
|
10455
10662
|
</dl>
|
|
@@ -10465,9 +10672,7 @@ Removes specific line items from a shipper pay courier line item group by their
|
|
|
10465
10672
|
<dd>
|
|
10466
10673
|
|
|
10467
10674
|
```typescript
|
|
10468
|
-
await client.shipperPayCourierLineItemGroups.
|
|
10469
|
-
line_item_uuid_strs: ["line_item_uuid_strs"],
|
|
10470
|
-
});
|
|
10675
|
+
await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
10471
10676
|
```
|
|
10472
10677
|
|
|
10473
10678
|
</dd>
|
|
@@ -10483,23 +10688,7 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
10483
10688
|
<dl>
|
|
10484
10689
|
<dd>
|
|
10485
10690
|
|
|
10486
|
-
**
|
|
10487
|
-
|
|
10488
|
-
</dd>
|
|
10489
|
-
</dl>
|
|
10490
|
-
|
|
10491
|
-
<dl>
|
|
10492
|
-
<dd>
|
|
10493
|
-
|
|
10494
|
-
**request:** `Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupRemoveLineItemsReq`
|
|
10495
|
-
|
|
10496
|
-
</dd>
|
|
10497
|
-
</dl>
|
|
10498
|
-
|
|
10499
|
-
<dl>
|
|
10500
|
-
<dd>
|
|
10501
|
-
|
|
10502
|
-
**requestOptions:** `RemoveLineItems.RequestOptions`
|
|
10691
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
10503
10692
|
|
|
10504
10693
|
</dd>
|
|
10505
10694
|
</dl>
|
|
@@ -10510,9 +10699,7 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
10510
10699
|
</dl>
|
|
10511
10700
|
</details>
|
|
10512
10701
|
|
|
10513
|
-
|
|
10514
|
-
|
|
10515
|
-
<details><summary><code>client.taskArtifacts.images.<a href="/src/api/resources/taskArtifacts/resources/images/client/Client.ts">getByMetadataIdV1</a>(taskArtifactS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
10702
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.shipper.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.ts">getByIdV1</a>(id) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
|
|
10516
10703
|
<dl>
|
|
10517
10704
|
<dd>
|
|
10518
10705
|
|
|
@@ -10524,7 +10711,7 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
10524
10711
|
<dl>
|
|
10525
10712
|
<dd>
|
|
10526
10713
|
|
|
10527
|
-
|
|
10714
|
+
Retrieves a shipper pay courier line item group by its ID for the authenticated shipper organization.
|
|
10528
10715
|
|
|
10529
10716
|
</dd>
|
|
10530
10717
|
</dl>
|
|
@@ -10540,7 +10727,7 @@ Streams a task_artifact image file from S3 storage. | () -> (StreamingResponse)
|
|
|
10540
10727
|
<dd>
|
|
10541
10728
|
|
|
10542
10729
|
```typescript
|
|
10543
|
-
await client.
|
|
10730
|
+
await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
10544
10731
|
```
|
|
10545
10732
|
|
|
10546
10733
|
</dd>
|
|
@@ -10556,7 +10743,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10556
10743
|
<dl>
|
|
10557
10744
|
<dd>
|
|
10558
10745
|
|
|
10559
|
-
**
|
|
10746
|
+
**id:** `string`
|
|
10560
10747
|
|
|
10561
10748
|
</dd>
|
|
10562
10749
|
</dl>
|
|
@@ -10564,7 +10751,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10564
10751
|
<dl>
|
|
10565
10752
|
<dd>
|
|
10566
10753
|
|
|
10567
|
-
**requestOptions:** `
|
|
10754
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
10568
10755
|
|
|
10569
10756
|
</dd>
|
|
10570
10757
|
</dl>
|
|
@@ -10575,7 +10762,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10575
10762
|
</dl>
|
|
10576
10763
|
</details>
|
|
10577
10764
|
|
|
10578
|
-
<details><summary><code>client.
|
|
10765
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.shipper.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.ts">byTaskGroupIdV1</a>(taskGroupId) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
|
|
10579
10766
|
<dl>
|
|
10580
10767
|
<dd>
|
|
10581
10768
|
|
|
@@ -10587,7 +10774,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
10587
10774
|
<dl>
|
|
10588
10775
|
<dd>
|
|
10589
10776
|
|
|
10590
|
-
|
|
10777
|
+
Retrieves a shipper pay courier line item group by its associated task group ID for the authenticated shipper organization.
|
|
10591
10778
|
|
|
10592
10779
|
</dd>
|
|
10593
10780
|
</dl>
|
|
@@ -10603,9 +10790,7 @@ Uploads an image file to a task_artifact with automatic blurhash generation. | (
|
|
|
10603
10790
|
<dd>
|
|
10604
10791
|
|
|
10605
10792
|
```typescript
|
|
10606
|
-
await client.
|
|
10607
|
-
image: fs.createReadStream("/path/to/your/file"),
|
|
10608
|
-
});
|
|
10793
|
+
await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group_id");
|
|
10609
10794
|
```
|
|
10610
10795
|
|
|
10611
10796
|
</dd>
|
|
@@ -10621,15 +10806,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
10621
10806
|
<dl>
|
|
10622
10807
|
<dd>
|
|
10623
10808
|
|
|
10624
|
-
**
|
|
10625
|
-
|
|
10626
|
-
</dd>
|
|
10627
|
-
</dl>
|
|
10628
|
-
|
|
10629
|
-
<dl>
|
|
10630
|
-
<dd>
|
|
10631
|
-
|
|
10632
|
-
**request:** `Chrt.taskArtifacts.BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost`
|
|
10809
|
+
**taskGroupId:** `string`
|
|
10633
10810
|
|
|
10634
10811
|
</dd>
|
|
10635
10812
|
</dl>
|
|
@@ -10637,7 +10814,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
10637
10814
|
<dl>
|
|
10638
10815
|
<dd>
|
|
10639
10816
|
|
|
10640
|
-
**requestOptions:** `
|
|
10817
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
10641
10818
|
|
|
10642
10819
|
</dd>
|
|
10643
10820
|
</dl>
|
|
@@ -10648,7 +10825,9 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
10648
10825
|
</dl>
|
|
10649
10826
|
</details>
|
|
10650
10827
|
|
|
10651
|
-
|
|
10828
|
+
## ShipperPayCourierLineItemGroups Courier
|
|
10829
|
+
|
|
10830
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.courier.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.ts">listV1</a>() -> Chrt.ShipperPayCourierLineItemGroup1[]</code></summary>
|
|
10652
10831
|
<dl>
|
|
10653
10832
|
<dd>
|
|
10654
10833
|
|
|
@@ -10660,7 +10839,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
10660
10839
|
<dl>
|
|
10661
10840
|
<dd>
|
|
10662
10841
|
|
|
10663
|
-
|
|
10842
|
+
Lists all shipper pay courier line item groups for the authenticated courier organization.
|
|
10664
10843
|
|
|
10665
10844
|
</dd>
|
|
10666
10845
|
</dl>
|
|
@@ -10676,7 +10855,7 @@ Deletes a task_artifact image from both S3 storage and database metadata. | () -
|
|
|
10676
10855
|
<dd>
|
|
10677
10856
|
|
|
10678
10857
|
```typescript
|
|
10679
|
-
await client.
|
|
10858
|
+
await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
10680
10859
|
```
|
|
10681
10860
|
|
|
10682
10861
|
</dd>
|
|
@@ -10692,15 +10871,7 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
10692
10871
|
<dl>
|
|
10693
10872
|
<dd>
|
|
10694
10873
|
|
|
10695
|
-
**
|
|
10696
|
-
|
|
10697
|
-
</dd>
|
|
10698
|
-
</dl>
|
|
10699
|
-
|
|
10700
|
-
<dl>
|
|
10701
|
-
<dd>
|
|
10702
|
-
|
|
10703
|
-
**requestOptions:** `Images.RequestOptions`
|
|
10874
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10704
10875
|
|
|
10705
10876
|
</dd>
|
|
10706
10877
|
</dl>
|
|
@@ -10711,9 +10882,9 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
10711
10882
|
</dl>
|
|
10712
10883
|
</details>
|
|
10713
10884
|
|
|
10714
|
-
##
|
|
10885
|
+
## ShipperPayCourierLineItemGroups AddLineItems
|
|
10715
10886
|
|
|
10716
|
-
<details><summary><code>client.
|
|
10887
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.addLineItems.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/addLineItems/client/Client.ts">byIdV1</a>(id, { ...params }) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
|
|
10717
10888
|
<dl>
|
|
10718
10889
|
<dd>
|
|
10719
10890
|
|
|
@@ -10725,7 +10896,7 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
10725
10896
|
<dl>
|
|
10726
10897
|
<dd>
|
|
10727
10898
|
|
|
10728
|
-
|
|
10899
|
+
Adds additional line items to an existing shipper pay courier line item group.
|
|
10729
10900
|
|
|
10730
10901
|
</dd>
|
|
10731
10902
|
</dl>
|
|
@@ -10741,7 +10912,16 @@ Retrieves the blurhash string for a task_artifact image for fast placeholder loa
|
|
|
10741
10912
|
<dd>
|
|
10742
10913
|
|
|
10743
10914
|
```typescript
|
|
10744
|
-
await client.
|
|
10915
|
+
await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
10916
|
+
line_items: [
|
|
10917
|
+
{
|
|
10918
|
+
schema_version: 1,
|
|
10919
|
+
item: "base_rate",
|
|
10920
|
+
quantity: 1.1,
|
|
10921
|
+
rate: 1.1,
|
|
10922
|
+
},
|
|
10923
|
+
],
|
|
10924
|
+
});
|
|
10745
10925
|
```
|
|
10746
10926
|
|
|
10747
10927
|
</dd>
|
|
@@ -10757,7 +10937,7 @@ await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_m
|
|
|
10757
10937
|
<dl>
|
|
10758
10938
|
<dd>
|
|
10759
10939
|
|
|
10760
|
-
**
|
|
10940
|
+
**id:** `string`
|
|
10761
10941
|
|
|
10762
10942
|
</dd>
|
|
10763
10943
|
</dl>
|
|
@@ -10765,7 +10945,15 @@ await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_m
|
|
|
10765
10945
|
<dl>
|
|
10766
10946
|
<dd>
|
|
10767
10947
|
|
|
10768
|
-
**
|
|
10948
|
+
**request:** `Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupAddLineItemsReq`
|
|
10949
|
+
|
|
10950
|
+
</dd>
|
|
10951
|
+
</dl>
|
|
10952
|
+
|
|
10953
|
+
<dl>
|
|
10954
|
+
<dd>
|
|
10955
|
+
|
|
10956
|
+
**requestOptions:** `AddLineItems.RequestOptions`
|
|
10769
10957
|
|
|
10770
10958
|
</dd>
|
|
10771
10959
|
</dl>
|
|
@@ -10776,9 +10964,9 @@ await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_m
|
|
|
10776
10964
|
</dl>
|
|
10777
10965
|
</details>
|
|
10778
10966
|
|
|
10779
|
-
##
|
|
10967
|
+
## ShipperPayCourierLineItemGroups RemoveLineItems
|
|
10780
10968
|
|
|
10781
|
-
<details><summary><code>client.
|
|
10969
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.removeLineItems.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/removeLineItems/client/Client.ts">byIdV1</a>(id, { ...params }) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
|
|
10782
10970
|
<dl>
|
|
10783
10971
|
<dd>
|
|
10784
10972
|
|
|
@@ -10790,7 +10978,7 @@ await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_m
|
|
|
10790
10978
|
<dl>
|
|
10791
10979
|
<dd>
|
|
10792
10980
|
|
|
10793
|
-
|
|
10981
|
+
Removes specific line items from a shipper pay courier line item group by their UUID identifiers.
|
|
10794
10982
|
|
|
10795
10983
|
</dd>
|
|
10796
10984
|
</dl>
|
|
@@ -10806,7 +10994,9 @@ Fetches an expanded task group for the courier org with expanded related data. |
|
|
|
10806
10994
|
<dd>
|
|
10807
10995
|
|
|
10808
10996
|
```typescript
|
|
10809
|
-
await client.
|
|
10997
|
+
await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
10998
|
+
line_item_uuid_strs: ["line_item_uuid_strs"],
|
|
10999
|
+
});
|
|
10810
11000
|
```
|
|
10811
11001
|
|
|
10812
11002
|
</dd>
|
|
@@ -10830,7 +11020,7 @@ await client.taskGroups.expanded.forCourierAdministratorByIdV1("id", {});
|
|
|
10830
11020
|
<dl>
|
|
10831
11021
|
<dd>
|
|
10832
11022
|
|
|
10833
|
-
**request:** `Chrt.
|
|
11023
|
+
**request:** `Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupRemoveLineItemsReq`
|
|
10834
11024
|
|
|
10835
11025
|
</dd>
|
|
10836
11026
|
</dl>
|
|
@@ -10838,7 +11028,7 @@ await client.taskGroups.expanded.forCourierAdministratorByIdV1("id", {});
|
|
|
10838
11028
|
<dl>
|
|
10839
11029
|
<dd>
|
|
10840
11030
|
|
|
10841
|
-
**requestOptions:** `
|
|
11031
|
+
**requestOptions:** `RemoveLineItems.RequestOptions`
|
|
10842
11032
|
|
|
10843
11033
|
</dd>
|
|
10844
11034
|
</dl>
|
|
@@ -10849,7 +11039,9 @@ await client.taskGroups.expanded.forCourierAdministratorByIdV1("id", {});
|
|
|
10849
11039
|
</dl>
|
|
10850
11040
|
</details>
|
|
10851
11041
|
|
|
10852
|
-
|
|
11042
|
+
## TaskArtifacts Images
|
|
11043
|
+
|
|
11044
|
+
<details><summary><code>client.taskArtifacts.images.<a href="/src/api/resources/taskArtifacts/resources/images/client/Client.ts">getByMetadataIdV1</a>(taskArtifactS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
10853
11045
|
<dl>
|
|
10854
11046
|
<dd>
|
|
10855
11047
|
|
|
@@ -10861,7 +11053,7 @@ await client.taskGroups.expanded.forCourierAdministratorByIdV1("id", {});
|
|
|
10861
11053
|
<dl>
|
|
10862
11054
|
<dd>
|
|
10863
11055
|
|
|
10864
|
-
|
|
11056
|
+
Streams a task_artifact image file from S3 storage. | () -> (StreamingResponse)
|
|
10865
11057
|
|
|
10866
11058
|
</dd>
|
|
10867
11059
|
</dl>
|
|
@@ -10877,7 +11069,7 @@ Fetches an expanded task group assigned to a courier driver with optional expand
|
|
|
10877
11069
|
<dd>
|
|
10878
11070
|
|
|
10879
11071
|
```typescript
|
|
10880
|
-
await client.
|
|
11072
|
+
await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_metadata_id");
|
|
10881
11073
|
```
|
|
10882
11074
|
|
|
10883
11075
|
</dd>
|
|
@@ -10893,15 +11085,7 @@ await client.taskGroups.expanded.forCourierDriverByIdV1("id", {});
|
|
|
10893
11085
|
<dl>
|
|
10894
11086
|
<dd>
|
|
10895
11087
|
|
|
10896
|
-
**
|
|
10897
|
-
|
|
10898
|
-
</dd>
|
|
10899
|
-
</dl>
|
|
10900
|
-
|
|
10901
|
-
<dl>
|
|
10902
|
-
<dd>
|
|
10903
|
-
|
|
10904
|
-
**request:** `Chrt.TaskGroupExpandedForCourierDriverReq`
|
|
11088
|
+
**taskArtifactS3ObjectMetadataId:** `string`
|
|
10905
11089
|
|
|
10906
11090
|
</dd>
|
|
10907
11091
|
</dl>
|
|
@@ -10909,7 +11093,7 @@ await client.taskGroups.expanded.forCourierDriverByIdV1("id", {});
|
|
|
10909
11093
|
<dl>
|
|
10910
11094
|
<dd>
|
|
10911
11095
|
|
|
10912
|
-
**requestOptions:** `
|
|
11096
|
+
**requestOptions:** `Images.RequestOptions`
|
|
10913
11097
|
|
|
10914
11098
|
</dd>
|
|
10915
11099
|
</dl>
|
|
@@ -10920,7 +11104,7 @@ await client.taskGroups.expanded.forCourierDriverByIdV1("id", {});
|
|
|
10920
11104
|
</dl>
|
|
10921
11105
|
</details>
|
|
10922
11106
|
|
|
10923
|
-
<details><summary><code>client.
|
|
11107
|
+
<details><summary><code>client.taskArtifacts.images.<a href="/src/api/resources/taskArtifacts/resources/images/client/Client.ts">uploadByTaskArtifactIdV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
|
|
10924
11108
|
<dl>
|
|
10925
11109
|
<dd>
|
|
10926
11110
|
|
|
@@ -10932,7 +11116,7 @@ await client.taskGroups.expanded.forCourierDriverByIdV1("id", {});
|
|
|
10932
11116
|
<dl>
|
|
10933
11117
|
<dd>
|
|
10934
11118
|
|
|
10935
|
-
|
|
11119
|
+
Uploads an image file to a task_artifact with automatic blurhash generation. | (UploadFile) -> (bool)
|
|
10936
11120
|
|
|
10937
11121
|
</dd>
|
|
10938
11122
|
</dl>
|
|
@@ -10948,7 +11132,9 @@ Fetches an expanded task group for the shipper org with expanded related data. |
|
|
|
10948
11132
|
<dd>
|
|
10949
11133
|
|
|
10950
11134
|
```typescript
|
|
10951
|
-
await client.
|
|
11135
|
+
await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
11136
|
+
image: fs.createReadStream("/path/to/your/file"),
|
|
11137
|
+
});
|
|
10952
11138
|
```
|
|
10953
11139
|
|
|
10954
11140
|
</dd>
|
|
@@ -10964,7 +11150,7 @@ await client.taskGroups.expanded.forShipperByIdV1("id");
|
|
|
10964
11150
|
<dl>
|
|
10965
11151
|
<dd>
|
|
10966
11152
|
|
|
10967
|
-
**
|
|
11153
|
+
**taskArtifactId:** `string`
|
|
10968
11154
|
|
|
10969
11155
|
</dd>
|
|
10970
11156
|
</dl>
|
|
@@ -10972,7 +11158,7 @@ await client.taskGroups.expanded.forShipperByIdV1("id");
|
|
|
10972
11158
|
<dl>
|
|
10973
11159
|
<dd>
|
|
10974
11160
|
|
|
10975
|
-
**request:** `Chrt.
|
|
11161
|
+
**request:** `Chrt.taskArtifacts.BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost`
|
|
10976
11162
|
|
|
10977
11163
|
</dd>
|
|
10978
11164
|
</dl>
|
|
@@ -10980,7 +11166,7 @@ await client.taskGroups.expanded.forShipperByIdV1("id");
|
|
|
10980
11166
|
<dl>
|
|
10981
11167
|
<dd>
|
|
10982
11168
|
|
|
10983
|
-
**requestOptions:** `
|
|
11169
|
+
**requestOptions:** `Images.RequestOptions`
|
|
10984
11170
|
|
|
10985
11171
|
</dd>
|
|
10986
11172
|
</dl>
|
|
@@ -10991,9 +11177,7 @@ await client.taskGroups.expanded.forShipperByIdV1("id");
|
|
|
10991
11177
|
</dl>
|
|
10992
11178
|
</details>
|
|
10993
11179
|
|
|
10994
|
-
|
|
10995
|
-
|
|
10996
|
-
<details><summary><code>client.taskGroups.expandedList.<a href="/src/api/resources/taskGroups/resources/expandedList/client/Client.ts">forCourierAdministratorV1</a>({ ...params }) -> Chrt.TaskGroupsExpandedForCourierAdministratorRes</code></summary>
|
|
11180
|
+
<details><summary><code>client.taskArtifacts.images.<a href="/src/api/resources/taskArtifacts/resources/images/client/Client.ts">deleteByMetadataIdV1</a>(taskArtifactS3ObjectMetadataId) -> boolean</code></summary>
|
|
10997
11181
|
<dl>
|
|
10998
11182
|
<dd>
|
|
10999
11183
|
|
|
@@ -11005,7 +11189,7 @@ await client.taskGroups.expanded.forShipperByIdV1("id");
|
|
|
11005
11189
|
<dl>
|
|
11006
11190
|
<dd>
|
|
11007
11191
|
|
|
11008
|
-
|
|
11192
|
+
Deletes a task_artifact image from both S3 storage and database metadata. | () -> (bool)
|
|
11009
11193
|
|
|
11010
11194
|
</dd>
|
|
11011
11195
|
</dl>
|
|
@@ -11021,22 +11205,7 @@ Fetches expanded task groups for the courier org with optional filters and expan
|
|
|
11021
11205
|
<dd>
|
|
11022
11206
|
|
|
11023
11207
|
```typescript
|
|
11024
|
-
await client.
|
|
11025
|
-
page: 1,
|
|
11026
|
-
page_size: 1,
|
|
11027
|
-
sort_by: "staged_at_timestamp",
|
|
11028
|
-
sort_order: "asc",
|
|
11029
|
-
filter_created_at_gte: "2024-01-15T09:30:00Z",
|
|
11030
|
-
filter_created_at_lte: "2024-01-15T09:30:00Z",
|
|
11031
|
-
filter_started_at_gte: "2024-01-15T09:30:00Z",
|
|
11032
|
-
filter_started_at_lte: "2024-01-15T09:30:00Z",
|
|
11033
|
-
filter_completed_at_gte: "2024-01-15T09:30:00Z",
|
|
11034
|
-
filter_completed_at_lte: "2024-01-15T09:30:00Z",
|
|
11035
|
-
filter_order_cancelled: true,
|
|
11036
|
-
filter_completed: true,
|
|
11037
|
-
filter_paused: true,
|
|
11038
|
-
body: {},
|
|
11039
|
-
});
|
|
11208
|
+
await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_metadata_id");
|
|
11040
11209
|
```
|
|
11041
11210
|
|
|
11042
11211
|
</dd>
|
|
@@ -11052,7 +11221,7 @@ await client.taskGroups.expandedList.forCourierAdministratorV1({
|
|
|
11052
11221
|
<dl>
|
|
11053
11222
|
<dd>
|
|
11054
11223
|
|
|
11055
|
-
**
|
|
11224
|
+
**taskArtifactS3ObjectMetadataId:** `string`
|
|
11056
11225
|
|
|
11057
11226
|
</dd>
|
|
11058
11227
|
</dl>
|
|
@@ -11060,7 +11229,7 @@ await client.taskGroups.expandedList.forCourierAdministratorV1({
|
|
|
11060
11229
|
<dl>
|
|
11061
11230
|
<dd>
|
|
11062
11231
|
|
|
11063
|
-
**requestOptions:** `
|
|
11232
|
+
**requestOptions:** `Images.RequestOptions`
|
|
11064
11233
|
|
|
11065
11234
|
</dd>
|
|
11066
11235
|
</dl>
|
|
@@ -11071,7 +11240,9 @@ await client.taskGroups.expandedList.forCourierAdministratorV1({
|
|
|
11071
11240
|
</dl>
|
|
11072
11241
|
</details>
|
|
11073
11242
|
|
|
11074
|
-
|
|
11243
|
+
## TaskArtifacts Blurhash
|
|
11244
|
+
|
|
11245
|
+
<details><summary><code>client.taskArtifacts.blurhash.<a href="/src/api/resources/taskArtifacts/resources/blurhash/client/Client.ts">getByMetadataIdV1</a>(taskArtifactS3ObjectMetadataId) -> string</code></summary>
|
|
11075
11246
|
<dl>
|
|
11076
11247
|
<dd>
|
|
11077
11248
|
|
|
@@ -11083,7 +11254,7 @@ await client.taskGroups.expandedList.forCourierAdministratorV1({
|
|
|
11083
11254
|
<dl>
|
|
11084
11255
|
<dd>
|
|
11085
11256
|
|
|
11086
|
-
|
|
11257
|
+
Retrieves the blurhash string for a task_artifact image for fast placeholder loading. | () -> (BlurHash)
|
|
11087
11258
|
|
|
11088
11259
|
</dd>
|
|
11089
11260
|
</dl>
|
|
@@ -11099,22 +11270,7 @@ Fetches expanded task groups assigned to a courier driver with optional expanded
|
|
|
11099
11270
|
<dd>
|
|
11100
11271
|
|
|
11101
11272
|
```typescript
|
|
11102
|
-
await client.
|
|
11103
|
-
page: 1,
|
|
11104
|
-
page_size: 1,
|
|
11105
|
-
sort_by: "staged_at_timestamp",
|
|
11106
|
-
sort_order: "asc",
|
|
11107
|
-
filter_created_at_gte: "2024-01-15T09:30:00Z",
|
|
11108
|
-
filter_created_at_lte: "2024-01-15T09:30:00Z",
|
|
11109
|
-
filter_started_at_gte: "2024-01-15T09:30:00Z",
|
|
11110
|
-
filter_started_at_lte: "2024-01-15T09:30:00Z",
|
|
11111
|
-
filter_completed_at_gte: "2024-01-15T09:30:00Z",
|
|
11112
|
-
filter_completed_at_lte: "2024-01-15T09:30:00Z",
|
|
11113
|
-
filter_order_cancelled: true,
|
|
11114
|
-
filter_completed: true,
|
|
11115
|
-
filter_paused: true,
|
|
11116
|
-
body: {},
|
|
11117
|
-
});
|
|
11273
|
+
await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_metadata_id");
|
|
11118
11274
|
```
|
|
11119
11275
|
|
|
11120
11276
|
</dd>
|
|
@@ -11130,7 +11286,7 @@ await client.taskGroups.expandedList.forCourierDriverV1({
|
|
|
11130
11286
|
<dl>
|
|
11131
11287
|
<dd>
|
|
11132
11288
|
|
|
11133
|
-
**
|
|
11289
|
+
**taskArtifactS3ObjectMetadataId:** `string`
|
|
11134
11290
|
|
|
11135
11291
|
</dd>
|
|
11136
11292
|
</dl>
|
|
@@ -11138,7 +11294,7 @@ await client.taskGroups.expandedList.forCourierDriverV1({
|
|
|
11138
11294
|
<dl>
|
|
11139
11295
|
<dd>
|
|
11140
11296
|
|
|
11141
|
-
**requestOptions:** `
|
|
11297
|
+
**requestOptions:** `Blurhash.RequestOptions`
|
|
11142
11298
|
|
|
11143
11299
|
</dd>
|
|
11144
11300
|
</dl>
|