ultracart_rest_api_v2_typescript 3.10.28 → 3.10.31

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.28
+## ultracart_rest_api_v2_typescript@3.10.31
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@3.10.28 --save
+npm install ultracart_rest_api_v2_typescript@3.10.31 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.31 | 08/02/2022 | storefront communication sequence test method |
+| 3.10.30 | 08/01/2022 | conversation event refinement |
+| 3.10.29 | 07/29/2022 | conversation development |
 | 3.10.28 | 07/28/2022 | conversation bug fixes |
 | 3.10.27 | 07/28/2022 | conversation message upload keys property |
 | 3.10.26 | 07/26/2022 | conversations - queue statistics |

package/api.ts

@@ -6329,10 +6329,10 @@ export interface ConversationAgentAuth {
     merchant_id?: string;
     /**
      * 
-     * @type {Array<string>}
+     * @type {Array<ConversationTwilioAccount>}
      * @memberof ConversationAgentAuth
      */
-    twilio_phone_numbers?: Array<string>;
+    twilio_accounts?: Array<ConversationTwilioAccount>;
     /**
      * 
      * @type {string}
@@ -6399,6 +6399,71 @@ export interface ConversationEventQueuePosition {
     position?: number;
 }
 
+/**
+ * 
+ * @export
+ * @interface ConversationEventRRWeb
+ */
+export interface ConversationEventRRWeb {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationEventRRWeb
+     */
+    data?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationEventRRWeb
+     */
+    data_part?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationEventRRWeb
+     */
+    data_sha256?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationEventRRWeb
+     */
+    data_total_parts?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationEventRRWeb
+     */
+    data_total_sha256?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationEventRRWeb
+     */
+    event_index?: number;
+    /**
+     * Type of event
+     * @type {string}
+     * @memberof ConversationEventRRWeb
+     */
+    type?: ConversationEventRRWeb.TypeEnum;
+}
+
+/**
+ * @export
+ * @namespace ConversationEventRRWeb
+ */
+export namespace ConversationEventRRWeb {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum TypeEnum {
+        Init = <any> 'init',
+        Events = <any> 'events'
+    }
+}
+
 /**
  * 
  * @export
@@ -6423,6 +6488,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     body?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationMessage
+     */
+    client_message_id?: string;
     /**
      * 
      * @type {Array<string>}
@@ -6441,6 +6512,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     transport_statuses?: Array<ConversationMessageTransportStatus>;
+    /**
+     * Message type
+     * @type {string}
+     * @memberof ConversationMessage
+     */
+    type?: ConversationMessage.TypeEnum;
     /**
      * 
      * @type {Array<string>}
@@ -6449,6 +6526,21 @@ export interface ConversationMessage {
     upload_keys?: Array<string>;
 }
 
+/**
+ * @export
+ * @namespace ConversationMessage
+ */
+export namespace ConversationMessage {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum TypeEnum {
+        Message = <any> 'message',
+        Notice = <any> 'notice'
+    }
+}
+
 /**
  * 
  * @export
@@ -6715,12 +6807,44 @@ export interface ConversationSummary {
      * @memberof ConversationSummary
      */
     message_count?: number;
+    /**
+     * Start of the conversation date/time
+     * @type {string}
+     * @memberof ConversationSummary
+     */
+    start_dts?: string;
     /**
      * 
      * @type {boolean}
      * @memberof ConversationSummary
      */
     unread_messages?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ConversationSummary
+     */
+    visible?: boolean;
+}
+
+/**
+ * 
+ * @export
+ * @interface ConversationTwilioAccount
+ */
+export interface ConversationTwilioAccount {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationTwilioAccount
+     */
+    merchant_id?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ConversationTwilioAccount
+     */
+    twilio_phone_numbers?: Array<string>;
 }
 
 /**
@@ -6997,6 +7121,12 @@ export interface ConversationWebsocketMessage {
      * @memberof ConversationWebsocketMessage
      */
     event_queue_status_update?: ConversationWebchatQueueStatus;
