ultracart_rest_api_v2_typescript 3.10.43 → 3.10.46

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.43
+## ultracart_rest_api_v2_typescript@3.10.46
 
 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.43 --save
+npm install ultracart_rest_api_v2_typescript@3.10.46 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.46 | 09/13/2022 | storefront comms - postcard tracking |
+| 3.10.45 | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
+| 3.10.44 | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
 | 3.10.43 | 09/02/2022 | customer editor added loyal ledger descriptions |
 | 3.10.42 | 08/30/2022 | storefront comm fields for sms configuration |
 | 3.10.41 | 08/26/2022 | postcard address fields for comm sequence testing |

package/api.ts

@@ -16008,6 +16008,202 @@ export interface EmailPostcardStat {
     view_count_formatted?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface EmailPostcardTracking
+ */
+export interface EmailPostcardTracking {
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    commseq_postcard_uuid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    commseq_step_uuid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    commseq_uuid?: string;
+    /**
+     * Conversion date time.
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    conversion_dts?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof EmailPostcardTracking
+     */
+    cost?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    customer_uuid?: string;
+    /**
+     * Delivered date time.
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    delivered_dts?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_address_line1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_address_line2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_city?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_state?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_zip?: string;
+    /**
+     * Mailed date time.
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    mailed_dts?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    order_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    postcard_tracking_uuid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    status?: string;
+    /**
+     * Submit date time.
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    submit_dts?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_address_line1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_address_line2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_city?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_state?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_zip?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    tracking_description?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface EmailPostcardTrackingResponse
+ */
+export interface EmailPostcardTrackingResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {EmailPostcardTracking}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    tracking?: EmailPostcardTracking;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -16518,6 +16714,12 @@ export interface EmailSettings {
      * @memberof EmailSettings
      */
     postcard_from_state?: string;
+    /**
+     * True if the Reviews.io integration is configured
+     * @type {boolean}
+     * @memberof EmailSettings
+     */
+    reviews_io_configured?: boolean;
     /**
      * 
      * @type {string}
@@ -29291,6 +29493,40 @@ export interface ResultSet {
     total_records?: number;
 }
 
+/**
+ * 
+ * @export
+ * @interface RulerValidationRequest
+ */
+export interface RulerValidationRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof RulerValidationRequest
+     */
+    ruler?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface RulerValidationResponse
+ */
+export interface RulerValidationResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof RulerValidationResponse
+     */
+    error_message?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RulerValidationResponse
+     */
+    valid?: boolean;
+}
+
 /**
  * 
  * @export
@@ -55491,6 +55727,72 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 
+         * @summary Get email communication postcard tracking
+         * @param {number} storefront_oid 
+         * @param {string} commseq_postcard_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, 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 getEmailCommseqPostcardTracking.');
+            }
+            // verify required parameter 'commseq_postcard_uuid' is not null or undefined
+            if (commseq_postcard_uuid === null || commseq_postcard_uuid === undefined) {
+                throw new RequiredError('commseq_postcard_uuid','Required parameter commseq_postcard_uuid was null or undefined when calling getEmailCommseqPostcardTracking.');
+            }
+            const localVarPath = `/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking`
+                .replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
+                .replace(`{${"commseq_postcard_uuid"}}`, encodeURIComponent(String(commseq_postcard_uuid)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, 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_read"])
+					: 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;
+            }
+
+            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);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Get communication sequence stats overall
@@ -63846,6 +64148,69 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
             const needsSerialization = (<any>"Twilio" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
             localVarRequestOptions.body =  needsSerialization ? JSON.stringify(twilio || {}) : (twilio || "");
 
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Validate AWS Event Ruler
+         * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        validateRuler(ruler_validate_request: RulerValidationRequest, options: any = {}): FetchArgs {
+            // verify required parameter 'ruler_validate_request' is not null or undefined
+            if (ruler_validate_request === null || ruler_validate_request === undefined) {
+                throw new RequiredError('ruler_validate_request','Required parameter ruler_validate_request was null or undefined when calling validateRuler.');
+            }
+            const localVarPath = `/storefront/ruler/validate`;
+            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>"RulerValidationRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify(ruler_validate_request || {}) : (ruler_validate_request || "");
+
             return {
                 url: url.format(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -64732,6 +65097,28 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * 
+         * @summary Get email communication postcard tracking
+         * @param {number} storefront_oid 
+         * @param {string} commseq_postcard_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailPostcardTrackingResponse> {
+            const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, 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 Get communication sequence stats overall
@@ -67489,6 +67876,27 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * 
+         * @summary Validate AWS Event Ruler
+         * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        validateRuler(ruler_validate_request: RulerValidationRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<RulerValidationResponse> {
+            const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).validateRuler(ruler_validate_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;
+                    }
+                });
+            };
+        },
     }
 };
 
@@ -67930,6 +68338,17 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
         getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any) {
             return StorefrontApiFp(configuration).getEmailCommseqPostcardStats(storefront_oid, commseq_uuid, statsRequest, options)(fetch, basePath);
         },
+        /**
+         * 
+         * @summary Get email communication postcard tracking
+         * @param {number} storefront_oid 
+         * @param {string} commseq_postcard_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any) {
+            return StorefrontApiFp(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(fetch, basePath);
+        },
         /**
          * 
          * @summary Get communication sequence stats overall
@@ -69323,6 +69742,16 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
         updateTwilioAccount(esp_twilio_uuid: string, twilio: Twilio, options?: any) {
             return StorefrontApiFp(configuration).updateTwilioAccount(esp_twilio_uuid, twilio, options)(fetch, basePath);
         },
+        /**
+         * 
+         * @summary Validate AWS Event Ruler
+         * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        validateRuler(ruler_validate_request: RulerValidationRequest, options?: any) {
+            return StorefrontApiFp(configuration).validateRuler(ruler_validate_request, options)(fetch, basePath);
+        },
     };
 };
 
@@ -69764,6 +70193,17 @@ export interface StorefrontApiInterface {
      */
     getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): Promise<EmailStatPostcardSummaryResponse>;
 
+    /**
+     * 
+     * @summary Get email communication postcard tracking
+     * @param {number} storefront_oid 
+     * @param {string} commseq_postcard_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
+
     /**
      * 
      * @summary Get communication sequence stats overall
@@ -71157,6 +71597,16 @@ export interface StorefrontApiInterface {
      */
     updateTwilioAccount(esp_twilio_uuid: string, twilio: Twilio, options?: any): Promise<TwilioResponse>;
 
+    /**
+     * 
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    validateRuler(ruler_validate_request: RulerValidationRequest, options?: any): Promise<RulerValidationResponse>;
+
 }
 
 /**
@@ -71678,6 +72128,19 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
         return StorefrontApiFp(this.configuration).getEmailCommseqPostcardStats(storefront_oid, commseq_uuid, statsRequest, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * 
+     * @summary Get email communication postcard tracking
+     * @param {number} storefront_oid 
+     * @param {string} commseq_postcard_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    public getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any) {
+        return StorefrontApiFp(this.configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * 
      * @summary Get communication sequence stats overall
@@ -73319,6 +73782,18 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
         return StorefrontApiFp(this.configuration).updateTwilioAccount(esp_twilio_uuid, twilio, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * 
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    public validateRuler(ruler_validate_request: RulerValidationRequest, options?: any) {
+        return StorefrontApiFp(this.configuration).validateRuler(ruler_validate_request, options)(this.fetch, this.basePath);
+    }
+
 }
 
 /**

package/dist/api.d.ts

@@ -15649,6 +15649,200 @@ export interface EmailPostcardStat {
      */
     view_count_formatted?: string;
 }
