@chrt-inc/typescript-sdk 1.929.0 → 1.930.0

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

@@ -1,182 +0,0 @@
-/**
- * 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);
-    /**
-     * 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;
-    /**
-     * Retrieves an order template with resolved references, recent orders, and total order count. Unresolvable list references are omitted so the caller can detect dangling ids. | authz: min_org_role=operator | () -> (OrderTemplateExpanded1)
-     *
-     * @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.OrderTemplateExpanded1>;
-    private __getExpandedByIdV1;
-    /**
-     * Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description, text, 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_off_chrt_reference_id_str: "filter_off_chrt_reference_id_str",
-     *         filter_shipper_org_id: "filter_shipper_org_id",
-     *         filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
-     *         filter_coordinator_org_id: "filter_coordinator_org_id",
-     *         filter_department_id: "filter_department_id",
-     *         filter_coordinator_label: "filter_coordinator_label",
-     *         filter_driver_id: "filter_driver_id",
-     *         filter_contact_id: "filter_contact_id",
-     *         filter_task_lists_to_apply_at_order_creation_task_list_id: "filter_task_lists_to_apply_at_order_creation_task_list_id",
-     *         filter_task_lists_to_apply_at_order_staging_task_list_id: "filter_task_lists_to_apply_at_order_staging_task_list_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",
-     *         filter_last_used_at_timestamp_gte: "2024-01-15T09:30:00Z",
-     *         filter_last_used_at_timestamp_lte: "2024-01-15T09:30:00Z"
-     *     })
-     */
-    listV1(request?: Chrt.shipping.OrderTemplatesListV1Request, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<Chrt.OrderTemplateListRes>;
-    private __listV1;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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({
-     *         name: "name",
-     *         schema_version: 1
-     *     })
-     */
-    createV1(request: Chrt.shipping.OrderTemplateClientCreate1, requestOptions?: OrderTemplates.RequestOptions): core.HttpResponsePromise<string>;
-    private __createV1;
-    /**
-     * 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;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
-}