@chrt-inc/typescript-sdk 1.992.0 → 1.997.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 (70) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/errors/ForbiddenError.d.ts +9 -0
  3. package/dist/cjs/api/errors/ForbiddenError.js +52 -0
  4. package/dist/cjs/api/errors/LockedError.d.ts +9 -0
  5. package/dist/cjs/api/errors/LockedError.js +52 -0
  6. package/dist/cjs/api/errors/NotFoundError.d.ts +9 -0
  7. package/dist/cjs/api/errors/NotFoundError.js +52 -0
  8. package/dist/cjs/api/errors/ServiceUnavailableError.d.ts +9 -0
  9. package/dist/cjs/api/errors/ServiceUnavailableError.js +52 -0
  10. package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +1 -2
  11. package/dist/cjs/api/errors/index.d.ts +4 -0
  12. package/dist/cjs/api/errors/index.js +4 -0
  13. package/dist/cjs/api/resources/operations/resources/orderInternalMessages/resources/s3Objects/client/Client.d.ts +5 -1
  14. package/dist/cjs/api/resources/operations/resources/orderInternalMessages/resources/s3Objects/client/Client.js +13 -1
  15. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.d.ts +5 -1
  16. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.js +13 -1
  17. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.d.ts +5 -1
  18. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.js +13 -1
  19. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.ts +5 -1
  20. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.js +13 -1
  21. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.d.ts +5 -1
  22. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.js +13 -1
  23. package/dist/cjs/api/types/FileDownloadErrorRes.d.ts +27 -0
  24. package/dist/cjs/api/types/FileDownloadErrorRes.js +19 -0
  25. package/dist/cjs/api/types/FileDownloadRequestErrorRes.d.ts +13 -0
  26. package/dist/cjs/api/types/FileDownloadRequestErrorRes.js +5 -0
  27. package/dist/cjs/api/types/NotFoundErrorBody.d.ts +5 -0
  28. package/dist/cjs/api/types/NotFoundErrorBody.js +5 -0
  29. package/dist/cjs/api/types/UnprocessableEntityErrorBody.d.ts +5 -0
  30. package/dist/cjs/api/types/UnprocessableEntityErrorBody.js +5 -0
  31. package/dist/cjs/api/types/index.d.ts +4 -0
  32. package/dist/cjs/api/types/index.js +4 -0
  33. package/dist/cjs/version.d.ts +1 -1
  34. package/dist/cjs/version.js +1 -1
  35. package/dist/esm/Client.mjs +2 -2
  36. package/dist/esm/api/errors/ForbiddenError.d.mts +9 -0
  37. package/dist/esm/api/errors/ForbiddenError.mjs +15 -0
  38. package/dist/esm/api/errors/LockedError.d.mts +9 -0
  39. package/dist/esm/api/errors/LockedError.mjs +15 -0
  40. package/dist/esm/api/errors/NotFoundError.d.mts +9 -0
  41. package/dist/esm/api/errors/NotFoundError.mjs +15 -0
  42. package/dist/esm/api/errors/ServiceUnavailableError.d.mts +9 -0
  43. package/dist/esm/api/errors/ServiceUnavailableError.mjs +15 -0
  44. package/dist/esm/api/errors/UnprocessableEntityError.d.mts +1 -2
  45. package/dist/esm/api/errors/index.d.mts +4 -0
  46. package/dist/esm/api/errors/index.mjs +4 -0
  47. package/dist/esm/api/resources/operations/resources/orderInternalMessages/resources/s3Objects/client/Client.d.mts +5 -1
  48. package/dist/esm/api/resources/operations/resources/orderInternalMessages/resources/s3Objects/client/Client.mjs +13 -1
  49. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.d.mts +5 -1
  50. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.mjs +13 -1
  51. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.d.mts +5 -1
  52. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.mjs +13 -1
  53. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.mts +5 -1
  54. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.mjs +13 -1
  55. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.d.mts +5 -1
  56. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/s3Object/client/Client.mjs +13 -1
  57. package/dist/esm/api/types/FileDownloadErrorRes.d.mts +27 -0
  58. package/dist/esm/api/types/FileDownloadErrorRes.mjs +16 -0
  59. package/dist/esm/api/types/FileDownloadRequestErrorRes.d.mts +13 -0
  60. package/dist/esm/api/types/FileDownloadRequestErrorRes.mjs +4 -0
  61. package/dist/esm/api/types/NotFoundErrorBody.d.mts +5 -0
  62. package/dist/esm/api/types/NotFoundErrorBody.mjs +4 -0
  63. package/dist/esm/api/types/UnprocessableEntityErrorBody.d.mts +5 -0
  64. package/dist/esm/api/types/UnprocessableEntityErrorBody.mjs +4 -0
  65. package/dist/esm/api/types/index.d.mts +4 -0
  66. package/dist/esm/api/types/index.mjs +4 -0
  67. package/dist/esm/version.d.mts +1 -1
  68. package/dist/esm/version.mjs +1 -1
  69. package/package.json +1 -1
  70. package/reference.md +5 -5