+/**
+ *
+ * @export
+ * @interface EmailPostcardTracking
+ */
+export interface EmailPostcardTracking {
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    commseq_postcard_uuid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    commseq_step_uuid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    commseq_uuid?: string;
+    /**
+     * Conversion date time.
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    conversion_dts?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof EmailPostcardTracking
+     */
+    cost?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    customer_uuid?: string;
+    /**
+     * Delivered date time.
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    delivered_dts?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_address_line1?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_address_line2?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_city?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_state?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    from_zip?: string;
+    /**
+     * Mailed date time.
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    mailed_dts?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    order_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    postcard_tracking_uuid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    status?: string;
+    /**
+     * Submit date time.
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    submit_dts?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_address_line1?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_address_line2?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_city?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_state?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    to_zip?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailPostcardTracking
+     */
+    tracking_description?: string;
+}
+/**
+ *
+ * @export
+ * @interface EmailPostcardTrackingResponse
+ */
+export interface EmailPostcardTrackingResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {EmailPostcardTracking}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    tracking?: EmailPostcardTracking;
+    /**
+     *
+     * @type {Warning}
+     * @memberof EmailPostcardTrackingResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -16150,6 +16344,12 @@ export interface EmailSettings {
      * @memberof EmailSettings
      */
     postcard_from_state?: string;
+    /**
+     * True if the Reviews.io integration is configured
+     * @type {boolean}
+     * @memberof EmailSettings
+     */
+    reviews_io_configured?: boolean;
     /**
      *
      * @type {string}
@@ -28677,6 +28877,38 @@ export interface ResultSet {
      */
     total_records?: number;
 }
