ultracart_rest_api_v2_typescript 3.11.17 → 3.11.18

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.11.17
+## ultracart_rest_api_v2_typescript@3.11.18
 
 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.11.17 --save
+npm install ultracart_rest_api_v2_typescript@3.11.18 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
 | 3.11.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
 | 3.11.16 | 07/28/2025 | updated doc samples |
 | 3.11.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |

package/api.ts

@@ -20245,6 +20245,44 @@ export interface EmailEditorTokenResponse {
     warning?: Warning;
 }
 
+/**
+ * 
+ * @export
+ * @interface EmailEditorValuesResponse
+ */
+export interface EmailEditorValuesResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof EmailEditorValuesResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof EmailEditorValuesResponse
+     */
+    loyalty_tiers?: Array<string>;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof EmailEditorValuesResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof EmailEditorValuesResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof EmailEditorValuesResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -24257,12 +24295,6 @@ export interface EmailWebhookEditorValuesResponse {
      * @memberof EmailWebhookEditorValuesResponse
      */
     error?: ModelError;
-    /**
-     * 
-     * @type {Array<string>}
-     * @memberof EmailWebhookEditorValuesResponse
-     */
-    loyalty_tiers?: Array<string>;
     /**
      * 
      * @type {ResponseMetadata}
@@ -82582,6 +82614,66 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
 
 
 
+            // 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 email merchant specific editor values
+         * @param {number} storefront_oid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqEditorValues(storefront_oid: number, 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 getEmailCommseqEditorValues.');
+            }
+            const localVarPath = `/storefront/{storefront_oid}/email/commseqs/editorValues`
+                .replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)));
+            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'
@@ -92845,6 +92937,27 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * 
+         * @summary Get email merchant specific editor values
+         * @param {number} storefront_oid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqEditorValues(storefront_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailEditorValuesResponse> {
+            const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).getEmailCommseqEditorValues(storefront_oid, 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 email communication sequence emails stats
@@ -96360,6 +96473,16 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
         getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any) {
             return StorefrontApiFp(configuration).getEmailCommseq(storefront_oid, commseq_uuid, options)(fetch, basePath);
         },
+        /**
+         * 
+         * @summary Get email merchant specific editor values
+         * @param {number} storefront_oid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqEditorValues(storefront_oid: number, options?: any) {
+            return StorefrontApiFp(configuration).getEmailCommseqEditorValues(storefront_oid, options)(fetch, basePath);
+        },
         /**
          * 
          * @summary Get email communication sequence emails stats
@@ -98357,6 +98480,16 @@ export interface StorefrontApiInterface {
      */
     getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailCommseqResponse>;
 
+    /**
+     * 
+     * @summary Get email merchant specific editor values
+     * @param {number} storefront_oid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    getEmailCommseqEditorValues(storefront_oid: number, options?: any): Promise<EmailEditorValuesResponse>;
+
     /**
      * 
      * @summary Get email communication sequence emails stats
@@ -100434,6 +100567,18 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
         return StorefrontApiFp(this.configuration).getEmailCommseq(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * 
+     * @summary Get email merchant specific editor values
+     * @param {number} storefront_oid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    public getEmailCommseqEditorValues(storefront_oid: number, options?: any) {
+        return StorefrontApiFp(this.configuration).getEmailCommseqEditorValues(storefront_oid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * 
      * @summary Get email communication sequence emails stats

package/dist/api.d.ts

@@ -19785,6 +19785,43 @@ export interface EmailEditorTokenResponse {
      */
     warning?: Warning;
 }
