@chrt-inc/typescript-sdk 1.321.0 → 1.324.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/drivers/client/Client.d.ts +18 -6
- package/dist/cjs/api/resources/drivers/client/Client.js +70 -32
- package/dist/cjs/api/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/drivers/client/requests/DriversListV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/drivers/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.d.ts +52 -5
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.js +200 -9
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.d.ts +13 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.js +5 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/SetTaskOrderingDraftReq.d.ts +13 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/SetTaskOrderingDraftReq.js +5 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/UpdateCourierOrgDraftReq.d.ts +13 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/UpdateCourierOrgDraftReq.js +5 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/index.d.ts +3 -1
- package/dist/cjs/api/resources/taskArtifacts/client/Client.d.ts +0 -3
- package/dist/cjs/api/resources/taskArtifacts/client/Client.js +2 -7
- package/dist/cjs/api/resources/taskArtifacts/resources/index.d.ts +1 -1
- package/dist/cjs/api/resources/taskArtifacts/resources/index.js +5 -2
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/Client.d.ts +44 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/Client.js +187 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/index.js +15 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/requests/BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost.d.ts +13 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/requests/BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost.js +5 -0
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +0 -33
- package/dist/cjs/api/resources/taskGroups/client/Client.js +4 -137
- package/dist/cjs/api/resources/taskGroups/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskGroups/resources/index.d.ts +1 -1
- package/dist/cjs/api/resources/taskGroups/resources/index.js +2 -2
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/Client.d.ts +44 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/Client.js +187 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/index.js +15 -0
- package/dist/cjs/api/resources/taskGroups/{client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.d.ts → resources/s3Object/client/requests/BodyPostTaskGroupsS3ObjectAddV1OortTaskGroupsS3ObjectAddV1TaskGroupIdPost.d.ts} +2 -2
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/requests/BodyPostTaskGroupsS3ObjectAddV1OortTaskGroupsS3ObjectAddV1TaskGroupIdPost.js +5 -0
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/requests/index.d.ts +1 -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/drivers/client/Client.d.mts +18 -6
- package/dist/esm/api/resources/drivers/client/Client.mjs +70 -32
- package/dist/esm/api/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts +16 -0
- package/dist/esm/api/resources/drivers/client/requests/DriversListV1Request.d.mts +16 -0
- package/dist/esm/api/resources/drivers/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.d.mts +52 -5
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.mjs +200 -9
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.d.mts +13 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/SetFlightNumberDraftReq.mjs +4 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/SetTaskOrderingDraftReq.d.mts +13 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/SetTaskOrderingDraftReq.mjs +4 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/UpdateCourierOrgDraftReq.d.mts +13 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/UpdateCourierOrgDraftReq.mjs +4 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/index.d.mts +3 -1
- package/dist/esm/api/resources/taskArtifacts/client/Client.d.mts +0 -3
- package/dist/esm/api/resources/taskArtifacts/client/Client.mjs +0 -5
- package/dist/esm/api/resources/taskArtifacts/resources/index.d.mts +1 -1
- package/dist/esm/api/resources/taskArtifacts/resources/index.mjs +1 -1
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/Client.d.mts +44 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/Client.mjs +187 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/index.d.mts +1 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/index.mjs +1 -1
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/requests/BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost.d.mts +13 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/requests/BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost.mjs +4 -0
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/client/Client.d.mts +0 -33
- package/dist/esm/api/resources/taskGroups/client/Client.mjs +0 -133
- package/dist/esm/api/resources/taskGroups/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/taskGroups/resources/index.d.mts +1 -1
- package/dist/esm/api/resources/taskGroups/resources/index.mjs +1 -1
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/Client.d.mts +44 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/Client.mjs +187 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/index.mjs +1 -1
- package/dist/esm/api/resources/taskGroups/{client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.d.mts → resources/s3Object/client/requests/BodyPostTaskGroupsS3ObjectAddV1OortTaskGroupsS3ObjectAddV1TaskGroupIdPost.d.mts} +2 -2
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/requests/BodyPostTaskGroupsS3ObjectAddV1OortTaskGroupsS3ObjectAddV1TaskGroupIdPost.mjs +4 -0
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/requests/index.d.mts +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 +578 -213
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/UpdateTaskGroupDraftReq.d.ts +0 -13
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.d.ts +0 -47
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.js +0 -127
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.js +0 -17
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.d.ts +0 -47
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.js +0 -127
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/index.d.ts +0 -1
- package/dist/cjs/api/resources/taskGroups/resources/s3ObjectMetadata/index.js +0 -17
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/UpdateTaskGroupDraftReq.d.mts +0 -13
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.d.mts +0 -47
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.mjs +0 -90
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/index.d.mts +0 -1
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.d.mts +0 -1
- package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.mjs +0 -1
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.d.mts +0 -47
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.mjs +0 -90
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/client/index.d.mts +0 -1
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/index.d.mts +0 -1
- package/dist/esm/api/resources/taskGroups/resources/s3ObjectMetadata/index.mjs +0 -1
- /package/dist/cjs/api/resources/{orderDrafts/resources/taskGroup/client/requests/UpdateTaskGroupDraftReq.js → drivers/client/requests/DriversListOrgMembersAndDriversV1Request.js} +0 -0
- /package/dist/cjs/api/resources/{taskGroups/client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.js → drivers/client/requests/DriversListV1Request.js} +0 -0
- /package/dist/cjs/api/resources/taskArtifacts/resources/{s3ObjectMetadata/client → s3Object/client/requests}/index.js +0 -0
- /package/dist/cjs/api/resources/taskGroups/resources/{s3ObjectMetadata/client → s3Object/client/requests}/index.js +0 -0
- /package/dist/esm/api/resources/{orderDrafts/resources/taskGroup/client/requests/UpdateTaskGroupDraftReq.mjs → drivers/client/requests/DriversListOrgMembersAndDriversV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/{taskGroups/client/requests/BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost.mjs → drivers/client/requests/DriversListV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/taskArtifacts/resources/{s3ObjectMetadata/client → s3Object/client/requests}/index.mjs +0 -0
- /package/dist/esm/api/resources/taskGroups/resources/{s3ObjectMetadata/client → s3Object/client/requests}/index.mjs +0 -0
package/reference.md
CHANGED
|
@@ -4474,7 +4474,7 @@ await client.drivers.getByDriverIdV1("driver_id");
|
|
|
4474
4474
|
</dl>
|
|
4475
4475
|
</details>
|
|
4476
4476
|
|
|
4477
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>() -> Chrt.OrgMembersAndDrivers[]</code></summary>
|
|
4477
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>({ ...params }) -> Chrt.OrgMembersAndDrivers[]</code></summary>
|
|
4478
4478
|
<dl>
|
|
4479
4479
|
<dd>
|
|
4480
4480
|
|
|
@@ -4486,7 +4486,7 @@ await client.drivers.getByDriverIdV1("driver_id");
|
|
|
4486
4486
|
<dl>
|
|
4487
4487
|
<dd>
|
|
4488
4488
|
|
|
4489
|
-
Lists all organization members paired with their driver information if they are drivers. | () -> (list[OrgMembersAndDrivers])
|
|
4489
|
+
Lists all organization members paired with their driver information if they are drivers. Filter by availability. | () -> (list[OrgMembersAndDrivers])
|
|
4490
4490
|
|
|
4491
4491
|
</dd>
|
|
4492
4492
|
</dl>
|
|
@@ -4502,7 +4502,10 @@ Lists all organization members paired with their driver information if they are
|
|
|
4502
4502
|
<dd>
|
|
4503
4503
|
|
|
4504
4504
|
```typescript
|
|
4505
|
-
await client.drivers.listOrgMembersAndDriversV1(
|
|
4505
|
+
await client.drivers.listOrgMembersAndDriversV1({
|
|
4506
|
+
available_according_to_driver: true,
|
|
4507
|
+
available_according_to_operators: true,
|
|
4508
|
+
});
|
|
4506
4509
|
```
|
|
4507
4510
|
|
|
4508
4511
|
</dd>
|
|
@@ -4518,6 +4521,14 @@ await client.drivers.listOrgMembersAndDriversV1();
|
|
|
4518
4521
|
<dl>
|
|
4519
4522
|
<dd>
|
|
4520
4523
|
|
|
4524
|
+
**request:** `Chrt.DriversListOrgMembersAndDriversV1Request`
|
|
4525
|
+
|
|
4526
|
+
</dd>
|
|
4527
|
+
</dl>
|
|
4528
|
+
|
|
4529
|
+
<dl>
|
|
4530
|
+
<dd>
|
|
4531
|
+
|
|
4521
4532
|
**requestOptions:** `Drivers.RequestOptions`
|
|
4522
4533
|
|
|
4523
4534
|
</dd>
|
|
@@ -4529,7 +4540,7 @@ await client.drivers.listOrgMembersAndDriversV1();
|
|
|
4529
4540
|
</dl>
|
|
4530
4541
|
</details>
|
|
4531
4542
|
|
|
4532
|
-
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listV1</a>() -> Chrt.Driver1[]</code></summary>
|
|
4543
|
+
<details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listV1</a>({ ...params }) -> Chrt.Driver1[]</code></summary>
|
|
4533
4544
|
<dl>
|
|
4534
4545
|
<dd>
|
|
4535
4546
|
|
|
@@ -4541,7 +4552,7 @@ await client.drivers.listOrgMembersAndDriversV1();
|
|
|
4541
4552
|
<dl>
|
|
4542
4553
|
<dd>
|
|
4543
4554
|
|
|
4544
|
-
Lists all drivers belonging to the caller's organization. | () -> (list[Driver1])
|
|
4555
|
+
Lists all drivers belonging to the caller's organization. Filter by availability. | () -> (list[Driver1])
|
|
4545
4556
|
|
|
4546
4557
|
</dd>
|
|
4547
4558
|
</dl>
|
|
@@ -4557,7 +4568,10 @@ Lists all drivers belonging to the caller's organization. | () -> (list[Driver1]
|
|
|
4557
4568
|
<dd>
|
|
4558
4569
|
|
|
4559
4570
|
```typescript
|
|
4560
|
-
await client.drivers.listV1(
|
|
4571
|
+
await client.drivers.listV1({
|
|
4572
|
+
available_according_to_driver: true,
|
|
4573
|
+
available_according_to_operators: true,
|
|
4574
|
+
});
|
|
4561
4575
|
```
|
|
4562
4576
|
|
|
4563
4577
|
</dd>
|
|
@@ -4573,6 +4587,14 @@ await client.drivers.listV1();
|
|
|
4573
4587
|
<dl>
|
|
4574
4588
|
<dd>
|
|
4575
4589
|
|
|
4590
|
+
**request:** `Chrt.DriversListV1Request`
|
|
4591
|
+
|
|
4592
|
+
</dd>
|
|
4593
|
+
</dl>
|
|
4594
|
+
|
|
4595
|
+
<dl>
|
|
4596
|
+
<dd>
|
|
4597
|
+
|
|
4576
4598
|
**requestOptions:** `Drivers.RequestOptions`
|
|
4577
4599
|
|
|
4578
4600
|
</dd>
|
|
@@ -6598,142 +6620,6 @@ await client.taskGroups.addMessageV1("task_group_id", {
|
|
|
6598
6620
|
</dl>
|
|
6599
6621
|
</details>
|
|
6600
6622
|
|
|
6601
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">addS3ObjectV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6602
|
-
<dl>
|
|
6603
|
-
<dd>
|
|
6604
|
-
|
|
6605
|
-
#### 📝 Description
|
|
6606
|
-
|
|
6607
|
-
<dl>
|
|
6608
|
-
<dd>
|
|
6609
|
-
|
|
6610
|
-
<dl>
|
|
6611
|
-
<dd>
|
|
6612
|
-
|
|
6613
|
-
Uploads an image file to a task group with automatic blurhash generation. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
6614
|
-
|
|
6615
|
-
</dd>
|
|
6616
|
-
</dl>
|
|
6617
|
-
</dd>
|
|
6618
|
-
</dl>
|
|
6619
|
-
|
|
6620
|
-
#### 🔌 Usage
|
|
6621
|
-
|
|
6622
|
-
<dl>
|
|
6623
|
-
<dd>
|
|
6624
|
-
|
|
6625
|
-
<dl>
|
|
6626
|
-
<dd>
|
|
6627
|
-
|
|
6628
|
-
```typescript
|
|
6629
|
-
await client.taskGroups.addS3ObjectV1("task_group_id", {
|
|
6630
|
-
image: fs.createReadStream("/path/to/your/file"),
|
|
6631
|
-
});
|
|
6632
|
-
```
|
|
6633
|
-
|
|
6634
|
-
</dd>
|
|
6635
|
-
</dl>
|
|
6636
|
-
</dd>
|
|
6637
|
-
</dl>
|
|
6638
|
-
|
|
6639
|
-
#### ⚙️ Parameters
|
|
6640
|
-
|
|
6641
|
-
<dl>
|
|
6642
|
-
<dd>
|
|
6643
|
-
|
|
6644
|
-
<dl>
|
|
6645
|
-
<dd>
|
|
6646
|
-
|
|
6647
|
-
**taskGroupId:** `string`
|
|
6648
|
-
|
|
6649
|
-
</dd>
|
|
6650
|
-
</dl>
|
|
6651
|
-
|
|
6652
|
-
<dl>
|
|
6653
|
-
<dd>
|
|
6654
|
-
|
|
6655
|
-
**request:** `Chrt.BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost`
|
|
6656
|
-
|
|
6657
|
-
</dd>
|
|
6658
|
-
</dl>
|
|
6659
|
-
|
|
6660
|
-
<dl>
|
|
6661
|
-
<dd>
|
|
6662
|
-
|
|
6663
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6664
|
-
|
|
6665
|
-
</dd>
|
|
6666
|
-
</dl>
|
|
6667
|
-
</dd>
|
|
6668
|
-
</dl>
|
|
6669
|
-
|
|
6670
|
-
</dd>
|
|
6671
|
-
</dl>
|
|
6672
|
-
</details>
|
|
6673
|
-
|
|
6674
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">deleteS3ObjectV1</a>(taskGroupS3ObjectMetadataId) -> boolean</code></summary>
|
|
6675
|
-
<dl>
|
|
6676
|
-
<dd>
|
|
6677
|
-
|
|
6678
|
-
#### 📝 Description
|
|
6679
|
-
|
|
6680
|
-
<dl>
|
|
6681
|
-
<dd>
|
|
6682
|
-
|
|
6683
|
-
<dl>
|
|
6684
|
-
<dd>
|
|
6685
|
-
|
|
6686
|
-
Deletes an S3 object metadata and the associated S3 object from a task group. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
|
|
6687
|
-
|
|
6688
|
-
</dd>
|
|
6689
|
-
</dl>
|
|
6690
|
-
</dd>
|
|
6691
|
-
</dl>
|
|
6692
|
-
|
|
6693
|
-
#### 🔌 Usage
|
|
6694
|
-
|
|
6695
|
-
<dl>
|
|
6696
|
-
<dd>
|
|
6697
|
-
|
|
6698
|
-
<dl>
|
|
6699
|
-
<dd>
|
|
6700
|
-
|
|
6701
|
-
```typescript
|
|
6702
|
-
await client.taskGroups.deleteS3ObjectV1("task_group_s3_object_metadata_id");
|
|
6703
|
-
```
|
|
6704
|
-
|
|
6705
|
-
</dd>
|
|
6706
|
-
</dl>
|
|
6707
|
-
</dd>
|
|
6708
|
-
</dl>
|
|
6709
|
-
|
|
6710
|
-
#### ⚙️ Parameters
|
|
6711
|
-
|
|
6712
|
-
<dl>
|
|
6713
|
-
<dd>
|
|
6714
|
-
|
|
6715
|
-
<dl>
|
|
6716
|
-
<dd>
|
|
6717
|
-
|
|
6718
|
-
**taskGroupS3ObjectMetadataId:** `string`
|
|
6719
|
-
|
|
6720
|
-
</dd>
|
|
6721
|
-
</dl>
|
|
6722
|
-
|
|
6723
|
-
<dl>
|
|
6724
|
-
<dd>
|
|
6725
|
-
|
|
6726
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6727
|
-
|
|
6728
|
-
</dd>
|
|
6729
|
-
</dl>
|
|
6730
|
-
</dd>
|
|
6731
|
-
</dl>
|
|
6732
|
-
|
|
6733
|
-
</dd>
|
|
6734
|
-
</dl>
|
|
6735
|
-
</details>
|
|
6736
|
-
|
|
6737
6623
|
## Tasks
|
|
6738
6624
|
|
|
6739
6625
|
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">addToTaskGroupV1</a>(taskGroupId, { ...params }) -> string</code></summary>
|
|
@@ -9312,7 +9198,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
9312
9198
|
</dl>
|
|
9313
9199
|
</details>
|
|
9314
9200
|
|
|
9315
|
-
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">
|
|
9201
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">setFlightNumberV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
9316
9202
|
<dl>
|
|
9317
9203
|
<dd>
|
|
9318
9204
|
|
|
@@ -9324,7 +9210,7 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
9324
9210
|
<dl>
|
|
9325
9211
|
<dd>
|
|
9326
9212
|
|
|
9327
|
-
Sets
|
|
9213
|
+
Sets the flight number on a draft task group. | (SetFlightNumberDraftReq) -> (bool)
|
|
9328
9214
|
|
|
9329
9215
|
</dd>
|
|
9330
9216
|
</dl>
|
|
@@ -9340,7 +9226,9 @@ Sets or removes courier org. Sets task ordering (must provide all task ids). | (
|
|
|
9340
9226
|
<dd>
|
|
9341
9227
|
|
|
9342
9228
|
```typescript
|
|
9343
|
-
await client.orderDrafts.taskGroup.
|
|
9229
|
+
await client.orderDrafts.taskGroup.setFlightNumberV1("task_group_id", {
|
|
9230
|
+
flight_number: "flight_number",
|
|
9231
|
+
});
|
|
9344
9232
|
```
|
|
9345
9233
|
|
|
9346
9234
|
</dd>
|
|
@@ -9364,7 +9252,7 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
9364
9252
|
<dl>
|
|
9365
9253
|
<dd>
|
|
9366
9254
|
|
|
9367
|
-
**request:** `Chrt.orderDrafts.
|
|
9255
|
+
**request:** `Chrt.orderDrafts.SetFlightNumberDraftReq`
|
|
9368
9256
|
|
|
9369
9257
|
</dd>
|
|
9370
9258
|
</dl>
|
|
@@ -9383,7 +9271,7 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
9383
9271
|
</dl>
|
|
9384
9272
|
</details>
|
|
9385
9273
|
|
|
9386
|
-
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">
|
|
9274
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">updateCourierOrgV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
9387
9275
|
<dl>
|
|
9388
9276
|
<dd>
|
|
9389
9277
|
|
|
@@ -9395,7 +9283,7 @@ await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
|
9395
9283
|
<dl>
|
|
9396
9284
|
<dd>
|
|
9397
9285
|
|
|
9398
|
-
|
|
9286
|
+
Updates the courier organization assigned to a draft task group. | (UpdateCourierOrgDraftReq) -> (bool)
|
|
9399
9287
|
|
|
9400
9288
|
</dd>
|
|
9401
9289
|
</dl>
|
|
@@ -9411,7 +9299,9 @@ Deletes a task group and all associated entities (tasks, task artifacts, S3 meta
|
|
|
9411
9299
|
<dd>
|
|
9412
9300
|
|
|
9413
9301
|
```typescript
|
|
9414
|
-
await client.orderDrafts.taskGroup.
|
|
9302
|
+
await client.orderDrafts.taskGroup.updateCourierOrgV1("task_group_id", {
|
|
9303
|
+
courier_org_id: "courier_org_id",
|
|
9304
|
+
});
|
|
9415
9305
|
```
|
|
9416
9306
|
|
|
9417
9307
|
</dd>
|
|
@@ -9435,6 +9325,14 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
9435
9325
|
<dl>
|
|
9436
9326
|
<dd>
|
|
9437
9327
|
|
|
9328
|
+
**request:** `Chrt.orderDrafts.UpdateCourierOrgDraftReq`
|
|
9329
|
+
|
|
9330
|
+
</dd>
|
|
9331
|
+
</dl>
|
|
9332
|
+
|
|
9333
|
+
<dl>
|
|
9334
|
+
<dd>
|
|
9335
|
+
|
|
9438
9336
|
**requestOptions:** `TaskGroup.RequestOptions`
|
|
9439
9337
|
|
|
9440
9338
|
</dd>
|
|
@@ -9446,9 +9344,7 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
9446
9344
|
</dl>
|
|
9447
9345
|
</details>
|
|
9448
9346
|
|
|
9449
|
-
|
|
9450
|
-
|
|
9451
|
-
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9347
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">removeCourierOrgV1</a>(taskGroupId) -> boolean</code></summary>
|
|
9452
9348
|
<dl>
|
|
9453
9349
|
<dd>
|
|
9454
9350
|
|
|
@@ -9460,7 +9356,7 @@ await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
|
9460
9356
|
<dl>
|
|
9461
9357
|
<dd>
|
|
9462
9358
|
|
|
9463
|
-
|
|
9359
|
+
Removes the courier organization from a draft task group (sets courier_org_id to null). | () -> (bool)
|
|
9464
9360
|
|
|
9465
9361
|
</dd>
|
|
9466
9362
|
</dl>
|
|
@@ -9476,12 +9372,7 @@ Adds a task to an existing task group in a draft order. Validates order is in DR
|
|
|
9476
9372
|
<dd>
|
|
9477
9373
|
|
|
9478
9374
|
```typescript
|
|
9479
|
-
await client.orderDrafts.
|
|
9480
|
-
task_group_id: "task_group_id",
|
|
9481
|
-
task: {
|
|
9482
|
-
schema_version: 1,
|
|
9483
|
-
},
|
|
9484
|
-
});
|
|
9375
|
+
await client.orderDrafts.taskGroup.removeCourierOrgV1("task_group_id");
|
|
9485
9376
|
```
|
|
9486
9377
|
|
|
9487
9378
|
</dd>
|
|
@@ -9497,7 +9388,7 @@ await client.orderDrafts.task.addV1({
|
|
|
9497
9388
|
<dl>
|
|
9498
9389
|
<dd>
|
|
9499
9390
|
|
|
9500
|
-
**
|
|
9391
|
+
**taskGroupId:** `string`
|
|
9501
9392
|
|
|
9502
9393
|
</dd>
|
|
9503
9394
|
</dl>
|
|
@@ -9505,7 +9396,7 @@ await client.orderDrafts.task.addV1({
|
|
|
9505
9396
|
<dl>
|
|
9506
9397
|
<dd>
|
|
9507
9398
|
|
|
9508
|
-
**requestOptions:** `
|
|
9399
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
9509
9400
|
|
|
9510
9401
|
</dd>
|
|
9511
9402
|
</dl>
|
|
@@ -9516,7 +9407,7 @@ await client.orderDrafts.task.addV1({
|
|
|
9516
9407
|
</dl>
|
|
9517
9408
|
</details>
|
|
9518
9409
|
|
|
9519
|
-
<details><summary><code>client.orderDrafts.
|
|
9410
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
9520
9411
|
<dl>
|
|
9521
9412
|
<dd>
|
|
9522
9413
|
|
|
@@ -9528,7 +9419,7 @@ await client.orderDrafts.task.addV1({
|
|
|
9528
9419
|
<dl>
|
|
9529
9420
|
<dd>
|
|
9530
9421
|
|
|
9531
|
-
|
|
9422
|
+
Sets the ordering of tasks within a draft task group. Must provide all task IDs with no duplicates. | (SetTaskOrderingDraftReq) -> (bool)
|
|
9532
9423
|
|
|
9533
9424
|
</dd>
|
|
9534
9425
|
</dl>
|
|
@@ -9544,9 +9435,8 @@ Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (Pydan
|
|
|
9544
9435
|
<dd>
|
|
9545
9436
|
|
|
9546
9437
|
```typescript
|
|
9547
|
-
await client.orderDrafts.
|
|
9548
|
-
|
|
9549
|
-
task_update: {},
|
|
9438
|
+
await client.orderDrafts.taskGroup.setTaskOrderingV1("task_group_id", {
|
|
9439
|
+
task_ids: ["task_ids"],
|
|
9550
9440
|
});
|
|
9551
9441
|
```
|
|
9552
9442
|
|
|
@@ -9563,7 +9453,7 @@ await client.orderDrafts.task.updateV1({
|
|
|
9563
9453
|
<dl>
|
|
9564
9454
|
<dd>
|
|
9565
9455
|
|
|
9566
|
-
**
|
|
9456
|
+
**taskGroupId:** `string`
|
|
9567
9457
|
|
|
9568
9458
|
</dd>
|
|
9569
9459
|
</dl>
|
|
@@ -9571,7 +9461,15 @@ await client.orderDrafts.task.updateV1({
|
|
|
9571
9461
|
<dl>
|
|
9572
9462
|
<dd>
|
|
9573
9463
|
|
|
9574
|
-
**
|
|
9464
|
+
**request:** `Chrt.orderDrafts.SetTaskOrderingDraftReq`
|
|
9465
|
+
|
|
9466
|
+
</dd>
|
|
9467
|
+
</dl>
|
|
9468
|
+
|
|
9469
|
+
<dl>
|
|
9470
|
+
<dd>
|
|
9471
|
+
|
|
9472
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
9575
9473
|
|
|
9576
9474
|
</dd>
|
|
9577
9475
|
</dl>
|
|
@@ -9582,7 +9480,7 @@ await client.orderDrafts.task.updateV1({
|
|
|
9582
9480
|
</dl>
|
|
9583
9481
|
</details>
|
|
9584
9482
|
|
|
9585
|
-
<details><summary><code>client.orderDrafts.
|
|
9483
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">deleteV1</a>(taskGroupId) -> boolean</code></summary>
|
|
9586
9484
|
<dl>
|
|
9587
9485
|
<dd>
|
|
9588
9486
|
|
|
@@ -9594,7 +9492,7 @@ await client.orderDrafts.task.updateV1({
|
|
|
9594
9492
|
<dl>
|
|
9595
9493
|
<dd>
|
|
9596
9494
|
|
|
9597
|
-
Deletes a task
|
|
9495
|
+
Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order. | () -> (bool)
|
|
9598
9496
|
|
|
9599
9497
|
</dd>
|
|
9600
9498
|
</dl>
|
|
@@ -9610,7 +9508,7 @@ Deletes a task from a draft order, including all task artifacts. Cargo is preser
|
|
|
9610
9508
|
<dd>
|
|
9611
9509
|
|
|
9612
9510
|
```typescript
|
|
9613
|
-
await client.orderDrafts.
|
|
9511
|
+
await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
9614
9512
|
```
|
|
9615
9513
|
|
|
9616
9514
|
</dd>
|
|
@@ -9626,7 +9524,7 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
9626
9524
|
<dl>
|
|
9627
9525
|
<dd>
|
|
9628
9526
|
|
|
9629
|
-
**
|
|
9527
|
+
**taskGroupId:** `string`
|
|
9630
9528
|
|
|
9631
9529
|
</dd>
|
|
9632
9530
|
</dl>
|
|
@@ -9634,7 +9532,7 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
9634
9532
|
<dl>
|
|
9635
9533
|
<dd>
|
|
9636
9534
|
|
|
9637
|
-
**requestOptions:** `
|
|
9535
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
9638
9536
|
|
|
9639
9537
|
</dd>
|
|
9640
9538
|
</dl>
|
|
@@ -9645,9 +9543,9 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
9645
9543
|
</dl>
|
|
9646
9544
|
</details>
|
|
9647
9545
|
|
|
9648
|
-
## OrderDrafts
|
|
9546
|
+
## OrderDrafts Task
|
|
9649
9547
|
|
|
9650
|
-
<details><summary><code>client.orderDrafts.
|
|
9548
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9651
9549
|
<dl>
|
|
9652
9550
|
<dd>
|
|
9653
9551
|
|
|
@@ -9659,7 +9557,7 @@ await client.orderDrafts.task.deleteV1("task_id");
|
|
|
9659
9557
|
<dl>
|
|
9660
9558
|
<dd>
|
|
9661
9559
|
|
|
9662
|
-
Adds a task
|
|
9560
|
+
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)
|
|
9663
9561
|
|
|
9664
9562
|
</dd>
|
|
9665
9563
|
</dl>
|
|
@@ -9675,9 +9573,11 @@ Adds a task artifact to an existing task in a draft order. | (OrderDraftAddTaskA
|
|
|
9675
9573
|
<dd>
|
|
9676
9574
|
|
|
9677
9575
|
```typescript
|
|
9678
|
-
await client.orderDrafts.
|
|
9679
|
-
|
|
9680
|
-
|
|
9576
|
+
await client.orderDrafts.task.addV1({
|
|
9577
|
+
task_group_id: "task_group_id",
|
|
9578
|
+
task: {
|
|
9579
|
+
schema_version: 1,
|
|
9580
|
+
},
|
|
9681
9581
|
});
|
|
9682
9582
|
```
|
|
9683
9583
|
|
|
@@ -9694,7 +9594,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
9694
9594
|
<dl>
|
|
9695
9595
|
<dd>
|
|
9696
9596
|
|
|
9697
|
-
**request:** `Chrt.orderDrafts.
|
|
9597
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskReqV1`
|
|
9698
9598
|
|
|
9699
9599
|
</dd>
|
|
9700
9600
|
</dl>
|
|
@@ -9702,7 +9602,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
9702
9602
|
<dl>
|
|
9703
9603
|
<dd>
|
|
9704
9604
|
|
|
9705
|
-
**requestOptions:** `
|
|
9605
|
+
**requestOptions:** `Task.RequestOptions`
|
|
9706
9606
|
|
|
9707
9607
|
</dd>
|
|
9708
9608
|
</dl>
|
|
@@ -9713,7 +9613,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
9713
9613
|
</dl>
|
|
9714
9614
|
</details>
|
|
9715
9615
|
|
|
9716
|
-
<details><summary><code>client.orderDrafts.
|
|
9616
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">updateV1</a>({ ...params }) -> string</code></summary>
|
|
9717
9617
|
<dl>
|
|
9718
9618
|
<dd>
|
|
9719
9619
|
|
|
@@ -9725,7 +9625,7 @@ await client.orderDrafts.taskArtifact.addV1({
|
|
|
9725
9625
|
<dl>
|
|
9726
9626
|
<dd>
|
|
9727
9627
|
|
|
9728
|
-
|
|
9628
|
+
Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (PydanticObjectId)
|
|
9729
9629
|
|
|
9730
9630
|
</dd>
|
|
9731
9631
|
</dl>
|
|
@@ -9741,7 +9641,10 @@ Deletes a task artifact from a draft order and removes it from the associated ta
|
|
|
9741
9641
|
<dd>
|
|
9742
9642
|
|
|
9743
9643
|
```typescript
|
|
9744
|
-
await client.orderDrafts.
|
|
9644
|
+
await client.orderDrafts.task.updateV1({
|
|
9645
|
+
task_id: "task_id",
|
|
9646
|
+
task_update: {},
|
|
9647
|
+
});
|
|
9745
9648
|
```
|
|
9746
9649
|
|
|
9747
9650
|
</dd>
|
|
@@ -9757,7 +9660,7 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
9757
9660
|
<dl>
|
|
9758
9661
|
<dd>
|
|
9759
9662
|
|
|
9760
|
-
**
|
|
9663
|
+
**request:** `Chrt.orderDrafts.OrderDraftUpdateTaskReq`
|
|
9761
9664
|
|
|
9762
9665
|
</dd>
|
|
9763
9666
|
</dl>
|
|
@@ -9765,7 +9668,7 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
9765
9668
|
<dl>
|
|
9766
9669
|
<dd>
|
|
9767
9670
|
|
|
9768
|
-
**requestOptions:** `
|
|
9671
|
+
**requestOptions:** `Task.RequestOptions`
|
|
9769
9672
|
|
|
9770
9673
|
</dd>
|
|
9771
9674
|
</dl>
|
|
@@ -9776,9 +9679,7 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
9776
9679
|
</dl>
|
|
9777
9680
|
</details>
|
|
9778
9681
|
|
|
9779
|
-
|
|
9780
|
-
|
|
9781
|
-
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9682
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
|
|
9782
9683
|
<dl>
|
|
9783
9684
|
<dd>
|
|
9784
9685
|
|
|
@@ -9790,7 +9691,7 @@ await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
|
9790
9691
|
<dl>
|
|
9791
9692
|
<dd>
|
|
9792
9693
|
|
|
9793
|
-
|
|
9694
|
+
Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group. | () -> (bool)
|
|
9794
9695
|
|
|
9795
9696
|
</dd>
|
|
9796
9697
|
</dl>
|
|
@@ -9806,13 +9707,7 @@ Adds a cargo item to an existing draft order. Validates order is in DRAFT status
|
|
|
9806
9707
|
<dd>
|
|
9807
9708
|
|
|
9808
9709
|
```typescript
|
|
9809
|
-
await client.orderDrafts.
|
|
9810
|
-
order_id: "order_id",
|
|
9811
|
-
cargo: {
|
|
9812
|
-
schema_version: 1,
|
|
9813
|
-
cargo_type: "spare_parts",
|
|
9814
|
-
},
|
|
9815
|
-
});
|
|
9710
|
+
await client.orderDrafts.task.deleteV1("task_id");
|
|
9816
9711
|
```
|
|
9817
9712
|
|
|
9818
9713
|
</dd>
|
|
@@ -9828,7 +9723,7 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9828
9723
|
<dl>
|
|
9829
9724
|
<dd>
|
|
9830
9725
|
|
|
9831
|
-
**
|
|
9726
|
+
**taskId:** `string`
|
|
9832
9727
|
|
|
9833
9728
|
</dd>
|
|
9834
9729
|
</dl>
|
|
@@ -9836,7 +9731,7 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9836
9731
|
<dl>
|
|
9837
9732
|
<dd>
|
|
9838
9733
|
|
|
9839
|
-
**requestOptions:** `
|
|
9734
|
+
**requestOptions:** `Task.RequestOptions`
|
|
9840
9735
|
|
|
9841
9736
|
</dd>
|
|
9842
9737
|
</dl>
|
|
@@ -9847,7 +9742,9 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9847
9742
|
</dl>
|
|
9848
9743
|
</details>
|
|
9849
9744
|
|
|
9850
|
-
|
|
9745
|
+
## OrderDrafts TaskArtifact
|
|
9746
|
+
|
|
9747
|
+
<details><summary><code>client.orderDrafts.taskArtifact.<a href="/src/api/resources/orderDrafts/resources/taskArtifact/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9851
9748
|
<dl>
|
|
9852
9749
|
<dd>
|
|
9853
9750
|
|
|
@@ -9859,7 +9756,207 @@ await client.orderDrafts.cargo.addV1({
|
|
|
9859
9756
|
<dl>
|
|
9860
9757
|
<dd>
|
|
9861
9758
|
|
|
9862
|
-
|
|
9759
|
+
Adds a task artifact to an existing task in a draft order. | (OrderDraftAddTaskArtifactReq) -> (PydanticObjectId)
|
|
9760
|
+
|
|
9761
|
+
</dd>
|
|
9762
|
+
</dl>
|
|
9763
|
+
</dd>
|
|
9764
|
+
</dl>
|
|
9765
|
+
|
|
9766
|
+
#### 🔌 Usage
|
|
9767
|
+
|
|
9768
|
+
<dl>
|
|
9769
|
+
<dd>
|
|
9770
|
+
|
|
9771
|
+
<dl>
|
|
9772
|
+
<dd>
|
|
9773
|
+
|
|
9774
|
+
```typescript
|
|
9775
|
+
await client.orderDrafts.taskArtifact.addV1({
|
|
9776
|
+
task_id: "task_id",
|
|
9777
|
+
task_artifact_type: "image",
|
|
9778
|
+
});
|
|
9779
|
+
```
|
|
9780
|
+
|
|
9781
|
+
</dd>
|
|
9782
|
+
</dl>
|
|
9783
|
+
</dd>
|
|
9784
|
+
</dl>
|
|
9785
|
+
|
|
9786
|
+
#### ⚙️ Parameters
|
|
9787
|
+
|
|
9788
|
+
<dl>
|
|
9789
|
+
<dd>
|
|
9790
|
+
|
|
9791
|
+
<dl>
|
|
9792
|
+
<dd>
|
|
9793
|
+
|
|
9794
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskArtifactReq`
|
|
9795
|
+
|
|
9796
|
+
</dd>
|
|
9797
|
+
</dl>
|
|
9798
|
+
|
|
9799
|
+
<dl>
|
|
9800
|
+
<dd>
|
|
9801
|
+
|
|
9802
|
+
**requestOptions:** `TaskArtifact.RequestOptions`
|
|
9803
|
+
|
|
9804
|
+
</dd>
|
|
9805
|
+
</dl>
|
|
9806
|
+
</dd>
|
|
9807
|
+
</dl>
|
|
9808
|
+
|
|
9809
|
+
</dd>
|
|
9810
|
+
</dl>
|
|
9811
|
+
</details>
|
|
9812
|
+
|
|
9813
|
+
<details><summary><code>client.orderDrafts.taskArtifact.<a href="/src/api/resources/orderDrafts/resources/taskArtifact/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
9814
|
+
<dl>
|
|
9815
|
+
<dd>
|
|
9816
|
+
|
|
9817
|
+
#### 📝 Description
|
|
9818
|
+
|
|
9819
|
+
<dl>
|
|
9820
|
+
<dd>
|
|
9821
|
+
|
|
9822
|
+
<dl>
|
|
9823
|
+
<dd>
|
|
9824
|
+
|
|
9825
|
+
Deletes a task artifact from a draft order and removes it from the associated task. | () -> (bool)
|
|
9826
|
+
|
|
9827
|
+
</dd>
|
|
9828
|
+
</dl>
|
|
9829
|
+
</dd>
|
|
9830
|
+
</dl>
|
|
9831
|
+
|
|
9832
|
+
#### 🔌 Usage
|
|
9833
|
+
|
|
9834
|
+
<dl>
|
|
9835
|
+
<dd>
|
|
9836
|
+
|
|
9837
|
+
<dl>
|
|
9838
|
+
<dd>
|
|
9839
|
+
|
|
9840
|
+
```typescript
|
|
9841
|
+
await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
9842
|
+
```
|
|
9843
|
+
|
|
9844
|
+
</dd>
|
|
9845
|
+
</dl>
|
|
9846
|
+
</dd>
|
|
9847
|
+
</dl>
|
|
9848
|
+
|
|
9849
|
+
#### ⚙️ Parameters
|
|
9850
|
+
|
|
9851
|
+
<dl>
|
|
9852
|
+
<dd>
|
|
9853
|
+
|
|
9854
|
+
<dl>
|
|
9855
|
+
<dd>
|
|
9856
|
+
|
|
9857
|
+
**taskArtifactId:** `string`
|
|
9858
|
+
|
|
9859
|
+
</dd>
|
|
9860
|
+
</dl>
|
|
9861
|
+
|
|
9862
|
+
<dl>
|
|
9863
|
+
<dd>
|
|
9864
|
+
|
|
9865
|
+
**requestOptions:** `TaskArtifact.RequestOptions`
|
|
9866
|
+
|
|
9867
|
+
</dd>
|
|
9868
|
+
</dl>
|
|
9869
|
+
</dd>
|
|
9870
|
+
</dl>
|
|
9871
|
+
|
|
9872
|
+
</dd>
|
|
9873
|
+
</dl>
|
|
9874
|
+
</details>
|
|
9875
|
+
|
|
9876
|
+
## OrderDrafts Cargo
|
|
9877
|
+
|
|
9878
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
9879
|
+
<dl>
|
|
9880
|
+
<dd>
|
|
9881
|
+
|
|
9882
|
+
#### 📝 Description
|
|
9883
|
+
|
|
9884
|
+
<dl>
|
|
9885
|
+
<dd>
|
|
9886
|
+
|
|
9887
|
+
<dl>
|
|
9888
|
+
<dd>
|
|
9889
|
+
|
|
9890
|
+
Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddCargoReq) -> (PydanticObjectId)
|
|
9891
|
+
|
|
9892
|
+
</dd>
|
|
9893
|
+
</dl>
|
|
9894
|
+
</dd>
|
|
9895
|
+
</dl>
|
|
9896
|
+
|
|
9897
|
+
#### 🔌 Usage
|
|
9898
|
+
|
|
9899
|
+
<dl>
|
|
9900
|
+
<dd>
|
|
9901
|
+
|
|
9902
|
+
<dl>
|
|
9903
|
+
<dd>
|
|
9904
|
+
|
|
9905
|
+
```typescript
|
|
9906
|
+
await client.orderDrafts.cargo.addV1({
|
|
9907
|
+
order_id: "order_id",
|
|
9908
|
+
cargo: {
|
|
9909
|
+
schema_version: 1,
|
|
9910
|
+
cargo_type: "spare_parts",
|
|
9911
|
+
},
|
|
9912
|
+
});
|
|
9913
|
+
```
|
|
9914
|
+
|
|
9915
|
+
</dd>
|
|
9916
|
+
</dl>
|
|
9917
|
+
</dd>
|
|
9918
|
+
</dl>
|
|
9919
|
+
|
|
9920
|
+
#### ⚙️ Parameters
|
|
9921
|
+
|
|
9922
|
+
<dl>
|
|
9923
|
+
<dd>
|
|
9924
|
+
|
|
9925
|
+
<dl>
|
|
9926
|
+
<dd>
|
|
9927
|
+
|
|
9928
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddCargoReq`
|
|
9929
|
+
|
|
9930
|
+
</dd>
|
|
9931
|
+
</dl>
|
|
9932
|
+
|
|
9933
|
+
<dl>
|
|
9934
|
+
<dd>
|
|
9935
|
+
|
|
9936
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
9937
|
+
|
|
9938
|
+
</dd>
|
|
9939
|
+
</dl>
|
|
9940
|
+
</dd>
|
|
9941
|
+
</dl>
|
|
9942
|
+
|
|
9943
|
+
</dd>
|
|
9944
|
+
</dl>
|
|
9945
|
+
</details>
|
|
9946
|
+
|
|
9947
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">associateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
9948
|
+
<dl>
|
|
9949
|
+
<dd>
|
|
9950
|
+
|
|
9951
|
+
#### 📝 Description
|
|
9952
|
+
|
|
9953
|
+
<dl>
|
|
9954
|
+
<dd>
|
|
9955
|
+
|
|
9956
|
+
<dl>
|
|
9957
|
+
<dd>
|
|
9958
|
+
|
|
9959
|
+
Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCargoWithTaskReq) -> (bool)
|
|
9863
9960
|
|
|
9864
9961
|
</dd>
|
|
9865
9962
|
</dl>
|
|
@@ -11432,9 +11529,9 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
11432
11529
|
</dl>
|
|
11433
11530
|
</details>
|
|
11434
11531
|
|
|
11435
|
-
## TaskArtifacts
|
|
11532
|
+
## TaskArtifacts S3Object
|
|
11436
11533
|
|
|
11437
|
-
<details><summary><code>client.taskArtifacts.
|
|
11534
|
+
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(taskArtifactS3ObjectMetadataId) -> Chrt.TaskArtifactS3ObjectMetadata1</code></summary>
|
|
11438
11535
|
<dl>
|
|
11439
11536
|
<dd>
|
|
11440
11537
|
|
|
@@ -11462,7 +11559,7 @@ Retrieves the metadata for a task artifact S3 object, including blurhash for pla
|
|
|
11462
11559
|
<dd>
|
|
11463
11560
|
|
|
11464
11561
|
```typescript
|
|
11465
|
-
await client.taskArtifacts.
|
|
11562
|
+
await client.taskArtifacts.s3Object.getS3ObjectMetadataV1("task_artifact_s3_object_metadata_id");
|
|
11466
11563
|
```
|
|
11467
11564
|
|
|
11468
11565
|
</dd>
|
|
@@ -11486,7 +11583,7 @@ await client.taskArtifacts.s3ObjectMetadata.getV1("task_artifact_s3_object_metad
|
|
|
11486
11583
|
<dl>
|
|
11487
11584
|
<dd>
|
|
11488
11585
|
|
|
11489
|
-
**requestOptions:** `
|
|
11586
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
11490
11587
|
|
|
11491
11588
|
</dd>
|
|
11492
11589
|
</dl>
|
|
@@ -11497,8 +11594,6 @@ await client.taskArtifacts.s3ObjectMetadata.getV1("task_artifact_s3_object_metad
|
|
|
11497
11594
|
</dl>
|
|
11498
11595
|
</details>
|
|
11499
11596
|
|
|
11500
|
-
## TaskArtifacts S3Object
|
|
11501
|
-
|
|
11502
11597
|
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) -> unknown</code></summary>
|
|
11503
11598
|
<dl>
|
|
11504
11599
|
<dd>
|
|
@@ -11562,6 +11657,142 @@ await client.taskArtifacts.s3Object.getV1("task_artifact_s3_object_metadata_id")
|
|
|
11562
11657
|
</dl>
|
|
11563
11658
|
</details>
|
|
11564
11659
|
|
|
11660
|
+
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">addV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
|
|
11661
|
+
<dl>
|
|
11662
|
+
<dd>
|
|
11663
|
+
|
|
11664
|
+
#### 📝 Description
|
|
11665
|
+
|
|
11666
|
+
<dl>
|
|
11667
|
+
<dd>
|
|
11668
|
+
|
|
11669
|
+
<dl>
|
|
11670
|
+
<dd>
|
|
11671
|
+
|
|
11672
|
+
Uploads an image file to a task artifact with automatic blurhash generation. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
11673
|
+
|
|
11674
|
+
</dd>
|
|
11675
|
+
</dl>
|
|
11676
|
+
</dd>
|
|
11677
|
+
</dl>
|
|
11678
|
+
|
|
11679
|
+
#### 🔌 Usage
|
|
11680
|
+
|
|
11681
|
+
<dl>
|
|
11682
|
+
<dd>
|
|
11683
|
+
|
|
11684
|
+
<dl>
|
|
11685
|
+
<dd>
|
|
11686
|
+
|
|
11687
|
+
```typescript
|
|
11688
|
+
await client.taskArtifacts.s3Object.addV1("task_artifact_id", {
|
|
11689
|
+
image: fs.createReadStream("/path/to/your/file"),
|
|
11690
|
+
});
|
|
11691
|
+
```
|
|
11692
|
+
|
|
11693
|
+
</dd>
|
|
11694
|
+
</dl>
|
|
11695
|
+
</dd>
|
|
11696
|
+
</dl>
|
|
11697
|
+
|
|
11698
|
+
#### ⚙️ Parameters
|
|
11699
|
+
|
|
11700
|
+
<dl>
|
|
11701
|
+
<dd>
|
|
11702
|
+
|
|
11703
|
+
<dl>
|
|
11704
|
+
<dd>
|
|
11705
|
+
|
|
11706
|
+
**taskArtifactId:** `string`
|
|
11707
|
+
|
|
11708
|
+
</dd>
|
|
11709
|
+
</dl>
|
|
11710
|
+
|
|
11711
|
+
<dl>
|
|
11712
|
+
<dd>
|
|
11713
|
+
|
|
11714
|
+
**request:** `Chrt.taskArtifacts.BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost`
|
|
11715
|
+
|
|
11716
|
+
</dd>
|
|
11717
|
+
</dl>
|
|
11718
|
+
|
|
11719
|
+
<dl>
|
|
11720
|
+
<dd>
|
|
11721
|
+
|
|
11722
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
11723
|
+
|
|
11724
|
+
</dd>
|
|
11725
|
+
</dl>
|
|
11726
|
+
</dd>
|
|
11727
|
+
</dl>
|
|
11728
|
+
|
|
11729
|
+
</dd>
|
|
11730
|
+
</dl>
|
|
11731
|
+
</details>
|
|
11732
|
+
|
|
11733
|
+
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">deleteV1</a>(taskArtifactS3ObjectMetadataId) -> boolean</code></summary>
|
|
11734
|
+
<dl>
|
|
11735
|
+
<dd>
|
|
11736
|
+
|
|
11737
|
+
#### 📝 Description
|
|
11738
|
+
|
|
11739
|
+
<dl>
|
|
11740
|
+
<dd>
|
|
11741
|
+
|
|
11742
|
+
<dl>
|
|
11743
|
+
<dd>
|
|
11744
|
+
|
|
11745
|
+
Deletes an S3 object metadata and the associated S3 object from a task artifact. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
|
|
11746
|
+
|
|
11747
|
+
</dd>
|
|
11748
|
+
</dl>
|
|
11749
|
+
</dd>
|
|
11750
|
+
</dl>
|
|
11751
|
+
|
|
11752
|
+
#### 🔌 Usage
|
|
11753
|
+
|
|
11754
|
+
<dl>
|
|
11755
|
+
<dd>
|
|
11756
|
+
|
|
11757
|
+
<dl>
|
|
11758
|
+
<dd>
|
|
11759
|
+
|
|
11760
|
+
```typescript
|
|
11761
|
+
await client.taskArtifacts.s3Object.deleteV1("task_artifact_s3_object_metadata_id");
|
|
11762
|
+
```
|
|
11763
|
+
|
|
11764
|
+
</dd>
|
|
11765
|
+
</dl>
|
|
11766
|
+
</dd>
|
|
11767
|
+
</dl>
|
|
11768
|
+
|
|
11769
|
+
#### ⚙️ Parameters
|
|
11770
|
+
|
|
11771
|
+
<dl>
|
|
11772
|
+
<dd>
|
|
11773
|
+
|
|
11774
|
+
<dl>
|
|
11775
|
+
<dd>
|
|
11776
|
+
|
|
11777
|
+
**taskArtifactS3ObjectMetadataId:** `string`
|
|
11778
|
+
|
|
11779
|
+
</dd>
|
|
11780
|
+
</dl>
|
|
11781
|
+
|
|
11782
|
+
<dl>
|
|
11783
|
+
<dd>
|
|
11784
|
+
|
|
11785
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
11786
|
+
|
|
11787
|
+
</dd>
|
|
11788
|
+
</dl>
|
|
11789
|
+
</dd>
|
|
11790
|
+
</dl>
|
|
11791
|
+
|
|
11792
|
+
</dd>
|
|
11793
|
+
</dl>
|
|
11794
|
+
</details>
|
|
11795
|
+
|
|
11565
11796
|
## TaskGroups TaskGroupId
|
|
11566
11797
|
|
|
11567
11798
|
<details><summary><code>client.taskGroups.taskGroupId.<a href="/src/api/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierOperatorsV1</a>(orderIdOrShortId) -> string</code></summary>
|
|
@@ -11690,9 +11921,9 @@ await client.taskGroups.taskGroupId.forCourierDriverV1("order_id_or_short_id");
|
|
|
11690
11921
|
</dl>
|
|
11691
11922
|
</details>
|
|
11692
11923
|
|
|
11693
|
-
## TaskGroups
|
|
11924
|
+
## TaskGroups S3Object
|
|
11694
11925
|
|
|
11695
|
-
<details><summary><code>client.taskGroups.
|
|
11926
|
+
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(taskGroupS3ObjectMetadataId) -> Chrt.TaskGroupS3ObjectMetadata1</code></summary>
|
|
11696
11927
|
<dl>
|
|
11697
11928
|
<dd>
|
|
11698
11929
|
|
|
@@ -11720,7 +11951,7 @@ Retrieves the metadata for a task group S3 object, including blurhash for placeh
|
|
|
11720
11951
|
<dd>
|
|
11721
11952
|
|
|
11722
11953
|
```typescript
|
|
11723
|
-
await client.taskGroups.
|
|
11954
|
+
await client.taskGroups.s3Object.getS3ObjectMetadataV1("task_group_s3_object_metadata_id");
|
|
11724
11955
|
```
|
|
11725
11956
|
|
|
11726
11957
|
</dd>
|
|
@@ -11744,7 +11975,7 @@ await client.taskGroups.s3ObjectMetadata.getV1("task_group_s3_object_metadata_id
|
|
|
11744
11975
|
<dl>
|
|
11745
11976
|
<dd>
|
|
11746
11977
|
|
|
11747
|
-
**requestOptions:** `
|
|
11978
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
11748
11979
|
|
|
11749
11980
|
</dd>
|
|
11750
11981
|
</dl>
|
|
@@ -11755,8 +11986,6 @@ await client.taskGroups.s3ObjectMetadata.getV1("task_group_s3_object_metadata_id
|
|
|
11755
11986
|
</dl>
|
|
11756
11987
|
</details>
|
|
11757
11988
|
|
|
11758
|
-
## TaskGroups S3Object
|
|
11759
|
-
|
|
11760
11989
|
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) -> unknown</code></summary>
|
|
11761
11990
|
<dl>
|
|
11762
11991
|
<dd>
|
|
@@ -11820,6 +12049,142 @@ await client.taskGroups.s3Object.getV1("task_group_s3_object_metadata_id");
|
|
|
11820
12049
|
</dl>
|
|
11821
12050
|
</details>
|
|
11822
12051
|
|
|
12052
|
+
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">addV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
12053
|
+
<dl>
|
|
12054
|
+
<dd>
|
|
12055
|
+
|
|
12056
|
+
#### 📝 Description
|
|
12057
|
+
|
|
12058
|
+
<dl>
|
|
12059
|
+
<dd>
|
|
12060
|
+
|
|
12061
|
+
<dl>
|
|
12062
|
+
<dd>
|
|
12063
|
+
|
|
12064
|
+
Uploads an image file to a task group with automatic blurhash generation. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
12065
|
+
|
|
12066
|
+
</dd>
|
|
12067
|
+
</dl>
|
|
12068
|
+
</dd>
|
|
12069
|
+
</dl>
|
|
12070
|
+
|
|
12071
|
+
#### 🔌 Usage
|
|
12072
|
+
|
|
12073
|
+
<dl>
|
|
12074
|
+
<dd>
|
|
12075
|
+
|
|
12076
|
+
<dl>
|
|
12077
|
+
<dd>
|
|
12078
|
+
|
|
12079
|
+
```typescript
|
|
12080
|
+
await client.taskGroups.s3Object.addV1("task_group_id", {
|
|
12081
|
+
image: fs.createReadStream("/path/to/your/file"),
|
|
12082
|
+
});
|
|
12083
|
+
```
|
|
12084
|
+
|
|
12085
|
+
</dd>
|
|
12086
|
+
</dl>
|
|
12087
|
+
</dd>
|
|
12088
|
+
</dl>
|
|
12089
|
+
|
|
12090
|
+
#### ⚙️ Parameters
|
|
12091
|
+
|
|
12092
|
+
<dl>
|
|
12093
|
+
<dd>
|
|
12094
|
+
|
|
12095
|
+
<dl>
|
|
12096
|
+
<dd>
|
|
12097
|
+
|
|
12098
|
+
**taskGroupId:** `string`
|
|
12099
|
+
|
|
12100
|
+
</dd>
|
|
12101
|
+
</dl>
|
|
12102
|
+
|
|
12103
|
+
<dl>
|
|
12104
|
+
<dd>
|
|
12105
|
+
|
|
12106
|
+
**request:** `Chrt.taskGroups.BodyPostTaskGroupsS3ObjectAddV1OortTaskGroupsS3ObjectAddV1TaskGroupIdPost`
|
|
12107
|
+
|
|
12108
|
+
</dd>
|
|
12109
|
+
</dl>
|
|
12110
|
+
|
|
12111
|
+
<dl>
|
|
12112
|
+
<dd>
|
|
12113
|
+
|
|
12114
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
12115
|
+
|
|
12116
|
+
</dd>
|
|
12117
|
+
</dl>
|
|
12118
|
+
</dd>
|
|
12119
|
+
</dl>
|
|
12120
|
+
|
|
12121
|
+
</dd>
|
|
12122
|
+
</dl>
|
|
12123
|
+
</details>
|
|
12124
|
+
|
|
12125
|
+
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">deleteV1</a>(taskGroupS3ObjectMetadataId) -> boolean</code></summary>
|
|
12126
|
+
<dl>
|
|
12127
|
+
<dd>
|
|
12128
|
+
|
|
12129
|
+
#### 📝 Description
|
|
12130
|
+
|
|
12131
|
+
<dl>
|
|
12132
|
+
<dd>
|
|
12133
|
+
|
|
12134
|
+
<dl>
|
|
12135
|
+
<dd>
|
|
12136
|
+
|
|
12137
|
+
Deletes an S3 object metadata and the associated S3 object from a task group. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
|
|
12138
|
+
|
|
12139
|
+
</dd>
|
|
12140
|
+
</dl>
|
|
12141
|
+
</dd>
|
|
12142
|
+
</dl>
|
|
12143
|
+
|
|
12144
|
+
#### 🔌 Usage
|
|
12145
|
+
|
|
12146
|
+
<dl>
|
|
12147
|
+
<dd>
|
|
12148
|
+
|
|
12149
|
+
<dl>
|
|
12150
|
+
<dd>
|
|
12151
|
+
|
|
12152
|
+
```typescript
|
|
12153
|
+
await client.taskGroups.s3Object.deleteV1("task_group_s3_object_metadata_id");
|
|
12154
|
+
```
|
|
12155
|
+
|
|
12156
|
+
</dd>
|
|
12157
|
+
</dl>
|
|
12158
|
+
</dd>
|
|
12159
|
+
</dl>
|
|
12160
|
+
|
|
12161
|
+
#### ⚙️ Parameters
|
|
12162
|
+
|
|
12163
|
+
<dl>
|
|
12164
|
+
<dd>
|
|
12165
|
+
|
|
12166
|
+
<dl>
|
|
12167
|
+
<dd>
|
|
12168
|
+
|
|
12169
|
+
**taskGroupS3ObjectMetadataId:** `string`
|
|
12170
|
+
|
|
12171
|
+
</dd>
|
|
12172
|
+
</dl>
|
|
12173
|
+
|
|
12174
|
+
<dl>
|
|
12175
|
+
<dd>
|
|
12176
|
+
|
|
12177
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
12178
|
+
|
|
12179
|
+
</dd>
|
|
12180
|
+
</dl>
|
|
12181
|
+
</dd>
|
|
12182
|
+
</dl>
|
|
12183
|
+
|
|
12184
|
+
</dd>
|
|
12185
|
+
</dl>
|
|
12186
|
+
</details>
|
|
12187
|
+
|
|
11823
12188
|
## TaskGroups Expanded
|
|
11824
12189
|
|
|
11825
12190
|
<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>
|