@@ -60,8 +60,8 @@ class ChrtClient {
60
60
  this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
61
61
  "X-Fern-Language": "JavaScript",
62
62
  "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
63
- "X-Fern-SDK-Version": "1.992.0",
64
- "User-Agent": "@chrt-inc/typescript-sdk/1.992.0",
63
+ "X-Fern-SDK-Version": "1.997.0",
64
+ "User-Agent": "@chrt-inc/typescript-sdk/1.997.0",
65
65
  "X-Fern-Runtime": core.RUNTIME.type,
66
66
  "X-Fern-Runtime-Version": core.RUNTIME.version,
67
67
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index.js";
5
+ import * as Chrt from "../index.js";
6
+ import * as core from "../../core/index.js";
7
+ export declare class ForbiddenError extends errors.ChrtError {
8
+ constructor(body: Chrt.FileDownloadRequestErrorRes, rawResponse?: core.RawResponse);
9
+ }
@@ -0,0 +1,52 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.ForbiddenError = void 0;
40
+ const errors = __importStar(require("../../errors/index.js"));
41
+ class ForbiddenError extends errors.ChrtError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "ForbiddenError",
45
+ statusCode: 403,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, ForbiddenError.prototype);
50
+ }
51
+ }
52
+ exports.ForbiddenError = ForbiddenError;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index.js";
5
+ import * as Chrt from "../index.js";
6
+ import * as core from "../../core/index.js";
7
+ export declare class LockedError extends errors.ChrtError {
8
+ constructor(body: Chrt.FileDownloadErrorRes, rawResponse?: core.RawResponse);
9
+ }
@@ -0,0 +1,52 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.LockedError = void 0;
40
+ const errors = __importStar(require("../../errors/index.js"));
41
+ class LockedError extends errors.ChrtError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "LockedError",
45
+ statusCode: 423,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, LockedError.prototype);
50
+ }
51
+ }
52
+ exports.LockedError = LockedError;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index.js";
5
+ import * as Chrt from "../index.js";
6
+ import * as core from "../../core/index.js";
7
+ export declare class NotFoundError extends errors.ChrtError {
8
+ constructor(body: Chrt.NotFoundErrorBody, rawResponse?: core.RawResponse);
9
+ }
@@ -0,0 +1,52 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.NotFoundError = void 0;
40
+ const errors = __importStar(require("../../errors/index.js"));
41
+ class NotFoundError extends errors.ChrtError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "NotFoundError",
45
+ statusCode: 404,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, NotFoundError.prototype);
50
+ }
51
+ }
52
+ exports.NotFoundError = NotFoundError;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index.js";
5
+ import * as Chrt from "../index.js";
6
+ import * as core from "../../core/index.js";
7
+ export declare class ServiceUnavailableError extends errors.ChrtError {
8
+ constructor(body: Chrt.FileDownloadErrorRes, rawResponse?: core.RawResponse);
9
+ }
@@ -0,0 +1,52 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.ServiceUnavailableError = void 0;
40
+ const errors = __importStar(require("../../errors/index.js"));
41
+ class ServiceUnavailableError extends errors.ChrtError {
42
+ constructor(body, rawResponse) {
43
+ super({
44
+ message: "ServiceUnavailableError",
45
+ statusCode: 503,
46
+ body: body,
47
+ rawResponse: rawResponse,
48
+ });
49
+ Object.setPrototypeOf(this, ServiceUnavailableError.prototype);
50
+ }
51
+ }
52
+ exports.ServiceUnavailableError = ServiceUnavailableError;
@@ -2,8 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors/index.js";
5
- import * as Chrt from "../index.js";
6
5
  import * as core from "../../core/index.js";
