@chrt-inc/typescript-sdk 1.810.0 → 1.841.0

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

@@ -66,75 +66,28 @@ class OrderSchedules {
         return ((_a = this._orderManifest) !== null && _a !== void 0 ? _a : (this._orderManifest = new Client_js_2.OrderManifest(this._options)));
     }
     /**
-     * Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
+     * Retrieves the generated order count and live orchestrator status from Temporal. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
      *
-     * @param {Chrt.shipping.OrderSchedulesListV1Request} request
+     * @param {string} orderScheduleId
      * @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"
-     *     })
+     *     await client.shipping.orderSchedules.aboutV1("order_schedule_id")
      */
-    listV1(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listV1(request, requestOptions));
+    aboutV1(orderScheduleId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__aboutV1(orderScheduleId, requestOptions));
     }
-    __listV1() {
-        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
-            var _a, _b, _c, _d, _e, _f;
-            const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_intended_status: filterIntendedStatus, filter_owned_by_user_id: filterOwnedByUserId, filter_created_at_timestamp_gte: filterCreatedAtTimestampGte, filter_created_at_timestamp_lte: filterCreatedAtTimestampLte, filter_last_edited_at_timestamp_gte: filterLastEditedAtTimestampGte, filter_last_edited_at_timestamp_lte: filterLastEditedAtTimestampLte, } = request;
-            const _queryParams = {};
-            if (sortBy !== undefined) {
-                _queryParams["sort_by"] = sortBy;
-            }
-            if (sortOrder !== undefined) {
-                _queryParams["sort_order"] = sortOrder;
-            }
-            if (page !== undefined) {
-                _queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
-            }
-            if (pageSize !== undefined) {
-                _queryParams["page_size"] = (_b = pageSize === null || pageSize === void 0 ? void 0 : pageSize.toString()) !== null && _b !== void 0 ? _b : null;
-            }
-            if (filterIntendedStatus !== undefined) {
-                if (Array.isArray(filterIntendedStatus)) {
-                    _queryParams["filter_intended_status"] = filterIntendedStatus.map((item) => item);
-                }
-                else {
-                    _queryParams["filter_intended_status"] = filterIntendedStatus;
-                }
-            }
-            if (filterOwnedByUserId !== undefined) {
-                _queryParams["filter_owned_by_user_id"] = filterOwnedByUserId;
-            }
-            if (filterCreatedAtTimestampGte !== undefined) {
-                _queryParams["filter_created_at_timestamp_gte"] = filterCreatedAtTimestampGte;
-            }
-            if (filterCreatedAtTimestampLte !== undefined) {
-                _queryParams["filter_created_at_timestamp_lte"] = filterCreatedAtTimestampLte;
-            }
-            if (filterLastEditedAtTimestampGte !== undefined) {
-                _queryParams["filter_last_edited_at_timestamp_gte"] = filterLastEditedAtTimestampGte;
-            }
-            if (filterLastEditedAtTimestampLte !== undefined) {
-                _queryParams["filter_last_edited_at_timestamp_lte"] = filterLastEditedAtTimestampLte;
-            }
-            let _headers = (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
-                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.ChrtEnvironment.Local, "shipping/order_schedules/list/v1"),
+    __aboutV1(orderScheduleId, 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/about/v1/${encodeURIComponent(orderScheduleId)}`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryParameters: 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,
@@ -162,7 +115,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/order_schedules/list/v1.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/order_schedules/about/v1/{order_schedule_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -172,7 +125,7 @@ class OrderSchedules {
         });
     }
     /**
-     * Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)
+     * 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.
@@ -180,18 +133,18 @@ class OrderSchedules {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.getByIdV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.activateV1("order_schedule_id")
      */
-    getByIdV1(orderScheduleId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getByIdV1(orderScheduleId, requestOptions));
+    activateV1(orderScheduleId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__activateV1(orderScheduleId, requestOptions));
     }
-    __getByIdV1(orderScheduleId, requestOptions) {
+    __activateV1(orderScheduleId, 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/v1/${encodeURIComponent(orderScheduleId)}`),
-                method: "GET",
+                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/activate/v1/${encodeURIComponent(orderScheduleId)}`),
+                method: "PATCH",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -221,7 +174,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/order_schedules/v1/{order_schedule_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/activate/v1/{order_schedule_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -231,7 +184,7 @@ class OrderSchedules {
         });
     }
     /**
-     * Retrieves the generated order count and live orchestrator status from Temporal. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
+     * Archives an order schedule and deletes its Temporal schedule, preventing future runs. | authz: min_org_role=operator | () -> (bool)
      *
      * @param {string} orderScheduleId
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
@@ -239,18 +192,18 @@ class OrderSchedules {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.aboutV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.archiveV1("order_schedule_id")
      */
-    aboutV1(orderScheduleId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__aboutV1(orderScheduleId, requestOptions));
+    archiveV1(orderScheduleId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__archiveV1(orderScheduleId, requestOptions));
     }
-    __aboutV1(orderScheduleId, requestOptions) {
+    __archiveV1(orderScheduleId, 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/about/v1/${encodeURIComponent(orderScheduleId)}`),
-                method: "GET",
+                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/archive/v1/${encodeURIComponent(orderScheduleId)}`),
+                method: "PATCH",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -280,7 +233,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/order_schedules/about/v1/{order_schedule_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/archive/v1/{order_schedule_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -290,28 +243,75 @@ class OrderSchedules {
         });
     }
     /**
-     * Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
+     * Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
      *
-     * @param {string} orderScheduleId
+     * @param {Chrt.shipping.OrderSchedulesListV1Request} request
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.activateV1("order_schedule_id")
+     *     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"
+     *     })
      */
-    activateV1(orderScheduleId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__activateV1(orderScheduleId, requestOptions));
+    listV1(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listV1(request, requestOptions));
     }
-    __activateV1(orderScheduleId, 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/activate/v1/${encodeURIComponent(orderScheduleId)}`),
-                method: "PATCH",
+    __listV1() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f;
+            const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_intended_status: filterIntendedStatus, filter_owned_by_user_id: filterOwnedByUserId, filter_created_at_timestamp_gte: filterCreatedAtTimestampGte, filter_created_at_timestamp_lte: filterCreatedAtTimestampLte, filter_last_edited_at_timestamp_gte: filterLastEditedAtTimestampGte, filter_last_edited_at_timestamp_lte: filterLastEditedAtTimestampLte, } = request;
+            const _queryParams = {};
+            if (sortBy !== undefined) {
+                _queryParams["sort_by"] = sortBy;
+            }
+            if (sortOrder !== undefined) {
+                _queryParams["sort_order"] = sortOrder;
+            }
+            if (page !== undefined) {
+                _queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
+            }
+            if (pageSize !== undefined) {
+                _queryParams["page_size"] = (_b = pageSize === null || pageSize === void 0 ? void 0 : pageSize.toString()) !== null && _b !== void 0 ? _b : null;
+            }
+            if (filterIntendedStatus !== undefined) {
+                if (Array.isArray(filterIntendedStatus)) {
+                    _queryParams["filter_intended_status"] = filterIntendedStatus.map((item) => item);
+                }
+                else {
+                    _queryParams["filter_intended_status"] = filterIntendedStatus;
+                }
+            }
+            if (filterOwnedByUserId !== undefined) {
+                _queryParams["filter_owned_by_user_id"] = filterOwnedByUserId;
+            }
+            if (filterCreatedAtTimestampGte !== undefined) {
+                _queryParams["filter_created_at_timestamp_gte"] = filterCreatedAtTimestampGte;
+            }
+            if (filterCreatedAtTimestampLte !== undefined) {
+                _queryParams["filter_created_at_timestamp_lte"] = filterCreatedAtTimestampLte;
+            }
+            if (filterLastEditedAtTimestampGte !== undefined) {
+                _queryParams["filter_last_edited_at_timestamp_gte"] = filterLastEditedAtTimestampGte;
+            }
+            if (filterLastEditedAtTimestampLte !== undefined) {
+                _queryParams["filter_last_edited_at_timestamp_lte"] = filterLastEditedAtTimestampLte;
+            }
+            let _headers = (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.ChrtEnvironment.Local, "shipping/order_schedules/list/v1"),
+                method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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,
@@ -339,7 +339,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/activate/v1/{order_schedule_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/order_schedules/list/v1.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -349,7 +349,7 @@ class OrderSchedules {
         });
     }
     /**
-     * Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
+     * Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
      *
      * @param {string} orderScheduleId
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
@@ -357,18 +357,18 @@ class OrderSchedules {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.triggerV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.pauseV1("order_schedule_id")
      */
