@chrt-inc/typescript-sdk 1.303.0 → 1.304.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 (163) hide show
  1. package/README.md +0 -604
  2. package/dist/cjs/Client.js +2 -2
  3. package/dist/cjs/api/resources/connections/client/Client.d.ts +3 -3
  4. package/dist/cjs/api/resources/connections/client/Client.js +3 -3
  5. package/dist/cjs/api/resources/connections/resources/connectionToCourier/client/Client.d.ts +1 -1
  6. package/dist/cjs/api/resources/connections/resources/connectionToCourier/client/Client.js +1 -1
  7. package/dist/cjs/api/resources/connections/resources/connectionToForwarder/client/Client.d.ts +1 -1
  8. package/dist/cjs/api/resources/connections/resources/connectionToForwarder/client/Client.js +1 -1
  9. package/dist/cjs/api/resources/connections/resources/connectionToShipper/client/Client.d.ts +1 -1
  10. package/dist/cjs/api/resources/connections/resources/connectionToShipper/client/Client.js +1 -1
  11. package/dist/cjs/api/resources/dev/client/Client.d.ts +9 -9
  12. package/dist/cjs/api/resources/dev/client/Client.js +9 -9
  13. package/dist/cjs/api/resources/notifications/resources/courier/client/Client.d.ts +2 -2
  14. package/dist/cjs/api/resources/notifications/resources/courier/client/Client.js +2 -2
  15. package/dist/cjs/api/resources/notifications/resources/shipper/client/Client.d.ts +2 -2
  16. package/dist/cjs/api/resources/notifications/resources/shipper/client/Client.js +2 -2
  17. package/dist/cjs/api/resources/orderDrafts/client/Client.d.ts +27 -0
  18. package/dist/cjs/api/resources/orderDrafts/client/Client.js +125 -0
  19. package/dist/cjs/api/resources/orderDrafts/client/requests/index.d.ts +2 -0
  20. package/dist/cjs/api/resources/orders/client/Client.d.ts +0 -3
  21. package/dist/cjs/api/resources/orders/client/Client.js +0 -5
  22. package/dist/cjs/api/resources/orders/resources/index.d.ts +0 -1
  23. package/dist/cjs/api/resources/orders/resources/index.js +1 -2
  24. package/dist/cjs/api/resources/orgConnectionInfos/resources/courier/client/Client.d.ts +3 -3
  25. package/dist/cjs/api/resources/orgConnectionInfos/resources/courier/client/Client.js +3 -3
  26. package/dist/cjs/api/resources/orgConnectionInfos/resources/shipper/client/Client.d.ts +3 -3
  27. package/dist/cjs/api/resources/orgConnectionInfos/resources/shipper/client/Client.js +3 -3
  28. package/dist/cjs/api/resources/orgProfiles/client/Client.d.ts +7 -7
  29. package/dist/cjs/api/resources/orgProfiles/client/Client.js +7 -7
  30. package/dist/cjs/api/resources/orgs/client/Client.d.ts +8 -8
  31. package/dist/cjs/api/resources/orgs/client/Client.js +7 -7
  32. package/dist/cjs/api/resources/root/client/Client.d.ts +8 -8
  33. package/dist/cjs/api/resources/root/client/Client.js +5 -5
  34. package/dist/cjs/api/resources/taskArtifactNotifications/client/Client.d.ts +2 -2
  35. package/dist/cjs/api/resources/taskArtifactNotifications/client/Client.js +2 -2
  36. package/dist/cjs/api/resources/tracking/resources/cargoByDevice/client/Client.d.ts +1 -1
  37. package/dist/cjs/api/resources/tracking/resources/cargoByDevice/client/Client.js +1 -1
  38. package/dist/cjs/api/resources/tracking/resources/cargoByDriver/client/Client.d.ts +1 -1
  39. package/dist/cjs/api/resources/tracking/resources/cargoByDriver/client/Client.js +1 -1
  40. package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +7 -7
  41. package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +7 -7
  42. package/dist/cjs/api/resources/tracking/resources/driver/client/Client.d.ts +2 -2
  43. package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js +1 -1
  44. package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.d.ts +14 -14
  45. package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.js +14 -14
  46. package/dist/cjs/api/resources/tracking/resources/taskGroupByDriver/client/Client.d.ts +1 -1
  47. package/dist/cjs/api/resources/tracking/resources/taskGroupByDriver/client/Client.js +1 -1
  48. package/dist/cjs/api/resources/users/client/Client.d.ts +1 -1
  49. package/dist/cjs/api/resources/users/client/Client.js +1 -1
  50. package/dist/cjs/api/resources/utils/client/Client.d.ts +1 -1
  51. package/dist/cjs/api/resources/utils/client/Client.js +1 -1
  52. package/dist/cjs/api/types/Cargo1.d.ts +1 -1
  53. package/dist/cjs/api/types/CargoClientCreate1.d.ts +1 -1
  54. package/dist/cjs/api/types/CargoClientUpdate1.d.ts +1 -1
  55. package/dist/{esm/api/types/DriverUpdateResp.d.mts → cjs/api/types/DriverUpdateRes.d.ts} +1 -1
  56. package/dist/cjs/api/types/TaskClientUpdate1.d.ts +0 -1
  57. package/dist/cjs/api/types/index.d.ts +1 -1
  58. package/dist/cjs/api/types/index.js +1 -1
  59. package/dist/cjs/version.d.ts +1 -1
  60. package/dist/cjs/version.js +1 -1
  61. package/dist/esm/Client.mjs +2 -2
  62. package/dist/esm/api/resources/connections/client/Client.d.mts +3 -3
  63. package/dist/esm/api/resources/connections/client/Client.mjs +3 -3
  64. package/dist/esm/api/resources/connections/resources/connectionToCourier/client/Client.d.mts +1 -1
  65. package/dist/esm/api/resources/connections/resources/connectionToCourier/client/Client.mjs +1 -1
  66. package/dist/esm/api/resources/connections/resources/connectionToForwarder/client/Client.d.mts +1 -1
  67. package/dist/esm/api/resources/connections/resources/connectionToForwarder/client/Client.mjs +1 -1
  68. package/dist/esm/api/resources/connections/resources/connectionToShipper/client/Client.d.mts +1 -1
  69. package/dist/esm/api/resources/connections/resources/connectionToShipper/client/Client.mjs +1 -1
  70. package/dist/esm/api/resources/dev/client/Client.d.mts +9 -9
  71. package/dist/esm/api/resources/dev/client/Client.mjs +9 -9
  72. package/dist/esm/api/resources/notifications/resources/courier/client/Client.d.mts +2 -2
  73. package/dist/esm/api/resources/notifications/resources/courier/client/Client.mjs +2 -2
  74. package/dist/esm/api/resources/notifications/resources/shipper/client/Client.d.mts +2 -2
  75. package/dist/esm/api/resources/notifications/resources/shipper/client/Client.mjs +2 -2
  76. package/dist/esm/api/resources/orderDrafts/client/Client.d.mts +27 -0
  77. package/dist/esm/api/resources/orderDrafts/client/Client.mjs +125 -0
  78. package/dist/esm/api/resources/orderDrafts/client/requests/index.d.mts +2 -0
  79. package/dist/esm/api/resources/orders/client/Client.d.mts +0 -3
  80. package/dist/esm/api/resources/orders/client/Client.mjs +0 -5
  81. package/dist/esm/api/resources/orders/resources/index.d.mts +0 -1
  82. package/dist/esm/api/resources/orders/resources/index.mjs +0 -1
  83. package/dist/esm/api/resources/orgConnectionInfos/resources/courier/client/Client.d.mts +3 -3
  84. package/dist/esm/api/resources/orgConnectionInfos/resources/courier/client/Client.mjs +3 -3
  85. package/dist/esm/api/resources/orgConnectionInfos/resources/shipper/client/Client.d.mts +3 -3
  86. package/dist/esm/api/resources/orgConnectionInfos/resources/shipper/client/Client.mjs +3 -3
  87. package/dist/esm/api/resources/orgProfiles/client/Client.d.mts +7 -7
  88. package/dist/esm/api/resources/orgProfiles/client/Client.mjs +7 -7
  89. package/dist/esm/api/resources/orgs/client/Client.d.mts +8 -8
  90. package/dist/esm/api/resources/orgs/client/Client.mjs +7 -7
  91. package/dist/esm/api/resources/root/client/Client.d.mts +8 -8
  92. package/dist/esm/api/resources/root/client/Client.mjs +5 -5
  93. package/dist/esm/api/resources/taskArtifactNotifications/client/Client.d.mts +2 -2
  94. package/dist/esm/api/resources/taskArtifactNotifications/client/Client.mjs +2 -2
  95. package/dist/esm/api/resources/tracking/resources/cargoByDevice/client/Client.d.mts +1 -1
  96. package/dist/esm/api/resources/tracking/resources/cargoByDevice/client/Client.mjs +1 -1
  97. package/dist/esm/api/resources/tracking/resources/cargoByDriver/client/Client.d.mts +1 -1
  98. package/dist/esm/api/resources/tracking/resources/cargoByDriver/client/Client.mjs +1 -1
  99. package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +7 -7
  100. package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +7 -7
  101. package/dist/esm/api/resources/tracking/resources/driver/client/Client.d.mts +2 -2
  102. package/dist/esm/api/resources/tracking/resources/driver/client/Client.mjs +1 -1
  103. package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.d.mts +14 -14
  104. package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.mjs +14 -14
  105. package/dist/esm/api/resources/tracking/resources/taskGroupByDriver/client/Client.d.mts +1 -1
  106. package/dist/esm/api/resources/tracking/resources/taskGroupByDriver/client/Client.mjs +1 -1
  107. package/dist/esm/api/resources/users/client/Client.d.mts +1 -1
  108. package/dist/esm/api/resources/users/client/Client.mjs +1 -1
  109. package/dist/esm/api/resources/utils/client/Client.d.mts +1 -1
  110. package/dist/esm/api/resources/utils/client/Client.mjs +1 -1
  111. package/dist/esm/api/types/Cargo1.d.mts +1 -1
  112. package/dist/esm/api/types/CargoClientCreate1.d.mts +1 -1
  113. package/dist/esm/api/types/CargoClientUpdate1.d.mts +1 -1
  114. package/dist/{cjs/api/types/DriverUpdateResp.d.ts → esm/api/types/DriverUpdateRes.d.mts} +1 -1
  115. package/dist/esm/api/types/TaskClientUpdate1.d.mts +0 -1
  116. package/dist/esm/api/types/index.d.mts +1 -1
  117. package/dist/esm/api/types/index.mjs +1 -1
  118. package/dist/esm/version.d.mts +1 -1
  119. package/dist/esm/version.mjs +1 -1
  120. package/package.json +1 -1
  121. package/reference.md +212 -214
  122. package/dist/cjs/api/resources/orders/resources/draft/client/Client.d.ts +0 -23
  123. package/dist/cjs/api/resources/orders/resources/draft/client/Client.js +0 -17
  124. package/dist/cjs/api/resources/orders/resources/draft/client/index.d.ts +0 -1
  125. package/dist/cjs/api/resources/orders/resources/draft/client/index.js +0 -2
  126. package/dist/cjs/api/resources/orders/resources/draft/index.d.ts +0 -2
  127. package/dist/cjs/api/resources/orders/resources/draft/index.js +0 -18
  128. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/Client.d.ts +0 -61
  129. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/Client.js +0 -193
  130. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/index.d.ts +0 -2
  131. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/index.js +0 -17
  132. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/requests/index.d.ts +0 -2
  133. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/requests/index.js +0 -2
  134. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/index.d.ts +0 -1
  135. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/index.js +0 -17
  136. package/dist/cjs/api/resources/orders/resources/draft/resources/index.d.ts +0 -2
  137. package/dist/cjs/api/resources/orders/resources/draft/resources/index.js +0 -41
  138. package/dist/esm/api/resources/orders/resources/draft/client/Client.d.mts +0 -23
  139. package/dist/esm/api/resources/orders/resources/draft/client/Client.mjs +0 -13
  140. package/dist/esm/api/resources/orders/resources/draft/client/index.d.mts +0 -1
  141. package/dist/esm/api/resources/orders/resources/draft/client/index.mjs +0 -1
  142. package/dist/esm/api/resources/orders/resources/draft/index.d.mts +0 -2
  143. package/dist/esm/api/resources/orders/resources/draft/index.mjs +0 -2
  144. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/Client.d.mts +0 -61
  145. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/Client.mjs +0 -156
  146. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/index.d.mts +0 -2
  147. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/index.mjs +0 -1
  148. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/requests/index.d.mts +0 -2
  149. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/requests/index.mjs +0 -1
  150. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/index.d.mts +0 -1
  151. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/index.mjs +0 -1
  152. package/dist/esm/api/resources/orders/resources/draft/resources/index.d.mts +0 -2
  153. package/dist/esm/api/resources/orders/resources/draft/resources/index.mjs +0 -2
  154. /package/dist/cjs/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedListReq.d.ts +0 -0
  155. /package/dist/cjs/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedListReq.js +0 -0
  156. /package/dist/cjs/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedReq.d.ts +0 -0
  157. /package/dist/cjs/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedReq.js +0 -0
  158. /package/dist/cjs/api/types/{DriverUpdateResp.js → DriverUpdateRes.js} +0 -0
  159. /package/dist/esm/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedListReq.d.mts +0 -0
  160. /package/dist/esm/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedListReq.mjs +0 -0
  161. /package/dist/esm/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedReq.d.mts +0 -0
  162. /package/dist/esm/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedReq.mjs +0 -0
  163. /package/dist/esm/api/types/{DriverUpdateResp.mjs → DriverUpdateRes.mjs} +0 -0