+/**
+ *
+ * @export
+ * @interface RulerValidationRequest
+ */
+export interface RulerValidationRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof RulerValidationRequest
+     */
+    ruler?: string;
+}
+/**
+ *
+ * @export
+ * @interface RulerValidationResponse
+ */
+export interface RulerValidationResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof RulerValidationResponse
+     */
+    error_message?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RulerValidationResponse
+     */
+    valid?: boolean;
+}
 /**
  *
  * @export
@@ -41982,6 +42214,15 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): FetchArgs;
+    /**
+     *
+     * @summary Get email communication postcard tracking
+     * @param {number} storefront_oid
+     * @param {string} commseq_postcard_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): FetchArgs;
     /**
      *
      * @summary Get communication sequence stats overall
@@ -43127,6 +43368,14 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     updateTwilioAccount(esp_twilio_uuid: string, twilio: Twilio, options?: any): FetchArgs;
+    /**
+     *
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateRuler(ruler_validate_request: RulerValidationRequest, options?: any): FetchArgs;
 };
 /**
  * StorefrontApi - functional programming interface
@@ -43485,6 +43734,15 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailStatPostcardSummaryResponse>;
+    /**
+     *
+     * @summary Get email communication postcard tracking
+     * @param {number} storefront_oid
+     * @param {string} commseq_postcard_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailPostcardTrackingResponse>;
     /**
      *
      * @summary Get communication sequence stats overall
@@ -44630,6 +44888,14 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateTwilioAccount(esp_twilio_uuid: string, twilio: Twilio, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<TwilioResponse>;
+    /**
+     *
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateRuler(ruler_validate_request: RulerValidationRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<RulerValidationResponse>;
 };
 /**
  * StorefrontApi - factory interface
@@ -44988,6 +45254,15 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
      * @throws {RequiredError}
      */
     getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): Promise<EmailStatPostcardSummaryResponse>;
+    /**
+     *
+     * @summary Get email communication postcard tracking
+     * @param {number} storefront_oid
+     * @param {string} commseq_postcard_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
     /**
      *
      * @summary Get communication sequence stats overall
@@ -46133,6 +46408,14 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
      * @throws {RequiredError}
      */
     updateTwilioAccount(esp_twilio_uuid: string, twilio: Twilio, options?: any): Promise<TwilioResponse>;
+    /**
+     *
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateRuler(ruler_validate_request: RulerValidationRequest, options?: any): Promise<RulerValidationResponse>;
 };
 /**
  * StorefrontApi - interface
@@ -46532,6 +46815,16 @@ export interface StorefrontApiInterface {
      * @memberof StorefrontApiInterface
      */
     getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): Promise<EmailStatPostcardSummaryResponse>;
+    /**
+     *
+     * @summary Get email communication postcard tracking
+     * @param {number} storefront_oid
+     * @param {string} commseq_postcard_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
     /**
      *
      * @summary Get communication sequence stats overall
@@ -47801,6 +48094,15 @@ export interface StorefrontApiInterface {
      * @memberof StorefrontApiInterface
      */
     updateTwilioAccount(esp_twilio_uuid: string, twilio: Twilio, options?: any): Promise<TwilioResponse>;
+    /**
+     *
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    validateRuler(ruler_validate_request: RulerValidationRequest, options?: any): Promise<RulerValidationResponse>;
 }
 /**
  * StorefrontApi - object-oriented interface
@@ -48201,6 +48503,16 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
      * @memberof StorefrontApi
      */
     getEmailCommseqPostcardStats(storefront_oid: number, commseq_uuid: string, statsRequest: EmailStatPostcardSummaryRequest, options?: any): Promise<EmailStatPostcardSummaryResponse>;
+    /**
+     *
+     * @summary Get email communication postcard tracking
+     * @param {number} storefront_oid
+     * @param {string} commseq_postcard_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    getEmailCommseqPostcardTracking(storefront_oid: number, commseq_postcard_uuid: string, options?: any): Promise<EmailPostcardTrackingResponse>;
     /**
      *
      * @summary Get communication sequence stats overall
@@ -49470,6 +49782,15 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
      * @memberof StorefrontApi
      */
     updateTwilioAccount(esp_twilio_uuid: string, twilio: Twilio, options?: any): Promise<TwilioResponse>;