-    triggerV1(orderScheduleId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__triggerV1(orderScheduleId, requestOptions));
+    pauseV1(orderScheduleId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pauseV1(orderScheduleId, requestOptions));
     }
-    __triggerV1(orderScheduleId, requestOptions) {
+    __pauseV1(orderScheduleId, 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/trigger/v1/${encodeURIComponent(orderScheduleId)}`),
-                method: "POST",
+                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/pause/v1/${encodeURIComponent(orderScheduleId)}`),
+                method: "PATCH",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -398,7 +398,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_schedules/trigger/v1/{order_schedule_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/pause/v1/{order_schedule_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -408,7 +408,7 @@ class OrderSchedules {
         });
     }
     /**
-     * Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
+     * Re-syncs the Temporal schedule to match the order schedule's intended status. | authz: min_org_role=operator | () -> (bool)
      *
      * @param {string} orderScheduleId
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
@@ -416,18 +416,18 @@ class OrderSchedules {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.pauseV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id")
      */
-    pauseV1(orderScheduleId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__pauseV1(orderScheduleId, requestOptions));
+    syncWithOrchestratorV1(orderScheduleId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__syncWithOrchestratorV1(orderScheduleId, requestOptions));
     }
-    __pauseV1(orderScheduleId, requestOptions) {
+    __syncWithOrchestratorV1(orderScheduleId, 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/pause/v1/${encodeURIComponent(orderScheduleId)}`),
-                method: "PATCH",
+                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/sync_with_orchestrator/v1/${encodeURIComponent(orderScheduleId)}`),
+                method: "POST",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -457,7 +457,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/pause/v1/{order_schedule_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_schedules/sync_with_orchestrator/v1/{order_schedule_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -467,7 +467,7 @@ class OrderSchedules {
         });
     }
     /**
-     * Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
+     * Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
      *
      * @param {string} orderScheduleId
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
@@ -475,17 +475,17 @@ class OrderSchedules {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.unpauseV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id")
      */
-    unpauseV1(orderScheduleId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__unpauseV1(orderScheduleId, requestOptions));
+    takeOwnershipV1(orderScheduleId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__takeOwnershipV1(orderScheduleId, requestOptions));
     }