@@ -20,7 +20,7 @@ export class Dev {
20
20
  this._options = _options;
21
21
  }
22
22
  /**
23
- * Experimental endpoint for running AI agentic workflows. Returns the authenticated user's ID for testing purposes.
23
+ * Experimental endpoint for running AI agentic workflows. Returns the authenticated user's ID for testing purposes. | () -> (str)
24
24
  *
25
25
  * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
26
26
  *
@@ -71,7 +71,7 @@ export class Dev {
71
71
  });
72
72
  }
73
73
  /**
74
- * (DEPRECATED) Extracts and returns the user ID from the authenticated request's JWT token.
74
+ * (DEPRECATED) Extracts and returns the user ID from the authenticated request's JWT token. | () -> (str)
75
75
  *
76
76
  * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
77
77
  *
@@ -122,7 +122,7 @@ export class Dev {
122
122
  });
123
123
  }
124
124
  /**
125
- * Extracts and returns the user ID from the authenticated request's JWT token.
125
+ * Extracts and returns the user ID from the authenticated request's JWT token. | () -> (str)
126
126
  *
127
127
  * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
128
128
  *
@@ -173,7 +173,7 @@ export class Dev {
173
173
  });
174
174
  }
175
175
  /**
176
- * Returns the complete decoded JWT token information for development purposes.
176
+ * Returns the complete decoded JWT token information for development purposes. | () -> (DecodedJWTWithOrgAndUserId)
177
177
  *
178
178
  * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
179
179
  *
@@ -224,7 +224,7 @@ export class Dev {
224
224
  });
225
225
  }
226
226
  /**
227
- * Retrieves the primary email address for the authenticated user from the authentication service.
227
+ * Retrieves the primary email address for the authenticated user from the authentication service. | () -> (str)
228
228
  *
229
229
  * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
230
230
  *
@@ -275,7 +275,7 @@ export class Dev {
275
275
  });
276
276
  }
277
277
  /**
278
- * Experimental endpoint for running durable execution workflows. Returns the authenticated user's ID for testing purposes.
278
+ * Experimental endpoint for running durable execution workflows. Returns the authenticated user's ID for testing purposes. | () -> (dict[str, Any])
279
279
  *
280
280
  * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
281
281
  *
@@ -326,7 +326,7 @@ export class Dev {
326
326
  });
327
327
  }
328
328
  /**
329
- * Development template endpoint that returns the authenticated user's ID for testing.
329
+ * Development template endpoint that returns the authenticated user's ID for testing. | () -> (str)
330
330
  *
331
331
  * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
332
332
  *
@@ -377,7 +377,7 @@ export class Dev {
377
377
  });
378
378
  }
379
379
  /**
380
- * Development template endpoint that demonstrates transaction handling and request mirroring.
380
+ * Development template endpoint that demonstrates transaction handling and request mirroring. | (TemplateReq) -> (TemplateRes)
381
381
  *
382
382
  * @param {Chrt.TemplateReq} request
383
383
  * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
@@ -443,7 +443,7 @@ export class Dev {
443
443
  });
444
444
  }
445
445
  /**
446
- * Returns the current GitHub PR number and commit hash for the deployment.
446
+ * Returns the current GitHub PR number and commit hash for the deployment. | () -> (dict[str, str])
447
447
  *
448
448
  * @param {Dev.RequestOptions} requestOptions - Request-specific configuration.
449
449
  *
@@ -31,7 +31,7 @@ export declare class Courier {
31
31
  protected readonly _options: Courier.Options;
32
32
  constructor(_options?: Courier.Options);
33
33
  /**
34
- * Retrieves notification preferences for the authenticated courier organization.
34
+ * Retrieves notification preferences for the authenticated courier organization. | () -> (CourierNotificationPreferences1)
35
35
  *
36
36
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
37
37
  *
@@ -41,7 +41,7 @@ export declare class Courier {
41
41
  getPreferencesV1(requestOptions?: Courier.RequestOptions): core.HttpResponsePromise<Chrt.CourierNotificationPreferences1>;
42
42
  private __getPreferencesV1;
43
43
  /**
44
- * Creates or updates notification preferences for the authenticated courier organization.
44
+ * Creates or updates notification preferences for the authenticated courier organization. | (CourierNotificationPreferencesClientCreate1) -> (PydanticObjectId)
45
45
  *
46
46
  * @param {Chrt.notifications.CourierNotificationPreferencesClientCreate1} request
47
47
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
@@ -20,7 +20,7 @@ export class Courier {
20
20
  this._options = _options;
21
21
  }
22
22
  /**
23
- * Retrieves notification preferences for the authenticated courier organization.
23
+ * Retrieves notification preferences for the authenticated courier organization. | () -> (CourierNotificationPreferences1)
24
24
  *
25
25
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
26
26
  *
@@ -71,7 +71,7 @@ export class Courier {
71
71
  });
72
72
  }
73
73
  /**
74
- * Creates or updates notification preferences for the authenticated courier organization.
74
+ * Creates or updates notification preferences for the authenticated courier organization. | (CourierNotificationPreferencesClientCreate1) -> (PydanticObjectId)
75
75
  *
76
76
  * @param {Chrt.notifications.CourierNotificationPreferencesClientCreate1} request
77
77
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,7 +31,7 @@ export declare class Shipper {
31
31
  protected readonly _options: Shipper.Options;
32
32
  constructor(_options?: Shipper.Options);
33
33
  /**
34
- * Retrieves notification preferences for the authenticated shipper organization.
34
+ * Retrieves notification preferences for the authenticated shipper organization. | () -> (ShipperNotificationPreferences1)
35
35
  *
36
36
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
37
37
  *
@@ -41,7 +41,7 @@ export declare class Shipper {
41
41
  getPreferencesV1(requestOptions?: Shipper.RequestOptions): core.HttpResponsePromise<Chrt.ShipperNotificationPreferences1>;
42
42
  private __getPreferencesV1;
43
43
  /**
44
- * Creates or updates notification preferences for the authenticated shipper organization.
44
+ * Creates or updates notification preferences for the authenticated shipper organization. | (ShipperNotificationPreferencesClientCreate1) -> (PydanticObjectId)
45
45
  *
46
46
  * @param {Chrt.notifications.ShipperNotificationPreferencesClientCreate1} request
47
47
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
@@ -20,7 +20,7 @@ export class Shipper {
20
20
  this._options = _options;
21
21
  }
22
22
  /**
23
- * Retrieves notification preferences for the authenticated shipper organization.
23
+ * Retrieves notification preferences for the authenticated shipper organization. | () -> (ShipperNotificationPreferences1)
24
24
  *
25
25
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
26
26
  *
@@ -71,7 +71,7 @@ export class Shipper {
71
71
  });
72
72
  }
73
73
  /**
74
- * Creates or updates notification preferences for the authenticated shipper organization.
74
+ * Creates or updates notification preferences for the authenticated shipper organization. | (ShipperNotificationPreferencesClientCreate1) -> (PydanticObjectId)
75
75
  *
76
76
  * @param {Chrt.notifications.ShipperNotificationPreferencesClientCreate1} request
77
77
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
@@ -83,6 +83,33 @@ export declare class OrderDrafts {
83
83
  */
