@chrt-inc/typescript-sdk 1.734.0 → 1.746.0

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

@@ -430,6 +430,74 @@ export class OrderDrafts {
             }
         });
     }
+    /**
+     * Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])
+     *
+     * @param {Chrt.shipping.OrderDraftsTypeaheadV1Request} request
+     * @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderDrafts.typeaheadV1({
+     *         query: "query",
+     *         limit: 1
+     *     })
+     */
+    typeaheadV1(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__typeaheadV1(request, requestOptions));
+    }
+    __typeaheadV1(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e;
+            const { query, limit } = request;
+            const _queryParams = {};
+            _queryParams["query"] = query;
+            if (limit !== undefined) {
+                _queryParams["limit"] = (_a = limit === null || limit === void 0 ? void 0 : limit.toString()) !== null && _a !== void 0 ? _a : null;
+            }
+            let _headers = mergeHeaders((_b = this._options) === null || _b === void 0 ? void 0 : _b.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ChrtEnvironment.Local, "shipping/order_drafts/typeahead/v1"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), 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 /shipping/order_drafts/typeahead/v1.");
+                case "unknown":
+                    throw new errors.ChrtError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
      *

package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrderDraftsTypeaheadV1Request.d.mts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         query: "query",
+ *         limit: 1
+ *     }
+ */
+export interface OrderDraftsTypeaheadV1Request {
+    /** Typeahead search query */
+    query: string;
+    /** Max results per field */
+    limit?: number | null;
+}

package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/index.d.mts

@@ -3,3 +3,4 @@ export { type OrdersDraftUpdateReq } from "./OrdersDraftUpdateReq.mjs";
 export { type SetTaskGroupOrderingDraftReq } from "./SetTaskGroupOrderingDraftReq.mjs";
 export { type OrdersDraftDeleteManyReq } from "./OrdersDraftDeleteManyReq.mjs";
 export { type BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post } from "./BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post.mjs";
+export { type OrderDraftsTypeaheadV1Request } from "./OrderDraftsTypeaheadV1Request.mjs";

package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.mts

@@ -70,21 +70,5 @@ export declare class Expanded {
      */
     listV1(request: Chrt.shipping.orderDrafts.ExpandedListV1Request, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpandedListRes>;
     private __listV1;
-    /**
-     * Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])
-     *
-     * @param {Chrt.shipping.orderDrafts.ExpandedTypeaheadV1Request} request
-     * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.orderDrafts.expanded.typeaheadV1({
-     *         query: "query",
-     *         limit: 1
-     *     })
-     */
-    typeaheadV1(request: Chrt.shipping.orderDrafts.ExpandedTypeaheadV1Request, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderTypeaheadResult[]>;
-    private __typeaheadV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.mjs

@@ -192,74 +192,6 @@ export class Expanded {
             }
         });
     }
-    /**
-     * Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])
-     *
-     * @param {Chrt.shipping.orderDrafts.ExpandedTypeaheadV1Request} request
-     * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.shipping.orderDrafts.expanded.typeaheadV1({
-     *         query: "query",
-     *         limit: 1
-     *     })
-     */
-    typeaheadV1(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__typeaheadV1(request, requestOptions));
-    }
-    __typeaheadV1(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e;
-            const { query, limit } = request;
-            const _queryParams = {};
-            _queryParams["query"] = query;
-            if (limit !== undefined) {
-                _queryParams["limit"] = (_a = limit === null || limit === void 0 ? void 0 : limit.toString()) !== null && _a !== void 0 ? _a : null;
-            }
-            let _headers = mergeHeaders((_b = this._options) === null || _b === void 0 ? void 0 : _b.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
-                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ChrtEnvironment.Local, "shipping/order_drafts/expanded/typeahead/v1"),
-                method: "GET",
-                headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), 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 /shipping/order_drafts/expanded/typeahead/v1.");
-                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);

package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/requests/index.d.mts

@@ -1,2 +1 @@
 export { type ExpandedListV1Request } from "./ExpandedListV1Request.mjs";
-export { type ExpandedTypeaheadV1Request } from "./ExpandedTypeaheadV1Request.mjs";

package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.d.mts

@@ -0,0 +1,170 @@
+/**
+ * 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 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>;
+}