-    __unpauseV1(orderScheduleId, requestOptions) {
+    __takeOwnershipV1(orderScheduleId, 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/unpause/v1/${encodeURIComponent(orderScheduleId)}`),
+                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/take_ownership/v1/${encodeURIComponent(orderScheduleId)}`),
                 method: "PATCH",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -516,7 +516,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/unpause/v1/{order_schedule_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/take_ownership/v1/{order_schedule_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -526,7 +526,7 @@ class OrderSchedules {
         });
     }
     /**
-     * Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
+     * Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
      *
      * @param {string} orderScheduleId
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
@@ -534,18 +534,18 @@ class OrderSchedules {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.triggerV1("order_schedule_id")
      */
-    takeOwnershipV1(orderScheduleId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__takeOwnershipV1(orderScheduleId, requestOptions));
+    triggerV1(orderScheduleId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__triggerV1(orderScheduleId, requestOptions));
     }
-    __takeOwnershipV1(orderScheduleId, requestOptions) {
+    __triggerV1(orderScheduleId, 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/take_ownership/v1/${encodeURIComponent(orderScheduleId)}`),
-                method: "PATCH",
+                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/trigger/v1/${encodeURIComponent(orderScheduleId)}`),
+                method: "POST",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -575,7 +575,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/take_ownership/v1/{order_schedule_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_schedules/trigger/v1/{order_schedule_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -585,7 +585,7 @@ class OrderSchedules {
         });
     }
     /**
-     * Archives an order schedule and deletes its Temporal schedule, preventing future runs. | authz: min_org_role=operator | () -> (bool)
+     * Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
      *
      * @param {string} orderScheduleId
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
@@ -593,17 +593,17 @@ class OrderSchedules {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.archiveV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.unpauseV1("order_schedule_id")
      */
-    archiveV1(orderScheduleId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__archiveV1(orderScheduleId, requestOptions));
+    unpauseV1(orderScheduleId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__unpauseV1(orderScheduleId, requestOptions));
     }