+    /**
+     *
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    validateRuler(ruler_validate_request: RulerValidationRequest, options?: any): Promise<RulerValidationResponse>;
 }
 /**
  * TaxApi - fetch parameter creator

package/dist/api.js

@@ -18751,6 +18751,65 @@ var StorefrontApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Get email communication postcard tracking
+         * @param {number} storefront_oid
+         * @param {string} commseq_postcard_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqPostcardTracking: function (storefront_oid, commseq_postcard_uuid, 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 getEmailCommseqPostcardTracking.');
+            }
+            // verify required parameter 'commseq_postcard_uuid' is not null or undefined
+            if (commseq_postcard_uuid === null || commseq_postcard_uuid === undefined) {
+                throw new RequiredError('commseq_postcard_uuid', 'Required parameter commseq_postcard_uuid was null or undefined when calling getEmailCommseqPostcardTracking.');
+            }
+            var localVarPath = "/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking"
+                .replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)))
+                .replace("{".concat("commseq_postcard_uuid", "}"), encodeURIComponent(String(commseq_postcard_uuid)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'GET' }, 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_read"])
+                    : 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;
+            }
+            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);
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary Get communication sequence stats overall
@@ -26156,6 +26215,61 @@ var StorefrontApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Validate AWS Event Ruler
+         * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        validateRuler: function (ruler_validate_request, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'ruler_validate_request' is not null or undefined
+            if (ruler_validate_request === null || ruler_validate_request === undefined) {
+                throw new RequiredError('ruler_validate_request', 'Required parameter ruler_validate_request was null or undefined when calling validateRuler.');
+            }
+            var localVarPath = "/storefront/ruler/validate";
+            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 = ("RulerValidationRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body = needsSerialization ? JSON.stringify(ruler_validate_request || {}) : (ruler_validate_request || "");
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
     };
 };
 exports.StorefrontApiFetchParamCreator = StorefrontApiFetchParamCreator;
@@ -27077,6 +27191,29 @@ var StorefrontApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         *
+         * @summary Get email communication postcard tracking
+         * @param {number} storefront_oid
+         * @param {string} commseq_postcard_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqPostcardTracking: function (storefront_oid, commseq_postcard_uuid, options) {
+            var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, 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 Get communication sequence stats overall
@@ -29958,6 +30095,28 @@ var StorefrontApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         *
+         * @summary Validate AWS Event Ruler
+         * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        validateRuler: function (ruler_validate_request, options) {
+            var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).validateRuler(ruler_validate_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;
+                    }
+                });
+            };
+        },
     };
 };
 exports.StorefrontApiFp = StorefrontApiFp;
@@ -30399,6 +30558,17 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
         getEmailCommseqPostcardStats: function (storefront_oid, commseq_uuid, statsRequest, options) {
             return (0, exports.StorefrontApiFp)(configuration).getEmailCommseqPostcardStats(storefront_oid, commseq_uuid, statsRequest, options)(fetch, basePath);
         },
+        /**
+         *
+         * @summary Get email communication postcard tracking
+         * @param {number} storefront_oid
+         * @param {string} commseq_postcard_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqPostcardTracking: function (storefront_oid, commseq_postcard_uuid, options) {
+            return (0, exports.StorefrontApiFp)(configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(fetch, basePath);
+        },
         /**
          *
          * @summary Get communication sequence stats overall
@@ -31792,6 +31962,16 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
         updateTwilioAccount: function (esp_twilio_uuid, twilio, options) {
             return (0, exports.StorefrontApiFp)(configuration).updateTwilioAccount(esp_twilio_uuid, twilio, options)(fetch, basePath);
         },
+        /**
+         *
+         * @summary Validate AWS Event Ruler
+         * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        validateRuler: function (ruler_validate_request, options) {
+            return (0, exports.StorefrontApiFp)(configuration).validateRuler(ruler_validate_request, options)(fetch, basePath);
+        },
     };
 };
 exports.StorefrontApiFactory = StorefrontApiFactory;
@@ -32278,6 +32458,18 @@ var StorefrontApi = /** @class */ (function (_super) {
     StorefrontApi.prototype.getEmailCommseqPostcardStats = function (storefront_oid, commseq_uuid, statsRequest, options) {
         return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseqPostcardStats(storefront_oid, commseq_uuid, statsRequest, options)(this.fetch, this.basePath);
     };
+    /**
+     *
+     * @summary Get email communication postcard tracking
+     * @param {number} storefront_oid
+     * @param {string} commseq_postcard_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    StorefrontApi.prototype.getEmailCommseqPostcardTracking = function (storefront_oid, commseq_postcard_uuid, options) {
+        return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseqPostcardTracking(storefront_oid, commseq_postcard_uuid, options)(this.fetch, this.basePath);
+    };
     /**
      *
      * @summary Get communication sequence stats overall
@@ -33795,6 +33987,17 @@ var StorefrontApi = /** @class */ (function (_super) {
     StorefrontApi.prototype.updateTwilioAccount = function (esp_twilio_uuid, twilio, options) {
         return (0, exports.StorefrontApiFp)(this.configuration).updateTwilioAccount(esp_twilio_uuid, twilio, options)(this.fetch, this.basePath);
     };
+    /**
+     *
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} ruler_validate_request Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    StorefrontApi.prototype.validateRuler = function (ruler_validate_request, options) {
+        return (0, exports.StorefrontApiFp)(this.configuration).validateRuler(ruler_validate_request, options)(this.fetch, this.basePath);
+    };
     return StorefrontApi;
 }(BaseAPI));
 exports.StorefrontApi = StorefrontApi;

package/package.json

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