@chrt-inc/typescript-sdk 1.304.0 → 1.305.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 (89) hide show
  1. package/README.md +585 -0
  2. package/dist/cjs/Client.js +2 -2
  3. package/dist/cjs/api/resources/drivers/client/Client.d.ts +10 -10
  4. package/dist/cjs/api/resources/drivers/client/Client.js +10 -10
  5. package/dist/cjs/api/resources/offChrtShipperOrg/client/Client.d.ts +5 -5
  6. package/dist/cjs/api/resources/offChrtShipperOrg/client/Client.js +5 -5
  7. package/dist/cjs/api/resources/orderDrafts/client/Client.d.ts +6 -6
  8. package/dist/cjs/api/resources/orderDrafts/client/Client.js +6 -6
  9. package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/Client.d.ts +4 -4
  10. package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/Client.js +4 -4
  11. package/dist/cjs/api/resources/orderDrafts/resources/task/client/Client.d.ts +3 -3
  12. package/dist/cjs/api/resources/orderDrafts/resources/task/client/Client.js +3 -3
  13. package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/Client.d.ts +2 -2
  14. package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/Client.js +2 -2
  15. package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.d.ts +2 -2
  16. package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.js +2 -2
  17. package/dist/cjs/api/resources/orders/client/Client.d.ts +1 -1
  18. package/dist/cjs/api/resources/orders/client/Client.js +1 -1
  19. package/dist/cjs/api/resources/orders/resources/expanded/client/Client.d.ts +2 -2
  20. package/dist/cjs/api/resources/orders/resources/expanded/client/Client.js +2 -2
  21. package/dist/cjs/api/resources/orders/resources/expandedList/client/Client.d.ts +2 -2
  22. package/dist/cjs/api/resources/orders/resources/expandedList/client/Client.js +2 -2
  23. package/dist/cjs/api/resources/orgs/client/Client.d.ts +10 -0
  24. package/dist/cjs/api/resources/orgs/client/Client.js +53 -2
  25. package/dist/cjs/api/resources/shipperContactInfo/client/Client.d.ts +9 -9
  26. package/dist/cjs/api/resources/shipperContactInfo/client/Client.js +9 -9
  27. package/dist/cjs/api/resources/taskArtifacts/client/Client.d.ts +3 -3
  28. package/dist/cjs/api/resources/taskArtifacts/client/Client.js +3 -3
  29. package/dist/cjs/api/resources/taskArtifacts/resources/blurhash/client/Client.d.ts +1 -1
  30. package/dist/cjs/api/resources/taskArtifacts/resources/blurhash/client/Client.js +1 -1
  31. package/dist/cjs/api/resources/taskArtifacts/resources/images/client/Client.d.ts +3 -3
  32. package/dist/cjs/api/resources/taskArtifacts/resources/images/client/Client.js +3 -3
  33. package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +3 -3
  34. package/dist/cjs/api/resources/taskGroups/client/Client.js +3 -3
  35. package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.d.ts +3 -3
  36. package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.js +3 -3
  37. package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/Client.d.ts +2 -2
  38. package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/Client.js +2 -2
  39. package/dist/cjs/api/resources/users/client/Client.d.ts +4 -4
  40. package/dist/cjs/api/resources/users/client/Client.js +5 -5
  41. package/dist/cjs/api/types/OrgPublicData1.d.ts +1 -1
  42. package/dist/cjs/api/types/UserPublicData1.d.ts +1 -2
  43. package/dist/cjs/version.d.ts +1 -1
  44. package/dist/cjs/version.js +1 -1
  45. package/dist/esm/Client.mjs +2 -2
  46. package/dist/esm/api/resources/drivers/client/Client.d.mts +10 -10
  47. package/dist/esm/api/resources/drivers/client/Client.mjs +10 -10
  48. package/dist/esm/api/resources/offChrtShipperOrg/client/Client.d.mts +5 -5
  49. package/dist/esm/api/resources/offChrtShipperOrg/client/Client.mjs +5 -5
  50. package/dist/esm/api/resources/orderDrafts/client/Client.d.mts +6 -6
  51. package/dist/esm/api/resources/orderDrafts/client/Client.mjs +6 -6
  52. package/dist/esm/api/resources/orderDrafts/resources/cargo/client/Client.d.mts +4 -4
  53. package/dist/esm/api/resources/orderDrafts/resources/cargo/client/Client.mjs +4 -4
  54. package/dist/esm/api/resources/orderDrafts/resources/task/client/Client.d.mts +3 -3
  55. package/dist/esm/api/resources/orderDrafts/resources/task/client/Client.mjs +3 -3
  56. package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/Client.d.mts +2 -2
  57. package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/Client.mjs +2 -2
  58. package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.d.mts +2 -2
  59. package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.mjs +2 -2
  60. package/dist/esm/api/resources/orders/client/Client.d.mts +1 -1
  61. package/dist/esm/api/resources/orders/client/Client.mjs +1 -1
  62. package/dist/esm/api/resources/orders/resources/expanded/client/Client.d.mts +2 -2
  63. package/dist/esm/api/resources/orders/resources/expanded/client/Client.mjs +2 -2
  64. package/dist/esm/api/resources/orders/resources/expandedList/client/Client.d.mts +2 -2
  65. package/dist/esm/api/resources/orders/resources/expandedList/client/Client.mjs +2 -2
  66. package/dist/esm/api/resources/orgs/client/Client.d.mts +10 -0
  67. package/dist/esm/api/resources/orgs/client/Client.mjs +53 -2
  68. package/dist/esm/api/resources/shipperContactInfo/client/Client.d.mts +9 -9
  69. package/dist/esm/api/resources/shipperContactInfo/client/Client.mjs +9 -9
  70. package/dist/esm/api/resources/taskArtifacts/client/Client.d.mts +3 -3
  71. package/dist/esm/api/resources/taskArtifacts/client/Client.mjs +3 -3
  72. package/dist/esm/api/resources/taskArtifacts/resources/blurhash/client/Client.d.mts +1 -1
  73. package/dist/esm/api/resources/taskArtifacts/resources/blurhash/client/Client.mjs +1 -1
  74. package/dist/esm/api/resources/taskArtifacts/resources/images/client/Client.d.mts +3 -3
  75. package/dist/esm/api/resources/taskArtifacts/resources/images/client/Client.mjs +3 -3
  76. package/dist/esm/api/resources/taskGroups/client/Client.d.mts +3 -3
  77. package/dist/esm/api/resources/taskGroups/client/Client.mjs +3 -3
  78. package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.d.mts +3 -3
  79. package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.mjs +3 -3
  80. package/dist/esm/api/resources/taskGroups/resources/expandedList/client/Client.d.mts +2 -2
  81. package/dist/esm/api/resources/taskGroups/resources/expandedList/client/Client.mjs +2 -2
  82. package/dist/esm/api/resources/users/client/Client.d.mts +4 -4
  83. package/dist/esm/api/resources/users/client/Client.mjs +5 -5
  84. package/dist/esm/api/types/OrgPublicData1.d.mts +1 -1
  85. package/dist/esm/api/types/UserPublicData1.d.mts +1 -2
  86. package/dist/esm/version.d.mts +1 -1
  87. package/dist/esm/version.mjs +1 -1
  88. package/package.json +1 -1
  89. package/reference.md +119 -64
