ultracart_rest_api_v2_typescript 3.10.216 → 3.10.217

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.216
+## ultracart_rest_api_v2_typescript@3.10.217
 
 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.216 --save
+npm install ultracart_rest_api_v2_typescript@3.10.217 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.217 | 10/24/2024 | storefront page attribute edit method |
 | 3.10.216 | 09/18/2024 | order payment constant for PayPal Fastlane |
 | 3.10.215 | 08/29/2024 | add hold_for_transmission to item shipping object |
 | 3.10.214 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |

package/api.ts

@@ -36343,6 +36343,18 @@ export interface OrderUtm {
      * @memberof OrderUtm
      */
     msclkid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OrderUtm
+     */
+    short_code?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OrderUtm
+     */
+    short_code_backup?: boolean;
     /**
      * 
      * @type {string}
@@ -41446,6 +41458,38 @@ export interface StoreFront {
     unlock_password?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface StoreFrontPageContentAttribute
+ */
+export interface StoreFrontPageContentAttribute {
+    /**
+     * Attribute name
+     * @type {string}
+     * @memberof StoreFrontPageContentAttribute
+     */
+    name?: string;
+    /**
+     * Attribute translated text instance identifier
+     * @type {number}
+     * @memberof StoreFrontPageContentAttribute
+     */
+    translated_text_instance_oid?: number;
+    /**
+     * Attribute type
+     * @type {string}
+     * @memberof StoreFrontPageContentAttribute
+     */
+    type?: string;
+    /**
+     * Attribute value
+     * @type {string}
+     * @memberof StoreFrontPageContentAttribute
+     */
+    value?: string;
+}
+
 /**
  * 
  * @export
@@ -84220,6 +84264,73 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Update a page content attribute, creating it new if it does not yet exist. 
+         * @summary Upsert a page content attribute
+         * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+         * @param {number} storefront_oid 
+         * @param {number} page_oid The page oid to modify.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options: any = {}): FetchArgs {
+            // verify required parameter 'page_attribute' is not null or undefined
+            if (page_attribute === null || page_attribute === undefined) {
+                throw new RequiredError('page_attribute','Required parameter page_attribute was null or undefined when calling insertUpdatePageContentAttribute.');
+            }
+            // 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 insertUpdatePageContentAttribute.');
+            }
+            // verify required parameter 'page_oid' is not null or undefined
+            if (page_oid === null || page_oid === undefined) {
+                throw new RequiredError('page_oid','Required parameter page_oid was null or undefined when calling insertUpdatePageContentAttribute.');
+            }
+            const localVarPath = `/storefront/{storefront_oid}/pages/{page_oid}/content/attributes`
+                .replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
+                .replace(`{${"page_oid"}}`, encodeURIComponent(String(page_oid)));
+            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 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; charset=UTF-8';
+
+            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>"StoreFrontPageContentAttribute" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify(page_attribute || {}) : (page_attribute || "");
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Prepare download of email segment
@@ -90472,6 +90583,29 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Update a page content attribute, creating it new if it does not yet exist. 
+         * @summary Upsert a page content attribute
+         * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+         * @param {number} storefront_oid 
+         * @param {number} page_oid The page oid to modify.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
+            const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_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;
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * 
          * @summary Prepare download of email segment
@@ -92985,6 +93119,18 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
         insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any) {
             return StorefrontApiFp(configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(fetch, basePath);
         },
+        /**
+         * Update a page content attribute, creating it new if it does not yet exist. 
+         * @summary Upsert a page content attribute
+         * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+         * @param {number} storefront_oid 
+         * @param {number} page_oid The page oid to modify.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any) {
+            return StorefrontApiFp(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(fetch, basePath);
+        },
         /**
          * 
          * @summary Prepare download of email segment
@@ -94970,6 +95116,18 @@ export interface StorefrontApiInterface {
      */
     insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
 
+    /**
+     * Update a page content attribute, creating it new if it does not yet exist. 
+     * @summary Upsert a page content attribute
+     * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+     * @param {number} storefront_oid 
+     * @param {number} page_oid The page oid to modify.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<{}>;
+
     /**
      * 
      * @summary Prepare download of email segment
@@ -97213,6 +97371,20 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
         return StorefrontApiFp(this.configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Update a page content attribute, creating it new if it does not yet exist. 
+     * @summary Upsert a page content attribute
+     * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+     * @param {number} storefront_oid 
+     * @param {number} page_oid The page oid to modify.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    public insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any) {
+        return StorefrontApiFp(this.configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * 
      * @summary Prepare download of email segment

package/dist/api.d.ts

@@ -35589,6 +35589,18 @@ export interface OrderUtm {
      * @memberof OrderUtm
      */
     msclkid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderUtm
+     */
+    short_code?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof OrderUtm
+     */
+    short_code_backup?: boolean;
     /**
      *
      * @type {string}
@@ -40575,6 +40587,37 @@ export interface StoreFront {
      */
     unlock_password?: string;
 }
