@chrt-inc/typescript-sdk 1.314.0 → 1.315.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/index.d.ts +1 -2
- package/dist/cjs/api/resources/index.js +2 -3
- package/dist/cjs/api/resources/orders/client/Client.d.ts +0 -27
- package/dist/cjs/api/resources/orders/client/Client.js +0 -124
- package/dist/cjs/api/resources/orders/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/orders/client/index.js +0 -15
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.js +14 -14
- package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +0 -39
- package/dist/cjs/api/resources/taskGroups/client/Client.js +0 -186
- package/dist/cjs/api/resources/taskGroups/index.d.ts +1 -1
- package/dist/cjs/api/resources/taskGroups/index.js +1 -1
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.d.ts +58 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.js +260 -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 +15 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.ts +42 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.ts +42 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/index.d.ts +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 +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/types/ExpandedListForCourierDriverV1RequestSortOrder.d.ts +8 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/types/ExpandedListForCourierDriverV1RequestSortOrder.js +10 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/types/ExpandedListForCourierOperatorsV1RequestSortOrder.d.ts +8 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/types/ExpandedListForCourierOperatorsV1RequestSortOrder.js +10 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/types/index.js +18 -0
- package/dist/cjs/api/resources/taskGroups/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/index.js +5 -0
- package/dist/cjs/api/types/TaskGroupSortByEnum.d.ts +11 -0
- package/dist/cjs/api/types/TaskGroupSortByEnum.js +13 -0
- package/dist/cjs/api/types/index.d.ts +1 -2
- package/dist/cjs/api/types/index.js +1 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/index.d.mts +1 -2
- package/dist/esm/api/resources/index.mjs +1 -2
- package/dist/esm/api/resources/orders/client/Client.d.mts +0 -27
- package/dist/esm/api/resources/orders/client/Client.mjs +0 -124
- package/dist/esm/api/resources/orders/client/index.d.mts +0 -1
- package/dist/esm/api/resources/orders/client/index.mjs +1 -1
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.mjs +14 -14
- package/dist/esm/api/resources/taskGroups/client/Client.d.mts +0 -39
- package/dist/esm/api/resources/taskGroups/client/Client.mjs +0 -186
- package/dist/esm/api/resources/taskGroups/index.d.mts +1 -1
- package/dist/esm/api/resources/taskGroups/index.mjs +1 -1
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.d.mts +58 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.mjs +260 -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 -1
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.mts +42 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.mts +42 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/index.d.mts +2 -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/expanded/types/ExpandedListForCourierDriverV1RequestSortOrder.d.mts +8 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/types/ExpandedListForCourierDriverV1RequestSortOrder.mjs +7 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/types/ExpandedListForCourierOperatorsV1RequestSortOrder.d.mts +8 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/types/ExpandedListForCourierOperatorsV1RequestSortOrder.mjs +7 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/types/index.d.mts +2 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/types/index.mjs +2 -0
- package/dist/esm/api/resources/taskGroups/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/taskGroups/resources/index.mjs +2 -0
- package/dist/esm/api/types/TaskGroupSortByEnum.d.mts +11 -0
- package/dist/esm/api/types/TaskGroupSortByEnum.mjs +10 -0
- package/dist/esm/api/types/index.d.mts +1 -2
- package/dist/esm/api/types/index.mjs +1 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +164 -321
- package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedListForForwarderReq.d.ts +0 -28
- package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedListForShipperReq.d.ts +0 -28
- package/dist/cjs/api/resources/orders/client/requests/index.d.ts +0 -2
- package/dist/cjs/api/types/OrdersExpandedListRes.d.ts +0 -8
- package/dist/cjs/api/types/OrdersExpandedListRes.js +0 -5
- package/dist/cjs/api/types/TaskGroupExpandedListReq.d.ts +0 -26
- package/dist/cjs/api/types/TaskGroupExpandedListReq.js +0 -5
- package/dist/esm/api/resources/orders/client/requests/OrdersExpandedListForForwarderReq.d.mts +0 -28
- package/dist/esm/api/resources/orders/client/requests/OrdersExpandedListForShipperReq.d.mts +0 -28
- package/dist/esm/api/resources/orders/client/requests/index.d.mts +0 -2
- package/dist/esm/api/types/OrdersExpandedListRes.d.mts +0 -8
- package/dist/esm/api/types/OrdersExpandedListRes.mjs +0 -4
- package/dist/esm/api/types/TaskGroupExpandedListReq.d.mts +0 -26
- package/dist/esm/api/types/TaskGroupExpandedListReq.mjs +0 -4
- /package/dist/cjs/api/resources/{orders/client/requests/OrdersExpandedListForForwarderReq.js → taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.js} +0 -0
- /package/dist/cjs/api/resources/{orders/client/requests/OrdersExpandedListForShipperReq.js → taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.js} +0 -0
- /package/dist/cjs/api/resources/{orders → taskGroups/resources/expanded}/client/requests/index.js +0 -0
- /package/dist/esm/api/resources/{orders/client/requests/OrdersExpandedListForForwarderReq.mjs → taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/{orders/client/requests/OrdersExpandedListForShipperReq.mjs → taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/{orders → taskGroups/resources/expanded}/client/requests/index.mjs +0 -0
package/reference.md
CHANGED
|
@@ -5497,132 +5497,6 @@ 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">postExpandedListForShipperOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
|
|
5501
|
-
<dl>
|
|
5502
|
-
<dd>
|
|
5503
|
-
|
|
5504
|
-
#### 📝 Description
|
|
5505
|
-
|
|
5506
|
-
<dl>
|
|
5507
|
-
<dd>
|
|
5508
|
-
|
|
5509
|
-
<dl>
|
|
5510
|
-
<dd>
|
|
5511
|
-
|
|
5512
|
-
Retrieves a list of expanded orders with optional filters and related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrdersExpandedListForShipperReq) -> (OrdersExpandedListRes)
|
|
5513
|
-
|
|
5514
|
-
</dd>
|
|
5515
|
-
</dl>
|
|
5516
|
-
</dd>
|
|
5517
|
-
</dl>
|
|
5518
|
-
|
|
5519
|
-
#### 🔌 Usage
|
|
5520
|
-
|
|
5521
|
-
<dl>
|
|
5522
|
-
<dd>
|
|
5523
|
-
|
|
5524
|
-
<dl>
|
|
5525
|
-
<dd>
|
|
5526
|
-
|
|
5527
|
-
```typescript
|
|
5528
|
-
await client.orders.postExpandedListForShipperOperatorsV1();
|
|
5529
|
-
```
|
|
5530
|
-
|
|
5531
|
-
</dd>
|
|
5532
|
-
</dl>
|
|
5533
|
-
</dd>
|
|
5534
|
-
</dl>
|
|
5535
|
-
|
|
5536
|
-
#### ⚙️ Parameters
|
|
5537
|
-
|
|
5538
|
-
<dl>
|
|
5539
|
-
<dd>
|
|
5540
|
-
|
|
5541
|
-
<dl>
|
|
5542
|
-
<dd>
|
|
5543
|
-
|
|
5544
|
-
**request:** `Chrt.OrdersExpandedListForShipperReq`
|
|
5545
|
-
|
|
5546
|
-
</dd>
|
|
5547
|
-
</dl>
|
|
5548
|
-
|
|
5549
|
-
<dl>
|
|
5550
|
-
<dd>
|
|
5551
|
-
|
|
5552
|
-
**requestOptions:** `Orders.RequestOptions`
|
|
5553
|
-
|
|
5554
|
-
</dd>
|
|
5555
|
-
</dl>
|
|
5556
|
-
</dd>
|
|
5557
|
-
</dl>
|
|
5558
|
-
|
|
5559
|
-
</dd>
|
|
5560
|
-
</dl>
|
|
5561
|
-
</details>
|
|
5562
|
-
|
|
5563
|
-
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">postExpandedListForForwarderOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
|
|
5564
|
-
<dl>
|
|
5565
|
-
<dd>
|
|
5566
|
-
|
|
5567
|
-
#### 📝 Description
|
|
5568
|
-
|
|
5569
|
-
<dl>
|
|
5570
|
-
<dd>
|
|
5571
|
-
|
|
5572
|
-
<dl>
|
|
5573
|
-
<dd>
|
|
5574
|
-
|
|
5575
|
-
Retrieves a list of expanded orders with optional filters and related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrdersExpandedListForForwarderReq) -> (OrdersExpandedListRes)
|
|
5576
|
-
|
|
5577
|
-
</dd>
|
|
5578
|
-
</dl>
|
|
5579
|
-
</dd>
|
|
5580
|
-
</dl>
|
|
5581
|
-
|
|
5582
|
-
#### 🔌 Usage
|
|
5583
|
-
|
|
5584
|
-
<dl>
|
|
5585
|
-
<dd>
|
|
5586
|
-
|
|
5587
|
-
<dl>
|
|
5588
|
-
<dd>
|
|
5589
|
-
|
|
5590
|
-
```typescript
|
|
5591
|
-
await client.orders.postExpandedListForForwarderOperatorsV1();
|
|
5592
|
-
```
|
|
5593
|
-
|
|
5594
|
-
</dd>
|
|
5595
|
-
</dl>
|
|
5596
|
-
</dd>
|
|
5597
|
-
</dl>
|
|
5598
|
-
|
|
5599
|
-
#### ⚙️ Parameters
|
|
5600
|
-
|
|
5601
|
-
<dl>
|
|
5602
|
-
<dd>
|
|
5603
|
-
|
|
5604
|
-
<dl>
|
|
5605
|
-
<dd>
|
|
5606
|
-
|
|
5607
|
-
**request:** `Chrt.OrdersExpandedListForForwarderReq`
|
|
5608
|
-
|
|
5609
|
-
</dd>
|
|
5610
|
-
</dl>
|
|
5611
|
-
|
|
5612
|
-
<dl>
|
|
5613
|
-
<dd>
|
|
5614
|
-
|
|
5615
|
-
**requestOptions:** `Orders.RequestOptions`
|
|
5616
|
-
|
|
5617
|
-
</dd>
|
|
5618
|
-
</dl>
|
|
5619
|
-
</dd>
|
|
5620
|
-
</dl>
|
|
5621
|
-
|
|
5622
|
-
</dd>
|
|
5623
|
-
</dl>
|
|
5624
|
-
</details>
|
|
5625
|
-
|
|
5626
5500
|
<details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
5627
5501
|
<dl>
|
|
5628
5502
|
<dd>
|
|
@@ -6078,195 +5952,6 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
6078
5952
|
|
|
6079
5953
|
## TaskGroups
|
|
6080
5954
|
|
|
6081
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForCourierOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
6082
|
-
<dl>
|
|
6083
|
-
<dd>
|
|
6084
|
-
|
|
6085
|
-
#### 📝 Description
|
|
6086
|
-
|
|
6087
|
-
<dl>
|
|
6088
|
-
<dd>
|
|
6089
|
-
|
|
6090
|
-
<dl>
|
|
6091
|
-
<dd>
|
|
6092
|
-
|
|
6093
|
-
Retrieves a list of expanded task groups with optional filters and related data for courier operators. | authz_personas=[courier_org_operators] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
|
|
6094
|
-
|
|
6095
|
-
</dd>
|
|
6096
|
-
</dl>
|
|
6097
|
-
</dd>
|
|
6098
|
-
</dl>
|
|
6099
|
-
|
|
6100
|
-
#### 🔌 Usage
|
|
6101
|
-
|
|
6102
|
-
<dl>
|
|
6103
|
-
<dd>
|
|
6104
|
-
|
|
6105
|
-
<dl>
|
|
6106
|
-
<dd>
|
|
6107
|
-
|
|
6108
|
-
```typescript
|
|
6109
|
-
await client.taskGroups.postExpandedListForCourierOperatorsV1({});
|
|
6110
|
-
```
|
|
6111
|
-
|
|
6112
|
-
</dd>
|
|
6113
|
-
</dl>
|
|
6114
|
-
</dd>
|
|
6115
|
-
</dl>
|
|
6116
|
-
|
|
6117
|
-
#### ⚙️ Parameters
|
|
6118
|
-
|
|
6119
|
-
<dl>
|
|
6120
|
-
<dd>
|
|
6121
|
-
|
|
6122
|
-
<dl>
|
|
6123
|
-
<dd>
|
|
6124
|
-
|
|
6125
|
-
**request:** `Chrt.TaskGroupExpandedListReq`
|
|
6126
|
-
|
|
6127
|
-
</dd>
|
|
6128
|
-
</dl>
|
|
6129
|
-
|
|
6130
|
-
<dl>
|
|
6131
|
-
<dd>
|
|
6132
|
-
|
|
6133
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6134
|
-
|
|
6135
|
-
</dd>
|
|
6136
|
-
</dl>
|
|
6137
|
-
</dd>
|
|
6138
|
-
</dl>
|
|
6139
|
-
|
|
6140
|
-
</dd>
|
|
6141
|
-
</dl>
|
|
6142
|
-
</details>
|
|
6143
|
-
|
|
6144
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForCourierDriverV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
6145
|
-
<dl>
|
|
6146
|
-
<dd>
|
|
6147
|
-
|
|
6148
|
-
#### 📝 Description
|
|
6149
|
-
|
|
6150
|
-
<dl>
|
|
6151
|
-
<dd>
|
|
6152
|
-
|
|
6153
|
-
<dl>
|
|
6154
|
-
<dd>
|
|
6155
|
-
|
|
6156
|
-
Retrieves a list of expanded task groups with optional filters and related data for courier drivers. | authz_personas=[courier_driver] | (TaskGroupExpandedListReq) -> (TaskGroupExpandedListRes)
|
|
6157
|
-
|
|
6158
|
-
</dd>
|
|
6159
|
-
</dl>
|
|
6160
|
-
</dd>
|
|
6161
|
-
</dl>
|
|
6162
|
-
|
|
6163
|
-
#### 🔌 Usage
|
|
6164
|
-
|
|
6165
|
-
<dl>
|
|
6166
|
-
<dd>
|
|
6167
|
-
|
|
6168
|
-
<dl>
|
|
6169
|
-
<dd>
|
|
6170
|
-
|
|
6171
|
-
```typescript
|
|
6172
|
-
await client.taskGroups.postExpandedListForCourierDriverV1({});
|
|
6173
|
-
```
|
|
6174
|
-
|
|
6175
|
-
</dd>
|
|
6176
|
-
</dl>
|
|
6177
|
-
</dd>
|
|
6178
|
-
</dl>
|
|
6179
|
-
|
|
6180
|
-
#### ⚙️ Parameters
|
|
6181
|
-
|
|
6182
|
-
<dl>
|
|
6183
|
-
<dd>
|
|
6184
|
-
|
|
6185
|
-
<dl>
|
|
6186
|
-
<dd>
|
|
6187
|
-
|
|
6188
|
-
**request:** `Chrt.TaskGroupExpandedListReq`
|
|
6189
|
-
|
|
6190
|
-
</dd>
|
|
6191
|
-
</dl>
|
|
6192
|
-
|
|
6193
|
-
<dl>
|
|
6194
|
-
<dd>
|
|
6195
|
-
|
|
6196
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6197
|
-
|
|
6198
|
-
</dd>
|
|
6199
|
-
</dl>
|
|
6200
|
-
</dd>
|
|
6201
|
-
</dl>
|
|
6202
|
-
|
|
6203
|
-
</dd>
|
|
6204
|
-
</dl>
|
|
6205
|
-
</details>
|
|
6206
|
-
|
|
6207
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedListForForwarderOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
6208
|
-
<dl>
|
|
6209
|
-
<dd>
|
|
6210
|
-
|
|
6211
|
-
#### 📝 Description
|
|
6212
|
-
|
|
6213
|
-
<dl>
|
|
6214
|
-
<dd>
|
|
6215
|
-
|
|
6216
|
-
<dl>
|
|
6217
|
-
<dd>
|
|
6218
|
-
|
|
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
|
-
|
|
6221
|
-
</dd>
|
|
6222
|
-
</dl>
|
|
6223
|
-
</dd>
|
|
6224
|
-
</dl>
|
|
6225
|
-
|
|
6226
|
-
#### 🔌 Usage
|
|
6227
|
-
|
|
6228
|
-
<dl>
|
|
6229
|
-
<dd>
|
|
6230
|
-
|
|
6231
|
-
<dl>
|
|
6232
|
-
<dd>
|
|
6233
|
-
|
|
6234
|
-
```typescript
|
|
6235
|
-
await client.taskGroups.postExpandedListForForwarderOperatorsV1({});
|
|
6236
|
-
```
|
|
6237
|
-
|
|
6238
|
-
</dd>
|
|
6239
|
-
</dl>
|
|
6240
|
-
</dd>
|
|
6241
|
-
</dl>
|
|
6242
|
-
|
|
6243
|
-
#### ⚙️ Parameters
|
|
6244
|
-
|
|
6245
|
-
<dl>
|
|
6246
|
-
<dd>
|
|
6247
|
-
|
|
6248
|
-
<dl>
|
|
6249
|
-
<dd>
|
|
6250
|
-
|
|
6251
|
-
**request:** `Chrt.TaskGroupExpandedListReq`
|
|
6252
|
-
|
|
6253
|
-
</dd>
|
|
6254
|
-
</dl>
|
|
6255
|
-
|
|
6256
|
-
<dl>
|
|
6257
|
-
<dd>
|
|
6258
|
-
|
|
6259
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6260
|
-
|
|
6261
|
-
</dd>
|
|
6262
|
-
</dl>
|
|
6263
|
-
</dd>
|
|
6264
|
-
</dl>
|
|
6265
|
-
|
|
6266
|
-
</dd>
|
|
6267
|
-
</dl>
|
|
6268
|
-
</details>
|
|
6269
|
-
|
|
6270
5955
|
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6271
5956
|
<dl>
|
|
6272
5957
|
<dd>
|
|
@@ -9527,7 +9212,7 @@ await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
|
9527
9212
|
|
|
9528
9213
|
## Orders Expanded
|
|
9529
9214
|
|
|
9530
|
-
<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(
|
|
9215
|
+
<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpanded</code></summary>
|
|
9531
9216
|
<dl>
|
|
9532
9217
|
<dd>
|
|
9533
9218
|
|
|
@@ -9555,7 +9240,7 @@ Retrieves an expanded order with optional related data for shipper operators. |
|
|
|
9555
9240
|
<dd>
|
|
9556
9241
|
|
|
9557
9242
|
```typescript
|
|
9558
|
-
await client.orders.expanded.forShipperOperatorsV1("
|
|
9243
|
+
await client.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {});
|
|
9559
9244
|
```
|
|
9560
9245
|
|
|
9561
9246
|
</dd>
|
|
@@ -9571,7 +9256,7 @@ await client.orders.expanded.forShipperOperatorsV1("order_id", {});
|
|
|
9571
9256
|
<dl>
|
|
9572
9257
|
<dd>
|
|
9573
9258
|
|
|
9574
|
-
**
|
|
9259
|
+
**orderIdOrShortId:** `string`
|
|
9575
9260
|
|
|
9576
9261
|
</dd>
|
|
9577
9262
|
</dl>
|
|
@@ -9598,7 +9283,7 @@ await client.orders.expanded.forShipperOperatorsV1("order_id", {});
|
|
|
9598
9283
|
</dl>
|
|
9599
9284
|
</details>
|
|
9600
9285
|
|
|
9601
|
-
<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(
|
|
9286
|
+
<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpanded</code></summary>
|
|
9602
9287
|
<dl>
|
|
9603
9288
|
<dd>
|
|
9604
9289
|
|
|
@@ -9626,7 +9311,7 @@ Retrieves an expanded order with optional related data for forwarder operators.
|
|
|
9626
9311
|
<dd>
|
|
9627
9312
|
|
|
9628
9313
|
```typescript
|
|
9629
|
-
await client.orders.expanded.forForwarderOperatorsV1("
|
|
9314
|
+
await client.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {});
|
|
9630
9315
|
```
|
|
9631
9316
|
|
|
9632
9317
|
</dd>
|
|
@@ -9642,7 +9327,7 @@ await client.orders.expanded.forForwarderOperatorsV1("order_id", {});
|
|
|
9642
9327
|
<dl>
|
|
9643
9328
|
<dd>
|
|
9644
9329
|
|
|
9645
|
-
**
|
|
9330
|
+
**orderIdOrShortId:** `string`
|
|
9646
9331
|
|
|
9647
9332
|
</dd>
|
|
9648
9333
|
</dl>
|
|
@@ -11231,6 +10916,164 @@ await client.taskGroups.expanded.forForwarderOperatorsV1("task_group_id", {});
|
|
|
11231
10916
|
</dl>
|
|
11232
10917
|
</details>
|
|
11233
10918
|
|
|
10919
|
+
<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">listForCourierOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
10920
|
+
<dl>
|
|
10921
|
+
<dd>
|
|
10922
|
+
|
|
10923
|
+
#### 📝 Description
|
|
10924
|
+
|
|
10925
|
+
<dl>
|
|
10926
|
+
<dd>
|
|
10927
|
+
|
|
10928
|
+
<dl>
|
|
10929
|
+
<dd>
|
|
10930
|
+
|
|
10931
|
+
Lists expanded task groups for courier operators with filtering, sorting, and pagination. | authz_personas=[courier_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpandedListRes)
|
|
10932
|
+
|
|
10933
|
+
</dd>
|
|
10934
|
+
</dl>
|
|
10935
|
+
</dd>
|
|
10936
|
+
</dl>
|
|
10937
|
+
|
|
10938
|
+
#### 🔌 Usage
|
|
10939
|
+
|
|
10940
|
+
<dl>
|
|
10941
|
+
<dd>
|
|
10942
|
+
|
|
10943
|
+
<dl>
|
|
10944
|
+
<dd>
|
|
10945
|
+
|
|
10946
|
+
```typescript
|
|
10947
|
+
await client.taskGroups.expanded.listForCourierOperatorsV1({
|
|
10948
|
+
sort_by: "draft_started_at_timestamp",
|
|
10949
|
+
sort_order: "ascending",
|
|
10950
|
+
page: 1,
|
|
10951
|
+
page_size: 1,
|
|
10952
|
+
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
10953
|
+
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
10954
|
+
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
10955
|
+
filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
10956
|
+
filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
10957
|
+
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
10958
|
+
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
10959
|
+
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
10960
|
+
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
10961
|
+
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
10962
|
+
body: {},
|
|
10963
|
+
});
|
|
10964
|
+
```
|
|
10965
|
+
|
|
10966
|
+
</dd>
|
|
10967
|
+
</dl>
|
|
10968
|
+
</dd>
|
|
10969
|
+
</dl>
|
|
10970
|
+
|
|
10971
|
+
#### ⚙️ Parameters
|
|
10972
|
+
|
|
10973
|
+
<dl>
|
|
10974
|
+
<dd>
|
|
10975
|
+
|
|
10976
|
+
<dl>
|
|
10977
|
+
<dd>
|
|
10978
|
+
|
|
10979
|
+
**request:** `Chrt.taskGroups.ExpandedListForCourierOperatorsV1Request`
|
|
10980
|
+
|
|
10981
|
+
</dd>
|
|
10982
|
+
</dl>
|
|
10983
|
+
|
|
10984
|
+
<dl>
|
|
10985
|
+
<dd>
|
|
10986
|
+
|
|
10987
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
10988
|
+
|
|
10989
|
+
</dd>
|
|
10990
|
+
</dl>
|
|
10991
|
+
</dd>
|
|
10992
|
+
</dl>
|
|
10993
|
+
|
|
10994
|
+
</dd>
|
|
10995
|
+
</dl>
|
|
10996
|
+
</details>
|
|
10997
|
+
|
|
10998
|
+
<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">listForCourierDriverV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
10999
|
+
<dl>
|
|
11000
|
+
<dd>
|
|
11001
|
+
|
|
11002
|
+
#### 📝 Description
|
|
11003
|
+
|
|
11004
|
+
<dl>
|
|
11005
|
+
<dd>
|
|
11006
|
+
|
|
11007
|
+
<dl>
|
|
11008
|
+
<dd>
|
|
11009
|
+
|
|
11010
|
+
Lists expanded task groups for courier driver with filtering, sorting, and pagination. | authz_personas=[courier_driver] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpandedListRes)
|
|
11011
|
+
|
|
11012
|
+
</dd>
|
|
11013
|
+
</dl>
|
|
11014
|
+
</dd>
|
|
11015
|
+
</dl>
|
|
11016
|
+
|
|
11017
|
+
#### 🔌 Usage
|
|
11018
|
+
|
|
11019
|
+
<dl>
|
|
11020
|
+
<dd>
|
|
11021
|
+
|
|
11022
|
+
<dl>
|
|
11023
|
+
<dd>
|
|
11024
|
+
|
|
11025
|
+
```typescript
|
|
11026
|
+
await client.taskGroups.expanded.listForCourierDriverV1({
|
|
11027
|
+
sort_by: "draft_started_at_timestamp",
|
|
11028
|
+
sort_order: "ascending",
|
|
11029
|
+
page: 1,
|
|
11030
|
+
page_size: 1,
|
|
11031
|
+
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11032
|
+
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11033
|
+
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11034
|
+
filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11035
|
+
filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11036
|
+
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11037
|
+
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11038
|
+
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11039
|
+
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
11040
|
+
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
11041
|
+
body: {},
|
|
11042
|
+
});
|
|
11043
|
+
```
|
|
11044
|
+
|
|
11045
|
+
</dd>
|
|
11046
|
+
</dl>
|
|
11047
|
+
</dd>
|
|
11048
|
+
</dl>
|
|
11049
|
+
|
|
11050
|
+
#### ⚙️ Parameters
|
|
11051
|
+
|
|
11052
|
+
<dl>
|
|
11053
|
+
<dd>
|
|
11054
|
+
|
|
11055
|
+
<dl>
|
|
11056
|
+
<dd>
|
|
11057
|
+
|
|
11058
|
+
**request:** `Chrt.taskGroups.ExpandedListForCourierDriverV1Request`
|
|
11059
|
+
|
|
11060
|
+
</dd>
|
|
11061
|
+
</dl>
|
|
11062
|
+
|
|
11063
|
+
<dl>
|
|
11064
|
+
<dd>
|
|
11065
|
+
|
|
11066
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
11067
|
+
|
|
11068
|
+
</dd>
|
|
11069
|
+
</dl>
|
|
11070
|
+
</dd>
|
|
11071
|
+
</dl>
|
|
11072
|
+
|
|
11073
|
+
</dd>
|
|
11074
|
+
</dl>
|
|
11075
|
+
</details>
|
|
11076
|
+
|
|
11234
11077
|
## Tracking CargoByDevice
|
|
11235
11078
|
|
|
11236
11079
|
<details><summary><code>client.tracking.cargoByDevice.<a href="/src/api/resources/tracking/resources/cargoByDevice/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.TrackingCargoByDeviceDataPoint1 | null) | undefined</code></summary>
|
package/dist/cjs/api/resources/orders/client/requests/OrdersExpandedListForForwarderReq.d.ts
DELETED
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Chrt from "../../../../index.js";
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {}
|
|
8
|
-
*/
|
|
9
|
-
export interface OrdersExpandedListForForwarderReq {
|
|
10
|
-
expand_forwarder_org_company_name?: boolean;
|
|
11
|
-
expand_forwarder_org_handle?: boolean;
|
|
12
|
-
expand_shipper_org_company_name?: boolean;
|
|
13
|
-
expand_off_chrt_shipper_org_company_name?: boolean;
|
|
14
|
-
expand_tasks?: boolean;
|
|
15
|
-
expand_cargos?: boolean;
|
|
16
|
-
expand_task_artifacts?: boolean;
|
|
17
|
-
expand_shipper_contacts?: boolean;
|
|
18
|
-
expand_driver?: boolean;
|
|
19
|
-
expand_courier_org_company_name?: boolean;
|
|
20
|
-
expand_courier_org_handle?: boolean;
|
|
21
|
-
creator_org_ids_include?: string[] | null;
|
|
22
|
-
creator_org_ids_exclude?: string[] | null;
|
|
23
|
-
shipper_org_ids_include?: string[] | null;
|
|
24
|
-
shipper_org_ids_exclude?: string[] | null;
|
|
25
|
-
status?: Chrt.OrderStatusEnum1 | null;
|
|
26
|
-
skip?: number;
|
|
27
|
-
limit?: number;
|
|
28
|
-
}
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Chrt from "../../../../index.js";
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {}
|
|
8
|
-
*/
|
|
9
|
-
export interface OrdersExpandedListForShipperReq {
|
|
10
|
-
expand_forwarder_org_company_name?: boolean;
|
|
11
|
-
expand_forwarder_org_handle?: boolean;
|
|
12
|
-
expand_shipper_org_company_name?: boolean;
|
|
13
|
-
expand_off_chrt_shipper_org_company_name?: boolean;
|
|
14
|
-
expand_tasks?: boolean;
|
|
15
|
-
expand_cargos?: boolean;
|
|
16
|
-
expand_task_artifacts?: boolean;
|
|
17
|
-
expand_shipper_contacts?: boolean;
|
|
18
|
-
expand_driver?: boolean;
|
|
19
|
-
expand_courier_org_company_name?: boolean;
|
|
20
|
-
expand_courier_org_handle?: boolean;
|
|
21
|
-
creator_org_ids_include?: string[] | null;
|
|
22
|
-
creator_org_ids_exclude?: string[] | null;
|
|
23
|
-
forwarder_org_ids_include?: string[] | null;
|
|
24
|
-
forwarder_org_ids_exclude?: string[] | null;
|
|
25
|
-
status?: Chrt.OrderStatusEnum1 | null;
|
|
26
|
-
skip?: number;
|
|
27
|
-
limit?: number;
|
|
28
|
-
}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Chrt from "../index.js";
|
|
5
|
-
/**
|
|
6
|
-
* Request model for listing expanded task groups with filters and expansion options.
|
|
7
|
-
*/
|
|
8
|
-
export interface TaskGroupExpandedListReq {
|
|
9
|
-
expand_forwarder_org_company_name?: boolean;
|
|
10
|
-
expand_forwarder_org_handle?: boolean;
|
|
11
|
-
expand_shipper_org_company_name?: boolean;
|
|
12
|
-
expand_off_chrt_shipper_org_company_name?: boolean;
|
|
13
|
-
expand_tasks?: boolean;
|
|
14
|
-
expand_cargos?: boolean;
|
|
15
|
-
expand_task_artifacts?: boolean;
|
|
16
|
-
expand_shipper_contacts?: boolean;
|
|
17
|
-
expand_driver?: boolean;
|
|
18
|
-
expand_courier_org_company_name?: boolean;
|
|
19
|
-
expand_courier_org_handle?: boolean;
|
|
20
|
-
order_id?: string | null;
|
|
21
|
-
courier_org_id?: string | null;
|
|
22
|
-
driver_id?: string | null;
|
|
23
|
-
status?: Chrt.TaskGroupStatusEnum1 | null;
|
|
24
|
-
skip?: number;
|
|
25
|
-
limit?: number;
|
|
26
|
-
}
|
package/dist/esm/api/resources/orders/client/requests/OrdersExpandedListForForwarderReq.d.mts
DELETED
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Chrt from "../../../../index.mjs";
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {}
|
|
8
|
-
*/
|
|
9
|
-
export interface OrdersExpandedListForForwarderReq {
|
|
10
|
-
expand_forwarder_org_company_name?: boolean;
|
|
11
|
-
expand_forwarder_org_handle?: boolean;
|
|
12
|
-
expand_shipper_org_company_name?: boolean;
|
|
13
|
-
expand_off_chrt_shipper_org_company_name?: boolean;
|
|
14
|
-
expand_tasks?: boolean;
|
|
15
|
-
expand_cargos?: boolean;
|
|
16
|
-
expand_task_artifacts?: boolean;
|
|
17
|
-
expand_shipper_contacts?: boolean;
|
|
18
|
-
expand_driver?: boolean;
|
|
19
|
-
expand_courier_org_company_name?: boolean;
|
|
20
|
-
expand_courier_org_handle?: boolean;
|
|
21
|
-
creator_org_ids_include?: string[] | null;
|
|
22
|
-
creator_org_ids_exclude?: string[] | null;
|
|
23
|
-
shipper_org_ids_include?: string[] | null;
|
|
24
|
-
shipper_org_ids_exclude?: string[] | null;
|
|
25
|
-
status?: Chrt.OrderStatusEnum1 | null;
|
|
26
|
-
skip?: number;
|
|
27
|
-
limit?: number;
|
|
28
|
-
}
|