7
6
  export declare class UnprocessableEntityError extends errors.ChrtError {
8
- constructor(body: Chrt.HttpValidationError, rawResponse?: core.RawResponse);
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
9
8
  }
@@ -1 +1,5 @@
1
1
  export * from "./UnprocessableEntityError.js";
2
+ export * from "./ForbiddenError.js";
3
+ export * from "./NotFoundError.js";
4
+ export * from "./LockedError.js";
5
+ export * from "./ServiceUnavailableError.js";
@@ -15,3 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./UnprocessableEntityError.js"), exports);
18
+ __exportStar(require("./ForbiddenError.js"), exports);
19
+ __exportStar(require("./NotFoundError.js"), exports);
20
+ __exportStar(require("./LockedError.js"), exports);
21
+ __exportStar(require("./ServiceUnavailableError.js"), exports);
@@ -31,7 +31,7 @@ export declare class S3Objects {
31
31
  protected readonly _options: S3Objects.Options;
32
32
  constructor(_options?: S3Objects.Options);
33
33
  /**
34
- * Uploads a file to the caller's OrderInternalMessages for this order (lazy-creates the messages doc). Automatic blurhash generation for images. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (UploadFile) -> (OrderInternalMessageS3ObjectMetadata1)
34
+ * Uploads a file to the caller's OrderInternalMessages for this order (lazy-creates the messages doc). Retains uploaded files; previews require a clean malware scan. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (UploadFile) -> (OrderInternalMessageS3ObjectMetadata1)
35
35
  *
36
36
  * @param {string} orderId
37
37
  * @param {Chrt.operations.orderInternalMessages.BodyPostOrderInternalMessagesS3ObjectsAddV1} request
@@ -75,7 +75,11 @@ export declare class S3Objects {
75
75
  private __getS3ObjectMetadataV1;
76
76
  /**
77
77
  * Streams an order internal messages S3 object file from storage. | authz: min_org_role=operator | () -> (binary)
78
+ * @throws {@link Chrt.ForbiddenError}
79
+ * @throws {@link Chrt.NotFoundError}
78
80
  * @throws {@link Chrt.UnprocessableEntityError}
81
+ * @throws {@link Chrt.LockedError}
82
+ * @throws {@link Chrt.ServiceUnavailableError}
79
83
  */
80
84
  getV1(orderInternalMessageS3ObjectMetadataId: string, requestOptions?: S3Objects.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
81
85
  private __getV1;
@@ -56,7 +56,7 @@ class S3Objects {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Uploads a file to the caller's OrderInternalMessages for this order (lazy-creates the messages doc). Automatic blurhash generation for images. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (UploadFile) -> (OrderInternalMessageS3ObjectMetadata1)
59
+ * Uploads a file to the caller's OrderInternalMessages for this order (lazy-creates the messages doc). Retains uploaded files; previews require a clean malware scan. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (UploadFile) -> (OrderInternalMessageS3ObjectMetadata1)
60
60
  *
61
61
  * @param {string} orderId
62
62
  * @param {Chrt.operations.orderInternalMessages.BodyPostOrderInternalMessagesS3ObjectsAddV1} request
@@ -250,7 +250,11 @@ class S3Objects {
250
250
  }
251
251
  /**
252
252
  * Streams an order internal messages S3 object file from storage. | authz: min_org_role=operator | () -> (binary)
253
+ * @throws {@link Chrt.ForbiddenError}
254
+ * @throws {@link Chrt.NotFoundError}
253
255
  * @throws {@link Chrt.UnprocessableEntityError}
256
+ * @throws {@link Chrt.LockedError}
257
+ * @throws {@link Chrt.ServiceUnavailableError}
254
258
  */
255
259
  getV1(orderInternalMessageS3ObjectMetadataId, requestOptions) {
256
260
  return core.HttpResponsePromise.fromPromise(this.__getV1(orderInternalMessageS3ObjectMetadataId, requestOptions));
@@ -274,8 +278,16 @@ class S3Objects {
274
278
  }
275
279
  if (_response.error.reason === "status-code") {
276
280
  switch (_response.error.statusCode) {
281
+ case 403:
282
+ throw new Chrt.ForbiddenError(_response.error.body, _response.rawResponse);
283
+ case 404:
284
+ throw new Chrt.NotFoundError(_response.error.body, _response.rawResponse);
277
285
  case 422:
278
286
  throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
287
+ case 423:
288
+ throw new Chrt.LockedError(_response.error.body, _response.rawResponse);
289
+ case 503:
290
+ throw new Chrt.ServiceUnavailableError(_response.error.body, _response.rawResponse);
279
291
  default:
280
292
  throw new errors.ChrtError({
281
293
  statusCode: _response.error.statusCode,
@@ -31,7 +31,7 @@ export declare class S3Object {
31
31
  protected readonly _options: S3Object.Options;
32
32
  constructor(_options?: S3Object.Options);
33
33
  /**
34
- * Uploads a file to an organization compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (OrgComplianceDocumentS3ObjectMetadata1)
34
+ * Uploads a file to an organization compliance document. Retains uploaded files; previews require a clean malware scan. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (OrgComplianceDocumentS3ObjectMetadata1)
35
35
  *
36
36
  * @param {string} orgComplianceDocumentId
37
37
  * @param {Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1} request
@@ -75,7 +75,11 @@ export declare class S3Object {
75
75
  private __getS3ObjectMetadataV1;
76
76
  /**
77
77
  * Streams an organization compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
78
+ * @throws {@link Chrt.ForbiddenError}
79
+ * @throws {@link Chrt.NotFoundError}
78
80
  * @throws {@link Chrt.UnprocessableEntityError}
81
+ * @throws {@link Chrt.LockedError}
82
+ * @throws {@link Chrt.ServiceUnavailableError}
79
83
  */
80
84
  getV1(orgComplianceDocumentS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
81
85
  private __getV1;
@@ -56,7 +56,7 @@ class S3Object {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Uploads a file to an organization compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (OrgComplianceDocumentS3ObjectMetadata1)
59
+ * Uploads a file to an organization compliance document. Retains uploaded files; previews require a clean malware scan. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (OrgComplianceDocumentS3ObjectMetadata1)
60
60
  *
61
61
  * @param {string} orgComplianceDocumentId
62
62
  * @param {Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1} request
@@ -250,7 +250,11 @@ class S3Object {
250
250
  }
251
251
  /**
252
252
  * Streams an organization compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
253
+ * @throws {@link Chrt.ForbiddenError}
254
+ * @throws {@link Chrt.NotFoundError}
253
255
  * @throws {@link Chrt.UnprocessableEntityError}
256
+ * @throws {@link Chrt.LockedError}
257
+ * @throws {@link Chrt.ServiceUnavailableError}
254
258
  */
255
259
  getV1(orgComplianceDocumentS3ObjectMetadataId, requestOptions) {
256
260
  return core.HttpResponsePromise.fromPromise(this.__getV1(orgComplianceDocumentS3ObjectMetadataId, requestOptions));
@@ -274,8 +278,16 @@ class S3Object {
274
278
  }
275
279
  if (_response.error.reason === "status-code") {
276
280
  switch (_response.error.statusCode) {
281
+ case 403:
282
+ throw new Chrt.ForbiddenError(_response.error.body, _response.rawResponse);
283
+ case 404:
284
+ throw new Chrt.NotFoundError(_response.error.body, _response.rawResponse);
277
285
  case 422:
278
286
  throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
287
+ case 423:
288
+ throw new Chrt.LockedError(_response.error.body, _response.rawResponse);
289
+ case 503:
290
+ throw new Chrt.ServiceUnavailableError(_response.error.body, _response.rawResponse);
279
291
  default:
280
292
  throw new errors.ChrtError({
281
293
  statusCode: _response.error.statusCode,
@@ -31,7 +31,7 @@ export declare class S3Object {
31
31
  protected readonly _options: S3Object.Options;
32
32
  constructor(_options?: S3Object.Options);
33
33
  /**
34
- * Uploads a file to a driver compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (DriverComplianceDocumentS3ObjectMetadata1)
34
+ * Uploads a file to a driver compliance document. Retains uploaded files; previews require a clean malware scan. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (DriverComplianceDocumentS3ObjectMetadata1)
35
35
  *
36
36
  * @param {string} driverComplianceDocumentId
37
37
  * @param {Chrt.shipping.drivers.complianceDocuments.BodyPostDriverComplianceDocumentsS3ObjectAddV1} request
@@ -75,7 +75,11 @@ export declare class S3Object {
75
75
  private __getS3ObjectMetadataV1;
76
76
  /**
77
77
  * Streams a driver compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
78
+ * @throws {@link Chrt.ForbiddenError}
79
+ * @throws {@link Chrt.NotFoundError}
78
80
  * @throws {@link Chrt.UnprocessableEntityError}
81
+ * @throws {@link Chrt.LockedError}
82
+ * @throws {@link Chrt.ServiceUnavailableError}
79
83
  */
80
84
  getV1(driverComplianceDocumentS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
81
85
  private __getV1;
@@ -56,7 +56,7 @@ class S3Object {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Uploads a file to a driver compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (DriverComplianceDocumentS3ObjectMetadata1)
59
+ * Uploads a file to a driver compliance document. Retains uploaded files; previews require a clean malware scan. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (DriverComplianceDocumentS3ObjectMetadata1)
60
60
  *
61
61
  * @param {string} driverComplianceDocumentId
62
62
  * @param {Chrt.shipping.drivers.complianceDocuments.BodyPostDriverComplianceDocumentsS3ObjectAddV1} request
@@ -250,7 +250,11 @@ class S3Object {
250
250
  }
251
251
  /**
252
252
  * Streams a driver compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
253
+ * @throws {@link Chrt.ForbiddenError}
254
+ * @throws {@link Chrt.NotFoundError}
253
255
  * @throws {@link Chrt.UnprocessableEntityError}
256
+ * @throws {@link Chrt.LockedError}
257
+ * @throws {@link Chrt.ServiceUnavailableError}
254
258
  */
255
259
  getV1(driverComplianceDocumentS3ObjectMetadataId, requestOptions) {
256
260
  return core.HttpResponsePromise.fromPromise(this.__getV1(driverComplianceDocumentS3ObjectMetadataId, requestOptions));
@@ -274,8 +278,16 @@ class S3Object {
274
278
  }
275
279
  if (_response.error.reason === "status-code") {
276
280
  switch (_response.error.statusCode) {
281
+ case 403:
282
+ throw new Chrt.ForbiddenError(_response.error.body, _response.rawResponse);
283
+ case 404:
284
+ throw new Chrt.NotFoundError(_response.error.body, _response.rawResponse);
277
285
  case 422:
278
286
  throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
287
+ case 423:
288
+ throw new Chrt.LockedError(_response.error.body, _response.rawResponse);
289
+ case 503:
290
+ throw new Chrt.ServiceUnavailableError(_response.error.body, _response.rawResponse);
279
291
  default:
280
292
  throw new errors.ChrtError({
281
293
  statusCode: _response.error.statusCode,
@@ -31,7 +31,7 @@ export declare class S3Object {
31
31
  protected readonly _options: S3Object.Options;
32
32
  constructor(_options?: S3Object.Options);
33
33
  /**
34
- * Uploads a file (image, PDF, etc.) to a task artifact. Automatic blurhash generation for images. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (UploadFile) -> (TaskArtifactS3ObjectMetadata1)
34
+ * Uploads a file (image, PDF, etc.) to a task artifact. Retains uploaded files; previews require a clean malware scan. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (UploadFile) -> (TaskArtifactS3ObjectMetadata1)
35
35
  *
36
36
  * @param {string} taskArtifactId
37
37
  * @param {Chrt.shipping.taskArtifacts.BodyPostTaskArtifactsS3ObjectAddV1} request
@@ -101,7 +101,11 @@ export declare class S3Object {
101
101
  private __getS3ObjectMetadataV1;
102
102
  /**
103
103
  * Streams a task artifact S3 object file from storage. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | () -> (binary)
104
+ * @throws {@link Chrt.ForbiddenError}
105
+ * @throws {@link Chrt.NotFoundError}
104
106
  * @throws {@link Chrt.UnprocessableEntityError}
107
+ * @throws {@link Chrt.LockedError}
108
+ * @throws {@link Chrt.ServiceUnavailableError}
105
109
  */
106
110
  getV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
107
111
  private __getV1;
@@ -56,7 +56,7 @@ class S3Object {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Uploads a file (image, PDF, etc.) to a task artifact. Automatic blurhash generation for images. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (UploadFile) -> (TaskArtifactS3ObjectMetadata1)
59
+ * Uploads a file (image, PDF, etc.) to a task artifact. Retains uploaded files; previews require a clean malware scan. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (UploadFile) -> (TaskArtifactS3ObjectMetadata1)
60
60
  *
61
61
  * @param {string} taskArtifactId
62
62
  * @param {Chrt.shipping.taskArtifacts.BodyPostTaskArtifactsS3ObjectAddV1} request
@@ -319,7 +319,11 @@ class S3Object {
319
319
  }
320
320
  /**
321
321
  * Streams a task artifact S3 object file from storage. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | () -> (binary)
322
+ * @throws {@link Chrt.ForbiddenError}
323
+ * @throws {@link Chrt.NotFoundError}
322
324
  * @throws {@link Chrt.UnprocessableEntityError}
325
+ * @throws {@link Chrt.LockedError}
326
+ * @throws {@link Chrt.ServiceUnavailableError}
323
327
  */
324
328
  getV1(taskArtifactS3ObjectMetadataId, requestOptions) {
325
329
  return core.HttpResponsePromise.fromPromise(this.__getV1(taskArtifactS3ObjectMetadataId, requestOptions));
@@ -343,8 +347,16 @@ class S3Object {
343
347
  }
344
348
  if (_response.error.reason === "status-code") {
345
349
  switch (_response.error.statusCode) {
350
+ case 403:
351
+ throw new Chrt.ForbiddenError(_response.error.body, _response.rawResponse);
352
+ case 404:
353
+ throw new Chrt.NotFoundError(_response.error.body, _response.rawResponse);
346
354
  case 422:
347
355
  throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
356
+ case 423:
357
+ throw new Chrt.LockedError(_response.error.body, _response.rawResponse);
358
+ case 503:
359
+ throw new Chrt.ServiceUnavailableError(_response.error.body, _response.rawResponse);
348
360
  default:
349
361
  throw new errors.ChrtError({
350
362
  statusCode: _response.error.statusCode,
@@ -31,7 +31,7 @@ export declare class S3Object {
31
31
  protected readonly _options: S3Object.Options;
32
32
  constructor(_options?: S3Object.Options);
33
33
  /**
34
- * Uploads a file (image, PDF, etc.) to a task group. Automatic blurhash generation for images. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (UploadFile) -> (TaskGroupS3ObjectMetadata1)
34
+ * Uploads a file (image, PDF, etc.) to a task group. Retains uploaded files; previews require a clean malware scan. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (UploadFile) -> (TaskGroupS3ObjectMetadata1)
35
35
  *
36
36
  * @param {string} taskGroupId
37
37
  * @param {Chrt.shipping.taskGroups.BodyPostTaskGroupsS3ObjectAddV1} request
@@ -75,7 +75,11 @@ export declare class S3Object {
75
75
  private __getS3ObjectMetadataV1;
76
76
  /**
77
77
  * Streams a task group S3 object file from storage. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | () -> (binary)
78
+ * @throws {@link Chrt.ForbiddenError}
79
+ * @throws {@link Chrt.NotFoundError}
78
80
  * @throws {@link Chrt.UnprocessableEntityError}
81
+ * @throws {@link Chrt.LockedError}
82
+ * @throws {@link Chrt.ServiceUnavailableError}
79
83
  */
80
84
  getV1(taskGroupS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
81
85
  private __getV1;
@@ -56,7 +56,7 @@ class S3Object {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Uploads a file (image, PDF, etc.) to a task group. Automatic blurhash generation for images. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (UploadFile) -> (TaskGroupS3ObjectMetadata1)
59
+ * Uploads a file (image, PDF, etc.) to a task group. Retains uploaded files; previews require a clean malware scan. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (UploadFile) -> (TaskGroupS3ObjectMetadata1)
60
60
  *
61
61
  * @param {string} taskGroupId
62
62
  * @param {Chrt.shipping.taskGroups.BodyPostTaskGroupsS3ObjectAddV1} request
@@ -244,7 +244,11 @@ class S3Object {
244
244
  }
245
245
  /**
246
246
  * Streams a task group S3 object file from storage. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | () -> (binary)
247
+ * @throws {@link Chrt.ForbiddenError}
248
+ * @throws {@link Chrt.NotFoundError}
247
249
  * @throws {@link Chrt.UnprocessableEntityError}
250
+ * @throws {@link Chrt.LockedError}
251
+ * @throws {@link Chrt.ServiceUnavailableError}
248
252
  */
249
253
  getV1(taskGroupS3ObjectMetadataId, requestOptions) {
250
254
  return core.HttpResponsePromise.fromPromise(this.__getV1(taskGroupS3ObjectMetadataId, requestOptions));
@@ -268,8 +272,16 @@ class S3Object {
268
272
  }
269
273
  if (_response.error.reason === "status-code") {
270
274
  switch (_response.error.statusCode) {
275
+ case 403:
276
+ throw new Chrt.ForbiddenError(_response.error.body, _response.rawResponse);
277
+ case 404:
278
+ throw new Chrt.NotFoundError(_response.error.body, _response.rawResponse);
271
279
  case 422:
272
280
  throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
281
+ case 423:
282
+ throw new Chrt.LockedError(_response.error.body, _response.rawResponse);
283
+ case 503:
284
+ throw new Chrt.ServiceUnavailableError(_response.error.body, _response.rawResponse);
273
285
  default:
274
286
  throw new errors.ChrtError({
275
287
  statusCode: _response.error.statusCode,
@@ -0,0 +1,27 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface FileDownloadErrorRes {
5
+ /** Stable code for client behavior; do not parse detail. */
6
+ code: FileDownloadErrorRes.Code;
7
+ /** Factual description of the file or scan condition. */
8
+ detail: string;
9
+ /** Whether another download attempt may help without operator intervention. */
10
+ retryable: boolean;
11
+ }
12
+ export declare namespace FileDownloadErrorRes {
13
+ /**
14
+ * Stable code for client behavior; do not parse detail.
15
+ */
16
+ type Code = "FILE_SCAN_PENDING" | "FILE_MALWARE_DETECTED" | "FILE_SCAN_UNSUPPORTED" | "FILE_SCAN_FAILED" | "FILE_SCAN_ACCESS_DENIED" | "FILE_SCAN_STATUS_UNAVAILABLE" | "FILE_DOWNLOAD_UNAVAILABLE" | "FILE_NOT_FOUND";
17
+ const Code: {
18
+ readonly FileScanPending: "FILE_SCAN_PENDING";
19
+ readonly FileMalwareDetected: "FILE_MALWARE_DETECTED";
20
+ readonly FileScanUnsupported: "FILE_SCAN_UNSUPPORTED";
21
+ readonly FileScanFailed: "FILE_SCAN_FAILED";
22
+ readonly FileScanAccessDenied: "FILE_SCAN_ACCESS_DENIED";
23
+ readonly FileScanStatusUnavailable: "FILE_SCAN_STATUS_UNAVAILABLE";
24
+ readonly FileDownloadUnavailable: "FILE_DOWNLOAD_UNAVAILABLE";
25
+ readonly FileNotFound: "FILE_NOT_FOUND";
26
+ };
27
+ }
@@ -0,0 +1,19 @@
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.FileDownloadErrorRes = void 0;
7
+ var FileDownloadErrorRes;
8
+ (function (FileDownloadErrorRes) {
9
+ FileDownloadErrorRes.Code = {
10
+ FileScanPending: "FILE_SCAN_PENDING",
11
+ FileMalwareDetected: "FILE_MALWARE_DETECTED",
12
+ FileScanUnsupported: "FILE_SCAN_UNSUPPORTED",
13
+ FileScanFailed: "FILE_SCAN_FAILED",
14
+ FileScanAccessDenied: "FILE_SCAN_ACCESS_DENIED",
15
+ FileScanStatusUnavailable: "FILE_SCAN_STATUS_UNAVAILABLE",
16
+ FileDownloadUnavailable: "FILE_DOWNLOAD_UNAVAILABLE",
17
+ FileNotFound: "FILE_NOT_FOUND",
18
+ };
19
+ })(FileDownloadErrorRes || (exports.FileDownloadErrorRes = FileDownloadErrorRes = {}));