@chrt-inc/typescript-sdk 1.616.0 → 1.625.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 (86) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.d.ts +0 -1
  3. package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +0 -1
  4. package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListForCourierOrgV1Request.d.ts +0 -1
  5. package/dist/cjs/api/resources/billing/resources/statements/client/Client.d.ts +0 -2
  6. package/dist/cjs/api/resources/billing/resources/statements/client/Client.js +0 -2
  7. package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.ts +0 -1
  8. package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.ts +0 -1
  9. package/dist/cjs/api/resources/orgs/client/Client.d.ts +0 -1
  10. package/dist/cjs/api/resources/orgs/client/Client.js +0 -1
  11. package/dist/cjs/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.ts +0 -1
  12. package/dist/cjs/api/resources/shipping/client/Client.d.ts +0 -3
  13. package/dist/cjs/api/resources/shipping/client/Client.js +16 -21
  14. package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +0 -1
  15. package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +0 -1
  16. package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.ts +0 -1
  17. package/dist/cjs/api/resources/shipping/resources/index.d.ts +0 -2
  18. package/dist/cjs/api/resources/shipping/resources/index.js +1 -3
  19. package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +0 -2
  20. package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +0 -2
  21. package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.d.ts +0 -1
  22. package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +0 -1
  23. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +0 -2
  24. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +0 -2
  25. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.ts +0 -1
  26. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.ts +0 -1
  27. package/dist/cjs/api/types/index.d.ts +0 -1
  28. package/dist/cjs/api/types/index.js +0 -1
  29. package/dist/cjs/version.d.ts +1 -1
  30. package/dist/cjs/version.js +1 -1
  31. package/dist/esm/Client.mjs +2 -2
  32. package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.d.mts +0 -1
  33. package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +0 -1
  34. package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListForCourierOrgV1Request.d.mts +0 -1
  35. package/dist/esm/api/resources/billing/resources/statements/client/Client.d.mts +0 -2
  36. package/dist/esm/api/resources/billing/resources/statements/client/Client.mjs +0 -2
  37. package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.mts +0 -1
  38. package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.mts +0 -1
  39. package/dist/esm/api/resources/orgs/client/Client.d.mts +0 -1
  40. package/dist/esm/api/resources/orgs/client/Client.mjs +0 -1
  41. package/dist/esm/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.mts +0 -1
  42. package/dist/esm/api/resources/shipping/client/Client.d.mts +0 -3
  43. package/dist/esm/api/resources/shipping/client/Client.mjs +0 -5
  44. package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +0 -1
  45. package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +0 -1
  46. package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts +0 -1
  47. package/dist/esm/api/resources/shipping/resources/index.d.mts +0 -2
  48. package/dist/esm/api/resources/shipping/resources/index.mjs +0 -2
  49. package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +0 -2
  50. package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +0 -2
  51. package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.d.mts +0 -1
  52. package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +0 -1
  53. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +0 -2
  54. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +0 -2
  55. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.mts +0 -1
  56. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.mts +0 -1
  57. package/dist/esm/api/types/index.d.mts +0 -1
  58. package/dist/esm/api/types/index.mjs +0 -1
  59. package/dist/esm/version.d.mts +1 -1
  60. package/dist/esm/version.mjs +1 -1
  61. package/package.json +1 -1
  62. package/reference.md +0 -77
  63. package/dist/cjs/api/resources/shipping/resources/docs/client/Client.d.ts +0 -40
  64. package/dist/cjs/api/resources/shipping/resources/docs/client/Client.js +0 -124
  65. package/dist/cjs/api/resources/shipping/resources/docs/client/index.d.ts +0 -2
  66. package/dist/cjs/api/resources/shipping/resources/docs/client/index.js +0 -17
  67. package/dist/cjs/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.ts +0 -15
  68. package/dist/cjs/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.js +0 -5
  69. package/dist/cjs/api/resources/shipping/resources/docs/client/requests/index.d.ts +0 -1
  70. package/dist/cjs/api/resources/shipping/resources/docs/client/requests/index.js +0 -2
  71. package/dist/cjs/api/resources/shipping/resources/docs/index.d.ts +0 -1
  72. package/dist/cjs/api/resources/shipping/resources/docs/index.js +0 -17
  73. package/dist/cjs/api/types/ShippingDocTemplateEnum.d.ts +0 -8
  74. package/dist/cjs/api/types/ShippingDocTemplateEnum.js +0 -10
  75. package/dist/esm/api/resources/shipping/resources/docs/client/Client.d.mts +0 -40
  76. package/dist/esm/api/resources/shipping/resources/docs/client/Client.mjs +0 -87
  77. package/dist/esm/api/resources/shipping/resources/docs/client/index.d.mts +0 -2
  78. package/dist/esm/api/resources/shipping/resources/docs/client/index.mjs +0 -1
  79. package/dist/esm/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.mts +0 -15
  80. package/dist/esm/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.mjs +0 -4
  81. package/dist/esm/api/resources/shipping/resources/docs/client/requests/index.d.mts +0 -1
  82. package/dist/esm/api/resources/shipping/resources/docs/client/requests/index.mjs +0 -1
  83. package/dist/esm/api/resources/shipping/resources/docs/index.d.mts +0 -1
  84. package/dist/esm/api/resources/shipping/resources/docs/index.mjs +0 -1
  85. package/dist/esm/api/types/ShippingDocTemplateEnum.d.mts +0 -8
  86. package/dist/esm/api/types/ShippingDocTemplateEnum.mjs +0 -7