84
84
  deleteV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<boolean>;
85
85
  private __deleteV1;
86
+ /**
87
+ * Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it.
88
+ *
89
+ * @param {string} orderIdOrShortId
90
+ * @param {Chrt.OrderDraftExpandedReq} request
91
+ * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
92
+ *
93
+ * @throws {@link Chrt.UnprocessableEntityError}
94
+ *
95
+ * @example
96
+ * await client.orderDrafts.expandedV1("order_id_or_short_id")
97
+ */
98
+ expandedV1(orderIdOrShortId: string, request?: Chrt.OrderDraftExpandedReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpandedRes>;
99
+ private __expandedV1;
100
+ /**
101
+ * Lists all draft orders created by the authenticated user with optional expanded related data.
102
+ *
103
+ * @param {Chrt.OrderDraftExpandedListReq} request
104
+ * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
105
+ *
106
+ * @throws {@link Chrt.UnprocessableEntityError}
107
+ *
108
+ * @example
109
+ * await client.orderDrafts.expandedListV1()
110
+ */
111
+ expandedListV1(request?: Chrt.OrderDraftExpandedListReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpandedListRes>;
112
+ private __expandedListV1;
86
113
  /**
87
114
  * Checks whether the draft order satisfies all requirements to move into staging.
88
115
  *
@@ -224,6 +224,131 @@ export class OrderDrafts {
224
224
  }
225
225
  });
226
226
  }
227
+ /**
228
+ * Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it.
229
+ *
230
+ * @param {string} orderIdOrShortId
231
+ * @param {Chrt.OrderDraftExpandedReq} request
232
+ * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
233
+ *
234
+ * @throws {@link Chrt.UnprocessableEntityError}
235
+ *
236
+ * @example
237
+ * await client.orderDrafts.expandedV1("order_id_or_short_id")
238
+ */
239
+ expandedV1(orderIdOrShortId, request = {}, requestOptions) {
240
+ return core.HttpResponsePromise.fromPromise(this.__expandedV1(orderIdOrShortId, request, requestOptions));
241
+ }
242
+ __expandedV1(orderIdOrShortId_1) {
243
+ return __awaiter(this, arguments, void 0, function* (orderIdOrShortId, request = {}, requestOptions) {
244
+ var _a, _b, _c, _d;
245
+ let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
246
+ const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
247
+ 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, `oort/order_drafts/expanded/v1/${encodeURIComponent(orderIdOrShortId)}`),
248
+ method: "POST",
249
+ headers: _headers,
250
+ contentType: "application/json",
251
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
252
+ requestType: "json",
253
+ body: request,
254
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
255
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
256
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
257
+ });
258
+ if (_response.ok) {
259
+ return { data: _response.body, rawResponse: _response.rawResponse };
260
+ }
261
+ if (_response.error.reason === "status-code") {
262
+ switch (_response.error.statusCode) {
263
+ case 422:
264
+ throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
265
+ default:
266
+ throw new errors.ChrtError({
267
+ statusCode: _response.error.statusCode,
268
+ body: _response.error.body,
269
+ rawResponse: _response.rawResponse,
270
+ });
271
+ }
272
+ }
273
+ switch (_response.error.reason) {
274
+ case "non-json":
275
+ throw new errors.ChrtError({
276
+ statusCode: _response.error.statusCode,
277
+ body: _response.error.rawBody,
278
+ rawResponse: _response.rawResponse,
279
+ });
280
+ case "timeout":
281
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/order_drafts/expanded/v1/{order_id_or_short_id}.");
282
+ case "unknown":
283
+ throw new errors.ChrtError({
284
+ message: _response.error.errorMessage,
285
+ rawResponse: _response.rawResponse,
286
+ });
287
+ }
288
+ });
289
+ }
290
+ /**
291
+ * Lists all draft orders created by the authenticated user with optional expanded related data.
292
+ *
293
+ * @param {Chrt.OrderDraftExpandedListReq} request
294
+ * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
295
+ *
296
+ * @throws {@link Chrt.UnprocessableEntityError}
297
+ *
298
+ * @example
299
+ * await client.orderDrafts.expandedListV1()
300
+ */
301
+ expandedListV1(request = {}, requestOptions) {
302
+ return core.HttpResponsePromise.fromPromise(this.__expandedListV1(request, requestOptions));
303
+ }
304
+ __expandedListV1() {
305
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
306
+ var _a, _b, _c, _d;
307
+ let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
308
+ const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
309
+ 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, "oort/order_drafts/expanded/list/v1"),
310
+ method: "POST",
311
+ headers: _headers,
312
+ contentType: "application/json",
313
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
314
+ requestType: "json",
315
+ body: request,
316
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
317
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
318
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
319
+ });
320
+ if (_response.ok) {
321
+ return { data: _response.body, rawResponse: _response.rawResponse };
322
+ }
323
+ if (_response.error.reason === "status-code") {
324
+ switch (_response.error.statusCode) {
325
+ case 422:
326
+ throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
327
+ default:
328
+ throw new errors.ChrtError({
329
+ statusCode: _response.error.statusCode,
330
+ body: _response.error.body,
331
+ rawResponse: _response.rawResponse,
332
+ });
333
+ }
334
+ }
335
+ switch (_response.error.reason) {
336
+ case "non-json":
337
+ throw new errors.ChrtError({
338
+ statusCode: _response.error.statusCode,
339
+ body: _response.error.rawBody,
340
+ rawResponse: _response.rawResponse,
341
+ });
342
+ case "timeout":
343
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/order_drafts/expanded/list/v1.");
344
+ case "unknown":
345
+ throw new errors.ChrtError({
346
+ message: _response.error.errorMessage,
347
+ rawResponse: _response.rawResponse,
348
+ });
349
+ }
350
+ });
351
+ }
227
352
  /**
228
353
  * Checks whether the draft order satisfies all requirements to move into staging.
229
354
  *
@@ -1,2 +1,4 @@
1
1
  export { type OrdersNewDraftReq } from "./OrdersNewDraftReq.mjs";
2
2
  export { type OrdersDraftUpdateReq } from "./OrdersDraftUpdateReq.mjs";
3
+ export { type OrderDraftExpandedReq } from "./OrderDraftExpandedReq.mjs";
4
+ export { type OrderDraftExpandedListReq } from "./OrderDraftExpandedListReq.mjs";
@@ -5,7 +5,6 @@ import * as environments from "../../../../environments.mjs";
5
5
  import * as core from "../../../../core/index.mjs";
6
6
  import { Expanded } from "../resources/expanded/client/Client.mjs";
7
7
  import { ExpandedList } from "../resources/expandedList/client/Client.mjs";
8
- import { Draft } from "../resources/draft/client/Client.mjs";
9
8
  export declare namespace Orders {
10
9
  interface Options {
11
10
  environment?: core.Supplier<environments.ChrtEnvironment | string>;
@@ -33,11 +32,9 @@ export declare class Orders {
33
32
  protected readonly _options: Orders.Options;
34
33
  protected _expanded: Expanded | undefined;
35
34
  protected _expandedList: ExpandedList | undefined;
36
- protected _draft: Draft | undefined;
37
35
  constructor(_options?: Orders.Options);
38
36
  get expanded(): Expanded;
39
37
  get expandedList(): ExpandedList;
40
- get draft(): Draft;
41
38
  /**
42
39
  * Validates a draft order and stages all related entities in a transaction.
43
40
  *
@@ -17,7 +17,6 @@ import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.
17
17
  import * as errors from "../../../../errors/index.mjs";
18
18
  import { Expanded } from "../resources/expanded/client/Client.mjs";
19
19
  import { ExpandedList } from "../resources/expandedList/client/Client.mjs";
20
- import { Draft } from "../resources/draft/client/Client.mjs";
21
20
  export class Orders {
22
21
  constructor(_options = {}) {
23
22
  this._options = _options;
@@ -30,10 +29,6 @@ export class Orders {
30
29
  var _a;
31
30
  return ((_a = this._expandedList) !== null && _a !== void 0 ? _a : (this._expandedList = new ExpandedList(this._options)));
32
31
  }
33
- get draft() {
34
- var _a;
35
- return ((_a = this._draft) !== null && _a !== void 0 ? _a : (this._draft = new Draft(this._options)));
36
- }
37
32
  /**
38
33
  * Validates a draft order and stages all related entities in a transaction.
39
34
  *
@@ -1,4 +1,3 @@
1
1
  export * as expanded from "./expanded/index.mjs";
2
2
  export * as expandedList from "./expandedList/index.mjs";
3
- export * as draft from "./draft/index.mjs";
4
3
  export * from "./expandedList/client/requests/index.mjs";
@@ -1,4 +1,3 @@
1
1
  export * as expanded from "./expanded/index.mjs";
2
2
  export * as expandedList from "./expandedList/index.mjs";
3
- export * as draft from "./draft/index.mjs";
4
3
  export * from "./expandedList/client/requests/index.mjs";
@@ -31,7 +31,7 @@ export declare class Courier {
31
31
  protected readonly _options: Courier.Options;
32
32
  constructor(_options?: Courier.Options);
33
33
  /**
34
- * Retrieves courier organization connection information for the authenticated organization.
34
+ * Retrieves courier organization connection information for the authenticated organization. | () -> (CourierOrgInfoForConnections1)
35
35
  *
36
36
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
37
37
  *
@@ -41,7 +41,7 @@ export declare class Courier {
41
41
  getV1(requestOptions?: Courier.RequestOptions): core.HttpResponsePromise<Chrt.CourierOrgInfoForConnections1>;
42
42
  private __getV1;
43
43
  /**
44
- * Creates courier organization connection information. Fails if already exists.
44
+ * Creates courier organization connection information. Fails if already exists. | (CourierOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
45
45
  *
46
46
  * @param {Chrt.orgConnectionInfos.CourierOrgInfoForConnectionsClientCreate1} request
47
47
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
@@ -57,7 +57,7 @@ export declare class Courier {
57
57
  createV1(request: Chrt.orgConnectionInfos.CourierOrgInfoForConnectionsClientCreate1, requestOptions?: Courier.RequestOptions): core.HttpResponsePromise<string>;
58
58
  private __createV1;
59
59
  /**
60
- * Updates existing courier organization connection information.
60
+ * Updates existing courier organization connection information. | (CourierOrgInfoForConnectionsClientUpdate1) -> (bool)
61
61
  *
62
62
  * @param {Chrt.orgConnectionInfos.CourierOrgInfoForConnectionsClientUpdate1} request
63
63
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
@@ -20,7 +20,7 @@ export class Courier {
20
20
  this._options = _options;
21
21
  }
22
22
  /**
23
- * Retrieves courier organization connection information for the authenticated organization.
23
+ * Retrieves courier organization connection information for the authenticated organization. | () -> (CourierOrgInfoForConnections1)
24
24
  *
25
25
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
26
26
  *
@@ -71,7 +71,7 @@ export class Courier {
71
71
  });
72
72
  }
73
73
  /**
74
- * Creates courier organization connection information. Fails if already exists.
74
+ * Creates courier organization connection information. Fails if already exists. | (CourierOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
75
75
  *
76
76
  * @param {Chrt.orgConnectionInfos.CourierOrgInfoForConnectionsClientCreate1} request
77
77
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
@@ -136,7 +136,7 @@ export class Courier {
136
136
  });
137
137
  }
138
138
  /**
139
- * Updates existing courier organization connection information.
139
+ * Updates existing courier organization connection information. | (CourierOrgInfoForConnectionsClientUpdate1) -> (bool)
140
140
  *
141
141
  * @param {Chrt.orgConnectionInfos.CourierOrgInfoForConnectionsClientUpdate1} request
142
142
  * @param {Courier.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,7 +31,7 @@ export declare class Shipper {
31
31
  protected readonly _options: Shipper.Options;
32
32
  constructor(_options?: Shipper.Options);
33
33
  /**
34
- * Retrieves shipper organization connection information for the authenticated organization.
34
+ * Retrieves shipper organization connection information for the authenticated organization. | () -> (ShipperOrgInfoForConnections1)
35
35
  *
36
36
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
37
37
  *
@@ -41,7 +41,7 @@ export declare class Shipper {
41
41
  getV1(requestOptions?: Shipper.RequestOptions): core.HttpResponsePromise<Chrt.ShipperOrgInfoForConnections1>;
42
42
  private __getV1;
43
43
  /**
44
- * Creates shipper organization connection information. Fails if already exists.
44
+ * Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
45
45
  *
46
46
  * @param {Chrt.orgConnectionInfos.ShipperOrgInfoForConnectionsClientCreate1} request
47
47
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
@@ -57,7 +57,7 @@ export declare class Shipper {
57
57
  createV1(request: Chrt.orgConnectionInfos.ShipperOrgInfoForConnectionsClientCreate1, requestOptions?: Shipper.RequestOptions): core.HttpResponsePromise<string>;
58
58
  private __createV1;
59
59
  /**
60
- * Updates existing shipper organization connection information.
60
+ * Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
61
61
  *
62
62
  * @param {Chrt.orgConnectionInfos.ShipperOrgInfoForConnectionsClientUpdate1} request
63
63
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
@@ -20,7 +20,7 @@ export class Shipper {
20
20
  this._options = _options;
21
21
  }
22
22
  /**
23
- * Retrieves shipper organization connection information for the authenticated organization.
23
+ * Retrieves shipper organization connection information for the authenticated organization. | () -> (ShipperOrgInfoForConnections1)
24
24
  *
25
25
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
26
26
  *
@@ -71,7 +71,7 @@ export class Shipper {
71
71
  });
72
72
  }
73
73
  /**
74
- * Creates shipper organization connection information. Fails if already exists.
74
+ * Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
75
75
  *
76
76
  * @param {Chrt.orgConnectionInfos.ShipperOrgInfoForConnectionsClientCreate1} request
77
77
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
@@ -136,7 +136,7 @@ export class Shipper {
136
136
  });
137
137
  }
138
138
  /**
139
- * Updates existing shipper organization connection information.
139
+ * Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
140
140
  *
141
141
  * @param {Chrt.orgConnectionInfos.ShipperOrgInfoForConnectionsClientUpdate1} request
142
142
  * @param {Shipper.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,7 +31,7 @@ export declare class OrgProfiles {
31
31
  protected readonly _options: OrgProfiles.Options;
32
32
  constructor(_options?: OrgProfiles.Options);
33
33
  /**
34
- * Retrieves the courier or forwarder organization profile for the authenticated organization.
34
+ * Retrieves the courier or forwarder organization profile for the authenticated organization. | () -> (OrgProfileRes1)
35
35
  *
36
36
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
37
37
  *
@@ -41,7 +41,7 @@ export declare class OrgProfiles {
41
41
  getV1(requestOptions?: OrgProfiles.RequestOptions): core.HttpResponsePromise<Chrt.OrgProfileRes1>;
42
42
  private __getV1;
43
43
  /**
44
- * Creates a new courier organization profile. Fails if a profile already exists for the organization.
44
+ * Creates a new courier organization profile. Fails if a profile already exists for the organization. | (CourierOrgProfileClientCreate1) -> (PydanticObjectId)
45
45
  *
46
46
  * @param {Chrt.CourierOrgProfileClientCreate1} request
47
47
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -59,7 +59,7 @@ export declare class OrgProfiles {
59
59
  createCourierV1(request: Chrt.CourierOrgProfileClientCreate1, requestOptions?: OrgProfiles.RequestOptions): core.HttpResponsePromise<string>;
60
60
  private __createCourierV1;
61
61
  /**
62
- * Creates a new forwarder organization profile. Fails if a profile already exists for the organization.
62
+ * Creates a new forwarder organization profile. Fails if a profile already exists for the organization. | (ForwarderOrgProfileClientCreate1) -> (PydanticObjectId)
63
63
  *
64
64
  * @param {Chrt.ForwarderOrgProfileClientCreate1} request
65
65
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -77,7 +77,7 @@ export declare class OrgProfiles {
77
77
  createForwarderV1(request: Chrt.ForwarderOrgProfileClientCreate1, requestOptions?: OrgProfiles.RequestOptions): core.HttpResponsePromise<string>;
78
78
  private __createForwarderV1;
79
79
  /**
80
- * Updates an existing courier organization profile. Can update one or more fields.
80
+ * Updates an existing courier organization profile. Can update one or more fields. | (CourierOrgProfileClientUpdate1) -> (bool)
81
81
  *
82
82
  * @param {Chrt.CourierOrgProfileClientUpdate1} request
83
83
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -90,7 +90,7 @@ export declare class OrgProfiles {
90
90
  updateCourierV1(request?: Chrt.CourierOrgProfileClientUpdate1, requestOptions?: OrgProfiles.RequestOptions): core.HttpResponsePromise<boolean>;
91
91
  private __updateCourierV1;
92
92
  /**
93
- * Updates an existing forwarder organization profile. Can update one or more fields.
93
+ * Updates an existing forwarder organization profile. Can update one or more fields. | (ForwarderOrgProfileClientUpdate1) -> (bool)
94
94
  *
95
95
  * @param {Chrt.ForwarderOrgProfileClientUpdate1} request
96
96
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -103,7 +103,7 @@ export declare class OrgProfiles {
103
103
  updateForwarderV1(request?: Chrt.ForwarderOrgProfileClientUpdate1, requestOptions?: OrgProfiles.RequestOptions): core.HttpResponsePromise<boolean>;
104
104
  private __updateForwarderV1;
105
105
  /**
106
- * Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing.
106
+ * Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing. | () -> (OrgProfileRes1)
107
107
  *
108
108
  * @param {string} handle
109
109
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -116,7 +116,7 @@ export declare class OrgProfiles {
116
116
  getByHandleV1(handle: string, requestOptions?: OrgProfiles.RequestOptions): core.HttpResponsePromise<Chrt.OrgProfileRes1>;
117
117
  private __getByHandleV1;
118
118
  /**
119
- * Returns the organization avatar image URL from Clerk or a placeholder if not found.
119
+ * Returns the organization avatar image URL from Clerk or a placeholder if not found. | () -> (str)
120
120
  *
121
121
  * @param {string} handle
122
122
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -20,7 +20,7 @@ export class OrgProfiles {
20
20
  this._options = _options;
21
21
  }
22
22
  /**
23
- * Retrieves the courier or forwarder organization profile for the authenticated organization.
23
+ * Retrieves the courier or forwarder organization profile for the authenticated organization. | () -> (OrgProfileRes1)
24
24
  *
25
25
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
26
26
  *
@@ -71,7 +71,7 @@ export class OrgProfiles {
71
71
  });
72
72
  }
73
73
  /**
74
- * Creates a new courier organization profile. Fails if a profile already exists for the organization.
74
+ * Creates a new courier organization profile. Fails if a profile already exists for the organization. | (CourierOrgProfileClientCreate1) -> (PydanticObjectId)
75
75
  *
76
76
  * @param {Chrt.CourierOrgProfileClientCreate1} request
77
77
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -138,7 +138,7 @@ export class OrgProfiles {
138
138
  });
139
139
  }
140
140
  /**
141
- * Creates a new forwarder organization profile. Fails if a profile already exists for the organization.
141
+ * Creates a new forwarder organization profile. Fails if a profile already exists for the organization. | (ForwarderOrgProfileClientCreate1) -> (PydanticObjectId)
142
142
  *
143
143
  * @param {Chrt.ForwarderOrgProfileClientCreate1} request
144
144
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -205,7 +205,7 @@ export class OrgProfiles {
205
205
  });
206
206
  }
207
207
  /**
208
- * Updates an existing courier organization profile. Can update one or more fields.
208
+ * Updates an existing courier organization profile. Can update one or more fields. | (CourierOrgProfileClientUpdate1) -> (bool)
209
209
  *
210
210
  * @param {Chrt.CourierOrgProfileClientUpdate1} request
211
211
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -267,7 +267,7 @@ export class OrgProfiles {
267
267
  });
268
268
  }
269
269
  /**
270
- * Updates an existing forwarder organization profile. Can update one or more fields.
270
+ * Updates an existing forwarder organization profile. Can update one or more fields. | (ForwarderOrgProfileClientUpdate1) -> (bool)
271
271
  *
272
272
  * @param {Chrt.ForwarderOrgProfileClientUpdate1} request
273
273
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -329,7 +329,7 @@ export class OrgProfiles {
329
329
  });
330
330
  }
331
331
  /**
332
- * Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing.
332
+ * Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing. | () -> (OrgProfileRes1)
333
333
  *
334
334
  * @param {string} handle
335
335
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -388,7 +388,7 @@ export class OrgProfiles {
388
388
  });
389
389
  }
390
390
  /**
391
- * Returns the organization avatar image URL from Clerk or a placeholder if not found.
391
+ * Returns the organization avatar image URL from Clerk or a placeholder if not found. | () -> (str)
392
392
  *
393
393
  * @param {string} handle
394
394
  * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.