ultracart_rest_api_v2_typescript 4.1.193 → 4.1.195

package/.openapi-generator/FILES

@@ -1154,6 +1154,8 @@ src/models/SfvbTemplateResolveCandidate.ts
 src/models/SfvbTemplateResolvePath.ts
 src/models/SfvbTemplateResolveResponse.ts
 src/models/SfvbTemplatesResponse.ts
+src/models/SfvbTestOrder.ts
+src/models/SfvbTestOrdersResponse.ts
 src/models/SfvbTheme.ts
 src/models/SfvbThemeAttribute.ts
 src/models/SfvbThemeAttributeUpdate.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.193
+## ultracart_rest_api_v2_typescript@4.1.195
 
 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.193 --save
+npm install ultracart_rest_api_v2_typescript@4.1.195 --save
 ```
 
 ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.195 | 10/07/2026 | sfvb internal testing |
+| 4.1.194 | 10/07/2026 | sfvb internal testing |
 | 4.1.193 | 10/06/2026 | sfvb internal testing |
 | 4.1.192 | 10/06/2026 | sfvb internal testing |
 | 4.1.191 | 10/06/2026 | sfvb internal testing |

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, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, 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, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, 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;
@@ -316,6 +316,12 @@ export interface GetSfvbServerLogRequest {
 export interface GetSfvbSiteAttributesRequest {
     storefrontOid: number;
 }
+export interface GetSfvbTestOrdersRequest {
+    storefrontOid: number;
+    limit?: number;
+    digitalItems?: boolean;
+    autoOrder?: boolean;
+}
 export interface GetSfvbThemeRequest {
     storefrontOid: number;
     themeOid: number;
@@ -1775,6 +1781,23 @@ export interface SfvbApiInterface {
      * Read a storefront\'s site attributes
      */
     getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10.
+     * @summary List recent test orders
+     * @param {number} storefrontOid
+     * @param {number} [limit]
+     * @param {boolean} [digitalItems]
+     * @param {boolean} [autoOrder]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbTestOrdersRaw(requestParameters: GetSfvbTestOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTestOrdersResponse>>;
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10.
+     * List recent test orders
+     */
+    getSfvbTestOrders(requestParameters: GetSfvbTestOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTestOrdersResponse>;
     /**
      *
      * @summary Get a theme
@@ -3733,6 +3756,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Read a storefront\'s site attributes
      */
     getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10.
+     * List recent test orders
+     */
+    getSfvbTestOrdersRaw(requestParameters: GetSfvbTestOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTestOrdersResponse>>;
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10.
+     * List recent test orders
+     */
+    getSfvbTestOrders(requestParameters: GetSfvbTestOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTestOrdersResponse>;
     /**
      * Get a theme
      */

package/dist/apis/SfvbApi.js

@@ -4439,6 +4439,74 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10.
+     * List recent test orders
+     */
+    SfvbApi.prototype.getSfvbTestOrdersRaw = 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.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbTestOrders.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.limit !== undefined) {
+                            queryParameters['limit'] = requestParameters.limit;
+                        }
+                        if (requestParameters.digitalItems !== undefined) {
+                            queryParameters['digital_items'] = requestParameters.digitalItems;
+                        }
+                        if (requestParameters.autoOrder !== undefined) {
+                            queryParameters['auto_order'] = requestParameters.autoOrder;
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    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: "/sfvb/storefronts/{storefront_oid}/test_orders".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                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.SfvbTestOrdersResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10.
+     * List recent test orders
+     */
+    SfvbApi.prototype.getSfvbTestOrders = 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.getSfvbTestOrdersRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Get a theme
      */

package/dist/models/SfvbTestOrder.d.ts

@@ -0,0 +1,79 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SfvbTestOrder
+ */
+export interface SfvbTestOrder {
+    /**
+     * True when the order started an auto order, for working on the subscription pages.
+     * @type {boolean}
+     * @memberof SfvbTestOrder
+     */
+    auto_order?: boolean;
+    /**
+     * When the order was placed, ISO-8601 in UTC.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    created?: string;
+    /**
+     * The currency of the total.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    currency_code?: string;
+    /**
+     * True when the order has digital downloads, for working on the digital download page.
+     * @type {boolean}
+     * @memberof SfvbTestOrder
+     */
+    digital_items?: boolean;
+    /**
+     * How many item lines the order has.
+     * @type {number}
+     * @memberof SfvbTestOrder
+     */
+    item_count?: number;
+    /**
+     * The order id.  Pass it as a render's context_order_id.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    order_id?: string;
+    /**
+     * How the order was paid, such as Credit Card or PayPal.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    payment_method?: string;
+    /**
+     * The order's current stage code, such as CO (completed), SD (shipping department) or AR (accounts receivable).
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    stage?: string;
+    /**
+     * The order total as a decimal string.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    total?: string;
+}
+/**
+ * Check if a given object implements the SfvbTestOrder interface.
+ */
+export declare function instanceOfSfvbTestOrder(value: object): boolean;
+export declare function SfvbTestOrderFromJSON(json: any): SfvbTestOrder;
+export declare function SfvbTestOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbTestOrder;
+export declare function SfvbTestOrderToJSON(value?: SfvbTestOrder | null): any;

package/dist/models/SfvbTestOrder.js

@@ -0,0 +1,66 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbTestOrderToJSON = exports.SfvbTestOrderFromJSONTyped = exports.SfvbTestOrderFromJSON = exports.instanceOfSfvbTestOrder = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbTestOrder interface.
+ */
+function instanceOfSfvbTestOrder(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbTestOrder = instanceOfSfvbTestOrder;
+function SfvbTestOrderFromJSON(json) {
+    return SfvbTestOrderFromJSONTyped(json, false);
+}
+exports.SfvbTestOrderFromJSON = SfvbTestOrderFromJSON;
+function SfvbTestOrderFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'auto_order': !(0, runtime_1.exists)(json, 'auto_order') ? undefined : json['auto_order'],
+        'created': !(0, runtime_1.exists)(json, 'created') ? undefined : json['created'],
+        'currency_code': !(0, runtime_1.exists)(json, 'currency_code') ? undefined : json['currency_code'],
+        'digital_items': !(0, runtime_1.exists)(json, 'digital_items') ? undefined : json['digital_items'],
+        'item_count': !(0, runtime_1.exists)(json, 'item_count') ? undefined : json['item_count'],
+        'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
+        'payment_method': !(0, runtime_1.exists)(json, 'payment_method') ? undefined : json['payment_method'],
+        'stage': !(0, runtime_1.exists)(json, 'stage') ? undefined : json['stage'],
+        'total': !(0, runtime_1.exists)(json, 'total') ? undefined : json['total'],
+    };
+}
+exports.SfvbTestOrderFromJSONTyped = SfvbTestOrderFromJSONTyped;
+function SfvbTestOrderToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'auto_order': value.auto_order,
+        'created': value.created,
+        'currency_code': value.currency_code,
+        'digital_items': value.digital_items,
+        'item_count': value.item_count,
+        'order_id': value.order_id,
+        'payment_method': value.payment_method,
+        'stage': value.stage,
+        'total': value.total,
+    };
+}
+exports.SfvbTestOrderToJSON = SfvbTestOrderToJSON;

package/dist/models/SfvbTestOrdersResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SfvbTestOrder } from './SfvbTestOrder';
+/**
+ *
+ * @export
+ * @interface SfvbTestOrdersResponse
+ */
+export interface SfvbTestOrdersResponse {
+    /**
+     * Present when nothing matched.
+     * @type {string}
+     * @memberof SfvbTestOrdersResponse
+     */
+    hint?: string;
+    /**
+     * Test orders, newest first.  Only orders marked as test orders are ever listed.
+     * @type {Array<SfvbTestOrder>}
+     * @memberof SfvbTestOrdersResponse
+     */
+    test_orders?: Array<SfvbTestOrder>;
+}
+/**
+ * Check if a given object implements the SfvbTestOrdersResponse interface.
+ */
+export declare function instanceOfSfvbTestOrdersResponse(value: object): boolean;
+export declare function SfvbTestOrdersResponseFromJSON(json: any): SfvbTestOrdersResponse;
+export declare function SfvbTestOrdersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbTestOrdersResponse;
+export declare function SfvbTestOrdersResponseToJSON(value?: SfvbTestOrdersResponse | null): any;

package/dist/models/SfvbTestOrdersResponse.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbTestOrdersResponseToJSON = exports.SfvbTestOrdersResponseFromJSONTyped = exports.SfvbTestOrdersResponseFromJSON = exports.instanceOfSfvbTestOrdersResponse = void 0;
+var runtime_1 = require("../runtime");
+var SfvbTestOrder_1 = require("./SfvbTestOrder");
+/**
+ * Check if a given object implements the SfvbTestOrdersResponse interface.
+ */
+function instanceOfSfvbTestOrdersResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbTestOrdersResponse = instanceOfSfvbTestOrdersResponse;
+function SfvbTestOrdersResponseFromJSON(json) {
+    return SfvbTestOrdersResponseFromJSONTyped(json, false);
+}
+exports.SfvbTestOrdersResponseFromJSON = SfvbTestOrdersResponseFromJSON;
+function SfvbTestOrdersResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'hint': !(0, runtime_1.exists)(json, 'hint') ? undefined : json['hint'],
+        'test_orders': !(0, runtime_1.exists)(json, 'test_orders') ? undefined : (json['test_orders'].map(SfvbTestOrder_1.SfvbTestOrderFromJSON)),
+    };
+}
+exports.SfvbTestOrdersResponseFromJSONTyped = SfvbTestOrdersResponseFromJSONTyped;
+function SfvbTestOrdersResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'hint': value.hint,
+        'test_orders': value.test_orders === undefined ? undefined : (value.test_orders.map(SfvbTestOrder_1.SfvbTestOrderToJSON)),
+    };
+}
+exports.SfvbTestOrdersResponseToJSON = SfvbTestOrdersResponseToJSON;

package/dist/models/index.d.ts

@@ -1124,6 +1124,8 @@ export * from './SfvbTemplateResolveCandidate';
 export * from './SfvbTemplateResolvePath';
 export * from './SfvbTemplateResolveResponse';
 export * from './SfvbTemplatesResponse';
+export * from './SfvbTestOrder';
+export * from './SfvbTestOrdersResponse';
 export * from './SfvbTheme';
 export * from './SfvbThemeAttribute';
 export * from './SfvbThemeAttributeUpdate';

package/dist/models/index.js

@@ -1142,6 +1142,8 @@ __exportStar(require("./SfvbTemplateResolveCandidate"), exports);
 __exportStar(require("./SfvbTemplateResolvePath"), exports);
 __exportStar(require("./SfvbTemplateResolveResponse"), exports);
 __exportStar(require("./SfvbTemplatesResponse"), exports);
+__exportStar(require("./SfvbTestOrder"), exports);
+__exportStar(require("./SfvbTestOrdersResponse"), exports);
 __exportStar(require("./SfvbTheme"), exports);
 __exportStar(require("./SfvbThemeAttribute"), exports);
 __exportStar(require("./SfvbThemeAttributeUpdate"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.193",
+  "version": "4.1.195",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/SfvbApi.ts

@@ -336,6 +336,9 @@ import {
     SfvbTemplatesResponse,
     SfvbTemplatesResponseFromJSON,
     SfvbTemplatesResponseToJSON,
+    SfvbTestOrdersResponse,
+    SfvbTestOrdersResponseFromJSON,
+    SfvbTestOrdersResponseToJSON,
     SfvbTheme,
     SfvbThemeFromJSON,
     SfvbThemeToJSON,
@@ -765,6 +768,13 @@ export interface GetSfvbSiteAttributesRequest {
     storefrontOid: number;
 }
 
+export interface GetSfvbTestOrdersRequest {
+    storefrontOid: number;
+    limit?: number;
+    digitalItems?: boolean;
+    autoOrder?: boolean;
+}
+
 export interface GetSfvbThemeRequest {
     storefrontOid: number;
     themeOid: number;
@@ -2435,6 +2445,25 @@ export interface SfvbApiInterface {
      */
     getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
 
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10. 
+     * @summary List recent test orders
+     * @param {number} storefrontOid 
+     * @param {number} [limit] 
+     * @param {boolean} [digitalItems] 
+     * @param {boolean} [autoOrder] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbTestOrdersRaw(requestParameters: GetSfvbTestOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTestOrdersResponse>>;
+
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10. 
+     * List recent test orders
+     */
+    getSfvbTestOrders(requestParameters: GetSfvbTestOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTestOrdersResponse>;
+
     /**
      * 
      * @summary Get a theme
@@ -7148,6 +7177,59 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
         return await response.value();
     }
 
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10. 
+     * List recent test orders
+     */
+    async getSfvbTestOrdersRaw(requestParameters: GetSfvbTestOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTestOrdersResponse>> {
+        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+            throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbTestOrders.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        if (requestParameters.digitalItems !== undefined) {
+            queryParameters['digital_items'] = requestParameters.digitalItems;
+        }
+
+        if (requestParameters.autoOrder !== undefined) {
+            queryParameters['auto_order'] = requestParameters.autoOrder;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/sfvb/storefronts/{storefront_oid}/test_orders`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SfvbTestOrdersResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Test orders on this account only, newest first, with no customer details, so an agent can render the order pages (receipt, order tracking, digital downloads, auto order pages) with one.  Use an order_id as a render\'s context_order_id; a real customer\'s order is refused there.  The last 7 days are searched, widening to 30 and then 90 until enough are found.  digital_items and auto_order keep only orders with downloads or an auto order.  limit is 1 to 25, default 10. 
+     * List recent test orders
+     */
+    async getSfvbTestOrders(requestParameters: GetSfvbTestOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTestOrdersResponse> {
+        const response = await this.getSfvbTestOrdersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get a theme
      */

package/src/models/SfvbTestOrder.ts

@@ -0,0 +1,131 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SfvbTestOrder
+ */
+export interface SfvbTestOrder {
+    /**
+     * True when the order started an auto order, for working on the subscription pages.
+     * @type {boolean}
+     * @memberof SfvbTestOrder
+     */
+    auto_order?: boolean;
+    /**
+     * When the order was placed, ISO-8601 in UTC.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    created?: string;
+    /**
+     * The currency of the total.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    currency_code?: string;
+    /**
+     * True when the order has digital downloads, for working on the digital download page.
+     * @type {boolean}
+     * @memberof SfvbTestOrder
+     */
+    digital_items?: boolean;
+    /**
+     * How many item lines the order has.
+     * @type {number}
+     * @memberof SfvbTestOrder
+     */
+    item_count?: number;
+    /**
+     * The order id.  Pass it as a render's context_order_id.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    order_id?: string;
+    /**
+     * How the order was paid, such as Credit Card or PayPal.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    payment_method?: string;
+    /**
+     * The order's current stage code, such as CO (completed), SD (shipping department) or AR (accounts receivable).
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    stage?: string;
+    /**
+     * The order total as a decimal string.
+     * @type {string}
+     * @memberof SfvbTestOrder
+     */
+    total?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbTestOrder interface.
+ */
+export function instanceOfSfvbTestOrder(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbTestOrderFromJSON(json: any): SfvbTestOrder {
+    return SfvbTestOrderFromJSONTyped(json, false);
+}
+
+export function SfvbTestOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbTestOrder {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'auto_order': !exists(json, 'auto_order') ? undefined : json['auto_order'],
+        'created': !exists(json, 'created') ? undefined : json['created'],
+        'currency_code': !exists(json, 'currency_code') ? undefined : json['currency_code'],
+        'digital_items': !exists(json, 'digital_items') ? undefined : json['digital_items'],
+        'item_count': !exists(json, 'item_count') ? undefined : json['item_count'],
+        'order_id': !exists(json, 'order_id') ? undefined : json['order_id'],
+        'payment_method': !exists(json, 'payment_method') ? undefined : json['payment_method'],
+        'stage': !exists(json, 'stage') ? undefined : json['stage'],
+        'total': !exists(json, 'total') ? undefined : json['total'],
+    };
+}
+
+export function SfvbTestOrderToJSON(value?: SfvbTestOrder | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'auto_order': value.auto_order,
+        'created': value.created,
+        'currency_code': value.currency_code,
+        'digital_items': value.digital_items,
+        'item_count': value.item_count,
+        'order_id': value.order_id,
+        'payment_method': value.payment_method,
+        'stage': value.stage,
+        'total': value.total,
+    };
+}
+

package/src/models/SfvbTestOrdersResponse.ts

@@ -0,0 +1,82 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    SfvbTestOrder,
+    SfvbTestOrderFromJSON,
+    SfvbTestOrderFromJSONTyped,
+    SfvbTestOrderToJSON,
+} from './SfvbTestOrder';
+
+/**
+ * 
+ * @export
+ * @interface SfvbTestOrdersResponse
+ */
+export interface SfvbTestOrdersResponse {
+    /**
+     * Present when nothing matched.
+     * @type {string}
+     * @memberof SfvbTestOrdersResponse
+     */
+    hint?: string;
+    /**
+     * Test orders, newest first.  Only orders marked as test orders are ever listed.
+     * @type {Array<SfvbTestOrder>}
+     * @memberof SfvbTestOrdersResponse
+     */
+    test_orders?: Array<SfvbTestOrder>;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbTestOrdersResponse interface.
+ */
+export function instanceOfSfvbTestOrdersResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbTestOrdersResponseFromJSON(json: any): SfvbTestOrdersResponse {
+    return SfvbTestOrdersResponseFromJSONTyped(json, false);
+}
+
+export function SfvbTestOrdersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbTestOrdersResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'hint': !exists(json, 'hint') ? undefined : json['hint'],
+        'test_orders': !exists(json, 'test_orders') ? undefined : ((json['test_orders'] as Array<any>).map(SfvbTestOrderFromJSON)),
+    };
+}
+
+export function SfvbTestOrdersResponseToJSON(value?: SfvbTestOrdersResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'hint': value.hint,
+        'test_orders': value.test_orders === undefined ? undefined : ((value.test_orders as Array<any>).map(SfvbTestOrderToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -1126,6 +1126,8 @@ export * from './SfvbTemplateResolveCandidate';
 export * from './SfvbTemplateResolvePath';
 export * from './SfvbTemplateResolveResponse';
 export * from './SfvbTemplatesResponse';
+export * from './SfvbTestOrder';
+export * from './SfvbTestOrdersResponse';
 export * from './SfvbTheme';
 export * from './SfvbThemeAttribute';
 export * from './SfvbThemeAttributeUpdate';