ultracart_rest_api_v2_typescript 3.10.187 → 3.10.188

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.187
+## ultracart_rest_api_v2_typescript@3.10.188
 
 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.187 --save
+npm install ultracart_rest_api_v2_typescript@3.10.188 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.188 | 03/19/2024 | workflow task - method to obtain open task count |
 | 3.10.187 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
 | 3.10.186 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
 | 3.10.185 | 03/08/2024 | added getWorkflowTaskTags method |

package/api.ts

@@ -43530,6 +43530,44 @@ export interface WorkflowTaskHistory {
     user?: WorkflowUser;
 }
 
+/**
+ * 
+ * @export
+ * @interface WorkflowTaskOpenCountResponse
+ */
+export interface WorkflowTaskOpenCountResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Open Task Count
+     * @type {number}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    open_count?: number;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -43885,6 +43923,12 @@ export interface WorkflowUsersResponse {
      * @memberof WorkflowUsersResponse
      */
     metadata?: ResponseMetadata;
+    /**
+     * User ID of myself
+     * @type {number}
+     * @memberof WorkflowUsersResponse
+     */
+    my_user_id?: number;
     /**
      * Indicates if API call was successful
      * @type {boolean}
@@ -101142,6 +101186,52 @@ export const WorkflowApiFetchParamCreator = function (configuration?: Configurat
 
 
 
+            // 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 workflow task open count 
+         * @summary Retrieve workflow task open count
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowTaskOpenCount(options: any = {}): FetchArgs {
+            const localVarPath = `/workflow/tasks/open_count`;
+            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) {
@@ -101558,6 +101648,26 @@ export const WorkflowApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieve workflow task open count 
+         * @summary Retrieve workflow task open count
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowTaskOpenCount(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowTaskOpenCountResponse> {
+            const localVarFetchArgs = WorkflowApiFetchParamCreator(configuration).getWorkflowTaskOpenCount(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;
+                    }
+                });
+            };
+        },
         /**
          * Retrieves a unique list of all the existing workflow task tags. 
          * @summary Get a list of existing workflow task tags
@@ -101725,6 +101835,15 @@ export const WorkflowApiFactory = function (configuration?: Configuration, fetch
         getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any) {
             return WorkflowApiFp(configuration).getWorkflowTaskByObjectType(object_type, object_id, options)(fetch, basePath);
         },
+        /**
+         * Retrieve workflow task open count 
+         * @summary Retrieve workflow task open count
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowTaskOpenCount(options?: any) {
+            return WorkflowApiFp(configuration).getWorkflowTaskOpenCount(options)(fetch, basePath);
+        },
         /**
          * Retrieves a unique list of all the existing workflow task tags. 
          * @summary Get a list of existing workflow task tags
@@ -101848,6 +101967,15 @@ export interface WorkflowApiInterface {
      */
     getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): Promise<WorkflowTasksResponse>;
 
