@chrt-inc/typescript-sdk 1.906.0 → 1.914.0

package/dist/cjs/api/resources/shipping/resources/orders/resources/taskArtifact/client/Client.js

@@ -0,0 +1,195 @@
+"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.TaskArtifact = 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 TaskArtifact {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Adds a task artifact to an order task. Draft orders require draft_creator_org_operator and create DRAFT artifacts; operational orders require driver_for_executor, executor_org_operators, or coordinator_org_operators and create STAGED or COMPLETED artifacts. | authz_personas=[draft_creator_org_operator, driver_for_executor, executor_org_operators, coordinator_org_operators] | (OrdersAddTaskArtifactReq) -> (PydanticObjectId)
+     *
+     * @param {string} taskId
+     * @param {Chrt.shipping.orders.OrdersAddTaskArtifactReq} request
+     * @param {TaskArtifact.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskArtifact.addV1("task_id", {
+     *         task_artifact: {
+     *             schema_version: 1,
+     *             type: "image"
+     *         }
+     *     })
+     */
+    addV1(taskId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__addV1(taskId, request, requestOptions));
+    }
+    __addV1(taskId, request, 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, `shipping/orders/task_artifact/add/v1/${encodeURIComponent(taskId)}`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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 POST /shipping/orders/task_artifact/add/v1/{task_id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Deletes a task artifact and removes it from its task. Artifacts with S3 objects must have those objects deleted first. Draft orders require draft_creator_org_operator; operational orders require task_group_operating_org_operators. | authz_personas=[draft_creator_org_operator, task_group_operating_org_operators] | () -> (bool)
+     *
+     * @param {string} taskArtifactId
+     * @param {TaskArtifact.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskArtifact.deleteV1("task_artifact_id")
+     */
+    deleteV1(taskArtifactId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteV1(taskArtifactId, requestOptions));
+    }
+    __deleteV1(taskArtifactId, 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, `shipping/orders/task_artifact/delete/v1/${encodeURIComponent(taskArtifactId)}`),
+                method: "DELETE",
+                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 DELETE /shipping/orders/task_artifact/delete/v1/{task_artifact_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.TaskArtifact = TaskArtifact;

package/dist/cjs/api/resources/shipping/resources/orders/resources/taskArtifact/client/requests/OrdersAddTaskArtifactReq.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Chrt from "../../../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         task_artifact: {
+ *             schema_version: 1,
+ *             type: "image"
+ *         }
+ *     }
+ */
+export interface OrdersAddTaskArtifactReq {
+    /** Initial status for a non-draft task artifact. Defaults to STAGED. Omit for draft orders. */
+    status?: OrdersAddTaskArtifactReq.Status | null;
+    task_artifact: Chrt.TaskArtifactClientCreate1;
+}
+export declare namespace OrdersAddTaskArtifactReq {
+    type Status = "staged" | "completed";
+    const Status: {
+        readonly Staged: "staged";
+        readonly Completed: "completed";
+    };
+}

package/dist/cjs/api/resources/shipping/resources/orders/resources/taskArtifact/client/requests/OrdersAddTaskArtifactReq.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrdersAddTaskArtifactReq = void 0;
+var OrdersAddTaskArtifactReq;
+(function (OrdersAddTaskArtifactReq) {
+    OrdersAddTaskArtifactReq.Status = {
+        Staged: "staged",
+        Completed: "completed",
+    };
+})(OrdersAddTaskArtifactReq || (exports.OrdersAddTaskArtifactReq = OrdersAddTaskArtifactReq = {}));

package/dist/cjs/api/resources/shipping/resources/orders/resources/taskArtifact/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { type OrdersAddTaskArtifactReq } from "./OrdersAddTaskArtifactReq.js";

package/dist/cjs/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.d.ts

@@ -0,0 +1,175 @@
+/**
+ * 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 TaskGroup {
+    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 TaskGroup {
+    protected readonly _options: TaskGroup.Options;
+    constructor(_options?: TaskGroup.Options);
+    /**
+     * Adds a task group to a non-terminal order. Groups added to DRAFT orders are DRAFT; groups added to STAGED or IN_PROGRESS orders are STAGED. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | (OrdersAddTaskGroupReq) -> (PydanticObjectId)
+     *
+     * @param {Chrt.shipping.orders.OrdersAddTaskGroupReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.addV1({
+     *         order_id: "order_id",
+     *         task_group_type: "chrt_ground_provider"
+     *     })
+     */
+    addV1(request: Chrt.shipping.orders.OrdersAddTaskGroupReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<string>;
+    private __addV1;
+    /**
+     * Assigns an on-platform or off-platform executor organization to an order task group. DRAFT task groups require task_group_coordinator_operators; operational task groups require coordinator_org_operators and STAGED or IN_PROGRESS status. | authz_personas=[task_group_coordinator_operators, coordinator_org_operators] | (OrdersAddTaskGroupExecutorReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.shipping.orders.OrdersAddTaskGroupExecutorReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.addExecutorV1("task_group_id")
+     */
+    addExecutorV1(taskGroupId: string, request?: Chrt.shipping.orders.OrdersAddTaskGroupExecutorReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addExecutorV1;
+    /**
+     * Deletes a task group from an active order and synchronizes affected order, driver, cargo, and account state. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.deleteV1("task_group_id")
+     */
+    deleteV1(taskGroupId: string, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Clears the driver from an order task group. DRAFT task groups require executor_org_operators; operational task groups require executor_org_operators or driver_for_executor and STAGED or IN_PROGRESS status. | authz_personas=[executor_org_operators, driver_for_executor] | () -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.removeDriverV1("task_group_id")
+     */
+    removeDriverV1(taskGroupId: string, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeDriverV1;
+    /**
+     * Clears the executor and assigned driver from an order task group. DRAFT task groups require task_group_coordinator_operators; operational task groups require coordinator_org_operators and STAGED or IN_PROGRESS status. | authz_personas=[task_group_coordinator_operators, coordinator_org_operators] | () -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.removeExecutorV1("task_group_id")
+     */
+    removeExecutorV1(taskGroupId: string, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeExecutorV1;
+    /**
+     * Replaces the ordered flight legs on an order task group. | (OrdersSetTaskGroupFlightInfoReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.shipping.orders.OrdersSetTaskGroupFlightInfoReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.setFlightInfoV1("task_group_id", {
+     *         flight_legs: [{
+     *                 carrier_iata: "carrier_iata",
+     *                 destination_iata: "destination_iata",
+     *                 flight_number: "flight_number",
+     *                 origin_iata: "origin_iata",
+     *                 provenance: "manual",
+     *                 scheduled_departure_utc: "2024-01-15T09:30:00Z",
+     *                 schema_version: 1
+     *             }]
+     *     })
+     */
+    setFlightInfoV1(taskGroupId: string, request: Chrt.shipping.orders.OrdersSetTaskGroupFlightInfoReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setFlightInfoV1;
+    /**
+     * Sets the ordering of tasks within an order task group and recalculates estimated mileage. DRAFT orders require draft_creator_org_operator; operational orders require task_group_operating_org_operators and a STAGED or IN_PROGRESS task group. | authz_personas=[draft_creator_org_operator, task_group_operating_org_operators] | (OrdersSetTaskGroupTaskOrderingReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.shipping.orders.OrdersSetTaskGroupTaskOrderingReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.setTaskOrderingV1("task_group_id", {
+     *         task_ids: ["task_ids"]
+     *     })
+     */
+    setTaskOrderingV1(taskGroupId: string, request: Chrt.shipping.orders.OrdersSetTaskGroupTaskOrderingReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setTaskOrderingV1;
+    /**
+     * Sets the vehicle type until the task group reaches a terminal status. | authz_personas=[draft_creator_org_operator, task_group_coordinator_operators] | (OrdersSetTaskGroupVehicleTypeReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.shipping.orders.OrdersSetTaskGroupVehicleTypeReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.setVehicleTypeV1("task_group_id", {
+     *         vehicle_type: "sedan"
+     *     })
+     */
+    setVehicleTypeV1(taskGroupId: string, request: Chrt.shipping.orders.OrdersSetTaskGroupVehicleTypeReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setVehicleTypeV1;
+    /**
+     * Assigns or swaps the driver on an order task group. The driver must belong to the task group's executor organization and permit direct assignment. | authz_personas=[executor_org_operators] | (OrdersUpdateTaskGroupDriverReq) -> (bool)
+     *
+     * @param {string} taskGroupId
+     * @param {Chrt.shipping.orders.OrdersUpdateTaskGroupDriverReq} request
+     * @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.taskGroup.updateDriverV1("task_group_id", {
+     *         driver_id: "driver_id"
+     *     })
+     */
+    updateDriverV1(taskGroupId: string, request: Chrt.shipping.orders.OrdersUpdateTaskGroupDriverReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateDriverV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}