@@ -412,7 +412,7 @@ class Orgs {
412
412
  var _a, _b, _c, _d;
413
413
  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);
414
414
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
415
- 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, `orgs/org_public_data/handle_available/v1/${encodeURIComponent(handle)}`),
415
+ 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, `orgs/org_public_data/handle_availability/v1/${encodeURIComponent(handle)}`),
416
416
  method: "GET",
417
417
  headers: _headers,
418
418
  queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -443,7 +443,58 @@ class Orgs {
443
443
  rawResponse: _response.rawResponse,
444
444
  });
445
445
  case "timeout":
446
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /orgs/org_public_data/handle_available/v1/{handle}.");
446
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /orgs/org_public_data/handle_availability/v1/{handle}.");
447
+ case "unknown":
448
+ throw new errors.ChrtError({
449
+ message: _response.error.errorMessage,
450
+ rawResponse: _response.rawResponse,
451
+ });
452
+ }
453
+ });
454
+ }
455
+ /**
456
+ * Retrieves the Stripe Connect account ID for the authenticated organization. Returns 404 if not set. | () -> (str)
457
+ *
458
+ * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
459
+ *
460
+ * @example
461
+ * await client.orgs.getStripeConnectAccountIdV1()
462
+ */
463
+ getStripeConnectAccountIdV1(requestOptions) {
464
+ return core.HttpResponsePromise.fromPromise(this.__getStripeConnectAccountIdV1(requestOptions));
465
+ }
466
+ __getStripeConnectAccountIdV1(requestOptions) {
467
+ return __awaiter(this, void 0, void 0, function* () {
468
+ var _a, _b, _c, _d;
469
+ 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);
470
+ const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
471
+ 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, "orgs/stripe_connect_account_id/v1"),
472
+ method: "GET",
473
+ headers: _headers,
474
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
475
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
476
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
477
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
478
+ });
479
+ if (_response.ok) {
480
+ return { data: _response.body, rawResponse: _response.rawResponse };
481
+ }
482
+ if (_response.error.reason === "status-code") {
483
+ throw new errors.ChrtError({
484
+ statusCode: _response.error.statusCode,
485
+ body: _response.error.body,
486
+ rawResponse: _response.rawResponse,
487
+ });
488
+ }
489
+ switch (_response.error.reason) {
490
+ case "non-json":
491
+ throw new errors.ChrtError({
492
+ statusCode: _response.error.statusCode,
493
+ body: _response.error.rawBody,
494
+ rawResponse: _response.rawResponse,
495
+ });
496
+ case "timeout":
497
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /orgs/stripe_connect_account_id/v1.");
447
498
  case "unknown":
448
499
  throw new errors.ChrtError({
449
500
  message: _response.error.errorMessage,
@@ -31,7 +31,7 @@ export declare class ShipperContactInfo {
31
31
  protected readonly _options: ShipperContactInfo.Options;
32
32
  constructor(_options?: ShipperContactInfo.Options);
33
33
  /**
34
- * Retrieves the authenticated user's own shipper contact information.
34
+ * Retrieves the authenticated user's own shipper contact information. | () -> (ShipperContact1)
35
35
  *
36
36
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
37
37
  *
@@ -41,7 +41,7 @@ export declare class ShipperContactInfo {
41
41
  getByJwtUserIdV1(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1>;
42
42
  private __getByJwtUserIdV1;
43
43
  /**
44
- * Lists all shipper contacts created by the authenticated organization.
44
+ * Lists all shipper contacts created by the authenticated organization. | () -> (list[ShipperContact1])
45
45
  *
46
46
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
47
47
  *
@@ -51,7 +51,7 @@ export declare class ShipperContactInfo {
51
51
  listByJwtOrgIdV1(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1[]>;
52
52
  private __listByJwtOrgIdV1;
53
53
  /**
54
- * Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
54
+ * Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])
55
55
  *
56
56
  * @param {string} shipperOrgId
57
57
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -64,7 +64,7 @@ export declare class ShipperContactInfo {
64
64
  listCourierContactsByShipperOrgIdV1(shipperOrgId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1[]>;
65
65
  private __listCourierContactsByShipperOrgIdV1;
66
66
  /**
67
- * Lists all shipper contacts for a specific off-platform shipper connection.
67
+ * Lists all shipper contacts for a specific off-platform shipper connection. | () -> (list[ShipperContact1])
68
68
  *
69
69
  * @param {string} offChrtShipperOrgId
70
70
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -77,7 +77,7 @@ export declare class ShipperContactInfo {
77
77
  listByOffChrtShipperOrgIdV1(offChrtShipperOrgId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1[]>;
78
78
  private __listByOffChrtShipperOrgIdV1;
79
79
  /**
80
- * Retrieves a specific shipper contact by ID if authorized to access it.
80
+ * Retrieves a specific shipper contact by ID if authorized to access it. | () -> (ShipperContact1)
81
81
  *
82
82
  * @param {string} id
83
83
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -90,7 +90,7 @@ export declare class ShipperContactInfo {
90
90
  getByIdV1(id: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContact1>;
91
91
  private __getByIdV1;
92
92
  /**
93
- * Creates contact information for an on-platform shipper organization or user.
93
+ * Creates contact information for an on-platform shipper organization or user. | (ShipperContactClientCreate1) -> (PydanticObjectId)
94
94
  *
95
95
  * @param {Chrt.ShipperContactClientCreate1} request
96
96
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -105,7 +105,7 @@ export declare class ShipperContactInfo {
105
105
  createOnPlatformV1(request: Chrt.ShipperContactClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
106
106
  private __createOnPlatformV1;
107
107
  /**
108
- * Creates contact information for an off-platform shipper using connection info.
108
+ * Creates contact information for an off-platform shipper using connection info. | (ShipperContactClientCreate1) -> (PydanticObjectId)
109
109
  *
110
110
  * @param {Chrt.ShipperContactClientCreate1} request
111
111
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -120,7 +120,7 @@ export declare class ShipperContactInfo {
120
120
  createOffPlatformV1(request: Chrt.ShipperContactClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
121
121
  private __createOffPlatformV1;
122
122
  /**
123
- * Updates existing shipper contact information owned by the authenticated organization.
123
+ * Updates existing shipper contact information owned by the authenticated organization. | (ShipperContactClientUpdate1) -> (bool)
124
124
  *
125
125
  * @param {string} shipperContactInfoId
126
126
  * @param {Chrt.ShipperContactClientUpdate1} request
@@ -134,7 +134,7 @@ export declare class ShipperContactInfo {
134
134
  updateV1(shipperContactInfoId: string, request?: Chrt.ShipperContactClientUpdate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
135
135
  private __updateV1;
136
136
  /**
137
- * Deletes shipper contact information owned by the authenticated organization.
137
+ * Deletes shipper contact information owned by the authenticated organization. | () -> (bool)
138
138
  *
139
139
  * @param {string} id
140
140
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,7 @@ class ShipperContactInfo {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Retrieves the authenticated user's own shipper contact information.
59
+ * Retrieves the authenticated user's own shipper contact information. | () -> (ShipperContact1)
60
60
  *
61
61
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
62
62
  *
@@ -107,7 +107,7 @@ class ShipperContactInfo {
107
107
  });
108
108
  }
109
109
  /**
110
- * Lists all shipper contacts created by the authenticated organization.
110
+ * Lists all shipper contacts created by the authenticated organization. | () -> (list[ShipperContact1])
111
111
  *
112
112
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
113
113
  *
@@ -158,7 +158,7 @@ class ShipperContactInfo {
158
158
  });
159
159
  }
160
160
  /**
161
- * Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
161
+ * Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])
162
162
  *
163
163
  * @param {string} shipperOrgId
164
164
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -217,7 +217,7 @@ class ShipperContactInfo {
217
217
  });
218
218
  }
219
219
  /**
220
- * Lists all shipper contacts for a specific off-platform shipper connection.
220
+ * Lists all shipper contacts for a specific off-platform shipper connection. | () -> (list[ShipperContact1])
221
221
  *
222
222
  * @param {string} offChrtShipperOrgId
223
223
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -276,7 +276,7 @@ class ShipperContactInfo {
276
276
  });
277
277
  }
278
278
  /**
279
- * Retrieves a specific shipper contact by ID if authorized to access it.
279
+ * Retrieves a specific shipper contact by ID if authorized to access it. | () -> (ShipperContact1)
280
280
  *
281
281
  * @param {string} id
282
282
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -335,7 +335,7 @@ class ShipperContactInfo {
335
335
  });
336
336
  }
337
337
  /**
338
- * Creates contact information for an on-platform shipper organization or user.
338
+ * Creates contact information for an on-platform shipper organization or user. | (ShipperContactClientCreate1) -> (PydanticObjectId)
339
339
  *
340
340
  * @param {Chrt.ShipperContactClientCreate1} request
341
341
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -399,7 +399,7 @@ class ShipperContactInfo {
399
399
  });
400
400
  }
401
401
  /**
402
- * Creates contact information for an off-platform shipper using connection info.
402
+ * Creates contact information for an off-platform shipper using connection info. | (ShipperContactClientCreate1) -> (PydanticObjectId)
403
403
  *
404
404
  * @param {Chrt.ShipperContactClientCreate1} request
405
405
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -463,7 +463,7 @@ class ShipperContactInfo {
463
463
  });
464
464
  }
465
465
  /**
466
- * Updates existing shipper contact information owned by the authenticated organization.
466
+ * Updates existing shipper contact information owned by the authenticated organization. | (ShipperContactClientUpdate1) -> (bool)
467
467
  *
468
468
  * @param {string} shipperContactInfoId
469
469
  * @param {Chrt.ShipperContactClientUpdate1} request
@@ -526,7 +526,7 @@ class ShipperContactInfo {
526
526
  });
527
527
  }
528
528
  /**
529
- * Deletes shipper contact information owned by the authenticated organization.
529
+ * Deletes shipper contact information owned by the authenticated organization. | () -> (bool)
530
530
  *
531
531
  * @param {string} id
532
532
  * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,7 +37,7 @@ export declare class TaskArtifacts {
37
37
  get images(): Images;
38
38
  get blurhash(): Blurhash;
39
39
  /**
40
- * Completes a task_artifact and updates all related task, cargo, task group, and order statuses.
40
+ * Completes a task_artifact and updates all related task, cargo, task group, and order statuses. | () -> (bool)
41
41
  *
42
42
  * @param {string} taskArtifactId
43
43
  * @param {TaskArtifacts.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,7 +50,7 @@ export declare class TaskArtifacts {
50
50
  completeV1(taskArtifactId: string, requestOptions?: TaskArtifacts.RequestOptions): core.HttpResponsePromise<boolean>;
51
51
  private __completeV1;
52
52
  /**
53
- * Updates the completor comments on a task_artifact without affecting completion status.
53
+ * Updates the completor comments on a task_artifact without affecting completion status. | (TaskArtifactUpdateCommentsReq) -> (bool)
54
54
  *
55
55
  * @param {Chrt.TaskArtifactUpdateCommentsReq} request
56
56
  * @param {TaskArtifacts.RequestOptions} requestOptions - Request-specific configuration.
@@ -66,7 +66,7 @@ export declare class TaskArtifacts {
66
66
  updateCommentsV1(request: Chrt.TaskArtifactUpdateCommentsReq, requestOptions?: TaskArtifacts.RequestOptions): core.HttpResponsePromise<boolean>;
67
67
  private __updateCommentsV1;
68
68
  /**
69
- * Adds a new task_artifact to an existing task
69
+ * Adds a new task_artifact to an existing task. | (TaskArtifactAddToTaskReq) -> (PydanticObjectId)
70
70
  *
71
71
  * @param {Chrt.TaskArtifactAddToTaskReq} request
72
72
  * @param {TaskArtifacts.RequestOptions} requestOptions - Request-specific configuration.
@@ -66,7 +66,7 @@ class TaskArtifacts {
66
66
  return ((_a = this._blurhash) !== null && _a !== void 0 ? _a : (this._blurhash = new Client_js_2.Blurhash(this._options)));
67
67
  }
68
68
  /**
69
- * Completes a task_artifact and updates all related task, cargo, task group, and order statuses.
69
+ * Completes a task_artifact and updates all related task, cargo, task group, and order statuses. | () -> (bool)
70
70
  *
71
71
  * @param {string} taskArtifactId
72
72
  * @param {TaskArtifacts.RequestOptions} requestOptions - Request-specific configuration.
@@ -125,7 +125,7 @@ class TaskArtifacts {
125
125
  });
126
126
  }
127
127
  /**
128
- * Updates the completor comments on a task_artifact without affecting completion status.
128
+ * Updates the completor comments on a task_artifact without affecting completion status. | (TaskArtifactUpdateCommentsReq) -> (bool)
129
129
  *
130
130
  * @param {Chrt.TaskArtifactUpdateCommentsReq} request
131
131
  * @param {TaskArtifacts.RequestOptions} requestOptions - Request-specific configuration.
@@ -190,7 +190,7 @@ class TaskArtifacts {
190
190
  });
191
191
  }
192
192
  /**
193
- * Adds a new task_artifact to an existing task
193
+ * Adds a new task_artifact to an existing task. | (TaskArtifactAddToTaskReq) -> (PydanticObjectId)
194
194
  *
195
195
  * @param {Chrt.TaskArtifactAddToTaskReq} request
196
196
  * @param {TaskArtifacts.RequestOptions} requestOptions - Request-specific configuration.
@@ -30,7 +30,7 @@ export declare class Blurhash {
30
30
  protected readonly _options: Blurhash.Options;
31
31
  constructor(_options?: Blurhash.Options);
32
32
  /**
33
- * Retrieves the blurhash string for a task_artifact image for fast placeholder loading.
33
+ * Retrieves the blurhash string for a task_artifact image for fast placeholder loading. | () -> (BlurHash)
34
34
  *
35
35
  * @param {string} taskArtifactS3ObjectMetadataId
36
36
  * @param {Blurhash.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,7 @@ class Blurhash {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Retrieves the blurhash string for a task_artifact image for fast placeholder loading.
59
+ * Retrieves the blurhash string for a task_artifact image for fast placeholder loading. | () -> (BlurHash)
60
60
  *
61
61
  * @param {string} taskArtifactS3ObjectMetadataId
62
62
  * @param {Blurhash.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,13 +31,13 @@ export declare class Images {
31
31
  protected readonly _options: Images.Options;
32
32
  constructor(_options?: Images.Options);
33
33
  /**
34
- * Streams a task_artifact image file from S3 storage.
34
+ * Streams a task_artifact image file from S3 storage. | () -> (StreamingResponse)
35
35
  * @throws {@link Chrt.UnprocessableEntityError}
36
36
  */
37
37
  getByMetadataIdV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: Images.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
38
38
  private __getByMetadataIdV1;
39
39
  /**
40
- * Uploads an image file to a task_artifact with automatic blurhash generation.
40
+ * Uploads an image file to a task_artifact with automatic blurhash generation. | (UploadFile) -> (bool)
41
41
  *
42
42
  * @param {string} taskArtifactId
43
43
  * @param {Chrt.taskArtifacts.BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost} request
@@ -54,7 +54,7 @@ export declare class Images {
54
54
  uploadByTaskArtifactIdV1(taskArtifactId: string, request: Chrt.taskArtifacts.BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost, requestOptions?: Images.RequestOptions): core.HttpResponsePromise<boolean>;
55
55
  private __uploadByTaskArtifactIdV1;
56
56
  /**
57
- * Deletes a task_artifact image from both S3 storage and database metadata.
57
+ * Deletes a task_artifact image from both S3 storage and database metadata. | () -> (bool)
58
58
  *
59
59
  * @param {string} taskArtifactS3ObjectMetadataId
60
60
  * @param {Images.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,7 @@ class Images {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Streams a task_artifact image file from S3 storage.
59
+ * Streams a task_artifact image file from S3 storage. | () -> (StreamingResponse)
60
60
  * @throws {@link Chrt.UnprocessableEntityError}
61
61
  */
62
62
  getByMetadataIdV1(taskArtifactS3ObjectMetadataId, requestOptions) {
@@ -109,7 +109,7 @@ class Images {
109
109
  });
110
110
  }
111
111
  /**
112
- * Uploads an image file to a task_artifact with automatic blurhash generation.
112
+ * Uploads an image file to a task_artifact with automatic blurhash generation. | (UploadFile) -> (bool)
113
113
  *
114
114
  * @param {string} taskArtifactId
115
115
  * @param {Chrt.taskArtifacts.BodyPostTaskArtifactsUploadImageV1OortTaskArtifactsImagesUploadV1TaskArtifactIdPost} request
@@ -178,7 +178,7 @@ class Images {
178
178
  });
179
179
  }
180
180
  /**
181
- * Deletes a task_artifact image from both S3 storage and database metadata.
181
+ * Deletes a task_artifact image from both S3 storage and database metadata. | () -> (bool)
182
182
  *
183
183
  * @param {string} taskArtifactS3ObjectMetadataId
184
184
  * @param {Images.RequestOptions} requestOptions - Request-specific configuration.
@@ -37,7 +37,7 @@ export declare class TaskGroups {
37
37
  get expanded(): Expanded;
38
38
  get expandedList(): ExpandedList;
39
39
  /**
40
- * Updates task group driver assignments by adding or removing drivers.
40
+ * Updates task group driver assignments by adding or removing drivers. | (UpdateTaskGroupReq) -> (bool)
41
41
  *
42
42
  * @param {Chrt.UpdateTaskGroupReq} request
43
43
  * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -52,7 +52,7 @@ export declare class TaskGroups {
52
52
  updateV1(request: Chrt.UpdateTaskGroupReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
53
53
  private __updateV1;
54
54
  /**
55
- * Starts a task group by changing its status to in-progress and updating the order status. Only authorized personas (task_group_driver or task_group_courier_org_administrator) can start a task group.
55
+ * Starts a task group by changing its status to in-progress and updating the order status. Only authorized personas (task_group_driver or task_group_courier_org_administrator) can start a task group. | () -> (bool)
56
56
  *
57
57
  * @param {string} taskGroupId
58
58
  * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -65,7 +65,7 @@ export declare class TaskGroups {
65
65
  startV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
66
66
  private __startV1;
67
67
  /**
68
- * Toggles the pause status of an in-progress task group.
68
+ * Toggles the pause status of an in-progress task group. | (SetTaskGroupPauseReq) -> (bool)
69
69
  *
70
70
  * @param {string} id
71
71
  * @param {Chrt.SetTaskGroupPauseReq} request
@@ -66,7 +66,7 @@ class TaskGroups {
66
66
  return ((_a = this._expandedList) !== null && _a !== void 0 ? _a : (this._expandedList = new Client_js_2.ExpandedList(this._options)));
67
67
  }
68
68
  /**
69
- * Updates task group driver assignments by adding or removing drivers.
69
+ * Updates task group driver assignments by adding or removing drivers. | (UpdateTaskGroupReq) -> (bool)
70
70
  *
71
71
  * @param {Chrt.UpdateTaskGroupReq} request
72
72
  * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -130,7 +130,7 @@ class TaskGroups {
130
130
  });
131
131
  }
132
132
  /**
133
- * Starts a task group by changing its status to in-progress and updating the order status. Only authorized personas (task_group_driver or task_group_courier_org_administrator) can start a task group.
133
+ * Starts a task group by changing its status to in-progress and updating the order status. Only authorized personas (task_group_driver or task_group_courier_org_administrator) can start a task group. | () -> (bool)
134
134
  *
135
135
  * @param {string} taskGroupId
136
136
  * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -189,7 +189,7 @@ class TaskGroups {
189
189
  });
190
190
  }
191
191
  /**
192
- * Toggles the pause status of an in-progress task group.
192
+ * Toggles the pause status of an in-progress task group. | (SetTaskGroupPauseReq) -> (bool)
193
193
  *
194
194
  * @param {string} id
195
195
  * @param {Chrt.SetTaskGroupPauseReq} request
@@ -31,7 +31,7 @@ export declare class Expanded {
31
31
  protected readonly _options: Expanded.Options;
32
32
  constructor(_options?: Expanded.Options);
33
33
  /**
34
- * Fetches an expanded task group for the courier org with expanded related data.
34
+ * Fetches an expanded task group for the courier org with expanded related data. | (TaskGroupExpandedForCourierAdministratorReq) -> (TaskGroupExpandedForCourierAdministrator)
35
35
  *
36
36
  * @param {string} id
37
37
  * @param {Chrt.TaskGroupExpandedForCourierAdministratorReq} request
@@ -45,7 +45,7 @@ export declare class Expanded {
45
45
  forCourierAdministratorByIdV1(id: string, request: Chrt.TaskGroupExpandedForCourierAdministratorReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupExpandedForCourierAdministrator>;
46
46
  private __forCourierAdministratorByIdV1;
47
47
  /**
48
- * Fetches an expanded task group assigned to a courier driver with optional expanded related data.
48
+ * Fetches an expanded task group assigned to a courier driver with optional expanded related data. | (TaskGroupExpandedForCourierDriverReq) -> (TaskGroupExpandedForCourierDriver)
49
49
  *
50
50
  * @param {string} id
51
51
  * @param {Chrt.TaskGroupExpandedForCourierDriverReq} request
@@ -59,7 +59,7 @@ export declare class Expanded {
59
59
  forCourierDriverByIdV1(id: string, request: Chrt.TaskGroupExpandedForCourierDriverReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupExpandedForCourierDriver>;
60
60
  private __forCourierDriverByIdV1;
61
61
  /**
62
- * Fetches an expanded task group for the shipper org with expanded related data.
62
+ * Fetches an expanded task group for the shipper org with expanded related data. | (TaskGroupExpandedForShipperReq) -> (TaskGroupExpandedForShipper)
63
63
  *
64
64
  * @param {string} id
65
65
  * @param {Chrt.taskGroups.TaskGroupExpandedForShipperReq} request
@@ -56,7 +56,7 @@ class Expanded {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Fetches an expanded task group for the courier org with expanded related data.
59
+ * Fetches an expanded task group for the courier org with expanded related data. | (TaskGroupExpandedForCourierAdministratorReq) -> (TaskGroupExpandedForCourierAdministrator)
60
60
  *
61
61
  * @param {string} id
62
62
  * @param {Chrt.TaskGroupExpandedForCourierAdministratorReq} request
@@ -122,7 +122,7 @@ class Expanded {
122
122
  });
123
123
  }
124
124
  /**
125
- * Fetches an expanded task group assigned to a courier driver with optional expanded related data.
125
+ * Fetches an expanded task group assigned to a courier driver with optional expanded related data. | (TaskGroupExpandedForCourierDriverReq) -> (TaskGroupExpandedForCourierDriver)
126
126
  *
127
127
  * @param {string} id
128
128
  * @param {Chrt.TaskGroupExpandedForCourierDriverReq} request
@@ -188,7 +188,7 @@ class Expanded {
188
188
  });
189
189
  }
190
190
  /**
191
- * Fetches an expanded task group for the shipper org with expanded related data.
191
+ * Fetches an expanded task group for the shipper org with expanded related data. | (TaskGroupExpandedForShipperReq) -> (TaskGroupExpandedForShipper)
192
192
  *
193
193
  * @param {string} id
194
194
  * @param {Chrt.taskGroups.TaskGroupExpandedForShipperReq} request
@@ -31,7 +31,7 @@ export declare class ExpandedList {
31
31
  protected readonly _options: ExpandedList.Options;
32
32
  constructor(_options?: ExpandedList.Options);
33
33
  /**
34
- * Fetches expanded task groups for the courier org with optional filters and expanded related data.
34
+ * Fetches expanded task groups for the courier org with optional filters and expanded related data. | (TaskGroupExpandedForCourierAdministratorReq) -> (TaskGroupsExpandedForCourierAdministratorRes)
35
35
  *
36
36
  * @param {Chrt.taskGroups.ExpandedListForCourierAdministratorV1Request} request
37
37
  * @param {ExpandedList.RequestOptions} requestOptions - Request-specific configuration.
@@ -59,7 +59,7 @@ export declare class ExpandedList {
59
59
  forCourierAdministratorV1(request: Chrt.taskGroups.ExpandedListForCourierAdministratorV1Request, requestOptions?: ExpandedList.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupsExpandedForCourierAdministratorRes>;
60
60
  private __forCourierAdministratorV1;
61
61
  /**
62
- * Fetches expanded task groups assigned to a courier driver with optional expanded related data.
62
+ * Fetches expanded task groups assigned to a courier driver with optional expanded related data. | (TaskGroupExpandedForCourierDriverReq) -> (TaskGroupsExpandedForCourierDriverRes)
63
63
  *
64
64
  * @param {Chrt.taskGroups.ExpandedListForCourierDriverV1Request} request
65
65
  * @param {ExpandedList.RequestOptions} requestOptions - Request-specific configuration.
@@ -56,7 +56,7 @@ class ExpandedList {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Fetches expanded task groups for the courier org with optional filters and expanded related data.
59
+ * Fetches expanded task groups for the courier org with optional filters and expanded related data. | (TaskGroupExpandedForCourierAdministratorReq) -> (TaskGroupsExpandedForCourierAdministratorRes)
60
60
  *
61
61
  * @param {Chrt.taskGroups.ExpandedListForCourierAdministratorV1Request} request
62
62
  * @param {ExpandedList.RequestOptions} requestOptions - Request-specific configuration.
@@ -185,7 +185,7 @@ class ExpandedList {
185
185
  });
186
186
  }
187
187
  /**
188
- * Fetches expanded task groups assigned to a courier driver with optional expanded related data.
188
+ * Fetches expanded task groups assigned to a courier driver with optional expanded related data. | (TaskGroupExpandedForCourierDriverReq) -> (TaskGroupsExpandedForCourierDriverRes)
189
189
  *
190
190
  * @param {Chrt.taskGroups.ExpandedListForCourierDriverV1Request} request
191
191
  * @param {ExpandedList.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,14 +31,14 @@ export declare class Users {
31
31
  protected readonly _options: Users.Options;
32
32
  constructor(_options?: Users.Options);
33
33
  /**
34
- * Retrieves public user data for the authenticated user, including email, notes, and Stripe customer information. | () -> (UserPublicData1)
34
+ * Retrieves public user data for the authenticated user. | () -> (UserPublicData1)
35
35
  *
36
36
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
37
37
  *
38
38
  * @example
39
- * await client.users.getPublicDataV1()
39
+ * await client.users.getUserPublicDataV1()
40
40
  */
41
- getPublicDataV1(requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Chrt.UserPublicData1>;
42
- private __getPublicDataV1;
41
+ getUserPublicDataV1(requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Chrt.UserPublicData1>;
42
+ private __getUserPublicDataV1;
43
43
  protected _getAuthorizationHeader(): Promise<string | undefined>;
44
44
  }
@@ -55,17 +55,17 @@ class Users {
55
55
  this._options = _options;
56
56
  }
57
57
  /**
58
- * Retrieves public user data for the authenticated user, including email, notes, and Stripe customer information. | () -> (UserPublicData1)
58
+ * Retrieves public user data for the authenticated user. | () -> (UserPublicData1)
59
59
  *
60
60
  * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
61
61
  *
62
62
  * @example
63
- * await client.users.getPublicDataV1()
63
+ * await client.users.getUserPublicDataV1()
64
64
  */
65
- getPublicDataV1(requestOptions) {
66
- return core.HttpResponsePromise.fromPromise(this.__getPublicDataV1(requestOptions));
65
+ getUserPublicDataV1(requestOptions) {
66
+ return core.HttpResponsePromise.fromPromise(this.__getUserPublicDataV1(requestOptions));
67
67
  }
68
- __getPublicDataV1(requestOptions) {
68
+ __getUserPublicDataV1(requestOptions) {
69
69
  return __awaiter(this, void 0, void 0, function* () {
70
70
  var _a, _b, _c, _d;
71
71
  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);
@@ -4,10 +4,10 @@
4
4
  import * as Chrt from "../index.js";
5
5
  export interface OrgPublicData1 {
6
6
  schema_version: number;
7
+ org_type: Chrt.OrgTypeEnum;
7
8
  /** Must be a string starting with `org_` */
8
9
  org_id: string;
9
10
  company_name?: string | null;
10
11
  handle?: string | null;
11
- org_type: Chrt.OrgTypeEnum;
12
12
  _id: string;
13
13
  }
@@ -4,8 +4,7 @@
4
4
  export interface UserPublicData1 {
5
5
  schema_version: number;
6
6
  primary_email_address?: string | null;
7
+ /** Must be a string starting with `user_` */
7
8
  user_id: string;
8
- customer_id?: string | null;
9
- notes?: Record<string, unknown> | null;
10
9
  _id: string;
11
10
  }
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.304.0";
1
+ export declare const SDK_VERSION = "1.305.0";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.304.0";
4
+ exports.SDK_VERSION = "1.305.0";
@@ -35,8 +35,8 @@ export class ChrtClient {
35
35
  this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
36
36
  "X-Fern-Language": "JavaScript",
37
37
  "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
38
- "X-Fern-SDK-Version": "1.304.0",
39
- "User-Agent": "@chrt-inc/typescript-sdk/1.304.0",
38
+ "X-Fern-SDK-Version": "1.305.0",
39
+ "User-Agent": "@chrt-inc/typescript-sdk/1.305.0",
40
40
  "X-Fern-Runtime": core.RUNTIME.type,
41
41
  "X-Fern-Runtime-Version": core.RUNTIME.version,
42
42
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });