ultracart_rest_api_v2_typescript 3.10.42 → 3.10.45

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.42
+## ultracart_rest_api_v2_typescript@3.10.45
 
 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.42 --save
+npm install ultracart_rest_api_v2_typescript@3.10.45 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 3.10.40 | 08/22/2022 | exposing individual reviews within item.review object |

package/api.ts

@@ -10442,6 +10442,12 @@ export interface CustomerEditorValues {
      * @memberof CustomerEditorValues
      */
     countries?: Array<Country>;
+    /**
+     * loyalty_ledger_descriptions
+     * @type {Array<string>}
+     * @memberof CustomerEditorValues
+     */
+    loyalty_ledger_descriptions?: Array<string>;
     /**
      * loyalty_program_type
      * @type {string}
@@ -16512,6 +16518,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}
@@ -29285,6 +29297,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
@@ -63840,6 +63886,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,
@@ -67483,6 +67592,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;
+                    }
+                });
+            };
+        },
     }
 };
 
@@ -69317,6 +69447,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);
+        },
     };
 };
 
@@ -71151,6 +71291,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>;
+
 }
 
 /**
@@ -73313,6 +73463,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

@@ -10192,6 +10192,12 @@ export interface CustomerEditorValues {
      * @memberof CustomerEditorValues
      */
     countries?: Array<Country>;
+    /**
+     * loyalty_ledger_descriptions
+     * @type {Array<string>}
+     * @memberof CustomerEditorValues
+     */
+    loyalty_ledger_descriptions?: Array<string>;
     /**
      * loyalty_program_type
      * @type {string}
@@ -16144,6 +16150,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}
@@ -28671,6 +28683,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
@@ -43121,6 +43165,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
@@ -44624,6 +44676,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
@@ -46127,6 +46187,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
@@ -47795,6 +47863,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
@@ -49464,6 +49541,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

@@ -26156,6 +26156,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;
@@ -29958,6 +30013,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;
@@ -31792,6 +31869,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;
@@ -33795,6 +33882,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.42",
+  "version": "3.10.45",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [