ultracart_rest_api_v2_typescript 3.10.175 → 3.10.178

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.175
+## ultracart_rest_api_v2_typescript@3.10.178
 
 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.175 --save
+npm install ultracart_rest_api_v2_typescript@3.10.178 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.178 | 01/03/2024 | workflow - add task_context field to task obj |
+| 3.10.177 | 12/15/2023 | bug fix on bad docs breaking yaml schema |
+| 3.10.176 | 12/12/2023 | webhook - added event ruler property |
 | 3.10.175 | 11/21/2023 | coupons - addl support on tiered amount/percent off items |
 | 3.10.174 | 11/20/2023 | coupon - add item tag support to percent off items and free shipping |
 | 3.10.173 | 11/20/2023 | item.google_product_search.color bugfix for bad length validation: 20 to 100 |

package/api.ts

@@ -40768,6 +40768,12 @@ export interface WebhookEventSubscription {
      * @memberof WebhookEventSubscription
      */
     event_name?: string;
+    /**
+     * Optional - Event ruler expression to filter events to.  Only events that match this Ruler expression will be transmitted to the webhook.
+     * @type {string}
+     * @memberof WebhookEventSubscription
+     */
+    event_ruler?: string;
     /**
      * The expand string for the notification object.  See the individual resource _expand documentation for valid values.
      * @type {string}
@@ -41471,6 +41477,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     status?: WorkflowTask.StatusEnum;
+    /**
+     * User friendly string of the task context
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    task_context?: string;
     /**
      * Task Details
      * @type {string}
@@ -41504,7 +41516,8 @@ export namespace WorkflowTask {
         Order = <any> 'order',
         AutoOrder = <any> 'auto order',
         Item = <any> 'item',
-        CustomerProfile = <any> 'customer profile'
+        CustomerProfile = <any> 'customer profile',
+        Storefront = <any> 'storefront'
     }
     /**
      * @export
@@ -41769,6 +41782,12 @@ export interface WorkflowTasksResponse {
      * @memberof WorkflowTasksResponse
      */
     success?: boolean;
+    /**
+     * User friendly string of the task context if querying for a specific object type/id
+     * @type {string}
+     * @memberof WorkflowTasksResponse
+     */
+    task_context?: string;
     /**
      * tasks
      * @type {Array<WorkflowTask>}
@@ -41809,6 +41828,44 @@ export interface WorkflowUser {
     user_id?: number;
 }
 
+/**
+ * 
+ * @export
+ * @interface WorkflowUserResponse
+ */
+export interface WorkflowUserResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof WorkflowUserResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof WorkflowUserResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof WorkflowUserResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {WorkflowUser}
+     * @memberof WorkflowUserResponse
+     */
+    user?: WorkflowUser;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof WorkflowUserResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -94013,6 +94070,52 @@ export const WorkflowApiFetchParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve a user object for myself 
+         * @summary Retrieve a user object for myself
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowMe(options: any = {}): FetchArgs {
+            const localVarPath = `/workflow/me`;
+            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 ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["workflow_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,
+            };
+        },
         /**
          * Retrieve a workflow task 
          * @summary Retrieve a workflow task
@@ -94414,6 +94517,26 @@ export const WorkflowApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieve a user object for myself 
+         * @summary Retrieve a user object for myself
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowMe(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowUserResponse> {
+            const localVarFetchArgs = WorkflowApiFetchParamCreator(configuration).getWorkflowMe(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;
+                    }
+                });
+            };
+        },
         /**
          * Retrieve a workflow task 
          * @summary Retrieve a workflow task
@@ -94576,6 +94699,15 @@ export const WorkflowApiFactory = function (configuration?: Configuration, fetch
         getWorkflowAssignmentUsers(_limit?: number, _offset?: number, options?: any) {
             return WorkflowApiFp(configuration).getWorkflowAssignmentUsers(_limit, _offset, options)(fetch, basePath);
         },
+        /**
+         * Retrieve a user object for myself 
+         * @summary Retrieve a user object for myself
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowMe(options?: any) {
+            return WorkflowApiFp(configuration).getWorkflowMe(options)(fetch, basePath);
+        },
         /**
          * Retrieve a workflow task 
          * @summary Retrieve a workflow task
@@ -94672,6 +94804,15 @@ export interface WorkflowApiInterface {
      */
     getWorkflowAssignmentUsers(_limit?: number, _offset?: number, options?: any): Promise<WorkflowUsersResponse>;
 
+    /**
+     * Retrieve a user object for myself 
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowMe(options?: any): Promise<WorkflowUserResponse>;
+
     /**
      * Retrieve a workflow task 
      * @summary Retrieve a workflow task
@@ -94772,6 +94913,17 @@ export class WorkflowApi extends BaseAPI implements WorkflowApiInterface {
         return WorkflowApiFp(this.configuration).getWorkflowAssignmentUsers(_limit, _offset, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieve a user object for myself 
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApi
+     */
+    public getWorkflowMe(options?: any) {
+        return WorkflowApiFp(this.configuration).getWorkflowMe(options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieve a workflow task 
      * @summary Retrieve a workflow task

package/dist/api.d.ts

@@ -39906,6 +39906,12 @@ export interface WebhookEventSubscription {
      * @memberof WebhookEventSubscription
      */
     event_name?: string;
+    /**
+     * Optional - Event ruler expression to filter events to.  Only events that match this Ruler expression will be transmitted to the webhook.
+     * @type {string}
+     * @memberof WebhookEventSubscription
+     */
+    event_ruler?: string;
     /**
      * The expand string for the notification object.  See the individual resource _expand documentation for valid values.
      * @type {string}
@@ -40592,6 +40598,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     status?: WorkflowTask.StatusEnum;
+    /**
+     * User friendly string of the task context
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    task_context?: string;
     /**
      * Task Details
      * @type {string}
@@ -40624,7 +40636,8 @@ export declare namespace WorkflowTask {
         Order,
         AutoOrder,
         Item,
-        CustomerProfile
+        CustomerProfile,
+        Storefront
     }
     /**
      * @export
@@ -40884,6 +40897,12 @@ export interface WorkflowTasksResponse {
      * @memberof WorkflowTasksResponse
      */
     success?: boolean;
+    /**
+     * User friendly string of the task context if querying for a specific object type/id
+     * @type {string}
+     * @memberof WorkflowTasksResponse
+     */
+    task_context?: string;
     /**
      * tasks
      * @type {Array<WorkflowTask>}
@@ -40922,6 +40941,43 @@ export interface WorkflowUser {
      */
     user_id?: number;
 }
+/**
+ *
+ * @export
+ * @interface WorkflowUserResponse
+ */
+export interface WorkflowUserResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof WorkflowUserResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof WorkflowUserResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof WorkflowUserResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {WorkflowUser}
+     * @memberof WorkflowUserResponse
+     */
+    user?: WorkflowUser;
+    /**
+     *
+     * @type {Warning}
+     * @memberof WorkflowUserResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -61919,6 +61975,13 @@ export declare const WorkflowApiFetchParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getWorkflowAssignmentUsers(_limit?: number, _offset?: number, options?: any): FetchArgs;
+    /**
+     * Retrieve a user object for myself
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflowMe(options?: any): FetchArgs;
     /**
      * Retrieve a workflow task
      * @summary Retrieve a workflow task
@@ -61996,6 +62059,13 @@ export declare const WorkflowApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getWorkflowAssignmentUsers(_limit?: number, _offset?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowUsersResponse>;
+    /**
+     * Retrieve a user object for myself
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflowMe(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowUserResponse>;
     /**
      * Retrieve a workflow task
      * @summary Retrieve a workflow task
@@ -62073,6 +62143,13 @@ export declare const WorkflowApiFactory: (configuration?: Configuration, fetch?:
      * @throws {RequiredError}
      */
     getWorkflowAssignmentUsers(_limit?: number, _offset?: number, options?: any): Promise<WorkflowUsersResponse>;
+    /**
+     * Retrieve a user object for myself
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflowMe(options?: any): Promise<WorkflowUserResponse>;
     /**
      * Retrieve a workflow task
      * @summary Retrieve a workflow task
@@ -62153,6 +62230,14 @@ export interface WorkflowApiInterface {
      * @memberof WorkflowApiInterface
      */
     getWorkflowAssignmentUsers(_limit?: number, _offset?: number, options?: any): Promise<WorkflowUsersResponse>;
+    /**
+     * Retrieve a user object for myself
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowMe(options?: any): Promise<WorkflowUserResponse>;
     /**
      * Retrieve a workflow task
      * @summary Retrieve a workflow task
@@ -62240,6 +62325,14 @@ export declare class WorkflowApi extends BaseAPI implements WorkflowApiInterface
      * @memberof WorkflowApi
      */
     getWorkflowAssignmentUsers(_limit?: number, _offset?: number, options?: any): Promise<WorkflowUsersResponse>;
+    /**
+     * Retrieve a user object for myself
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApi
+     */
+    getWorkflowMe(options?: any): Promise<WorkflowUserResponse>;
     /**
      * Retrieve a workflow task
      * @summary Retrieve a workflow task

package/dist/api.js

@@ -1592,6 +1592,7 @@ var WorkflowTask;
         ObjectTypeEnum[ObjectTypeEnum["AutoOrder"] = 'auto order'] = "AutoOrder";
         ObjectTypeEnum[ObjectTypeEnum["Item"] = 'item'] = "Item";
         ObjectTypeEnum[ObjectTypeEnum["CustomerProfile"] = 'customer profile'] = "CustomerProfile";
+        ObjectTypeEnum[ObjectTypeEnum["Storefront"] = 'storefront'] = "Storefront";
     })(ObjectTypeEnum = WorkflowTask.ObjectTypeEnum || (WorkflowTask.ObjectTypeEnum = {}));
     /**
      * @export
@@ -45773,6 +45774,46 @@ var WorkflowApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve a user object for myself
+         * @summary Retrieve a user object for myself
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowMe: function (options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/workflow/me";
+            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 ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["workflow_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,
+            };
+        },
         /**
          * Retrieve a workflow task
          * @summary Retrieve a workflow task
@@ -46134,6 +46175,27 @@ var WorkflowApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieve a user object for myself
+         * @summary Retrieve a user object for myself
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowMe: function (options) {
+            var localVarFetchArgs = (0, exports.WorkflowApiFetchParamCreator)(configuration).getWorkflowMe(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;
+                    }
+                });
+            };
+        },
         /**
          * Retrieve a workflow task
          * @summary Retrieve a workflow task
@@ -46302,6 +46364,15 @@ var WorkflowApiFactory = function (configuration, fetch, basePath) {
         getWorkflowAssignmentUsers: function (_limit, _offset, options) {
             return (0, exports.WorkflowApiFp)(configuration).getWorkflowAssignmentUsers(_limit, _offset, options)(fetch, basePath);
         },
+        /**
+         * Retrieve a user object for myself
+         * @summary Retrieve a user object for myself
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowMe: function (options) {
+            return (0, exports.WorkflowApiFp)(configuration).getWorkflowMe(options)(fetch, basePath);
+        },
         /**
          * Retrieve a workflow task
          * @summary Retrieve a workflow task
@@ -46405,6 +46476,16 @@ var WorkflowApi = /** @class */ (function (_super) {
     WorkflowApi.prototype.getWorkflowAssignmentUsers = function (_limit, _offset, options) {
         return (0, exports.WorkflowApiFp)(this.configuration).getWorkflowAssignmentUsers(_limit, _offset, options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieve a user object for myself
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApi
+     */
+    WorkflowApi.prototype.getWorkflowMe = function (options) {
+        return (0, exports.WorkflowApiFp)(this.configuration).getWorkflowMe(options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieve a workflow task
      * @summary Retrieve a workflow task

package/package.json

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