+    /**
+     * 
+     * @type {ConversationEventRRWeb}
+     * @memberof ConversationWebsocketMessage
+     */
+    event_rrweb?: ConversationEventRRWeb;
     /**
      * Type of event
      * @type {string}
@@ -7039,7 +7169,8 @@ export namespace ConversationWebsocketMessage {
         NewConversation = <any> 'new conversation',
         NewMessage = <any> 'new message',
         UpdatedMessage = <any> 'updated message',
-        QueueStatusUpdate = <any> 'queue status update'
+        QueueStatusUpdate = <any> 'queue status update',
+        Rrweb = <any> 'rrweb'
     }
     /**
      * @export
@@ -7048,7 +7179,8 @@ export namespace ConversationWebsocketMessage {
     export enum TypeEnum {
         Message = <any> 'message',
         Event = <any> 'event',
-        Ping = <any> 'ping'
+        Ping = <any> 'ping',
+        CheckQueuePosition = <any> 'check queue position'
     }
 }
 
@@ -12725,6 +12857,94 @@ export interface EmailCommseqResponse {
     warning?: Warning;
 }
 
+/**
+ * 
+ * @export
+ * @interface EmailCommseqSequenceTestRequest
+ */
+export interface EmailCommseqSequenceTestRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    cart_id?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    cart_item_ids?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    esp_commseq_uuid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    order_id?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    please_review?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    send_to_email?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    send_to_logged_in_user?: boolean;
+}
+
+/**
+ * 
+ * @export
+ * @interface EmailCommseqSequenceTestResponse
+ */
+export interface EmailCommseqSequenceTestResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof EmailCommseqSequenceTestResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof EmailCommseqSequenceTestResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof EmailCommseqSequenceTestResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof EmailCommseqSequenceTestResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -60759,6 +60979,81 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 
+         * @summary Sequence test
+         * @param {number} storefront_oid 
+         * @param {string} commseq_uuid 
+         * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options: any = {}): FetchArgs {
+            // verify required parameter 'storefront_oid' is not null or undefined
+            if (storefront_oid === null || storefront_oid === undefined) {
+                throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling sequenceTest.');
+            }
+            // verify required parameter 'commseq_uuid' is not null or undefined
+            if (commseq_uuid === null || commseq_uuid === undefined) {
+                throw new RequiredError('commseq_uuid','Required parameter commseq_uuid was null or undefined when calling sequenceTest.');
+            }
+            // verify required parameter 'email_commseq_sequence_test_request' is not null or undefined
+            if (email_commseq_sequence_test_request === null || email_commseq_sequence_test_request === undefined) {
+                throw new RequiredError('email_commseq_sequence_test_request','Required parameter email_commseq_sequence_test_request was null or undefined when calling sequenceTest.');
+            }
+            const localVarPath = `/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test`
+                .replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
+                .replace(`{${"commseq_uuid"}}`, encodeURIComponent(String(commseq_uuid)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
+            // authentication ultraCartBrowserApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-browser-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
+            }
+
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["storefront_write"])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            const needsSerialization = (<any>"EmailCommseqSequenceTestRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify(email_commseq_sequence_test_request || {}) : (email_commseq_sequence_test_request || "");
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Start email campaign
@@ -65626,6 +65921,29 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * 
+         * @summary Sequence test
+         * @param {number} storefront_oid 
+         * @param {string} commseq_uuid 
+         * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqSequenceTestResponse> {
+            const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).sequenceTest(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * 
          * @summary Start email campaign
@@ -67725,6 +68043,18 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
         sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any) {
             return StorefrontApiFp(configuration).sendWebhookTest(storefront_oid, email_commseq_webhook_test_request, options)(fetch, basePath);
         },
+        /**
+         * 
+         * @summary Sequence test
+         * @param {number} storefront_oid 
+         * @param {string} commseq_uuid 
+         * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options?: any) {
+            return StorefrontApiFp(configuration).sequenceTest(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options)(fetch, basePath);
+        },
         /**
          * 
          * @summary Start email campaign
@@ -69538,6 +69868,18 @@ export interface StorefrontApiInterface {
      */
     sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
 
+    /**
+     * 
+     * @summary Sequence test
+     * @param {number} storefront_oid 
+     * @param {string} commseq_uuid 
+     * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options?: any): Promise<EmailCommseqSequenceTestResponse>;
+
     /**
      * 
      * @summary Start email campaign
@@ -71623,6 +71965,20 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
         return StorefrontApiFp(this.configuration).sendWebhookTest(storefront_oid, email_commseq_webhook_test_request, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * 
+     * @summary Sequence test
+     * @param {number} storefront_oid 
+     * @param {string} commseq_uuid 
+     * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    public sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options?: any) {
+        return StorefrontApiFp(this.configuration).sequenceTest(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options)(this.fetch, this.basePath);
+    }
+
     /**
      * 
      * @summary Start email campaign

package/dist/api.d.ts

@@ -6181,10 +6181,10 @@ export interface ConversationAgentAuth {
     merchant_id?: string;
     /**
      *
-     * @type {Array<string>}
+     * @type {Array<ConversationTwilioAccount>}
      * @memberof ConversationAgentAuth
      */
-    twilio_phone_numbers?: Array<string>;
+    twilio_accounts?: Array<ConversationTwilioAccount>;
     /**
      *
      * @type {string}
@@ -6248,6 +6248,69 @@ export interface ConversationEventQueuePosition {
      */
     position?: number;
 }
+/**
+ *
+ * @export
+ * @interface ConversationEventRRWeb
+ */
+export interface ConversationEventRRWeb {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationEventRRWeb
+     */
+    data?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationEventRRWeb
+     */
+    data_part?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationEventRRWeb
+     */
+    data_sha256?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationEventRRWeb
+     */
+    data_total_parts?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationEventRRWeb
+     */
+    data_total_sha256?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationEventRRWeb
+     */
+    event_index?: number;
+    /**
+     * Type of event
+     * @type {string}
+     * @memberof ConversationEventRRWeb
+     */
+    type?: ConversationEventRRWeb.TypeEnum;
+}
+/**
+ * @export
+ * @namespace ConversationEventRRWeb
+ */
+export declare namespace ConversationEventRRWeb {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum TypeEnum {
+        Init,
+        Events
+    }
+}
 /**
  *
  * @export
@@ -6272,6 +6335,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     body?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationMessage
+     */
+    client_message_id?: string;
     /**
      *
      * @type {Array<string>}
@@ -6290,6 +6359,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     transport_statuses?: Array<ConversationMessageTransportStatus>;
+    /**
+     * Message type
+     * @type {string}
+     * @memberof ConversationMessage
+     */
+    type?: ConversationMessage.TypeEnum;
     /**
      *
      * @type {Array<string>}
@@ -6297,6 +6372,20 @@ export interface ConversationMessage {
      */
     upload_keys?: Array<string>;
 }
+/**
+ * @export
+ * @namespace ConversationMessage
+ */
+export declare namespace ConversationMessage {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum TypeEnum {
+        Message,
+        Notice
+    }
+}
 /**
  *
  * @export
@@ -6556,12 +6645,43 @@ export interface ConversationSummary {
      * @memberof ConversationSummary
      */
     message_count?: number;
+    /**
+     * Start of the conversation date/time
+     * @type {string}
+     * @memberof ConversationSummary
+     */
+    start_dts?: string;
     /**
      *
      * @type {boolean}
      * @memberof ConversationSummary
      */
     unread_messages?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ConversationSummary
+     */
+    visible?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface ConversationTwilioAccount
+ */
+export interface ConversationTwilioAccount {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationTwilioAccount
+     */
+    merchant_id?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ConversationTwilioAccount
+     */
+    twilio_phone_numbers?: Array<string>;
 }
 /**
  *
@@ -6832,6 +6952,12 @@ export interface ConversationWebsocketMessage {
      * @memberof ConversationWebsocketMessage
      */
     event_queue_status_update?: ConversationWebchatQueueStatus;
+    /**
+     *
+     * @type {ConversationEventRRWeb}
+     * @memberof ConversationWebsocketMessage
+     */
+    event_rrweb?: ConversationEventRRWeb;
     /**
      * Type of event
      * @type {string}
@@ -6873,7 +6999,8 @@ export declare namespace ConversationWebsocketMessage {
         NewConversation,
         NewMessage,
         UpdatedMessage,
-        QueueStatusUpdate
+        QueueStatusUpdate,
+        Rrweb
     }
     /**
      * @export
@@ -6882,7 +7009,8 @@ export declare namespace ConversationWebsocketMessage {
     enum TypeEnum {
         Message,
         Event,
-        Ping
+        Ping,
+        CheckQueuePosition
     }
 }
 /**
@@ -12434,6 +12562,92 @@ export interface EmailCommseqResponse {
      */
     warning?: Warning;
 }
