@chrt-inc/typescript-sdk 1.640.0 → 1.647.0

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

@@ -0,0 +1,196 @@
+/**
+ * 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";
+import { OrderManifest } from "../resources/orderManifest/client/Client.js";
+export declare namespace OrderSchedules {
+    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 OrderSchedules {
+    protected readonly _options: OrderSchedules.Options;
+    protected _orderManifest: OrderManifest | undefined;
+    constructor(_options?: OrderSchedules.Options);
+    get orderManifest(): OrderManifest;
+    /**
+     * Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
+     *
+     * @param {Chrt.shipping.OrderSchedulesListV1Request} request
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.listV1({
+     *         sort_by: "created_at_timestamp",
+     *         sort_order: "asc",
+     *         page: 1,
+     *         page_size: 1,
+     *         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.OrderSchedulesListV1Request, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderScheduleListRes>;
+    private __listV1;
+    /**
+     * Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)
+     *
+     * @param {string} orderScheduleId
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.getByIdV1("order_schedule_id")
+     */
+    getByIdV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderSchedule1>;
+    private __getByIdV1;
+    /**
+     * Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
+     *
+     * @param {string} orderScheduleId
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.aboutV1("order_schedule_id")
+     */
+    aboutV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderScheduleAboutRes>;
+    private __aboutV1;
+    /**
+     * Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
+     *
+     * @param {Chrt.shipping.OrderScheduleClientCreate1} request
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.newV1({
+     *         schema_version: 1,
+     *         name: "name",
+     *         order_manifest: {},
+     *         schedule_spec: {}
+     *     })
+     */
+    newV1(request: Chrt.shipping.OrderScheduleClientCreate1, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<string>;
+    private __newV1;
+    /**
+     * Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
+     *
+     * @param {string} orderScheduleId
+     * @param {Chrt.shipping.OrderScheduleClientUpdate1} request
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.updateV1("order_schedule_id")
+     */
+    updateV1(orderScheduleId: string, request?: Chrt.shipping.OrderScheduleClientUpdate1, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
+    /**
+     * Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orderScheduleId
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id")
+     */
+    takeOwnershipV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __takeOwnershipV1;
+    /**
+     * Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orderScheduleId
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.activateV1("order_schedule_id")
+     */
+    activateV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __activateV1;
+    /**
+     * Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orderScheduleId
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.unpauseV1("order_schedule_id")
+     */
+    unpauseV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __unpauseV1;
+    /**
+     * Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orderScheduleId
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.pauseV1("order_schedule_id")
+     */
+    pauseV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __pauseV1;
+    /**
+     * Archives an order schedule and prevents future runs. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orderScheduleId
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.archiveV1("order_schedule_id")
+     */
+    archiveV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __archiveV1;
+    /**
+     * Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
+     *
+     * @param {string} orderScheduleId
+     * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.shipping.orderSchedules.triggerV1("order_schedule_id")
+     */
+    triggerV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __triggerV1;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}