+    /**
+     * Retrieve workflow task open count 
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowTaskOpenCount(options?: any): Promise<WorkflowTaskOpenCountResponse>;
+
     /**
      * Retrieves a unique list of all the existing workflow task tags. 
      * @summary Get a list of existing workflow task tags
@@ -101985,6 +102113,17 @@ export class WorkflowApi extends BaseAPI implements WorkflowApiInterface {
         return WorkflowApiFp(this.configuration).getWorkflowTaskByObjectType(object_type, object_id, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieve workflow task open count 
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApi
+     */
+    public getWorkflowTaskOpenCount(options?: any) {
+        return WorkflowApiFp(this.configuration).getWorkflowTaskOpenCount(options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieves a unique list of all the existing workflow task tags. 
      * @summary Get a list of existing workflow task tags

package/dist/api.d.ts

@@ -42610,6 +42610,43 @@ export interface WorkflowTaskHistory {
      */
     user?: WorkflowUser;
 }
+/**
+ *
+ * @export
+ * @interface WorkflowTaskOpenCountResponse
+ */
+export interface WorkflowTaskOpenCountResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Open Task Count
+     * @type {number}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    open_count?: number;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof WorkflowTaskOpenCountResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -42958,6 +42995,12 @@ export interface WorkflowUsersResponse {
      * @memberof WorkflowUsersResponse
      */
     metadata?: ResponseMetadata;
+    /**
+     * User ID of myself
+     * @type {number}
+     * @memberof WorkflowUsersResponse
+     */
+    my_user_id?: number;
     /**
      * Indicates if API call was successful
      * @type {boolean}
@@ -65891,6 +65934,13 @@ export declare const WorkflowApiFetchParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): FetchArgs;
+    /**
+     * Retrieve workflow task open count
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflowTaskOpenCount(options?: any): FetchArgs;
     /**
      * Retrieves a unique list of all the existing workflow task tags.
      * @summary Get a list of existing workflow task tags
@@ -65989,6 +66039,13 @@ export declare const WorkflowApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowTasksResponse>;
+    /**
+     * Retrieve workflow task open count
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflowTaskOpenCount(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowTaskOpenCountResponse>;
     /**
      * Retrieves a unique list of all the existing workflow task tags.
      * @summary Get a list of existing workflow task tags
@@ -66087,6 +66144,13 @@ export declare const WorkflowApiFactory: (configuration?: Configuration, fetch?:
      * @throws {RequiredError}
      */
     getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): Promise<WorkflowTasksResponse>;
+    /**
+     * Retrieve workflow task open count
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflowTaskOpenCount(options?: any): Promise<WorkflowTaskOpenCountResponse>;
     /**
      * Retrieves a unique list of all the existing workflow task tags.
      * @summary Get a list of existing workflow task tags
@@ -66193,6 +66257,14 @@ export interface WorkflowApiInterface {
      * @memberof WorkflowApiInterface
      */
     getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): Promise<WorkflowTasksResponse>;
+    /**
+     * Retrieve workflow task open count
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowTaskOpenCount(options?: any): Promise<WorkflowTaskOpenCountResponse>;
     /**
      * Retrieves a unique list of all the existing workflow task tags.
      * @summary Get a list of existing workflow task tags
@@ -66304,6 +66376,14 @@ export declare class WorkflowApi extends BaseAPI implements WorkflowApiInterface
      * @memberof WorkflowApi
      */
     getWorkflowTaskByObjectType(object_type: string, object_id: string, options?: any): Promise<WorkflowTasksResponse>;
+    /**
+     * Retrieve workflow task open count
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApi
+     */
+    getWorkflowTaskOpenCount(options?: any): Promise<WorkflowTaskOpenCountResponse>;
     /**
      * Retrieves a unique list of all the existing workflow task tags.
      * @summary Get a list of existing workflow task tags

package/dist/api.js

@@ -50112,6 +50112,46 @@ var WorkflowApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve workflow task open count
+         * @summary Retrieve workflow task open count
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowTaskOpenCount: function (options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/workflow/tasks/open_count";
+            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,
+            };
+        },
         /**
          * Retrieves a unique list of all the existing workflow task tags.
          * @summary Get a list of existing workflow task tags
@@ -50478,6 +50518,27 @@ var WorkflowApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieve workflow task open count
+         * @summary Retrieve workflow task open count
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowTaskOpenCount: function (options) {
+            var localVarFetchArgs = (0, exports.WorkflowApiFetchParamCreator)(configuration).getWorkflowTaskOpenCount(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;
+                    }
+                });
+            };
+        },
         /**
          * Retrieves a unique list of all the existing workflow task tags.
          * @summary Get a list of existing workflow task tags
@@ -50649,6 +50710,15 @@ var WorkflowApiFactory = function (configuration, fetch, basePath) {
         getWorkflowTaskByObjectType: function (object_type, object_id, options) {
             return (0, exports.WorkflowApiFp)(configuration).getWorkflowTaskByObjectType(object_type, object_id, options)(fetch, basePath);
         },
+        /**
+         * Retrieve workflow task open count
+         * @summary Retrieve workflow task open count
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowTaskOpenCount: function (options) {
+            return (0, exports.WorkflowApiFp)(configuration).getWorkflowTaskOpenCount(options)(fetch, basePath);
+        },
         /**
          * Retrieves a unique list of all the existing workflow task tags.
          * @summary Get a list of existing workflow task tags
@@ -50784,6 +50854,16 @@ var WorkflowApi = /** @class */ (function (_super) {
     WorkflowApi.prototype.getWorkflowTaskByObjectType = function (object_type, object_id, options) {
         return (0, exports.WorkflowApiFp)(this.configuration).getWorkflowTaskByObjectType(object_type, object_id, options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieve workflow task open count
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApi
+     */
+    WorkflowApi.prototype.getWorkflowTaskOpenCount = function (options) {
+        return (0, exports.WorkflowApiFp)(this.configuration).getWorkflowTaskOpenCount(options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieves a unique list of all the existing workflow task tags.
      * @summary Get a list of existing workflow task tags

package/package.json

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