@chrt-inc/typescript-sdk 1.441.0 → 1.441.2

package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs

@@ -0,0 +1,154 @@
+/**
+ * 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";
+import { Expanded } from "../resources/expanded/client/Client.mjs";
+export class Orders {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    get expanded() {
+        var _a;
+        return ((_a = this._expanded) !== null && _a !== void 0 ? _a : (this._expanded = new Expanded(this._options)));
+    }
+    /**
+     * Validates a draft order and stages all related entities in a transaction. | () -> (bool)
+     *
+     * @param {string} orderId
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.stageV1("order_id")
+     */
+    stageV1(orderId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__stageV1(orderId, requestOptions));
+    }
+    __stageV1(orderId, 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, `shipping/orders/stage/v1/${encodeURIComponent(orderId)}`),
+                method: "PATCH",
+                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 PATCH /shipping/orders/stage/v1/{order_id}.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
+     *
+     * @param {string} orderId
+     * @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.cancelV1("order_id")
+     */
+    cancelV1(orderId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__cancelV1(orderId, requestOptions));
+    }
+    __cancelV1(orderId, 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, `shipping/orders/cancel/v1/${encodeURIComponent(orderId)}`),
+                method: "PUT",
+                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 PUT /shipping/orders/cancel/v1/{order_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/shipping/resources/orders/resources/expanded/client/Client.d.mts

@@ -0,0 +1,124 @@
+/**
+ * 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 Expanded {
+    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 Expanded {
+    protected readonly _options: Expanded.Options;
+    constructor(_options?: Expanded.Options);
+    /**
+     * Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
+     *
+     * @param {string} orderIdOrShortId
+     * @param {Chrt.OrderAndTaskGroupExpandedReq} request
+     * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {})
+     */
+    forShipperOperatorsV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
+    private __forShipperOperatorsV1;
+    /**
+     * Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
+     *
+     * @param {string} orderIdOrShortId
+     * @param {Chrt.OrderAndTaskGroupExpandedReq} request
+     * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {})
+     */
+    forForwarderOperatorsV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
+    private __forForwarderOperatorsV1;
+    /**
+     * Lists expanded orders for forwarder operators with filtering, sorting, and pagination. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
+     *
+     * @param {Chrt.shipping.orders.ExpandedListForForwarderOperatorsV1Request} request
+     * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.expanded.listForForwarderOperatorsV1({
+     *         sort_by: "draft_started_at_timestamp",
+     *         sort_order: "ascending",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         body: {}
+     *     })
+     */
+    listForForwarderOperatorsV1(request: Chrt.shipping.orders.ExpandedListForForwarderOperatorsV1Request, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrdersExpandedListRes>;
+    private __listForForwarderOperatorsV1;
+    /**
+     * Lists expanded orders for shipper operators with filtering, sorting, and pagination. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
+     *
+     * @param {Chrt.shipping.orders.ExpandedListForShipperOperatorsV1Request} request
+     * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orders.expanded.listForShipperOperatorsV1({
+     *         sort_by: "draft_started_at_timestamp",
+     *         sort_order: "ascending",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         body: {}
+     *     })
+     */
+    listForShipperOperatorsV1(request: Chrt.shipping.orders.ExpandedListForShipperOperatorsV1Request, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrdersExpandedListRes>;
+    private __listForShipperOperatorsV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}