ultracart_rest_api_v2_typescript 4.1.87 → 4.1.88

package/.openapi-generator/FILES

@@ -787,6 +787,10 @@ src/models/OrderItemTag.ts
 src/models/OrderLinkedShipment.ts
 src/models/OrderMarketing.ts
 src/models/OrderPackingSlipResponse.ts
+src/models/OrderPageView.ts
+src/models/OrderPageViewHistoryResponse.ts
+src/models/OrderPageViewMetaData.ts
+src/models/OrderPageViewParam.ts
 src/models/OrderPayment.ts
 src/models/OrderPaymentCheck.ts
 src/models/OrderPaymentCreditCard.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.87
+## ultracart_rest_api_v2_typescript@4.1.88
 
 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.87 --save
+npm install ultracart_rest_api_v2_typescript@4.1.88 --save
 ```
 
 ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.88 | 05/08/2026 | order page view history |
 | 4.1.87 | 05/08/2026 | order and auto order emails |
 | 4.1.86 | 05/07/2026 | rest auto order api - additional item cancel request parameter for no orders after dts |
 | 4.1.85 | 05/05/2026 | improved warning object for customer insertCustomer and updateCustomer |

package/dist/apis/OrderApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAddItemsAndReleaseRequest, OrderAssignToAffiliateRequest, OrderByTokenQuery, OrderEdiDocumentsResponse, OrderEmailsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderUpsellCartRequest, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
+import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAddItemsAndReleaseRequest, OrderAssignToAffiliateRequest, OrderByTokenQuery, 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;
@@ -75,6 +75,9 @@ export interface GetOrderEdiDocumentsRequest {
 export interface GetOrderEmailsRequest {
     orderId: string;
 }
+export interface GetOrderPageViewHistoryRequest {
+    orderId: string;
+}
 export interface GetOrderUpsellCartRequest {
     orderId: string;
     upsellCartRequest: OrderUpsellCartRequest;
@@ -469,6 +472,20 @@ export interface OrderApiInterface {
      * Retrieve email delivery information for this order.
      */
     getOrderEmails(requestParameters: GetOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEmailsResponse>;
+    /**
+     * Retrieves the page views captured during the session that placed this order.
+     * @summary Retrieve page view history for this order.
+     * @param {string} orderId The order id to retrieve page view history for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getOrderPageViewHistoryRaw(requestParameters: GetOrderPageViewHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPageViewHistoryResponse>>;
+    /**
+     * Retrieves the page views captured during the session that placed this order.
+     * Retrieve page view history for this order.
+     */
+    getOrderPageViewHistory(requestParameters: GetOrderPageViewHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPageViewHistoryResponse>;
     /**
      * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
      * @summary Get Order Upsell Cart
@@ -972,6 +989,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      * Retrieve email delivery information for this order.
      */
     getOrderEmails(requestParameters: GetOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEmailsResponse>;
+    /**
+     * Retrieves the page views captured during the session that placed this order.
+     * Retrieve page view history for this order.
+     */
+    getOrderPageViewHistoryRaw(requestParameters: GetOrderPageViewHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPageViewHistoryResponse>>;
+    /**
+     * Retrieves the page views captured during the session that placed this order.
+     * Retrieve page view history for this order.
+     */
+    getOrderPageViewHistory(requestParameters: GetOrderPageViewHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPageViewHistoryResponse>;
     /**
      * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
      * Get Order Upsell Cart

package/dist/apis/OrderApi.js

@@ -1231,6 +1231,65 @@ var OrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieves the page views captured during the session that placed this order.
+     * Retrieve page view history for this order.
+     */
+    OrderApi.prototype.getOrderPageViewHistoryRaw = 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 getOrderPageViewHistory.');
+                        }
+                        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_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/{order_id}/page_view_history".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.OrderPageViewHistoryResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves the page views captured during the session that placed this order.
+     * Retrieve page view history for this order.
+     */
+    OrderApi.prototype.getOrderPageViewHistory = 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.getOrderPageViewHistoryRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
      * Get Order Upsell Cart

package/dist/models/OrderPageView.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { OrderPageViewMetaData } from './OrderPageViewMetaData';
+import { OrderPageViewParam } from './OrderPageViewParam';
+/**
+ *
+ * @export
+ * @interface OrderPageView
+ */
+export interface OrderPageView {
+    /**
+     * Meta tag name/value pairs captured on the page view
+     * @type {Array<OrderPageViewMetaData>}
+     * @memberof OrderPageView
+     */
+    meta_data?: Array<OrderPageViewMetaData>;
+    /**
+     * Query string parameters captured on the page view
+     * @type {Array<OrderPageViewParam>}
+     * @memberof OrderPageView
+     */
+    params?: Array<OrderPageViewParam>;
+    /**
+     * Time spent on the page in seconds
+     * @type {number}
+     * @memberof OrderPageView
+     */
+    time_on_page?: number;
+    /**
+     * URL of the page that was viewed
+     * @type {string}
+     * @memberof OrderPageView
+     */
+    url?: string;
+    /**
+     * Date/time the page was viewed
+     * @type {string}
+     * @memberof OrderPageView
+     */
+    view_dts?: string;
+}
+/**
+ * Check if a given object implements the OrderPageView interface.
+ */
+export declare function instanceOfOrderPageView(value: object): boolean;
+export declare function OrderPageViewFromJSON(json: any): OrderPageView;
+export declare function OrderPageViewFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderPageView;
+export declare function OrderPageViewToJSON(value?: OrderPageView | null): any;

package/dist/models/OrderPageView.js

@@ -0,0 +1,60 @@
+"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.OrderPageViewToJSON = exports.OrderPageViewFromJSONTyped = exports.OrderPageViewFromJSON = exports.instanceOfOrderPageView = void 0;
+var runtime_1 = require("../runtime");
+var OrderPageViewMetaData_1 = require("./OrderPageViewMetaData");
+var OrderPageViewParam_1 = require("./OrderPageViewParam");
+/**
+ * Check if a given object implements the OrderPageView interface.
+ */
+function instanceOfOrderPageView(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfOrderPageView = instanceOfOrderPageView;
+function OrderPageViewFromJSON(json) {
+    return OrderPageViewFromJSONTyped(json, false);
+}
+exports.OrderPageViewFromJSON = OrderPageViewFromJSON;
+function OrderPageViewFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'meta_data': !(0, runtime_1.exists)(json, 'meta_data') ? undefined : (json['meta_data'].map(OrderPageViewMetaData_1.OrderPageViewMetaDataFromJSON)),
+        'params': !(0, runtime_1.exists)(json, 'params') ? undefined : (json['params'].map(OrderPageViewParam_1.OrderPageViewParamFromJSON)),
+        'time_on_page': !(0, runtime_1.exists)(json, 'time_on_page') ? undefined : json['time_on_page'],
+        'url': !(0, runtime_1.exists)(json, 'url') ? undefined : json['url'],
+        'view_dts': !(0, runtime_1.exists)(json, 'view_dts') ? undefined : json['view_dts'],
+    };
+}
+exports.OrderPageViewFromJSONTyped = OrderPageViewFromJSONTyped;
+function OrderPageViewToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'meta_data': value.meta_data === undefined ? undefined : (value.meta_data.map(OrderPageViewMetaData_1.OrderPageViewMetaDataToJSON)),
+        'params': value.params === undefined ? undefined : (value.params.map(OrderPageViewParam_1.OrderPageViewParamToJSON)),
+        'time_on_page': value.time_on_page,
+        'url': value.url,
+        'view_dts': value.view_dts,
+    };
+}
+exports.OrderPageViewToJSON = OrderPageViewToJSON;

package/dist/models/OrderPageViewHistoryResponse.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { ModelError } from './ModelError';
+import { OrderPageView } from './OrderPageView';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface OrderPageViewHistoryResponse
+ */
+export interface OrderPageViewHistoryResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Page views captured during the session that placed this order
+     * @type {Array<OrderPageView>}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    page_views?: Array<OrderPageView>;
+    /**
+     * HTTP referrer captured at the start of the session that placed this order
+     * @type {string}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    referrer?: string;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    warning?: Warning;
+}
+/**
+ * Check if a given object implements the OrderPageViewHistoryResponse interface.
+ */
+export declare function instanceOfOrderPageViewHistoryResponse(value: object): boolean;
+export declare function OrderPageViewHistoryResponseFromJSON(json: any): OrderPageViewHistoryResponse;
+export declare function OrderPageViewHistoryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderPageViewHistoryResponse;
+export declare function OrderPageViewHistoryResponseToJSON(value?: OrderPageViewHistoryResponse | null): any;

package/dist/models/OrderPageViewHistoryResponse.js

@@ -0,0 +1,64 @@
+"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.OrderPageViewHistoryResponseToJSON = exports.OrderPageViewHistoryResponseFromJSONTyped = exports.OrderPageViewHistoryResponseFromJSON = exports.instanceOfOrderPageViewHistoryResponse = void 0;
+var runtime_1 = require("../runtime");
+var ModelError_1 = require("./ModelError");
+var OrderPageView_1 = require("./OrderPageView");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+/**
+ * Check if a given object implements the OrderPageViewHistoryResponse interface.
+ */
+function instanceOfOrderPageViewHistoryResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfOrderPageViewHistoryResponse = instanceOfOrderPageViewHistoryResponse;
+function OrderPageViewHistoryResponseFromJSON(json) {
+    return OrderPageViewHistoryResponseFromJSONTyped(json, false);
+}
+exports.OrderPageViewHistoryResponseFromJSON = OrderPageViewHistoryResponseFromJSON;
+function OrderPageViewHistoryResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'page_views': !(0, runtime_1.exists)(json, 'page_views') ? undefined : (json['page_views'].map(OrderPageView_1.OrderPageViewFromJSON)),
+        'referrer': !(0, runtime_1.exists)(json, 'referrer') ? undefined : json['referrer'],
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.OrderPageViewHistoryResponseFromJSONTyped = OrderPageViewHistoryResponseFromJSONTyped;
+function OrderPageViewHistoryResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'page_views': value.page_views === undefined ? undefined : (value.page_views.map(OrderPageView_1.OrderPageViewToJSON)),
+        'referrer': value.referrer,
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.OrderPageViewHistoryResponseToJSON = OrderPageViewHistoryResponseToJSON;

package/dist/models/OrderPageViewMetaData.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 OrderPageViewMetaData
+ */
+export interface OrderPageViewMetaData {
+    /**
+     * Meta tag name
+     * @type {string}
+     * @memberof OrderPageViewMetaData
+     */
+    name?: string;
+    /**
+     * Meta tag value
+     * @type {string}
+     * @memberof OrderPageViewMetaData
+     */
+    value?: string;
+}
+/**
+ * Check if a given object implements the OrderPageViewMetaData interface.
+ */
+export declare function instanceOfOrderPageViewMetaData(value: object): boolean;
+export declare function OrderPageViewMetaDataFromJSON(json: any): OrderPageViewMetaData;
+export declare function OrderPageViewMetaDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderPageViewMetaData;
+export declare function OrderPageViewMetaDataToJSON(value?: OrderPageViewMetaData | null): any;

package/dist/models/OrderPageViewMetaData.js

@@ -0,0 +1,52 @@
+"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.OrderPageViewMetaDataToJSON = exports.OrderPageViewMetaDataFromJSONTyped = exports.OrderPageViewMetaDataFromJSON = exports.instanceOfOrderPageViewMetaData = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the OrderPageViewMetaData interface.
+ */
+function instanceOfOrderPageViewMetaData(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfOrderPageViewMetaData = instanceOfOrderPageViewMetaData;
+function OrderPageViewMetaDataFromJSON(json) {
+    return OrderPageViewMetaDataFromJSONTyped(json, false);
+}
+exports.OrderPageViewMetaDataFromJSON = OrderPageViewMetaDataFromJSON;
+function OrderPageViewMetaDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
+    };
+}
+exports.OrderPageViewMetaDataFromJSONTyped = OrderPageViewMetaDataFromJSONTyped;
+function OrderPageViewMetaDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'value': value.value,
+    };
+}
+exports.OrderPageViewMetaDataToJSON = OrderPageViewMetaDataToJSON;

package/dist/models/OrderPageViewParam.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 OrderPageViewParam
+ */
+export interface OrderPageViewParam {
+    /**
+     * Query string parameter name
+     * @type {string}
+     * @memberof OrderPageViewParam
+     */
+    name?: string;
+    /**
+     * Query string parameter value
+     * @type {string}
+     * @memberof OrderPageViewParam
+     */
+    value?: string;
+}
+/**
+ * Check if a given object implements the OrderPageViewParam interface.
+ */
+export declare function instanceOfOrderPageViewParam(value: object): boolean;
+export declare function OrderPageViewParamFromJSON(json: any): OrderPageViewParam;
+export declare function OrderPageViewParamFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderPageViewParam;
+export declare function OrderPageViewParamToJSON(value?: OrderPageViewParam | null): any;

package/dist/models/OrderPageViewParam.js

@@ -0,0 +1,52 @@
+"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.OrderPageViewParamToJSON = exports.OrderPageViewParamFromJSONTyped = exports.OrderPageViewParamFromJSON = exports.instanceOfOrderPageViewParam = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the OrderPageViewParam interface.
+ */
+function instanceOfOrderPageViewParam(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfOrderPageViewParam = instanceOfOrderPageViewParam;
+function OrderPageViewParamFromJSON(json) {
+    return OrderPageViewParamFromJSONTyped(json, false);
+}
+exports.OrderPageViewParamFromJSON = OrderPageViewParamFromJSON;
+function OrderPageViewParamFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
+    };
+}
+exports.OrderPageViewParamFromJSONTyped = OrderPageViewParamFromJSONTyped;
+function OrderPageViewParamToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'value': value.value,
+    };
+}
+exports.OrderPageViewParamToJSON = OrderPageViewParamToJSON;

package/dist/models/index.d.ts

@@ -760,6 +760,10 @@ export * from './OrderItemTag';
 export * from './OrderLinkedShipment';
 export * from './OrderMarketing';
 export * from './OrderPackingSlipResponse';
+export * from './OrderPageView';
+export * from './OrderPageViewHistoryResponse';
+export * from './OrderPageViewMetaData';
+export * from './OrderPageViewParam';
 export * from './OrderPayment';
 export * from './OrderPaymentCheck';
 export * from './OrderPaymentCreditCard';

package/dist/models/index.js

@@ -778,6 +778,10 @@ __exportStar(require("./OrderItemTag"), exports);
 __exportStar(require("./OrderLinkedShipment"), exports);
 __exportStar(require("./OrderMarketing"), exports);
 __exportStar(require("./OrderPackingSlipResponse"), exports);
+__exportStar(require("./OrderPageView"), exports);
+__exportStar(require("./OrderPageViewHistoryResponse"), exports);
+__exportStar(require("./OrderPageViewMetaData"), exports);
+__exportStar(require("./OrderPageViewParam"), exports);
 __exportStar(require("./OrderPayment"), exports);
 __exportStar(require("./OrderPaymentCheck"), exports);
 __exportStar(require("./OrderPaymentCreditCard"), exports);

package/package.json

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

package/src/apis/OrderApi.ts

@@ -60,6 +60,9 @@ import {
     OrderPackingSlipResponse,
     OrderPackingSlipResponseFromJSON,
     OrderPackingSlipResponseToJSON,
+    OrderPageViewHistoryResponse,
+    OrderPageViewHistoryResponseFromJSON,
+    OrderPageViewHistoryResponseToJSON,
     OrderProcessPaymentRequest,
     OrderProcessPaymentRequestFromJSON,
     OrderProcessPaymentRequestToJSON,
@@ -185,6 +188,10 @@ export interface GetOrderEmailsRequest {
     orderId: string;
 }
 
+export interface GetOrderPageViewHistoryRequest {
+    orderId: string;
+}
+
 export interface GetOrderUpsellCartRequest {
     orderId: string;
     upsellCartRequest: OrderUpsellCartRequest;
@@ -635,6 +642,22 @@ export interface OrderApiInterface {
      */
     getOrderEmails(requestParameters: GetOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderEmailsResponse>;
 
+    /**
+     * Retrieves the page views captured during the session that placed this order. 
+     * @summary Retrieve page view history for this order.
+     * @param {string} orderId The order id to retrieve page view history for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getOrderPageViewHistoryRaw(requestParameters: GetOrderPageViewHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPageViewHistoryResponse>>;
+
+    /**
+     * Retrieves the page views captured during the session that placed this order. 
+     * Retrieve page view history for this order.
+     */
+    getOrderPageViewHistory(requestParameters: GetOrderPageViewHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPageViewHistoryResponse>;
+
     /**
      * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to 
      * @summary Get Order Upsell Cart
@@ -1818,6 +1841,47 @@ export class OrderApi extends runtime.BaseAPI implements OrderApiInterface {
         return await response.value();
     }
 
+    /**
+     * Retrieves the page views captured during the session that placed this order. 
+     * Retrieve page view history for this order.
+     */
+    async getOrderPageViewHistoryRaw(requestParameters: GetOrderPageViewHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPageViewHistoryResponse>> {
+        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+            throw new runtime.RequiredError('orderId','Required parameter requestParameters.orderId was null or undefined when calling getOrderPageViewHistory.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["order_read"]);
+        }
+
+        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: `/order/orders/{order_id}/page_view_history`.replace(`{${"order_id"}}`, encodeURIComponent(String(requestParameters.orderId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderPageViewHistoryResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves the page views captured during the session that placed this order. 
+     * Retrieve page view history for this order.
+     */
+    async getOrderPageViewHistory(requestParameters: GetOrderPageViewHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPageViewHistoryResponse> {
+        const response = await this.getOrderPageViewHistoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to 
      * Get Order Upsell Cart

package/src/models/OrderPageView.ts

@@ -0,0 +1,112 @@
+/* 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 {
+    OrderPageViewMetaData,
+    OrderPageViewMetaDataFromJSON,
+    OrderPageViewMetaDataFromJSONTyped,
+    OrderPageViewMetaDataToJSON,
+} from './OrderPageViewMetaData';
+import {
+    OrderPageViewParam,
+    OrderPageViewParamFromJSON,
+    OrderPageViewParamFromJSONTyped,
+    OrderPageViewParamToJSON,
+} from './OrderPageViewParam';
+
+/**
+ * 
+ * @export
+ * @interface OrderPageView
+ */
+export interface OrderPageView {
+    /**
+     * Meta tag name/value pairs captured on the page view
+     * @type {Array<OrderPageViewMetaData>}
+     * @memberof OrderPageView
+     */
+    meta_data?: Array<OrderPageViewMetaData>;
+    /**
+     * Query string parameters captured on the page view
+     * @type {Array<OrderPageViewParam>}
+     * @memberof OrderPageView
+     */
+    params?: Array<OrderPageViewParam>;
+    /**
+     * Time spent on the page in seconds
+     * @type {number}
+     * @memberof OrderPageView
+     */
+    time_on_page?: number;
+    /**
+     * URL of the page that was viewed
+     * @type {string}
+     * @memberof OrderPageView
+     */
+    url?: string;
+    /**
+     * Date/time the page was viewed
+     * @type {string}
+     * @memberof OrderPageView
+     */
+    view_dts?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the OrderPageView interface.
+ */
+export function instanceOfOrderPageView(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function OrderPageViewFromJSON(json: any): OrderPageView {
+    return OrderPageViewFromJSONTyped(json, false);
+}
+
+export function OrderPageViewFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderPageView {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'meta_data': !exists(json, 'meta_data') ? undefined : ((json['meta_data'] as Array<any>).map(OrderPageViewMetaDataFromJSON)),
+        'params': !exists(json, 'params') ? undefined : ((json['params'] as Array<any>).map(OrderPageViewParamFromJSON)),
+        'time_on_page': !exists(json, 'time_on_page') ? undefined : json['time_on_page'],
+        'url': !exists(json, 'url') ? undefined : json['url'],
+        'view_dts': !exists(json, 'view_dts') ? undefined : json['view_dts'],
+    };
+}
+
+export function OrderPageViewToJSON(value?: OrderPageView | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'meta_data': value.meta_data === undefined ? undefined : ((value.meta_data as Array<any>).map(OrderPageViewMetaDataToJSON)),
+        'params': value.params === undefined ? undefined : ((value.params as Array<any>).map(OrderPageViewParamToJSON)),
+        'time_on_page': value.time_on_page,
+        'url': value.url,
+        'view_dts': value.view_dts,
+    };
+}
+

package/src/models/OrderPageViewHistoryResponse.ts

@@ -0,0 +1,132 @@
+/* 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 {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    OrderPageView,
+    OrderPageViewFromJSON,
+    OrderPageViewFromJSONTyped,
+    OrderPageViewToJSON,
+} from './OrderPageView';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface OrderPageViewHistoryResponse
+ */
+export interface OrderPageViewHistoryResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Page views captured during the session that placed this order
+     * @type {Array<OrderPageView>}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    page_views?: Array<OrderPageView>;
+    /**
+     * HTTP referrer captured at the start of the session that placed this order
+     * @type {string}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    referrer?: string;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof OrderPageViewHistoryResponse
+     */
+    warning?: Warning;
+}
+
+
+
+/**
+ * Check if a given object implements the OrderPageViewHistoryResponse interface.
+ */
+export function instanceOfOrderPageViewHistoryResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function OrderPageViewHistoryResponseFromJSON(json: any): OrderPageViewHistoryResponse {
+    return OrderPageViewHistoryResponseFromJSONTyped(json, false);
+}
+
+export function OrderPageViewHistoryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderPageViewHistoryResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'page_views': !exists(json, 'page_views') ? undefined : ((json['page_views'] as Array<any>).map(OrderPageViewFromJSON)),
+        'referrer': !exists(json, 'referrer') ? undefined : json['referrer'],
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function OrderPageViewHistoryResponseToJSON(value?: OrderPageViewHistoryResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'page_views': value.page_views === undefined ? undefined : ((value.page_views as Array<any>).map(OrderPageViewToJSON)),
+        'referrer': value.referrer,
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/OrderPageViewMetaData.ts

@@ -0,0 +1,75 @@
+/* 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 OrderPageViewMetaData
+ */
+export interface OrderPageViewMetaData {
+    /**
+     * Meta tag name
+     * @type {string}
+     * @memberof OrderPageViewMetaData
+     */
+    name?: string;
+    /**
+     * Meta tag value
+     * @type {string}
+     * @memberof OrderPageViewMetaData
+     */
+    value?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the OrderPageViewMetaData interface.
+ */
+export function instanceOfOrderPageViewMetaData(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function OrderPageViewMetaDataFromJSON(json: any): OrderPageViewMetaData {
+    return OrderPageViewMetaDataFromJSONTyped(json, false);
+}
+
+export function OrderPageViewMetaDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderPageViewMetaData {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'value': !exists(json, 'value') ? undefined : json['value'],
+    };
+}
+
+export function OrderPageViewMetaDataToJSON(value?: OrderPageViewMetaData | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'value': value.value,
+    };
+}
+

package/src/models/OrderPageViewParam.ts

@@ -0,0 +1,75 @@
+/* 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 OrderPageViewParam
+ */
+export interface OrderPageViewParam {
+    /**
+     * Query string parameter name
+     * @type {string}
+     * @memberof OrderPageViewParam
+     */
+    name?: string;
+    /**
+     * Query string parameter value
+     * @type {string}
+     * @memberof OrderPageViewParam
+     */
+    value?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the OrderPageViewParam interface.
+ */
+export function instanceOfOrderPageViewParam(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function OrderPageViewParamFromJSON(json: any): OrderPageViewParam {
+    return OrderPageViewParamFromJSONTyped(json, false);
+}
+
+export function OrderPageViewParamFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderPageViewParam {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'value': !exists(json, 'value') ? undefined : json['value'],
+    };
+}
+
+export function OrderPageViewParamToJSON(value?: OrderPageViewParam | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'value': value.value,
+    };
+}
+

package/src/models/index.ts

@@ -762,6 +762,10 @@ export * from './OrderItemTag';
 export * from './OrderLinkedShipment';
 export * from './OrderMarketing';
 export * from './OrderPackingSlipResponse';
+export * from './OrderPageView';
+export * from './OrderPageViewHistoryResponse';
+export * from './OrderPageViewMetaData';
+export * from './OrderPageViewParam';
 export * from './OrderPayment';
 export * from './OrderPaymentCheck';
 export * from './OrderPaymentCreditCard';