@chrt-inc/typescript-sdk 1.315.0 → 1.318.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 (72) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/index.d.ts +1 -1
  3. package/dist/cjs/api/resources/index.js +2 -2
  4. package/dist/cjs/api/resources/orders/index.d.ts +1 -1
  5. package/dist/cjs/api/resources/orders/index.js +1 -1
  6. package/dist/cjs/api/resources/orders/resources/expanded/client/Client.d.ts +62 -0
  7. package/dist/cjs/api/resources/orders/resources/expanded/client/Client.js +276 -0
  8. package/dist/cjs/api/resources/orders/resources/expanded/client/index.d.ts +1 -0
  9. package/dist/cjs/api/resources/orders/resources/expanded/client/index.js +15 -0
  10. package/dist/cjs/api/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.d.ts +46 -0
  11. package/dist/cjs/api/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.js +5 -0
  12. package/dist/cjs/api/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +46 -0
  13. package/dist/cjs/api/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.js +5 -0
  14. package/dist/cjs/api/resources/orders/resources/expanded/client/requests/index.d.ts +2 -0
  15. package/dist/cjs/api/resources/orders/resources/expanded/client/requests/index.js +2 -0
  16. package/dist/cjs/api/resources/orders/resources/expanded/index.d.ts +1 -0
  17. package/dist/cjs/api/resources/orders/resources/expanded/index.js +1 -0
  18. package/dist/cjs/api/resources/orders/resources/expanded/types/ExpandedListForForwarderOperatorsV1RequestSortOrder.d.ts +8 -0
  19. package/dist/cjs/api/resources/orders/resources/expanded/types/ExpandedListForForwarderOperatorsV1RequestSortOrder.js +10 -0
  20. package/dist/cjs/api/resources/orders/resources/expanded/types/ExpandedListForShipperOperatorsV1RequestSortOrder.d.ts +8 -0
  21. package/dist/cjs/api/resources/orders/resources/expanded/types/ExpandedListForShipperOperatorsV1RequestSortOrder.js +10 -0
  22. package/dist/cjs/api/resources/orders/resources/expanded/types/index.d.ts +2 -0
  23. package/dist/cjs/api/resources/orders/resources/expanded/types/index.js +18 -0
  24. package/dist/cjs/api/resources/orders/resources/index.d.ts +2 -0
  25. package/dist/cjs/api/resources/orders/resources/index.js +5 -0
  26. package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +26 -0
  27. package/dist/cjs/api/resources/taskGroups/client/Client.js +118 -0
  28. package/dist/cjs/api/types/OrderSortByEnum.d.ts +12 -0
  29. package/dist/cjs/api/types/OrderSortByEnum.js +14 -0
  30. package/dist/cjs/api/types/OrdersExpandedListRes.d.ts +8 -0
  31. package/dist/cjs/api/types/OrdersExpandedListRes.js +5 -0
  32. package/dist/cjs/api/types/index.d.ts +2 -0
  33. package/dist/cjs/api/types/index.js +2 -0
  34. package/dist/cjs/version.d.ts +1 -1
  35. package/dist/cjs/version.js +1 -1
  36. package/dist/esm/Client.mjs +2 -2
  37. package/dist/esm/api/resources/index.d.mts +1 -1
  38. package/dist/esm/api/resources/index.mjs +1 -1
  39. package/dist/esm/api/resources/orders/index.d.mts +1 -1
  40. package/dist/esm/api/resources/orders/index.mjs +1 -1
  41. package/dist/esm/api/resources/orders/resources/expanded/client/Client.d.mts +62 -0
  42. package/dist/esm/api/resources/orders/resources/expanded/client/Client.mjs +276 -0
  43. package/dist/esm/api/resources/orders/resources/expanded/client/index.d.mts +1 -0
  44. package/dist/esm/api/resources/orders/resources/expanded/client/index.mjs +1 -1
  45. package/dist/esm/api/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.d.mts +46 -0
  46. package/dist/esm/api/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.mjs +4 -0
  47. package/dist/esm/api/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +46 -0
  48. package/dist/esm/api/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.mjs +4 -0
  49. package/dist/esm/api/resources/orders/resources/expanded/client/requests/index.d.mts +2 -0
  50. package/dist/esm/api/resources/orders/resources/expanded/client/requests/index.mjs +1 -0
  51. package/dist/esm/api/resources/orders/resources/expanded/index.d.mts +1 -0
  52. package/dist/esm/api/resources/orders/resources/expanded/index.mjs +1 -0
  53. package/dist/esm/api/resources/orders/resources/expanded/types/ExpandedListForForwarderOperatorsV1RequestSortOrder.d.mts +8 -0
  54. package/dist/esm/api/resources/orders/resources/expanded/types/ExpandedListForForwarderOperatorsV1RequestSortOrder.mjs +7 -0
  55. package/dist/esm/api/resources/orders/resources/expanded/types/ExpandedListForShipperOperatorsV1RequestSortOrder.d.mts +8 -0
  56. package/dist/esm/api/resources/orders/resources/expanded/types/ExpandedListForShipperOperatorsV1RequestSortOrder.mjs +7 -0
  57. package/dist/esm/api/resources/orders/resources/expanded/types/index.d.mts +2 -0
  58. package/dist/esm/api/resources/orders/resources/expanded/types/index.mjs +2 -0
  59. package/dist/esm/api/resources/orders/resources/index.d.mts +2 -0
  60. package/dist/esm/api/resources/orders/resources/index.mjs +2 -0
  61. package/dist/esm/api/resources/taskGroups/client/Client.d.mts +26 -0
  62. package/dist/esm/api/resources/taskGroups/client/Client.mjs +118 -0
  63. package/dist/esm/api/types/OrderSortByEnum.d.mts +12 -0
  64. package/dist/esm/api/types/OrderSortByEnum.mjs +11 -0
  65. package/dist/esm/api/types/OrdersExpandedListRes.d.mts +8 -0
  66. package/dist/esm/api/types/OrdersExpandedListRes.mjs +4 -0
  67. package/dist/esm/api/types/index.d.mts +2 -0
  68. package/dist/esm/api/types/index.mjs +2 -0
  69. package/dist/esm/version.d.mts +1 -1
  70. package/dist/esm/version.mjs +1 -1
  71. package/package.json +1 -1
  72. package/reference.md +288 -0
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export const OrderSortByEnum = {
5
+ DraftStartedAtTimestamp: "draft_started_at_timestamp",
6
+ StagedAtTimestamp: "staged_at_timestamp",
7
+ InProgressAtTimestamp: "in_progress_at_timestamp",
8
+ CompletedAtTimestamp: "completed_at_timestamp",
9
+ ExceptionAtTimestamp: "exception_at_timestamp",
10
+ OrderCancelledAtTimestamp: "order_cancelled_at_timestamp",
11
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Chrt from "../index.mjs";
5
+ export interface OrdersExpandedListRes {
6
+ orders_expanded: Chrt.OrderExpanded[];
7
+ total_count: number;
8
+ }
@@ -0,0 +1,4 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export {};
@@ -59,8 +59,10 @@ export * from "./OrderAndTaskGroupExpandedReq.mjs";
59
59
  export * from "./OrderDraftExpandedListRes.mjs";
60
60
  export * from "./OrderDraftExpandedRes.mjs";
61
61
  export * from "./OrderExpanded.mjs";
62
+ export * from "./OrderSortByEnum.mjs";
62
63
  export * from "./OrderStatusEnum1.mjs";
63
64
  export * from "./OrdersDraftUpdateRes.mjs";
65
+ export * from "./OrdersExpandedListRes.mjs";
64
66
  export * from "./OrdersNewDraftRes.mjs";
65
67
  export * from "./OrgMemberDetails.mjs";
66
68
  export * from "./OrgMembersAndDrivers.mjs";
@@ -59,8 +59,10 @@ export * from "./OrderAndTaskGroupExpandedReq.mjs";
59
59
  export * from "./OrderDraftExpandedListRes.mjs";
60
60
  export * from "./OrderDraftExpandedRes.mjs";
61
61
  export * from "./OrderExpanded.mjs";
62
+ export * from "./OrderSortByEnum.mjs";
62
63
  export * from "./OrderStatusEnum1.mjs";
63
64
  export * from "./OrdersDraftUpdateRes.mjs";
65
+ export * from "./OrdersExpandedListRes.mjs";
64
66
  export * from "./OrdersNewDraftRes.mjs";
65
67
  export * from "./OrgMemberDetails.mjs";
66
68
  export * from "./OrgMembersAndDrivers.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.315.0";
1
+ export declare const SDK_VERSION = "1.318.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.315.0";
1
+ export const SDK_VERSION = "1.318.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@chrt-inc/typescript-sdk",
3
- "version": "1.315.0",
3
+ "version": "1.318.0",
4
4
  "private": false,
5
5
  "repository": "github:chrt-inc/typescript-sdk",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -5952,6 +5952,132 @@ await client.orderDrafts.validateV1("order_id");
5952
5952
 
5953
5953
  ## TaskGroups
5954
5954
 
5955
+ <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getTaskGroupIdForCourierOperatorsV1</a>(byOrderIdOrShortId) -> string</code></summary>
5956
+ <dl>
5957
+ <dd>
5958
+
5959
+ #### 📝 Description
5960
+
5961
+ <dl>
5962
+ <dd>
5963
+
5964
+ <dl>
5965
+ <dd>
5966
+
5967
+ Retrieves the task group ID for the courier organization assigned to an order. | authz_personas=[courier_org_operators] | () -> (PydanticObjectId)
5968
+
5969
+ </dd>
5970
+ </dl>
5971
+ </dd>
5972
+ </dl>
5973
+
5974
+ #### 🔌 Usage
5975
+
5976
+ <dl>
5977
+ <dd>
5978
+
5979
+ <dl>
5980
+ <dd>
5981
+
5982
+ ```typescript
5983
+ await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_short_id");
5984
+ ```
5985
+
5986
+ </dd>
5987
+ </dl>
5988
+ </dd>
5989
+ </dl>
5990
+
5991
+ #### ⚙️ Parameters
5992
+
5993
+ <dl>
5994
+ <dd>
5995
+
5996
+ <dl>
5997
+ <dd>
5998
+
5999
+ **byOrderIdOrShortId:** `string`
6000
+
6001
+ </dd>
6002
+ </dl>
6003
+
6004
+ <dl>
6005
+ <dd>
6006
+
6007
+ **requestOptions:** `TaskGroups.RequestOptions`
6008
+
6009
+ </dd>
6010
+ </dl>
6011
+ </dd>
6012
+ </dl>
6013
+
6014
+ </dd>
6015
+ </dl>
6016
+ </details>
6017
+
6018
+ <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getTaskGroupIdForCourierDriverV1</a>(byOrderIdOrShortId) -> string</code></summary>
6019
+ <dl>
6020
+ <dd>
6021
+
6022
+ #### 📝 Description
6023
+
6024
+ <dl>
6025
+ <dd>
6026
+
6027
+ <dl>
6028
+ <dd>
6029
+
6030
+ Retrieves the task group ID for the courier driver assigned to an order. | authz_personas=[courier_driver] | () -> (PydanticObjectId)
6031
+
6032
+ </dd>
6033
+ </dl>
6034
+ </dd>
6035
+ </dl>
6036
+
6037
+ #### 🔌 Usage
6038
+
6039
+ <dl>
6040
+ <dd>
6041
+
6042
+ <dl>
6043
+ <dd>
6044
+
6045
+ ```typescript
6046
+ await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_id");
6047
+ ```
6048
+
6049
+ </dd>
6050
+ </dl>
6051
+ </dd>
6052
+ </dl>
6053
+
6054
+ #### ⚙️ Parameters
6055
+
6056
+ <dl>
6057
+ <dd>
6058
+
6059
+ <dl>
6060
+ <dd>
6061
+
6062
+ **byOrderIdOrShortId:** `string`
6063
+
6064
+ </dd>
6065
+ </dl>
6066
+
6067
+ <dl>
6068
+ <dd>
6069
+
6070
+ **requestOptions:** `TaskGroups.RequestOptions`
6071
+
6072
+ </dd>
6073
+ </dl>
6074
+ </dd>
6075
+ </dl>
6076
+
6077
+ </dd>
6078
+ </dl>
6079
+ </details>
6080
+
5955
6081
  <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
5956
6082
  <dl>
5957
6083
  <dd>
@@ -9354,6 +9480,168 @@ await client.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {})
9354
9480
  </dl>
9355
9481
  </details>
9356
9482
 
9483
+ <details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">listForForwarderOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
9484
+ <dl>
9485
+ <dd>
9486
+
9487
+ #### 📝 Description
9488
+
9489
+ <dl>
9490
+ <dd>
9491
+
9492
+ <dl>
9493
+ <dd>
9494
+
9495
+ Lists expanded orders for forwarder operators with filtering, sorting, and pagination. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
9496
+
9497
+ </dd>
9498
+ </dl>
9499
+ </dd>
9500
+ </dl>
9501
+
9502
+ #### 🔌 Usage
9503
+
9504
+ <dl>
9505
+ <dd>
9506
+
9507
+ <dl>
9508
+ <dd>
9509
+
9510
+ ```typescript
9511
+ await client.orders.expanded.listForForwarderOperatorsV1({
9512
+ sort_by: "draft_started_at_timestamp",
9513
+ sort_order: "ascending",
9514
+ page: 1,
9515
+ page_size: 1,
9516
+ filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
9517
+ filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
9518
+ filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
9519
+ filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
9520
+ filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
9521
+ filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
9522
+ filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
9523
+ filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
9524
+ filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
9525
+ filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
9526
+ filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
9527
+ filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
9528
+ body: {},
9529
+ });
9530
+ ```
9531
+
9532
+ </dd>
9533
+ </dl>
9534
+ </dd>
9535
+ </dl>
9536
+
9537
+ #### ⚙️ Parameters
9538
+
9539
+ <dl>
9540
+ <dd>
9541
+
9542
+ <dl>
9543
+ <dd>
9544
+
9545
+ **request:** `Chrt.orders.ExpandedListForForwarderOperatorsV1Request`
9546
+
9547
+ </dd>
9548
+ </dl>
9549
+
9550
+ <dl>
9551
+ <dd>
9552
+
9553
+ **requestOptions:** `Expanded.RequestOptions`
9554
+
9555
+ </dd>
9556
+ </dl>
9557
+ </dd>
9558
+ </dl>
9559
+
9560
+ </dd>
9561
+ </dl>
9562
+ </details>
9563
+
9564
+ <details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">listForShipperOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
9565
+ <dl>
9566
+ <dd>
9567
+
9568
+ #### 📝 Description
9569
+
9570
+ <dl>
9571
+ <dd>
9572
+
9573
+ <dl>
9574
+ <dd>
9575
+
9576
+ Lists expanded orders for shipper operators with filtering, sorting, and pagination. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
9577
+
9578
+ </dd>
9579
+ </dl>
9580
+ </dd>
9581
+ </dl>
9582
+
9583
+ #### 🔌 Usage
9584
+
9585
+ <dl>
9586
+ <dd>
9587
+
9588
+ <dl>
9589
+ <dd>
9590
+
9591
+ ```typescript
9592
+ await client.orders.expanded.listForShipperOperatorsV1({
9593
+ sort_by: "draft_started_at_timestamp",
9594
+ sort_order: "ascending",
9595
+ page: 1,
9596
+ page_size: 1,
9597
+ filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
9598
+ filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
9599
+ filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
9600
+ filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
9601
+ filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
9602
+ filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
9603
+ filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
9604
+ filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
9605
+ filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
9606
+ filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
9607
+ filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
9608
+ filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
9609
+ body: {},
9610
+ });
9611
+ ```
9612
+
9613
+ </dd>
9614
+ </dl>
9615
+ </dd>
9616
+ </dl>
9617
+
9618
+ #### ⚙️ Parameters
9619
+
9620
+ <dl>
9621
+ <dd>
9622
+
9623
+ <dl>
9624
+ <dd>
9625
+
9626
+ **request:** `Chrt.orders.ExpandedListForShipperOperatorsV1Request`
9627
+
9628
+ </dd>
9629
+ </dl>
9630
+
9631
+ <dl>
9632
+ <dd>
9633
+
9634
+ **requestOptions:** `Expanded.RequestOptions`
9635
+
9636
+ </dd>
9637
+ </dl>
9638
+ </dd>
9639
+ </dl>
9640
+
9641
+ </dd>
9642
+ </dl>
9643
+ </details>
9644
+
9357
9645
  ## OrgInfoForConnections Shipper
9358
9646
 
9359
9647
  <details><summary><code>client.orgInfoForConnections.shipper.<a href="/src/api/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>