@chrt-inc/typescript-sdk 1.313.0 → 1.314.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/orders/client/Client.d.ts +3 -26
- package/dist/cjs/api/resources/orders/client/Client.js +4 -117
- package/dist/cjs/api/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/index.js +1 -0
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.d.ts +62 -0
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.js +194 -0
- package/dist/cjs/api/resources/orders/resources/expanded/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/resources/expanded/client/index.js +2 -0
- package/dist/cjs/api/resources/orders/resources/expanded/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/resources/expanded/index.js +17 -0
- package/dist/cjs/api/resources/orders/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/orders/resources/index.js +37 -0
- package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +3 -78
- package/dist/cjs/api/resources/taskGroups/client/Client.js +4 -353
- package/dist/cjs/api/resources/taskGroups/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/index.js +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.d.ts +90 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.js +320 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/index.js +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/index.js +17 -0
- package/dist/cjs/api/resources/taskGroups/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/index.js +37 -0
- 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/orders/client/Client.d.mts +3 -26
- package/dist/esm/api/resources/orders/client/Client.mjs +4 -117
- package/dist/esm/api/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.d.mts +62 -0
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.mjs +157 -0
- package/dist/esm/api/resources/orders/resources/expanded/client/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/resources/expanded/client/index.mjs +1 -0
- package/dist/esm/api/resources/orders/resources/expanded/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/resources/expanded/index.mjs +1 -0
- package/dist/esm/api/resources/orders/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/orders/resources/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/client/Client.d.mts +3 -78
- package/dist/esm/api/resources/taskGroups/client/Client.mjs +4 -353
- package/dist/esm/api/resources/taskGroups/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.d.mts +90 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.mjs +283 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +715 -789
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">postExpandedListForShipperOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</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
|
-
Retrieves
|
|
5512
|
+
Retrieves a list of expanded orders with optional filters and related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrdersExpandedListForShipperReq) -> (OrdersExpandedListRes)
|
|
5513
5513
|
|
|
5514
5514
|
</dd>
|
|
5515
5515
|
</dl>
|
|
@@ -5525,7 +5525,7 @@ Retrieves an expanded order with optional related data for shipper operators. |
|
|
|
5525
5525
|
<dd>
|
|
5526
5526
|
|
|
5527
5527
|
```typescript
|
|
5528
|
-
await client.orders.
|
|
5528
|
+
await client.orders.postExpandedListForShipperOperatorsV1();
|
|
5529
5529
|
```
|
|
5530
5530
|
|
|
5531
5531
|
</dd>
|
|
@@ -5541,7 +5541,7 @@ await client.orders.getExpandedForShipperOperatorsV1("order_id");
|
|
|
5541
5541
|
<dl>
|
|
5542
5542
|
<dd>
|
|
5543
5543
|
|
|
5544
|
-
**
|
|
5544
|
+
**request:** `Chrt.OrdersExpandedListForShipperReq`
|
|
5545
5545
|
|
|
5546
5546
|
</dd>
|
|
5547
5547
|
</dl>
|
|
@@ -5560,7 +5560,7 @@ await client.orders.getExpandedForShipperOperatorsV1("order_id");
|
|
|
5560
5560
|
</dl>
|
|
5561
5561
|
</details>
|
|
5562
5562
|
|
|
5563
|
-
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">
|
|
5563
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">postExpandedListForForwarderOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
|
|
5564
5564
|
<dl>
|
|
5565
5565
|
<dd>
|
|
5566
5566
|
|
|
@@ -5572,7 +5572,7 @@ await client.orders.getExpandedForShipperOperatorsV1("order_id");
|
|
|
5572
5572
|
<dl>
|
|
5573
5573
|
<dd>
|
|
5574
5574
|
|
|
5575
|
-
Retrieves
|
|
5575
|
+
Retrieves a list of expanded orders with optional filters and related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrdersExpandedListForForwarderReq) -> (OrdersExpandedListRes)
|
|
5576
5576
|
|
|
5577
5577
|
</dd>
|
|
5578
5578
|
</dl>
|
|
@@ -5588,7 +5588,7 @@ Retrieves an expanded order with optional related data for forwarder operators.
|
|
|
5588
5588
|
<dd>
|
|
5589
5589
|
|
|
5590
5590
|
```typescript
|
|
5591
|
-
await client.orders.
|
|
5591
|
+
await client.orders.postExpandedListForForwarderOperatorsV1();
|
|
5592
5592
|
```
|
|
5593
5593
|
|
|
5594
5594
|
</dd>
|
|
@@ -5604,7 +5604,7 @@ await client.orders.getExpandedForForwarderOperatorsV1("order_id");
|
|
|
5604
5604
|
<dl>
|
|
5605
5605
|
<dd>
|
|
5606
5606
|
|
|
5607
|
-
**
|
|
5607
|
+
**request:** `Chrt.OrdersExpandedListForForwarderReq`
|
|
5608
5608
|
|
|
5609
5609
|
</dd>
|
|
5610
5610
|
</dl>
|
|
@@ -5623,7 +5623,7 @@ await client.orders.getExpandedForForwarderOperatorsV1("order_id");
|
|
|
5623
5623
|
</dl>
|
|
5624
5624
|
</details>
|
|
5625
5625
|
|
|
5626
|
-
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">
|
|
5626
|
+
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
5627
5627
|
<dl>
|
|
5628
5628
|
<dd>
|
|
5629
5629
|
|
|
@@ -5635,7 +5635,7 @@ await client.orders.getExpandedForForwarderOperatorsV1("order_id");
|
|
|
5635
5635
|
<dl>
|
|
5636
5636
|
<dd>
|
|
5637
5637
|
|
|
5638
|
-
|
|
5638
|
+
Validates a draft order and stages all related entities in a transaction. | () -> (bool)
|
|
5639
5639
|
|
|
5640
5640
|
</dd>
|
|
5641
5641
|
</dl>
|
|
@@ -5651,7 +5651,7 @@ Retrieves a list of expanded orders with optional filters and related data for s
|
|
|
5651
5651
|
<dd>
|
|
5652
5652
|
|
|
5653
5653
|
```typescript
|
|
5654
|
-
await client.orders.
|
|
5654
|
+
await client.orders.stageV1("order_id");
|
|
5655
5655
|
```
|
|
5656
5656
|
|
|
5657
5657
|
</dd>
|
|
@@ -5667,7 +5667,7 @@ await client.orders.postExpandedListForShipperOperatorsV1();
|
|
|
5667
5667
|
<dl>
|
|
5668
5668
|
<dd>
|
|
5669
5669
|
|
|
5670
|
-
**
|
|
5670
|
+
**orderId:** `string`
|
|
5671
5671
|
|
|
5672
5672
|
</dd>
|
|
5673
5673
|
</dl>
|
|
@@ -5686,7 +5686,9 @@ await client.orders.postExpandedListForShipperOperatorsV1();
|
|
|
5686
5686
|
</dl>
|
|
5687
5687
|
</details>
|
|
5688
5688
|
|
|
5689
|
-
|
|
5689
|
+
## OrderDrafts
|
|
5690
|
+
|
|
5691
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
5690
5692
|
<dl>
|
|
5691
5693
|
<dd>
|
|
5692
5694
|
|
|
@@ -5698,7 +5700,7 @@ await client.orders.postExpandedListForShipperOperatorsV1();
|
|
|
5698
5700
|
<dl>
|
|
5699
5701
|
<dd>
|
|
5700
5702
|
|
|
5701
|
-
|
|
5703
|
+
Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
5702
5704
|
|
|
5703
5705
|
</dd>
|
|
5704
5706
|
</dl>
|
|
@@ -5714,7 +5716,7 @@ Retrieves a list of expanded orders with optional filters and related data for f
|
|
|
5714
5716
|
<dd>
|
|
5715
5717
|
|
|
5716
5718
|
```typescript
|
|
5717
|
-
await client.
|
|
5719
|
+
await client.orderDrafts.newV1();
|
|
5718
5720
|
```
|
|
5719
5721
|
|
|
5720
5722
|
</dd>
|
|
@@ -5730,7 +5732,7 @@ await client.orders.postExpandedListForForwarderOperatorsV1();
|
|
|
5730
5732
|
<dl>
|
|
5731
5733
|
<dd>
|
|
5732
5734
|
|
|
5733
|
-
**request:** `Chrt.
|
|
5735
|
+
**request:** `Chrt.OrdersNewDraftReq`
|
|
5734
5736
|
|
|
5735
5737
|
</dd>
|
|
5736
5738
|
</dl>
|
|
@@ -5738,7 +5740,7 @@ await client.orders.postExpandedListForForwarderOperatorsV1();
|
|
|
5738
5740
|
<dl>
|
|
5739
5741
|
<dd>
|
|
5740
5742
|
|
|
5741
|
-
**requestOptions:** `
|
|
5743
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
5742
5744
|
|
|
5743
5745
|
</dd>
|
|
5744
5746
|
</dl>
|
|
@@ -5749,7 +5751,7 @@ await client.orders.postExpandedListForForwarderOperatorsV1();
|
|
|
5749
5751
|
</dl>
|
|
5750
5752
|
</details>
|
|
5751
5753
|
|
|
5752
|
-
<details><summary><code>client.
|
|
5754
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
|
|
5753
5755
|
<dl>
|
|
5754
5756
|
<dd>
|
|
5755
5757
|
|
|
@@ -5761,7 +5763,7 @@ await client.orders.postExpandedListForForwarderOperatorsV1();
|
|
|
5761
5763
|
<dl>
|
|
5762
5764
|
<dd>
|
|
5763
5765
|
|
|
5764
|
-
|
|
5766
|
+
Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
5765
5767
|
|
|
5766
5768
|
</dd>
|
|
5767
5769
|
</dl>
|
|
@@ -5777,7 +5779,9 @@ Validates a draft order and stages all related entities in a transaction. | () -
|
|
|
5777
5779
|
<dd>
|
|
5778
5780
|
|
|
5779
5781
|
```typescript
|
|
5780
|
-
await client.
|
|
5782
|
+
await client.orderDrafts.updateV1({
|
|
5783
|
+
order_id: "order_id",
|
|
5784
|
+
});
|
|
5781
5785
|
```
|
|
5782
5786
|
|
|
5783
5787
|
</dd>
|
|
@@ -5793,7 +5797,7 @@ await client.orders.stageV1("order_id");
|
|
|
5793
5797
|
<dl>
|
|
5794
5798
|
<dd>
|
|
5795
5799
|
|
|
5796
|
-
**
|
|
5800
|
+
**request:** `Chrt.OrdersDraftUpdateReq`
|
|
5797
5801
|
|
|
5798
5802
|
</dd>
|
|
5799
5803
|
</dl>
|
|
@@ -5801,7 +5805,7 @@ await client.orders.stageV1("order_id");
|
|
|
5801
5805
|
<dl>
|
|
5802
5806
|
<dd>
|
|
5803
5807
|
|
|
5804
|
-
**requestOptions:** `
|
|
5808
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
5805
5809
|
|
|
5806
5810
|
</dd>
|
|
5807
5811
|
</dl>
|
|
@@ -5812,9 +5816,7 @@ await client.orders.stageV1("order_id");
|
|
|
5812
5816
|
</dl>
|
|
5813
5817
|
</details>
|
|
5814
5818
|
|
|
5815
|
-
|
|
5816
|
-
|
|
5817
|
-
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
5819
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
|
|
5818
5820
|
<dl>
|
|
5819
5821
|
<dd>
|
|
5820
5822
|
|
|
@@ -5826,7 +5828,7 @@ await client.orders.stageV1("order_id");
|
|
|
5826
5828
|
<dl>
|
|
5827
5829
|
<dd>
|
|
5828
5830
|
|
|
5829
|
-
|
|
5831
|
+
Deletes a draft order and all associated entities. | () -> (bool)
|
|
5830
5832
|
|
|
5831
5833
|
</dd>
|
|
5832
5834
|
</dl>
|
|
@@ -5842,7 +5844,7 @@ Creates a new draft order with org assignments based on caller's organization ty
|
|
|
5842
5844
|
<dd>
|
|
5843
5845
|
|
|
5844
5846
|
```typescript
|
|
5845
|
-
await client.orderDrafts.
|
|
5847
|
+
await client.orderDrafts.deleteV1("order_id");
|
|
5846
5848
|
```
|
|
5847
5849
|
|
|
5848
5850
|
</dd>
|
|
@@ -5858,7 +5860,7 @@ await client.orderDrafts.newV1();
|
|
|
5858
5860
|
<dl>
|
|
5859
5861
|
<dd>
|
|
5860
5862
|
|
|
5861
|
-
**
|
|
5863
|
+
**orderId:** `string`
|
|
5862
5864
|
|
|
5863
5865
|
</dd>
|
|
5864
5866
|
</dl>
|
|
@@ -5877,7 +5879,7 @@ await client.orderDrafts.newV1();
|
|
|
5877
5879
|
</dl>
|
|
5878
5880
|
</details>
|
|
5879
5881
|
|
|
5880
|
-
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">
|
|
5882
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">expandedV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderDraftExpandedRes</code></summary>
|
|
5881
5883
|
<dl>
|
|
5882
5884
|
<dd>
|
|
5883
5885
|
|
|
@@ -5889,7 +5891,7 @@ await client.orderDrafts.newV1();
|
|
|
5889
5891
|
<dl>
|
|
5890
5892
|
<dd>
|
|
5891
5893
|
|
|
5892
|
-
|
|
5894
|
+
Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderDraftExpandedReq) -> (OrderDraftExpandedRes)
|
|
5893
5895
|
|
|
5894
5896
|
</dd>
|
|
5895
5897
|
</dl>
|
|
@@ -5905,9 +5907,7 @@ Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDra
|
|
|
5905
5907
|
<dd>
|
|
5906
5908
|
|
|
5907
5909
|
```typescript
|
|
5908
|
-
await client.orderDrafts.
|
|
5909
|
-
order_id: "order_id",
|
|
5910
|
-
});
|
|
5910
|
+
await client.orderDrafts.expandedV1("order_id_or_short_id");
|
|
5911
5911
|
```
|
|
5912
5912
|
|
|
5913
5913
|
</dd>
|
|
@@ -5923,7 +5923,15 @@ await client.orderDrafts.updateV1({
|
|
|
5923
5923
|
<dl>
|
|
5924
5924
|
<dd>
|
|
5925
5925
|
|
|
5926
|
-
**
|
|
5926
|
+
**orderIdOrShortId:** `string`
|
|
5927
|
+
|
|
5928
|
+
</dd>
|
|
5929
|
+
</dl>
|
|
5930
|
+
|
|
5931
|
+
<dl>
|
|
5932
|
+
<dd>
|
|
5933
|
+
|
|
5934
|
+
**request:** `Chrt.OrderDraftExpandedReq`
|
|
5927
5935
|
|
|
5928
5936
|
</dd>
|
|
5929
5937
|
</dl>
|
|
@@ -5942,7 +5950,7 @@ await client.orderDrafts.updateV1({
|
|
|
5942
5950
|
</dl>
|
|
5943
5951
|
</details>
|
|
5944
5952
|
|
|
5945
|
-
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">
|
|
5953
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">expandedListV1</a>({ ...params }) -> Chrt.OrderDraftExpandedListRes</code></summary>
|
|
5946
5954
|
<dl>
|
|
5947
5955
|
<dd>
|
|
5948
5956
|
|
|
@@ -5954,7 +5962,7 @@ await client.orderDrafts.updateV1({
|
|
|
5954
5962
|
<dl>
|
|
5955
5963
|
<dd>
|
|
5956
5964
|
|
|
5957
|
-
|
|
5965
|
+
Lists all draft orders created by the authenticated user with optional expanded related data. | (OrderDraftExpandedListReq) -> (OrderDraftExpandedListRes)
|
|
5958
5966
|
|
|
5959
5967
|
</dd>
|
|
5960
5968
|
</dl>
|
|
@@ -5970,7 +5978,7 @@ Deletes a draft order and all associated entities. | () -> (bool)
|
|
|
5970
5978
|
<dd>
|
|
5971
5979
|
|
|
5972
5980
|
```typescript
|
|
5973
|
-
await client.orderDrafts.
|
|
5981
|
+
await client.orderDrafts.expandedListV1();
|
|
5974
5982
|
```
|
|
5975
5983
|
|
|
5976
5984
|
</dd>
|
|
@@ -5986,7 +5994,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
5986
5994
|
<dl>
|
|
5987
5995
|
<dd>
|
|
5988
5996
|
|
|
5989
|
-
**
|
|
5997
|
+
**request:** `Chrt.OrderDraftExpandedListReq`
|
|
5990
5998
|
|
|
5991
5999
|
</dd>
|
|
5992
6000
|
</dl>
|
|
@@ -6005,7 +6013,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
6005
6013
|
</dl>
|
|
6006
6014
|
</details>
|
|
6007
6015
|
|
|
6008
|
-
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">
|
|
6016
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> boolean</code></summary>
|
|
6009
6017
|
<dl>
|
|
6010
6018
|
<dd>
|
|
6011
6019
|
|
|
@@ -6017,7 +6025,7 @@ await client.orderDrafts.deleteV1("order_id");
|
|
|
6017
6025
|
<dl>
|
|
6018
6026
|
<dd>
|
|
6019
6027
|
|
|
6020
|
-
|
|
6028
|
+
Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
|
|
6021
6029
|
|
|
6022
6030
|
</dd>
|
|
6023
6031
|
</dl>
|
|
@@ -6033,7 +6041,7 @@ Fetches a single draft order with optional expanded related data. Only the creat
|
|
|
6033
6041
|
<dd>
|
|
6034
6042
|
|
|
6035
6043
|
```typescript
|
|
6036
|
-
await client.orderDrafts.
|
|
6044
|
+
await client.orderDrafts.validateV1("order_id");
|
|
6037
6045
|
```
|
|
6038
6046
|
|
|
6039
6047
|
</dd>
|
|
@@ -6049,15 +6057,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id");
|
|
|
6049
6057
|
<dl>
|
|
6050
6058
|
<dd>
|
|
6051
6059
|
|
|
6052
|
-
**
|
|
6053
|
-
|
|
6054
|
-
</dd>
|
|
6055
|
-
</dl>
|
|
6056
|
-
|
|
6057
|
-
<dl>
|
|
6058
|
-
<dd>
|
|
6059
|
-
|
|
6060
|
-
**request:** `Chrt.OrderDraftExpandedReq`
|
|
6060
|
+
**orderId:** `string`
|
|
6061
6061
|
|
|
6062
6062
|
</dd>
|
|
6063
6063
|
</dl>
|
|
@@ -6076,7 +6076,9 @@ await client.orderDrafts.expandedV1("order_id_or_short_id");
|
|
|
6076
6076
|
</dl>
|
|
6077
6077
|
</details>
|
|
6078
6078
|
|
|
6079
|
-
|
|
6079
|
+
## TaskGroups
|
|
6080
|
+
|
|
6081
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForCourierOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
6080
6082
|
<dl>
|
|
6081
6083
|
<dd>
|
|
6082
6084
|
|
|
@@ -6088,7 +6090,7 @@ await client.orderDrafts.expandedV1("order_id_or_short_id");
|
|
|
6088
6090
|
<dl>
|
|
6089
6091
|
<dd>
|
|
6090
6092
|
|
|
6091
|
-
|
|
6093
|
+
Retrieves a list of expanded task groups with optional filters and related data for courier operators. | authz_personas=[courier_org_operators] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
|
|
6092
6094
|
|
|
6093
6095
|
</dd>
|
|
6094
6096
|
</dl>
|
|
@@ -6104,7 +6106,7 @@ Lists all draft orders created by the authenticated user with optional expanded
|
|
|
6104
6106
|
<dd>
|
|
6105
6107
|
|
|
6106
6108
|
```typescript
|
|
6107
|
-
await client.
|
|
6109
|
+
await client.taskGroups.postExpandedListForCourierOperatorsV1({});
|
|
6108
6110
|
```
|
|
6109
6111
|
|
|
6110
6112
|
</dd>
|
|
@@ -6120,7 +6122,7 @@ await client.orderDrafts.expandedListV1();
|
|
|
6120
6122
|
<dl>
|
|
6121
6123
|
<dd>
|
|
6122
6124
|
|
|
6123
|
-
**request:** `Chrt.
|
|
6125
|
+
**request:** `Chrt.TaskGroupExpandedListReq`
|
|
6124
6126
|
|
|
6125
6127
|
</dd>
|
|
6126
6128
|
</dl>
|
|
@@ -6128,7 +6130,7 @@ await client.orderDrafts.expandedListV1();
|
|
|
6128
6130
|
<dl>
|
|
6129
6131
|
<dd>
|
|
6130
6132
|
|
|
6131
|
-
**requestOptions:** `
|
|
6133
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6132
6134
|
|
|
6133
6135
|
</dd>
|
|
6134
6136
|
</dl>
|
|
@@ -6139,7 +6141,7 @@ await client.orderDrafts.expandedListV1();
|
|
|
6139
6141
|
</dl>
|
|
6140
6142
|
</details>
|
|
6141
6143
|
|
|
6142
|
-
<details><summary><code>client.
|
|
6144
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForCourierDriverV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
6143
6145
|
<dl>
|
|
6144
6146
|
<dd>
|
|
6145
6147
|
|
|
@@ -6151,7 +6153,7 @@ await client.orderDrafts.expandedListV1();
|
|
|
6151
6153
|
<dl>
|
|
6152
6154
|
<dd>
|
|
6153
6155
|
|
|
6154
|
-
|
|
6156
|
+
Retrieves a list of expanded task groups with optional filters and related data for courier drivers. | authz_personas=[courier_driver] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
|
|
6155
6157
|
|
|
6156
6158
|
</dd>
|
|
6157
6159
|
</dl>
|
|
@@ -6167,7 +6169,7 @@ Checks whether the draft order satisfies all requirements to move into staging.
|
|
|
6167
6169
|
<dd>
|
|
6168
6170
|
|
|
6169
6171
|
```typescript
|
|
6170
|
-
await client.
|
|
6172
|
+
await client.taskGroups.postExpandedListForCourierDriverV1({});
|
|
6171
6173
|
```
|
|
6172
6174
|
|
|
6173
6175
|
</dd>
|
|
@@ -6183,7 +6185,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
6183
6185
|
<dl>
|
|
6184
6186
|
<dd>
|
|
6185
6187
|
|
|
6186
|
-
**
|
|
6188
|
+
**request:** `Chrt.TaskGroupExpandedListReq`
|
|
6187
6189
|
|
|
6188
6190
|
</dd>
|
|
6189
6191
|
</dl>
|
|
@@ -6191,7 +6193,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
6191
6193
|
<dl>
|
|
6192
6194
|
<dd>
|
|
6193
6195
|
|
|
6194
|
-
**requestOptions:** `
|
|
6196
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6195
6197
|
|
|
6196
6198
|
</dd>
|
|
6197
6199
|
</dl>
|
|
@@ -6202,9 +6204,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
6202
6204
|
</dl>
|
|
6203
6205
|
</details>
|
|
6204
6206
|
|
|
6205
|
-
|
|
6206
|
-
|
|
6207
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getExpandedForCourierOperatorsV1</a>(taskGroupId) -> Chrt.TaskGroupExpanded</code></summary>
|
|
6207
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForForwarderOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
6208
6208
|
<dl>
|
|
6209
6209
|
<dd>
|
|
6210
6210
|
|
|
@@ -6216,7 +6216,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
6216
6216
|
<dl>
|
|
6217
6217
|
<dd>
|
|
6218
6218
|
|
|
6219
|
-
Retrieves
|
|
6219
|
+
Retrieves a list of expanded task groups with optional filters and related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
|
|
6220
6220
|
|
|
6221
6221
|
</dd>
|
|
6222
6222
|
</dl>
|
|
@@ -6232,7 +6232,7 @@ Retrieves an expanded task group with optional related data for courier operator
|
|
|
6232
6232
|
<dd>
|
|
6233
6233
|
|
|
6234
6234
|
```typescript
|
|
6235
|
-
await client.taskGroups.
|
|
6235
|
+
await client.taskGroups.postExpandedListForForwarderOperatorsV1({});
|
|
6236
6236
|
```
|
|
6237
6237
|
|
|
6238
6238
|
</dd>
|
|
@@ -6248,7 +6248,7 @@ await client.taskGroups.getExpandedForCourierOperatorsV1("task_group_id");
|
|
|
6248
6248
|
<dl>
|
|
6249
6249
|
<dd>
|
|
6250
6250
|
|
|
6251
|
-
**
|
|
6251
|
+
**request:** `Chrt.TaskGroupExpandedListReq`
|
|
6252
6252
|
|
|
6253
6253
|
</dd>
|
|
6254
6254
|
</dl>
|
|
@@ -6267,7 +6267,7 @@ await client.taskGroups.getExpandedForCourierOperatorsV1("task_group_id");
|
|
|
6267
6267
|
</dl>
|
|
6268
6268
|
</details>
|
|
6269
6269
|
|
|
6270
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6270
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6271
6271
|
<dl>
|
|
6272
6272
|
<dd>
|
|
6273
6273
|
|
|
@@ -6279,7 +6279,7 @@ await client.taskGroups.getExpandedForCourierOperatorsV1("task_group_id");
|
|
|
6279
6279
|
<dl>
|
|
6280
6280
|
<dd>
|
|
6281
6281
|
|
|
6282
|
-
|
|
6282
|
+
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)
|
|
6283
6283
|
|
|
6284
6284
|
</dd>
|
|
6285
6285
|
</dl>
|
|
@@ -6295,7 +6295,9 @@ Retrieves expanded task groups by order ID or short ID for courier operators. |
|
|
|
6295
6295
|
<dd>
|
|
6296
6296
|
|
|
6297
6297
|
```typescript
|
|
6298
|
-
await client.taskGroups.
|
|
6298
|
+
await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
6299
|
+
task_ordering: ["task_ordering"],
|
|
6300
|
+
});
|
|
6299
6301
|
```
|
|
6300
6302
|
|
|
6301
6303
|
</dd>
|
|
@@ -6311,7 +6313,15 @@ await client.taskGroups.getExpandedForCourierOperatorsByOrderV1("order_id_or_sho
|
|
|
6311
6313
|
<dl>
|
|
6312
6314
|
<dd>
|
|
6313
6315
|
|
|
6314
|
-
**
|
|
6316
|
+
**taskGroupId:** `string`
|
|
6317
|
+
|
|
6318
|
+
</dd>
|
|
6319
|
+
</dl>
|
|
6320
|
+
|
|
6321
|
+
<dl>
|
|
6322
|
+
<dd>
|
|
6323
|
+
|
|
6324
|
+
**request:** `Chrt.SetTaskOrderingReq`
|
|
6315
6325
|
|
|
6316
6326
|
</dd>
|
|
6317
6327
|
</dl>
|
|
@@ -6330,7 +6340,7 @@ await client.taskGroups.getExpandedForCourierOperatorsByOrderV1("order_id_or_sho
|
|
|
6330
6340
|
</dl>
|
|
6331
6341
|
</details>
|
|
6332
6342
|
|
|
6333
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6343
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setFlightNumberV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6334
6344
|
<dl>
|
|
6335
6345
|
<dd>
|
|
6336
6346
|
|
|
@@ -6342,7 +6352,7 @@ await client.taskGroups.getExpandedForCourierOperatorsByOrderV1("order_id_or_sho
|
|
|
6342
6352
|
<dl>
|
|
6343
6353
|
<dd>
|
|
6344
6354
|
|
|
6345
|
-
|
|
6355
|
+
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)
|
|
6346
6356
|
|
|
6347
6357
|
</dd>
|
|
6348
6358
|
</dl>
|
|
@@ -6358,7 +6368,9 @@ Retrieves an expanded task group with optional related data for courier drivers.
|
|
|
6358
6368
|
<dd>
|
|
6359
6369
|
|
|
6360
6370
|
```typescript
|
|
6361
|
-
await client.taskGroups.
|
|
6371
|
+
await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
6372
|
+
flight_number: "flight_number",
|
|
6373
|
+
});
|
|
6362
6374
|
```
|
|
6363
6375
|
|
|
6364
6376
|
</dd>
|
|
@@ -6382,6 +6394,14 @@ await client.taskGroups.getExpandedForCourierDriverV1("task_group_id");
|
|
|
6382
6394
|
<dl>
|
|
6383
6395
|
<dd>
|
|
6384
6396
|
|
|
6397
|
+
**request:** `Chrt.SetFlightNumberReq`
|
|
6398
|
+
|
|
6399
|
+
</dd>
|
|
6400
|
+
</dl>
|
|
6401
|
+
|
|
6402
|
+
<dl>
|
|
6403
|
+
<dd>
|
|
6404
|
+
|
|
6385
6405
|
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6386
6406
|
|
|
6387
6407
|
</dd>
|
|
@@ -6393,7 +6413,7 @@ await client.taskGroups.getExpandedForCourierDriverV1("task_group_id");
|
|
|
6393
6413
|
</dl>
|
|
6394
6414
|
</details>
|
|
6395
6415
|
|
|
6396
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6416
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6397
6417
|
<dl>
|
|
6398
6418
|
<dd>
|
|
6399
6419
|
|
|
@@ -6405,7 +6425,7 @@ await client.taskGroups.getExpandedForCourierDriverV1("task_group_id");
|
|
|
6405
6425
|
<dl>
|
|
6406
6426
|
<dd>
|
|
6407
6427
|
|
|
6408
|
-
|
|
6428
|
+
Sets or removes the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateTaskGroupDriverReq) -> (bool)
|
|
6409
6429
|
|
|
6410
6430
|
</dd>
|
|
6411
6431
|
</dl>
|
|
@@ -6421,7 +6441,7 @@ Retrieves expanded task groups by order ID or short ID for courier drivers. | au
|
|
|
6421
6441
|
<dd>
|
|
6422
6442
|
|
|
6423
6443
|
```typescript
|
|
6424
|
-
await client.taskGroups.
|
|
6444
|
+
await client.taskGroups.updateDriverV1("task_group_id");
|
|
6425
6445
|
```
|
|
6426
6446
|
|
|
6427
6447
|
</dd>
|
|
@@ -6437,7 +6457,15 @@ await client.taskGroups.getExpandedForCourierDriverByOrderV1("order_id_or_short_
|
|
|
6437
6457
|
<dl>
|
|
6438
6458
|
<dd>
|
|
6439
6459
|
|
|
6440
|
-
**
|
|
6460
|
+
**taskGroupId:** `string`
|
|
6461
|
+
|
|
6462
|
+
</dd>
|
|
6463
|
+
</dl>
|
|
6464
|
+
|
|
6465
|
+
<dl>
|
|
6466
|
+
<dd>
|
|
6467
|
+
|
|
6468
|
+
**request:** `Chrt.UpdateTaskGroupDriverReq`
|
|
6441
6469
|
|
|
6442
6470
|
</dd>
|
|
6443
6471
|
</dl>
|
|
@@ -6456,7 +6484,7 @@ await client.taskGroups.getExpandedForCourierDriverByOrderV1("order_id_or_short_
|
|
|
6456
6484
|
</dl>
|
|
6457
6485
|
</details>
|
|
6458
6486
|
|
|
6459
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6487
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateCourierOrgV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6460
6488
|
<dl>
|
|
6461
6489
|
<dd>
|
|
6462
6490
|
|
|
@@ -6468,7 +6496,7 @@ await client.taskGroups.getExpandedForCourierDriverByOrderV1("order_id_or_short_
|
|
|
6468
6496
|
<dl>
|
|
6469
6497
|
<dd>
|
|
6470
6498
|
|
|
6471
|
-
|
|
6499
|
+
Sets or removes the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateTaskGroupCourierOrgReq) -> (bool)
|
|
6472
6500
|
|
|
6473
6501
|
</dd>
|
|
6474
6502
|
</dl>
|
|
@@ -6484,7 +6512,7 @@ Retrieves an expanded task group with optional related data for shipper operator
|
|
|
6484
6512
|
<dd>
|
|
6485
6513
|
|
|
6486
6514
|
```typescript
|
|
6487
|
-
await client.taskGroups.
|
|
6515
|
+
await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
6488
6516
|
```
|
|
6489
6517
|
|
|
6490
6518
|
</dd>
|
|
@@ -6508,6 +6536,14 @@ await client.taskGroups.getExpandedForShipperOperatorsV1("task_group_id");
|
|
|
6508
6536
|
<dl>
|
|
6509
6537
|
<dd>
|
|
6510
6538
|
|
|
6539
|
+
**request:** `Chrt.UpdateTaskGroupCourierOrgReq`
|
|
6540
|
+
|
|
6541
|
+
</dd>
|
|
6542
|
+
</dl>
|
|
6543
|
+
|
|
6544
|
+
<dl>
|
|
6545
|
+
<dd>
|
|
6546
|
+
|
|
6511
6547
|
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6512
6548
|
|
|
6513
6549
|
</dd>
|
|
@@ -6519,7 +6555,7 @@ await client.taskGroups.getExpandedForShipperOperatorsV1("task_group_id");
|
|
|
6519
6555
|
</dl>
|
|
6520
6556
|
</details>
|
|
6521
6557
|
|
|
6522
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6558
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
6523
6559
|
<dl>
|
|
6524
6560
|
<dd>
|
|
6525
6561
|
|
|
@@ -6531,7 +6567,7 @@ await client.taskGroups.getExpandedForShipperOperatorsV1("task_group_id");
|
|
|
6531
6567
|
<dl>
|
|
6532
6568
|
<dd>
|
|
6533
6569
|
|
|
6534
|
-
|
|
6570
|
+
Starts a task group by changing its status to in-progress and updating the order status. | authz_personas=[courier_driver, lig_org_operators] | () -> (bool)
|
|
6535
6571
|
|
|
6536
6572
|
</dd>
|
|
6537
6573
|
</dl>
|
|
@@ -6547,7 +6583,7 @@ Retrieves an expanded task group with optional related data for forwarder operat
|
|
|
6547
6583
|
<dd>
|
|
6548
6584
|
|
|
6549
6585
|
```typescript
|
|
6550
|
-
await client.taskGroups.
|
|
6586
|
+
await client.taskGroups.startV1("task_group_id");
|
|
6551
6587
|
```
|
|
6552
6588
|
|
|
6553
6589
|
</dd>
|
|
@@ -6582,7 +6618,9 @@ await client.taskGroups.getExpandedForForwarderOperatorsV1("task_group_id");
|
|
|
6582
6618
|
</dl>
|
|
6583
6619
|
</details>
|
|
6584
6620
|
|
|
6585
|
-
|
|
6621
|
+
## ShipperContactInfo
|
|
6622
|
+
|
|
6623
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByJwtUserIdV1</a>() -> Chrt.ShipperContact1</code></summary>
|
|
6586
6624
|
<dl>
|
|
6587
6625
|
<dd>
|
|
6588
6626
|
|
|
@@ -6594,7 +6632,7 @@ await client.taskGroups.getExpandedForForwarderOperatorsV1("task_group_id");
|
|
|
6594
6632
|
<dl>
|
|
6595
6633
|
<dd>
|
|
6596
6634
|
|
|
6597
|
-
Retrieves
|
|
6635
|
+
Retrieves the authenticated user's own shipper contact information. | () -> (ShipperContact1)
|
|
6598
6636
|
|
|
6599
6637
|
</dd>
|
|
6600
6638
|
</dl>
|
|
@@ -6610,7 +6648,7 @@ Retrieves a list of expanded task groups with optional filters and related data
|
|
|
6610
6648
|
<dd>
|
|
6611
6649
|
|
|
6612
6650
|
```typescript
|
|
6613
|
-
await client.
|
|
6651
|
+
await client.shipperContactInfo.getByJwtUserIdV1();
|
|
6614
6652
|
```
|
|
6615
6653
|
|
|
6616
6654
|
</dd>
|
|
@@ -6626,15 +6664,7 @@ await client.taskGroups.postExpandedListForCourierOperatorsV1({});
|
|
|
6626
6664
|
<dl>
|
|
6627
6665
|
<dd>
|
|
6628
6666
|
|
|
6629
|
-
**
|
|
6630
|
-
|
|
6631
|
-
</dd>
|
|
6632
|
-
</dl>
|
|
6633
|
-
|
|
6634
|
-
<dl>
|
|
6635
|
-
<dd>
|
|
6636
|
-
|
|
6637
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6667
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6638
6668
|
|
|
6639
6669
|
</dd>
|
|
6640
6670
|
</dl>
|
|
@@ -6645,7 +6675,7 @@ await client.taskGroups.postExpandedListForCourierOperatorsV1({});
|
|
|
6645
6675
|
</dl>
|
|
6646
6676
|
</details>
|
|
6647
6677
|
|
|
6648
|
-
<details><summary><code>client.
|
|
6678
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByJwtOrgIdV1</a>() -> Chrt.ShipperContact1[]</code></summary>
|
|
6649
6679
|
<dl>
|
|
6650
6680
|
<dd>
|
|
6651
6681
|
|
|
@@ -6657,7 +6687,7 @@ await client.taskGroups.postExpandedListForCourierOperatorsV1({});
|
|
|
6657
6687
|
<dl>
|
|
6658
6688
|
<dd>
|
|
6659
6689
|
|
|
6660
|
-
|
|
6690
|
+
Lists all shipper contacts created by the authenticated organization. | () -> (list[ShipperContact1])
|
|
6661
6691
|
|
|
6662
6692
|
</dd>
|
|
6663
6693
|
</dl>
|
|
@@ -6673,7 +6703,7 @@ Retrieves a list of expanded task groups with optional filters and related data
|
|
|
6673
6703
|
<dd>
|
|
6674
6704
|
|
|
6675
6705
|
```typescript
|
|
6676
|
-
await client.
|
|
6706
|
+
await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
6677
6707
|
```
|
|
6678
6708
|
|
|
6679
6709
|
</dd>
|
|
@@ -6689,15 +6719,7 @@ await client.taskGroups.postExpandedListForCourierDriverV1({});
|
|
|
6689
6719
|
<dl>
|
|
6690
6720
|
<dd>
|
|
6691
6721
|
|
|
6692
|
-
**
|
|
6693
|
-
|
|
6694
|
-
</dd>
|
|
6695
|
-
</dl>
|
|
6696
|
-
|
|
6697
|
-
<dl>
|
|
6698
|
-
<dd>
|
|
6699
|
-
|
|
6700
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6722
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6701
6723
|
|
|
6702
6724
|
</dd>
|
|
6703
6725
|
</dl>
|
|
@@ -6708,7 +6730,7 @@ await client.taskGroups.postExpandedListForCourierDriverV1({});
|
|
|
6708
6730
|
</dl>
|
|
6709
6731
|
</details>
|
|
6710
6732
|
|
|
6711
|
-
<details><summary><code>client.
|
|
6733
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listCourierContactsByShipperOrgIdV1</a>(shipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
|
|
6712
6734
|
<dl>
|
|
6713
6735
|
<dd>
|
|
6714
6736
|
|
|
@@ -6720,7 +6742,7 @@ await client.taskGroups.postExpandedListForCourierDriverV1({});
|
|
|
6720
6742
|
<dl>
|
|
6721
6743
|
<dd>
|
|
6722
6744
|
|
|
6723
|
-
|
|
6745
|
+
Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])
|
|
6724
6746
|
|
|
6725
6747
|
</dd>
|
|
6726
6748
|
</dl>
|
|
@@ -6736,7 +6758,7 @@ Retrieves a list of expanded task groups with optional filters and related data
|
|
|
6736
6758
|
<dd>
|
|
6737
6759
|
|
|
6738
6760
|
```typescript
|
|
6739
|
-
await client.
|
|
6761
|
+
await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org_id");
|
|
6740
6762
|
```
|
|
6741
6763
|
|
|
6742
6764
|
</dd>
|
|
@@ -6752,7 +6774,7 @@ await client.taskGroups.postExpandedListForForwarderOperatorsV1({});
|
|
|
6752
6774
|
<dl>
|
|
6753
6775
|
<dd>
|
|
6754
6776
|
|
|
6755
|
-
**
|
|
6777
|
+
**shipperOrgId:** `string`
|
|
6756
6778
|
|
|
6757
6779
|
</dd>
|
|
6758
6780
|
</dl>
|
|
@@ -6760,7 +6782,7 @@ await client.taskGroups.postExpandedListForForwarderOperatorsV1({});
|
|
|
6760
6782
|
<dl>
|
|
6761
6783
|
<dd>
|
|
6762
6784
|
|
|
6763
|
-
**requestOptions:** `
|
|
6785
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6764
6786
|
|
|
6765
6787
|
</dd>
|
|
6766
6788
|
</dl>
|
|
@@ -6771,7 +6793,7 @@ await client.taskGroups.postExpandedListForForwarderOperatorsV1({});
|
|
|
6771
6793
|
</dl>
|
|
6772
6794
|
</details>
|
|
6773
6795
|
|
|
6774
|
-
<details><summary><code>client.
|
|
6796
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByOffChrtShipperOrgIdV1</a>(offChrtShipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
|
|
6775
6797
|
<dl>
|
|
6776
6798
|
<dd>
|
|
6777
6799
|
|
|
@@ -6783,7 +6805,7 @@ await client.taskGroups.postExpandedListForForwarderOperatorsV1({});
|
|
|
6783
6805
|
<dl>
|
|
6784
6806
|
<dd>
|
|
6785
6807
|
|
|
6786
|
-
|
|
6808
|
+
Lists all shipper contacts for a specific off-platform shipper connection. | () -> (list[ShipperContact1])
|
|
6787
6809
|
|
|
6788
6810
|
</dd>
|
|
6789
6811
|
</dl>
|
|
@@ -6799,9 +6821,7 @@ Updates the ordering of tasks in a task group. Task group must be in STAGED or I
|
|
|
6799
6821
|
<dd>
|
|
6800
6822
|
|
|
6801
6823
|
```typescript
|
|
6802
|
-
await client.
|
|
6803
|
-
task_ordering: ["task_ordering"],
|
|
6804
|
-
});
|
|
6824
|
+
await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_org_id");
|
|
6805
6825
|
```
|
|
6806
6826
|
|
|
6807
6827
|
</dd>
|
|
@@ -6817,15 +6837,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6817
6837
|
<dl>
|
|
6818
6838
|
<dd>
|
|
6819
6839
|
|
|
6820
|
-
**
|
|
6821
|
-
|
|
6822
|
-
</dd>
|
|
6823
|
-
</dl>
|
|
6824
|
-
|
|
6825
|
-
<dl>
|
|
6826
|
-
<dd>
|
|
6827
|
-
|
|
6828
|
-
**request:** `Chrt.SetTaskOrderingReq`
|
|
6840
|
+
**offChrtShipperOrgId:** `string`
|
|
6829
6841
|
|
|
6830
6842
|
</dd>
|
|
6831
6843
|
</dl>
|
|
@@ -6833,7 +6845,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6833
6845
|
<dl>
|
|
6834
6846
|
<dd>
|
|
6835
6847
|
|
|
6836
|
-
**requestOptions:** `
|
|
6848
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6837
6849
|
|
|
6838
6850
|
</dd>
|
|
6839
6851
|
</dl>
|
|
@@ -6844,7 +6856,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6844
6856
|
</dl>
|
|
6845
6857
|
</details>
|
|
6846
6858
|
|
|
6847
|
-
<details><summary><code>client.
|
|
6859
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByIdV1</a>(id) -> Chrt.ShipperContact1</code></summary>
|
|
6848
6860
|
<dl>
|
|
6849
6861
|
<dd>
|
|
6850
6862
|
|
|
@@ -6856,7 +6868,7 @@ await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
6856
6868
|
<dl>
|
|
6857
6869
|
<dd>
|
|
6858
6870
|
|
|
6859
|
-
|
|
6871
|
+
Retrieves a specific shipper contact by ID if authorized to access it. | () -> (ShipperContact1)
|
|
6860
6872
|
|
|
6861
6873
|
</dd>
|
|
6862
6874
|
</dl>
|
|
@@ -6872,9 +6884,7 @@ Updates the flight number on both task group and all its tasks. Task group must
|
|
|
6872
6884
|
<dd>
|
|
6873
6885
|
|
|
6874
6886
|
```typescript
|
|
6875
|
-
await client.
|
|
6876
|
-
flight_number: "flight_number",
|
|
6877
|
-
});
|
|
6887
|
+
await client.shipperContactInfo.getByIdV1("id");
|
|
6878
6888
|
```
|
|
6879
6889
|
|
|
6880
6890
|
</dd>
|
|
@@ -6890,15 +6900,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6890
6900
|
<dl>
|
|
6891
6901
|
<dd>
|
|
6892
6902
|
|
|
6893
|
-
**
|
|
6894
|
-
|
|
6895
|
-
</dd>
|
|
6896
|
-
</dl>
|
|
6897
|
-
|
|
6898
|
-
<dl>
|
|
6899
|
-
<dd>
|
|
6900
|
-
|
|
6901
|
-
**request:** `Chrt.SetFlightNumberReq`
|
|
6903
|
+
**id:** `string`
|
|
6902
6904
|
|
|
6903
6905
|
</dd>
|
|
6904
6906
|
</dl>
|
|
@@ -6906,7 +6908,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6906
6908
|
<dl>
|
|
6907
6909
|
<dd>
|
|
6908
6910
|
|
|
6909
|
-
**requestOptions:** `
|
|
6911
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6910
6912
|
|
|
6911
6913
|
</dd>
|
|
6912
6914
|
</dl>
|
|
@@ -6917,7 +6919,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6917
6919
|
</dl>
|
|
6918
6920
|
</details>
|
|
6919
6921
|
|
|
6920
|
-
<details><summary><code>client.
|
|
6922
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOnPlatformV1</a>({ ...params }) -> string</code></summary>
|
|
6921
6923
|
<dl>
|
|
6922
6924
|
<dd>
|
|
6923
6925
|
|
|
@@ -6929,7 +6931,7 @@ await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
|
6929
6931
|
<dl>
|
|
6930
6932
|
<dd>
|
|
6931
6933
|
|
|
6932
|
-
|
|
6934
|
+
Creates contact information for an on-platform shipper organization or user. | (ShipperContactClientCreate1) -> (PydanticObjectId)
|
|
6933
6935
|
|
|
6934
6936
|
</dd>
|
|
6935
6937
|
</dl>
|
|
@@ -6945,7 +6947,9 @@ Sets or removes the driver assigned to a task group. | authz_personas=[courier_o
|
|
|
6945
6947
|
<dd>
|
|
6946
6948
|
|
|
6947
6949
|
```typescript
|
|
6948
|
-
await client.
|
|
6950
|
+
await client.shipperContactInfo.createOnPlatformV1({
|
|
6951
|
+
schema_version: 1,
|
|
6952
|
+
});
|
|
6949
6953
|
```
|
|
6950
6954
|
|
|
6951
6955
|
</dd>
|
|
@@ -6961,15 +6965,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6961
6965
|
<dl>
|
|
6962
6966
|
<dd>
|
|
6963
6967
|
|
|
6964
|
-
**
|
|
6965
|
-
|
|
6966
|
-
</dd>
|
|
6967
|
-
</dl>
|
|
6968
|
-
|
|
6969
|
-
<dl>
|
|
6970
|
-
<dd>
|
|
6971
|
-
|
|
6972
|
-
**request:** `Chrt.UpdateTaskGroupDriverReq`
|
|
6968
|
+
**request:** `Chrt.ShipperContactClientCreate1`
|
|
6973
6969
|
|
|
6974
6970
|
</dd>
|
|
6975
6971
|
</dl>
|
|
@@ -6977,7 +6973,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6977
6973
|
<dl>
|
|
6978
6974
|
<dd>
|
|
6979
6975
|
|
|
6980
|
-
**requestOptions:** `
|
|
6976
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6981
6977
|
|
|
6982
6978
|
</dd>
|
|
6983
6979
|
</dl>
|
|
@@ -6988,7 +6984,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
6988
6984
|
</dl>
|
|
6989
6985
|
</details>
|
|
6990
6986
|
|
|
6991
|
-
<details><summary><code>client.
|
|
6987
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOffPlatformV1</a>({ ...params }) -> string</code></summary>
|
|
6992
6988
|
<dl>
|
|
6993
6989
|
<dd>
|
|
6994
6990
|
|
|
@@ -7000,7 +6996,7 @@ await client.taskGroups.updateDriverV1("task_group_id");
|
|
|
7000
6996
|
<dl>
|
|
7001
6997
|
<dd>
|
|
7002
6998
|
|
|
7003
|
-
|
|
6999
|
+
Creates contact information for an off-platform shipper using connection info. | (ShipperContactClientCreate1) -> (PydanticObjectId)
|
|
7004
7000
|
|
|
7005
7001
|
</dd>
|
|
7006
7002
|
</dl>
|
|
@@ -7016,7 +7012,9 @@ Sets or removes the courier organization assigned to a task group. | authz_perso
|
|
|
7016
7012
|
<dd>
|
|
7017
7013
|
|
|
7018
7014
|
```typescript
|
|
7019
|
-
await client.
|
|
7015
|
+
await client.shipperContactInfo.createOffPlatformV1({
|
|
7016
|
+
schema_version: 1,
|
|
7017
|
+
});
|
|
7020
7018
|
```
|
|
7021
7019
|
|
|
7022
7020
|
</dd>
|
|
@@ -7032,15 +7030,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
7032
7030
|
<dl>
|
|
7033
7031
|
<dd>
|
|
7034
7032
|
|
|
7035
|
-
**
|
|
7036
|
-
|
|
7037
|
-
</dd>
|
|
7038
|
-
</dl>
|
|
7039
|
-
|
|
7040
|
-
<dl>
|
|
7041
|
-
<dd>
|
|
7042
|
-
|
|
7043
|
-
**request:** `Chrt.UpdateTaskGroupCourierOrgReq`
|
|
7033
|
+
**request:** `Chrt.ShipperContactClientCreate1`
|
|
7044
7034
|
|
|
7045
7035
|
</dd>
|
|
7046
7036
|
</dl>
|
|
@@ -7048,7 +7038,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
7048
7038
|
<dl>
|
|
7049
7039
|
<dd>
|
|
7050
7040
|
|
|
7051
|
-
**requestOptions:** `
|
|
7041
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7052
7042
|
|
|
7053
7043
|
</dd>
|
|
7054
7044
|
</dl>
|
|
@@ -7059,7 +7049,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
7059
7049
|
</dl>
|
|
7060
7050
|
</details>
|
|
7061
7051
|
|
|
7062
|
-
<details><summary><code>client.
|
|
7052
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">updateV1</a>(shipperContactInfoId, { ...params }) -> boolean</code></summary>
|
|
7063
7053
|
<dl>
|
|
7064
7054
|
<dd>
|
|
7065
7055
|
|
|
@@ -7071,7 +7061,7 @@ await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
|
7071
7061
|
<dl>
|
|
7072
7062
|
<dd>
|
|
7073
7063
|
|
|
7074
|
-
|
|
7064
|
+
Updates existing shipper contact information owned by the authenticated organization. | (ShipperContactClientUpdate1) -> (bool)
|
|
7075
7065
|
|
|
7076
7066
|
</dd>
|
|
7077
7067
|
</dl>
|
|
@@ -7087,7 +7077,7 @@ Starts a task group by changing its status to in-progress and updating the order
|
|
|
7087
7077
|
<dd>
|
|
7088
7078
|
|
|
7089
7079
|
```typescript
|
|
7090
|
-
await client.
|
|
7080
|
+
await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
7091
7081
|
```
|
|
7092
7082
|
|
|
7093
7083
|
</dd>
|
|
@@ -7103,7 +7093,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
7103
7093
|
<dl>
|
|
7104
7094
|
<dd>
|
|
7105
7095
|
|
|
7106
|
-
**
|
|
7096
|
+
**shipperContactInfoId:** `string`
|
|
7107
7097
|
|
|
7108
7098
|
</dd>
|
|
7109
7099
|
</dl>
|
|
@@ -7111,7 +7101,15 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
7111
7101
|
<dl>
|
|
7112
7102
|
<dd>
|
|
7113
7103
|
|
|
7114
|
-
**
|
|
7104
|
+
**request:** `Chrt.ShipperContactClientUpdate1`
|
|
7105
|
+
|
|
7106
|
+
</dd>
|
|
7107
|
+
</dl>
|
|
7108
|
+
|
|
7109
|
+
<dl>
|
|
7110
|
+
<dd>
|
|
7111
|
+
|
|
7112
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7115
7113
|
|
|
7116
7114
|
</dd>
|
|
7117
7115
|
</dl>
|
|
@@ -7122,9 +7120,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
7122
7120
|
</dl>
|
|
7123
7121
|
</details>
|
|
7124
7122
|
|
|
7125
|
-
|
|
7126
|
-
|
|
7127
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByJwtUserIdV1</a>() -> Chrt.ShipperContact1</code></summary>
|
|
7123
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">deleteByIdV1</a>(id) -> boolean</code></summary>
|
|
7128
7124
|
<dl>
|
|
7129
7125
|
<dd>
|
|
7130
7126
|
|
|
@@ -7136,7 +7132,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
7136
7132
|
<dl>
|
|
7137
7133
|
<dd>
|
|
7138
7134
|
|
|
7139
|
-
|
|
7135
|
+
Deletes shipper contact information owned by the authenticated organization. | () -> (bool)
|
|
7140
7136
|
|
|
7141
7137
|
</dd>
|
|
7142
7138
|
</dl>
|
|
@@ -7152,7 +7148,7 @@ Retrieves the authenticated user's own shipper contact information. | () -> (Shi
|
|
|
7152
7148
|
<dd>
|
|
7153
7149
|
|
|
7154
7150
|
```typescript
|
|
7155
|
-
await client.shipperContactInfo.
|
|
7151
|
+
await client.shipperContactInfo.deleteByIdV1("id");
|
|
7156
7152
|
```
|
|
7157
7153
|
|
|
7158
7154
|
</dd>
|
|
@@ -7168,6 +7164,14 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
7168
7164
|
<dl>
|
|
7169
7165
|
<dd>
|
|
7170
7166
|
|
|
7167
|
+
**id:** `string`
|
|
7168
|
+
|
|
7169
|
+
</dd>
|
|
7170
|
+
</dl>
|
|
7171
|
+
|
|
7172
|
+
<dl>
|
|
7173
|
+
<dd>
|
|
7174
|
+
|
|
7171
7175
|
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7172
7176
|
|
|
7173
7177
|
</dd>
|
|
@@ -7179,7 +7183,9 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
7179
7183
|
</dl>
|
|
7180
7184
|
</details>
|
|
7181
7185
|
|
|
7182
|
-
|
|
7186
|
+
## Orgs
|
|
7187
|
+
|
|
7188
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> Record<string, unknown></code></summary>
|
|
7183
7189
|
<dl>
|
|
7184
7190
|
<dd>
|
|
7185
7191
|
|
|
@@ -7191,7 +7197,7 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
7191
7197
|
<dl>
|
|
7192
7198
|
<dd>
|
|
7193
7199
|
|
|
7194
|
-
|
|
7200
|
+
Retrieves basic organization information from the authentication service. | () -> (dict)
|
|
7195
7201
|
|
|
7196
7202
|
</dd>
|
|
7197
7203
|
</dl>
|
|
@@ -7207,7 +7213,7 @@ Lists all shipper contacts created by the authenticated organization. | () -> (l
|
|
|
7207
7213
|
<dd>
|
|
7208
7214
|
|
|
7209
7215
|
```typescript
|
|
7210
|
-
await client.
|
|
7216
|
+
await client.orgs.getInfoV1();
|
|
7211
7217
|
```
|
|
7212
7218
|
|
|
7213
7219
|
</dd>
|
|
@@ -7223,7 +7229,7 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
7223
7229
|
<dl>
|
|
7224
7230
|
<dd>
|
|
7225
7231
|
|
|
7226
|
-
**requestOptions:** `
|
|
7232
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7227
7233
|
|
|
7228
7234
|
</dd>
|
|
7229
7235
|
</dl>
|
|
@@ -7234,7 +7240,7 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
7234
7240
|
</dl>
|
|
7235
7241
|
</details>
|
|
7236
7242
|
|
|
7237
|
-
<details><summary><code>client.
|
|
7243
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">listMembersV1</a>() -> Chrt.OrgMemberDetails[]</code></summary>
|
|
7238
7244
|
<dl>
|
|
7239
7245
|
<dd>
|
|
7240
7246
|
|
|
@@ -7246,7 +7252,7 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
7246
7252
|
<dl>
|
|
7247
7253
|
<dd>
|
|
7248
7254
|
|
|
7249
|
-
Lists all
|
|
7255
|
+
Lists all members of the authenticated organization with their roles and details. | () -> (list[OrgMemberDetails])
|
|
7250
7256
|
|
|
7251
7257
|
</dd>
|
|
7252
7258
|
</dl>
|
|
@@ -7262,7 +7268,7 @@ Lists all shipper contacts accessible to the courier organization for a specific
|
|
|
7262
7268
|
<dd>
|
|
7263
7269
|
|
|
7264
7270
|
```typescript
|
|
7265
|
-
await client.
|
|
7271
|
+
await client.orgs.listMembersV1();
|
|
7266
7272
|
```
|
|
7267
7273
|
|
|
7268
7274
|
</dd>
|
|
@@ -7278,15 +7284,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
7278
7284
|
<dl>
|
|
7279
7285
|
<dd>
|
|
7280
7286
|
|
|
7281
|
-
**
|
|
7282
|
-
|
|
7283
|
-
</dd>
|
|
7284
|
-
</dl>
|
|
7285
|
-
|
|
7286
|
-
<dl>
|
|
7287
|
-
<dd>
|
|
7288
|
-
|
|
7289
|
-
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7287
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7290
7288
|
|
|
7291
7289
|
</dd>
|
|
7292
7290
|
</dl>
|
|
@@ -7297,7 +7295,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
7297
7295
|
</dl>
|
|
7298
7296
|
</details>
|
|
7299
7297
|
|
|
7300
|
-
<details><summary><code>client.
|
|
7298
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataV1</a>() -> Chrt.OrgPublicData1</code></summary>
|
|
7301
7299
|
<dl>
|
|
7302
7300
|
<dd>
|
|
7303
7301
|
|
|
@@ -7309,7 +7307,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
7309
7307
|
<dl>
|
|
7310
7308
|
<dd>
|
|
7311
7309
|
|
|
7312
|
-
|
|
7310
|
+
Retrieves public organization data for the authenticated organization. | () -> (OrgPublicData1)
|
|
7313
7311
|
|
|
7314
7312
|
</dd>
|
|
7315
7313
|
</dl>
|
|
@@ -7325,7 +7323,7 @@ Lists all shipper contacts for a specific off-platform shipper connection. | ()
|
|
|
7325
7323
|
<dd>
|
|
7326
7324
|
|
|
7327
7325
|
```typescript
|
|
7328
|
-
await client.
|
|
7326
|
+
await client.orgs.getOrgPublicDataV1();
|
|
7329
7327
|
```
|
|
7330
7328
|
|
|
7331
7329
|
</dd>
|
|
@@ -7341,15 +7339,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
7341
7339
|
<dl>
|
|
7342
7340
|
<dd>
|
|
7343
7341
|
|
|
7344
|
-
**
|
|
7345
|
-
|
|
7346
|
-
</dd>
|
|
7347
|
-
</dl>
|
|
7348
|
-
|
|
7349
|
-
<dl>
|
|
7350
|
-
<dd>
|
|
7351
|
-
|
|
7352
|
-
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
7342
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7353
7343
|
|
|
7354
7344
|
</dd>
|
|
7355
7345
|
</dl>
|
|
@@ -7360,7 +7350,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
7360
7350
|
</dl>
|
|
7361
7351
|
</details>
|
|
7362
7352
|
|
|
7363
|
-
<details><summary><code>client.
|
|
7353
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">createOrgPublicDataV1</a>({ ...params }) -> Chrt.CreateOrgPublicDataRes</code></summary>
|
|
7364
7354
|
<dl>
|
|
7365
7355
|
<dd>
|
|
7366
7356
|
|
|
@@ -7372,7 +7362,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
7372
7362
|
<dl>
|
|
7373
7363
|
<dd>
|
|
7374
7364
|
|
|
7375
|
-
|
|
7365
|
+
Creates org_public_data and org_private_data documents for the authenticated organization using org_type from JWT. | (CreateOrgPublicDataReq) -> (CreateOrgPublicDataRes)
|
|
7376
7366
|
|
|
7377
7367
|
</dd>
|
|
7378
7368
|
</dl>
|
|
@@ -7388,7 +7378,7 @@ Retrieves a specific shipper contact by ID if authorized to access it. | () -> (
|
|
|
7388
7378
|
<dd>
|
|
7389
7379
|
|
|
7390
7380
|
```typescript
|
|
7391
|
-
await client.
|
|
7381
|
+
await client.orgs.createOrgPublicDataV1();
|
|
7392
7382
|
```
|
|
7393
7383
|
|
|
7394
7384
|
</dd>
|
|
@@ -7404,7 +7394,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
7404
7394
|
<dl>
|
|
7405
7395
|
<dd>
|
|
7406
7396
|
|
|
7407
|
-
**
|
|
7397
|
+
**request:** `Chrt.CreateOrgPublicDataReq`
|
|
7408
7398
|
|
|
7409
7399
|
</dd>
|
|
7410
7400
|
</dl>
|
|
@@ -7412,7 +7402,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
7412
7402
|
<dl>
|
|
7413
7403
|
<dd>
|
|
7414
7404
|
|
|
7415
|
-
**requestOptions:** `
|
|
7405
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7416
7406
|
|
|
7417
7407
|
</dd>
|
|
7418
7408
|
</dl>
|
|
@@ -7423,7 +7413,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
7423
7413
|
</dl>
|
|
7424
7414
|
</details>
|
|
7425
7415
|
|
|
7426
|
-
<details><summary><code>client.
|
|
7416
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">updateOrgPublicDataV1</a>({ ...params }) -> boolean</code></summary>
|
|
7427
7417
|
<dl>
|
|
7428
7418
|
<dd>
|
|
7429
7419
|
|
|
@@ -7435,7 +7425,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
7435
7425
|
<dl>
|
|
7436
7426
|
<dd>
|
|
7437
7427
|
|
|
7438
|
-
|
|
7428
|
+
Updates the handle and/or company_name for the authenticated organization. | (UpdateOrgPublicDataReq) -> (bool)
|
|
7439
7429
|
|
|
7440
7430
|
</dd>
|
|
7441
7431
|
</dl>
|
|
@@ -7451,9 +7441,7 @@ Creates contact information for an on-platform shipper organization or user. | (
|
|
|
7451
7441
|
<dd>
|
|
7452
7442
|
|
|
7453
7443
|
```typescript
|
|
7454
|
-
await client.
|
|
7455
|
-
schema_version: 1,
|
|
7456
|
-
});
|
|
7444
|
+
await client.orgs.updateOrgPublicDataV1();
|
|
7457
7445
|
```
|
|
7458
7446
|
|
|
7459
7447
|
</dd>
|
|
@@ -7469,7 +7457,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
7469
7457
|
<dl>
|
|
7470
7458
|
<dd>
|
|
7471
7459
|
|
|
7472
|
-
**request:** `Chrt.
|
|
7460
|
+
**request:** `Chrt.UpdateOrgPublicDataReq`
|
|
7473
7461
|
|
|
7474
7462
|
</dd>
|
|
7475
7463
|
</dl>
|
|
@@ -7477,7 +7465,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
7477
7465
|
<dl>
|
|
7478
7466
|
<dd>
|
|
7479
7467
|
|
|
7480
|
-
**requestOptions:** `
|
|
7468
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7481
7469
|
|
|
7482
7470
|
</dd>
|
|
7483
7471
|
</dl>
|
|
@@ -7488,7 +7476,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
7488
7476
|
</dl>
|
|
7489
7477
|
</details>
|
|
7490
7478
|
|
|
7491
|
-
<details><summary><code>client.
|
|
7479
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataByOrgIdV1</a>(orgId) -> Chrt.OrgPublicData1</code></summary>
|
|
7492
7480
|
<dl>
|
|
7493
7481
|
<dd>
|
|
7494
7482
|
|
|
@@ -7500,7 +7488,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
7500
7488
|
<dl>
|
|
7501
7489
|
<dd>
|
|
7502
7490
|
|
|
7503
|
-
|
|
7491
|
+
Retrieves public organization data for a specific organization by ID. | () -> (OrgPublicData1)
|
|
7504
7492
|
|
|
7505
7493
|
</dd>
|
|
7506
7494
|
</dl>
|
|
@@ -7516,9 +7504,7 @@ Creates contact information for an off-platform shipper using connection info. |
|
|
|
7516
7504
|
<dd>
|
|
7517
7505
|
|
|
7518
7506
|
```typescript
|
|
7519
|
-
await client.
|
|
7520
|
-
schema_version: 1,
|
|
7521
|
-
});
|
|
7507
|
+
await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
7522
7508
|
```
|
|
7523
7509
|
|
|
7524
7510
|
</dd>
|
|
@@ -7534,7 +7520,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
7534
7520
|
<dl>
|
|
7535
7521
|
<dd>
|
|
7536
7522
|
|
|
7537
|
-
**
|
|
7523
|
+
**orgId:** `string`
|
|
7538
7524
|
|
|
7539
7525
|
</dd>
|
|
7540
7526
|
</dl>
|
|
@@ -7542,7 +7528,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
7542
7528
|
<dl>
|
|
7543
7529
|
<dd>
|
|
7544
7530
|
|
|
7545
|
-
**requestOptions:** `
|
|
7531
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7546
7532
|
|
|
7547
7533
|
</dd>
|
|
7548
7534
|
</dl>
|
|
@@ -7553,7 +7539,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
7553
7539
|
</dl>
|
|
7554
7540
|
</details>
|
|
7555
7541
|
|
|
7556
|
-
<details><summary><code>client.
|
|
7542
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataHandleAvailabilityV1</a>(handle) -> boolean</code></summary>
|
|
7557
7543
|
<dl>
|
|
7558
7544
|
<dd>
|
|
7559
7545
|
|
|
@@ -7565,7 +7551,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
7565
7551
|
<dl>
|
|
7566
7552
|
<dd>
|
|
7567
7553
|
|
|
7568
|
-
|
|
7554
|
+
Returns True when the provided handle is available, otherwise False. | () -> (bool)
|
|
7569
7555
|
|
|
7570
7556
|
</dd>
|
|
7571
7557
|
</dl>
|
|
@@ -7581,7 +7567,7 @@ Updates existing shipper contact information owned by the authenticated organiza
|
|
|
7581
7567
|
<dd>
|
|
7582
7568
|
|
|
7583
7569
|
```typescript
|
|
7584
|
-
await client.
|
|
7570
|
+
await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
7585
7571
|
```
|
|
7586
7572
|
|
|
7587
7573
|
</dd>
|
|
@@ -7597,15 +7583,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
7597
7583
|
<dl>
|
|
7598
7584
|
<dd>
|
|
7599
7585
|
|
|
7600
|
-
**
|
|
7601
|
-
|
|
7602
|
-
</dd>
|
|
7603
|
-
</dl>
|
|
7604
|
-
|
|
7605
|
-
<dl>
|
|
7606
|
-
<dd>
|
|
7607
|
-
|
|
7608
|
-
**request:** `Chrt.ShipperContactClientUpdate1`
|
|
7586
|
+
**handle:** `string`
|
|
7609
7587
|
|
|
7610
7588
|
</dd>
|
|
7611
7589
|
</dl>
|
|
@@ -7613,7 +7591,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
7613
7591
|
<dl>
|
|
7614
7592
|
<dd>
|
|
7615
7593
|
|
|
7616
|
-
**requestOptions:** `
|
|
7594
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7617
7595
|
|
|
7618
7596
|
</dd>
|
|
7619
7597
|
</dl>
|
|
@@ -7624,7 +7602,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
7624
7602
|
</dl>
|
|
7625
7603
|
</details>
|
|
7626
7604
|
|
|
7627
|
-
<details><summary><code>client.
|
|
7605
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">setOrgTypeV1</a>({ ...params }) -> boolean</code></summary>
|
|
7628
7606
|
<dl>
|
|
7629
7607
|
<dd>
|
|
7630
7608
|
|
|
@@ -7636,7 +7614,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
7636
7614
|
<dl>
|
|
7637
7615
|
<dd>
|
|
7638
7616
|
|
|
7639
|
-
|
|
7617
|
+
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)
|
|
7640
7618
|
|
|
7641
7619
|
</dd>
|
|
7642
7620
|
</dl>
|
|
@@ -7652,7 +7630,9 @@ Deletes shipper contact information owned by the authenticated organization. | (
|
|
|
7652
7630
|
<dd>
|
|
7653
7631
|
|
|
7654
7632
|
```typescript
|
|
7655
|
-
await client.
|
|
7633
|
+
await client.orgs.setOrgTypeV1({
|
|
7634
|
+
org_type: "courier",
|
|
7635
|
+
});
|
|
7656
7636
|
```
|
|
7657
7637
|
|
|
7658
7638
|
</dd>
|
|
@@ -7668,7 +7648,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
7668
7648
|
<dl>
|
|
7669
7649
|
<dd>
|
|
7670
7650
|
|
|
7671
|
-
**
|
|
7651
|
+
**request:** `Chrt.SetOrgTypeReq`
|
|
7672
7652
|
|
|
7673
7653
|
</dd>
|
|
7674
7654
|
</dl>
|
|
@@ -7676,7 +7656,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
7676
7656
|
<dl>
|
|
7677
7657
|
<dd>
|
|
7678
7658
|
|
|
7679
|
-
**requestOptions:** `
|
|
7659
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7680
7660
|
|
|
7681
7661
|
</dd>
|
|
7682
7662
|
</dl>
|
|
@@ -7687,9 +7667,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
7687
7667
|
</dl>
|
|
7688
7668
|
</details>
|
|
7689
7669
|
|
|
7690
|
-
|
|
7691
|
-
|
|
7692
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> Record<string, unknown></code></summary>
|
|
7670
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getStripeConnectAccountIdV1</a>() -> string</code></summary>
|
|
7693
7671
|
<dl>
|
|
7694
7672
|
<dd>
|
|
7695
7673
|
|
|
@@ -7701,7 +7679,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
7701
7679
|
<dl>
|
|
7702
7680
|
<dd>
|
|
7703
7681
|
|
|
7704
|
-
Retrieves
|
|
7682
|
+
Retrieves the Stripe Connect account ID for the authenticated organization. Returns 404 if not set. | () -> (str)
|
|
7705
7683
|
|
|
7706
7684
|
</dd>
|
|
7707
7685
|
</dl>
|
|
@@ -7717,7 +7695,7 @@ Retrieves basic organization information from the authentication service. | () -
|
|
|
7717
7695
|
<dd>
|
|
7718
7696
|
|
|
7719
7697
|
```typescript
|
|
7720
|
-
await client.orgs.
|
|
7698
|
+
await client.orgs.getStripeConnectAccountIdV1();
|
|
7721
7699
|
```
|
|
7722
7700
|
|
|
7723
7701
|
</dd>
|
|
@@ -7744,7 +7722,9 @@ await client.orgs.getInfoV1();
|
|
|
7744
7722
|
</dl>
|
|
7745
7723
|
</details>
|
|
7746
7724
|
|
|
7747
|
-
|
|
7725
|
+
## Root
|
|
7726
|
+
|
|
7727
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingAuthd</a>() -> Record<string, string></code></summary>
|
|
7748
7728
|
<dl>
|
|
7749
7729
|
<dd>
|
|
7750
7730
|
|
|
@@ -7756,7 +7736,7 @@ await client.orgs.getInfoV1();
|
|
|
7756
7736
|
<dl>
|
|
7757
7737
|
<dd>
|
|
7758
7738
|
|
|
7759
|
-
|
|
7739
|
+
Test endpoint for authenticated requests that requires valid authentication tokens. | () -> (dict[str, str])
|
|
7760
7740
|
|
|
7761
7741
|
</dd>
|
|
7762
7742
|
</dl>
|
|
@@ -7772,7 +7752,7 @@ Lists all members of the authenticated organization with their roles and details
|
|
|
7772
7752
|
<dd>
|
|
7773
7753
|
|
|
7774
7754
|
```typescript
|
|
7775
|
-
await client.
|
|
7755
|
+
await client.root.pingAuthd();
|
|
7776
7756
|
```
|
|
7777
7757
|
|
|
7778
7758
|
</dd>
|
|
@@ -7788,7 +7768,7 @@ await client.orgs.listMembersV1();
|
|
|
7788
7768
|
<dl>
|
|
7789
7769
|
<dd>
|
|
7790
7770
|
|
|
7791
|
-
**requestOptions:** `
|
|
7771
|
+
**requestOptions:** `Root.RequestOptions`
|
|
7792
7772
|
|
|
7793
7773
|
</dd>
|
|
7794
7774
|
</dl>
|
|
@@ -7799,7 +7779,7 @@ await client.orgs.listMembersV1();
|
|
|
7799
7779
|
</dl>
|
|
7800
7780
|
</details>
|
|
7801
7781
|
|
|
7802
|
-
<details><summary><code>client.
|
|
7782
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingOptionallyAuthd</a>() -> Record<string, unknown></code></summary>
|
|
7803
7783
|
<dl>
|
|
7804
7784
|
<dd>
|
|
7805
7785
|
|
|
@@ -7811,7 +7791,7 @@ await client.orgs.listMembersV1();
|
|
|
7811
7791
|
<dl>
|
|
7812
7792
|
<dd>
|
|
7813
7793
|
|
|
7814
|
-
|
|
7794
|
+
Test endpoint for optionally authenticated requests that works with or without authentication. | () -> (dict)
|
|
7815
7795
|
|
|
7816
7796
|
</dd>
|
|
7817
7797
|
</dl>
|
|
@@ -7827,7 +7807,7 @@ Retrieves public organization data for the authenticated organization. | () -> (
|
|
|
7827
7807
|
<dd>
|
|
7828
7808
|
|
|
7829
7809
|
```typescript
|
|
7830
|
-
await client.
|
|
7810
|
+
await client.root.pingOptionallyAuthd();
|
|
7831
7811
|
```
|
|
7832
7812
|
|
|
7833
7813
|
</dd>
|
|
@@ -7843,7 +7823,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
7843
7823
|
<dl>
|
|
7844
7824
|
<dd>
|
|
7845
7825
|
|
|
7846
|
-
**requestOptions:** `
|
|
7826
|
+
**requestOptions:** `Root.RequestOptions`
|
|
7847
7827
|
|
|
7848
7828
|
</dd>
|
|
7849
7829
|
</dl>
|
|
@@ -7854,7 +7834,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
7854
7834
|
</dl>
|
|
7855
7835
|
</details>
|
|
7856
7836
|
|
|
7857
|
-
<details><summary><code>client.
|
|
7837
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingUnauthd</a>() -> Record<string, unknown></code></summary>
|
|
7858
7838
|
<dl>
|
|
7859
7839
|
<dd>
|
|
7860
7840
|
|
|
@@ -7866,7 +7846,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
7866
7846
|
<dl>
|
|
7867
7847
|
<dd>
|
|
7868
7848
|
|
|
7869
|
-
|
|
7849
|
+
Returns a greeting message to verify the API is accessible. | () -> (dict)
|
|
7870
7850
|
|
|
7871
7851
|
</dd>
|
|
7872
7852
|
</dl>
|
|
@@ -7882,7 +7862,7 @@ Creates org_public_data and org_private_data documents for the authenticated org
|
|
|
7882
7862
|
<dd>
|
|
7883
7863
|
|
|
7884
7864
|
```typescript
|
|
7885
|
-
await client.
|
|
7865
|
+
await client.root.pingUnauthd();
|
|
7886
7866
|
```
|
|
7887
7867
|
|
|
7888
7868
|
</dd>
|
|
@@ -7898,15 +7878,7 @@ await client.orgs.createOrgPublicDataV1();
|
|
|
7898
7878
|
<dl>
|
|
7899
7879
|
<dd>
|
|
7900
7880
|
|
|
7901
|
-
**
|
|
7902
|
-
|
|
7903
|
-
</dd>
|
|
7904
|
-
</dl>
|
|
7905
|
-
|
|
7906
|
-
<dl>
|
|
7907
|
-
<dd>
|
|
7908
|
-
|
|
7909
|
-
**requestOptions:** `Orgs.RequestOptions`
|
|
7881
|
+
**requestOptions:** `Root.RequestOptions`
|
|
7910
7882
|
|
|
7911
7883
|
</dd>
|
|
7912
7884
|
</dl>
|
|
@@ -7917,7 +7889,7 @@ await client.orgs.createOrgPublicDataV1();
|
|
|
7917
7889
|
</dl>
|
|
7918
7890
|
</details>
|
|
7919
7891
|
|
|
7920
|
-
<details><summary><code>client.
|
|
7892
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> Record<string, unknown></code></summary>
|
|
7921
7893
|
<dl>
|
|
7922
7894
|
<dd>
|
|
7923
7895
|
|
|
@@ -7929,7 +7901,7 @@ await client.orgs.createOrgPublicDataV1();
|
|
|
7929
7901
|
<dl>
|
|
7930
7902
|
<dd>
|
|
7931
7903
|
|
|
7932
|
-
|
|
7904
|
+
Returns a health status message used for monitoring system availability and uptime. | () -> (dict)
|
|
7933
7905
|
|
|
7934
7906
|
</dd>
|
|
7935
7907
|
</dl>
|
|
@@ -7945,7 +7917,7 @@ Updates the handle and/or company_name for the authenticated organization. | (Up
|
|
|
7945
7917
|
<dd>
|
|
7946
7918
|
|
|
7947
7919
|
```typescript
|
|
7948
|
-
await client.
|
|
7920
|
+
await client.root.health();
|
|
7949
7921
|
```
|
|
7950
7922
|
|
|
7951
7923
|
</dd>
|
|
@@ -7961,15 +7933,7 @@ await client.orgs.updateOrgPublicDataV1();
|
|
|
7961
7933
|
<dl>
|
|
7962
7934
|
<dd>
|
|
7963
7935
|
|
|
7964
|
-
**
|
|
7965
|
-
|
|
7966
|
-
</dd>
|
|
7967
|
-
</dl>
|
|
7968
|
-
|
|
7969
|
-
<dl>
|
|
7970
|
-
<dd>
|
|
7971
|
-
|
|
7972
|
-
**requestOptions:** `Orgs.RequestOptions`
|
|
7936
|
+
**requestOptions:** `Root.RequestOptions`
|
|
7973
7937
|
|
|
7974
7938
|
</dd>
|
|
7975
7939
|
</dl>
|
|
@@ -7980,7 +7944,7 @@ await client.orgs.updateOrgPublicDataV1();
|
|
|
7980
7944
|
</dl>
|
|
7981
7945
|
</details>
|
|
7982
7946
|
|
|
7983
|
-
<details><summary><code>client.
|
|
7947
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">failure</a>() -> unknown</code></summary>
|
|
7984
7948
|
<dl>
|
|
7985
7949
|
<dd>
|
|
7986
7950
|
|
|
@@ -7992,7 +7956,7 @@ await client.orgs.updateOrgPublicDataV1();
|
|
|
7992
7956
|
<dl>
|
|
7993
7957
|
<dd>
|
|
7994
7958
|
|
|
7995
|
-
|
|
7959
|
+
Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)
|
|
7996
7960
|
|
|
7997
7961
|
</dd>
|
|
7998
7962
|
</dl>
|
|
@@ -8008,7 +7972,7 @@ Retrieves public organization data for a specific organization by ID. | () -> (O
|
|
|
8008
7972
|
<dd>
|
|
8009
7973
|
|
|
8010
7974
|
```typescript
|
|
8011
|
-
await client.
|
|
7975
|
+
await client.root.failure();
|
|
8012
7976
|
```
|
|
8013
7977
|
|
|
8014
7978
|
</dd>
|
|
@@ -8024,15 +7988,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
8024
7988
|
<dl>
|
|
8025
7989
|
<dd>
|
|
8026
7990
|
|
|
8027
|
-
**
|
|
8028
|
-
|
|
8029
|
-
</dd>
|
|
8030
|
-
</dl>
|
|
8031
|
-
|
|
8032
|
-
<dl>
|
|
8033
|
-
<dd>
|
|
8034
|
-
|
|
8035
|
-
**requestOptions:** `Orgs.RequestOptions`
|
|
7991
|
+
**requestOptions:** `Root.RequestOptions`
|
|
8036
7992
|
|
|
8037
7993
|
</dd>
|
|
8038
7994
|
</dl>
|
|
@@ -8043,7 +7999,9 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
8043
7999
|
</dl>
|
|
8044
8000
|
</details>
|
|
8045
8001
|
|
|
8046
|
-
|
|
8002
|
+
## Users
|
|
8003
|
+
|
|
8004
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPublicDataV1</a>() -> Chrt.UserPublicData1</code></summary>
|
|
8047
8005
|
<dl>
|
|
8048
8006
|
<dd>
|
|
8049
8007
|
|
|
@@ -8055,7 +8013,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
8055
8013
|
<dl>
|
|
8056
8014
|
<dd>
|
|
8057
8015
|
|
|
8058
|
-
|
|
8016
|
+
Retrieves public user data for the authenticated user. | () -> (UserPublicData1)
|
|
8059
8017
|
|
|
8060
8018
|
</dd>
|
|
8061
8019
|
</dl>
|
|
@@ -8071,7 +8029,7 @@ Returns True when the provided handle is available, otherwise False. | () -> (bo
|
|
|
8071
8029
|
<dd>
|
|
8072
8030
|
|
|
8073
8031
|
```typescript
|
|
8074
|
-
await client.
|
|
8032
|
+
await client.users.getUserPublicDataV1();
|
|
8075
8033
|
```
|
|
8076
8034
|
|
|
8077
8035
|
</dd>
|
|
@@ -8087,15 +8045,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
8087
8045
|
<dl>
|
|
8088
8046
|
<dd>
|
|
8089
8047
|
|
|
8090
|
-
**
|
|
8091
|
-
|
|
8092
|
-
</dd>
|
|
8093
|
-
</dl>
|
|
8094
|
-
|
|
8095
|
-
<dl>
|
|
8096
|
-
<dd>
|
|
8097
|
-
|
|
8098
|
-
**requestOptions:** `Orgs.RequestOptions`
|
|
8048
|
+
**requestOptions:** `Users.RequestOptions`
|
|
8099
8049
|
|
|
8100
8050
|
</dd>
|
|
8101
8051
|
</dl>
|
|
@@ -8106,7 +8056,9 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
8106
8056
|
</dl>
|
|
8107
8057
|
</details>
|
|
8108
8058
|
|
|
8109
|
-
|
|
8059
|
+
## Utils
|
|
8060
|
+
|
|
8061
|
+
<details><summary><code>client.utils.<a href="/src/api/resources/utils/client/Client.ts">getTimezoneV1</a>({ ...params }) -> Chrt.TimezoneResponse</code></summary>
|
|
8110
8062
|
<dl>
|
|
8111
8063
|
<dd>
|
|
8112
8064
|
|
|
@@ -8118,7 +8070,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
8118
8070
|
<dl>
|
|
8119
8071
|
<dd>
|
|
8120
8072
|
|
|
8121
|
-
|
|
8073
|
+
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)
|
|
8122
8074
|
|
|
8123
8075
|
</dd>
|
|
8124
8076
|
</dl>
|
|
@@ -8134,8 +8086,9 @@ Sets the org_type in Clerk's JWT public metadata. Returns True if already set an
|
|
|
8134
8086
|
<dd>
|
|
8135
8087
|
|
|
8136
8088
|
```typescript
|
|
8137
|
-
await client.
|
|
8138
|
-
|
|
8089
|
+
await client.utils.getTimezoneV1({
|
|
8090
|
+
lat: 37.7749,
|
|
8091
|
+
lng: -122.4194,
|
|
8139
8092
|
});
|
|
8140
8093
|
```
|
|
8141
8094
|
|
|
@@ -8152,7 +8105,7 @@ await client.orgs.setOrgTypeV1({
|
|
|
8152
8105
|
<dl>
|
|
8153
8106
|
<dd>
|
|
8154
8107
|
|
|
8155
|
-
**request:** `Chrt.
|
|
8108
|
+
**request:** `Chrt.UtilsGetTimezoneV1Request`
|
|
8156
8109
|
|
|
8157
8110
|
</dd>
|
|
8158
8111
|
</dl>
|
|
@@ -8160,7 +8113,7 @@ await client.orgs.setOrgTypeV1({
|
|
|
8160
8113
|
<dl>
|
|
8161
8114
|
<dd>
|
|
8162
8115
|
|
|
8163
|
-
**requestOptions:** `
|
|
8116
|
+
**requestOptions:** `Utils.RequestOptions`
|
|
8164
8117
|
|
|
8165
8118
|
</dd>
|
|
8166
8119
|
</dl>
|
|
@@ -8171,7 +8124,9 @@ await client.orgs.setOrgTypeV1({
|
|
|
8171
8124
|
</dl>
|
|
8172
8125
|
</details>
|
|
8173
8126
|
|
|
8174
|
-
|
|
8127
|
+
## Connections ConnectionToCourier
|
|
8128
|
+
|
|
8129
|
+
<details><summary><code>client.connections.connectionToCourier.<a href="/src/api/resources/connections/resources/connectionToCourier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
8175
8130
|
<dl>
|
|
8176
8131
|
<dd>
|
|
8177
8132
|
|
|
@@ -8183,7 +8138,7 @@ await client.orgs.setOrgTypeV1({
|
|
|
8183
8138
|
<dl>
|
|
8184
8139
|
<dd>
|
|
8185
8140
|
|
|
8186
|
-
|
|
8141
|
+
Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers. | (CreateConnectionReq) -> (PydanticObjectId)
|
|
8187
8142
|
|
|
8188
8143
|
</dd>
|
|
8189
8144
|
</dl>
|
|
@@ -8199,7 +8154,9 @@ Retrieves the Stripe Connect account ID for the authenticated organization. Retu
|
|
|
8199
8154
|
<dd>
|
|
8200
8155
|
|
|
8201
8156
|
```typescript
|
|
8202
|
-
await client.
|
|
8157
|
+
await client.connections.connectionToCourier.createV1({
|
|
8158
|
+
handle: "handle",
|
|
8159
|
+
});
|
|
8203
8160
|
```
|
|
8204
8161
|
|
|
8205
8162
|
</dd>
|
|
@@ -8215,7 +8172,15 @@ await client.orgs.getStripeConnectAccountIdV1();
|
|
|
8215
8172
|
<dl>
|
|
8216
8173
|
<dd>
|
|
8217
8174
|
|
|
8218
|
-
**
|
|
8175
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
8176
|
+
|
|
8177
|
+
</dd>
|
|
8178
|
+
</dl>
|
|
8179
|
+
|
|
8180
|
+
<dl>
|
|
8181
|
+
<dd>
|
|
8182
|
+
|
|
8183
|
+
**requestOptions:** `ConnectionToCourier.RequestOptions`
|
|
8219
8184
|
|
|
8220
8185
|
</dd>
|
|
8221
8186
|
</dl>
|
|
@@ -8226,9 +8191,9 @@ await client.orgs.getStripeConnectAccountIdV1();
|
|
|
8226
8191
|
</dl>
|
|
8227
8192
|
</details>
|
|
8228
8193
|
|
|
8229
|
-
##
|
|
8194
|
+
## Connections ConnectionToShipper
|
|
8230
8195
|
|
|
8231
|
-
<details><summary><code>client.
|
|
8196
|
+
<details><summary><code>client.connections.connectionToShipper.<a href="/src/api/resources/connections/resources/connectionToShipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
8232
8197
|
<dl>
|
|
8233
8198
|
<dd>
|
|
8234
8199
|
|
|
@@ -8240,7 +8205,7 @@ await client.orgs.getStripeConnectAccountIdV1();
|
|
|
8240
8205
|
<dl>
|
|
8241
8206
|
<dd>
|
|
8242
8207
|
|
|
8243
|
-
|
|
8208
|
+
Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)
|
|
8244
8209
|
|
|
8245
8210
|
</dd>
|
|
8246
8211
|
</dl>
|
|
@@ -8256,7 +8221,9 @@ Test endpoint for authenticated requests that requires valid authentication toke
|
|
|
8256
8221
|
<dd>
|
|
8257
8222
|
|
|
8258
8223
|
```typescript
|
|
8259
|
-
await client.
|
|
8224
|
+
await client.connections.connectionToShipper.createV1({
|
|
8225
|
+
handle: "handle",
|
|
8226
|
+
});
|
|
8260
8227
|
```
|
|
8261
8228
|
|
|
8262
8229
|
</dd>
|
|
@@ -8272,7 +8239,15 @@ await client.root.pingAuthd();
|
|
|
8272
8239
|
<dl>
|
|
8273
8240
|
<dd>
|
|
8274
8241
|
|
|
8275
|
-
**
|
|
8242
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
8243
|
+
|
|
8244
|
+
</dd>
|
|
8245
|
+
</dl>
|
|
8246
|
+
|
|
8247
|
+
<dl>
|
|
8248
|
+
<dd>
|
|
8249
|
+
|
|
8250
|
+
**requestOptions:** `ConnectionToShipper.RequestOptions`
|
|
8276
8251
|
|
|
8277
8252
|
</dd>
|
|
8278
8253
|
</dl>
|
|
@@ -8283,7 +8258,9 @@ await client.root.pingAuthd();
|
|
|
8283
8258
|
</dl>
|
|
8284
8259
|
</details>
|
|
8285
8260
|
|
|
8286
|
-
|
|
8261
|
+
## Connections ConnectionToForwarder
|
|
8262
|
+
|
|
8263
|
+
<details><summary><code>client.connections.connectionToForwarder.<a href="/src/api/resources/connections/resources/connectionToForwarder/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
8287
8264
|
<dl>
|
|
8288
8265
|
<dd>
|
|
8289
8266
|
|
|
@@ -8295,7 +8272,7 @@ await client.root.pingAuthd();
|
|
|
8295
8272
|
<dl>
|
|
8296
8273
|
<dd>
|
|
8297
8274
|
|
|
8298
|
-
|
|
8275
|
+
Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders. | (CreateConnectionReq) -> (PydanticObjectId)
|
|
8299
8276
|
|
|
8300
8277
|
</dd>
|
|
8301
8278
|
</dl>
|
|
@@ -8311,7 +8288,9 @@ Test endpoint for optionally authenticated requests that works with or without a
|
|
|
8311
8288
|
<dd>
|
|
8312
8289
|
|
|
8313
8290
|
```typescript
|
|
8314
|
-
await client.
|
|
8291
|
+
await client.connections.connectionToForwarder.createV1({
|
|
8292
|
+
handle: "handle",
|
|
8293
|
+
});
|
|
8315
8294
|
```
|
|
8316
8295
|
|
|
8317
8296
|
</dd>
|
|
@@ -8327,7 +8306,15 @@ await client.root.pingOptionallyAuthd();
|
|
|
8327
8306
|
<dl>
|
|
8328
8307
|
<dd>
|
|
8329
8308
|
|
|
8330
|
-
**
|
|
8309
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
8310
|
+
|
|
8311
|
+
</dd>
|
|
8312
|
+
</dl>
|
|
8313
|
+
|
|
8314
|
+
<dl>
|
|
8315
|
+
<dd>
|
|
8316
|
+
|
|
8317
|
+
**requestOptions:** `ConnectionToForwarder.RequestOptions`
|
|
8331
8318
|
|
|
8332
8319
|
</dd>
|
|
8333
8320
|
</dl>
|
|
@@ -8338,7 +8325,9 @@ await client.root.pingOptionallyAuthd();
|
|
|
8338
8325
|
</dl>
|
|
8339
8326
|
</details>
|
|
8340
8327
|
|
|
8341
|
-
|
|
8328
|
+
## CourierPayDriverLineItemGroups AddLineItems
|
|
8329
|
+
|
|
8330
|
+
<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>
|
|
8342
8331
|
<dl>
|
|
8343
8332
|
<dd>
|
|
8344
8333
|
|
|
@@ -8350,7 +8339,7 @@ await client.root.pingOptionallyAuthd();
|
|
|
8350
8339
|
<dl>
|
|
8351
8340
|
<dd>
|
|
8352
8341
|
|
|
8353
|
-
|
|
8342
|
+
Adds additional line items to an existing courier driver line item group.
|
|
8354
8343
|
|
|
8355
8344
|
</dd>
|
|
8356
8345
|
</dl>
|
|
@@ -8366,7 +8355,16 @@ Returns a greeting message to verify the API is accessible. | () -> (dict)
|
|
|
8366
8355
|
<dd>
|
|
8367
8356
|
|
|
8368
8357
|
```typescript
|
|
8369
|
-
await client.
|
|
8358
|
+
await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
8359
|
+
line_items: [
|
|
8360
|
+
{
|
|
8361
|
+
schema_version: 1,
|
|
8362
|
+
item: "base_rate",
|
|
8363
|
+
quantity: 1.1,
|
|
8364
|
+
rate: 1.1,
|
|
8365
|
+
},
|
|
8366
|
+
],
|
|
8367
|
+
});
|
|
8370
8368
|
```
|
|
8371
8369
|
|
|
8372
8370
|
</dd>
|
|
@@ -8382,62 +8380,23 @@ await client.root.pingUnauthd();
|
|
|
8382
8380
|
<dl>
|
|
8383
8381
|
<dd>
|
|
8384
8382
|
|
|
8385
|
-
**
|
|
8386
|
-
|
|
8387
|
-
</dd>
|
|
8388
|
-
</dl>
|
|
8389
|
-
</dd>
|
|
8390
|
-
</dl>
|
|
8391
|
-
|
|
8392
|
-
</dd>
|
|
8393
|
-
</dl>
|
|
8394
|
-
</details>
|
|
8395
|
-
|
|
8396
|
-
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> Record<string, unknown></code></summary>
|
|
8397
|
-
<dl>
|
|
8398
|
-
<dd>
|
|
8399
|
-
|
|
8400
|
-
#### 📝 Description
|
|
8401
|
-
|
|
8402
|
-
<dl>
|
|
8403
|
-
<dd>
|
|
8404
|
-
|
|
8405
|
-
<dl>
|
|
8406
|
-
<dd>
|
|
8407
|
-
|
|
8408
|
-
Returns a health status message used for monitoring system availability and uptime. | () -> (dict)
|
|
8383
|
+
**id:** `string`
|
|
8409
8384
|
|
|
8410
|
-
</dd>
|
|
8411
|
-
</dl>
|
|
8412
8385
|
</dd>
|
|
8413
8386
|
</dl>
|
|
8414
8387
|
|
|
8415
|
-
#### 🔌 Usage
|
|
8416
|
-
|
|
8417
8388
|
<dl>
|
|
8418
8389
|
<dd>
|
|
8419
8390
|
|
|
8420
|
-
|
|
8421
|
-
<dd>
|
|
8422
|
-
|
|
8423
|
-
```typescript
|
|
8424
|
-
await client.root.health();
|
|
8425
|
-
```
|
|
8391
|
+
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupAddLineItemsReq`
|
|
8426
8392
|
|
|
8427
|
-
</dd>
|
|
8428
|
-
</dl>
|
|
8429
8393
|
</dd>
|
|
8430
8394
|
</dl>
|
|
8431
8395
|
|
|
8432
|
-
#### ⚙️ Parameters
|
|
8433
|
-
|
|
8434
|
-
<dl>
|
|
8435
|
-
<dd>
|
|
8436
|
-
|
|
8437
8396
|
<dl>
|
|
8438
8397
|
<dd>
|
|
8439
8398
|
|
|
8440
|
-
**requestOptions:** `
|
|
8399
|
+
**requestOptions:** `AddLineItems.RequestOptions`
|
|
8441
8400
|
|
|
8442
8401
|
</dd>
|
|
8443
8402
|
</dl>
|
|
@@ -8448,7 +8407,9 @@ await client.root.health();
|
|
|
8448
8407
|
</dl>
|
|
8449
8408
|
</details>
|
|
8450
8409
|
|
|
8451
|
-
|
|
8410
|
+
## CourierPayDriverLineItemGroups RemoveLineItems
|
|
8411
|
+
|
|
8412
|
+
<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>
|
|
8452
8413
|
<dl>
|
|
8453
8414
|
<dd>
|
|
8454
8415
|
|
|
@@ -8460,7 +8421,7 @@ await client.root.health();
|
|
|
8460
8421
|
<dl>
|
|
8461
8422
|
<dd>
|
|
8462
8423
|
|
|
8463
|
-
|
|
8424
|
+
Removes specific line items from a courier driver line item group by their UUID identifiers.
|
|
8464
8425
|
|
|
8465
8426
|
</dd>
|
|
8466
8427
|
</dl>
|
|
@@ -8476,7 +8437,9 @@ Test endpoint that intentionally fails for error handling validation and monitor
|
|
|
8476
8437
|
<dd>
|
|
8477
8438
|
|
|
8478
8439
|
```typescript
|
|
8479
|
-
await client.
|
|
8440
|
+
await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
8441
|
+
line_item_uuid_strs: ["line_item_uuid_strs"],
|
|
8442
|
+
});
|
|
8480
8443
|
```
|
|
8481
8444
|
|
|
8482
8445
|
</dd>
|
|
@@ -8492,64 +8455,23 @@ await client.root.failure();
|
|
|
8492
8455
|
<dl>
|
|
8493
8456
|
<dd>
|
|
8494
8457
|
|
|
8495
|
-
**
|
|
8496
|
-
|
|
8497
|
-
</dd>
|
|
8498
|
-
</dl>
|
|
8499
|
-
</dd>
|
|
8500
|
-
</dl>
|
|
8501
|
-
|
|
8502
|
-
</dd>
|
|
8503
|
-
</dl>
|
|
8504
|
-
</details>
|
|
8505
|
-
|
|
8506
|
-
## Users
|
|
8507
|
-
|
|
8508
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPublicDataV1</a>() -> Chrt.UserPublicData1</code></summary>
|
|
8509
|
-
<dl>
|
|
8510
|
-
<dd>
|
|
8511
|
-
|
|
8512
|
-
#### 📝 Description
|
|
8513
|
-
|
|
8514
|
-
<dl>
|
|
8515
|
-
<dd>
|
|
8516
|
-
|
|
8517
|
-
<dl>
|
|
8518
|
-
<dd>
|
|
8519
|
-
|
|
8520
|
-
Retrieves public user data for the authenticated user. | () -> (UserPublicData1)
|
|
8458
|
+
**id:** `string`
|
|
8521
8459
|
|
|
8522
|
-
</dd>
|
|
8523
|
-
</dl>
|
|
8524
8460
|
</dd>
|
|
8525
8461
|
</dl>
|
|
8526
8462
|
|
|
8527
|
-
#### 🔌 Usage
|
|
8528
|
-
|
|
8529
|
-
<dl>
|
|
8530
|
-
<dd>
|
|
8531
|
-
|
|
8532
8463
|
<dl>
|
|
8533
8464
|
<dd>
|
|
8534
8465
|
|
|
8535
|
-
|
|
8536
|
-
await client.users.getUserPublicDataV1();
|
|
8537
|
-
```
|
|
8466
|
+
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupRemoveLineItemsReq`
|
|
8538
8467
|
|
|
8539
8468
|
</dd>
|
|
8540
8469
|
</dl>
|
|
8541
|
-
</dd>
|
|
8542
|
-
</dl>
|
|
8543
|
-
|
|
8544
|
-
#### ⚙️ Parameters
|
|
8545
|
-
|
|
8546
|
-
<dl>
|
|
8547
|
-
<dd>
|
|
8548
8470
|
|
|
8549
8471
|
<dl>
|
|
8550
8472
|
<dd>
|
|
8551
8473
|
|
|
8552
|
-
**requestOptions:** `
|
|
8474
|
+
**requestOptions:** `RemoveLineItems.RequestOptions`
|
|
8553
8475
|
|
|
8554
8476
|
</dd>
|
|
8555
8477
|
</dl>
|
|
@@ -8560,9 +8482,9 @@ await client.users.getUserPublicDataV1();
|
|
|
8560
8482
|
</dl>
|
|
8561
8483
|
</details>
|
|
8562
8484
|
|
|
8563
|
-
##
|
|
8485
|
+
## Notifications Shipper
|
|
8564
8486
|
|
|
8565
|
-
<details><summary><code>client.
|
|
8487
|
+
<details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">getPreferencesV1</a>() -> Chrt.ShipperNotificationPreferences1</code></summary>
|
|
8566
8488
|
<dl>
|
|
8567
8489
|
<dd>
|
|
8568
8490
|
|
|
@@ -8574,7 +8496,7 @@ await client.users.getUserPublicDataV1();
|
|
|
8574
8496
|
<dl>
|
|
8575
8497
|
<dd>
|
|
8576
8498
|
|
|
8577
|
-
|
|
8499
|
+
Retrieves notification preferences for the authenticated shipper organization. | () -> (ShipperNotificationPreferences1)
|
|
8578
8500
|
|
|
8579
8501
|
</dd>
|
|
8580
8502
|
</dl>
|
|
@@ -8590,10 +8512,7 @@ Returns the IANA timezone identifier (e.g., 'America/Los_Angeles') for the given
|
|
|
8590
8512
|
<dd>
|
|
8591
8513
|
|
|
8592
8514
|
```typescript
|
|
8593
|
-
await client.
|
|
8594
|
-
lat: 37.7749,
|
|
8595
|
-
lng: -122.4194,
|
|
8596
|
-
});
|
|
8515
|
+
await client.notifications.shipper.getPreferencesV1();
|
|
8597
8516
|
```
|
|
8598
8517
|
|
|
8599
8518
|
</dd>
|
|
@@ -8609,15 +8528,7 @@ await client.utils.getTimezoneV1({
|
|
|
8609
8528
|
<dl>
|
|
8610
8529
|
<dd>
|
|
8611
8530
|
|
|
8612
|
-
**
|
|
8613
|
-
|
|
8614
|
-
</dd>
|
|
8615
|
-
</dl>
|
|
8616
|
-
|
|
8617
|
-
<dl>
|
|
8618
|
-
<dd>
|
|
8619
|
-
|
|
8620
|
-
**requestOptions:** `Utils.RequestOptions`
|
|
8531
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
8621
8532
|
|
|
8622
8533
|
</dd>
|
|
8623
8534
|
</dl>
|
|
@@ -8628,9 +8539,7 @@ await client.utils.getTimezoneV1({
|
|
|
8628
8539
|
</dl>
|
|
8629
8540
|
</details>
|
|
8630
8541
|
|
|
8631
|
-
|
|
8632
|
-
|
|
8633
|
-
<details><summary><code>client.connections.connectionToCourier.<a href="/src/api/resources/connections/resources/connectionToCourier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
8542
|
+
<details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">upsertPreferencesV1</a>({ ...params }) -> string</code></summary>
|
|
8634
8543
|
<dl>
|
|
8635
8544
|
<dd>
|
|
8636
8545
|
|
|
@@ -8642,7 +8551,7 @@ await client.utils.getTimezoneV1({
|
|
|
8642
8551
|
<dl>
|
|
8643
8552
|
<dd>
|
|
8644
8553
|
|
|
8645
|
-
Creates
|
|
8554
|
+
Creates or updates notification preferences for the authenticated shipper organization. | (ShipperNotificationPreferencesClientCreate1) -> (PydanticObjectId)
|
|
8646
8555
|
|
|
8647
8556
|
</dd>
|
|
8648
8557
|
</dl>
|
|
@@ -8658,8 +8567,8 @@ Creates a new connection to a courier organization. Shippers and forwarders can
|
|
|
8658
8567
|
<dd>
|
|
8659
8568
|
|
|
8660
8569
|
```typescript
|
|
8661
|
-
await client.
|
|
8662
|
-
|
|
8570
|
+
await client.notifications.shipper.upsertPreferencesV1({
|
|
8571
|
+
schema_version: 1,
|
|
8663
8572
|
});
|
|
8664
8573
|
```
|
|
8665
8574
|
|
|
@@ -8676,7 +8585,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
8676
8585
|
<dl>
|
|
8677
8586
|
<dd>
|
|
8678
8587
|
|
|
8679
|
-
**request:** `Chrt.
|
|
8588
|
+
**request:** `Chrt.notifications.ShipperNotificationPreferencesClientCreate1`
|
|
8680
8589
|
|
|
8681
8590
|
</dd>
|
|
8682
8591
|
</dl>
|
|
@@ -8684,7 +8593,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
8684
8593
|
<dl>
|
|
8685
8594
|
<dd>
|
|
8686
8595
|
|
|
8687
|
-
**requestOptions:** `
|
|
8596
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
8688
8597
|
|
|
8689
8598
|
</dd>
|
|
8690
8599
|
</dl>
|
|
@@ -8695,9 +8604,9 @@ await client.connections.connectionToCourier.createV1({
|
|
|
8695
8604
|
</dl>
|
|
8696
8605
|
</details>
|
|
8697
8606
|
|
|
8698
|
-
##
|
|
8607
|
+
## Notifications Courier
|
|
8699
8608
|
|
|
8700
|
-
<details><summary><code>client.
|
|
8609
|
+
<details><summary><code>client.notifications.courier.<a href="/src/api/resources/notifications/resources/courier/client/Client.ts">getPreferencesV1</a>() -> Chrt.CourierNotificationPreferences1</code></summary>
|
|
8701
8610
|
<dl>
|
|
8702
8611
|
<dd>
|
|
8703
8612
|
|
|
@@ -8709,7 +8618,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
8709
8618
|
<dl>
|
|
8710
8619
|
<dd>
|
|
8711
8620
|
|
|
8712
|
-
|
|
8621
|
+
Retrieves notification preferences for the authenticated courier organization. | () -> (CourierNotificationPreferences1)
|
|
8713
8622
|
|
|
8714
8623
|
</dd>
|
|
8715
8624
|
</dl>
|
|
@@ -8725,9 +8634,7 @@ Creates a new connection to a shipper organization. Only forwarders can initiate
|
|
|
8725
8634
|
<dd>
|
|
8726
8635
|
|
|
8727
8636
|
```typescript
|
|
8728
|
-
await client.
|
|
8729
|
-
handle: "handle",
|
|
8730
|
-
});
|
|
8637
|
+
await client.notifications.courier.getPreferencesV1();
|
|
8731
8638
|
```
|
|
8732
8639
|
|
|
8733
8640
|
</dd>
|
|
@@ -8743,15 +8650,7 @@ await client.connections.connectionToShipper.createV1({
|
|
|
8743
8650
|
<dl>
|
|
8744
8651
|
<dd>
|
|
8745
8652
|
|
|
8746
|
-
**
|
|
8747
|
-
|
|
8748
|
-
</dd>
|
|
8749
|
-
</dl>
|
|
8750
|
-
|
|
8751
|
-
<dl>
|
|
8752
|
-
<dd>
|
|
8753
|
-
|
|
8754
|
-
**requestOptions:** `ConnectionToShipper.RequestOptions`
|
|
8653
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
8755
8654
|
|
|
8756
8655
|
</dd>
|
|
8757
8656
|
</dl>
|
|
@@ -8762,9 +8661,7 @@ await client.connections.connectionToShipper.createV1({
|
|
|
8762
8661
|
</dl>
|
|
8763
8662
|
</details>
|
|
8764
8663
|
|
|
8765
|
-
|
|
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>
|
|
8664
|
+
<details><summary><code>client.notifications.courier.<a href="/src/api/resources/notifications/resources/courier/client/Client.ts">upsertPreferencesV1</a>({ ...params }) -> string</code></summary>
|
|
8768
8665
|
<dl>
|
|
8769
8666
|
<dd>
|
|
8770
8667
|
|
|
@@ -8776,7 +8673,7 @@ await client.connections.connectionToShipper.createV1({
|
|
|
8776
8673
|
<dl>
|
|
8777
8674
|
<dd>
|
|
8778
8675
|
|
|
8779
|
-
Creates
|
|
8676
|
+
Creates or updates notification preferences for the authenticated courier organization. | (CourierNotificationPreferencesClientCreate1) -> (PydanticObjectId)
|
|
8780
8677
|
|
|
8781
8678
|
</dd>
|
|
8782
8679
|
</dl>
|
|
@@ -8792,8 +8689,8 @@ Creates a new connection to a forwarder organization. Only shippers can initiate
|
|
|
8792
8689
|
<dd>
|
|
8793
8690
|
|
|
8794
8691
|
```typescript
|
|
8795
|
-
await client.
|
|
8796
|
-
|
|
8692
|
+
await client.notifications.courier.upsertPreferencesV1({
|
|
8693
|
+
schema_version: 1,
|
|
8797
8694
|
});
|
|
8798
8695
|
```
|
|
8799
8696
|
|
|
@@ -8810,7 +8707,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
8810
8707
|
<dl>
|
|
8811
8708
|
<dd>
|
|
8812
8709
|
|
|
8813
|
-
**request:** `Chrt.
|
|
8710
|
+
**request:** `Chrt.notifications.CourierNotificationPreferencesClientCreate1`
|
|
8814
8711
|
|
|
8815
8712
|
</dd>
|
|
8816
8713
|
</dl>
|
|
@@ -8818,7 +8715,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
8818
8715
|
<dl>
|
|
8819
8716
|
<dd>
|
|
8820
8717
|
|
|
8821
|
-
**requestOptions:** `
|
|
8718
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
8822
8719
|
|
|
8823
8720
|
</dd>
|
|
8824
8721
|
</dl>
|
|
@@ -8829,9 +8726,9 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
8829
8726
|
</dl>
|
|
8830
8727
|
</details>
|
|
8831
8728
|
|
|
8832
|
-
##
|
|
8729
|
+
## OrderDrafts TaskGroup
|
|
8833
8730
|
|
|
8834
|
-
<details><summary><code>client.
|
|
8731
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
8835
8732
|
<dl>
|
|
8836
8733
|
<dd>
|
|
8837
8734
|
|
|
@@ -8843,7 +8740,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
8843
8740
|
<dl>
|
|
8844
8741
|
<dd>
|
|
8845
8742
|
|
|
8846
|
-
Adds
|
|
8743
|
+
Adds a task group to an existing order draft. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddTaskGroupReq) -> (PydanticObjectId)
|
|
8847
8744
|
|
|
8848
8745
|
</dd>
|
|
8849
8746
|
</dl>
|
|
@@ -8859,15 +8756,9 @@ Adds additional line items to an existing courier driver line item group.
|
|
|
8859
8756
|
<dd>
|
|
8860
8757
|
|
|
8861
8758
|
```typescript
|
|
8862
|
-
await client.
|
|
8863
|
-
|
|
8864
|
-
|
|
8865
|
-
schema_version: 1,
|
|
8866
|
-
item: "base_rate",
|
|
8867
|
-
quantity: 1.1,
|
|
8868
|
-
rate: 1.1,
|
|
8869
|
-
},
|
|
8870
|
-
],
|
|
8759
|
+
await client.orderDrafts.taskGroup.addV1({
|
|
8760
|
+
task_group_type: "chrt_ground_courier",
|
|
8761
|
+
order_id: "order_id",
|
|
8871
8762
|
});
|
|
8872
8763
|
```
|
|
8873
8764
|
|
|
@@ -8884,15 +8775,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8884
8775
|
<dl>
|
|
8885
8776
|
<dd>
|
|
8886
8777
|
|
|
8887
|
-
**
|
|
8888
|
-
|
|
8889
|
-
</dd>
|
|
8890
|
-
</dl>
|
|
8891
|
-
|
|
8892
|
-
<dl>
|
|
8893
|
-
<dd>
|
|
8894
|
-
|
|
8895
|
-
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupAddLineItemsReq`
|
|
8778
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskGroupReq`
|
|
8896
8779
|
|
|
8897
8780
|
</dd>
|
|
8898
8781
|
</dl>
|
|
@@ -8900,7 +8783,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8900
8783
|
<dl>
|
|
8901
8784
|
<dd>
|
|
8902
8785
|
|
|
8903
|
-
**requestOptions:** `
|
|
8786
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
8904
8787
|
|
|
8905
8788
|
</dd>
|
|
8906
8789
|
</dl>
|
|
@@ -8911,9 +8794,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8911
8794
|
</dl>
|
|
8912
8795
|
</details>
|
|
8913
8796
|
|
|
8914
|
-
|
|
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>
|
|
8797
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">updateV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
8917
8798
|
<dl>
|
|
8918
8799
|
<dd>
|
|
8919
8800
|
|
|
@@ -8925,7 +8806,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
8925
8806
|
<dl>
|
|
8926
8807
|
<dd>
|
|
8927
8808
|
|
|
8928
|
-
|
|
8809
|
+
Sets or removes courier org. Sets task ordering (must provide all task ids). | (UpdateTaskGroupDraftReq) -> (bool)
|
|
8929
8810
|
|
|
8930
8811
|
</dd>
|
|
8931
8812
|
</dl>
|
|
@@ -8941,9 +8822,7 @@ Removes specific line items from a courier driver line item group by their UUID
|
|
|
8941
8822
|
<dd>
|
|
8942
8823
|
|
|
8943
8824
|
```typescript
|
|
8944
|
-
await client.
|
|
8945
|
-
line_item_uuid_strs: ["line_item_uuid_strs"],
|
|
8946
|
-
});
|
|
8825
|
+
await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
8947
8826
|
```
|
|
8948
8827
|
|
|
8949
8828
|
</dd>
|
|
@@ -8959,7 +8838,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8959
8838
|
<dl>
|
|
8960
8839
|
<dd>
|
|
8961
8840
|
|
|
8962
|
-
**
|
|
8841
|
+
**taskGroupId:** `string`
|
|
8963
8842
|
|
|
8964
8843
|
</dd>
|
|
8965
8844
|
</dl>
|
|
@@ -8967,7 +8846,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8967
8846
|
<dl>
|
|
8968
8847
|
<dd>
|
|
8969
8848
|
|
|
8970
|
-
**request:** `Chrt.
|
|
8849
|
+
**request:** `Chrt.orderDrafts.UpdateTaskGroupDraftReq`
|
|
8971
8850
|
|
|
8972
8851
|
</dd>
|
|
8973
8852
|
</dl>
|
|
@@ -8975,7 +8854,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8975
8854
|
<dl>
|
|
8976
8855
|
<dd>
|
|
8977
8856
|
|
|
8978
|
-
**requestOptions:** `
|
|
8857
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
8979
8858
|
|
|
8980
8859
|
</dd>
|
|
8981
8860
|
</dl>
|
|
@@ -8986,9 +8865,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8986
8865
|
</dl>
|
|
8987
8866
|
</details>
|
|
8988
8867
|
|
|
8989
|
-
|
|
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>
|
|
8868
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">deleteV1</a>(taskGroupId) -> boolean</code></summary>
|
|
8992
8869
|
<dl>
|
|
8993
8870
|
<dd>
|
|
8994
8871
|
|
|
@@ -9000,7 +8877,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
9000
8877
|
<dl>
|
|
9001
8878
|
<dd>
|
|
9002
8879
|
|
|
9003
|
-
|
|
8880
|
+
Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order. | () -> (bool)
|
|
9004
8881
|
|
|
9005
8882
|
</dd>
|
|
9006
8883
|
</dl>
|
|
@@ -9016,7 +8893,7 @@ Retrieves notification preferences for the authenticated shipper organization. |
|
|
|
9016
8893
|
<dd>
|
|
9017
8894
|
|
|
9018
8895
|
```typescript
|
|
9019
|
-
await client.
|
|
8896
|
+
await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
9020
8897
|
```
|
|
9021
8898
|
|
|
9022
8899
|
</dd>
|
|
@@ -9032,7 +8909,15 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
9032
8909
|
<dl>
|
|
9033
8910
|
<dd>
|
|
9034
8911
|
|
|
9035
|
-
**
|
|
8912
|
+
**taskGroupId:** `string`
|
|
8913
|
+
|
|
8914
|
+
</dd>
|
|
8915
|
+
</dl>
|
|
8916
|
+
|
|
8917
|
+
<dl>
|
|
8918
|
+
<dd>
|
|
8919
|
+
|
|
8920
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
9036
8921
|
|
|
9037
8922
|
</dd>
|
|
9038
8923
|
</dl>
|
|
@@ -9043,7 +8928,9 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
9043
8928
|
</dl>
|
|
9044
8929
|
</details>
|
|
9045
8930
|
|
|
9046
|
-
|
|
8931
|
+
## OrderDrafts Task
|
|
8932
|
+
|
|
8933
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9047
8934
|
<dl>
|
|
9048
8935
|
<dd>
|
|
9049
8936
|
|
|
@@ -9055,7 +8942,7 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
9055
8942
|
<dl>
|
|
9056
8943
|
<dd>
|
|
9057
8944
|
|
|
9058
|
-
|
|
8945
|
+
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)
|
|
9059
8946
|
|
|
9060
8947
|
</dd>
|
|
9061
8948
|
</dl>
|
|
@@ -9071,8 +8958,11 @@ Creates or updates notification preferences for the authenticated shipper organi
|
|
|
9071
8958
|
<dd>
|
|
9072
8959
|
|
|
9073
8960
|
```typescript
|
|
9074
|
-
await client.
|
|
9075
|
-
|
|
8961
|
+
await client.orderDrafts.task.addV1({
|
|
8962
|
+
task_group_id: "task_group_id",
|
|
8963
|
+
task: {
|
|
8964
|
+
schema_version: 1,
|
|
8965
|
+
},
|
|
9076
8966
|
});
|
|
9077
8967
|
```
|
|
9078
8968
|
|
|
@@ -9089,7 +8979,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
9089
8979
|
<dl>
|
|
9090
8980
|
<dd>
|
|
9091
8981
|
|
|
9092
|
-
**request:** `Chrt.
|
|
8982
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskReqV1`
|
|
9093
8983
|
|
|
9094
8984
|
</dd>
|
|
9095
8985
|
</dl>
|
|
@@ -9097,7 +8987,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
9097
8987
|
<dl>
|
|
9098
8988
|
<dd>
|
|
9099
8989
|
|
|
9100
|
-
**requestOptions:** `
|
|
8990
|
+
**requestOptions:** `Task.RequestOptions`
|
|
9101
8991
|
|
|
9102
8992
|
</dd>
|
|
9103
8993
|
</dl>
|
|
@@ -9108,9 +8998,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
9108
8998
|
</dl>
|
|
9109
8999
|
</details>
|
|
9110
9000
|
|
|
9111
|
-
|
|
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>
|
|
9001
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">updateV1</a>({ ...params }) -> string</code></summary>
|
|
9114
9002
|
<dl>
|
|
9115
9003
|
<dd>
|
|
9116
9004
|
|
|
@@ -9122,7 +9010,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
9122
9010
|
<dl>
|
|
9123
9011
|
<dd>
|
|
9124
9012
|
|
|
9125
|
-
|
|
9013
|
+
Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (PydanticObjectId)
|
|
9126
9014
|
|
|
9127
9015
|
</dd>
|
|
9128
9016
|
</dl>
|
|
@@ -9138,7 +9026,10 @@ Retrieves notification preferences for the authenticated courier organization. |
|
|
|
9138
9026
|
<dd>
|
|
9139
9027
|
|
|
9140
9028
|
```typescript
|
|
9141
|
-
await client.
|
|
9029
|
+
await client.orderDrafts.task.updateV1({
|
|
9030
|
+
task_id: "task_id",
|
|
9031
|
+
task_update: {},
|
|
9032
|
+
});
|
|
9142
9033
|
```
|
|
9143
9034
|
|
|
9144
9035
|
</dd>
|
|
@@ -9154,7 +9045,15 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
9154
9045
|
<dl>
|
|
9155
9046
|
<dd>
|
|
9156
9047
|
|
|
9157
|
-
**
|
|
9048
|
+
**request:** `Chrt.orderDrafts.OrderDraftUpdateTaskReq`
|
|
9049
|
+
|
|
9050
|
+
</dd>
|
|
9051
|
+
</dl>
|
|
9052
|
+
|
|
9053
|
+
<dl>
|
|
9054
|
+
<dd>
|
|
9055
|
+
|
|
9056
|
+
**requestOptions:** `Task.RequestOptions`
|
|
9158
9057
|
|
|
9159
9058
|
</dd>
|
|
9160
9059
|
</dl>
|
|
@@ -9165,7 +9064,7 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
9165
9064
|
</dl>
|
|
9166
9065
|
</details>
|
|
9167
9066
|
|
|
9168
|
-
<details><summary><code>client.
|
|
9067
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
|
|
9169
9068
|
<dl>
|
|
9170
9069
|
<dd>
|
|
9171
9070
|
|
|
@@ -9177,7 +9076,7 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
9177
9076
|
<dl>
|
|
9178
9077
|
<dd>
|
|
9179
9078
|
|
|
9180
|
-
|
|
9079
|
+
Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group. | () -> (bool)
|
|
9181
9080
|
|
|
9182
9081
|
</dd>
|
|
9183
9082
|
</dl>
|
|
@@ -9193,9 +9092,7 @@ Creates or updates notification preferences for the authenticated courier organi
|
|
|
9193
9092
|
<dd>
|
|
9194
9093
|
|
|
9195
9094
|
```typescript
|
|
9196
|
-
await client.
|
|
9197
|
-
schema_version: 1,
|
|
9198
|
-
});
|
|
9095
|
+
await client.orderDrafts.task.deleteV1("task_id");
|
|
9199
9096
|
```
|
|
9200
9097
|
|
|
9201
9098
|
</dd>
|
|
@@ -9211,7 +9108,7 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
9211
9108
|
<dl>
|
|
9212
9109
|
<dd>
|
|
9213
9110
|
|
|
9214
|
-
**
|
|
9111
|
+
**taskId:** `string`
|
|
9215
9112
|
|
|
9216
9113
|
</dd>
|
|
9217
9114
|
</dl>
|
|
@@ -9219,7 +9116,7 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
9219
9116
|
<dl>
|
|
9220
9117
|
<dd>
|
|
9221
9118
|
|
|
9222
|
-
**requestOptions:** `
|
|
9119
|
+
**requestOptions:** `Task.RequestOptions`
|
|
9223
9120
|
|
|
9224
9121
|
</dd>
|
|
9225
9122
|
</dl>
|
|
@@ -9230,9 +9127,9 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
9230
9127
|
</dl>
|
|
9231
9128
|
</details>
|
|
9232
9129
|
|
|
9233
|
-
## OrderDrafts
|
|
9130
|
+
## OrderDrafts TaskArtifact
|
|
9234
9131
|
|
|
9235
|
-
<details><summary><code>client.orderDrafts.
|
|
9132
|
+
<details><summary><code>client.orderDrafts.taskArtifact.<a href="/src/api/resources/orderDrafts/resources/taskArtifact/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9236
9133
|
<dl>
|
|
9237
9134
|
<dd>
|
|
9238
9135
|
|
|
@@ -9244,7 +9141,7 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
9244
9141
|
<dl>
|
|
9245
9142
|
<dd>
|
|
9246
9143
|
|
|
9247
|
-
Adds a task
|
|
9144
|
+
Adds a task artifact to an existing task in a draft order. | (OrderDraftAddTaskArtifactReq) -> (PydanticObjectId)
|
|
9248
9145
|
|
|
9249
9146
|
</dd>
|
|
9250
9147
|
</dl>
|
|
@@ -9260,9 +9157,9 @@ Adds a task group to an existing order draft. Validates order is in DRAFT status
|
|
|
9260
9157
|
<dd>
|
|
9261
9158
|
|
|
9262
9159
|
```typescript
|
|
9263
|
-
await client.orderDrafts.
|
|
9264
|
-
|
|
9265
|
-
|
|
9160
|
+
await client.orderDrafts.taskArtifact.addV1({
|
|
9161
|
+
task_id: "task_id",
|
|
9162
|
+
task_artifact_type: "image",
|
|
9266
9163
|
});
|
|
9267
9164
|
```
|
|
9268
9165
|
|
|
@@ -9279,7 +9176,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
9279
9176
|
<dl>
|
|
9280
9177
|
<dd>
|
|
9281
9178
|
|
|
9282
|
-
**request:** `Chrt.orderDrafts.
|
|
9179
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskArtifactReq`
|
|
9283
9180
|
|
|
9284
9181
|
</dd>
|
|
9285
9182
|
</dl>
|
|
@@ -9287,7 +9184,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
9287
9184
|
<dl>
|
|
9288
9185
|
<dd>
|
|
9289
9186
|
|
|
9290
|
-
**requestOptions:** `
|
|
9187
|
+
**requestOptions:** `TaskArtifact.RequestOptions`
|
|
9291
9188
|
|
|
9292
9189
|
</dd>
|
|
9293
9190
|
</dl>
|
|
@@ -9298,7 +9195,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
9298
9195
|
</dl>
|
|
9299
9196
|
</details>
|
|
9300
9197
|
|
|
9301
|
-
<details><summary><code>client.orderDrafts.
|
|
9198
|
+
<details><summary><code>client.orderDrafts.taskArtifact.<a href="/src/api/resources/orderDrafts/resources/taskArtifact/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
9302
9199
|
<dl>
|
|
9303
9200
|
<dd>
|
|
9304
9201
|
|
|
@@ -9310,7 +9207,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
9310
9207
|
<dl>
|
|
9311
9208
|
<dd>
|
|
9312
9209
|
|
|
9313
|
-
|
|
9210
|
+
Deletes a task artifact from a draft order and removes it from the associated task. | () -> (bool)
|
|
9314
9211
|
|
|
9315
9212
|
</dd>
|
|
9316
9213
|
</dl>
|
|
@@ -9326,7 +9223,7 @@ Sets or removes courier org. Sets task ordering (must provide all task ids). | (
|
|
|
9326
9223
|
<dd>
|
|
9327
9224
|
|
|
9328
9225
|
```typescript
|
|
9329
|
-
await client.orderDrafts.
|
|
9226
|
+
await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
9330
9227
|
```
|
|
9331
9228
|
|
|
9332
9229
|
</dd>
|
|
@@ -9337,20 +9234,12 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
9337
9234
|
#### ⚙️ Parameters
|
|
9338
9235
|
|
|
9339
9236
|
<dl>
|
|
9340
|
-
<dd>
|
|
9341
|
-
|
|
9342
|
-
<dl>
|
|
9343
|
-
<dd>
|
|
9344
|
-
|
|
9345
|
-
**taskGroupId:** `string`
|
|
9346
|
-
|
|
9347
|
-
</dd>
|
|
9348
|
-
</dl>
|
|
9237
|
+
<dd>
|
|
9349
9238
|
|
|
9350
9239
|
<dl>
|
|
9351
9240
|
<dd>
|
|
9352
9241
|
|
|
9353
|
-
**
|
|
9242
|
+
**taskArtifactId:** `string`
|
|
9354
9243
|
|
|
9355
9244
|
</dd>
|
|
9356
9245
|
</dl>
|
|
@@ -9358,7 +9247,7 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
9358
9247
|
<dl>
|
|
9359
9248
|
<dd>
|
|
9360
9249
|
|
|
9361
|
-
**requestOptions:** `
|
|
9250
|
+
**requestOptions:** `TaskArtifact.RequestOptions`
|
|
9362
9251
|
|
|
9363
9252
|
</dd>
|
|
9364
9253
|
</dl>
|
|
@@ -9369,7 +9258,9 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
9369
9258
|
</dl>
|
|
9370
9259
|
</details>
|
|
9371
9260
|
|
|
9372
|
-
|
|
9261
|
+
## OrderDrafts Cargo
|
|
9262
|
+
|
|
9263
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9373
9264
|
<dl>
|
|
9374
9265
|
<dd>
|
|
9375
9266
|
|
|
@@ -9381,7 +9272,7 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
9381
9272
|
<dl>
|
|
9382
9273
|
<dd>
|
|
9383
9274
|
|
|
9384
|
-
|
|
9275
|
+
Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddCargoReq) -> (PydanticObjectId)
|
|
9385
9276
|
|
|
9386
9277
|
</dd>
|
|
9387
9278
|
</dl>
|
|
@@ -9397,7 +9288,13 @@ Deletes a task group and all associated entities (tasks, task artifacts, S3 meta
|
|
|
9397
9288
|
<dd>
|
|
9398
9289
|
|
|
9399
9290
|
```typescript
|
|
9400
|
-
await client.orderDrafts.
|
|
9291
|
+
await client.orderDrafts.cargo.addV1({
|
|
9292
|
+
order_id: "order_id",
|
|
9293
|
+
cargo: {
|
|
9294
|
+
schema_version: 1,
|
|
9295
|
+
cargo_type: "spare_parts",
|
|
9296
|
+
},
|
|
9297
|
+
});
|
|
9401
9298
|
```
|
|
9402
9299
|
|
|
9403
9300
|
</dd>
|
|
@@ -9413,7 +9310,7 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
9413
9310
|
<dl>
|
|
9414
9311
|
<dd>
|
|
9415
9312
|
|
|
9416
|
-
**
|
|
9313
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddCargoReq`
|
|
9417
9314
|
|
|
9418
9315
|
</dd>
|
|
9419
9316
|
</dl>
|
|
@@ -9421,7 +9318,7 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
9421
9318
|
<dl>
|
|
9422
9319
|
<dd>
|
|
9423
9320
|
|
|
9424
|
-
**requestOptions:** `
|
|
9321
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
9425
9322
|
|
|
9426
9323
|
</dd>
|
|
9427
9324
|
</dl>
|
|
@@ -9432,9 +9329,7 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
9432
9329
|
</dl>
|
|
9433
9330
|
</details>
|
|
9434
9331
|
|
|
9435
|
-
|
|
9436
|
-
|
|
9437
|
-
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9332
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">associateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
9438
9333
|
<dl>
|
|
9439
9334
|
<dd>
|
|
9440
9335
|
|
|
@@ -9446,7 +9341,7 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
9446
9341
|
<dl>
|
|
9447
9342
|
<dd>
|
|
9448
9343
|
|
|
9449
|
-
|
|
9344
|
+
Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCargoWithTaskReq) -> (bool)
|
|
9450
9345
|
|
|
9451
9346
|
</dd>
|
|
9452
9347
|
</dl>
|
|
@@ -9462,11 +9357,10 @@ Adds a task to an existing task group in a draft order. Validates order is in DR
|
|
|
9462
9357
|
<dd>
|
|
9463
9358
|
|
|
9464
9359
|
```typescript
|
|
9465
|
-
await client.orderDrafts.
|
|
9466
|
-
|
|
9467
|
-
|
|
9468
|
-
|
|
9469
|
-
},
|
|
9360
|
+
await client.orderDrafts.cargo.associateWithTaskV1({
|
|
9361
|
+
order_id: "order_id",
|
|
9362
|
+
task_id: "task_id",
|
|
9363
|
+
cargo_id: "cargo_id",
|
|
9470
9364
|
});
|
|
9471
9365
|
```
|
|
9472
9366
|
|
|
@@ -9483,7 +9377,7 @@ await client.orderDrafts.task.addV1({
|
|
|
9483
9377
|
<dl>
|
|
9484
9378
|
<dd>
|
|
9485
9379
|
|
|
9486
|
-
**request:** `Chrt.orderDrafts.
|
|
9380
|
+
**request:** `Chrt.orderDrafts.OrderDraftAssociateCargoWithTaskReq`
|
|
9487
9381
|
|
|
9488
9382
|
</dd>
|
|
9489
9383
|
</dl>
|
|
@@ -9491,7 +9385,7 @@ await client.orderDrafts.task.addV1({
|
|
|
9491
9385
|
<dl>
|
|
9492
9386
|
<dd>
|
|
9493
9387
|
|
|
9494
|
-
**requestOptions:** `
|
|
9388
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
9495
9389
|
|
|
9496
9390
|
</dd>
|
|
9497
9391
|
</dl>
|
|
@@ -9502,7 +9396,7 @@ await client.orderDrafts.task.addV1({
|
|
|
9502
9396
|
</dl>
|
|
9503
9397
|
</details>
|
|
9504
9398
|
|
|
9505
|
-
<details><summary><code>client.orderDrafts.
|
|
9399
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">updateV1</a>({ ...params }) -> string</code></summary>
|
|
9506
9400
|
<dl>
|
|
9507
9401
|
<dd>
|
|
9508
9402
|
|
|
@@ -9514,7 +9408,7 @@ await client.orderDrafts.task.addV1({
|
|
|
9514
9408
|
<dl>
|
|
9515
9409
|
<dd>
|
|
9516
9410
|
|
|
9517
|
-
Updates a
|
|
9411
|
+
Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftUpdateCargoReq) -> (PydanticObjectId)
|
|
9518
9412
|
|
|
9519
9413
|
</dd>
|
|
9520
9414
|
</dl>
|
|
@@ -9530,9 +9424,9 @@ Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (Pydan
|
|
|
9530
9424
|
<dd>
|
|
9531
9425
|
|
|
9532
9426
|
```typescript
|
|
9533
|
-
await client.orderDrafts.
|
|
9534
|
-
|
|
9535
|
-
|
|
9427
|
+
await client.orderDrafts.cargo.updateV1({
|
|
9428
|
+
cargo_id: "cargo_id",
|
|
9429
|
+
cargo_update: {},
|
|
9536
9430
|
});
|
|
9537
9431
|
```
|
|
9538
9432
|
|
|
@@ -9549,7 +9443,7 @@ await client.orderDrafts.task.updateV1({
|
|
|
9549
9443
|
<dl>
|
|
9550
9444
|
<dd>
|
|
9551
9445
|
|
|
9552
|
-
**request:** `Chrt.orderDrafts.
|
|
9446
|
+
**request:** `Chrt.orderDrafts.OrderDraftUpdateCargoReq`
|
|
9553
9447
|
|
|
9554
9448
|
</dd>
|
|
9555
9449
|
</dl>
|
|
@@ -9557,7 +9451,7 @@ await client.orderDrafts.task.updateV1({
|
|
|
9557
9451
|
<dl>
|
|
9558
9452
|
<dd>
|
|
9559
9453
|
|
|
9560
|
-
**requestOptions:** `
|
|
9454
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
9561
9455
|
|
|
9562
9456
|
</dd>
|
|
9563
9457
|
</dl>
|
|
@@ -9568,7 +9462,7 @@ await client.orderDrafts.task.updateV1({
|
|
|
9568
9462
|
</dl>
|
|
9569
9463
|
</details>
|
|
9570
9464
|
|
|
9571
|
-
<details><summary><code>client.orderDrafts.
|
|
9465
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">deleteV1</a>(cargoId) -> boolean</code></summary>
|
|
9572
9466
|
<dl>
|
|
9573
9467
|
<dd>
|
|
9574
9468
|
|
|
@@ -9580,7 +9474,7 @@ await client.orderDrafts.task.updateV1({
|
|
|
9580
9474
|
<dl>
|
|
9581
9475
|
<dd>
|
|
9582
9476
|
|
|
9583
|
-
Deletes a
|
|
9477
|
+
Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)
|
|
9584
9478
|
|
|
9585
9479
|
</dd>
|
|
9586
9480
|
</dl>
|
|
@@ -9596,7 +9490,7 @@ Deletes a task from a draft order, including all task artifacts. Cargo is preser
|
|
|
9596
9490
|
<dd>
|
|
9597
9491
|
|
|
9598
9492
|
```typescript
|
|
9599
|
-
await client.orderDrafts.
|
|
9493
|
+
await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
9600
9494
|
```
|
|
9601
9495
|
|
|
9602
9496
|
</dd>
|
|
@@ -9612,7 +9506,7 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
9612
9506
|
<dl>
|
|
9613
9507
|
<dd>
|
|
9614
9508
|
|
|
9615
|
-
**
|
|
9509
|
+
**cargoId:** `string`
|
|
9616
9510
|
|
|
9617
9511
|
</dd>
|
|
9618
9512
|
</dl>
|
|
@@ -9620,7 +9514,7 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
9620
9514
|
<dl>
|
|
9621
9515
|
<dd>
|
|
9622
9516
|
|
|
9623
|
-
**requestOptions:** `
|
|
9517
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
9624
9518
|
|
|
9625
9519
|
</dd>
|
|
9626
9520
|
</dl>
|
|
@@ -9631,9 +9525,9 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
9631
9525
|
</dl>
|
|
9632
9526
|
</details>
|
|
9633
9527
|
|
|
9634
|
-
##
|
|
9528
|
+
## Orders Expanded
|
|
9635
9529
|
|
|
9636
|
-
<details><summary><code>client.
|
|
9530
|
+
<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(orderId, { ...params }) -> Chrt.OrderExpanded</code></summary>
|
|
9637
9531
|
<dl>
|
|
9638
9532
|
<dd>
|
|
9639
9533
|
|
|
@@ -9645,7 +9539,7 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
9645
9539
|
<dl>
|
|
9646
9540
|
<dd>
|
|
9647
9541
|
|
|
9648
|
-
|
|
9542
|
+
Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
|
|
9649
9543
|
|
|
9650
9544
|
</dd>
|
|
9651
9545
|
</dl>
|
|
@@ -9661,10 +9555,7 @@ Adds a task artifact to an existing task in a draft order. | (OrderDraftAddTaskA
|
|
|
9661
9555
|
<dd>
|
|
9662
9556
|
|
|
9663
9557
|
```typescript
|
|
9664
|
-
await client.
|
|
9665
|
-
task_id: "task_id",
|
|
9666
|
-
task_artifact_type: "image",
|
|
9667
|
-
});
|
|
9558
|
+
await client.orders.expanded.forShipperOperatorsV1("order_id", {});
|
|
9668
9559
|
```
|
|
9669
9560
|
|
|
9670
9561
|
</dd>
|
|
@@ -9680,7 +9571,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
9680
9571
|
<dl>
|
|
9681
9572
|
<dd>
|
|
9682
9573
|
|
|
9683
|
-
**
|
|
9574
|
+
**orderId:** `string`
|
|
9684
9575
|
|
|
9685
9576
|
</dd>
|
|
9686
9577
|
</dl>
|
|
@@ -9688,7 +9579,15 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
9688
9579
|
<dl>
|
|
9689
9580
|
<dd>
|
|
9690
9581
|
|
|
9691
|
-
**
|
|
9582
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
9583
|
+
|
|
9584
|
+
</dd>
|
|
9585
|
+
</dl>
|
|
9586
|
+
|
|
9587
|
+
<dl>
|
|
9588
|
+
<dd>
|
|
9589
|
+
|
|
9590
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
9692
9591
|
|
|
9693
9592
|
</dd>
|
|
9694
9593
|
</dl>
|
|
@@ -9699,7 +9598,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
9699
9598
|
</dl>
|
|
9700
9599
|
</details>
|
|
9701
9600
|
|
|
9702
|
-
<details><summary><code>client.
|
|
9601
|
+
<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(orderId, { ...params }) -> Chrt.OrderExpanded</code></summary>
|
|
9703
9602
|
<dl>
|
|
9704
9603
|
<dd>
|
|
9705
9604
|
|
|
@@ -9711,7 +9610,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
9711
9610
|
<dl>
|
|
9712
9611
|
<dd>
|
|
9713
9612
|
|
|
9714
|
-
|
|
9613
|
+
Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
|
|
9715
9614
|
|
|
9716
9615
|
</dd>
|
|
9717
9616
|
</dl>
|
|
@@ -9727,7 +9626,7 @@ Deletes a task artifact from a draft order and removes it from the associated ta
|
|
|
9727
9626
|
<dd>
|
|
9728
9627
|
|
|
9729
9628
|
```typescript
|
|
9730
|
-
await client.
|
|
9629
|
+
await client.orders.expanded.forForwarderOperatorsV1("order_id", {});
|
|
9731
9630
|
```
|
|
9732
9631
|
|
|
9733
9632
|
</dd>
|
|
@@ -9743,7 +9642,7 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
9743
9642
|
<dl>
|
|
9744
9643
|
<dd>
|
|
9745
9644
|
|
|
9746
|
-
**
|
|
9645
|
+
**orderId:** `string`
|
|
9747
9646
|
|
|
9748
9647
|
</dd>
|
|
9749
9648
|
</dl>
|
|
@@ -9751,7 +9650,15 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
9751
9650
|
<dl>
|
|
9752
9651
|
<dd>
|
|
9753
9652
|
|
|
9754
|
-
**
|
|
9653
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
9654
|
+
|
|
9655
|
+
</dd>
|
|
9656
|
+
</dl>
|
|
9657
|
+
|
|
9658
|
+
<dl>
|
|
9659
|
+
<dd>
|
|
9660
|
+
|
|
9661
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
9755
9662
|
|
|
9756
9663
|
</dd>
|
|
9757
9664
|
</dl>
|
|
@@ -9762,9 +9669,9 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
9762
9669
|
</dl>
|
|
9763
9670
|
</details>
|
|
9764
9671
|
|
|
9765
|
-
##
|
|
9672
|
+
## OrgInfoForConnections Shipper
|
|
9766
9673
|
|
|
9767
|
-
<details><summary><code>client.
|
|
9674
|
+
<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
|
|
9768
9675
|
<dl>
|
|
9769
9676
|
<dd>
|
|
9770
9677
|
|
|
@@ -9776,7 +9683,7 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
9776
9683
|
<dl>
|
|
9777
9684
|
<dd>
|
|
9778
9685
|
|
|
9779
|
-
|
|
9686
|
+
Retrieves shipper organization connection information for the authenticated organization. | () -> (ShipperOrgInfoForConnections1)
|
|
9780
9687
|
|
|
9781
9688
|
</dd>
|
|
9782
9689
|
</dl>
|
|
@@ -9792,13 +9699,7 @@ Adds a cargo item to an existing draft order. Validates order is in DRAFT status
|
|
|
9792
9699
|
<dd>
|
|
9793
9700
|
|
|
9794
9701
|
```typescript
|
|
9795
|
-
await client.
|
|
9796
|
-
order_id: "order_id",
|
|
9797
|
-
cargo: {
|
|
9798
|
-
schema_version: 1,
|
|
9799
|
-
cargo_type: "spare_parts",
|
|
9800
|
-
},
|
|
9801
|
-
});
|
|
9702
|
+
await client.orgInfoForConnections.shipper.getV1();
|
|
9802
9703
|
```
|
|
9803
9704
|
|
|
9804
9705
|
</dd>
|
|
@@ -9814,15 +9715,7 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9814
9715
|
<dl>
|
|
9815
9716
|
<dd>
|
|
9816
9717
|
|
|
9817
|
-
**
|
|
9818
|
-
|
|
9819
|
-
</dd>
|
|
9820
|
-
</dl>
|
|
9821
|
-
|
|
9822
|
-
<dl>
|
|
9823
|
-
<dd>
|
|
9824
|
-
|
|
9825
|
-
**requestOptions:** `Cargo.RequestOptions`
|
|
9718
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
9826
9719
|
|
|
9827
9720
|
</dd>
|
|
9828
9721
|
</dl>
|
|
@@ -9833,7 +9726,7 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9833
9726
|
</dl>
|
|
9834
9727
|
</details>
|
|
9835
9728
|
|
|
9836
|
-
<details><summary><code>client.
|
|
9729
|
+
<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
9837
9730
|
<dl>
|
|
9838
9731
|
<dd>
|
|
9839
9732
|
|
|
@@ -9845,7 +9738,7 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9845
9738
|
<dl>
|
|
9846
9739
|
<dd>
|
|
9847
9740
|
|
|
9848
|
-
|
|
9741
|
+
Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
9849
9742
|
|
|
9850
9743
|
</dd>
|
|
9851
9744
|
</dl>
|
|
@@ -9861,10 +9754,9 @@ Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCa
|
|
|
9861
9754
|
<dd>
|
|
9862
9755
|
|
|
9863
9756
|
```typescript
|
|
9864
|
-
await client.
|
|
9865
|
-
|
|
9866
|
-
|
|
9867
|
-
cargo_id: "cargo_id",
|
|
9757
|
+
await client.orgInfoForConnections.shipper.createV1({
|
|
9758
|
+
schema_version: 1,
|
|
9759
|
+
email_address_primary: "email_address_primary",
|
|
9868
9760
|
});
|
|
9869
9761
|
```
|
|
9870
9762
|
|
|
@@ -9881,7 +9773,7 @@ await client.orderDrafts.cargo.associateWithTaskV1({
|
|
|
9881
9773
|
<dl>
|
|
9882
9774
|
<dd>
|
|
9883
9775
|
|
|
9884
|
-
**request:** `Chrt.
|
|
9776
|
+
**request:** `Chrt.orgInfoForConnections.ShipperOrgInfoForConnectionsClientCreate1`
|
|
9885
9777
|
|
|
9886
9778
|
</dd>
|
|
9887
9779
|
</dl>
|
|
@@ -9889,7 +9781,7 @@ await client.orderDrafts.cargo.associateWithTaskV1({
|
|
|
9889
9781
|
<dl>
|
|
9890
9782
|
<dd>
|
|
9891
9783
|
|
|
9892
|
-
**requestOptions:** `
|
|
9784
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
9893
9785
|
|
|
9894
9786
|
</dd>
|
|
9895
9787
|
</dl>
|
|
@@ -9900,7 +9792,7 @@ await client.orderDrafts.cargo.associateWithTaskV1({
|
|
|
9900
9792
|
</dl>
|
|
9901
9793
|
</details>
|
|
9902
9794
|
|
|
9903
|
-
<details><summary><code>client.
|
|
9795
|
+
<details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
9904
9796
|
<dl>
|
|
9905
9797
|
<dd>
|
|
9906
9798
|
|
|
@@ -9912,7 +9804,7 @@ await client.orderDrafts.cargo.associateWithTaskV1({
|
|
|
9912
9804
|
<dl>
|
|
9913
9805
|
<dd>
|
|
9914
9806
|
|
|
9915
|
-
Updates
|
|
9807
|
+
Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
9916
9808
|
|
|
9917
9809
|
</dd>
|
|
9918
9810
|
</dl>
|
|
@@ -9928,10 +9820,7 @@ Updates a cargo item in an existing draft order. Validates order is in DRAFT sta
|
|
|
9928
9820
|
<dd>
|
|
9929
9821
|
|
|
9930
9822
|
```typescript
|
|
9931
|
-
await client.
|
|
9932
|
-
cargo_id: "cargo_id",
|
|
9933
|
-
cargo_update: {},
|
|
9934
|
-
});
|
|
9823
|
+
await client.orgInfoForConnections.shipper.updateV1();
|
|
9935
9824
|
```
|
|
9936
9825
|
|
|
9937
9826
|
</dd>
|
|
@@ -9947,7 +9836,7 @@ await client.orderDrafts.cargo.updateV1({
|
|
|
9947
9836
|
<dl>
|
|
9948
9837
|
<dd>
|
|
9949
9838
|
|
|
9950
|
-
**request:** `Chrt.
|
|
9839
|
+
**request:** `Chrt.orgInfoForConnections.ShipperOrgInfoForConnectionsClientUpdate1`
|
|
9951
9840
|
|
|
9952
9841
|
</dd>
|
|
9953
9842
|
</dl>
|
|
@@ -9955,7 +9844,7 @@ await client.orderDrafts.cargo.updateV1({
|
|
|
9955
9844
|
<dl>
|
|
9956
9845
|
<dd>
|
|
9957
9846
|
|
|
9958
|
-
**requestOptions:** `
|
|
9847
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
9959
9848
|
|
|
9960
9849
|
</dd>
|
|
9961
9850
|
</dl>
|
|
@@ -9966,7 +9855,9 @@ await client.orderDrafts.cargo.updateV1({
|
|
|
9966
9855
|
</dl>
|
|
9967
9856
|
</details>
|
|
9968
9857
|
|
|
9969
|
-
|
|
9858
|
+
## OrgInfoForConnections Courier
|
|
9859
|
+
|
|
9860
|
+
<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">getV1</a>() -> Chrt.CourierOrgInfoForConnections1</code></summary>
|
|
9970
9861
|
<dl>
|
|
9971
9862
|
<dd>
|
|
9972
9863
|
|
|
@@ -9978,7 +9869,7 @@ await client.orderDrafts.cargo.updateV1({
|
|
|
9978
9869
|
<dl>
|
|
9979
9870
|
<dd>
|
|
9980
9871
|
|
|
9981
|
-
|
|
9872
|
+
Retrieves courier organization connection information for the authenticated organization. | () -> (CourierOrgInfoForConnections1)
|
|
9982
9873
|
|
|
9983
9874
|
</dd>
|
|
9984
9875
|
</dl>
|
|
@@ -9994,7 +9885,7 @@ Deletes a cargo item from a draft order and removes references from associated t
|
|
|
9994
9885
|
<dd>
|
|
9995
9886
|
|
|
9996
9887
|
```typescript
|
|
9997
|
-
await client.
|
|
9888
|
+
await client.orgInfoForConnections.courier.getV1();
|
|
9998
9889
|
```
|
|
9999
9890
|
|
|
10000
9891
|
</dd>
|
|
@@ -10010,15 +9901,7 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
|
10010
9901
|
<dl>
|
|
10011
9902
|
<dd>
|
|
10012
9903
|
|
|
10013
|
-
**
|
|
10014
|
-
|
|
10015
|
-
</dd>
|
|
10016
|
-
</dl>
|
|
10017
|
-
|
|
10018
|
-
<dl>
|
|
10019
|
-
<dd>
|
|
10020
|
-
|
|
10021
|
-
**requestOptions:** `Cargo.RequestOptions`
|
|
9904
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10022
9905
|
|
|
10023
9906
|
</dd>
|
|
10024
9907
|
</dl>
|
|
@@ -10029,9 +9912,7 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
|
10029
9912
|
</dl>
|
|
10030
9913
|
</details>
|
|
10031
9914
|
|
|
10032
|
-
|
|
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>
|
|
9915
|
+
<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">listV1</a>() -> Chrt.CourierOrgInfoForConnections1[]</code></summary>
|
|
10035
9916
|
<dl>
|
|
10036
9917
|
<dd>
|
|
10037
9918
|
|
|
@@ -10043,7 +9924,7 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
|
10043
9924
|
<dl>
|
|
10044
9925
|
<dd>
|
|
10045
9926
|
|
|
10046
|
-
Retrieves
|
|
9927
|
+
Retrieves list of connected courier organizations for forwarder or shipper organizations. Not accessible by courier organizations. | () -> (list[CourierOrgInfoForConnections1])
|
|
10047
9928
|
|
|
10048
9929
|
</dd>
|
|
10049
9930
|
</dl>
|
|
@@ -10059,7 +9940,7 @@ Retrieves shipper organization connection information for the authenticated orga
|
|
|
10059
9940
|
<dd>
|
|
10060
9941
|
|
|
10061
9942
|
```typescript
|
|
10062
|
-
await client.orgInfoForConnections.
|
|
9943
|
+
await client.orgInfoForConnections.courier.listV1();
|
|
10063
9944
|
```
|
|
10064
9945
|
|
|
10065
9946
|
</dd>
|
|
@@ -10075,7 +9956,7 @@ await client.orgInfoForConnections.shipper.getV1();
|
|
|
10075
9956
|
<dl>
|
|
10076
9957
|
<dd>
|
|
10077
9958
|
|
|
10078
|
-
**requestOptions:** `
|
|
9959
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10079
9960
|
|
|
10080
9961
|
</dd>
|
|
10081
9962
|
</dl>
|
|
@@ -10086,7 +9967,7 @@ await client.orgInfoForConnections.shipper.getV1();
|
|
|
10086
9967
|
</dl>
|
|
10087
9968
|
</details>
|
|
10088
9969
|
|
|
10089
|
-
<details><summary><code>client.orgInfoForConnections.
|
|
9970
|
+
<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
10090
9971
|
<dl>
|
|
10091
9972
|
<dd>
|
|
10092
9973
|
|
|
@@ -10098,7 +9979,7 @@ await client.orgInfoForConnections.shipper.getV1();
|
|
|
10098
9979
|
<dl>
|
|
10099
9980
|
<dd>
|
|
10100
9981
|
|
|
10101
|
-
Creates
|
|
9982
|
+
Creates courier organization connection information. Fails if already exists. | (CourierOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
10102
9983
|
|
|
10103
9984
|
</dd>
|
|
10104
9985
|
</dl>
|
|
@@ -10114,7 +9995,7 @@ Creates shipper organization connection information. Fails if already exists. |
|
|
|
10114
9995
|
<dd>
|
|
10115
9996
|
|
|
10116
9997
|
```typescript
|
|
10117
|
-
await client.orgInfoForConnections.
|
|
9998
|
+
await client.orgInfoForConnections.courier.createV1({
|
|
10118
9999
|
schema_version: 1,
|
|
10119
10000
|
email_address_primary: "email_address_primary",
|
|
10120
10001
|
});
|
|
@@ -10133,7 +10014,7 @@ await client.orgInfoForConnections.shipper.createV1({
|
|
|
10133
10014
|
<dl>
|
|
10134
10015
|
<dd>
|
|
10135
10016
|
|
|
10136
|
-
**request:** `Chrt.orgInfoForConnections.
|
|
10017
|
+
**request:** `Chrt.orgInfoForConnections.CourierOrgInfoForConnectionsClientCreate1`
|
|
10137
10018
|
|
|
10138
10019
|
</dd>
|
|
10139
10020
|
</dl>
|
|
@@ -10141,7 +10022,7 @@ await client.orgInfoForConnections.shipper.createV1({
|
|
|
10141
10022
|
<dl>
|
|
10142
10023
|
<dd>
|
|
10143
10024
|
|
|
10144
|
-
**requestOptions:** `
|
|
10025
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10145
10026
|
|
|
10146
10027
|
</dd>
|
|
10147
10028
|
</dl>
|
|
@@ -10152,7 +10033,7 @@ await client.orgInfoForConnections.shipper.createV1({
|
|
|
10152
10033
|
</dl>
|
|
10153
10034
|
</details>
|
|
10154
10035
|
|
|
10155
|
-
<details><summary><code>client.orgInfoForConnections.
|
|
10036
|
+
<details><summary><code>client.orgInfoForConnections.courier.<a href="/src/api/resources/orgInfoForConnections/resources/courier/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
10156
10037
|
<dl>
|
|
10157
10038
|
<dd>
|
|
10158
10039
|
|
|
@@ -10164,7 +10045,7 @@ await client.orgInfoForConnections.shipper.createV1({
|
|
|
10164
10045
|
<dl>
|
|
10165
10046
|
<dd>
|
|
10166
10047
|
|
|
10167
|
-
Updates existing
|
|
10048
|
+
Updates existing courier organization connection information. | (CourierOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
10168
10049
|
|
|
10169
10050
|
</dd>
|
|
10170
10051
|
</dl>
|
|
@@ -10180,7 +10061,7 @@ Updates existing shipper organization connection information. | (ShipperOrgInfoF
|
|
|
10180
10061
|
<dd>
|
|
10181
10062
|
|
|
10182
10063
|
```typescript
|
|
10183
|
-
await client.orgInfoForConnections.
|
|
10064
|
+
await client.orgInfoForConnections.courier.updateV1();
|
|
10184
10065
|
```
|
|
10185
10066
|
|
|
10186
10067
|
</dd>
|
|
@@ -10196,7 +10077,7 @@ await client.orgInfoForConnections.shipper.updateV1();
|
|
|
10196
10077
|
<dl>
|
|
10197
10078
|
<dd>
|
|
10198
10079
|
|
|
10199
|
-
**request:** `Chrt.orgInfoForConnections.
|
|
10080
|
+
**request:** `Chrt.orgInfoForConnections.CourierOrgInfoForConnectionsClientUpdate1`
|
|
10200
10081
|
|
|
10201
10082
|
</dd>
|
|
10202
10083
|
</dl>
|
|
@@ -10204,7 +10085,7 @@ await client.orgInfoForConnections.shipper.updateV1();
|
|
|
10204
10085
|
<dl>
|
|
10205
10086
|
<dd>
|
|
10206
10087
|
|
|
10207
|
-
**requestOptions:** `
|
|
10088
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10208
10089
|
|
|
10209
10090
|
</dd>
|
|
10210
10091
|
</dl>
|
|
@@ -10215,9 +10096,9 @@ await client.orgInfoForConnections.shipper.updateV1();
|
|
|
10215
10096
|
</dl>
|
|
10216
10097
|
</details>
|
|
10217
10098
|
|
|
10218
|
-
## OrgInfoForConnections
|
|
10099
|
+
## OrgInfoForConnections Forwarder
|
|
10219
10100
|
|
|
10220
|
-
<details><summary><code>client.orgInfoForConnections.
|
|
10101
|
+
<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">getV1</a>() -> Chrt.ForwarderOrgInfoForConnections1</code></summary>
|
|
10221
10102
|
<dl>
|
|
10222
10103
|
<dd>
|
|
10223
10104
|
|
|
@@ -10229,7 +10110,7 @@ await client.orgInfoForConnections.shipper.updateV1();
|
|
|
10229
10110
|
<dl>
|
|
10230
10111
|
<dd>
|
|
10231
10112
|
|
|
10232
|
-
Retrieves
|
|
10113
|
+
Retrieves forwarder organization connection information for the authenticated organization. | () -> (ForwarderOrgInfoForConnections1)
|
|
10233
10114
|
|
|
10234
10115
|
</dd>
|
|
10235
10116
|
</dl>
|
|
@@ -10245,7 +10126,7 @@ Retrieves courier organization connection information for the authenticated orga
|
|
|
10245
10126
|
<dd>
|
|
10246
10127
|
|
|
10247
10128
|
```typescript
|
|
10248
|
-
await client.orgInfoForConnections.
|
|
10129
|
+
await client.orgInfoForConnections.forwarder.getV1();
|
|
10249
10130
|
```
|
|
10250
10131
|
|
|
10251
10132
|
</dd>
|
|
@@ -10261,7 +10142,7 @@ await client.orgInfoForConnections.courier.getV1();
|
|
|
10261
10142
|
<dl>
|
|
10262
10143
|
<dd>
|
|
10263
10144
|
|
|
10264
|
-
**requestOptions:** `
|
|
10145
|
+
**requestOptions:** `Forwarder.RequestOptions`
|
|
10265
10146
|
|
|
10266
10147
|
</dd>
|
|
10267
10148
|
</dl>
|
|
@@ -10272,7 +10153,7 @@ await client.orgInfoForConnections.courier.getV1();
|
|
|
10272
10153
|
</dl>
|
|
10273
10154
|
</details>
|
|
10274
10155
|
|
|
10275
|
-
<details><summary><code>client.orgInfoForConnections.
|
|
10156
|
+
<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
10276
10157
|
<dl>
|
|
10277
10158
|
<dd>
|
|
10278
10159
|
|
|
@@ -10284,7 +10165,7 @@ await client.orgInfoForConnections.courier.getV1();
|
|
|
10284
10165
|
<dl>
|
|
10285
10166
|
<dd>
|
|
10286
10167
|
|
|
10287
|
-
|
|
10168
|
+
Creates forwarder organization connection information. Fails if already exists. | (ForwarderOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
10288
10169
|
|
|
10289
10170
|
</dd>
|
|
10290
10171
|
</dl>
|
|
@@ -10300,7 +10181,10 @@ Retrieves list of connected courier organizations for forwarder or shipper organ
|
|
|
10300
10181
|
<dd>
|
|
10301
10182
|
|
|
10302
10183
|
```typescript
|
|
10303
|
-
await client.orgInfoForConnections.
|
|
10184
|
+
await client.orgInfoForConnections.forwarder.createV1({
|
|
10185
|
+
schema_version: 1,
|
|
10186
|
+
email_address_primary: "email_address_primary",
|
|
10187
|
+
});
|
|
10304
10188
|
```
|
|
10305
10189
|
|
|
10306
10190
|
</dd>
|
|
@@ -10316,7 +10200,15 @@ await client.orgInfoForConnections.courier.listV1();
|
|
|
10316
10200
|
<dl>
|
|
10317
10201
|
<dd>
|
|
10318
10202
|
|
|
10319
|
-
**
|
|
10203
|
+
**request:** `Chrt.orgInfoForConnections.ForwarderOrgInfoForConnectionsClientCreate1`
|
|
10204
|
+
|
|
10205
|
+
</dd>
|
|
10206
|
+
</dl>
|
|
10207
|
+
|
|
10208
|
+
<dl>
|
|
10209
|
+
<dd>
|
|
10210
|
+
|
|
10211
|
+
**requestOptions:** `Forwarder.RequestOptions`
|
|
10320
10212
|
|
|
10321
10213
|
</dd>
|
|
10322
10214
|
</dl>
|
|
@@ -10327,7 +10219,7 @@ await client.orgInfoForConnections.courier.listV1();
|
|
|
10327
10219
|
</dl>
|
|
10328
10220
|
</details>
|
|
10329
10221
|
|
|
10330
|
-
<details><summary><code>client.orgInfoForConnections.
|
|
10222
|
+
<details><summary><code>client.orgInfoForConnections.forwarder.<a href="/src/api/resources/orgInfoForConnections/resources/forwarder/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
10331
10223
|
<dl>
|
|
10332
10224
|
<dd>
|
|
10333
10225
|
|
|
@@ -10339,7 +10231,7 @@ await client.orgInfoForConnections.courier.listV1();
|
|
|
10339
10231
|
<dl>
|
|
10340
10232
|
<dd>
|
|
10341
10233
|
|
|
10342
|
-
|
|
10234
|
+
Updates existing forwarder organization connection information. | (ForwarderOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
10343
10235
|
|
|
10344
10236
|
</dd>
|
|
10345
10237
|
</dl>
|
|
@@ -10355,10 +10247,7 @@ Creates courier organization connection information. Fails if already exists. |
|
|
|
10355
10247
|
<dd>
|
|
10356
10248
|
|
|
10357
10249
|
```typescript
|
|
10358
|
-
await client.orgInfoForConnections.
|
|
10359
|
-
schema_version: 1,
|
|
10360
|
-
email_address_primary: "email_address_primary",
|
|
10361
|
-
});
|
|
10250
|
+
await client.orgInfoForConnections.forwarder.updateV1();
|
|
10362
10251
|
```
|
|
10363
10252
|
|
|
10364
10253
|
</dd>
|
|
@@ -10374,7 +10263,7 @@ await client.orgInfoForConnections.courier.createV1({
|
|
|
10374
10263
|
<dl>
|
|
10375
10264
|
<dd>
|
|
10376
10265
|
|
|
10377
|
-
**request:** `Chrt.orgInfoForConnections.
|
|
10266
|
+
**request:** `Chrt.orgInfoForConnections.ForwarderOrgInfoForConnectionsClientUpdate1`
|
|
10378
10267
|
|
|
10379
10268
|
</dd>
|
|
10380
10269
|
</dl>
|
|
@@ -10382,7 +10271,7 @@ await client.orgInfoForConnections.courier.createV1({
|
|
|
10382
10271
|
<dl>
|
|
10383
10272
|
<dd>
|
|
10384
10273
|
|
|
10385
|
-
**requestOptions:** `
|
|
10274
|
+
**requestOptions:** `Forwarder.RequestOptions`
|
|
10386
10275
|
|
|
10387
10276
|
</dd>
|
|
10388
10277
|
</dl>
|
|
@@ -10393,7 +10282,9 @@ await client.orgInfoForConnections.courier.createV1({
|
|
|
10393
10282
|
</dl>
|
|
10394
10283
|
</details>
|
|
10395
10284
|
|
|
10396
|
-
|
|
10285
|
+
## ShipperPayCourierLineItemGroups Shipper
|
|
10286
|
+
|
|
10287
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.shipper.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.ts">listV1</a>() -> Chrt.ShipperPayCourierLineItemGroup1[]</code></summary>
|
|
10397
10288
|
<dl>
|
|
10398
10289
|
<dd>
|
|
10399
10290
|
|
|
@@ -10405,7 +10296,7 @@ await client.orgInfoForConnections.courier.createV1({
|
|
|
10405
10296
|
<dl>
|
|
10406
10297
|
<dd>
|
|
10407
10298
|
|
|
10408
|
-
|
|
10299
|
+
Lists all shipper pay courier line item groups for the authenticated shipper organization.
|
|
10409
10300
|
|
|
10410
10301
|
</dd>
|
|
10411
10302
|
</dl>
|
|
@@ -10421,7 +10312,7 @@ Updates existing courier organization connection information. | (CourierOrgInfoF
|
|
|
10421
10312
|
<dd>
|
|
10422
10313
|
|
|
10423
10314
|
```typescript
|
|
10424
|
-
await client.
|
|
10315
|
+
await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
10425
10316
|
```
|
|
10426
10317
|
|
|
10427
10318
|
</dd>
|
|
@@ -10431,21 +10322,13 @@ await client.orgInfoForConnections.courier.updateV1();
|
|
|
10431
10322
|
|
|
10432
10323
|
#### ⚙️ Parameters
|
|
10433
10324
|
|
|
10434
|
-
<dl>
|
|
10435
|
-
<dd>
|
|
10436
|
-
|
|
10437
|
-
<dl>
|
|
10438
|
-
<dd>
|
|
10439
|
-
|
|
10440
|
-
**request:** `Chrt.orgInfoForConnections.CourierOrgInfoForConnectionsClientUpdate1`
|
|
10441
|
-
|
|
10442
|
-
</dd>
|
|
10443
|
-
</dl>
|
|
10325
|
+
<dl>
|
|
10326
|
+
<dd>
|
|
10444
10327
|
|
|
10445
10328
|
<dl>
|
|
10446
10329
|
<dd>
|
|
10447
10330
|
|
|
10448
|
-
**requestOptions:** `
|
|
10331
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
10449
10332
|
|
|
10450
10333
|
</dd>
|
|
10451
10334
|
</dl>
|
|
@@ -10456,9 +10339,7 @@ await client.orgInfoForConnections.courier.updateV1();
|
|
|
10456
10339
|
</dl>
|
|
10457
10340
|
</details>
|
|
10458
10341
|
|
|
10459
|
-
|
|
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>
|
|
10342
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.shipper.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.ts">getByIdV1</a>(id) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
|
|
10462
10343
|
<dl>
|
|
10463
10344
|
<dd>
|
|
10464
10345
|
|
|
@@ -10470,7 +10351,7 @@ await client.orgInfoForConnections.courier.updateV1();
|
|
|
10470
10351
|
<dl>
|
|
10471
10352
|
<dd>
|
|
10472
10353
|
|
|
10473
|
-
Retrieves
|
|
10354
|
+
Retrieves a shipper pay courier line item group by its ID for the authenticated shipper organization.
|
|
10474
10355
|
|
|
10475
10356
|
</dd>
|
|
10476
10357
|
</dl>
|
|
@@ -10486,7 +10367,7 @@ Retrieves forwarder organization connection information for the authenticated or
|
|
|
10486
10367
|
<dd>
|
|
10487
10368
|
|
|
10488
10369
|
```typescript
|
|
10489
|
-
await client.
|
|
10370
|
+
await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
10490
10371
|
```
|
|
10491
10372
|
|
|
10492
10373
|
</dd>
|
|
@@ -10502,7 +10383,15 @@ await client.orgInfoForConnections.forwarder.getV1();
|
|
|
10502
10383
|
<dl>
|
|
10503
10384
|
<dd>
|
|
10504
10385
|
|
|
10505
|
-
**
|
|
10386
|
+
**id:** `string`
|
|
10387
|
+
|
|
10388
|
+
</dd>
|
|
10389
|
+
</dl>
|
|
10390
|
+
|
|
10391
|
+
<dl>
|
|
10392
|
+
<dd>
|
|
10393
|
+
|
|
10394
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
10506
10395
|
|
|
10507
10396
|
</dd>
|
|
10508
10397
|
</dl>
|
|
@@ -10513,7 +10402,7 @@ await client.orgInfoForConnections.forwarder.getV1();
|
|
|
10513
10402
|
</dl>
|
|
10514
10403
|
</details>
|
|
10515
10404
|
|
|
10516
|
-
<details><summary><code>client.
|
|
10405
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.shipper.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/shipper/client/Client.ts">byTaskGroupIdV1</a>(taskGroupId) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
|
|
10517
10406
|
<dl>
|
|
10518
10407
|
<dd>
|
|
10519
10408
|
|
|
@@ -10525,7 +10414,7 @@ await client.orgInfoForConnections.forwarder.getV1();
|
|
|
10525
10414
|
<dl>
|
|
10526
10415
|
<dd>
|
|
10527
10416
|
|
|
10528
|
-
|
|
10417
|
+
Retrieves a shipper pay courier line item group by its associated task group ID for the authenticated shipper organization.
|
|
10529
10418
|
|
|
10530
10419
|
</dd>
|
|
10531
10420
|
</dl>
|
|
@@ -10541,10 +10430,7 @@ Creates forwarder organization connection information. Fails if already exists.
|
|
|
10541
10430
|
<dd>
|
|
10542
10431
|
|
|
10543
10432
|
```typescript
|
|
10544
|
-
await client.
|
|
10545
|
-
schema_version: 1,
|
|
10546
|
-
email_address_primary: "email_address_primary",
|
|
10547
|
-
});
|
|
10433
|
+
await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group_id");
|
|
10548
10434
|
```
|
|
10549
10435
|
|
|
10550
10436
|
</dd>
|
|
@@ -10560,7 +10446,7 @@ await client.orgInfoForConnections.forwarder.createV1({
|
|
|
10560
10446
|
<dl>
|
|
10561
10447
|
<dd>
|
|
10562
10448
|
|
|
10563
|
-
**
|
|
10449
|
+
**taskGroupId:** `string`
|
|
10564
10450
|
|
|
10565
10451
|
</dd>
|
|
10566
10452
|
</dl>
|
|
@@ -10568,7 +10454,7 @@ await client.orgInfoForConnections.forwarder.createV1({
|
|
|
10568
10454
|
<dl>
|
|
10569
10455
|
<dd>
|
|
10570
10456
|
|
|
10571
|
-
**requestOptions:** `
|
|
10457
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
10572
10458
|
|
|
10573
10459
|
</dd>
|
|
10574
10460
|
</dl>
|
|
@@ -10579,7 +10465,9 @@ await client.orgInfoForConnections.forwarder.createV1({
|
|
|
10579
10465
|
</dl>
|
|
10580
10466
|
</details>
|
|
10581
10467
|
|
|
10582
|
-
|
|
10468
|
+
## ShipperPayCourierLineItemGroups Courier
|
|
10469
|
+
|
|
10470
|
+
<details><summary><code>client.shipperPayCourierLineItemGroups.courier.<a href="/src/api/resources/shipperPayCourierLineItemGroups/resources/courier/client/Client.ts">listV1</a>() -> Chrt.ShipperPayCourierLineItemGroup1[]</code></summary>
|
|
10583
10471
|
<dl>
|
|
10584
10472
|
<dd>
|
|
10585
10473
|
|
|
@@ -10591,7 +10479,7 @@ await client.orgInfoForConnections.forwarder.createV1({
|
|
|
10591
10479
|
<dl>
|
|
10592
10480
|
<dd>
|
|
10593
10481
|
|
|
10594
|
-
|
|
10482
|
+
Lists all shipper pay courier line item groups for the authenticated courier organization.
|
|
10595
10483
|
|
|
10596
10484
|
</dd>
|
|
10597
10485
|
</dl>
|
|
@@ -10607,7 +10495,7 @@ Updates existing forwarder organization connection information. | (ForwarderOrgI
|
|
|
10607
10495
|
<dd>
|
|
10608
10496
|
|
|
10609
10497
|
```typescript
|
|
10610
|
-
await client.
|
|
10498
|
+
await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
10611
10499
|
```
|
|
10612
10500
|
|
|
10613
10501
|
</dd>
|
|
@@ -10623,15 +10511,7 @@ await client.orgInfoForConnections.forwarder.updateV1();
|
|
|
10623
10511
|
<dl>
|
|
10624
10512
|
<dd>
|
|
10625
10513
|
|
|
10626
|
-
**
|
|
10627
|
-
|
|
10628
|
-
</dd>
|
|
10629
|
-
</dl>
|
|
10630
|
-
|
|
10631
|
-
<dl>
|
|
10632
|
-
<dd>
|
|
10633
|
-
|
|
10634
|
-
**requestOptions:** `Forwarder.RequestOptions`
|
|
10514
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
10635
10515
|
|
|
10636
10516
|
</dd>
|
|
10637
10517
|
</dl>
|
|
@@ -10642,9 +10522,9 @@ await client.orgInfoForConnections.forwarder.updateV1();
|
|
|
10642
10522
|
</dl>
|
|
10643
10523
|
</details>
|
|
10644
10524
|
|
|
10645
|
-
## ShipperPayCourierLineItemGroups
|
|
10525
|
+
## ShipperPayCourierLineItemGroups AddLineItems
|
|
10646
10526
|
|
|
10647
|
-
<details><summary><code>client.shipperPayCourierLineItemGroups.
|
|
10527
|
+
<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>
|
|
10648
10528
|
<dl>
|
|
10649
10529
|
<dd>
|
|
10650
10530
|
|
|
@@ -10656,7 +10536,7 @@ await client.orgInfoForConnections.forwarder.updateV1();
|
|
|
10656
10536
|
<dl>
|
|
10657
10537
|
<dd>
|
|
10658
10538
|
|
|
10659
|
-
|
|
10539
|
+
Adds additional line items to an existing shipper pay courier line item group.
|
|
10660
10540
|
|
|
10661
10541
|
</dd>
|
|
10662
10542
|
</dl>
|
|
@@ -10672,7 +10552,16 @@ Lists all shipper pay courier line item groups for the authenticated shipper org
|
|
|
10672
10552
|
<dd>
|
|
10673
10553
|
|
|
10674
10554
|
```typescript
|
|
10675
|
-
await client.shipperPayCourierLineItemGroups.
|
|
10555
|
+
await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
10556
|
+
line_items: [
|
|
10557
|
+
{
|
|
10558
|
+
schema_version: 1,
|
|
10559
|
+
item: "base_rate",
|
|
10560
|
+
quantity: 1.1,
|
|
10561
|
+
rate: 1.1,
|
|
10562
|
+
},
|
|
10563
|
+
],
|
|
10564
|
+
});
|
|
10676
10565
|
```
|
|
10677
10566
|
|
|
10678
10567
|
</dd>
|
|
@@ -10688,7 +10577,23 @@ await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
|
10688
10577
|
<dl>
|
|
10689
10578
|
<dd>
|
|
10690
10579
|
|
|
10691
|
-
**
|
|
10580
|
+
**id:** `string`
|
|
10581
|
+
|
|
10582
|
+
</dd>
|
|
10583
|
+
</dl>
|
|
10584
|
+
|
|
10585
|
+
<dl>
|
|
10586
|
+
<dd>
|
|
10587
|
+
|
|
10588
|
+
**request:** `Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupAddLineItemsReq`
|
|
10589
|
+
|
|
10590
|
+
</dd>
|
|
10591
|
+
</dl>
|
|
10592
|
+
|
|
10593
|
+
<dl>
|
|
10594
|
+
<dd>
|
|
10595
|
+
|
|
10596
|
+
**requestOptions:** `AddLineItems.RequestOptions`
|
|
10692
10597
|
|
|
10693
10598
|
</dd>
|
|
10694
10599
|
</dl>
|
|
@@ -10699,7 +10604,9 @@ await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
|
10699
10604
|
</dl>
|
|
10700
10605
|
</details>
|
|
10701
10606
|
|
|
10702
|
-
|
|
10607
|
+
## ShipperPayCourierLineItemGroups RemoveLineItems
|
|
10608
|
+
|
|
10609
|
+
<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>
|
|
10703
10610
|
<dl>
|
|
10704
10611
|
<dd>
|
|
10705
10612
|
|
|
@@ -10711,7 +10618,7 @@ await client.shipperPayCourierLineItemGroups.shipper.listV1();
|
|
|
10711
10618
|
<dl>
|
|
10712
10619
|
<dd>
|
|
10713
10620
|
|
|
10714
|
-
|
|
10621
|
+
Removes specific line items from a shipper pay courier line item group by their UUID identifiers.
|
|
10715
10622
|
|
|
10716
10623
|
</dd>
|
|
10717
10624
|
</dl>
|
|
@@ -10727,7 +10634,9 @@ Retrieves a shipper pay courier line item group by its ID for the authenticated
|
|
|
10727
10634
|
<dd>
|
|
10728
10635
|
|
|
10729
10636
|
```typescript
|
|
10730
|
-
await client.shipperPayCourierLineItemGroups.
|
|
10637
|
+
await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
10638
|
+
line_item_uuid_strs: ["line_item_uuid_strs"],
|
|
10639
|
+
});
|
|
10731
10640
|
```
|
|
10732
10641
|
|
|
10733
10642
|
</dd>
|
|
@@ -10751,7 +10660,15 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
10751
10660
|
<dl>
|
|
10752
10661
|
<dd>
|
|
10753
10662
|
|
|
10754
|
-
**
|
|
10663
|
+
**request:** `Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupRemoveLineItemsReq`
|
|
10664
|
+
|
|
10665
|
+
</dd>
|
|
10666
|
+
</dl>
|
|
10667
|
+
|
|
10668
|
+
<dl>
|
|
10669
|
+
<dd>
|
|
10670
|
+
|
|
10671
|
+
**requestOptions:** `RemoveLineItems.RequestOptions`
|
|
10755
10672
|
|
|
10756
10673
|
</dd>
|
|
10757
10674
|
</dl>
|
|
@@ -10762,7 +10679,9 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
10762
10679
|
</dl>
|
|
10763
10680
|
</details>
|
|
10764
10681
|
|
|
10765
|
-
|
|
10682
|
+
## TaskArtifacts Images
|
|
10683
|
+
|
|
10684
|
+
<details><summary><code>client.taskArtifacts.images.<a href="/src/api/resources/taskArtifacts/resources/images/client/Client.ts">getByMetadataIdV1</a>(taskArtifactS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
10766
10685
|
<dl>
|
|
10767
10686
|
<dd>
|
|
10768
10687
|
|
|
@@ -10774,7 +10693,7 @@ await client.shipperPayCourierLineItemGroups.shipper.getByIdV1("id");
|
|
|
10774
10693
|
<dl>
|
|
10775
10694
|
<dd>
|
|
10776
10695
|
|
|
10777
|
-
|
|
10696
|
+
Streams a task_artifact image file from S3 storage. | () -> (StreamingResponse)
|
|
10778
10697
|
|
|
10779
10698
|
</dd>
|
|
10780
10699
|
</dl>
|
|
@@ -10790,7 +10709,7 @@ Retrieves a shipper pay courier line item group by its associated task group ID
|
|
|
10790
10709
|
<dd>
|
|
10791
10710
|
|
|
10792
10711
|
```typescript
|
|
10793
|
-
await client.
|
|
10712
|
+
await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_metadata_id");
|
|
10794
10713
|
```
|
|
10795
10714
|
|
|
10796
10715
|
</dd>
|
|
@@ -10806,7 +10725,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
10806
10725
|
<dl>
|
|
10807
10726
|
<dd>
|
|
10808
10727
|
|
|
10809
|
-
**
|
|
10728
|
+
**taskArtifactS3ObjectMetadataId:** `string`
|
|
10810
10729
|
|
|
10811
10730
|
</dd>
|
|
10812
10731
|
</dl>
|
|
@@ -10814,7 +10733,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
10814
10733
|
<dl>
|
|
10815
10734
|
<dd>
|
|
10816
10735
|
|
|
10817
|
-
**requestOptions:** `
|
|
10736
|
+
**requestOptions:** `Images.RequestOptions`
|
|
10818
10737
|
|
|
10819
10738
|
</dd>
|
|
10820
10739
|
</dl>
|
|
@@ -10825,9 +10744,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
10825
10744
|
</dl>
|
|
10826
10745
|
</details>
|
|
10827
10746
|
|
|
10828
|
-
|
|
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>
|
|
10747
|
+
<details><summary><code>client.taskArtifacts.images.<a href="/src/api/resources/taskArtifacts/resources/images/client/Client.ts">uploadByTaskArtifactIdV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
|
|
10831
10748
|
<dl>
|
|
10832
10749
|
<dd>
|
|
10833
10750
|
|
|
@@ -10839,7 +10756,7 @@ await client.shipperPayCourierLineItemGroups.shipper.byTaskGroupIdV1("task_group
|
|
|
10839
10756
|
<dl>
|
|
10840
10757
|
<dd>
|
|
10841
10758
|
|
|
10842
|
-
|
|
10759
|
+
Uploads an image file to a task_artifact with automatic blurhash generation. | (UploadFile) -> (bool)
|
|
10843
10760
|
|
|
10844
10761
|
</dd>
|
|
10845
10762
|
</dl>
|
|
@@ -10855,7 +10772,9 @@ Lists all shipper pay courier line item groups for the authenticated courier org
|
|
|
10855
10772
|
<dd>
|
|
10856
10773
|
|
|
10857
10774
|
```typescript
|
|
10858
|
-
await client.
|
|
10775
|
+
await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
10776
|
+
image: fs.createReadStream("/path/to/your/file"),
|
|
10777
|
+
});
|
|
10859
10778
|
```
|
|
10860
10779
|
|
|
10861
10780
|
</dd>
|
|
@@ -10871,7 +10790,23 @@ await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
|
10871
10790
|
<dl>
|
|
10872
10791
|
<dd>
|
|
10873
10792
|
|
|
10874
|
-
**
|
|
10793
|
+
**taskArtifactId:** `string`
|
|
10794
|
+
|
|
10795
|
+
</dd>
|
|
10796
|
+
</dl>
|
|
10797
|
+
|
|
10798
|
+
<dl>
|
|
10799
|
+
<dd>
|
|
10800
|
+
|
|
10801
|
+
**request:** `Chrt.taskArtifacts.BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost`
|
|
10802
|
+
|
|
10803
|
+
</dd>
|
|
10804
|
+
</dl>
|
|
10805
|
+
|
|
10806
|
+
<dl>
|
|
10807
|
+
<dd>
|
|
10808
|
+
|
|
10809
|
+
**requestOptions:** `Images.RequestOptions`
|
|
10875
10810
|
|
|
10876
10811
|
</dd>
|
|
10877
10812
|
</dl>
|
|
@@ -10882,9 +10817,7 @@ await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
|
10882
10817
|
</dl>
|
|
10883
10818
|
</details>
|
|
10884
10819
|
|
|
10885
|
-
|
|
10886
|
-
|
|
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>
|
|
10820
|
+
<details><summary><code>client.taskArtifacts.images.<a href="/src/api/resources/taskArtifacts/resources/images/client/Client.ts">deleteByMetadataIdV1</a>(taskArtifactS3ObjectMetadataId) -> boolean</code></summary>
|
|
10888
10821
|
<dl>
|
|
10889
10822
|
<dd>
|
|
10890
10823
|
|
|
@@ -10896,7 +10829,7 @@ await client.shipperPayCourierLineItemGroups.courier.listV1();
|
|
|
10896
10829
|
<dl>
|
|
10897
10830
|
<dd>
|
|
10898
10831
|
|
|
10899
|
-
|
|
10832
|
+
Deletes a task_artifact image from both S3 storage and database metadata. | () -> (bool)
|
|
10900
10833
|
|
|
10901
10834
|
</dd>
|
|
10902
10835
|
</dl>
|
|
@@ -10912,16 +10845,7 @@ Adds additional line items to an existing shipper pay courier line item group.
|
|
|
10912
10845
|
<dd>
|
|
10913
10846
|
|
|
10914
10847
|
```typescript
|
|
10915
|
-
await client.
|
|
10916
|
-
line_items: [
|
|
10917
|
-
{
|
|
10918
|
-
schema_version: 1,
|
|
10919
|
-
item: "base_rate",
|
|
10920
|
-
quantity: 1.1,
|
|
10921
|
-
rate: 1.1,
|
|
10922
|
-
},
|
|
10923
|
-
],
|
|
10924
|
-
});
|
|
10848
|
+
await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_metadata_id");
|
|
10925
10849
|
```
|
|
10926
10850
|
|
|
10927
10851
|
</dd>
|
|
@@ -10937,15 +10861,7 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
10937
10861
|
<dl>
|
|
10938
10862
|
<dd>
|
|
10939
10863
|
|
|
10940
|
-
**
|
|
10941
|
-
|
|
10942
|
-
</dd>
|
|
10943
|
-
</dl>
|
|
10944
|
-
|
|
10945
|
-
<dl>
|
|
10946
|
-
<dd>
|
|
10947
|
-
|
|
10948
|
-
**request:** `Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupAddLineItemsReq`
|
|
10864
|
+
**taskArtifactS3ObjectMetadataId:** `string`
|
|
10949
10865
|
|
|
10950
10866
|
</dd>
|
|
10951
10867
|
</dl>
|
|
@@ -10953,7 +10869,7 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
10953
10869
|
<dl>
|
|
10954
10870
|
<dd>
|
|
10955
10871
|
|
|
10956
|
-
**requestOptions:** `
|
|
10872
|
+
**requestOptions:** `Images.RequestOptions`
|
|
10957
10873
|
|
|
10958
10874
|
</dd>
|
|
10959
10875
|
</dl>
|
|
@@ -10964,9 +10880,9 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
10964
10880
|
</dl>
|
|
10965
10881
|
</details>
|
|
10966
10882
|
|
|
10967
|
-
##
|
|
10883
|
+
## TaskArtifacts Blurhash
|
|
10968
10884
|
|
|
10969
|
-
<details><summary><code>client.
|
|
10885
|
+
<details><summary><code>client.taskArtifacts.blurhash.<a href="/src/api/resources/taskArtifacts/resources/blurhash/client/Client.ts">getByMetadataIdV1</a>(taskArtifactS3ObjectMetadataId) -> string</code></summary>
|
|
10970
10886
|
<dl>
|
|
10971
10887
|
<dd>
|
|
10972
10888
|
|
|
@@ -10978,7 +10894,7 @@ await client.shipperPayCourierLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
10978
10894
|
<dl>
|
|
10979
10895
|
<dd>
|
|
10980
10896
|
|
|
10981
|
-
|
|
10897
|
+
Retrieves the blurhash string for a task_artifact image for fast placeholder loading. | () -> (BlurHash)
|
|
10982
10898
|
|
|
10983
10899
|
</dd>
|
|
10984
10900
|
</dl>
|
|
@@ -10994,9 +10910,7 @@ Removes specific line items from a shipper pay courier line item group by their
|
|
|
10994
10910
|
<dd>
|
|
10995
10911
|
|
|
10996
10912
|
```typescript
|
|
10997
|
-
await client.
|
|
10998
|
-
line_item_uuid_strs: ["line_item_uuid_strs"],
|
|
10999
|
-
});
|
|
10913
|
+
await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_metadata_id");
|
|
11000
10914
|
```
|
|
11001
10915
|
|
|
11002
10916
|
</dd>
|
|
@@ -11012,15 +10926,7 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
11012
10926
|
<dl>
|
|
11013
10927
|
<dd>
|
|
11014
10928
|
|
|
11015
|
-
**
|
|
11016
|
-
|
|
11017
|
-
</dd>
|
|
11018
|
-
</dl>
|
|
11019
|
-
|
|
11020
|
-
<dl>
|
|
11021
|
-
<dd>
|
|
11022
|
-
|
|
11023
|
-
**request:** `Chrt.shipperPayCourierLineItemGroups.ShipperPayCourierLineItemGroupRemoveLineItemsReq`
|
|
10929
|
+
**taskArtifactS3ObjectMetadataId:** `string`
|
|
11024
10930
|
|
|
11025
10931
|
</dd>
|
|
11026
10932
|
</dl>
|
|
@@ -11028,7 +10934,7 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
11028
10934
|
<dl>
|
|
11029
10935
|
<dd>
|
|
11030
10936
|
|
|
11031
|
-
**requestOptions:** `
|
|
10937
|
+
**requestOptions:** `Blurhash.RequestOptions`
|
|
11032
10938
|
|
|
11033
10939
|
</dd>
|
|
11034
10940
|
</dl>
|
|
@@ -11039,9 +10945,9 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
11039
10945
|
</dl>
|
|
11040
10946
|
</details>
|
|
11041
10947
|
|
|
11042
|
-
##
|
|
10948
|
+
## TaskGroups Expanded
|
|
11043
10949
|
|
|
11044
|
-
<details><summary><code>client.
|
|
10950
|
+
<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">forCourierOperatorsV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupExpanded</code></summary>
|
|
11045
10951
|
<dl>
|
|
11046
10952
|
<dd>
|
|
11047
10953
|
|
|
@@ -11053,7 +10959,7 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
11053
10959
|
<dl>
|
|
11054
10960
|
<dd>
|
|
11055
10961
|
|
|
11056
|
-
|
|
10962
|
+
Retrieves an expanded task group with optional related data for courier operators. | authz_personas=[courier_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
11057
10963
|
|
|
11058
10964
|
</dd>
|
|
11059
10965
|
</dl>
|
|
@@ -11069,7 +10975,7 @@ Streams a task_artifact image file from S3 storage. | () -> (StreamingResponse)
|
|
|
11069
10975
|
<dd>
|
|
11070
10976
|
|
|
11071
10977
|
```typescript
|
|
11072
|
-
await client.
|
|
10978
|
+
await client.taskGroups.expanded.forCourierOperatorsV1("task_group_id", {});
|
|
11073
10979
|
```
|
|
11074
10980
|
|
|
11075
10981
|
</dd>
|
|
@@ -11085,7 +10991,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
11085
10991
|
<dl>
|
|
11086
10992
|
<dd>
|
|
11087
10993
|
|
|
11088
|
-
**
|
|
10994
|
+
**taskGroupId:** `string`
|
|
11089
10995
|
|
|
11090
10996
|
</dd>
|
|
11091
10997
|
</dl>
|
|
@@ -11093,7 +10999,15 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
11093
10999
|
<dl>
|
|
11094
11000
|
<dd>
|
|
11095
11001
|
|
|
11096
|
-
**
|
|
11002
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
11003
|
+
|
|
11004
|
+
</dd>
|
|
11005
|
+
</dl>
|
|
11006
|
+
|
|
11007
|
+
<dl>
|
|
11008
|
+
<dd>
|
|
11009
|
+
|
|
11010
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
11097
11011
|
|
|
11098
11012
|
</dd>
|
|
11099
11013
|
</dl>
|
|
@@ -11104,7 +11018,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
11104
11018
|
</dl>
|
|
11105
11019
|
</details>
|
|
11106
11020
|
|
|
11107
|
-
<details><summary><code>client.
|
|
11021
|
+
<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">forCourierDriverV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupExpanded</code></summary>
|
|
11108
11022
|
<dl>
|
|
11109
11023
|
<dd>
|
|
11110
11024
|
|
|
@@ -11116,7 +11030,7 @@ await client.taskArtifacts.images.getByMetadataIdV1("task_artifact_s3_object_met
|
|
|
11116
11030
|
<dl>
|
|
11117
11031
|
<dd>
|
|
11118
11032
|
|
|
11119
|
-
|
|
11033
|
+
Retrieves an expanded task group with optional related data for courier drivers. | authz_personas=[courier_driver] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
11120
11034
|
|
|
11121
11035
|
</dd>
|
|
11122
11036
|
</dl>
|
|
@@ -11132,9 +11046,7 @@ Uploads an image file to a task_artifact with automatic blurhash generation. | (
|
|
|
11132
11046
|
<dd>
|
|
11133
11047
|
|
|
11134
11048
|
```typescript
|
|
11135
|
-
await client.
|
|
11136
|
-
image: fs.createReadStream("/path/to/your/file"),
|
|
11137
|
-
});
|
|
11049
|
+
await client.taskGroups.expanded.forCourierDriverV1("task_group_id", {});
|
|
11138
11050
|
```
|
|
11139
11051
|
|
|
11140
11052
|
</dd>
|
|
@@ -11150,7 +11062,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
11150
11062
|
<dl>
|
|
11151
11063
|
<dd>
|
|
11152
11064
|
|
|
11153
|
-
**
|
|
11065
|
+
**taskGroupId:** `string`
|
|
11154
11066
|
|
|
11155
11067
|
</dd>
|
|
11156
11068
|
</dl>
|
|
@@ -11158,7 +11070,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
11158
11070
|
<dl>
|
|
11159
11071
|
<dd>
|
|
11160
11072
|
|
|
11161
|
-
**request:** `Chrt.
|
|
11073
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
11162
11074
|
|
|
11163
11075
|
</dd>
|
|
11164
11076
|
</dl>
|
|
@@ -11166,7 +11078,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
11166
11078
|
<dl>
|
|
11167
11079
|
<dd>
|
|
11168
11080
|
|
|
11169
|
-
**requestOptions:** `
|
|
11081
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
11170
11082
|
|
|
11171
11083
|
</dd>
|
|
11172
11084
|
</dl>
|
|
@@ -11177,7 +11089,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
11177
11089
|
</dl>
|
|
11178
11090
|
</details>
|
|
11179
11091
|
|
|
11180
|
-
<details><summary><code>client.
|
|
11092
|
+
<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupExpanded</code></summary>
|
|
11181
11093
|
<dl>
|
|
11182
11094
|
<dd>
|
|
11183
11095
|
|
|
@@ -11189,7 +11101,7 @@ await client.taskArtifacts.images.uploadByTaskArtifactIdV1("task_artifact_id", {
|
|
|
11189
11101
|
<dl>
|
|
11190
11102
|
<dd>
|
|
11191
11103
|
|
|
11192
|
-
|
|
11104
|
+
Retrieves an expanded task group with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
11193
11105
|
|
|
11194
11106
|
</dd>
|
|
11195
11107
|
</dl>
|
|
@@ -11205,7 +11117,7 @@ Deletes a task_artifact image from both S3 storage and database metadata. | () -
|
|
|
11205
11117
|
<dd>
|
|
11206
11118
|
|
|
11207
11119
|
```typescript
|
|
11208
|
-
await client.
|
|
11120
|
+
await client.taskGroups.expanded.forShipperOperatorsV1("task_group_id", {});
|
|
11209
11121
|
```
|
|
11210
11122
|
|
|
11211
11123
|
</dd>
|
|
@@ -11221,7 +11133,7 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
11221
11133
|
<dl>
|
|
11222
11134
|
<dd>
|
|
11223
11135
|
|
|
11224
|
-
**
|
|
11136
|
+
**taskGroupId:** `string`
|
|
11225
11137
|
|
|
11226
11138
|
</dd>
|
|
11227
11139
|
</dl>
|
|
@@ -11229,7 +11141,15 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
11229
11141
|
<dl>
|
|
11230
11142
|
<dd>
|
|
11231
11143
|
|
|
11232
|
-
**
|
|
11144
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
11145
|
+
|
|
11146
|
+
</dd>
|
|
11147
|
+
</dl>
|
|
11148
|
+
|
|
11149
|
+
<dl>
|
|
11150
|
+
<dd>
|
|
11151
|
+
|
|
11152
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
11233
11153
|
|
|
11234
11154
|
</dd>
|
|
11235
11155
|
</dl>
|
|
@@ -11240,9 +11160,7 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
11240
11160
|
</dl>
|
|
11241
11161
|
</details>
|
|
11242
11162
|
|
|
11243
|
-
|
|
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>
|
|
11163
|
+
<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupExpanded</code></summary>
|
|
11246
11164
|
<dl>
|
|
11247
11165
|
<dd>
|
|
11248
11166
|
|
|
@@ -11254,7 +11172,7 @@ await client.taskArtifacts.images.deleteByMetadataIdV1("task_artifact_s3_object_
|
|
|
11254
11172
|
<dl>
|
|
11255
11173
|
<dd>
|
|
11256
11174
|
|
|
11257
|
-
Retrieves
|
|
11175
|
+
Retrieves an expanded task group with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
11258
11176
|
|
|
11259
11177
|
</dd>
|
|
11260
11178
|
</dl>
|
|
@@ -11270,7 +11188,7 @@ Retrieves the blurhash string for a task_artifact image for fast placeholder loa
|
|
|
11270
11188
|
<dd>
|
|
11271
11189
|
|
|
11272
11190
|
```typescript
|
|
11273
|
-
await client.
|
|
11191
|
+
await client.taskGroups.expanded.forForwarderOperatorsV1("task_group_id", {});
|
|
11274
11192
|
```
|
|
11275
11193
|
|
|
11276
11194
|
</dd>
|
|
@@ -11286,7 +11204,7 @@ await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_m
|
|
|
11286
11204
|
<dl>
|
|
11287
11205
|
<dd>
|
|
11288
11206
|
|
|
11289
|
-
**
|
|
11207
|
+
**taskGroupId:** `string`
|
|
11290
11208
|
|
|
11291
11209
|
</dd>
|
|
11292
11210
|
</dl>
|
|
@@ -11294,7 +11212,15 @@ await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_m
|
|
|
11294
11212
|
<dl>
|
|
11295
11213
|
<dd>
|
|
11296
11214
|
|
|
11297
|
-
**
|
|
11215
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
11216
|
+
|
|
11217
|
+
</dd>
|
|
11218
|
+
</dl>
|
|
11219
|
+
|
|
11220
|
+
<dl>
|
|
11221
|
+
<dd>
|
|
11222
|
+
|
|
11223
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
11298
11224
|
|
|
11299
11225
|
</dd>
|
|
11300
11226
|
</dl>
|