+/**
+ *
+ * @export
+ * @interface EmailEditorValuesResponse
+ */
+export interface EmailEditorValuesResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof EmailEditorValuesResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof EmailEditorValuesResponse
+     */
+    loyalty_tiers?: Array<string>;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof EmailEditorValuesResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof EmailEditorValuesResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof EmailEditorValuesResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -23718,12 +23755,6 @@ export interface EmailWebhookEditorValuesResponse {
      * @memberof EmailWebhookEditorValuesResponse
      */
     error?: ModelError;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof EmailWebhookEditorValuesResponse
-     */
-    loyalty_tiers?: Array<string>;
     /**
      *
      * @type {ResponseMetadata}
@@ -59630,6 +59661,14 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): FetchArgs;
+    /**
+     *
+     * @summary Get email merchant specific editor values
+     * @param {number} storefront_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailCommseqEditorValues(storefront_oid: number, options?: any): FetchArgs;
     /**
      *
      * @summary Get email communication sequence emails stats
@@ -61268,6 +61307,14 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqResponse>;
+    /**
+     *
+     * @summary Get email merchant specific editor values
+     * @param {number} storefront_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailCommseqEditorValues(storefront_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailEditorValuesResponse>;
     /**
      *
      * @summary Get email communication sequence emails stats
@@ -62906,6 +62953,14 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
      * @throws {RequiredError}
      */
     getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailCommseqResponse>;
+    /**
+     *
+     * @summary Get email merchant specific editor values
+     * @param {number} storefront_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailCommseqEditorValues(storefront_oid: number, options?: any): Promise<EmailEditorValuesResponse>;
     /**
      *
      * @summary Get email communication sequence emails stats
@@ -64585,6 +64640,15 @@ export interface StorefrontApiInterface {
      * @memberof StorefrontApiInterface
      */
     getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailCommseqResponse>;
+    /**
+     *
+     * @summary Get email merchant specific editor values
+     * @param {number} storefront_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    getEmailCommseqEditorValues(storefront_oid: number, options?: any): Promise<EmailEditorValuesResponse>;
     /**
      *
      * @summary Get email communication sequence emails stats
@@ -66403,6 +66467,15 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
      * @memberof StorefrontApi
      */
     getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailCommseqResponse>;
+    /**
+     *
+     * @summary Get email merchant specific editor values
+     * @param {number} storefront_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    getEmailCommseqEditorValues(storefront_oid: number, options?: any): Promise<EmailEditorValuesResponse>;
     /**
      *
      * @summary Get email communication sequence emails stats

package/dist/api.js

@@ -32580,6 +32580,59 @@ var StorefrontApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Get email merchant specific editor values
+         * @param {number} storefront_oid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqEditorValues: function (storefront_oid, 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 getEmailCommseqEditorValues.');
+            }
+            var localVarPath = "/storefront/{storefront_oid}/email/commseqs/editorValues"
+                .replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)));
+            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 email communication sequence emails stats
@@ -41785,6 +41838,28 @@ var StorefrontApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         *
+         * @summary Get email merchant specific editor values
+         * @param {number} storefront_oid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqEditorValues: function (storefront_oid, options) {
+            var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).getEmailCommseqEditorValues(storefront_oid, 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 email communication sequence emails stats
@@ -45438,6 +45513,16 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
         getEmailCommseq: function (storefront_oid, commseq_uuid, options) {
             return (0, exports.StorefrontApiFp)(configuration).getEmailCommseq(storefront_oid, commseq_uuid, options)(fetch, basePath);
         },
+        /**
+         *
+         * @summary Get email merchant specific editor values
+         * @param {number} storefront_oid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getEmailCommseqEditorValues: function (storefront_oid, options) {
+            return (0, exports.StorefrontApiFp)(configuration).getEmailCommseqEditorValues(storefront_oid, options)(fetch, basePath);
+        },
         /**
          *
          * @summary Get email communication sequence emails stats
@@ -47480,6 +47565,17 @@ var StorefrontApi = /** @class */ (function (_super) {
     StorefrontApi.prototype.getEmailCommseq = function (storefront_oid, commseq_uuid, options) {
         return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseq(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
     };
+    /**
+     *
+     * @summary Get email merchant specific editor values
+     * @param {number} storefront_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    StorefrontApi.prototype.getEmailCommseqEditorValues = function (storefront_oid, options) {
+        return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseqEditorValues(storefront_oid, options)(this.fetch, this.basePath);
+    };
     /**
      *
      * @summary Get email communication sequence emails stats

package/package.json

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