@chrt-inc/typescript-sdk 1.641.0 → 1.651.0

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

@@ -4,6 +4,7 @@
 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>;
@@ -29,9 +30,34 @@ export declare namespace OrderSchedules {
 }
 export declare class OrderSchedules {
     protected readonly _options: OrderSchedules.Options;
+    protected _orderManifest: OrderManifest | undefined;
     constructor(_options?: OrderSchedules.Options);
+    get orderManifest(): OrderManifest;
     /**
-     * Retrieves an order schedule by ID. | () -> (OrderScheduleStub)
+     * 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.
@@ -41,62 +67,120 @@ export declare class OrderSchedules {
      * @example
      *     await client.shipping.orderSchedules.getByIdV1("order_schedule_id")
      */
-    getByIdV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderScheduleStub>;
+    getByIdV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderSchedule1>;
     private __getByIdV1;
     /**
-     * Lists order schedules for the caller's organization. | () -> (list[OrderScheduleStub])
+     * 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.listV1()
+     *     await client.shipping.orderSchedules.aboutV1("order_schedule_id")
      */
-    listV1(requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderScheduleStub[]>;
-    private __listV1;
+    aboutV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderScheduleAboutRes>;
+    private __aboutV1;
     /**
-     * Creates an order schedule. | (OrderScheduleCreateReq) -> (PydanticObjectId)
+     * Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
      *
-     * @param {Chrt.shipping.OrderScheduleCreateReq} request
+     * @param {Chrt.shipping.OrderScheduleClientCreate1} request
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.createV1({
-     *         name: "name"
+     *     await client.shipping.orderSchedules.newV1({
+     *         schema_version: 1,
+     *         name: "name",
+     *         order_manifest: {},
+     *         schedule_spec: {}
      *     })
      */
-    createV1(request: Chrt.shipping.OrderScheduleCreateReq, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<string>;
-    private __createV1;
+    newV1(request: Chrt.shipping.OrderScheduleClientCreate1, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<string>;
+    private __newV1;
     /**
-     * Echoes Temporal schedule specs to test SDK round trips. | (OrderScheduleRoundTripModelTestReq) -> (OrderScheduleRoundTripModelTestRes)
+     * Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
      *
-     * @param {Chrt.shipping.OrderScheduleRoundTripModelTestReq} request
+     * @param {string} orderScheduleId
+     * @param {Chrt.shipping.OrderScheduleClientUpdate1} request
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.roundTripModelTestV1()
+     *     await client.shipping.orderSchedules.updateV1("order_schedule_id")
      */
-    roundTripModelTestV1(request?: Chrt.shipping.OrderScheduleRoundTripModelTestReq, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderScheduleRoundTripModelTestRes>;
-    private __roundTripModelTestV1;
+    updateV1(orderScheduleId: string, request?: Chrt.shipping.OrderScheduleClientUpdate1, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
     /**
-     * Updates an order schedule. | (OrderScheduleUpdateReq) -> (bool)
+     * Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
      *
      * @param {string} orderScheduleId
-     * @param {Chrt.shipping.OrderScheduleUpdateReq} request
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.updateV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id")
      */
-    updateV1(orderScheduleId: string, request?: Chrt.shipping.OrderScheduleUpdateReq, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateV1;
+    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;
     /**
-     * Deletes an order schedule. | () -> (bool)
+     * Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
      *
      * @param {string} orderScheduleId
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
@@ -104,9 +188,9 @@ export declare class OrderSchedules {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.deleteV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.triggerV1("order_schedule_id")
      */
-    deleteV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __deleteV1;
+    triggerV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __triggerV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }