@chrt-inc/typescript-sdk 1.296.0 → 1.299.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/taskGroups/client/Client.d.ts +6 -65
- package/dist/cjs/api/resources/taskGroups/client/Client.js +7 -301
- package/dist/cjs/api/resources/taskGroups/client/requests/index.d.ts +0 -2
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.d.ts +76 -0
- package/dist/cjs/api/resources/taskGroups/resources/{full → expanded}/client/Client.js +108 -26
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/index.js +17 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/TaskGroupExpandedForShipperReq.d.ts +20 -0
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/Client.d.ts +90 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/Client.js +326 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/index.js +17 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierAdministratorV1Request.d.ts +40 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierDriverV1Request.d.ts +40 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/index.js +17 -0
- package/dist/cjs/api/resources/taskGroups/resources/index.d.ts +4 -1
- package/dist/cjs/api/resources/taskGroups/resources/index.js +8 -2
- package/dist/cjs/api/types/SortOrderEnum.d.ts +11 -0
- package/dist/cjs/api/types/SortOrderEnum.js +10 -0
- package/dist/cjs/api/types/TaskExpanded.d.ts +1 -1
- package/dist/cjs/api/types/TaskGroupExpandedForCourierAdministrator.d.ts +1 -1
- package/dist/cjs/api/types/TaskGroupExpandedForCourierAdministratorReq.d.ts +19 -0
- package/dist/cjs/api/types/TaskGroupExpandedForCourierDriver.d.ts +2 -0
- package/dist/cjs/api/types/TaskGroupExpandedForCourierDriverReq.d.ts +19 -0
- package/dist/cjs/api/types/TaskGroupExpandedForShipper.d.ts +18 -0
- package/dist/cjs/api/types/TaskGroupExpandedSortFieldEnum.d.ts +12 -0
- package/dist/cjs/api/types/TaskGroupExpandedSortFieldEnum.js +11 -0
- package/dist/cjs/api/types/TaskGroupsExpandedForCourierAdministratorRes.d.ts +4 -0
- package/dist/cjs/api/types/TaskGroupsExpandedForCourierDriverRes.d.ts +4 -0
- package/dist/cjs/api/types/index.d.ts +5 -6
- package/dist/cjs/api/types/index.js +5 -6
- 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/taskGroups/client/Client.d.mts +6 -65
- package/dist/esm/api/resources/taskGroups/client/Client.mjs +7 -301
- package/dist/esm/api/resources/taskGroups/client/requests/index.d.mts +0 -2
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.d.mts +76 -0
- package/dist/esm/api/resources/taskGroups/resources/{full → expanded}/client/Client.mjs +106 -24
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/index.d.mts +2 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/TaskGroupExpandedForShipperReq.d.mts +20 -0
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/Client.d.mts +90 -0
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/Client.mjs +289 -0
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/index.d.mts +2 -0
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierAdministratorV1Request.d.mts +40 -0
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierDriverV1Request.d.mts +40 -0
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/taskGroups/resources/expandedList/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/resources/expandedList/index.mjs +1 -0
- package/dist/esm/api/resources/taskGroups/resources/index.d.mts +4 -1
- package/dist/esm/api/resources/taskGroups/resources/index.mjs +4 -1
- package/dist/esm/api/types/SortOrderEnum.d.mts +11 -0
- package/dist/esm/api/types/SortOrderEnum.mjs +7 -0
- package/dist/esm/api/types/TaskExpanded.d.mts +1 -1
- package/dist/esm/api/types/TaskGroupExpandedForCourierAdministrator.d.mts +1 -1
- package/dist/esm/api/types/TaskGroupExpandedForCourierAdministratorReq.d.mts +19 -0
- package/dist/esm/api/types/TaskGroupExpandedForCourierDriver.d.mts +2 -0
- package/dist/esm/api/types/TaskGroupExpandedForCourierDriverReq.d.mts +19 -0
- package/dist/esm/api/types/TaskGroupExpandedForShipper.d.mts +18 -0
- package/dist/esm/api/types/TaskGroupExpandedSortFieldEnum.d.mts +12 -0
- package/dist/esm/api/types/TaskGroupExpandedSortFieldEnum.mjs +8 -0
- package/dist/esm/api/types/TaskGroupsExpandedForCourierAdministratorRes.d.mts +4 -0
- package/dist/esm/api/types/TaskGroupsExpandedForCourierDriverRes.d.mts +4 -0
- package/dist/esm/api/types/index.d.mts +5 -6
- package/dist/esm/api/types/index.mjs +5 -6
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +262 -316
- package/dist/cjs/api/resources/taskGroups/client/requests/TaskGroupExpandedForCourierAdministratorReq.d.ts +0 -34
- package/dist/cjs/api/resources/taskGroups/client/requests/TaskGroupExpandedForCourierDriverReq.d.ts +0 -32
- package/dist/cjs/api/resources/taskGroups/resources/full/client/Client.d.ts +0 -57
- package/dist/cjs/api/types/MultipleTaskGroupsDetailsResponse.d.ts +0 -7
- package/dist/cjs/api/types/MultipleTaskGroupsWithTasks.d.ts +0 -7
- package/dist/cjs/api/types/TaskGroupDetailsResponse.d.ts +0 -8
- package/dist/cjs/api/types/TaskGroupWithDetails.d.ts +0 -8
- package/dist/cjs/api/types/TaskGroupWithTasks.d.ts +0 -8
- package/dist/cjs/api/types/TaskGroupWithTasks.js +0 -5
- package/dist/cjs/api/types/TaskWithDetails.d.ts +0 -9
- package/dist/cjs/api/types/TaskWithDetails.js +0 -5
- package/dist/esm/api/resources/taskGroups/client/requests/TaskGroupExpandedForCourierAdministratorReq.d.mts +0 -34
- package/dist/esm/api/resources/taskGroups/client/requests/TaskGroupExpandedForCourierDriverReq.d.mts +0 -32
- package/dist/esm/api/resources/taskGroups/resources/full/client/Client.d.mts +0 -57
- package/dist/esm/api/resources/taskGroups/resources/full/client/index.d.mts +0 -1
- package/dist/esm/api/types/MultipleTaskGroupsDetailsResponse.d.mts +0 -7
- package/dist/esm/api/types/MultipleTaskGroupsWithTasks.d.mts +0 -7
- package/dist/esm/api/types/TaskGroupDetailsResponse.d.mts +0 -8
- package/dist/esm/api/types/TaskGroupWithDetails.d.mts +0 -8
- package/dist/esm/api/types/TaskGroupWithTasks.d.mts +0 -8
- package/dist/esm/api/types/TaskGroupWithTasks.mjs +0 -4
- package/dist/esm/api/types/TaskWithDetails.d.mts +0 -9
- package/dist/esm/api/types/TaskWithDetails.mjs +0 -4
- /package/dist/cjs/api/resources/taskGroups/{client/requests/TaskGroupExpandedForCourierAdministratorReq.js → resources/expanded/client/requests/TaskGroupExpandedForShipperReq.js} +0 -0
- /package/dist/cjs/api/resources/taskGroups/resources/{full/client → expanded/client/requests}/index.js +0 -0
- /package/dist/cjs/api/resources/taskGroups/resources/{full → expanded}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/taskGroups/resources/{full → expanded}/index.js +0 -0
- /package/dist/cjs/api/resources/taskGroups/{client/requests/TaskGroupExpandedForCourierDriverReq.js → resources/expandedList/client/requests/ExpandedListForCourierAdministratorV1Request.js} +0 -0
- /package/dist/cjs/api/{types/MultipleTaskGroupsDetailsResponse.js → resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierDriverV1Request.js} +0 -0
- /package/dist/cjs/api/types/{MultipleTaskGroupsWithTasks.js → TaskGroupExpandedForCourierAdministratorReq.js} +0 -0
- /package/dist/cjs/api/types/{TaskGroupDetailsResponse.js → TaskGroupExpandedForCourierDriverReq.js} +0 -0
- /package/dist/cjs/api/types/{TaskGroupWithDetails.js → TaskGroupExpandedForShipper.js} +0 -0
- /package/dist/esm/api/resources/taskGroups/{client/requests/TaskGroupExpandedForCourierAdministratorReq.mjs → resources/expanded/client/requests/TaskGroupExpandedForShipperReq.mjs} +0 -0
- /package/dist/esm/api/resources/taskGroups/resources/{full/client → expanded/client/requests}/index.mjs +0 -0
- /package/dist/esm/api/resources/taskGroups/resources/{full → expanded}/index.d.mts +0 -0
- /package/dist/esm/api/resources/taskGroups/resources/{full → expanded}/index.mjs +0 -0
- /package/dist/esm/api/resources/taskGroups/{client/requests/TaskGroupExpandedForCourierDriverReq.mjs → resources/expandedList/client/requests/ExpandedListForCourierAdministratorV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/MultipleTaskGroupsDetailsResponse.mjs → resources/taskGroups/resources/expandedList/client/requests/ExpandedListForCourierDriverV1Request.mjs} +0 -0
- /package/dist/{cjs/api/resources/taskGroups/resources/full/client/index.d.ts → esm/api/resources/taskGroups/resources/expandedList/client/requests/index.mjs} +0 -0
- /package/dist/esm/api/types/{MultipleTaskGroupsWithTasks.mjs → TaskGroupExpandedForCourierAdministratorReq.mjs} +0 -0
- /package/dist/esm/api/types/{TaskGroupDetailsResponse.mjs → TaskGroupExpandedForCourierDriverReq.mjs} +0 -0
- /package/dist/esm/api/types/{TaskGroupWithDetails.mjs → TaskGroupExpandedForShipper.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -4436,313 +4436,6 @@ await client.connections.listCouriersV1();
|
|
|
4436
4436
|
|
|
4437
4437
|
## TaskGroups
|
|
4438
4438
|
|
|
4439
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">listByCourierOrgIdV1</a>() -> Chrt.MultipleTaskGroupsWithTasks</code></summary>
|
|
4440
|
-
<dl>
|
|
4441
|
-
<dd>
|
|
4442
|
-
|
|
4443
|
-
#### 📝 Description
|
|
4444
|
-
|
|
4445
|
-
<dl>
|
|
4446
|
-
<dd>
|
|
4447
|
-
|
|
4448
|
-
<dl>
|
|
4449
|
-
<dd>
|
|
4450
|
-
|
|
4451
|
-
Lists all task groups assigned to the authenticated courier organization with their associated tasks.
|
|
4452
|
-
|
|
4453
|
-
</dd>
|
|
4454
|
-
</dl>
|
|
4455
|
-
</dd>
|
|
4456
|
-
</dl>
|
|
4457
|
-
|
|
4458
|
-
#### 🔌 Usage
|
|
4459
|
-
|
|
4460
|
-
<dl>
|
|
4461
|
-
<dd>
|
|
4462
|
-
|
|
4463
|
-
<dl>
|
|
4464
|
-
<dd>
|
|
4465
|
-
|
|
4466
|
-
```typescript
|
|
4467
|
-
await client.taskGroups.listByCourierOrgIdV1();
|
|
4468
|
-
```
|
|
4469
|
-
|
|
4470
|
-
</dd>
|
|
4471
|
-
</dl>
|
|
4472
|
-
</dd>
|
|
4473
|
-
</dl>
|
|
4474
|
-
|
|
4475
|
-
#### ⚙️ Parameters
|
|
4476
|
-
|
|
4477
|
-
<dl>
|
|
4478
|
-
<dd>
|
|
4479
|
-
|
|
4480
|
-
<dl>
|
|
4481
|
-
<dd>
|
|
4482
|
-
|
|
4483
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
4484
|
-
|
|
4485
|
-
</dd>
|
|
4486
|
-
</dl>
|
|
4487
|
-
</dd>
|
|
4488
|
-
</dl>
|
|
4489
|
-
|
|
4490
|
-
</dd>
|
|
4491
|
-
</dl>
|
|
4492
|
-
</details>
|
|
4493
|
-
|
|
4494
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getByIdV1</a>(id) -> Chrt.TaskGroupWithTasks</code></summary>
|
|
4495
|
-
<dl>
|
|
4496
|
-
<dd>
|
|
4497
|
-
|
|
4498
|
-
#### 📝 Description
|
|
4499
|
-
|
|
4500
|
-
<dl>
|
|
4501
|
-
<dd>
|
|
4502
|
-
|
|
4503
|
-
<dl>
|
|
4504
|
-
<dd>
|
|
4505
|
-
|
|
4506
|
-
Retrieves a specific task group by ID with its associated tasks.
|
|
4507
|
-
|
|
4508
|
-
</dd>
|
|
4509
|
-
</dl>
|
|
4510
|
-
</dd>
|
|
4511
|
-
</dl>
|
|
4512
|
-
|
|
4513
|
-
#### 🔌 Usage
|
|
4514
|
-
|
|
4515
|
-
<dl>
|
|
4516
|
-
<dd>
|
|
4517
|
-
|
|
4518
|
-
<dl>
|
|
4519
|
-
<dd>
|
|
4520
|
-
|
|
4521
|
-
```typescript
|
|
4522
|
-
await client.taskGroups.getByIdV1("id");
|
|
4523
|
-
```
|
|
4524
|
-
|
|
4525
|
-
</dd>
|
|
4526
|
-
</dl>
|
|
4527
|
-
</dd>
|
|
4528
|
-
</dl>
|
|
4529
|
-
|
|
4530
|
-
#### ⚙️ Parameters
|
|
4531
|
-
|
|
4532
|
-
<dl>
|
|
4533
|
-
<dd>
|
|
4534
|
-
|
|
4535
|
-
<dl>
|
|
4536
|
-
<dd>
|
|
4537
|
-
|
|
4538
|
-
**id:** `string`
|
|
4539
|
-
|
|
4540
|
-
</dd>
|
|
4541
|
-
</dl>
|
|
4542
|
-
|
|
4543
|
-
<dl>
|
|
4544
|
-
<dd>
|
|
4545
|
-
|
|
4546
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
4547
|
-
|
|
4548
|
-
</dd>
|
|
4549
|
-
</dl>
|
|
4550
|
-
</dd>
|
|
4551
|
-
</dl>
|
|
4552
|
-
|
|
4553
|
-
</dd>
|
|
4554
|
-
</dl>
|
|
4555
|
-
</details>
|
|
4556
|
-
|
|
4557
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">listByDriverIdV1</a>(driverId) -> Chrt.TaskGroup1[]</code></summary>
|
|
4558
|
-
<dl>
|
|
4559
|
-
<dd>
|
|
4560
|
-
|
|
4561
|
-
#### 📝 Description
|
|
4562
|
-
|
|
4563
|
-
<dl>
|
|
4564
|
-
<dd>
|
|
4565
|
-
|
|
4566
|
-
<dl>
|
|
4567
|
-
<dd>
|
|
4568
|
-
|
|
4569
|
-
Lists all task groups assigned to a specific driver.
|
|
4570
|
-
|
|
4571
|
-
</dd>
|
|
4572
|
-
</dl>
|
|
4573
|
-
</dd>
|
|
4574
|
-
</dl>
|
|
4575
|
-
|
|
4576
|
-
#### 🔌 Usage
|
|
4577
|
-
|
|
4578
|
-
<dl>
|
|
4579
|
-
<dd>
|
|
4580
|
-
|
|
4581
|
-
<dl>
|
|
4582
|
-
<dd>
|
|
4583
|
-
|
|
4584
|
-
```typescript
|
|
4585
|
-
await client.taskGroups.listByDriverIdV1("driver_id");
|
|
4586
|
-
```
|
|
4587
|
-
|
|
4588
|
-
</dd>
|
|
4589
|
-
</dl>
|
|
4590
|
-
</dd>
|
|
4591
|
-
</dl>
|
|
4592
|
-
|
|
4593
|
-
#### ⚙️ Parameters
|
|
4594
|
-
|
|
4595
|
-
<dl>
|
|
4596
|
-
<dd>
|
|
4597
|
-
|
|
4598
|
-
<dl>
|
|
4599
|
-
<dd>
|
|
4600
|
-
|
|
4601
|
-
**driverId:** `string`
|
|
4602
|
-
|
|
4603
|
-
</dd>
|
|
4604
|
-
</dl>
|
|
4605
|
-
|
|
4606
|
-
<dl>
|
|
4607
|
-
<dd>
|
|
4608
|
-
|
|
4609
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
4610
|
-
|
|
4611
|
-
</dd>
|
|
4612
|
-
</dl>
|
|
4613
|
-
</dd>
|
|
4614
|
-
</dl>
|
|
4615
|
-
|
|
4616
|
-
</dd>
|
|
4617
|
-
</dl>
|
|
4618
|
-
</details>
|
|
4619
|
-
|
|
4620
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedCourierAdministratorV1</a>({ ...params }) -> Chrt.TaskGroupsExpandedForCourierAdministratorRes</code></summary>
|
|
4621
|
-
<dl>
|
|
4622
|
-
<dd>
|
|
4623
|
-
|
|
4624
|
-
#### 📝 Description
|
|
4625
|
-
|
|
4626
|
-
<dl>
|
|
4627
|
-
<dd>
|
|
4628
|
-
|
|
4629
|
-
<dl>
|
|
4630
|
-
<dd>
|
|
4631
|
-
|
|
4632
|
-
Fetches task groups for the courier organization with optional filters and expanded related data.
|
|
4633
|
-
|
|
4634
|
-
</dd>
|
|
4635
|
-
</dl>
|
|
4636
|
-
</dd>
|
|
4637
|
-
</dl>
|
|
4638
|
-
|
|
4639
|
-
#### 🔌 Usage
|
|
4640
|
-
|
|
4641
|
-
<dl>
|
|
4642
|
-
<dd>
|
|
4643
|
-
|
|
4644
|
-
<dl>
|
|
4645
|
-
<dd>
|
|
4646
|
-
|
|
4647
|
-
```typescript
|
|
4648
|
-
await client.taskGroups.postExpandedCourierAdministratorV1();
|
|
4649
|
-
```
|
|
4650
|
-
|
|
4651
|
-
</dd>
|
|
4652
|
-
</dl>
|
|
4653
|
-
</dd>
|
|
4654
|
-
</dl>
|
|
4655
|
-
|
|
4656
|
-
#### ⚙️ Parameters
|
|
4657
|
-
|
|
4658
|
-
<dl>
|
|
4659
|
-
<dd>
|
|
4660
|
-
|
|
4661
|
-
<dl>
|
|
4662
|
-
<dd>
|
|
4663
|
-
|
|
4664
|
-
**request:** `Chrt.TaskGroupExpandedForCourierAdministratorReq`
|
|
4665
|
-
|
|
4666
|
-
</dd>
|
|
4667
|
-
</dl>
|
|
4668
|
-
|
|
4669
|
-
<dl>
|
|
4670
|
-
<dd>
|
|
4671
|
-
|
|
4672
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
4673
|
-
|
|
4674
|
-
</dd>
|
|
4675
|
-
</dl>
|
|
4676
|
-
</dd>
|
|
4677
|
-
</dl>
|
|
4678
|
-
|
|
4679
|
-
</dd>
|
|
4680
|
-
</dl>
|
|
4681
|
-
</details>
|
|
4682
|
-
|
|
4683
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">postExpandedCourierDriverV1</a>({ ...params }) -> Chrt.TaskGroupsExpandedForCourierDriverRes</code></summary>
|
|
4684
|
-
<dl>
|
|
4685
|
-
<dd>
|
|
4686
|
-
|
|
4687
|
-
#### 📝 Description
|
|
4688
|
-
|
|
4689
|
-
<dl>
|
|
4690
|
-
<dd>
|
|
4691
|
-
|
|
4692
|
-
<dl>
|
|
4693
|
-
<dd>
|
|
4694
|
-
|
|
4695
|
-
Fetches task groups assigned to the authenticated courier driver with optional expanded related data.
|
|
4696
|
-
|
|
4697
|
-
</dd>
|
|
4698
|
-
</dl>
|
|
4699
|
-
</dd>
|
|
4700
|
-
</dl>
|
|
4701
|
-
|
|
4702
|
-
#### 🔌 Usage
|
|
4703
|
-
|
|
4704
|
-
<dl>
|
|
4705
|
-
<dd>
|
|
4706
|
-
|
|
4707
|
-
<dl>
|
|
4708
|
-
<dd>
|
|
4709
|
-
|
|
4710
|
-
```typescript
|
|
4711
|
-
await client.taskGroups.postExpandedCourierDriverV1();
|
|
4712
|
-
```
|
|
4713
|
-
|
|
4714
|
-
</dd>
|
|
4715
|
-
</dl>
|
|
4716
|
-
</dd>
|
|
4717
|
-
</dl>
|
|
4718
|
-
|
|
4719
|
-
#### ⚙️ Parameters
|
|
4720
|
-
|
|
4721
|
-
<dl>
|
|
4722
|
-
<dd>
|
|
4723
|
-
|
|
4724
|
-
<dl>
|
|
4725
|
-
<dd>
|
|
4726
|
-
|
|
4727
|
-
**request:** `Chrt.TaskGroupExpandedForCourierDriverReq`
|
|
4728
|
-
|
|
4729
|
-
</dd>
|
|
4730
|
-
</dl>
|
|
4731
|
-
|
|
4732
|
-
<dl>
|
|
4733
|
-
<dd>
|
|
4734
|
-
|
|
4735
|
-
**requestOptions:** `TaskGroups.RequestOptions`
|
|
4736
|
-
|
|
4737
|
-
</dd>
|
|
4738
|
-
</dl>
|
|
4739
|
-
</dd>
|
|
4740
|
-
</dl>
|
|
4741
|
-
|
|
4742
|
-
</dd>
|
|
4743
|
-
</dl>
|
|
4744
|
-
</details>
|
|
4745
|
-
|
|
4746
4439
|
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.UpdateTaskGroupRes</code></summary>
|
|
4747
4440
|
<dl>
|
|
4748
4441
|
<dd>
|
|
@@ -8487,9 +8180,9 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8487
8180
|
</dl>
|
|
8488
8181
|
</details>
|
|
8489
8182
|
|
|
8490
|
-
## TaskGroups
|
|
8183
|
+
## TaskGroups Expanded
|
|
8491
8184
|
|
|
8492
|
-
<details><summary><code>client.taskGroups.
|
|
8185
|
+
<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">forCourierAdministratorByIdV1</a>(id, { ...params }) -> Chrt.TaskGroupExpandedForCourierAdministrator</code></summary>
|
|
8493
8186
|
<dl>
|
|
8494
8187
|
<dd>
|
|
8495
8188
|
|
|
@@ -8501,7 +8194,7 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
8501
8194
|
<dl>
|
|
8502
8195
|
<dd>
|
|
8503
8196
|
|
|
8504
|
-
|
|
8197
|
+
Fetches an expanded task group for the courier org with expanded related data.
|
|
8505
8198
|
|
|
8506
8199
|
</dd>
|
|
8507
8200
|
</dl>
|
|
@@ -8517,7 +8210,7 @@ Lists all task groups for the authenticated courier organization with complete t
|
|
|
8517
8210
|
<dd>
|
|
8518
8211
|
|
|
8519
8212
|
```typescript
|
|
8520
|
-
await client.taskGroups.
|
|
8213
|
+
await client.taskGroups.expanded.forCourierAdministratorByIdV1("id", {});
|
|
8521
8214
|
```
|
|
8522
8215
|
|
|
8523
8216
|
</dd>
|
|
@@ -8533,7 +8226,23 @@ await client.taskGroups.full.listByCourierOrgIdV1();
|
|
|
8533
8226
|
<dl>
|
|
8534
8227
|
<dd>
|
|
8535
8228
|
|
|
8536
|
-
**
|
|
8229
|
+
**id:** `string`
|
|
8230
|
+
|
|
8231
|
+
</dd>
|
|
8232
|
+
</dl>
|
|
8233
|
+
|
|
8234
|
+
<dl>
|
|
8235
|
+
<dd>
|
|
8236
|
+
|
|
8237
|
+
**request:** `Chrt.TaskGroupExpandedForCourierAdministratorReq`
|
|
8238
|
+
|
|
8239
|
+
</dd>
|
|
8240
|
+
</dl>
|
|
8241
|
+
|
|
8242
|
+
<dl>
|
|
8243
|
+
<dd>
|
|
8244
|
+
|
|
8245
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
8537
8246
|
|
|
8538
8247
|
</dd>
|
|
8539
8248
|
</dl>
|
|
@@ -8544,7 +8253,7 @@ await client.taskGroups.full.listByCourierOrgIdV1();
|
|
|
8544
8253
|
</dl>
|
|
8545
8254
|
</details>
|
|
8546
8255
|
|
|
8547
|
-
<details><summary><code>client.taskGroups.
|
|
8256
|
+
<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">forCourierDriverByIdV1</a>(id, { ...params }) -> Chrt.TaskGroupExpandedForCourierDriver</code></summary>
|
|
8548
8257
|
<dl>
|
|
8549
8258
|
<dd>
|
|
8550
8259
|
|
|
@@ -8556,7 +8265,7 @@ await client.taskGroups.full.listByCourierOrgIdV1();
|
|
|
8556
8265
|
<dl>
|
|
8557
8266
|
<dd>
|
|
8558
8267
|
|
|
8559
|
-
|
|
8268
|
+
Fetches an expanded task group assigned to a courier driver with optional expanded related data.
|
|
8560
8269
|
|
|
8561
8270
|
</dd>
|
|
8562
8271
|
</dl>
|
|
@@ -8572,7 +8281,7 @@ Retrieves a specific task group with complete tasks, milestones, and cargo infor
|
|
|
8572
8281
|
<dd>
|
|
8573
8282
|
|
|
8574
8283
|
```typescript
|
|
8575
|
-
await client.taskGroups.
|
|
8284
|
+
await client.taskGroups.expanded.forCourierDriverByIdV1("id", {});
|
|
8576
8285
|
```
|
|
8577
8286
|
|
|
8578
8287
|
</dd>
|
|
@@ -8596,7 +8305,244 @@ await client.taskGroups.full.getByTaskGroupIdV1("id");
|
|
|
8596
8305
|
<dl>
|
|
8597
8306
|
<dd>
|
|
8598
8307
|
|
|
8599
|
-
**
|
|
8308
|
+
**request:** `Chrt.TaskGroupExpandedForCourierDriverReq`
|
|
8309
|
+
|
|
8310
|
+
</dd>
|
|
8311
|
+
</dl>
|
|
8312
|
+
|
|
8313
|
+
<dl>
|
|
8314
|
+
<dd>
|
|
8315
|
+
|
|
8316
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
8317
|
+
|
|
8318
|
+
</dd>
|
|
8319
|
+
</dl>
|
|
8320
|
+
</dd>
|
|
8321
|
+
</dl>
|
|
8322
|
+
|
|
8323
|
+
</dd>
|
|
8324
|
+
</dl>
|
|
8325
|
+
</details>
|
|
8326
|
+
|
|
8327
|
+
<details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">forShipperByIdV1</a>(id, { ...params }) -> Chrt.TaskGroupExpandedForShipper</code></summary>
|
|
8328
|
+
<dl>
|
|
8329
|
+
<dd>
|
|
8330
|
+
|
|
8331
|
+
#### 📝 Description
|
|
8332
|
+
|
|
8333
|
+
<dl>
|
|
8334
|
+
<dd>
|
|
8335
|
+
|
|
8336
|
+
<dl>
|
|
8337
|
+
<dd>
|
|
8338
|
+
|
|
8339
|
+
Fetches an expanded task group for the shipper org with expanded related data.
|
|
8340
|
+
|
|
8341
|
+
</dd>
|
|
8342
|
+
</dl>
|
|
8343
|
+
</dd>
|
|
8344
|
+
</dl>
|
|
8345
|
+
|
|
8346
|
+
#### 🔌 Usage
|
|
8347
|
+
|
|
8348
|
+
<dl>
|
|
8349
|
+
<dd>
|
|
8350
|
+
|
|
8351
|
+
<dl>
|
|
8352
|
+
<dd>
|
|
8353
|
+
|
|
8354
|
+
```typescript
|
|
8355
|
+
await client.taskGroups.expanded.forShipperByIdV1("id");
|
|
8356
|
+
```
|
|
8357
|
+
|
|
8358
|
+
</dd>
|
|
8359
|
+
</dl>
|
|
8360
|
+
</dd>
|
|
8361
|
+
</dl>
|
|
8362
|
+
|
|
8363
|
+
#### ⚙️ Parameters
|
|
8364
|
+
|
|
8365
|
+
<dl>
|
|
8366
|
+
<dd>
|
|
8367
|
+
|
|
8368
|
+
<dl>
|
|
8369
|
+
<dd>
|
|
8370
|
+
|
|
8371
|
+
**id:** `string`
|
|
8372
|
+
|
|
8373
|
+
</dd>
|
|
8374
|
+
</dl>
|
|
8375
|
+
|
|
8376
|
+
<dl>
|
|
8377
|
+
<dd>
|
|
8378
|
+
|
|
8379
|
+
**request:** `Chrt.taskGroups.TaskGroupExpandedForShipperReq`
|
|
8380
|
+
|
|
8381
|
+
</dd>
|
|
8382
|
+
</dl>
|
|
8383
|
+
|
|
8384
|
+
<dl>
|
|
8385
|
+
<dd>
|
|
8386
|
+
|
|
8387
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
8388
|
+
|
|
8389
|
+
</dd>
|
|
8390
|
+
</dl>
|
|
8391
|
+
</dd>
|
|
8392
|
+
</dl>
|
|
8393
|
+
|
|
8394
|
+
</dd>
|
|
8395
|
+
</dl>
|
|
8396
|
+
</details>
|
|
8397
|
+
|
|
8398
|
+
## TaskGroups ExpandedList
|
|
8399
|
+
|
|
8400
|
+
<details><summary><code>client.taskGroups.expandedList.<a href="/src/api/resources/taskGroups/resources/expandedList/client/Client.ts">forCourierAdministratorV1</a>({ ...params }) -> Chrt.TaskGroupsExpandedForCourierAdministratorRes</code></summary>
|
|
8401
|
+
<dl>
|
|
8402
|
+
<dd>
|
|
8403
|
+
|
|
8404
|
+
#### 📝 Description
|
|
8405
|
+
|
|
8406
|
+
<dl>
|
|
8407
|
+
<dd>
|
|
8408
|
+
|
|
8409
|
+
<dl>
|
|
8410
|
+
<dd>
|
|
8411
|
+
|
|
8412
|
+
Fetches expanded task groups for the courier org with optional filters and expanded related data.
|
|
8413
|
+
|
|
8414
|
+
</dd>
|
|
8415
|
+
</dl>
|
|
8416
|
+
</dd>
|
|
8417
|
+
</dl>
|
|
8418
|
+
|
|
8419
|
+
#### 🔌 Usage
|
|
8420
|
+
|
|
8421
|
+
<dl>
|
|
8422
|
+
<dd>
|
|
8423
|
+
|
|
8424
|
+
<dl>
|
|
8425
|
+
<dd>
|
|
8426
|
+
|
|
8427
|
+
```typescript
|
|
8428
|
+
await client.taskGroups.expandedList.forCourierAdministratorV1({
|
|
8429
|
+
page: 1,
|
|
8430
|
+
page_size: 1,
|
|
8431
|
+
sort_by: "created_at",
|
|
8432
|
+
sort_order: "asc",
|
|
8433
|
+
filter_created_at_gte: "2024-01-15T09:30:00Z",
|
|
8434
|
+
filter_created_at_lte: "2024-01-15T09:30:00Z",
|
|
8435
|
+
filter_started_at_gte: "2024-01-15T09:30:00Z",
|
|
8436
|
+
filter_started_at_lte: "2024-01-15T09:30:00Z",
|
|
8437
|
+
filter_completed_at_gte: "2024-01-15T09:30:00Z",
|
|
8438
|
+
filter_completed_at_lte: "2024-01-15T09:30:00Z",
|
|
8439
|
+
filter_order_cancelled: true,
|
|
8440
|
+
filter_completed: true,
|
|
8441
|
+
filter_paused: true,
|
|
8442
|
+
body: {},
|
|
8443
|
+
});
|
|
8444
|
+
```
|
|
8445
|
+
|
|
8446
|
+
</dd>
|
|
8447
|
+
</dl>
|
|
8448
|
+
</dd>
|
|
8449
|
+
</dl>
|
|
8450
|
+
|
|
8451
|
+
#### ⚙️ Parameters
|
|
8452
|
+
|
|
8453
|
+
<dl>
|
|
8454
|
+
<dd>
|
|
8455
|
+
|
|
8456
|
+
<dl>
|
|
8457
|
+
<dd>
|
|
8458
|
+
|
|
8459
|
+
**request:** `Chrt.taskGroups.ExpandedListForCourierAdministratorV1Request`
|
|
8460
|
+
|
|
8461
|
+
</dd>
|
|
8462
|
+
</dl>
|
|
8463
|
+
|
|
8464
|
+
<dl>
|
|
8465
|
+
<dd>
|
|
8466
|
+
|
|
8467
|
+
**requestOptions:** `ExpandedList.RequestOptions`
|
|
8468
|
+
|
|
8469
|
+
</dd>
|
|
8470
|
+
</dl>
|
|
8471
|
+
</dd>
|
|
8472
|
+
</dl>
|
|
8473
|
+
|
|
8474
|
+
</dd>
|
|
8475
|
+
</dl>
|
|
8476
|
+
</details>
|
|
8477
|
+
|
|
8478
|
+
<details><summary><code>client.taskGroups.expandedList.<a href="/src/api/resources/taskGroups/resources/expandedList/client/Client.ts">forCourierDriverV1</a>({ ...params }) -> Chrt.TaskGroupsExpandedForCourierDriverRes</code></summary>
|
|
8479
|
+
<dl>
|
|
8480
|
+
<dd>
|
|
8481
|
+
|
|
8482
|
+
#### 📝 Description
|
|
8483
|
+
|
|
8484
|
+
<dl>
|
|
8485
|
+
<dd>
|
|
8486
|
+
|
|
8487
|
+
<dl>
|
|
8488
|
+
<dd>
|
|
8489
|
+
|
|
8490
|
+
Fetches expanded task groups assigned to a courier driver with optional expanded related data.
|
|
8491
|
+
|
|
8492
|
+
</dd>
|
|
8493
|
+
</dl>
|
|
8494
|
+
</dd>
|
|
8495
|
+
</dl>
|
|
8496
|
+
|
|
8497
|
+
#### 🔌 Usage
|
|
8498
|
+
|
|
8499
|
+
<dl>
|
|
8500
|
+
<dd>
|
|
8501
|
+
|
|
8502
|
+
<dl>
|
|
8503
|
+
<dd>
|
|
8504
|
+
|
|
8505
|
+
```typescript
|
|
8506
|
+
await client.taskGroups.expandedList.forCourierDriverV1({
|
|
8507
|
+
page: 1,
|
|
8508
|
+
page_size: 1,
|
|
8509
|
+
sort_by: "created_at",
|
|
8510
|
+
sort_order: "asc",
|
|
8511
|
+
filter_created_at_gte: "2024-01-15T09:30:00Z",
|
|
8512
|
+
filter_created_at_lte: "2024-01-15T09:30:00Z",
|
|
8513
|
+
filter_started_at_gte: "2024-01-15T09:30:00Z",
|
|
8514
|
+
filter_started_at_lte: "2024-01-15T09:30:00Z",
|
|
8515
|
+
filter_completed_at_gte: "2024-01-15T09:30:00Z",
|
|
8516
|
+
filter_completed_at_lte: "2024-01-15T09:30:00Z",
|
|
8517
|
+
filter_order_cancelled: true,
|
|
8518
|
+
filter_completed: true,
|
|
8519
|
+
filter_paused: true,
|
|
8520
|
+
body: {},
|
|
8521
|
+
});
|
|
8522
|
+
```
|
|
8523
|
+
|
|
8524
|
+
</dd>
|
|
8525
|
+
</dl>
|
|
8526
|
+
</dd>
|
|
8527
|
+
</dl>
|
|
8528
|
+
|
|
8529
|
+
#### ⚙️ Parameters
|
|
8530
|
+
|
|
8531
|
+
<dl>
|
|
8532
|
+
<dd>
|
|
8533
|
+
|
|
8534
|
+
<dl>
|
|
8535
|
+
<dd>
|
|
8536
|
+
|
|
8537
|
+
**request:** `Chrt.taskGroups.ExpandedListForCourierDriverV1Request`
|
|
8538
|
+
|
|
8539
|
+
</dd>
|
|
8540
|
+
</dl>
|
|
8541
|
+
|
|
8542
|
+
<dl>
|
|
8543
|
+
<dd>
|
|
8544
|
+
|
|
8545
|
+
**requestOptions:** `ExpandedList.RequestOptions`
|
|
8600
8546
|
|
|
8601
8547
|
</dd>
|
|
8602
8548
|
</dl>
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Chrt from "../../../../index.js";
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {}
|
|
8
|
-
*/
|
|
9
|
-
export interface TaskGroupExpandedForCourierAdministratorReq {
|
|
10
|
-
sort_created_at_desc?: boolean;
|
|
11
|
-
page?: number;
|
|
12
|
-
page_size?: number;
|
|
13
|
-
created_at_gte?: string | null;
|
|
14
|
-
created_at_lte?: string | null;
|
|
15
|
-
started_at_gte?: string | null;
|
|
16
|
-
started_at_lte?: string | null;
|
|
17
|
-
completed_at_gte?: string | null;
|
|
18
|
-
completed_at_lte?: string | null;
|
|
19
|
-
order_cancelled?: boolean | null;
|
|
20
|
-
statuses?: Chrt.TaskGroupStatusEnum1[] | null;
|
|
21
|
-
completed?: boolean | null;
|
|
22
|
-
paused?: boolean | null;
|
|
23
|
-
expand_tasks?: boolean;
|
|
24
|
-
expand_cargos?: boolean;
|
|
25
|
-
expand_milestones?: boolean;
|
|
26
|
-
expand_shipper_contact_info?: boolean;
|
|
27
|
-
expand_shipper_org_company_name?: boolean;
|
|
28
|
-
expand_shipper_org_handle?: boolean;
|
|
29
|
-
expand_task_group_mileage?: boolean;
|
|
30
|
-
expand_driver?: boolean;
|
|
31
|
-
expand_courier_pay_driver_line_item_groups?: boolean;
|
|
32
|
-
expand_courier_pay_driver_rate_sheet?: boolean;
|
|
33
|
-
expand_courier_pay_driver_payout?: boolean;
|
|
34
|
-
}
|
package/dist/cjs/api/resources/taskGroups/client/requests/TaskGroupExpandedForCourierDriverReq.d.ts
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as Chrt from "../../../../index.js";
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {}
|
|
8
|
-
*/
|
|
9
|
-
export interface TaskGroupExpandedForCourierDriverReq {
|
|
10
|
-
sort_created_at_desc?: boolean;
|
|
11
|
-
page?: number;
|
|
12
|
-
page_size?: number;
|
|
13
|
-
created_at_gte?: string | null;
|
|
14
|
-
created_at_lte?: string | null;
|
|
15
|
-
started_at_gte?: string | null;
|
|
16
|
-
started_at_lte?: string | null;
|
|
17
|
-
completed_at_gte?: string | null;
|
|
18
|
-
completed_at_lte?: string | null;
|
|
19
|
-
statuses?: Chrt.TaskGroupStatusEnum1[] | null;
|
|
20
|
-
order_cancelled?: boolean | null;
|
|
21
|
-
completed?: boolean | null;
|
|
22
|
-
paused?: boolean | null;
|
|
23
|
-
expand_tasks?: boolean;
|
|
24
|
-
expand_cargos?: boolean;
|
|
25
|
-
expand_milestones?: boolean;
|
|
26
|
-
expand_shipper_contact_info?: boolean;
|
|
27
|
-
expand_shipper_org_company_name?: boolean;
|
|
28
|
-
expand_shipper_org_handle?: boolean;
|
|
29
|
-
expand_task_group_mileage?: boolean;
|
|
30
|
-
expand_driver?: boolean;
|
|
31
|
-
expand_courier_pay_driver_payout?: boolean;
|
|
32
|
-
}
|