+/**
+ *
+ * @export
+ * @interface EmailCommseqSequenceTestRequest
+ */
+export interface EmailCommseqSequenceTestRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    cart_id?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    cart_item_ids?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    esp_commseq_uuid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    order_id?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    please_review?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    send_to_email?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof EmailCommseqSequenceTestRequest
+     */
+    send_to_logged_in_user?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface EmailCommseqSequenceTestResponse
+ */
+export interface EmailCommseqSequenceTestResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof EmailCommseqSequenceTestResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof EmailCommseqSequenceTestResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof EmailCommseqSequenceTestResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof EmailCommseqSequenceTestResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -41849,6 +42063,16 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): FetchArgs;
+    /**
+     *
+     * @summary Sequence test
+     * @param {number} storefront_oid
+     * @param {string} commseq_uuid
+     * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options?: any): FetchArgs;
     /**
      *
      * @summary Start email campaign
@@ -43335,6 +43559,16 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqWebhookSendTestResponse>;
+    /**
+     *
+     * @summary Sequence test
+     * @param {number} storefront_oid
+     * @param {string} commseq_uuid
+     * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqSequenceTestResponse>;
     /**
      *
      * @summary Start email campaign
@@ -44821,6 +45055,16 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
      * @throws {RequiredError}
      */
     sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
+    /**
+     *
+     * @summary Sequence test
+     * @param {number} storefront_oid
+     * @param {string} commseq_uuid
+     * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options?: any): Promise<EmailCommseqSequenceTestResponse>;
     /**
      *
      * @summary Start email campaign
@@ -46444,6 +46688,17 @@ export interface StorefrontApiInterface {
      * @memberof StorefrontApiInterface
      */
     sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
+    /**
+     *
+     * @summary Sequence test
+     * @param {number} storefront_oid
+     * @param {string} commseq_uuid
+     * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options?: any): Promise<EmailCommseqSequenceTestResponse>;
     /**
      *
      * @summary Start email campaign
@@ -48094,6 +48349,17 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
      * @memberof StorefrontApi
      */
     sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
