@chrt-inc/typescript-sdk 1.734.0 → 1.749.0

package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.js

@@ -0,0 +1,196 @@
+"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.Draft = 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 Draft {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
+     *
+     * @param {Chrt.shipping.orderSchedules.OrderScheduleClientCreate1} request
+     * @param {Draft.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.draft.newV1({
+     *         schema_version: 1,
+     *         name: "name"
+     *     })
+     */
+    newV1(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__newV1(request, requestOptions));
+    }
+    __newV1(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/order_schedules/draft/new/v1"),
+                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/order_schedules/draft/new/v1.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Updates a draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
+     *
+     * @param {string} orderScheduleId
+     * @param {Chrt.shipping.orderSchedules.OrderScheduleClientUpdate1} request
+     * @param {Draft.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.draft.updateV1("order_schedule_id")
+     */
+    updateV1(orderScheduleId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__updateV1(orderScheduleId, request, requestOptions));
+    }
+    __updateV1(orderScheduleId_1) {
+        return __awaiter(this, arguments, void 0, function* (orderScheduleId, request = {}, requestOptions) {
+            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/order_schedules/draft/update/v1/${encodeURIComponent(orderScheduleId)}`),
+                method: "PATCH",
+                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 PATCH /shipping/order_schedules/draft/update/v1/{order_schedule_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.Draft = Draft;

package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.js";

package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.js

@@ -0,0 +1,17 @@
+"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("./requests/index.js"), exports);

package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientCreate1.d.ts

@@ -1,20 +1,18 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Chrt from "../../../../../../index.js";
+import * as Chrt from "../../../../../../../../index.js";
 /**
  * @example
  *     {
  *         schema_version: 1,
- *         name: "name",
- *         order_manifest: {},
- *         schedule_spec: {}
+ *         name: "name"
  *     }
  */
 export interface OrderScheduleClientCreate1 {
     schema_version: number;
     name: string;
     description?: string | null;
-    order_manifest: Chrt.OrderManifest1;
-    schedule_spec: Chrt.ScheduleSpec;
+    order_manifest?: Chrt.OrderManifest1 | null;
+    schedule_spec?: Chrt.OrderScheduleSpec1 | null;
 }

package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientUpdate1.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Chrt from "../../../../../../index.js";
+import * as Chrt from "../../../../../../../../index.js";
 /**
  * @example
  *     {}
@@ -10,6 +10,6 @@ export interface OrderScheduleClientUpdate1 {
     name?: string | null;
     description?: string | null;
     order_manifest?: Chrt.OrderManifest1 | null;
-    schedule_spec?: Chrt.ScheduleSpec | null;
+    schedule_spec?: Chrt.OrderScheduleSpec1 | null;
     description__set_to_None?: boolean;
 }

package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.d.ts

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

package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/index.d.ts

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

package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/index.js

@@ -0,0 +1,17 @@
+"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);

package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/index.d.ts

@@ -1 +1,3 @@
+export * as draft from "./draft/index.js";
 export * as orderManifest from "./orderManifest/index.js";
+export * from "./draft/client/requests/index.js";

package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/index.js

@@ -32,6 +32,11 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+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 });
-exports.orderManifest = void 0;
+exports.orderManifest = exports.draft = void 0;
+exports.draft = __importStar(require("./draft/index.js"));
 exports.orderManifest = __importStar(require("./orderManifest/index.js"));
+__exportStar(require("./draft/client/requests/index.js"), exports);

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

@@ -0,0 +1,170 @@
+/**
+ * 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 OrderTemplates {
+    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 OrderTemplates {
+    protected readonly _options: OrderTemplates.Options;
+    constructor(_options?: OrderTemplates.Options);
+    /**
+     * Retrieves an order template with its reference columns resolved (shipper, executor orgs, drivers, directory entries). Unresolvable list references are omitted so the caller can detect dangling ids. | authz: min_org_role=operator | () -> (OrderTemplateExpanded)
+     *
+     * @param {string} orderTemplateId
+     * @param {OrderTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderTemplates.getExpandedByIdV1("order_template_id")
+     */
+    getExpandedByIdV1(orderTemplateId: string, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<Chrt.OrderTemplateExpanded>;
+    private __getExpandedByIdV1;
+    /**
+     * Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description, order_input, off_chrt_reference_id_str). | authz: min_org_role=operator | () -> (OrderTemplateListRes)
+     *
+     * @param {Chrt.shipping.OrderTemplatesListV1Request} request
+     * @param {OrderTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderTemplates.listV1({
+     *         sort_by: "created_at_timestamp",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         search: "search",
+     *         filter_archived: true,
+     *         filter_owned_by_user_id: "filter_owned_by_user_id",
+     *         filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
+     *         filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
+     *         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z"
+     *     })
+     */
+    listV1(request?: Chrt.shipping.OrderTemplatesListV1Request, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<Chrt.OrderTemplateListRes>;
+    private __listV1;
+    /**
+     * Retrieves an order template by ID. | authz: min_org_role=operator | () -> (OrderTemplate1)
+     *
+     * @param {string} orderTemplateId
+     * @param {OrderTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderTemplates.getByIdV1("order_template_id")
+     */
+    getByIdV1(orderTemplateId: string, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<Chrt.OrderTemplate1>;
+    private __getByIdV1;
+    /**
+     * Deletes an order template, but only when no orders were built from it (otherwise archive instead). | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orderTemplateId
+     * @param {OrderTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderTemplates.deleteV1("order_template_id")
+     */
+    deleteV1(orderTemplateId: string, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteV1;
+    /**
+     * Creates a new order template. | authz: min_org_role=operator | (OrderTemplateClientCreate1) -> (PydanticObjectId)
+     *
+     * @param {Chrt.shipping.OrderTemplateClientCreate1} request
+     * @param {OrderTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderTemplates.createV1({
+     *         schema_version: 1,
+     *         name: "name"
+     *     })
+     */
+    createV1(request: Chrt.shipping.OrderTemplateClientCreate1, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<string>;
+    private __createV1;
+    /**
+     * Updates an order template. | authz: min_org_role=operator | (OrderTemplateClientUpdate1) -> (bool)
+     *
+     * @param {string} orderTemplateId
+     * @param {Chrt.shipping.OrderTemplateClientUpdate1} request
+     * @param {OrderTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderTemplates.updateV1("order_template_id")
+     */
+    updateV1(orderTemplateId: string, request?: Chrt.shipping.OrderTemplateClientUpdate1, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
+    /**
+     * Archives an order template by setting archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orderTemplateId
+     * @param {OrderTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderTemplates.archiveV1("order_template_id")
+     */
+    archiveV1(orderTemplateId: string, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __archiveV1;
+    /**
+     * Restores an archived order template by clearing archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orderTemplateId
+     * @param {OrderTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderTemplates.unarchiveV1("order_template_id")
+     */
+    unarchiveV1(orderTemplateId: string, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __unarchiveV1;
+    /**
+     * Removes a (possibly dangling) reference id from a template column. | authz: min_org_role=operator | (OrderTemplateRemoveReferenceReq) -> (bool)
+     *
+     * @param {string} orderTemplateId
+     * @param {Chrt.shipping.OrderTemplateRemoveReferenceReq} request
+     * @param {OrderTemplates.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderTemplates.referencesRemoveV1("order_template_id", {
+     *         column: "shipper_org_id"
+     *     })
+     */
+    referencesRemoveV1(orderTemplateId: string, request: Chrt.shipping.OrderTemplateRemoveReferenceReq, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __referencesRemoveV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}