@chrt-inc/typescript-sdk 1.749.0 → 1.754.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.
Files changed (88) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/shipping/resources/flights/client/Client.d.ts +39 -0
  3. package/dist/cjs/api/resources/shipping/resources/flights/client/Client.js +177 -0
  4. package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.d.ts +11 -2
  5. package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.js +11 -2
  6. package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts +11 -2
  7. package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.js +11 -2
  8. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.ts +1 -1
  9. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.ts +1 -1
  10. package/dist/cjs/api/resources/utils/resources/dev/client/Client.d.ts +0 -13
  11. package/dist/cjs/api/resources/utils/resources/dev/client/Client.js +0 -62
  12. package/dist/cjs/api/resources/utils/resources/dev/client/requests/index.d.ts +0 -1
  13. package/dist/cjs/api/types/FlightInfoForTaskRes.d.ts +4 -3
  14. package/dist/cjs/api/types/FlightLeg1.d.ts +30 -0
  15. package/dist/cjs/api/types/FlightLegClientCreate1.d.ts +15 -0
  16. package/dist/cjs/api/types/FlightLegProvenanceEnum1.d.ts +9 -0
  17. package/dist/cjs/api/types/FlightLegProvenanceEnum1.js +11 -0
  18. package/dist/cjs/api/types/FlightLegStatusEnum1.d.ts +14 -0
  19. package/dist/cjs/api/types/FlightLegStatusEnum1.js +16 -0
  20. package/dist/cjs/api/types/FlightLegStatusSourceEnum1.d.ts +8 -0
  21. package/dist/cjs/api/types/FlightLegStatusSourceEnum1.js +10 -0
  22. package/dist/cjs/api/types/FlightLegWebhookInfo.d.ts +20 -0
  23. package/dist/cjs/api/types/FlightTrackPosition.d.ts +14 -0
  24. package/dist/cjs/api/types/FlightTrackPosition.js +5 -0
  25. package/dist/cjs/api/types/FlightTrackRes.d.ts +21 -0
  26. package/dist/cjs/api/types/FlightTrackRes.js +5 -0
  27. package/dist/cjs/api/types/FlightTrackWaypoint.d.ts +10 -0
  28. package/dist/cjs/api/types/FlightTrackWaypoint.js +5 -0
  29. package/dist/cjs/api/types/OrderSchedule1.d.ts +1 -0
  30. package/dist/cjs/api/types/OrderScheduleAboutRes.d.ts +1 -0
  31. package/dist/cjs/api/types/SetFlightInfoReq.d.ts +3 -4
  32. package/dist/cjs/api/types/ShippingTaskGroupFlightInfoUpdatedWebhookPayload.d.ts +3 -4
  33. package/dist/cjs/api/types/TaskGroup1.d.ts +1 -2
  34. package/dist/cjs/api/types/index.d.ts +9 -2
  35. package/dist/cjs/api/types/index.js +9 -2
  36. package/dist/cjs/version.d.ts +1 -1
  37. package/dist/cjs/version.js +1 -1
  38. package/dist/esm/Client.mjs +2 -2
  39. package/dist/esm/api/resources/shipping/resources/flights/client/Client.d.mts +39 -0
  40. package/dist/esm/api/resources/shipping/resources/flights/client/Client.mjs +177 -0
  41. package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.d.mts +11 -2
  42. package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.mjs +11 -2
  43. package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.d.mts +11 -2
  44. package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.mjs +11 -2
  45. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.mts +1 -1
  46. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.mts +1 -1
  47. package/dist/esm/api/resources/utils/resources/dev/client/Client.d.mts +0 -13
  48. package/dist/esm/api/resources/utils/resources/dev/client/Client.mjs +0 -62
  49. package/dist/esm/api/resources/utils/resources/dev/client/requests/index.d.mts +0 -1
  50. package/dist/esm/api/types/FlightInfoForTaskRes.d.mts +4 -3
  51. package/dist/esm/api/types/FlightLeg1.d.mts +30 -0
  52. package/dist/esm/api/types/FlightLegClientCreate1.d.mts +15 -0
  53. package/dist/esm/api/types/FlightLegProvenanceEnum1.d.mts +9 -0
  54. package/dist/esm/api/types/FlightLegProvenanceEnum1.mjs +8 -0
  55. package/dist/esm/api/types/FlightLegStatusEnum1.d.mts +14 -0
  56. package/dist/esm/api/types/FlightLegStatusEnum1.mjs +13 -0
  57. package/dist/esm/api/types/FlightLegStatusSourceEnum1.d.mts +8 -0
  58. package/dist/esm/api/types/FlightLegStatusSourceEnum1.mjs +7 -0
  59. package/dist/esm/api/types/FlightLegWebhookInfo.d.mts +20 -0
  60. package/dist/esm/api/types/FlightTrackPosition.d.mts +14 -0
  61. package/dist/esm/api/types/FlightTrackPosition.mjs +4 -0
  62. package/dist/esm/api/types/FlightTrackRes.d.mts +21 -0
  63. package/dist/esm/api/types/FlightTrackRes.mjs +4 -0
  64. package/dist/esm/api/types/FlightTrackWaypoint.d.mts +10 -0
  65. package/dist/esm/api/types/FlightTrackWaypoint.mjs +4 -0
  66. package/dist/esm/api/types/OrderSchedule1.d.mts +1 -0
  67. package/dist/esm/api/types/OrderScheduleAboutRes.d.mts +1 -0
  68. package/dist/esm/api/types/SetFlightInfoReq.d.mts +3 -4
  69. package/dist/esm/api/types/ShippingTaskGroupFlightInfoUpdatedWebhookPayload.d.mts +3 -4
  70. package/dist/esm/api/types/TaskGroup1.d.mts +1 -2
  71. package/dist/esm/api/types/index.d.mts +9 -2
  72. package/dist/esm/api/types/index.mjs +9 -2
  73. package/dist/esm/version.d.mts +1 -1
  74. package/dist/esm/version.mjs +1 -1
  75. package/package.json +1 -1
  76. package/reference.md +215 -67
  77. package/dist/cjs/api/resources/utils/resources/dev/client/requests/ScheduledPingReq.d.ts +0 -13
  78. package/dist/cjs/api/types/ScheduleSpec.d.ts +0 -14
  79. package/dist/cjs/api/types/ScheduledPingRes.d.ts +0 -16
  80. package/dist/esm/api/resources/utils/resources/dev/client/requests/ScheduledPingReq.d.mts +0 -13
  81. package/dist/esm/api/types/ScheduleSpec.d.mts +0 -14
  82. package/dist/esm/api/types/ScheduledPingRes.d.mts +0 -16
  83. /package/dist/cjs/api/{resources/utils/resources/dev/client/requests/ScheduledPingReq.js → types/FlightLeg1.js} +0 -0
  84. /package/dist/cjs/api/types/{ScheduleSpec.js → FlightLegClientCreate1.js} +0 -0
  85. /package/dist/cjs/api/types/{ScheduledPingRes.js → FlightLegWebhookInfo.js} +0 -0
  86. /package/dist/esm/api/{resources/utils/resources/dev/client/requests/ScheduledPingReq.mjs → types/FlightLeg1.mjs} +0 -0
  87. /package/dist/esm/api/types/{ScheduleSpec.mjs → FlightLegClientCreate1.mjs} +0 -0
  88. /package/dist/esm/api/types/{ScheduledPingRes.mjs → FlightLegWebhookInfo.mjs} +0 -0
package/reference.md CHANGED
@@ -17510,6 +17510,195 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
17510
17510
  </dl>
17511
17511
  </details>
17512
17512
 
17513
+ <details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightLegsForTaskGroupV1</a>(taskGroupId) -> Chrt.FlightInfoForTaskRes</code></summary>
17514
+ <dl>
17515
+ <dd>
17516
+
17517
+ #### 📝 Description
17518
+
17519
+ <dl>
17520
+ <dd>
17521
+
17522
+ <dl>
17523
+ <dd>
17524
+
17525
+ Returns the ordered list of flight legs for a task group. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
17526
+
17527
+ </dd>
17528
+ </dl>
17529
+ </dd>
17530
+ </dl>
17531
+
17532
+ #### 🔌 Usage
17533
+
17534
+ <dl>
17535
+ <dd>
17536
+
17537
+ <dl>
17538
+ <dd>
17539
+
17540
+ ```typescript
17541
+ await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
17542
+ ```
17543
+
17544
+ </dd>
17545
+ </dl>
17546
+ </dd>
17547
+ </dl>
17548
+
17549
+ #### ⚙️ Parameters
17550
+
17551
+ <dl>
17552
+ <dd>
17553
+
17554
+ <dl>
17555
+ <dd>
17556
+
17557
+ **taskGroupId:** `string`
17558
+
17559
+ </dd>
17560
+ </dl>
17561
+
17562
+ <dl>
17563
+ <dd>
17564
+
17565
+ **requestOptions:** `Flights.RequestOptions`
17566
+
17567
+ </dd>
17568
+ </dl>
17569
+ </dd>
17570
+ </dl>
17571
+
17572
+ </dd>
17573
+ </dl>
17574
+ </details>
17575
+
17576
+ <details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightStatusForFlightLegV1</a>(flightLegId) -> Chrt.FlightLeg1</code></summary>
17577
+ <dl>
17578
+ <dd>
17579
+
17580
+ #### 📝 Description
17581
+
17582
+ <dl>
17583
+ <dd>
17584
+
17585
+ <dl>
17586
+ <dd>
17587
+
17588
+ Returns the flight leg with its Cirium-sourced status, lazily resolving the Cirium flightId and refreshing the cached status on read. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightLeg1)
17589
+
17590
+ </dd>
17591
+ </dl>
17592
+ </dd>
17593
+ </dl>
17594
+
17595
+ #### 🔌 Usage
17596
+
17597
+ <dl>
17598
+ <dd>
17599
+
17600
+ <dl>
17601
+ <dd>
17602
+
17603
+ ```typescript
17604
+ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
17605
+ ```
17606
+
17607
+ </dd>
17608
+ </dl>
17609
+ </dd>
17610
+ </dl>
17611
+
17612
+ #### ⚙️ Parameters
17613
+
17614
+ <dl>
17615
+ <dd>
17616
+
17617
+ <dl>
17618
+ <dd>
17619
+
17620
+ **flightLegId:** `string`
17621
+
17622
+ </dd>
17623
+ </dl>
17624
+
17625
+ <dl>
17626
+ <dd>
17627
+
17628
+ **requestOptions:** `Flights.RequestOptions`
17629
+
17630
+ </dd>
17631
+ </dl>
17632
+ </dd>
17633
+ </dl>
17634
+
17635
+ </dd>
17636
+ </dl>
17637
+ </details>
17638
+
17639
+ <details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightTrackForFlightLegV1</a>(flightLegId) -> Chrt.FlightTrackRes</code></summary>
17640
+ <dl>
17641
+ <dd>
17642
+
17643
+ #### 📝 Description
17644
+
17645
+ <dl>
17646
+ <dd>
17647
+
17648
+ <dl>
17649
+ <dd>
17650
+
17651
+ Returns the Cirium-sourced positional track for a flight leg — the live breadcrumb trail plus the planned path (waypoints + legacy route) in one read-through call. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightTrackRes)
17652
+
17653
+ </dd>
17654
+ </dl>
17655
+ </dd>
17656
+ </dl>
17657
+
17658
+ #### 🔌 Usage
17659
+
17660
+ <dl>
17661
+ <dd>
17662
+
17663
+ <dl>
17664
+ <dd>
17665
+
17666
+ ```typescript
17667
+ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
17668
+ ```
17669
+
17670
+ </dd>
17671
+ </dl>
17672
+ </dd>
17673
+ </dl>
17674
+
17675
+ #### ⚙️ Parameters
17676
+
17677
+ <dl>
17678
+ <dd>
17679
+
17680
+ <dl>
17681
+ <dd>
17682
+
17683
+ **flightLegId:** `string`
17684
+
17685
+ </dd>
17686
+ </dl>
17687
+
17688
+ <dl>
17689
+ <dd>
17690
+
17691
+ **requestOptions:** `Flights.RequestOptions`
17692
+
17693
+ </dd>
17694
+ </dl>
17695
+ </dd>
17696
+ </dl>
17697
+
17698
+ </dd>
17699
+ </dl>
17700
+ </details>
17701
+
17513
17702
  ## Shipping TaskArtifacts
17514
17703
 
17515
17704
  <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">addToTaskV1</a>(taskId, { ...params }) -> string</code></summary>
@@ -20369,7 +20558,7 @@ await client.shipping.taskGroups.removeExecutorV1("task_group_id");
20369
20558
  <dl>
20370
20559
  <dd>
20371
20560
 
20372
- Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
20561
+ Replaces the ordered list of flights on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
20373
20562
 
20374
20563
  </dd>
20375
20564
  </dl>
@@ -20385,7 +20574,18 @@ Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[l
20385
20574
  <dd>
20386
20575
 
20387
20576
  ```typescript
20388
- await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
20577
+ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {
20578
+ flight_legs: [
20579
+ {
20580
+ schema_version: 1,
20581
+ flight_number: "flight_number",
20582
+ provenance: "manual",
20583
+ origin_iata: "origin_iata",
20584
+ destination_iata: "destination_iata",
20585
+ scheduled_departure_utc: "2024-01-15T09:30:00Z",
20586
+ },
20587
+ ],
20588
+ });
20389
20589
  ```
20390
20590
 
20391
20591
  </dd>
@@ -23087,7 +23287,7 @@ await client.shipping.orderDrafts.taskGroup.addV1({
23087
23287
  <dl>
23088
23288
  <dd>
23089
23289
 
23090
- Sets the flight number and/or fa_flight_ids on a draft task group. | (SetFlightInfoReq) -> (bool)
23290
+ Replaces the ordered list of flights on a draft task group. | (SetFlightInfoReq) -> (bool)
23091
23291
 
23092
23292
  </dd>
23093
23293
  </dl>
@@ -23103,7 +23303,18 @@ Sets the flight number and/or fa_flight_ids on a draft task group. | (SetFlightI
23103
23303
  <dd>
23104
23304
 
23105
23305
  ```typescript
23106
- await client.shipping.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {});
23306
+ await client.shipping.orderDrafts.taskGroup.setFlightInfoV1("task_group_id", {
23307
+ flight_legs: [
23308
+ {
23309
+ schema_version: 1,
23310
+ flight_number: "flight_number",
23311
+ provenance: "manual",
23312
+ origin_iata: "origin_iata",
23313
+ destination_iata: "destination_iata",
23314
+ scheduled_departure_utc: "2024-01-15T09:30:00Z",
23315
+ },
23316
+ ],
23317
+ });
23107
23318
  ```
23108
23319
 
23109
23320
  </dd>
@@ -30400,69 +30611,6 @@ await client.users.directoryEntries.deleteV1("directory_entry_id");
30400
30611
 
30401
30612
  ## Utils Dev
30402
30613
 
30403
- <details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentPingScheduleV1</a>({ ...params }) -> Chrt.ScheduledPingRes</code></summary>
30404
- <dl>
30405
- <dd>
30406
-
30407
- #### 📝 Description
30408
-
30409
- <dl>
30410
- <dd>
30411
-
30412
- <dl>
30413
- <dd>
30414
-
30415
- Creates or updates a Temporal Schedule that runs the scheduled ping workflow for developer diagnostics. | authz: min_org_role=administrator | (ScheduledPingReq) -> (ScheduledPingRes)
30416
-
30417
- </dd>
30418
- </dl>
30419
- </dd>
30420
- </dl>
30421
-
30422
- #### 🔌 Usage
30423
-
30424
- <dl>
30425
- <dd>
30426
-
30427
- <dl>
30428
- <dd>
30429
-
30430
- ```typescript
30431
- await client.utils.dev.postAgentPingScheduleV1();
30432
- ```
30433
-
30434
- </dd>
30435
- </dl>
30436
- </dd>
30437
- </dl>
30438
-
30439
- #### ⚙️ Parameters
30440
-
30441
- <dl>
30442
- <dd>
30443
-
30444
- <dl>
30445
- <dd>
30446
-
30447
- **request:** `Chrt.utils.ScheduledPingReq`
30448
-
30449
- </dd>
30450
- </dl>
30451
-
30452
- <dl>
30453
- <dd>
30454
-
30455
- **requestOptions:** `Dev.RequestOptions`
30456
-
30457
- </dd>
30458
- </dl>
30459
- </dd>
30460
- </dl>
30461
-
30462
- </dd>
30463
- </dl>
30464
- </details>
30465
-
30466
30614
  <details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOpenaiPingV1</a>({ ...params }) -> Chrt.PingOpenAiRes</code></summary>
30467
30615
  <dl>
30468
30616
  <dd>
@@ -1,13 +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 ScheduledPingReq {
10
- message?: string;
11
- schedule_spec?: Chrt.ScheduleSpec;
12
- catchup_window_seconds?: number;
13
- }
@@ -1,14 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as Chrt from "../index.js";
5
- export interface ScheduleSpec {
6
- calendars?: Chrt.ScheduleCalendarSpec[];
7
- intervals?: Chrt.ScheduleIntervalSpec[];
8
- cron_expressions?: string[];
9
- skip?: Chrt.ScheduleCalendarSpec[];
10
- start_at?: string | null;
11
- end_at?: string | null;
12
- jitter?: string | null;
13
- time_zone_name?: string | null;
14
- }
@@ -1,16 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as Chrt from "../index.js";
5
- export interface ScheduledPingRes {
6
- schedule_id: string;
7
- ping_id: string;
8
- message: string;
9
- workflow_name: string;
10
- workflow_id: string;
11
- task_queue: string;
12
- schedule_spec: Chrt.ScheduleSpec;
13
- catchup_window_seconds: number;
14
- created: boolean;
15
- next_action_times: string[];
16
- }
@@ -1,13 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as Chrt from "../../../../../../index.mjs";
5
- /**
6
- * @example
7
- * {}
8
- */
9
- export interface ScheduledPingReq {
10
- message?: string;
11
- schedule_spec?: Chrt.ScheduleSpec;
12
- catchup_window_seconds?: number;
13
- }
@@ -1,14 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as Chrt from "../index.mjs";
5
- export interface ScheduleSpec {
6
- calendars?: Chrt.ScheduleCalendarSpec[];
7
- intervals?: Chrt.ScheduleIntervalSpec[];
8
- cron_expressions?: string[];
9
- skip?: Chrt.ScheduleCalendarSpec[];
10
- start_at?: string | null;
11
- end_at?: string | null;
12
- jitter?: string | null;
13
- time_zone_name?: string | null;
14
- }
@@ -1,16 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as Chrt from "../index.mjs";
5
- export interface ScheduledPingRes {
6
- schedule_id: string;
7
- ping_id: string;
8
- message: string;
9
- workflow_name: string;
10
- workflow_id: string;
11
- task_queue: string;
12
- schedule_spec: Chrt.ScheduleSpec;
13
- catchup_window_seconds: number;
14
- created: boolean;
15
- next_action_times: string[];
16
- }