-    __archiveV1(orderScheduleId, requestOptions) {
+    __unpauseV1(orderScheduleId, 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/archive/v1/${encodeURIComponent(orderScheduleId)}`),
+                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/unpause/v1/${encodeURIComponent(orderScheduleId)}`),
                 method: "PATCH",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -634,7 +634,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/archive/v1/{order_schedule_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/unpause/v1/{order_schedule_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -644,7 +644,7 @@ class OrderSchedules {
         });
     }
     /**
-     * Re-syncs the Temporal schedule to match the order schedule's intended status. | authz: min_org_role=operator | () -> (bool)
+     * Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)
      *
      * @param {string} orderScheduleId
      * @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
@@ -652,18 +652,18 @@ class OrderSchedules {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id")
+     *     await client.shipping.orderSchedules.getByIdV1("order_schedule_id")
      */
-    syncWithOrchestratorV1(orderScheduleId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__syncWithOrchestratorV1(orderScheduleId, requestOptions));
+    getByIdV1(orderScheduleId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getByIdV1(orderScheduleId, requestOptions));
     }
-    __syncWithOrchestratorV1(orderScheduleId, requestOptions) {
+    __getByIdV1(orderScheduleId, 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/sync_with_orchestrator/v1/${encodeURIComponent(orderScheduleId)}`),
-                method: "POST",
+                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/v1/${encodeURIComponent(orderScheduleId)}`),
+                method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -693,7 +693,7 @@ class OrderSchedules {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_schedules/sync_with_orchestrator/v1/{order_schedule_id}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/order_schedules/v1/{order_schedule_id}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,

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

@@ -40,8 +40,8 @@ export declare class Draft {
      *
      * @example
      *     await client.shipping.orderSchedules.draft.newV1({
-     *         schema_version: 1,
-     *         name: "name"
+     *         name: "name",
+     *         schema_version: 1
      *     })
      */
     newV1(request: Chrt.shipping.orderSchedules.OrderScheduleClientCreate1, requestOptions?: Draft.RequestOptions): core.HttpResponsePromise<string>;

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

@@ -65,8 +65,8 @@ class Draft {
      *
      * @example
      *     await client.shipping.orderSchedules.draft.newV1({
-     *         schema_version: 1,
-     *         name: "name"
+     *         name: "name",
+     *         schema_version: 1
      *     })
      */
     newV1(request, requestOptions) {

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

@@ -5,14 +5,14 @@ import * as Chrt from "../../../../../../../../index.js";
 /**
  * @example
  *     {
- *         schema_version: 1,
- *         name: "name"
+ *         name: "name",
+ *         schema_version: 1
  *     }
  */
 export interface OrderScheduleClientCreate1 {
-    schema_version: number;
-    name: string;
     description?: string | null;
+    name: string;
     order_manifest?: Chrt.OrderManifest1 | null;
     schedule_spec?: Chrt.OrderScheduleSpec1 | null;
+    schema_version: number;
 }

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

@@ -7,9 +7,9 @@ import * as Chrt from "../../../../../../../../index.js";
  *     {}
  */
 export interface OrderScheduleClientUpdate1 {
-    name?: string | null;
     description?: string | null;
+    description__set_to_None?: boolean;
+    name?: string | null;
     order_manifest?: Chrt.OrderManifest1 | null;
     schedule_spec?: Chrt.OrderScheduleSpec1 | null;
-    description__set_to_None?: boolean;
 }