@@ -1,4 +1,3 @@
1
- export * as docs from "./docs/index.mjs";
2
1
  export * as drivers from "./drivers/index.mjs";
3
2
  export * as cargos from "./cargos/index.mjs";
4
3
  export * as flights from "./flights/index.mjs";
@@ -7,7 +6,6 @@ export * as orders from "./orders/index.mjs";
7
6
  export * as orderDrafts from "./orderDrafts/index.mjs";
8
7
  export * as taskGroups from "./taskGroups/index.mjs";
9
8
  export * as tasks from "./tasks/index.mjs";
10
- export * from "./docs/client/requests/index.mjs";
11
9
  export * from "./drivers/client/requests/index.mjs";
12
10
  export * from "./taskArtifacts/client/requests/index.mjs";
13
11
  export * from "./orders/client/requests/index.mjs";
@@ -73,7 +73,6 @@ export declare class Expanded {
73
73
  * page: 1,
74
74
  * page_size: 1,
75
75
  * search: "search",
76
- * filter_status: ["draft"],
77
76
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
78
77
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
79
78
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -110,7 +109,6 @@ export declare class Expanded {
110
109
  * page: 1,
111
110
  * page_size: 1,
112
111
  * search: "search",
113
- * filter_status: ["draft"],
114
112
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
115
113
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
116
114
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -160,7 +160,6 @@ export class Expanded {
160
160
  * page: 1,
161
161
  * page_size: 1,
162
162
  * search: "search",
163
- * filter_status: ["draft"],
164
163
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
165
164
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
166
165
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -319,7 +318,6 @@ export class Expanded {
319
318
  * page: 1,
320
319
  * page_size: 1,
321
320
  * search: "search",
322
- * filter_status: ["draft"],
323
321
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
324
322
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
325
323
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -10,7 +10,6 @@ import * as Chrt from "../../../../../../../../index.mjs";
10
10
  * page: 1,
11
11
  * page_size: 1,
12
12
  * search: "search",
13
- * filter_status: ["draft"],
14
13
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
15
14
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
16
15
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -10,7 +10,6 @@ import * as Chrt from "../../../../../../../../index.mjs";
10
10
  * page: 1,
11
11
  * page_size: 1,
12
12
  * search: "search",
13
- * filter_status: ["draft"],
14
13
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
15
14
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
16
15
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -101,7 +101,6 @@ export declare class Expanded {
101
101
  * page: 1,
102
102
  * page_size: 1,
103
103
  * search: "search",
104
- * filter_status: ["draft"],
105
104
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
106
105
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
107
106
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -139,7 +138,6 @@ export declare class Expanded {
139
138
  * page: 1,
140
139
  * page_size: 1,
141
140
  * search: "search",
142
- * filter_status: ["draft"],
143
141
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
144
142
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
145
143
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -286,7 +286,6 @@ export class Expanded {
286
286
  * page: 1,
287
287
  * page_size: 1,
288
288
  * search: "search",
289
- * filter_status: ["draft"],
290
289
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
291
290
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
292
291
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -449,7 +448,6 @@ export class Expanded {
449
448
  * page: 1,
450
449
  * page_size: 1,
451
450
  * search: "search",
452
- * filter_status: ["draft"],
453
451
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
454
452
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
455
453
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -10,7 +10,6 @@ import * as Chrt from "../../../../../../../../index.mjs";
10
10
  * page: 1,
11
11
  * page_size: 1,
12
12
  * search: "search",
13
- * filter_status: ["draft"],
14
13
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
15
14
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
16
15
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -10,7 +10,6 @@ import * as Chrt from "../../../../../../../../index.mjs";
10
10
  * page: 1,
11
11
  * page_size: 1,
12
12
  * search: "search",
13
- * filter_status: ["draft"],
14
13
  * filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
15
14
  * filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
16
15
  * filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -195,7 +195,6 @@ export * from "./ShipperConnectionRes.mjs";
195
195
  export * from "./ShipperCourierConnection1.mjs";
196
196
  export * from "./ShipperForwarderConnection1.mjs";
197
197
  export * from "./ShipperOrgInfoForConnections1.mjs";
198
- export * from "./ShippingDocTemplateEnum.mjs";
199
198
  export * from "./ShippingOrderCancelledWebhookPayload.mjs";
200
199
  export * from "./ShippingOrderCompletedWebhookPayload.mjs";
201
200
  export * from "./ShippingOrderStagedWebhookPayload.mjs";
@@ -195,7 +195,6 @@ export * from "./ShipperConnectionRes.mjs";
195
195
  export * from "./ShipperCourierConnection1.mjs";
196
196
  export * from "./ShipperForwarderConnection1.mjs";
197
197
  export * from "./ShipperOrgInfoForConnections1.mjs";
198
- export * from "./ShippingDocTemplateEnum.mjs";
199
198
  export * from "./ShippingOrderCancelledWebhookPayload.mjs";
200
199
  export * from "./ShippingOrderCompletedWebhookPayload.mjs";
201
200
  export * from "./ShippingOrderStagedWebhookPayload.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.616.0";
1
+ export declare const SDK_VERSION = "1.625.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.616.0";
1
+ export const SDK_VERSION = "1.625.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@chrt-inc/typescript-sdk",
3
- "version": "1.616.0",
3
+ "version": "1.625.0",
4
4
  "private": false,
5
5
  "repository": "github:chrt-inc/typescript-sdk",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -86,7 +86,6 @@ Lists all members of the caller's organization with their roles and details. Sup
86
86
 
87
87
  ```typescript
88
88
  await client.orgs.listMembersV1({
89
- filter_role: ["owner"],
90
89
  sort_by: "first_name",
91
90
  sort_order: "asc",
92
91
  page: 1,
@@ -478,7 +477,6 @@ Lists line item groups for the authenticated courier organization with filtering
478
477
  ```typescript
479
478
  await client.billing.lineItemGroups.listForCourierOrgV1({
480
479
  filter_driver_id: "filter_driver_id",
481
- filter_status: ["staged"],
482
480
  filter_attached_to_statement: true,
483
481
  filter_order_id: "filter_order_id",
484
482
  filter_payment_role: "origin",
@@ -1711,7 +1709,6 @@ await client.billing.statements.listV1({
1711
1709
  sort_order: "asc",
1712
1710
  page: 1,
1713
1711
  page_size: 1,
1714
- filter_status: ["staged"],
1715
1712
  filter_settlement_type: "stripe_connect",
1716
1713
  filter_order_id: "filter_order_id",
1717
1714
  filter_order_short_id: "filter_order_short_id",
@@ -1796,7 +1793,6 @@ await client.billing.statements.expandedListV1({
1796
1793
  sort_order: "asc",
1797
1794
  page: 1,
1798
1795
  page_size: 1,
1799
- filter_status: ["staged"],
1800
1796
  filter_settlement_type: "stripe_connect",
1801
1797
  filter_order_id: "filter_order_id",
1802
1798
  filter_order_short_id: "filter_order_short_id",
@@ -7619,74 +7615,6 @@ await client.orgs.orgInfoForConnections.forwarder.updateV1();
7619
7615
  </dl>
7620
7616
  </details>
7621
7617
 
7622
- ## Shipping Docs
7623
-
7624
- <details><summary><code>client.shipping.docs.<a href="/src/api/resources/shipping/resources/docs/client/Client.ts">postGenerateV1</a>({ ...params }) -> core.BinaryResponse</code></summary>
7625
- <dl>
7626
- <dd>
7627
-
7628
- #### 📝 Description
7629
-
7630
- <dl>
7631
- <dd>
7632
-
7633
- <dl>
7634
- <dd>
7635
-
7636
- Generates a shipping document (BOL or POD) as a PDF for the given order. | authz_personas=[order_creator_org_operators] | (GenerateShippingDocReq) -> (PDF binary)
7637
-
7638
- </dd>
7639
- </dl>
7640
- </dd>
7641
- </dl>
7642
-
7643
- #### 🔌 Usage
7644
-
7645
- <dl>
7646
- <dd>
7647
-
7648
- <dl>
7649
- <dd>
7650
-
7651
- ```typescript
7652
- await client.shipping.docs.postGenerateV1({
7653
- order_ref: "order_ref",
7654
- template: "pod",
7655
- });
7656
- ```
7657
-
7658
- </dd>
7659
- </dl>
7660
- </dd>
7661
- </dl>
7662
-
7663
- #### ⚙️ Parameters
7664
-
7665
- <dl>
7666
- <dd>
7667
-
7668
- <dl>
7669
- <dd>
7670
-
7671
- **request:** `Chrt.shipping.GenerateShippingDocReq`
7672
-
7673
- </dd>
7674
- </dl>
7675
-
7676
- <dl>
7677
- <dd>
7678
-
7679
- **requestOptions:** `Docs.RequestOptions`
7680
-
7681
- </dd>
7682
- </dl>
7683
- </dd>
7684
- </dl>
7685
-
7686
- </dd>
7687
- </dl>
7688
- </details>
7689
-
7690
7618
  ## Shipping Drivers
7691
7619
 
7692
7620
  <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
@@ -7837,7 +7765,6 @@ Lists all organization members paired with their driver information if they are
7837
7765
  ```typescript
7838
7766
  await client.shipping.drivers.listOrgMembersAndDriversV1({
7839
7767
  search: "search",
7840
- filter_role: ["owner"],
7841
7768
  filter_available_according_to_driver: true,
7842
7769
  filter_available_according_to_operators: true,
7843
7770
  sort_by: "first_name",
@@ -11592,7 +11519,6 @@ await client.shipping.orders.expanded.listForForwarderOperatorsV1({
11592
11519
  page: 1,
11593
11520
  page_size: 1,
11594
11521
  search: "search",
11595
- filter_status: ["draft"],
11596
11522
  filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
11597
11523
  filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
11598
11524
  filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -11679,7 +11605,6 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
11679
11605
  page: 1,
11680
11606
  page_size: 1,
11681
11607
  search: "search",
11682
- filter_status: ["draft"],
11683
11608
  filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
11684
11609
  filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
11685
11610
  filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -12773,7 +12698,6 @@ await client.shipping.taskGroups.expanded.listForCourierOperatorsV1({
12773
12698
  page: 1,
12774
12699
  page_size: 1,
12775
12700
  search: "search",
12776
- filter_status: ["draft"],
12777
12701
  filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
12778
12702
  filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
12779
12703
  filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -12861,7 +12785,6 @@ await client.shipping.taskGroups.expanded.listForCourierDriverV1({
12861
12785
  page: 1,
12862
12786
  page_size: 1,
12863
12787
  search: "search",
12864
- filter_status: ["draft"],
12865
12788
  filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
12866
12789
  filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
12867
12790
  filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -1,40 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as environments from "../../../../../../environments.js";
5
- import * as core from "../../../../../../core/index.js";
6
- import * as Chrt from "../../../../../index.js";
7
- export declare namespace Docs {
8
- interface Options {
9
- environment?: core.Supplier<environments.ChrtEnvironment | string>;
10
- /** Specify a custom URL to connect the client to. */
11
- baseUrl?: core.Supplier<string>;
12
- token?: core.Supplier<core.BearerToken | undefined>;
13
- /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
- fetcher?: core.FetchFunction;
16
- }
17
- interface RequestOptions {
18
- /** The maximum time to wait for a response in seconds. */
19
- timeoutInSeconds?: number;
20
- /** The number of times to retry the request. Defaults to 2. */
21
- maxRetries?: number;
22
- /** A hook to abort the request. */
23
- abortSignal?: AbortSignal;
24
- /** Additional query string parameters to include in the request. */
25
- queryParams?: Record<string, unknown>;
26
- /** Additional headers to include in the request. */
27
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
28
- }
29
- }
30
- export declare class Docs {
31
- protected readonly _options: Docs.Options;
32
- constructor(_options?: Docs.Options);
33
- /**
34
- * Generates a shipping document (BOL or POD) as a PDF for the given order. | authz_personas=[order_creator_org_operators] | (GenerateShippingDocReq) -> (PDF binary)
35
- * @throws {@link Chrt.UnprocessableEntityError}
36
- */
37
- postGenerateV1(request: Chrt.shipping.GenerateShippingDocReq, requestOptions?: Docs.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
38
- private __postGenerateV1;
39
- protected _getAuthorizationHeader(): Promise<string | undefined>;
40
- }
@@ -1,124 +0,0 @@
1
- "use strict";
2
- /**
3
- * This file was auto-generated by Fern from our API Definition.
4
- */
5
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
- if (k2 === undefined) k2 = k;
7
- var desc = Object.getOwnPropertyDescriptor(m, k);
8
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
- desc = { enumerable: true, get: function() { return m[k]; } };
10
- }
11
- Object.defineProperty(o, k2, desc);
12
- }) : (function(o, m, k, k2) {
13
- if (k2 === undefined) k2 = k;
14
- o[k2] = m[k];
15
- }));
16
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
- Object.defineProperty(o, "default", { enumerable: true, value: v });
18
- }) : function(o, v) {
19
- o["default"] = v;
20
- });
21
- var __importStar = (this && this.__importStar) || (function () {
22
- var ownKeys = function(o) {
23
- ownKeys = Object.getOwnPropertyNames || function (o) {
24
- var ar = [];
25
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
- return ar;
27
- };
28
- return ownKeys(o);
29
- };
30
- return function (mod) {
31
- if (mod && mod.__esModule) return mod;
32
- var result = {};
33
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
- __setModuleDefault(result, mod);
35
- return result;
36
- };
37
- })();
38
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
39
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
40
- return new (P || (P = Promise))(function (resolve, reject) {
41
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
42
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
43
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
44
- step((generator = generator.apply(thisArg, _arguments || [])).next());
45
- });
46
- };
47
- Object.defineProperty(exports, "__esModule", { value: true });
48
- exports.Docs = void 0;
49
- const environments = __importStar(require("../../../../../../environments.js"));
50
- const core = __importStar(require("../../../../../../core/index.js"));
51
- const Chrt = __importStar(require("../../../../../index.js"));
52
- const headers_js_1 = require("../../../../../../core/headers.js");
53
- const errors = __importStar(require("../../../../../../errors/index.js"));
54
- class Docs {
55
- constructor(_options = {}) {
56
- this._options = _options;
57
- }
58
- /**
59
- * Generates a shipping document (BOL or POD) as a PDF for the given order. | authz_personas=[order_creator_org_operators] | (GenerateShippingDocReq) -> (PDF binary)
60
- * @throws {@link Chrt.UnprocessableEntityError}
61
- */
62
- postGenerateV1(request, requestOptions) {
63
- return core.HttpResponsePromise.fromPromise(this.__postGenerateV1(request, requestOptions));
64
- }
65
- __postGenerateV1(request, requestOptions) {
66
- return __awaiter(this, void 0, void 0, function* () {
67
- var _a, _b, _c, _d;
68
- let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
69
- const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
70
- url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "shipping/docs/v1"),
71
- method: "POST",
72
- headers: _headers,
73
- contentType: "application/json",
74
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
75
- requestType: "json",
76
- body: request,
77
- responseType: "binary-response",
78
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
79
- maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
80
- abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
81
- });
82
- if (_response.ok) {
83
- return { data: _response.body, rawResponse: _response.rawResponse };
84
- }
85
- if (_response.error.reason === "status-code") {
86
- switch (_response.error.statusCode) {
87
- case 422:
88
- throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
89
- default:
90
- throw new errors.ChrtError({
91
- statusCode: _response.error.statusCode,
92
- body: _response.error.body,
93
- rawResponse: _response.rawResponse,
94
- });
95
- }
96
- }
97
- switch (_response.error.reason) {
98
- case "non-json":
99
- throw new errors.ChrtError({
100
- statusCode: _response.error.statusCode,
101
- body: _response.error.rawBody,
102
- rawResponse: _response.rawResponse,
103
- });
104
- case "timeout":
105
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/docs/v1.");
106
- case "unknown":
107
- throw new errors.ChrtError({
108
- message: _response.error.errorMessage,
109
- rawResponse: _response.rawResponse,
110
- });
111
- }
112
- });
113
- }
114
- _getAuthorizationHeader() {
115
- return __awaiter(this, void 0, void 0, function* () {
116
- const bearer = yield core.Supplier.get(this._options.token);
117
- if (bearer != null) {
118
- return `Bearer ${bearer}`;
119
- }
120
- return undefined;
121
- });
122
- }
123
- }
124
- exports.Docs = Docs;
@@ -1,2 +0,0 @@
1
- export {};
2
- export * from "./requests/index.js";
@@ -1,17 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./requests/index.js"), exports);
@@ -1,15 +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
- * order_ref: "order_ref",
9
- * template: "pod"
10
- * }
11
- */
12
- export interface GenerateShippingDocReq {
13
- order_ref: string;
14
- template: Chrt.ShippingDocTemplateEnum;
15
- }
@@ -1,5 +0,0 @@
1
- "use strict";
2
- /**
3
- * This file was auto-generated by Fern from our API Definition.
4
- */
5
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1 +0,0 @@
1
- export { type GenerateShippingDocReq } from "./GenerateShippingDocReq.js";
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1 +0,0 @@
1
- export * from "./client/index.js";
@@ -1,17 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./client/index.js"), exports);
@@ -1,8 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- export type ShippingDocTemplateEnum = "pod" | "bol";
5
- export declare const ShippingDocTemplateEnum: {
6
- readonly Pod: "pod";
7
- readonly Bol: "bol";
8
- };
@@ -1,10 +0,0 @@
1
- "use strict";
2
- /**
3
- * This file was auto-generated by Fern from our API Definition.
4
- */
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.ShippingDocTemplateEnum = void 0;
7
- exports.ShippingDocTemplateEnum = {
8
- Pod: "pod",
9
- Bol: "bol",
10
- };
@@ -1,40 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as environments from "../../../../../../environments.mjs";
5
- import * as core from "../../../../../../core/index.mjs";
6
- import * as Chrt from "../../../../../index.mjs";
7
- export declare namespace Docs {
8
- interface Options {
9
- environment?: core.Supplier<environments.ChrtEnvironment | string>;
10
- /** Specify a custom URL to connect the client to. */
11
- baseUrl?: core.Supplier<string>;
12
- token?: core.Supplier<core.BearerToken | undefined>;
13
- /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
- fetcher?: core.FetchFunction;
16
- }
17
- interface RequestOptions {
18
- /** The maximum time to wait for a response in seconds. */
19
- timeoutInSeconds?: number;
20
- /** The number of times to retry the request. Defaults to 2. */
21
- maxRetries?: number;
22
- /** A hook to abort the request. */
23
- abortSignal?: AbortSignal;
24
- /** Additional query string parameters to include in the request. */
25
- queryParams?: Record<string, unknown>;
26
- /** Additional headers to include in the request. */
27
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
28
- }
29
- }
30
- export declare class Docs {
31
- protected readonly _options: Docs.Options;
32
- constructor(_options?: Docs.Options);
33
- /**
34
- * Generates a shipping document (BOL or POD) as a PDF for the given order. | authz_personas=[order_creator_org_operators] | (GenerateShippingDocReq) -> (PDF binary)
35
- * @throws {@link Chrt.UnprocessableEntityError}
36
- */
37
- postGenerateV1(request: Chrt.shipping.GenerateShippingDocReq, requestOptions?: Docs.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
38
- private __postGenerateV1;
39
- protected _getAuthorizationHeader(): Promise<string | undefined>;
40
- }