+/**
+ *
+ * @export
+ * @interface StoreFrontPageContentAttribute
+ */
+export interface StoreFrontPageContentAttribute {
+    /**
+     * Attribute name
+     * @type {string}
+     * @memberof StoreFrontPageContentAttribute
+     */
+    name?: string;
+    /**
+     * Attribute translated text instance identifier
+     * @type {number}
+     * @memberof StoreFrontPageContentAttribute
+     */
+    translated_text_instance_oid?: number;
+    /**
+     * Attribute type
+     * @type {string}
+     * @memberof StoreFrontPageContentAttribute
+     */
+    type?: string;
+    /**
+     * Attribute value
+     * @type {string}
+     * @memberof StoreFrontPageContentAttribute
+     */
+    value?: string;
+}
 /**
  *
  * @export
@@ -57913,6 +57956,16 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): FetchArgs;
+    /**
+     * Update a page content attribute, creating it new if it does not yet exist.
+     * @summary Upsert a page content attribute
+     * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+     * @param {number} storefront_oid
+     * @param {number} page_oid The page oid to modify.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): FetchArgs;
     /**
      *
      * @summary Prepare download of email segment
@@ -59541,6 +59594,16 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ScreenRecordingSegmentResponse>;
+    /**
+     * Update a page content attribute, creating it new if it does not yet exist.
+     * @summary Upsert a page content attribute
+     * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+     * @param {number} storefront_oid
+     * @param {number} page_oid The page oid to modify.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
     /**
      *
      * @summary Prepare download of email segment
@@ -61169,6 +61232,16 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
      * @throws {RequiredError}
      */
     insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
+    /**
+     * Update a page content attribute, creating it new if it does not yet exist.
+     * @summary Upsert a page content attribute
+     * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+     * @param {number} storefront_oid
+     * @param {number} page_oid The page oid to modify.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<Response>;
     /**
      *
      * @summary Prepare download of email segment
@@ -62927,6 +63000,17 @@ export interface StorefrontApiInterface {
      * @memberof StorefrontApiInterface
      */
     insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
+    /**
+     * Update a page content attribute, creating it new if it does not yet exist.
+     * @summary Upsert a page content attribute
+     * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+     * @param {number} storefront_oid
+     * @param {number} page_oid The page oid to modify.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<{}>;
     /**
      *
      * @summary Prepare download of email segment
@@ -64734,6 +64818,17 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
      * @memberof StorefrontApi
      */
     insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
+    /**
+     * Update a page content attribute, creating it new if it does not yet exist.
+     * @summary Upsert a page content attribute
+     * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+     * @param {number} storefront_oid
+     * @param {number} page_oid The page oid to modify.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<Response>;
     /**
      *
      * @summary Prepare download of email segment

package/dist/api.js

@@ -35299,6 +35299,66 @@ var StorefrontApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Update a page content attribute, creating it new if it does not yet exist.
+         * @summary Upsert a page content attribute
+         * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+         * @param {number} storefront_oid
+         * @param {number} page_oid The page oid to modify.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        insertUpdatePageContentAttribute: function (page_attribute, storefront_oid, page_oid, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'page_attribute' is not null or undefined
+            if (page_attribute === null || page_attribute === undefined) {
+                throw new RequiredError('page_attribute', 'Required parameter page_attribute was null or undefined when calling insertUpdatePageContentAttribute.');
+            }
+            // 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 insertUpdatePageContentAttribute.');
+            }
+            // verify required parameter 'page_oid' is not null or undefined
+            if (page_oid === null || page_oid === undefined) {
+                throw new RequiredError('page_oid', 'Required parameter page_oid was null or undefined when calling insertUpdatePageContentAttribute.');
+            }
+            var localVarPath = "/storefront/{storefront_oid}/pages/{page_oid}/content/attributes"
+                .replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)))
+                .replace("{".concat("page_oid", "}"), encodeURIComponent(String(page_oid)));
+            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 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; charset=UTF-8';
+            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 = ("StoreFrontPageContentAttribute" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body = needsSerialization ? JSON.stringify(page_attribute || {}) : (page_attribute || "");
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary Prepare download of email segment
@@ -41293,6 +41353,30 @@ var StorefrontApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Update a page content attribute, creating it new if it does not yet exist.
+         * @summary Upsert a page content attribute
+         * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+         * @param {number} storefront_oid
+         * @param {number} page_oid The page oid to modify.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        insertUpdatePageContentAttribute: function (page_attribute, storefront_oid, page_oid, options) {
+            var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_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;
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          *
          * @summary Prepare download of email segment
@@ -43854,6 +43938,18 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
         insertScreenRecordingSegment: function (storefront_oid, segment, options) {
             return (0, exports.StorefrontApiFp)(configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(fetch, basePath);
         },
+        /**
+         * Update a page content attribute, creating it new if it does not yet exist.
+         * @summary Upsert a page content attribute
+         * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+         * @param {number} storefront_oid
+         * @param {number} page_oid The page oid to modify.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        insertUpdatePageContentAttribute: function (page_attribute, storefront_oid, page_oid, options) {
+            return (0, exports.StorefrontApiFp)(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(fetch, basePath);
+        },
         /**
          *
          * @summary Prepare download of email segment
@@ -45973,6 +46069,19 @@ var StorefrontApi = /** @class */ (function (_super) {
     StorefrontApi.prototype.insertScreenRecordingSegment = function (storefront_oid, segment, options) {
         return (0, exports.StorefrontApiFp)(this.configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(this.fetch, this.basePath);
     };
+    /**
+     * Update a page content attribute, creating it new if it does not yet exist.
+     * @summary Upsert a page content attribute
+     * @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
+     * @param {number} storefront_oid
+     * @param {number} page_oid The page oid to modify.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApi
+     */
+    StorefrontApi.prototype.insertUpdatePageContentAttribute = function (page_attribute, storefront_oid, page_oid, options) {
+        return (0, exports.StorefrontApiFp)(this.configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(this.fetch, this.basePath);
+    };
     /**
      *
      * @summary Prepare download of email segment

package/package.json

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