@chrt-inc/typescript-sdk 1.734.0 → 1.746.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/operations/resources/operationsTasks/client/Client.d.ts +2 -29
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.js +10 -124
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.ts +2 -3
- package/dist/cjs/api/resources/shipping/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/client/Client.js +9 -4
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/index.js +3 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.js +68 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrderDraftsTypeaheadV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.ts +0 -16
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.js +0 -68
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.d.ts +170 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.js +662 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.ts +23 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.ts +24 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.d.ts +14 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.d.ts +42 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.js +68 -0
- package/dist/cjs/api/resources/shipping/resources/{orderDrafts/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.ts → orders/client/requests/OrdersTypeaheadV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/OrdersTypeaheadV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +0 -16
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +0 -68
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.js +68 -0
- package/dist/cjs/api/resources/shipping/resources/{orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.ts → taskGroups/client/requests/TaskGroupsTypeaheadV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/requests/TaskGroupsTypeaheadV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +0 -16
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +0 -68
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/types/OperationsTaskTypeEnum.d.ts +4 -2
- package/dist/cjs/api/types/OperationsTaskTypeEnum.js +3 -1
- package/dist/cjs/api/types/Order1.d.ts +1 -0
- package/dist/cjs/api/types/OrderTemplate1.d.ts +24 -0
- package/dist/cjs/api/types/OrderTemplate1.js +5 -0
- package/dist/cjs/api/types/OrderTemplateExpanded.d.ts +12 -0
- package/dist/cjs/api/types/OrderTemplateExpanded.js +5 -0
- package/dist/cjs/api/types/OrderTemplateListRes.d.ts +8 -0
- package/dist/cjs/api/types/OrderTemplateListRes.js +5 -0
- package/dist/cjs/api/types/OrderTemplateOrgRef1.d.ts +10 -0
- package/dist/cjs/api/types/OrderTemplateOrgRef1.js +5 -0
- package/dist/cjs/api/types/OrderTemplateReferenceColumnEnum1.d.ts +11 -0
- package/dist/cjs/api/types/OrderTemplateReferenceColumnEnum1.js +13 -0
- package/dist/cjs/api/types/OrderTemplateSortByEnum.d.ts +9 -0
- package/dist/cjs/api/types/OrderTemplateSortByEnum.js +11 -0
- package/dist/cjs/api/types/OrderTypeaheadResult.d.ts +1 -1
- package/dist/cjs/api/types/OrderTypeaheadValue.d.ts +7 -0
- package/dist/cjs/api/types/OrderTypeaheadValue.js +5 -0
- package/dist/cjs/api/types/index.d.ts +7 -0
- package/dist/cjs/api/types/index.js +7 -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/operations/resources/operationsTasks/client/Client.d.mts +2 -29
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.mjs +10 -124
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.mts +2 -3
- package/dist/esm/api/resources/shipping/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/shipping/client/Client.mjs +5 -0
- package/dist/esm/api/resources/shipping/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.mjs +68 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrderDraftsTypeaheadV1Request.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.mts +0 -16
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.mjs +0 -68
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.d.mts +170 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.mjs +625 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.mts +23 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.mts +24 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.d.mts +14 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.d.mts +42 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs +68 -0
- package/dist/{cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.ts → esm/api/resources/shipping/resources/orders/client/requests/OrdersTypeaheadV1Request.d.mts} +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersTypeaheadV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +0 -16
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +0 -68
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.mjs +68 -0
- package/dist/esm/api/resources/shipping/resources/{orderDrafts/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.mts → taskGroups/client/requests/TaskGroupsTypeaheadV1Request.d.mts} +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/requests/TaskGroupsTypeaheadV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +0 -16
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +0 -68
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/index.d.mts +0 -1
- package/dist/esm/api/types/OperationsTaskTypeEnum.d.mts +4 -2
- package/dist/esm/api/types/OperationsTaskTypeEnum.mjs +3 -1
- package/dist/esm/api/types/Order1.d.mts +1 -0
- package/dist/esm/api/types/OrderTemplate1.d.mts +24 -0
- package/dist/esm/api/types/OrderTemplate1.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateExpanded.d.mts +12 -0
- package/dist/esm/api/types/OrderTemplateExpanded.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateListRes.d.mts +8 -0
- package/dist/esm/api/types/OrderTemplateListRes.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateOrgRef1.d.mts +10 -0
- package/dist/esm/api/types/OrderTemplateOrgRef1.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateReferenceColumnEnum1.d.mts +11 -0
- package/dist/esm/api/types/OrderTemplateReferenceColumnEnum1.mjs +10 -0
- package/dist/esm/api/types/OrderTemplateSortByEnum.d.mts +9 -0
- package/dist/esm/api/types/OrderTemplateSortByEnum.mjs +8 -0
- package/dist/esm/api/types/OrderTypeaheadResult.d.mts +1 -1
- package/dist/esm/api/types/OrderTypeaheadValue.d.mts +7 -0
- package/dist/esm/api/types/OrderTypeaheadValue.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +7 -0
- package/dist/esm/api/types/index.mjs +7 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +844 -369
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.mts +0 -16
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.mts +0 -16
- /package/dist/cjs/api/resources/shipping/resources/orderDrafts/{resources/expanded/client/requests/ExpandedTypeaheadV1Request.js → client/requests/OrderDraftsTypeaheadV1Request.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/{orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.js → orderTemplates/client/requests/OrderTemplateClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/{taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.js → orderTemplates/client/requests/OrderTemplateClientUpdate1.js} +0 -0
- /package/dist/esm/api/resources/shipping/resources/orderDrafts/{resources/expanded/client/requests/ExpandedTypeaheadV1Request.mjs → client/requests/OrderDraftsTypeaheadV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/{orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.mjs → orderTemplates/client/requests/OrderTemplateClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/{taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.mjs → orderTemplates/client/requests/OrderTemplateClientUpdate1.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -13197,7 +13197,7 @@ await client.operations.operationsTaskLists.removeFromCaseV1("task_list_id", "ca
|
|
|
13197
13197
|
<dl>
|
|
13198
13198
|
<dd>
|
|
13199
13199
|
|
|
13200
|
-
Lists OperationsTasks for the caller's organization, with order/department/type/status/tag/assignee/deadline filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)
|
|
13200
|
+
Lists OperationsTasks for the caller's organization, with order ids / department / type / status / tag / assignee / deadline filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)
|
|
13201
13201
|
|
|
13202
13202
|
</dd>
|
|
13203
13203
|
</dl>
|
|
@@ -13218,7 +13218,6 @@ await client.operations.operationsTasks.listV1({
|
|
|
13218
13218
|
sort_order: "asc",
|
|
13219
13219
|
page: 1,
|
|
13220
13220
|
page_size: 1,
|
|
13221
|
-
filter_order_id: "filter_order_id",
|
|
13222
13221
|
filter_department_id: "filter_department_id",
|
|
13223
13222
|
filter_assigned_user_id: "filter_assigned_user_id",
|
|
13224
13223
|
filter_deadline_gte: "2024-01-15T09:30:00Z",
|
|
@@ -13396,7 +13395,7 @@ await client.operations.operationsTasks.deleteV1("task_id");
|
|
|
13396
13395
|
<dl>
|
|
13397
13396
|
<dd>
|
|
13398
13397
|
|
|
13399
|
-
Updates
|
|
13398
|
+
Updates editable fields (task_type, title, description, deadline_timestamp, tags, assigned_user_ids) on an OperationsTask. | authz: min_org_role=operator | (OperationsTaskClientUpdate1) -> (bool)
|
|
13400
13399
|
|
|
13401
13400
|
</dd>
|
|
13402
13401
|
</dl>
|
|
@@ -13524,132 +13523,6 @@ await client.operations.operationsTasks.createV1({
|
|
|
13524
13523
|
</dl>
|
|
13525
13524
|
</details>
|
|
13526
13525
|
|
|
13527
|
-
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">completeV1</a>(taskId) -> boolean</code></summary>
|
|
13528
|
-
<dl>
|
|
13529
|
-
<dd>
|
|
13530
|
-
|
|
13531
|
-
#### 📝 Description
|
|
13532
|
-
|
|
13533
|
-
<dl>
|
|
13534
|
-
<dd>
|
|
13535
|
-
|
|
13536
|
-
<dl>
|
|
13537
|
-
<dd>
|
|
13538
|
-
|
|
13539
|
-
Marks an OperationsTask as completed. Idempotent — calling on an already-completed task is a no-op that returns False. | authz: min_org_role=operator | () -> (bool)
|
|
13540
|
-
|
|
13541
|
-
</dd>
|
|
13542
|
-
</dl>
|
|
13543
|
-
</dd>
|
|
13544
|
-
</dl>
|
|
13545
|
-
|
|
13546
|
-
#### 🔌 Usage
|
|
13547
|
-
|
|
13548
|
-
<dl>
|
|
13549
|
-
<dd>
|
|
13550
|
-
|
|
13551
|
-
<dl>
|
|
13552
|
-
<dd>
|
|
13553
|
-
|
|
13554
|
-
```typescript
|
|
13555
|
-
await client.operations.operationsTasks.completeV1("task_id");
|
|
13556
|
-
```
|
|
13557
|
-
|
|
13558
|
-
</dd>
|
|
13559
|
-
</dl>
|
|
13560
|
-
</dd>
|
|
13561
|
-
</dl>
|
|
13562
|
-
|
|
13563
|
-
#### ⚙️ Parameters
|
|
13564
|
-
|
|
13565
|
-
<dl>
|
|
13566
|
-
<dd>
|
|
13567
|
-
|
|
13568
|
-
<dl>
|
|
13569
|
-
<dd>
|
|
13570
|
-
|
|
13571
|
-
**taskId:** `string`
|
|
13572
|
-
|
|
13573
|
-
</dd>
|
|
13574
|
-
</dl>
|
|
13575
|
-
|
|
13576
|
-
<dl>
|
|
13577
|
-
<dd>
|
|
13578
|
-
|
|
13579
|
-
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
13580
|
-
|
|
13581
|
-
</dd>
|
|
13582
|
-
</dl>
|
|
13583
|
-
</dd>
|
|
13584
|
-
</dl>
|
|
13585
|
-
|
|
13586
|
-
</dd>
|
|
13587
|
-
</dl>
|
|
13588
|
-
</details>
|
|
13589
|
-
|
|
13590
|
-
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">uncompleteV1</a>(taskId) -> boolean</code></summary>
|
|
13591
|
-
<dl>
|
|
13592
|
-
<dd>
|
|
13593
|
-
|
|
13594
|
-
#### 📝 Description
|
|
13595
|
-
|
|
13596
|
-
<dl>
|
|
13597
|
-
<dd>
|
|
13598
|
-
|
|
13599
|
-
<dl>
|
|
13600
|
-
<dd>
|
|
13601
|
-
|
|
13602
|
-
Marks a previously-completed OperationsTask as incomplete and clears its completion timestamps. Idempotent — calling on an already-incomplete task is a no-op that returns False. | authz: min_org_role=operator | () -> (bool)
|
|
13603
|
-
|
|
13604
|
-
</dd>
|
|
13605
|
-
</dl>
|
|
13606
|
-
</dd>
|
|
13607
|
-
</dl>
|
|
13608
|
-
|
|
13609
|
-
#### 🔌 Usage
|
|
13610
|
-
|
|
13611
|
-
<dl>
|
|
13612
|
-
<dd>
|
|
13613
|
-
|
|
13614
|
-
<dl>
|
|
13615
|
-
<dd>
|
|
13616
|
-
|
|
13617
|
-
```typescript
|
|
13618
|
-
await client.operations.operationsTasks.uncompleteV1("task_id");
|
|
13619
|
-
```
|
|
13620
|
-
|
|
13621
|
-
</dd>
|
|
13622
|
-
</dl>
|
|
13623
|
-
</dd>
|
|
13624
|
-
</dl>
|
|
13625
|
-
|
|
13626
|
-
#### ⚙️ Parameters
|
|
13627
|
-
|
|
13628
|
-
<dl>
|
|
13629
|
-
<dd>
|
|
13630
|
-
|
|
13631
|
-
<dl>
|
|
13632
|
-
<dd>
|
|
13633
|
-
|
|
13634
|
-
**taskId:** `string`
|
|
13635
|
-
|
|
13636
|
-
</dd>
|
|
13637
|
-
</dl>
|
|
13638
|
-
|
|
13639
|
-
<dl>
|
|
13640
|
-
<dd>
|
|
13641
|
-
|
|
13642
|
-
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
13643
|
-
|
|
13644
|
-
</dd>
|
|
13645
|
-
</dl>
|
|
13646
|
-
</dd>
|
|
13647
|
-
</dl>
|
|
13648
|
-
|
|
13649
|
-
</dd>
|
|
13650
|
-
</dl>
|
|
13651
|
-
</details>
|
|
13652
|
-
|
|
13653
13526
|
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">updateStatusV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
13654
13527
|
<dl>
|
|
13655
13528
|
<dd>
|
|
@@ -17907,6 +17780,72 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
17907
17780
|
|
|
17908
17781
|
## Shipping Orders
|
|
17909
17782
|
|
|
17783
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
17784
|
+
<dl>
|
|
17785
|
+
<dd>
|
|
17786
|
+
|
|
17787
|
+
#### 📝 Description
|
|
17788
|
+
|
|
17789
|
+
<dl>
|
|
17790
|
+
<dd>
|
|
17791
|
+
|
|
17792
|
+
<dl>
|
|
17793
|
+
<dd>
|
|
17794
|
+
|
|
17795
|
+
Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft orders visible to the caller's org. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
17796
|
+
|
|
17797
|
+
</dd>
|
|
17798
|
+
</dl>
|
|
17799
|
+
</dd>
|
|
17800
|
+
</dl>
|
|
17801
|
+
|
|
17802
|
+
#### 🔌 Usage
|
|
17803
|
+
|
|
17804
|
+
<dl>
|
|
17805
|
+
<dd>
|
|
17806
|
+
|
|
17807
|
+
<dl>
|
|
17808
|
+
<dd>
|
|
17809
|
+
|
|
17810
|
+
```typescript
|
|
17811
|
+
await client.shipping.orders.typeaheadV1({
|
|
17812
|
+
query: "query",
|
|
17813
|
+
limit: 1,
|
|
17814
|
+
});
|
|
17815
|
+
```
|
|
17816
|
+
|
|
17817
|
+
</dd>
|
|
17818
|
+
</dl>
|
|
17819
|
+
</dd>
|
|
17820
|
+
</dl>
|
|
17821
|
+
|
|
17822
|
+
#### ⚙️ Parameters
|
|
17823
|
+
|
|
17824
|
+
<dl>
|
|
17825
|
+
<dd>
|
|
17826
|
+
|
|
17827
|
+
<dl>
|
|
17828
|
+
<dd>
|
|
17829
|
+
|
|
17830
|
+
**request:** `Chrt.shipping.OrdersTypeaheadV1Request`
|
|
17831
|
+
|
|
17832
|
+
</dd>
|
|
17833
|
+
</dl>
|
|
17834
|
+
|
|
17835
|
+
<dl>
|
|
17836
|
+
<dd>
|
|
17837
|
+
|
|
17838
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17839
|
+
|
|
17840
|
+
</dd>
|
|
17841
|
+
</dl>
|
|
17842
|
+
</dd>
|
|
17843
|
+
</dl>
|
|
17844
|
+
|
|
17845
|
+
</dd>
|
|
17846
|
+
</dl>
|
|
17847
|
+
</details>
|
|
17848
|
+
|
|
17910
17849
|
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
17911
17850
|
<dl>
|
|
17912
17851
|
<dd>
|
|
@@ -18571,6 +18510,72 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
18571
18510
|
</dl>
|
|
18572
18511
|
</details>
|
|
18573
18512
|
|
|
18513
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
18514
|
+
<dl>
|
|
18515
|
+
<dd>
|
|
18516
|
+
|
|
18517
|
+
#### 📝 Description
|
|
18518
|
+
|
|
18519
|
+
<dl>
|
|
18520
|
+
<dd>
|
|
18521
|
+
|
|
18522
|
+
<dl>
|
|
18523
|
+
<dd>
|
|
18524
|
+
|
|
18525
|
+
Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
18526
|
+
|
|
18527
|
+
</dd>
|
|
18528
|
+
</dl>
|
|
18529
|
+
</dd>
|
|
18530
|
+
</dl>
|
|
18531
|
+
|
|
18532
|
+
#### 🔌 Usage
|
|
18533
|
+
|
|
18534
|
+
<dl>
|
|
18535
|
+
<dd>
|
|
18536
|
+
|
|
18537
|
+
<dl>
|
|
18538
|
+
<dd>
|
|
18539
|
+
|
|
18540
|
+
```typescript
|
|
18541
|
+
await client.shipping.orderDrafts.typeaheadV1({
|
|
18542
|
+
query: "query",
|
|
18543
|
+
limit: 1,
|
|
18544
|
+
});
|
|
18545
|
+
```
|
|
18546
|
+
|
|
18547
|
+
</dd>
|
|
18548
|
+
</dl>
|
|
18549
|
+
</dd>
|
|
18550
|
+
</dl>
|
|
18551
|
+
|
|
18552
|
+
#### ⚙️ Parameters
|
|
18553
|
+
|
|
18554
|
+
<dl>
|
|
18555
|
+
<dd>
|
|
18556
|
+
|
|
18557
|
+
<dl>
|
|
18558
|
+
<dd>
|
|
18559
|
+
|
|
18560
|
+
**request:** `Chrt.shipping.OrderDraftsTypeaheadV1Request`
|
|
18561
|
+
|
|
18562
|
+
</dd>
|
|
18563
|
+
</dl>
|
|
18564
|
+
|
|
18565
|
+
<dl>
|
|
18566
|
+
<dd>
|
|
18567
|
+
|
|
18568
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18569
|
+
|
|
18570
|
+
</dd>
|
|
18571
|
+
</dl>
|
|
18572
|
+
</dd>
|
|
18573
|
+
</dl>
|
|
18574
|
+
|
|
18575
|
+
</dd>
|
|
18576
|
+
</dl>
|
|
18577
|
+
</details>
|
|
18578
|
+
|
|
18574
18579
|
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
|
|
18575
18580
|
<dl>
|
|
18576
18581
|
<dd>
|
|
@@ -18947,15 +18952,659 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18947
18952
|
<dl>
|
|
18948
18953
|
<dd>
|
|
18949
18954
|
|
|
18950
|
-
**orderScheduleId:** `string`
|
|
18951
|
-
|
|
18952
|
-
</dd>
|
|
18953
|
-
</dl>
|
|
18954
|
-
|
|
18955
|
-
<dl>
|
|
18956
|
-
<dd>
|
|
18957
|
-
|
|
18958
|
-
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
18955
|
+
**orderScheduleId:** `string`
|
|
18956
|
+
|
|
18957
|
+
</dd>
|
|
18958
|
+
</dl>
|
|
18959
|
+
|
|
18960
|
+
<dl>
|
|
18961
|
+
<dd>
|
|
18962
|
+
|
|
18963
|
+
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
18964
|
+
|
|
18965
|
+
</dd>
|
|
18966
|
+
</dl>
|
|
18967
|
+
|
|
18968
|
+
<dl>
|
|
18969
|
+
<dd>
|
|
18970
|
+
|
|
18971
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
18972
|
+
|
|
18973
|
+
</dd>
|
|
18974
|
+
</dl>
|
|
18975
|
+
</dd>
|
|
18976
|
+
</dl>
|
|
18977
|
+
|
|
18978
|
+
</dd>
|
|
18979
|
+
</dl>
|
|
18980
|
+
</details>
|
|
18981
|
+
|
|
18982
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
18983
|
+
<dl>
|
|
18984
|
+
<dd>
|
|
18985
|
+
|
|
18986
|
+
#### 📝 Description
|
|
18987
|
+
|
|
18988
|
+
<dl>
|
|
18989
|
+
<dd>
|
|
18990
|
+
|
|
18991
|
+
<dl>
|
|
18992
|
+
<dd>
|
|
18993
|
+
|
|
18994
|
+
Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
|
|
18995
|
+
|
|
18996
|
+
</dd>
|
|
18997
|
+
</dl>
|
|
18998
|
+
</dd>
|
|
18999
|
+
</dl>
|
|
19000
|
+
|
|
19001
|
+
#### 🔌 Usage
|
|
19002
|
+
|
|
19003
|
+
<dl>
|
|
19004
|
+
<dd>
|
|
19005
|
+
|
|
19006
|
+
<dl>
|
|
19007
|
+
<dd>
|
|
19008
|
+
|
|
19009
|
+
```typescript
|
|
19010
|
+
await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
19011
|
+
```
|
|
19012
|
+
|
|
19013
|
+
</dd>
|
|
19014
|
+
</dl>
|
|
19015
|
+
</dd>
|
|
19016
|
+
</dl>
|
|
19017
|
+
|
|
19018
|
+
#### ⚙️ Parameters
|
|
19019
|
+
|
|
19020
|
+
<dl>
|
|
19021
|
+
<dd>
|
|
19022
|
+
|
|
19023
|
+
<dl>
|
|
19024
|
+
<dd>
|
|
19025
|
+
|
|
19026
|
+
**orderScheduleId:** `string`
|
|
19027
|
+
|
|
19028
|
+
</dd>
|
|
19029
|
+
</dl>
|
|
19030
|
+
|
|
19031
|
+
<dl>
|
|
19032
|
+
<dd>
|
|
19033
|
+
|
|
19034
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19035
|
+
|
|
19036
|
+
</dd>
|
|
19037
|
+
</dl>
|
|
19038
|
+
</dd>
|
|
19039
|
+
</dl>
|
|
19040
|
+
|
|
19041
|
+
</dd>
|
|
19042
|
+
</dl>
|
|
19043
|
+
</details>
|
|
19044
|
+
|
|
19045
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
19046
|
+
<dl>
|
|
19047
|
+
<dd>
|
|
19048
|
+
|
|
19049
|
+
#### 📝 Description
|
|
19050
|
+
|
|
19051
|
+
<dl>
|
|
19052
|
+
<dd>
|
|
19053
|
+
|
|
19054
|
+
<dl>
|
|
19055
|
+
<dd>
|
|
19056
|
+
|
|
19057
|
+
Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
|
|
19058
|
+
|
|
19059
|
+
</dd>
|
|
19060
|
+
</dl>
|
|
19061
|
+
</dd>
|
|
19062
|
+
</dl>
|
|
19063
|
+
|
|
19064
|
+
#### 🔌 Usage
|
|
19065
|
+
|
|
19066
|
+
<dl>
|
|
19067
|
+
<dd>
|
|
19068
|
+
|
|
19069
|
+
<dl>
|
|
19070
|
+
<dd>
|
|
19071
|
+
|
|
19072
|
+
```typescript
|
|
19073
|
+
await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
19074
|
+
```
|
|
19075
|
+
|
|
19076
|
+
</dd>
|
|
19077
|
+
</dl>
|
|
19078
|
+
</dd>
|
|
19079
|
+
</dl>
|
|
19080
|
+
|
|
19081
|
+
#### ⚙️ Parameters
|
|
19082
|
+
|
|
19083
|
+
<dl>
|
|
19084
|
+
<dd>
|
|
19085
|
+
|
|
19086
|
+
<dl>
|
|
19087
|
+
<dd>
|
|
19088
|
+
|
|
19089
|
+
**orderScheduleId:** `string`
|
|
19090
|
+
|
|
19091
|
+
</dd>
|
|
19092
|
+
</dl>
|
|
19093
|
+
|
|
19094
|
+
<dl>
|
|
19095
|
+
<dd>
|
|
19096
|
+
|
|
19097
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19098
|
+
|
|
19099
|
+
</dd>
|
|
19100
|
+
</dl>
|
|
19101
|
+
</dd>
|
|
19102
|
+
</dl>
|
|
19103
|
+
|
|
19104
|
+
</dd>
|
|
19105
|
+
</dl>
|
|
19106
|
+
</details>
|
|
19107
|
+
|
|
19108
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">unpauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
19109
|
+
<dl>
|
|
19110
|
+
<dd>
|
|
19111
|
+
|
|
19112
|
+
#### 📝 Description
|
|
19113
|
+
|
|
19114
|
+
<dl>
|
|
19115
|
+
<dd>
|
|
19116
|
+
|
|
19117
|
+
<dl>
|
|
19118
|
+
<dd>
|
|
19119
|
+
|
|
19120
|
+
Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
19121
|
+
|
|
19122
|
+
</dd>
|
|
19123
|
+
</dl>
|
|
19124
|
+
</dd>
|
|
19125
|
+
</dl>
|
|
19126
|
+
|
|
19127
|
+
#### 🔌 Usage
|
|
19128
|
+
|
|
19129
|
+
<dl>
|
|
19130
|
+
<dd>
|
|
19131
|
+
|
|
19132
|
+
<dl>
|
|
19133
|
+
<dd>
|
|
19134
|
+
|
|
19135
|
+
```typescript
|
|
19136
|
+
await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
19137
|
+
```
|
|
19138
|
+
|
|
19139
|
+
</dd>
|
|
19140
|
+
</dl>
|
|
19141
|
+
</dd>
|
|
19142
|
+
</dl>
|
|
19143
|
+
|
|
19144
|
+
#### ⚙️ Parameters
|
|
19145
|
+
|
|
19146
|
+
<dl>
|
|
19147
|
+
<dd>
|
|
19148
|
+
|
|
19149
|
+
<dl>
|
|
19150
|
+
<dd>
|
|
19151
|
+
|
|
19152
|
+
**orderScheduleId:** `string`
|
|
19153
|
+
|
|
19154
|
+
</dd>
|
|
19155
|
+
</dl>
|
|
19156
|
+
|
|
19157
|
+
<dl>
|
|
19158
|
+
<dd>
|
|
19159
|
+
|
|
19160
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19161
|
+
|
|
19162
|
+
</dd>
|
|
19163
|
+
</dl>
|
|
19164
|
+
</dd>
|
|
19165
|
+
</dl>
|
|
19166
|
+
|
|
19167
|
+
</dd>
|
|
19168
|
+
</dl>
|
|
19169
|
+
</details>
|
|
19170
|
+
|
|
19171
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
19172
|
+
<dl>
|
|
19173
|
+
<dd>
|
|
19174
|
+
|
|
19175
|
+
#### 📝 Description
|
|
19176
|
+
|
|
19177
|
+
<dl>
|
|
19178
|
+
<dd>
|
|
19179
|
+
|
|
19180
|
+
<dl>
|
|
19181
|
+
<dd>
|
|
19182
|
+
|
|
19183
|
+
Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
19184
|
+
|
|
19185
|
+
</dd>
|
|
19186
|
+
</dl>
|
|
19187
|
+
</dd>
|
|
19188
|
+
</dl>
|
|
19189
|
+
|
|
19190
|
+
#### 🔌 Usage
|
|
19191
|
+
|
|
19192
|
+
<dl>
|
|
19193
|
+
<dd>
|
|
19194
|
+
|
|
19195
|
+
<dl>
|
|
19196
|
+
<dd>
|
|
19197
|
+
|
|
19198
|
+
```typescript
|
|
19199
|
+
await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
19200
|
+
```
|
|
19201
|
+
|
|
19202
|
+
</dd>
|
|
19203
|
+
</dl>
|
|
19204
|
+
</dd>
|
|
19205
|
+
</dl>
|
|
19206
|
+
|
|
19207
|
+
#### ⚙️ Parameters
|
|
19208
|
+
|
|
19209
|
+
<dl>
|
|
19210
|
+
<dd>
|
|
19211
|
+
|
|
19212
|
+
<dl>
|
|
19213
|
+
<dd>
|
|
19214
|
+
|
|
19215
|
+
**orderScheduleId:** `string`
|
|
19216
|
+
|
|
19217
|
+
</dd>
|
|
19218
|
+
</dl>
|
|
19219
|
+
|
|
19220
|
+
<dl>
|
|
19221
|
+
<dd>
|
|
19222
|
+
|
|
19223
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19224
|
+
|
|
19225
|
+
</dd>
|
|
19226
|
+
</dl>
|
|
19227
|
+
</dd>
|
|
19228
|
+
</dl>
|
|
19229
|
+
|
|
19230
|
+
</dd>
|
|
19231
|
+
</dl>
|
|
19232
|
+
</details>
|
|
19233
|
+
|
|
19234
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">archiveV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
19235
|
+
<dl>
|
|
19236
|
+
<dd>
|
|
19237
|
+
|
|
19238
|
+
#### 📝 Description
|
|
19239
|
+
|
|
19240
|
+
<dl>
|
|
19241
|
+
<dd>
|
|
19242
|
+
|
|
19243
|
+
<dl>
|
|
19244
|
+
<dd>
|
|
19245
|
+
|
|
19246
|
+
Archives an order schedule and prevents future runs. | authz: min_org_role=operator | () -> (bool)
|
|
19247
|
+
|
|
19248
|
+
</dd>
|
|
19249
|
+
</dl>
|
|
19250
|
+
</dd>
|
|
19251
|
+
</dl>
|
|
19252
|
+
|
|
19253
|
+
#### 🔌 Usage
|
|
19254
|
+
|
|
19255
|
+
<dl>
|
|
19256
|
+
<dd>
|
|
19257
|
+
|
|
19258
|
+
<dl>
|
|
19259
|
+
<dd>
|
|
19260
|
+
|
|
19261
|
+
```typescript
|
|
19262
|
+
await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
19263
|
+
```
|
|
19264
|
+
|
|
19265
|
+
</dd>
|
|
19266
|
+
</dl>
|
|
19267
|
+
</dd>
|
|
19268
|
+
</dl>
|
|
19269
|
+
|
|
19270
|
+
#### ⚙️ Parameters
|
|
19271
|
+
|
|
19272
|
+
<dl>
|
|
19273
|
+
<dd>
|
|
19274
|
+
|
|
19275
|
+
<dl>
|
|
19276
|
+
<dd>
|
|
19277
|
+
|
|
19278
|
+
**orderScheduleId:** `string`
|
|
19279
|
+
|
|
19280
|
+
</dd>
|
|
19281
|
+
</dl>
|
|
19282
|
+
|
|
19283
|
+
<dl>
|
|
19284
|
+
<dd>
|
|
19285
|
+
|
|
19286
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19287
|
+
|
|
19288
|
+
</dd>
|
|
19289
|
+
</dl>
|
|
19290
|
+
</dd>
|
|
19291
|
+
</dl>
|
|
19292
|
+
|
|
19293
|
+
</dd>
|
|
19294
|
+
</dl>
|
|
19295
|
+
</details>
|
|
19296
|
+
|
|
19297
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">triggerV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
19298
|
+
<dl>
|
|
19299
|
+
<dd>
|
|
19300
|
+
|
|
19301
|
+
#### 📝 Description
|
|
19302
|
+
|
|
19303
|
+
<dl>
|
|
19304
|
+
<dd>
|
|
19305
|
+
|
|
19306
|
+
<dl>
|
|
19307
|
+
<dd>
|
|
19308
|
+
|
|
19309
|
+
Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
|
|
19310
|
+
|
|
19311
|
+
</dd>
|
|
19312
|
+
</dl>
|
|
19313
|
+
</dd>
|
|
19314
|
+
</dl>
|
|
19315
|
+
|
|
19316
|
+
#### 🔌 Usage
|
|
19317
|
+
|
|
19318
|
+
<dl>
|
|
19319
|
+
<dd>
|
|
19320
|
+
|
|
19321
|
+
<dl>
|
|
19322
|
+
<dd>
|
|
19323
|
+
|
|
19324
|
+
```typescript
|
|
19325
|
+
await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
19326
|
+
```
|
|
19327
|
+
|
|
19328
|
+
</dd>
|
|
19329
|
+
</dl>
|
|
19330
|
+
</dd>
|
|
19331
|
+
</dl>
|
|
19332
|
+
|
|
19333
|
+
#### ⚙️ Parameters
|
|
19334
|
+
|
|
19335
|
+
<dl>
|
|
19336
|
+
<dd>
|
|
19337
|
+
|
|
19338
|
+
<dl>
|
|
19339
|
+
<dd>
|
|
19340
|
+
|
|
19341
|
+
**orderScheduleId:** `string`
|
|
19342
|
+
|
|
19343
|
+
</dd>
|
|
19344
|
+
</dl>
|
|
19345
|
+
|
|
19346
|
+
<dl>
|
|
19347
|
+
<dd>
|
|
19348
|
+
|
|
19349
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19350
|
+
|
|
19351
|
+
</dd>
|
|
19352
|
+
</dl>
|
|
19353
|
+
</dd>
|
|
19354
|
+
</dl>
|
|
19355
|
+
|
|
19356
|
+
</dd>
|
|
19357
|
+
</dl>
|
|
19358
|
+
</details>
|
|
19359
|
+
|
|
19360
|
+
## Shipping OrderTemplates
|
|
19361
|
+
|
|
19362
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">getExpandedByIdV1</a>(orderTemplateId) -> Chrt.OrderTemplateExpanded</code></summary>
|
|
19363
|
+
<dl>
|
|
19364
|
+
<dd>
|
|
19365
|
+
|
|
19366
|
+
#### 📝 Description
|
|
19367
|
+
|
|
19368
|
+
<dl>
|
|
19369
|
+
<dd>
|
|
19370
|
+
|
|
19371
|
+
<dl>
|
|
19372
|
+
<dd>
|
|
19373
|
+
|
|
19374
|
+
Retrieves an order template with its reference columns resolved (shipper, executor orgs, drivers, directory entries). Unresolvable list references are omitted so the caller can detect dangling ids. | authz: min_org_role=operator | () -> (OrderTemplateExpanded)
|
|
19375
|
+
|
|
19376
|
+
</dd>
|
|
19377
|
+
</dl>
|
|
19378
|
+
</dd>
|
|
19379
|
+
</dl>
|
|
19380
|
+
|
|
19381
|
+
#### 🔌 Usage
|
|
19382
|
+
|
|
19383
|
+
<dl>
|
|
19384
|
+
<dd>
|
|
19385
|
+
|
|
19386
|
+
<dl>
|
|
19387
|
+
<dd>
|
|
19388
|
+
|
|
19389
|
+
```typescript
|
|
19390
|
+
await client.shipping.orderTemplates.getExpandedByIdV1("order_template_id");
|
|
19391
|
+
```
|
|
19392
|
+
|
|
19393
|
+
</dd>
|
|
19394
|
+
</dl>
|
|
19395
|
+
</dd>
|
|
19396
|
+
</dl>
|
|
19397
|
+
|
|
19398
|
+
#### ⚙️ Parameters
|
|
19399
|
+
|
|
19400
|
+
<dl>
|
|
19401
|
+
<dd>
|
|
19402
|
+
|
|
19403
|
+
<dl>
|
|
19404
|
+
<dd>
|
|
19405
|
+
|
|
19406
|
+
**orderTemplateId:** `string`
|
|
19407
|
+
|
|
19408
|
+
</dd>
|
|
19409
|
+
</dl>
|
|
19410
|
+
|
|
19411
|
+
<dl>
|
|
19412
|
+
<dd>
|
|
19413
|
+
|
|
19414
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19415
|
+
|
|
19416
|
+
</dd>
|
|
19417
|
+
</dl>
|
|
19418
|
+
</dd>
|
|
19419
|
+
</dl>
|
|
19420
|
+
|
|
19421
|
+
</dd>
|
|
19422
|
+
</dl>
|
|
19423
|
+
</details>
|
|
19424
|
+
|
|
19425
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderTemplateListRes</code></summary>
|
|
19426
|
+
<dl>
|
|
19427
|
+
<dd>
|
|
19428
|
+
|
|
19429
|
+
#### 📝 Description
|
|
19430
|
+
|
|
19431
|
+
<dl>
|
|
19432
|
+
<dd>
|
|
19433
|
+
|
|
19434
|
+
<dl>
|
|
19435
|
+
<dd>
|
|
19436
|
+
|
|
19437
|
+
Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description, order_input, off_chrt_reference_id_str). | authz: min_org_role=operator | () -> (OrderTemplateListRes)
|
|
19438
|
+
|
|
19439
|
+
</dd>
|
|
19440
|
+
</dl>
|
|
19441
|
+
</dd>
|
|
19442
|
+
</dl>
|
|
19443
|
+
|
|
19444
|
+
#### 🔌 Usage
|
|
19445
|
+
|
|
19446
|
+
<dl>
|
|
19447
|
+
<dd>
|
|
19448
|
+
|
|
19449
|
+
<dl>
|
|
19450
|
+
<dd>
|
|
19451
|
+
|
|
19452
|
+
```typescript
|
|
19453
|
+
await client.shipping.orderTemplates.listV1({
|
|
19454
|
+
sort_by: "created_at_timestamp",
|
|
19455
|
+
sort_order: "asc",
|
|
19456
|
+
page: 1,
|
|
19457
|
+
page_size: 1,
|
|
19458
|
+
search: "search",
|
|
19459
|
+
filter_archived: true,
|
|
19460
|
+
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
19461
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19462
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
19463
|
+
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19464
|
+
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
19465
|
+
});
|
|
19466
|
+
```
|
|
19467
|
+
|
|
19468
|
+
</dd>
|
|
19469
|
+
</dl>
|
|
19470
|
+
</dd>
|
|
19471
|
+
</dl>
|
|
19472
|
+
|
|
19473
|
+
#### ⚙️ Parameters
|
|
19474
|
+
|
|
19475
|
+
<dl>
|
|
19476
|
+
<dd>
|
|
19477
|
+
|
|
19478
|
+
<dl>
|
|
19479
|
+
<dd>
|
|
19480
|
+
|
|
19481
|
+
**request:** `Chrt.shipping.OrderTemplatesListV1Request`
|
|
19482
|
+
|
|
19483
|
+
</dd>
|
|
19484
|
+
</dl>
|
|
19485
|
+
|
|
19486
|
+
<dl>
|
|
19487
|
+
<dd>
|
|
19488
|
+
|
|
19489
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19490
|
+
|
|
19491
|
+
</dd>
|
|
19492
|
+
</dl>
|
|
19493
|
+
</dd>
|
|
19494
|
+
</dl>
|
|
19495
|
+
|
|
19496
|
+
</dd>
|
|
19497
|
+
</dl>
|
|
19498
|
+
</details>
|
|
19499
|
+
|
|
19500
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">getByIdV1</a>(orderTemplateId) -> Chrt.OrderTemplate1</code></summary>
|
|
19501
|
+
<dl>
|
|
19502
|
+
<dd>
|
|
19503
|
+
|
|
19504
|
+
#### 📝 Description
|
|
19505
|
+
|
|
19506
|
+
<dl>
|
|
19507
|
+
<dd>
|
|
19508
|
+
|
|
19509
|
+
<dl>
|
|
19510
|
+
<dd>
|
|
19511
|
+
|
|
19512
|
+
Retrieves an order template by ID. | authz: min_org_role=operator | () -> (OrderTemplate1)
|
|
19513
|
+
|
|
19514
|
+
</dd>
|
|
19515
|
+
</dl>
|
|
19516
|
+
</dd>
|
|
19517
|
+
</dl>
|
|
19518
|
+
|
|
19519
|
+
#### 🔌 Usage
|
|
19520
|
+
|
|
19521
|
+
<dl>
|
|
19522
|
+
<dd>
|
|
19523
|
+
|
|
19524
|
+
<dl>
|
|
19525
|
+
<dd>
|
|
19526
|
+
|
|
19527
|
+
```typescript
|
|
19528
|
+
await client.shipping.orderTemplates.getByIdV1("order_template_id");
|
|
19529
|
+
```
|
|
19530
|
+
|
|
19531
|
+
</dd>
|
|
19532
|
+
</dl>
|
|
19533
|
+
</dd>
|
|
19534
|
+
</dl>
|
|
19535
|
+
|
|
19536
|
+
#### ⚙️ Parameters
|
|
19537
|
+
|
|
19538
|
+
<dl>
|
|
19539
|
+
<dd>
|
|
19540
|
+
|
|
19541
|
+
<dl>
|
|
19542
|
+
<dd>
|
|
19543
|
+
|
|
19544
|
+
**orderTemplateId:** `string`
|
|
19545
|
+
|
|
19546
|
+
</dd>
|
|
19547
|
+
</dl>
|
|
19548
|
+
|
|
19549
|
+
<dl>
|
|
19550
|
+
<dd>
|
|
19551
|
+
|
|
19552
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19553
|
+
|
|
19554
|
+
</dd>
|
|
19555
|
+
</dl>
|
|
19556
|
+
</dd>
|
|
19557
|
+
</dl>
|
|
19558
|
+
|
|
19559
|
+
</dd>
|
|
19560
|
+
</dl>
|
|
19561
|
+
</details>
|
|
19562
|
+
|
|
19563
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">deleteV1</a>(orderTemplateId) -> boolean</code></summary>
|
|
19564
|
+
<dl>
|
|
19565
|
+
<dd>
|
|
19566
|
+
|
|
19567
|
+
#### 📝 Description
|
|
19568
|
+
|
|
19569
|
+
<dl>
|
|
19570
|
+
<dd>
|
|
19571
|
+
|
|
19572
|
+
<dl>
|
|
19573
|
+
<dd>
|
|
19574
|
+
|
|
19575
|
+
Deletes an order template, but only when no orders were built from it (otherwise archive instead). | authz: min_org_role=operator | () -> (bool)
|
|
19576
|
+
|
|
19577
|
+
</dd>
|
|
19578
|
+
</dl>
|
|
19579
|
+
</dd>
|
|
19580
|
+
</dl>
|
|
19581
|
+
|
|
19582
|
+
#### 🔌 Usage
|
|
19583
|
+
|
|
19584
|
+
<dl>
|
|
19585
|
+
<dd>
|
|
19586
|
+
|
|
19587
|
+
<dl>
|
|
19588
|
+
<dd>
|
|
19589
|
+
|
|
19590
|
+
```typescript
|
|
19591
|
+
await client.shipping.orderTemplates.deleteV1("order_template_id");
|
|
19592
|
+
```
|
|
19593
|
+
|
|
19594
|
+
</dd>
|
|
19595
|
+
</dl>
|
|
19596
|
+
</dd>
|
|
19597
|
+
</dl>
|
|
19598
|
+
|
|
19599
|
+
#### ⚙️ Parameters
|
|
19600
|
+
|
|
19601
|
+
<dl>
|
|
19602
|
+
<dd>
|
|
19603
|
+
|
|
19604
|
+
<dl>
|
|
19605
|
+
<dd>
|
|
19606
|
+
|
|
19607
|
+
**orderTemplateId:** `string`
|
|
18959
19608
|
|
|
18960
19609
|
</dd>
|
|
18961
19610
|
</dl>
|
|
@@ -18963,7 +19612,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18963
19612
|
<dl>
|
|
18964
19613
|
<dd>
|
|
18965
19614
|
|
|
18966
|
-
**requestOptions:** `
|
|
19615
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
18967
19616
|
|
|
18968
19617
|
</dd>
|
|
18969
19618
|
</dl>
|
|
@@ -18974,7 +19623,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18974
19623
|
</dl>
|
|
18975
19624
|
</details>
|
|
18976
19625
|
|
|
18977
|
-
<details><summary><code>client.shipping.
|
|
19626
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
18978
19627
|
<dl>
|
|
18979
19628
|
<dd>
|
|
18980
19629
|
|
|
@@ -18986,7 +19635,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18986
19635
|
<dl>
|
|
18987
19636
|
<dd>
|
|
18988
19637
|
|
|
18989
|
-
|
|
19638
|
+
Creates a new order template. | authz: min_org_role=operator | (OrderTemplateClientCreate1) -> (PydanticObjectId)
|
|
18990
19639
|
|
|
18991
19640
|
</dd>
|
|
18992
19641
|
</dl>
|
|
@@ -19002,7 +19651,10 @@ Transfers order schedule workflow ownership to the caller. | authz: min_org_role
|
|
|
19002
19651
|
<dd>
|
|
19003
19652
|
|
|
19004
19653
|
```typescript
|
|
19005
|
-
await client.shipping.
|
|
19654
|
+
await client.shipping.orderTemplates.createV1({
|
|
19655
|
+
schema_version: 1,
|
|
19656
|
+
name: "name",
|
|
19657
|
+
});
|
|
19006
19658
|
```
|
|
19007
19659
|
|
|
19008
19660
|
</dd>
|
|
@@ -19018,7 +19670,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
19018
19670
|
<dl>
|
|
19019
19671
|
<dd>
|
|
19020
19672
|
|
|
19021
|
-
**
|
|
19673
|
+
**request:** `Chrt.shipping.OrderTemplateClientCreate1`
|
|
19022
19674
|
|
|
19023
19675
|
</dd>
|
|
19024
19676
|
</dl>
|
|
@@ -19026,7 +19678,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
19026
19678
|
<dl>
|
|
19027
19679
|
<dd>
|
|
19028
19680
|
|
|
19029
|
-
**requestOptions:** `
|
|
19681
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19030
19682
|
|
|
19031
19683
|
</dd>
|
|
19032
19684
|
</dl>
|
|
@@ -19037,7 +19689,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
19037
19689
|
</dl>
|
|
19038
19690
|
</details>
|
|
19039
19691
|
|
|
19040
|
-
<details><summary><code>client.shipping.
|
|
19692
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">updateV1</a>(orderTemplateId, { ...params }) -> boolean</code></summary>
|
|
19041
19693
|
<dl>
|
|
19042
19694
|
<dd>
|
|
19043
19695
|
|
|
@@ -19049,7 +19701,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
19049
19701
|
<dl>
|
|
19050
19702
|
<dd>
|
|
19051
19703
|
|
|
19052
|
-
|
|
19704
|
+
Updates an order template. | authz: min_org_role=operator | (OrderTemplateClientUpdate1) -> (bool)
|
|
19053
19705
|
|
|
19054
19706
|
</dd>
|
|
19055
19707
|
</dl>
|
|
@@ -19065,7 +19717,7 @@ Validates a draft order schedule, creates its Temporal orchestrator schedule, an
|
|
|
19065
19717
|
<dd>
|
|
19066
19718
|
|
|
19067
19719
|
```typescript
|
|
19068
|
-
await client.shipping.
|
|
19720
|
+
await client.shipping.orderTemplates.updateV1("order_template_id");
|
|
19069
19721
|
```
|
|
19070
19722
|
|
|
19071
19723
|
</dd>
|
|
@@ -19081,7 +19733,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
19081
19733
|
<dl>
|
|
19082
19734
|
<dd>
|
|
19083
19735
|
|
|
19084
|
-
**
|
|
19736
|
+
**orderTemplateId:** `string`
|
|
19085
19737
|
|
|
19086
19738
|
</dd>
|
|
19087
19739
|
</dl>
|
|
@@ -19089,7 +19741,15 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
19089
19741
|
<dl>
|
|
19090
19742
|
<dd>
|
|
19091
19743
|
|
|
19092
|
-
**
|
|
19744
|
+
**request:** `Chrt.shipping.OrderTemplateClientUpdate1`
|
|
19745
|
+
|
|
19746
|
+
</dd>
|
|
19747
|
+
</dl>
|
|
19748
|
+
|
|
19749
|
+
<dl>
|
|
19750
|
+
<dd>
|
|
19751
|
+
|
|
19752
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19093
19753
|
|
|
19094
19754
|
</dd>
|
|
19095
19755
|
</dl>
|
|
@@ -19100,7 +19760,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
19100
19760
|
</dl>
|
|
19101
19761
|
</details>
|
|
19102
19762
|
|
|
19103
|
-
<details><summary><code>client.shipping.
|
|
19763
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">archiveV1</a>(orderTemplateId) -> boolean</code></summary>
|
|
19104
19764
|
<dl>
|
|
19105
19765
|
<dd>
|
|
19106
19766
|
|
|
@@ -19112,7 +19772,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
19112
19772
|
<dl>
|
|
19113
19773
|
<dd>
|
|
19114
19774
|
|
|
19115
|
-
|
|
19775
|
+
Archives an order template by setting archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)
|
|
19116
19776
|
|
|
19117
19777
|
</dd>
|
|
19118
19778
|
</dl>
|
|
@@ -19128,7 +19788,7 @@ Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
|
19128
19788
|
<dd>
|
|
19129
19789
|
|
|
19130
19790
|
```typescript
|
|
19131
|
-
await client.shipping.
|
|
19791
|
+
await client.shipping.orderTemplates.archiveV1("order_template_id");
|
|
19132
19792
|
```
|
|
19133
19793
|
|
|
19134
19794
|
</dd>
|
|
@@ -19144,7 +19804,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
19144
19804
|
<dl>
|
|
19145
19805
|
<dd>
|
|
19146
19806
|
|
|
19147
|
-
**
|
|
19807
|
+
**orderTemplateId:** `string`
|
|
19148
19808
|
|
|
19149
19809
|
</dd>
|
|
19150
19810
|
</dl>
|
|
@@ -19152,7 +19812,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
19152
19812
|
<dl>
|
|
19153
19813
|
<dd>
|
|
19154
19814
|
|
|
19155
|
-
**requestOptions:** `
|
|
19815
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19156
19816
|
|
|
19157
19817
|
</dd>
|
|
19158
19818
|
</dl>
|
|
@@ -19163,7 +19823,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
19163
19823
|
</dl>
|
|
19164
19824
|
</details>
|
|
19165
19825
|
|
|
19166
|
-
<details><summary><code>client.shipping.
|
|
19826
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">unarchiveV1</a>(orderTemplateId) -> boolean</code></summary>
|
|
19167
19827
|
<dl>
|
|
19168
19828
|
<dd>
|
|
19169
19829
|
|
|
@@ -19175,7 +19835,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
19175
19835
|
<dl>
|
|
19176
19836
|
<dd>
|
|
19177
19837
|
|
|
19178
|
-
|
|
19838
|
+
Restores an archived order template by clearing archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)
|
|
19179
19839
|
|
|
19180
19840
|
</dd>
|
|
19181
19841
|
</dl>
|
|
@@ -19191,7 +19851,7 @@ Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
|
19191
19851
|
<dd>
|
|
19192
19852
|
|
|
19193
19853
|
```typescript
|
|
19194
|
-
await client.shipping.
|
|
19854
|
+
await client.shipping.orderTemplates.unarchiveV1("order_template_id");
|
|
19195
19855
|
```
|
|
19196
19856
|
|
|
19197
19857
|
</dd>
|
|
@@ -19207,7 +19867,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
19207
19867
|
<dl>
|
|
19208
19868
|
<dd>
|
|
19209
19869
|
|
|
19210
|
-
**
|
|
19870
|
+
**orderTemplateId:** `string`
|
|
19211
19871
|
|
|
19212
19872
|
</dd>
|
|
19213
19873
|
</dl>
|
|
@@ -19215,7 +19875,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
19215
19875
|
<dl>
|
|
19216
19876
|
<dd>
|
|
19217
19877
|
|
|
19218
|
-
**requestOptions:** `
|
|
19878
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19219
19879
|
|
|
19220
19880
|
</dd>
|
|
19221
19881
|
</dl>
|
|
@@ -19226,7 +19886,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
19226
19886
|
</dl>
|
|
19227
19887
|
</details>
|
|
19228
19888
|
|
|
19229
|
-
<details><summary><code>client.shipping.
|
|
19889
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">referencesRemoveV1</a>(orderTemplateId, { ...params }) -> boolean</code></summary>
|
|
19230
19890
|
<dl>
|
|
19231
19891
|
<dd>
|
|
19232
19892
|
|
|
@@ -19238,7 +19898,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
19238
19898
|
<dl>
|
|
19239
19899
|
<dd>
|
|
19240
19900
|
|
|
19241
|
-
|
|
19901
|
+
Removes a (possibly dangling) reference id from a template column. | authz: min_org_role=operator | (OrderTemplateRemoveReferenceReq) -> (bool)
|
|
19242
19902
|
|
|
19243
19903
|
</dd>
|
|
19244
19904
|
</dl>
|
|
@@ -19254,7 +19914,9 @@ Archives an order schedule and prevents future runs. | authz: min_org_role=opera
|
|
|
19254
19914
|
<dd>
|
|
19255
19915
|
|
|
19256
19916
|
```typescript
|
|
19257
|
-
await client.shipping.
|
|
19917
|
+
await client.shipping.orderTemplates.referencesRemoveV1("order_template_id", {
|
|
19918
|
+
column: "shipper_org_id",
|
|
19919
|
+
});
|
|
19258
19920
|
```
|
|
19259
19921
|
|
|
19260
19922
|
</dd>
|
|
@@ -19270,7 +19932,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
19270
19932
|
<dl>
|
|
19271
19933
|
<dd>
|
|
19272
19934
|
|
|
19273
|
-
**
|
|
19935
|
+
**orderTemplateId:** `string`
|
|
19274
19936
|
|
|
19275
19937
|
</dd>
|
|
19276
19938
|
</dl>
|
|
@@ -19278,7 +19940,15 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
19278
19940
|
<dl>
|
|
19279
19941
|
<dd>
|
|
19280
19942
|
|
|
19281
|
-
**
|
|
19943
|
+
**request:** `Chrt.shipping.OrderTemplateRemoveReferenceReq`
|
|
19944
|
+
|
|
19945
|
+
</dd>
|
|
19946
|
+
</dl>
|
|
19947
|
+
|
|
19948
|
+
<dl>
|
|
19949
|
+
<dd>
|
|
19950
|
+
|
|
19951
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19282
19952
|
|
|
19283
19953
|
</dd>
|
|
19284
19954
|
</dl>
|
|
@@ -19289,7 +19959,9 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
19289
19959
|
</dl>
|
|
19290
19960
|
</details>
|
|
19291
19961
|
|
|
19292
|
-
|
|
19962
|
+
## Shipping TaskGroups
|
|
19963
|
+
|
|
19964
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.TaskGroupTypeaheadResult[]</code></summary>
|
|
19293
19965
|
<dl>
|
|
19294
19966
|
<dd>
|
|
19295
19967
|
|
|
@@ -19301,7 +19973,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
19301
19973
|
<dl>
|
|
19302
19974
|
<dd>
|
|
19303
19975
|
|
|
19304
|
-
|
|
19976
|
+
Returns distinct order_short_id and order_off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft task groups where the caller's provider org is the executor. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (list[TaskGroupTypeaheadResult])
|
|
19305
19977
|
|
|
19306
19978
|
</dd>
|
|
19307
19979
|
</dl>
|
|
@@ -19317,7 +19989,10 @@ Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (
|
|
|
19317
19989
|
<dd>
|
|
19318
19990
|
|
|
19319
19991
|
```typescript
|
|
19320
|
-
await client.shipping.
|
|
19992
|
+
await client.shipping.taskGroups.typeaheadV1({
|
|
19993
|
+
query: "query",
|
|
19994
|
+
limit: 1,
|
|
19995
|
+
});
|
|
19321
19996
|
```
|
|
19322
19997
|
|
|
19323
19998
|
</dd>
|
|
@@ -19333,7 +20008,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
19333
20008
|
<dl>
|
|
19334
20009
|
<dd>
|
|
19335
20010
|
|
|
19336
|
-
**
|
|
20011
|
+
**request:** `Chrt.shipping.TaskGroupsTypeaheadV1Request`
|
|
19337
20012
|
|
|
19338
20013
|
</dd>
|
|
19339
20014
|
</dl>
|
|
@@ -19341,7 +20016,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
19341
20016
|
<dl>
|
|
19342
20017
|
<dd>
|
|
19343
20018
|
|
|
19344
|
-
**requestOptions:** `
|
|
20019
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
19345
20020
|
|
|
19346
20021
|
</dd>
|
|
19347
20022
|
</dl>
|
|
@@ -19352,8 +20027,6 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
19352
20027
|
</dl>
|
|
19353
20028
|
</details>
|
|
19354
20029
|
|
|
19355
|
-
## Shipping TaskGroups
|
|
19356
|
-
|
|
19357
20030
|
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
19358
20031
|
<dl>
|
|
19359
20032
|
<dd>
|
|
@@ -23910,72 +24583,6 @@ await client.shipping.orderDrafts.expanded.listV1({
|
|
|
23910
24583
|
</dl>
|
|
23911
24584
|
</details>
|
|
23912
24585
|
|
|
23913
|
-
<details><summary><code>client.shipping.orderDrafts.expanded.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
23914
|
-
<dl>
|
|
23915
|
-
<dd>
|
|
23916
|
-
|
|
23917
|
-
#### 📝 Description
|
|
23918
|
-
|
|
23919
|
-
<dl>
|
|
23920
|
-
<dd>
|
|
23921
|
-
|
|
23922
|
-
<dl>
|
|
23923
|
-
<dd>
|
|
23924
|
-
|
|
23925
|
-
Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
23926
|
-
|
|
23927
|
-
</dd>
|
|
23928
|
-
</dl>
|
|
23929
|
-
</dd>
|
|
23930
|
-
</dl>
|
|
23931
|
-
|
|
23932
|
-
#### 🔌 Usage
|
|
23933
|
-
|
|
23934
|
-
<dl>
|
|
23935
|
-
<dd>
|
|
23936
|
-
|
|
23937
|
-
<dl>
|
|
23938
|
-
<dd>
|
|
23939
|
-
|
|
23940
|
-
```typescript
|
|
23941
|
-
await client.shipping.orderDrafts.expanded.typeaheadV1({
|
|
23942
|
-
query: "query",
|
|
23943
|
-
limit: 1,
|
|
23944
|
-
});
|
|
23945
|
-
```
|
|
23946
|
-
|
|
23947
|
-
</dd>
|
|
23948
|
-
</dl>
|
|
23949
|
-
</dd>
|
|
23950
|
-
</dl>
|
|
23951
|
-
|
|
23952
|
-
#### ⚙️ Parameters
|
|
23953
|
-
|
|
23954
|
-
<dl>
|
|
23955
|
-
<dd>
|
|
23956
|
-
|
|
23957
|
-
<dl>
|
|
23958
|
-
<dd>
|
|
23959
|
-
|
|
23960
|
-
**request:** `Chrt.shipping.orderDrafts.ExpandedTypeaheadV1Request`
|
|
23961
|
-
|
|
23962
|
-
</dd>
|
|
23963
|
-
</dl>
|
|
23964
|
-
|
|
23965
|
-
<dl>
|
|
23966
|
-
<dd>
|
|
23967
|
-
|
|
23968
|
-
**requestOptions:** `Expanded.RequestOptions`
|
|
23969
|
-
|
|
23970
|
-
</dd>
|
|
23971
|
-
</dl>
|
|
23972
|
-
</dd>
|
|
23973
|
-
</dl>
|
|
23974
|
-
|
|
23975
|
-
</dd>
|
|
23976
|
-
</dl>
|
|
23977
|
-
</details>
|
|
23978
|
-
|
|
23979
24586
|
## Shipping OrderSchedules OrderManifest
|
|
23980
24587
|
|
|
23981
24588
|
<details><summary><code>client.shipping.orderSchedules.orderManifest.<a href="/src/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/Client.ts">validateV1</a>({ ...params }) -> Chrt.OrderManifestValidationResult</code></summary>
|
|
@@ -24354,72 +24961,6 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
24354
24961
|
</dl>
|
|
24355
24962
|
</details>
|
|
24356
24963
|
|
|
24357
|
-
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
24358
|
-
<dl>
|
|
24359
|
-
<dd>
|
|
24360
|
-
|
|
24361
|
-
#### 📝 Description
|
|
24362
|
-
|
|
24363
|
-
<dl>
|
|
24364
|
-
<dd>
|
|
24365
|
-
|
|
24366
|
-
<dl>
|
|
24367
|
-
<dd>
|
|
24368
|
-
|
|
24369
|
-
Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft orders visible to the caller's org. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
24370
|
-
|
|
24371
|
-
</dd>
|
|
24372
|
-
</dl>
|
|
24373
|
-
</dd>
|
|
24374
|
-
</dl>
|
|
24375
|
-
|
|
24376
|
-
#### 🔌 Usage
|
|
24377
|
-
|
|
24378
|
-
<dl>
|
|
24379
|
-
<dd>
|
|
24380
|
-
|
|
24381
|
-
<dl>
|
|
24382
|
-
<dd>
|
|
24383
|
-
|
|
24384
|
-
```typescript
|
|
24385
|
-
await client.shipping.orders.expanded.typeaheadV1({
|
|
24386
|
-
query: "query",
|
|
24387
|
-
limit: 1,
|
|
24388
|
-
});
|
|
24389
|
-
```
|
|
24390
|
-
|
|
24391
|
-
</dd>
|
|
24392
|
-
</dl>
|
|
24393
|
-
</dd>
|
|
24394
|
-
</dl>
|
|
24395
|
-
|
|
24396
|
-
#### ⚙️ Parameters
|
|
24397
|
-
|
|
24398
|
-
<dl>
|
|
24399
|
-
<dd>
|
|
24400
|
-
|
|
24401
|
-
<dl>
|
|
24402
|
-
<dd>
|
|
24403
|
-
|
|
24404
|
-
**request:** `Chrt.shipping.orders.ExpandedTypeaheadV1Request`
|
|
24405
|
-
|
|
24406
|
-
</dd>
|
|
24407
|
-
</dl>
|
|
24408
|
-
|
|
24409
|
-
<dl>
|
|
24410
|
-
<dd>
|
|
24411
|
-
|
|
24412
|
-
**requestOptions:** `Expanded.RequestOptions`
|
|
24413
|
-
|
|
24414
|
-
</dd>
|
|
24415
|
-
</dl>
|
|
24416
|
-
</dd>
|
|
24417
|
-
</dl>
|
|
24418
|
-
|
|
24419
|
-
</dd>
|
|
24420
|
-
</dl>
|
|
24421
|
-
</details>
|
|
24422
|
-
|
|
24423
24964
|
## Shipping TaskArtifacts S3Object
|
|
24424
24965
|
|
|
24425
24966
|
<details><summary><code>client.shipping.taskArtifacts.s3Object.<a href="/src/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(taskArtifactS3ObjectMetadataId) -> Chrt.TaskArtifactS3ObjectMetadata1</code></summary>
|
|
@@ -25770,72 +26311,6 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
25770
26311
|
</dl>
|
|
25771
26312
|
</details>
|
|
25772
26313
|
|
|
25773
|
-
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.TaskGroupTypeaheadResult[]</code></summary>
|
|
25774
|
-
<dl>
|
|
25775
|
-
<dd>
|
|
25776
|
-
|
|
25777
|
-
#### 📝 Description
|
|
25778
|
-
|
|
25779
|
-
<dl>
|
|
25780
|
-
<dd>
|
|
25781
|
-
|
|
25782
|
-
<dl>
|
|
25783
|
-
<dd>
|
|
25784
|
-
|
|
25785
|
-
Returns distinct order_short_id and order_off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft task groups where the caller's provider org is the executor. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (list[TaskGroupTypeaheadResult])
|
|
25786
|
-
|
|
25787
|
-
</dd>
|
|
25788
|
-
</dl>
|
|
25789
|
-
</dd>
|
|
25790
|
-
</dl>
|
|
25791
|
-
|
|
25792
|
-
#### 🔌 Usage
|
|
25793
|
-
|
|
25794
|
-
<dl>
|
|
25795
|
-
<dd>
|
|
25796
|
-
|
|
25797
|
-
<dl>
|
|
25798
|
-
<dd>
|
|
25799
|
-
|
|
25800
|
-
```typescript
|
|
25801
|
-
await client.shipping.taskGroups.expanded.typeaheadV1({
|
|
25802
|
-
query: "query",
|
|
25803
|
-
limit: 1,
|
|
25804
|
-
});
|
|
25805
|
-
```
|
|
25806
|
-
|
|
25807
|
-
</dd>
|
|
25808
|
-
</dl>
|
|
25809
|
-
</dd>
|
|
25810
|
-
</dl>
|
|
25811
|
-
|
|
25812
|
-
#### ⚙️ Parameters
|
|
25813
|
-
|
|
25814
|
-
<dl>
|
|
25815
|
-
<dd>
|
|
25816
|
-
|
|
25817
|
-
<dl>
|
|
25818
|
-
<dd>
|
|
25819
|
-
|
|
25820
|
-
**request:** `Chrt.shipping.taskGroups.ExpandedTypeaheadV1Request`
|
|
25821
|
-
|
|
25822
|
-
</dd>
|
|
25823
|
-
</dl>
|
|
25824
|
-
|
|
25825
|
-
<dl>
|
|
25826
|
-
<dd>
|
|
25827
|
-
|
|
25828
|
-
**requestOptions:** `Expanded.RequestOptions`
|
|
25829
|
-
|
|
25830
|
-
</dd>
|
|
25831
|
-
</dl>
|
|
25832
|
-
</dd>
|
|
25833
|
-
</dl>
|
|
25834
|
-
|
|
25835
|
-
</dd>
|
|
25836
|
-
</dl>
|
|
25837
|
-
</details>
|
|
25838
|
-
|
|
25839
26314
|
## Shipping Tasks ExecutorOrgNotes
|
|
25840
26315
|
|
|
25841
26316
|
<details><summary><code>client.shipping.tasks.executorOrgNotes.<a href="/src/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.ts">addV1</a>(taskId, { ...params }) -> boolean</code></summary>
|