ultracart_rest_api_v2_typescript 4.1.179 → 4.1.181

package/.openapi-generator/FILES

@@ -818,8 +818,10 @@ src/models/Order.ts
 src/models/OrderAddItemsAndReleaseRequest.ts
 src/models/OrderAffiliate.ts
 src/models/OrderAffiliateLedger.ts
+src/models/OrderAssignRmaRequest.ts
 src/models/OrderAssignToAffiliateRequest.ts
 src/models/OrderAutoOrder.ts
+src/models/OrderAutoOrderUpdateBillingUrlResponse.ts
 src/models/OrderBilling.ts
 src/models/OrderBuysafe.ts
 src/models/OrderByTokenQuery.ts
@@ -1081,6 +1083,9 @@ src/models/SfvbRecordingEventsResponse.ts
 src/models/SfvbRecordingPageView.ts
 src/models/SfvbRecordingParameter.ts
 src/models/SfvbRecordingResponse.ts
+src/models/SfvbRecordingSettings.ts
+src/models/SfvbRecordingSettingsRequest.ts
+src/models/SfvbRecordingSettingsResponse.ts
 src/models/SfvbRenderRequest.ts
 src/models/SfvbRenderResponse.ts
 src/models/SfvbServerLog.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.179
+## ultracart_rest_api_v2_typescript@4.1.181
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.179 --save
+npm install ultracart_rest_api_v2_typescript@4.1.181 --save
 ```
 
 ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.181 | 10/02/2026 | sfvb internal testing |
+| 4.1.180 | 10/02/2026 | sfvb internal builder |
 | 4.1.179 | 10/01/2026 | sfvb internal testing |
 | 4.1.178 | 09/30/2026 | sfvb internal testing |
 | 4.1.177 | 09/30/2026 | sfvb internal testing |

package/dist/apis/AutoOrderApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderCancelReasonsResponse, AutoOrderConsolidate, AutoOrderEmailsResponse, AutoOrderItemCancelRequest, AutoOrderPaymentUpdateRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderRebillResponse, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
+import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderCancelReasonsResponse, AutoOrderConsolidate, AutoOrderEmailsResponse, AutoOrderItemCancelRequest, AutoOrderPaymentUpdateRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderRebillResponse, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse, OrderAutoOrderUpdateBillingUrlResponse } from '../models';
 export interface AttemptAutoOrderRebillRequest {
     autoOrderOid: number;
     expand?: string;
@@ -45,6 +45,9 @@ export interface GetAutoOrderByReferenceOrderIdRequest {
 export interface GetAutoOrderEmailsRequest {
     autoOrderOid: number;
 }
+export interface GetAutoOrderUpdateBillingUrlRequest {
+    autoOrderOid: number;
+}
 export interface GetAutoOrdersRequest {
     autoOrderCode?: string;
     originalOrderId?: string;
@@ -262,6 +265,20 @@ export interface AutoOrderApiInterface {
      * Retrieve email delivery information for this auto order.
      */
     getAutoOrderEmails(requestParameters: GetAutoOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderEmailsResponse>;
+    /**
+     * Generates the url a customer can use to update the billing information on this auto order.  This is the same url sent in the auto order update billing email.
+     * @summary Generate an auto order update billing url
+     * @param {number} autoOrderOid The auto order oid to generate the update billing url for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutoOrderApiInterface
+     */
+    getAutoOrderUpdateBillingUrlRaw(requestParameters: GetAutoOrderUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAutoOrderUpdateBillingUrlResponse>>;
+    /**
+     * Generates the url a customer can use to update the billing information on this auto order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    getAutoOrderUpdateBillingUrl(requestParameters: GetAutoOrderUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAutoOrderUpdateBillingUrlResponse>;
     /**
      * Retrieves auto orders from the account.  If no parameters are specified, all auto orders will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * @summary Retrieve auto orders
@@ -542,6 +559,16 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
      * Retrieve email delivery information for this auto order.
      */
     getAutoOrderEmails(requestParameters: GetAutoOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderEmailsResponse>;
+    /**
+     * Generates the url a customer can use to update the billing information on this auto order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    getAutoOrderUpdateBillingUrlRaw(requestParameters: GetAutoOrderUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAutoOrderUpdateBillingUrlResponse>>;
+    /**
+     * Generates the url a customer can use to update the billing information on this auto order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    getAutoOrderUpdateBillingUrl(requestParameters: GetAutoOrderUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAutoOrderUpdateBillingUrlResponse>;
     /**
      * Retrieves auto orders from the account.  If no parameters are specified, all auto orders will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * Retrieve auto orders

package/dist/apis/AutoOrderApi.js

@@ -634,6 +634,65 @@ var AutoOrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Generates the url a customer can use to update the billing information on this auto order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    AutoOrderApi.prototype.getAutoOrderUpdateBillingUrlRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
+                            throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling getAutoOrderUpdateBillingUrl.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/auto_order/auto_orders/{auto_order_oid}/update_billing_url".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderAutoOrderUpdateBillingUrlResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Generates the url a customer can use to update the billing information on this auto order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    AutoOrderApi.prototype.getAutoOrderUpdateBillingUrl = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getAutoOrderUpdateBillingUrlRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieves auto orders from the account.  If no parameters are specified, all auto orders will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * Retrieve auto orders

package/dist/apis/OrderApi.d.ts

@@ -10,11 +10,16 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAddItemsAndReleaseRequest, OrderAssignToAffiliateRequest, OrderByTokenQuery, OrderCustomerActivityResponse, OrderEdiDocumentsResponse, OrderEmailsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderPageViewHistoryResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderUpsellCartRequest, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
+import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAddItemsAndReleaseRequest, OrderAssignRmaRequest, OrderAssignToAffiliateRequest, OrderAutoOrderUpdateBillingUrlResponse, OrderByTokenQuery, OrderCustomerActivityResponse, OrderEdiDocumentsResponse, OrderEmailsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderPageViewHistoryResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderUpsellCartRequest, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
 export interface AdjustOrderTotalRequest {
     orderId: string;
     desiredTotal: string;
 }
+export interface AssignRmaRequest {
+    orderId: string;
+    assignRmaRequest: OrderAssignRmaRequest;
+    expand?: string;
+}
 export interface AssignToAffiliateRequest {
     orderId: string;
     assignToAffiliateRequest: OrderAssignToAffiliateRequest;
@@ -130,6 +135,13 @@ export interface GetOrdersByQueryRequest {
     sort?: string;
     expand?: string;
 }
+export interface GetOrdersByRmaRequest {
+    rma: string;
+    expand?: string;
+}
+export interface GetUpdateBillingUrlRequest {
+    orderId: string;
+}
 export interface HeldOrderAddItemsAndReleaseRequest {
     orderId: string;
     addItemsAndReleaseRequest: OrderAddItemsAndReleaseRequest;
@@ -213,6 +225,22 @@ export interface OrderApiInterface {
      * Adjusts an order total
      */
     adjustOrderTotal(requestParameters: AdjustOrderTotalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
+    /**
+     * Associates an RMA number with an order.  Any existing RMA on the order is replaced.
+     * @summary Associates an RMA with an order
+     * @param {string} orderId The order id to associate the RMA with.
+     * @param {OrderAssignRmaRequest} assignRmaRequest Assign RMA request
+     * @param {string} [expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    assignRmaRaw(requestParameters: AssignRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
+    /**
+     * Associates an RMA number with an order.  Any existing RMA on the order is replaced.
+     * Associates an RMA with an order
+     */
+    assignRma(requestParameters: AssignRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
     /**
      * Assigns an order to an affiliate.
      * @summary Assigns an order to an affiliate
@@ -596,6 +624,35 @@ export interface OrderApiInterface {
      * Retrieve orders by query
      */
     getOrdersByQuery(requestParameters: GetOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
+    /**
+     * Retrieves the orders associated with the specified RMA number.  The RMA must be an exact value; wildcards are not permitted.
+     * @summary Retrieve orders by RMA
+     * @param {string} rma The RMA number to search for.
+     * @param {string} [expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getOrdersByRmaRaw(requestParameters: GetOrdersByRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrdersResponse>>;
+    /**
+     * Retrieves the orders associated with the specified RMA number.  The RMA must be an exact value; wildcards are not permitted.
+     * Retrieve orders by RMA
+     */
+    getOrdersByRma(requestParameters: GetOrdersByRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
+    /**
+     * Generates the url a customer can use to update the billing information on the auto order associated with this order.  This is the same url sent in the auto order update billing email.
+     * @summary Generate an auto order update billing url
+     * @param {string} orderId The order id to generate the update billing url for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getUpdateBillingUrlRaw(requestParameters: GetUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAutoOrderUpdateBillingUrlResponse>>;
+    /**
+     * Generates the url a customer can use to update the billing information on the auto order associated with this order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    getUpdateBillingUrl(requestParameters: GetUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAutoOrderUpdateBillingUrlResponse>;
     /**
      * This method adds items to an order in the hold stage and releases it
      * @summary Add items and release a held order
@@ -826,6 +883,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      * Adjusts an order total
      */
     adjustOrderTotal(requestParameters: AdjustOrderTotalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
+    /**
+     * Associates an RMA number with an order.  Any existing RMA on the order is replaced.
+     * Associates an RMA with an order
+     */
+    assignRmaRaw(requestParameters: AssignRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
+    /**
+     * Associates an RMA number with an order.  Any existing RMA on the order is replaced.
+     * Associates an RMA with an order
+     */
+    assignRma(requestParameters: AssignRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
     /**
      * Assigns an order to an affiliate.
      * Assigns an order to an affiliate
@@ -1066,6 +1133,26 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      * Retrieve orders by query
      */
     getOrdersByQuery(requestParameters: GetOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
+    /**
+     * Retrieves the orders associated with the specified RMA number.  The RMA must be an exact value; wildcards are not permitted.
+     * Retrieve orders by RMA
+     */
+    getOrdersByRmaRaw(requestParameters: GetOrdersByRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrdersResponse>>;
+    /**
+     * Retrieves the orders associated with the specified RMA number.  The RMA must be an exact value; wildcards are not permitted.
+     * Retrieve orders by RMA
+     */
+    getOrdersByRma(requestParameters: GetOrdersByRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
+    /**
+     * Generates the url a customer can use to update the billing information on the auto order associated with this order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    getUpdateBillingUrlRaw(requestParameters: GetUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAutoOrderUpdateBillingUrlResponse>>;
+    /**
+     * Generates the url a customer can use to update the billing information on the auto order associated with this order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    getUpdateBillingUrl(requestParameters: GetUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAutoOrderUpdateBillingUrlResponse>;
     /**
      * This method adds items to an order in the hold stage and releases it
      * Add items and release a held order

package/dist/apis/OrderApi.js

@@ -137,6 +137,73 @@ var OrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Associates an RMA number with an order.  Any existing RMA on the order is replaced.
+     * Associates an RMA with an order
+     */
+    OrderApi.prototype.assignRmaRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+                            throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling assignRma.');
+                        }
+                        if (requestParameters.assignRmaRequest === null || requestParameters.assignRmaRequest === undefined) {
+                            throw new runtime.RequiredError('assignRmaRequest', 'Required parameter requestParameters.assignRmaRequest was null or undefined when calling assignRma.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.expand !== undefined) {
+                            queryParameters['_expand'] = requestParameters.expand;
+                        }
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/order/orders/{order_id}/rma".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.OrderAssignRmaRequestToJSON)(requestParameters.assignRmaRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Associates an RMA number with an order.  Any existing RMA on the order is replaced.
+     * Associates an RMA with an order
+     */
+    OrderApi.prototype.assignRma = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.assignRmaRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Assigns an order to an affiliate.
      * Assigns an order to an affiliate
@@ -1703,6 +1770,127 @@ var OrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieves the orders associated with the specified RMA number.  The RMA must be an exact value; wildcards are not permitted.
+     * Retrieve orders by RMA
+     */
+    OrderApi.prototype.getOrdersByRmaRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.rma === null || requestParameters.rma === undefined) {
+                            throw new runtime.RequiredError('rma', 'Required parameter requestParameters.rma was null or undefined when calling getOrdersByRma.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.expand !== undefined) {
+                            queryParameters['_expand'] = requestParameters.expand;
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/order/orders/rma/{rma}".replace("{".concat("rma", "}"), encodeURIComponent(String(requestParameters.rma))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrdersResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves the orders associated with the specified RMA number.  The RMA must be an exact value; wildcards are not permitted.
+     * Retrieve orders by RMA
+     */
+    OrderApi.prototype.getOrdersByRma = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getOrdersByRmaRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Generates the url a customer can use to update the billing information on the auto order associated with this order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    OrderApi.prototype.getUpdateBillingUrlRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+                            throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling getUpdateBillingUrl.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/order/orders/{order_id}/auto_order_update_billing_url".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderAutoOrderUpdateBillingUrlResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Generates the url a customer can use to update the billing information on the auto order associated with this order.  This is the same url sent in the auto order update billing email.
+     * Generate an auto order update billing url
+     */
+    OrderApi.prototype.getUpdateBillingUrl = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getUpdateBillingUrlRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * This method adds items to an order in the hold stage and releases it
      * Add items and release a held order

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
+import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -198,6 +198,9 @@ export interface GetSfvbRecordingPageViewEventsRequest {
     screenRecordingUuid: string;
     screenRecordingPageViewUuid: string;
 }
+export interface GetSfvbRecordingSettingsRequest {
+    storefrontOid: number;
+}
 export interface GetSfvbServerLogRequest {
     storefrontOid: number;
     logId: string;
@@ -409,6 +412,10 @@ export interface PutSfvbPreviewSessionRequest {
     previewSession: SfvbPreviewSessionRequest;
     themeOid?: number;
 }
+export interface PutSfvbRecordingSettingsRequest {
+    storefrontOid: number;
+    recordingSettingsRequest: SfvbRecordingSettingsRequest;
+}
 export interface PutSfvbSiteAttributesRequest {
     storefrontOid: number;
     siteAttributeUpdateRequest: SfvbSiteAttributeUpdateRequest;
@@ -1163,6 +1170,20 @@ export interface SfvbApiInterface {
      * Get one recorded page view\'s replay events
      */
     getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * @summary Get the storefront\'s screen recording settings
+     * @param {number} storefrontOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbRecordingSettingsRaw(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * Get the storefront\'s screen recording settings
+     */
+    getSfvbRecordingSettings(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * @summary Get one storefront render log
@@ -1842,6 +1863,21 @@ export interface SfvbApiInterface {
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
+    /**
+     * Turning it on records real shoppers\' sessions from that moment, with no history before it.  The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000.  Only change it when the merchant has asked for it.  Asking for the state it is already in changes nothing, and changed comes back false.  Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded.  Limited per storefront to 5 changes a minute, 20 an hour and 50 a day.
+     * @summary Turn the storefront\'s screen recording on or off
+     * @param {number} storefrontOid
+     * @param {SfvbRecordingSettingsRequest} recordingSettingsRequest Whether to record
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    putSfvbRecordingSettingsRaw(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+    /**
+     * Turning it on records real shoppers\' sessions from that moment, with no history before it.  The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000.  Only change it when the merchant has asked for it.  Asking for the state it is already in changes nothing, and changed comes back false.  Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded.  Limited per storefront to 5 changes a minute, 20 an hour and 50 a day.
+     * Turn the storefront\'s screen recording on or off
+     */
+    putSfvbRecordingSettings(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
     /**
      * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
      * @summary Change a storefront\'s site attributes
@@ -2584,6 +2620,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Get one recorded page view\'s replay events
      */
     getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * Get the storefront\'s screen recording settings
+     */
+    getSfvbRecordingSettingsRaw(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * Get the storefront\'s screen recording settings
+     */
+    getSfvbRecordingSettings(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * Get one storefront render log
@@ -3000,6 +3046,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
+    /**
+     * Turning it on records real shoppers\' sessions from that moment, with no history before it.  The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000.  Only change it when the merchant has asked for it.  Asking for the state it is already in changes nothing, and changed comes back false.  Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded.  Limited per storefront to 5 changes a minute, 20 an hour and 50 a day.
+     * Turn the storefront\'s screen recording on or off
+     */
+    putSfvbRecordingSettingsRaw(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+    /**
+     * Turning it on records real shoppers\' sessions from that moment, with no history before it.  The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000.  Only change it when the merchant has asked for it.  Asking for the state it is already in changes nothing, and changed comes back false.  Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded.  Limited per storefront to 5 changes a minute, 20 an hour and 50 a day.
+     * Turn the storefront\'s screen recording on or off
+     */
+    putSfvbRecordingSettings(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
     /**
      * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
      * Change a storefront\'s site attributes