@chrt-inc/typescript-sdk 1.320.0 → 1.321.0

package/dist/esm/api/resources/taskArtifacts/resources/{blurhash → s3Object}/client/Client.mjs

@@ -15,30 +15,30 @@ import * as core from "../../../../../../core/index.mjs";
 import * as Chrt from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
-export class Blurhash {
+export class S3Object {
     constructor(_options = {}) {
         this._options = _options;
     }
     /**
-     * Retrieves the blurhash string for a task_artifact image for fast placeholder loading. | () -> (BlurHash)
+     * Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (StreamingResponse)
      *
      * @param {string} taskArtifactS3ObjectMetadataId
-     * @param {Blurhash.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskArtifacts.blurhash.getByMetadataIdV1("task_artifact_s3_object_metadata_id")
+     *     await client.taskArtifacts.s3Object.getV1("task_artifact_s3_object_metadata_id")
      */
-    getByMetadataIdV1(taskArtifactS3ObjectMetadataId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getByMetadataIdV1(taskArtifactS3ObjectMetadataId, requestOptions));
+    getV1(taskArtifactS3ObjectMetadataId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getV1(taskArtifactS3ObjectMetadataId, requestOptions));
     }
-    __getByMetadataIdV1(taskArtifactS3ObjectMetadataId, requestOptions) {
+    __getV1(taskArtifactS3ObjectMetadataId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             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/blurhash/v1/${encodeURIComponent(taskArtifactS3ObjectMetadataId)}`),
+                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/v1/${encodeURIComponent(taskArtifactS3ObjectMetadataId)}`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -69,7 +69,7 @@ export class Blurhash {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/task_artifacts/blurhash/v1/{task_artifact_s3_object_metadata_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/task_artifacts/s3_object/v1/{task_artifact_s3_object_metadata_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,

package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/index.d.mts

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

package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/index.mjs

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

package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.d.mts

@@ -0,0 +1,47 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Chrt from "../../../../../index.mjs";
+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/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/Client.mjs

@@ -0,0 +1,90 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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());
+    });
+};
+import * as environments from "../../../../../../environments.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Chrt from "../../../../../index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
+import * as errors from "../../../../../../errors/index.mjs";
+export 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 = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            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;
+        });
+    }
+}

package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/index.d.mts

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

package/dist/esm/api/resources/taskArtifacts/resources/s3ObjectMetadata/client/index.mjs

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

package/dist/esm/api/resources/taskGroups/client/Client.d.mts

@@ -4,6 +4,9 @@
 import * as environments from "../../../../environments.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as Chrt from "../../../index.mjs";
+import { TaskGroupId } from "../resources/taskGroupId/client/Client.mjs";
+import { S3ObjectMetadata } from "../resources/s3ObjectMetadata/client/Client.mjs";
+import { S3Object } from "../resources/s3Object/client/Client.mjs";
 import { Expanded } from "../resources/expanded/client/Client.mjs";
 export declare namespace TaskGroups {
     interface Options {
@@ -30,37 +33,30 @@ export declare namespace TaskGroups {
 }
 export declare class TaskGroups {
     protected readonly _options: TaskGroups.Options;
+    protected _taskGroupId: TaskGroupId | undefined;
+    protected _s3ObjectMetadata: S3ObjectMetadata | undefined;
+    protected _s3Object: S3Object | undefined;
     protected _expanded: Expanded | undefined;
     constructor(_options?: TaskGroups.Options);
+    get taskGroupId(): TaskGroupId;
+    get s3ObjectMetadata(): S3ObjectMetadata;
+    get s3Object(): S3Object;
     get expanded(): Expanded;
     /**
-     * Retrieves the task group ID for the courier organization assigned to an order. | authz_personas=[courier_org_operators] | () -> (PydanticObjectId)
+     * Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state. | authz_personas=[courier_driver, lig_org_operators] | () -> (bool)
      *
-     * @param {string} byOrderIdOrShortId
-     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.taskGroups.getTaskGroupIdForCourierOperatorsV1("by_order_id_or_short_id")
-     */
-    getTaskGroupIdForCourierOperatorsV1(byOrderIdOrShortId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<string>;
-    private __getTaskGroupIdForCourierOperatorsV1;
-    /**
-     * Retrieves the task group ID for the courier driver assigned to an order. | authz_personas=[courier_driver] | () -> (PydanticObjectId)
-     *
-     * @param {string} byOrderIdOrShortId
+     * @param {string} taskGroupId
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.getTaskGroupIdForCourierDriverV1("by_order_id_or_short_id")
+     *     await client.taskGroups.startV1("task_group_id")
      */
-    getTaskGroupIdForCourierDriverV1(byOrderIdOrShortId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<string>;
-    private __getTaskGroupIdForCourierDriverV1;
+    startV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __startV1;
     /**
-     * Updates the ordering of tasks in a task group. Task group must be in STAGED or IN_PROGRESS status. | authz_personas=[lig_org_operators] | (SetTaskOrderingReq) -> (bool)
+     * Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_org_operators] | (SetTaskOrderingReq) -> (bool)
      *
      * @param {string} taskGroupId
      * @param {Chrt.SetTaskOrderingReq} request
@@ -70,13 +66,13 @@ export declare class TaskGroups {
      *
      * @example
      *     await client.taskGroups.setTaskOrderingV1("task_group_id", {
-     *         task_ordering: ["task_ordering"]
+     *         task_ids: ["task_ids"]
      *     })
      */
     setTaskOrderingV1(taskGroupId: string, request: Chrt.SetTaskOrderingReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __setTaskOrderingV1;
     /**
-     * Updates the flight number on both task group and all its tasks. Task group must be in STAGED or IN_PROGRESS status. | authz_personas=[lig_org_operators] | (SetFlightNumberReq) -> (bool)
+     * Sets the flight number on a task group, plus any TENDER_TO_AIRLINE tasks in the immediately preceding task group and RECOVER_FROM_AIRLINE tasks in the immediately following task group. | authz_personas=[lig_org_operators] | (SetFlightNumberReq) -> (bool)
      *
      * @param {string} taskGroupId
      * @param {Chrt.SetFlightNumberReq} request
@@ -92,45 +88,95 @@ export declare class TaskGroups {
     setFlightNumberV1(taskGroupId: string, request: Chrt.SetFlightNumberReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __setFlightNumberV1;
     /**
-     * Sets or removes the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateTaskGroupDriverReq) -> (bool)
+     * Updates the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateDriverReq) -> (bool)
      *
      * @param {string} taskGroupId
-     * @param {Chrt.UpdateTaskGroupDriverReq} request
+     * @param {Chrt.UpdateDriverReq} request
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.updateDriverV1("task_group_id")
+     *     await client.taskGroups.updateDriverV1("task_group_id", {
+     *         driver_id: "driver_id"
+     *     })
      */
-    updateDriverV1(taskGroupId: string, request?: Chrt.UpdateTaskGroupDriverReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    updateDriverV1(taskGroupId: string, request: Chrt.UpdateDriverReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateDriverV1;
     /**
-     * Sets or removes the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateTaskGroupCourierOrgReq) -> (bool)
+     * Removes the driver from a task group (sets driver_id to null). | authz_personas=[courier_org_operators, courier_driver] | () -> (bool)
      *
      * @param {string} taskGroupId
-     * @param {Chrt.UpdateTaskGroupCourierOrgReq} request
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.updateCourierOrgV1("task_group_id")
+     *     await client.taskGroups.removeDriverV1("task_group_id")
+     */
+    removeDriverV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeDriverV1;
+    /**
+     * Updates the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateCourierOrgReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.UpdateCourierOrgReq} request
+     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.taskGroups.updateCourierOrgV1("task_group_id", {
+     *         courier_org_id: "courier_org_id"
+     *     })
      */
-    updateCourierOrgV1(taskGroupId: string, request?: Chrt.UpdateTaskGroupCourierOrgReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    updateCourierOrgV1(taskGroupId: string, request: Chrt.UpdateCourierOrgReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updateCourierOrgV1;
     /**
-     * Starts a task group by changing its status to in-progress and updating the order status. | authz_personas=[courier_driver, lig_org_operators] | () -> (bool)
+     * Adds a message to a task group's message log. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
      *
      * @param {string} taskGroupId
+     * @param {Chrt.AddMessageReq} request
      * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.taskGroups.startV1("task_group_id")
+     *     await client.taskGroups.addMessageV1("task_group_id", {
+     *         message: "message"
+     *     })
      */
-    startV1(taskGroupId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __startV1;
+    addMessageV1(taskGroupId: string, request: Chrt.AddMessageReq, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addMessageV1;
+    /**
+     * 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)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost} request
+     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.taskGroups.addS3ObjectV1("task_group_id", {
+     *         image: fs.createReadStream("/path/to/your/file")
+     *     })
+     */
+    addS3ObjectV1(taskGroupId: string, request: Chrt.BodyPostAddS3ObjectV1OortTaskGroupsAddS3ObjectV1TaskGroupIdPost, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addS3ObjectV1;
+    /**
+     * 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)
+     *
+     * @param {string} taskGroupS3ObjectMetadataId
+     * @param {TaskGroups.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.taskGroups.deleteS3ObjectV1("task_group_s3_object_metadata_id")
+     */
+    deleteS3ObjectV1(taskGroupS3ObjectMetadataId: string, requestOptions?: TaskGroups.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteS3ObjectV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }