@chrt-inc/typescript-sdk 1.321.0 → 1.322.0

package/reference.md

@@ -6598,142 +6598,6 @@ await client.taskGroups.addMessageV1("task_group_id", {
 </dl>
 </details>
 
-<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">addS3ObjectV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Uploads an image file to a task group with automatic blurhash generation. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.taskGroups.addS3ObjectV1("task_group_id", {
-    image: fs.createReadStream("/path/to/your/file"),
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**taskGroupId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Chrt.BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `TaskGroups.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">deleteS3ObjectV1</a>(taskGroupS3ObjectMetadataId) -> boolean</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Deletes an S3 object metadata and the associated S3 object from a task group. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.taskGroups.deleteS3ObjectV1("task_group_s3_object_metadata_id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**taskGroupS3ObjectMetadataId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `TaskGroups.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Tasks
 
 <details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">addToTaskGroupV1</a>(taskGroupId, { ...params }) -> string</code></summary>
@@ -11432,9 +11296,9 @@ await client.shipperPayCourierLineItemGroups.removeLineItems.byIdV1("id", {
 </dl>
 </details>
 
-## TaskArtifacts S3ObjectMetadata
+## TaskArtifacts S3Object
 
-<details><summary><code>client.taskArtifacts.s3ObjectMetadata.<a href="/src/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) -> Chrt.TaskArtifactS3ObjectMetadata1</code></summary>
+<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(taskArtifactS3ObjectMetadataId) -> Chrt.TaskArtifactS3ObjectMetadata1</code></summary>
 <dl>
 <dd>
 
@@ -11462,7 +11326,7 @@ Retrieves the metadata for a task artifact S3 object, including blurhash for pla
 <dd>
 
 ```typescript
-await client.taskArtifacts.s3ObjectMetadata.getV1("task_artifact_s3_object_metadata_id");
+await client.taskArtifacts.s3Object.getS3ObjectMetadataV1("task_artifact_s3_object_metadata_id");
 ```
 
 </dd>
@@ -11486,7 +11350,7 @@ await client.taskArtifacts.s3ObjectMetadata.getV1("task_artifact_s3_object_metad
 <dl>
 <dd>
 
-**requestOptions:** `S3ObjectMetadata.RequestOptions`
+**requestOptions:** `S3Object.RequestOptions`
 
 </dd>
 </dl>
@@ -11497,8 +11361,6 @@ await client.taskArtifacts.s3ObjectMetadata.getV1("task_artifact_s3_object_metad
 </dl>
 </details>
 
-## TaskArtifacts S3Object
-
 <details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) -> unknown</code></summary>
 <dl>
 <dd>
@@ -11562,6 +11424,142 @@ await client.taskArtifacts.s3Object.getV1("task_artifact_s3_object_metadata_id")
 </dl>
 </details>
 
+<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">addV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uploads an image file to a task artifact with automatic blurhash generation. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.taskArtifacts.s3Object.addV1("task_artifact_id", {
+    image: fs.createReadStream("/path/to/your/file"),
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskArtifactId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.taskArtifacts.BodyPostTaskArtifactsS3ObjectAddV1OortTaskArtifactsS3ObjectAddV1TaskArtifactIdPost`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Object.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">deleteV1</a>(taskArtifactS3ObjectMetadataId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes an S3 object metadata and the associated S3 object from a task artifact. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.taskArtifacts.s3Object.deleteV1("task_artifact_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskArtifactS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Object.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## TaskGroups TaskGroupId
 
 <details><summary><code>client.taskGroups.taskGroupId.<a href="/src/api/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierOperatorsV1</a>(orderIdOrShortId) -> string</code></summary>
@@ -11690,9 +11688,9 @@ await client.taskGroups.taskGroupId.forCourierDriverV1("order_id_or_short_id");
 </dl>
 </details>
 
-## TaskGroups S3ObjectMetadata
+## TaskGroups S3Object
 
-<details><summary><code>client.taskGroups.s3ObjectMetadata.<a href="/src/api/resources/taskGroups/resources/s3ObjectMetadata/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) -> Chrt.TaskGroupS3ObjectMetadata1</code></summary>
+<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(taskGroupS3ObjectMetadataId) -> Chrt.TaskGroupS3ObjectMetadata1</code></summary>
 <dl>
 <dd>
 
@@ -11720,7 +11718,7 @@ Retrieves the metadata for a task group S3 object, including blurhash for placeh
 <dd>
 
 ```typescript
-await client.taskGroups.s3ObjectMetadata.getV1("task_group_s3_object_metadata_id");
+await client.taskGroups.s3Object.getS3ObjectMetadataV1("task_group_s3_object_metadata_id");
 ```
 
 </dd>
@@ -11744,7 +11742,7 @@ await client.taskGroups.s3ObjectMetadata.getV1("task_group_s3_object_metadata_id
 <dl>
 <dd>
 
-**requestOptions:** `S3ObjectMetadata.RequestOptions`
+**requestOptions:** `S3Object.RequestOptions`
 
 </dd>
 </dl>
@@ -11755,8 +11753,6 @@ await client.taskGroups.s3ObjectMetadata.getV1("task_group_s3_object_metadata_id
 </dl>
 </details>
 
-## TaskGroups S3Object
-
 <details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) -> unknown</code></summary>
 <dl>
 <dd>
@@ -11820,6 +11816,142 @@ await client.taskGroups.s3Object.getV1("task_group_s3_object_metadata_id");
 </dl>
 </details>
 
+<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">addV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uploads an image file to a task group with automatic blurhash generation. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.taskGroups.s3Object.addV1("task_group_id", {
+    image: fs.createReadStream("/path/to/your/file"),
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.taskGroups.BodyPostTaskGroupsS3ObjectAddV1OortTaskGroupsS3ObjectAddV1TaskGroupIdPost`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Object.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">deleteV1</a>(taskGroupS3ObjectMetadataId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes an S3 object metadata and the associated S3 object from a task group. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.taskGroups.s3Object.deleteV1("task_group_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Object.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## TaskGroups Expanded
 
 <details><summary><code>client.taskGroups.expanded.<a href="/src/api/resources/taskGroups/resources/expanded/client/Client.ts">forCourierOperatorsV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupExpanded</code></summary>

package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.d.ts

@@ -1,47 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../../../environments.js";
-import * as core from "../../../../../../core/index.js";
-import * as Chrt from "../../../../../index.js";
-export declare namespace S3ObjectMetadata {
-    interface Options {
-        environment?: core.Supplier<environments.ChrtEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional query string parameters to include in the request. */
-        queryParams?: Record<string, unknown>;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
-    }
-}
-export declare class S3ObjectMetadata {
-    protected readonly _options: S3ObjectMetadata.Options;
-    constructor(_options?: S3ObjectMetadata.Options);
-    /**
-     * Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (TaskArtifactS3ObjectMetadata1)
-     *
-     * @param {string} taskArtifactS3ObjectMetadataId
-     * @param {S3ObjectMetadata.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.taskArtifacts.s3ObjectMetadata.getV1("task_artifact_s3_object_metadata_id")
-     */
-    getV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: S3ObjectMetadata.RequestOptions): core.HttpResponsePromise<Chrt.TaskArtifactS3ObjectMetadata1>;
-    private __getV1;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
-}

package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.js

@@ -1,127 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.S3ObjectMetadata = void 0;
-const environments = __importStar(require("../../../../../../environments.js"));
-const core = __importStar(require("../../../../../../core/index.js"));
-const Chrt = __importStar(require("../../../../../index.js"));
-const headers_js_1 = require("../../../../../../core/headers.js");
-const errors = __importStar(require("../../../../../../errors/index.js"));
-class S3ObjectMetadata {
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    /**
-     * Retrieves the metadata for a task artifact S3 object, including blurhash for placeholder loading. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (TaskArtifactS3ObjectMetadata1)
-     *
-     * @param {string} taskArtifactS3ObjectMetadataId
-     * @param {S3ObjectMetadata.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.taskArtifacts.s3ObjectMetadata.getV1("task_artifact_s3_object_metadata_id")
-     */
-    getV1(taskArtifactS3ObjectMetadataId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getV1(taskArtifactS3ObjectMetadataId, requestOptions));
-    }
-    __getV1(taskArtifactS3ObjectMetadataId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
-            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);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                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/task_artifacts/s3_object_metadata/v1/${encodeURIComponent(taskArtifactS3ObjectMetadataId)}`),
-                method: "GET",
-                headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return { data: _response.body, rawResponse: _response.rawResponse };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 422:
-                        throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.ChrtError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.ChrtError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/task_artifacts/s3_object_metadata/v1/{task_artifact_s3_object_metadata_id}.");
-                case "unknown":
-                    throw new errors.ChrtError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
-    _getAuthorizationHeader() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const bearer = yield core.Supplier.get(this._options.token);
-            if (bearer != null) {
-                return `Bearer ${bearer}`;
-            }
-            return undefined;
-        });
-    }
-}
-exports.S3ObjectMetadata = S3ObjectMetadata;

package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/index.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.d.ts

@@ -1 +0,0 @@
-export * from "./client/index.js";

package/dist/cjs/api/resources/taskArtifacts/resources/s3ObjectMetadata/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./client/index.js"), exports);