+    /**
+     *
+     * @summary Sequence test
+     * @param {number} storefront_oid
+     * @param {string} commseq_uuid
+     * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    sequenceTest(storefront_oid: number, commseq_uuid: string, email_commseq_sequence_test_request: EmailCommseqSequenceTestRequest, options?: any): Promise<EmailCommseqSequenceTestResponse>;
     /**
      *
      * @summary Start email campaign

package/dist/api.js

@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
-exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = void 0;
-exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = void 0;
+exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
+exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = void 0;
+exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = void 0;
 var url = require("url");
 var portableFetch = require("portable-fetch");
 var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -359,6 +359,38 @@ var CheckoutHandoffRequest;
         OperationEnum[OperationEnum["Sezzle"] = 'sezzle'] = "Sezzle";
     })(OperationEnum = CheckoutHandoffRequest.OperationEnum || (CheckoutHandoffRequest.OperationEnum = {}));
 })(CheckoutHandoffRequest = exports.CheckoutHandoffRequest || (exports.CheckoutHandoffRequest = {}));
+/**
+ * @export
+ * @namespace ConversationEventRRWeb
+ */
+var ConversationEventRRWeb;
+(function (ConversationEventRRWeb) {
+    /**
+     * @export
+     * @enum {string}
+     */
+    var TypeEnum;
+    (function (TypeEnum) {
+        TypeEnum[TypeEnum["Init"] = 'init'] = "Init";
+        TypeEnum[TypeEnum["Events"] = 'events'] = "Events";
+    })(TypeEnum = ConversationEventRRWeb.TypeEnum || (ConversationEventRRWeb.TypeEnum = {}));
+})(ConversationEventRRWeb = exports.ConversationEventRRWeb || (exports.ConversationEventRRWeb = {}));
+/**
+ * @export
+ * @namespace ConversationMessage
+ */
+var ConversationMessage;
+(function (ConversationMessage) {
+    /**
+     * @export
+     * @enum {string}
+     */
+    var TypeEnum;
+    (function (TypeEnum) {
+        TypeEnum[TypeEnum["Message"] = 'message'] = "Message";
+        TypeEnum[TypeEnum["Notice"] = 'notice'] = "Notice";
+    })(TypeEnum = ConversationMessage.TypeEnum || (ConversationMessage.TypeEnum = {}));
+})(ConversationMessage = exports.ConversationMessage || (exports.ConversationMessage = {}));
 /**
  * @export
  * @namespace ConversationWebsocketMessage
@@ -378,6 +410,7 @@ var ConversationWebsocketMessage;
         EventTypeEnum[EventTypeEnum["NewMessage"] = 'new message'] = "NewMessage";
         EventTypeEnum[EventTypeEnum["UpdatedMessage"] = 'updated message'] = "UpdatedMessage";
         EventTypeEnum[EventTypeEnum["QueueStatusUpdate"] = 'queue status update'] = "QueueStatusUpdate";
+        EventTypeEnum[EventTypeEnum["Rrweb"] = 'rrweb'] = "Rrweb";
     })(EventTypeEnum = ConversationWebsocketMessage.EventTypeEnum || (ConversationWebsocketMessage.EventTypeEnum = {}));
     /**
      * @export
@@ -388,6 +421,7 @@ var ConversationWebsocketMessage;
         TypeEnum[TypeEnum["Message"] = 'message'] = "Message";
         TypeEnum[TypeEnum["Event"] = 'event'] = "Event";
         TypeEnum[TypeEnum["Ping"] = 'ping'] = "Ping";
+        TypeEnum[TypeEnum["CheckQueuePosition"] = 'check queue position'] = "CheckQueuePosition";
     })(TypeEnum = ConversationWebsocketMessage.TypeEnum || (ConversationWebsocketMessage.TypeEnum = {}));
 })(ConversationWebsocketMessage = exports.ConversationWebsocketMessage || (exports.ConversationWebsocketMessage = {}));
 /**
@@ -24163,6 +24197,73 @@ var StorefrontApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Sequence test
+         * @param {number} storefront_oid
+         * @param {string} commseq_uuid
+         * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sequenceTest: function (storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'storefront_oid' is not null or undefined
+            if (storefront_oid === null || storefront_oid === undefined) {
+                throw new RequiredError('storefront_oid', 'Required parameter storefront_oid was null or undefined when calling sequenceTest.');
+            }
+            // verify required parameter 'commseq_uuid' is not null or undefined
+            if (commseq_uuid === null || commseq_uuid === undefined) {
+                throw new RequiredError('commseq_uuid', 'Required parameter commseq_uuid was null or undefined when calling sequenceTest.');
+            }
+            // verify required parameter 'email_commseq_sequence_test_request' is not null or undefined
+            if (email_commseq_sequence_test_request === null || email_commseq_sequence_test_request === undefined) {
+                throw new RequiredError('email_commseq_sequence_test_request', 'Required parameter email_commseq_sequence_test_request was null or undefined when calling sequenceTest.');
+            }
+            var localVarPath = "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test"
+                .replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)))
+                .replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(commseq_uuid)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartBrowserApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-browser-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["storefront_write"])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            var needsSerialization = ("EmailCommseqSequenceTestRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body = needsSerialization ? JSON.stringify(email_commseq_sequence_test_request || {}) : (email_commseq_sequence_test_request || "");
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary Start email campaign
@@ -28963,6 +29064,30 @@ var StorefrontApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         *
+         * @summary Sequence test
+         * @param {number} storefront_oid
+         * @param {string} commseq_uuid
+         * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sequenceTest: function (storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options) {
+            var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).sequenceTest(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          *
          * @summary Start email campaign
@@ -31088,6 +31213,18 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
         sendWebhookTest: function (storefront_oid, email_commseq_webhook_test_request, options) {
             return (0, exports.StorefrontApiFp)(configuration).sendWebhookTest(storefront_oid, email_commseq_webhook_test_request, options)(fetch, basePath);
         },
+        /**
+         *
+         * @summary Sequence test
+         * @param {number} storefront_oid
+         * @param {string} commseq_uuid
+         * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sequenceTest: function (storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options) {
+            return (0, exports.StorefrontApiFp)(configuration).sequenceTest(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options)(fetch, basePath);
+        },
         /**
          *
          * @summary Start email campaign
@@ -33042,6 +33179,19 @@ var StorefrontApi = /** @class */ (function (_super) {
     StorefrontApi.prototype.sendWebhookTest = function (storefront_oid, email_commseq_webhook_test_request, options) {
         return (0, exports.StorefrontApiFp)(this.configuration).sendWebhookTest(storefront_oid, email_commseq_webhook_test_request, options)(this.fetch, this.basePath);
     };
+    /**
+     *
+     * @summary Sequence test
+     * @param {number} storefront_oid
+     * @param {string} commseq_uuid
+     * @param {EmailCommseqSequenceTestRequest} email_commseq_sequence_test_request Commseq test request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    StorefrontApi.prototype.sequenceTest = function (storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options) {
+        return (0, exports.StorefrontApiFp)(this.configuration).sequenceTest(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, options)(this.fetch, this.basePath);
+    };
     /**
      *
      * @summary Start email campaign

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.10.28",
+  "version": "3.10.31",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [