ultracart_rest_api_v2_typescript 4.0.204 → 4.0.205

package/.openapi-generator/FILES

@@ -857,6 +857,7 @@ src/models/WorkflowGroupsResponse.ts
 src/models/WorkflowNote.ts
 src/models/WorkflowTask.ts
 src/models/WorkflowTaskHistory.ts
+src/models/WorkflowTaskOpenCountResponse.ts
 src/models/WorkflowTaskResponse.ts
 src/models/WorkflowTaskTagsResponse.ts
 src/models/WorkflowTasksRequest.ts

package/README.md

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

package/dist/apis/WorkflowApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { WorkflowAgentAuthResponse, WorkflowAttachmentUploadUrlResponse, WorkflowGroupsResponse, WorkflowTask, WorkflowTaskResponse, WorkflowTaskTagsResponse, WorkflowTasksRequest, WorkflowTasksResponse, WorkflowUserResponse, WorkflowUsersResponse } from '../models';
+import { WorkflowAgentAuthResponse, WorkflowAttachmentUploadUrlResponse, WorkflowGroupsResponse, WorkflowTask, WorkflowTaskOpenCountResponse, WorkflowTaskResponse, WorkflowTaskTagsResponse, WorkflowTasksRequest, WorkflowTasksResponse, WorkflowUserResponse, WorkflowUsersResponse } from '../models';
 export interface GetWorkflowAssignmentGroupsRequest {
     limit?: number;
     offset?: number;
@@ -148,6 +148,19 @@ export interface WorkflowApiInterface {
      * Retrieve a workflow task by object type and id
      */
     getWorkflowTaskByObjectType(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTasksResponse>;
+    /**
+     * Retrieve workflow task open count
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowTaskOpenCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskOpenCountResponse>>;
+    /**
+     * Retrieve workflow task open count
+     * Retrieve workflow task open count
+     */
+    getWorkflowTaskOpenCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskOpenCountResponse>;
     /**
      * Retrieves a unique list of all the existing workflow task tags.
      * @summary Get a list of existing workflow task tags
@@ -282,6 +295,16 @@ export declare class WorkflowApi extends runtime.BaseAPI implements WorkflowApiI
      * Retrieve a workflow task by object type and id
      */
     getWorkflowTaskByObjectType(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTasksResponse>;
+    /**
+     * Retrieve workflow task open count
+     * Retrieve workflow task open count
+     */
+    getWorkflowTaskOpenCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskOpenCountResponse>>;
+    /**
+     * Retrieve workflow task open count
+     * Retrieve workflow task open count
+     */
+    getWorkflowTaskOpenCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskOpenCountResponse>;
     /**
      * Retrieves a unique list of all the existing workflow task tags.
      * Get a list of existing workflow task tags

package/dist/apis/WorkflowApi.js

@@ -493,6 +493,62 @@ var WorkflowApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve workflow task open count
+     * Retrieve workflow task open count
+     */
+    WorkflowApi.prototype.getWorkflowTaskOpenCountRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["workflow_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/workflow/tasks/open_count",
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.WorkflowTaskOpenCountResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve workflow task open count
+     * Retrieve workflow task open count
+     */
+    WorkflowApi.prototype.getWorkflowTaskOpenCount = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getWorkflowTaskOpenCountRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieves a unique list of all the existing workflow task tags.
      * Get a list of existing workflow task tags

package/dist/models/WorkflowTaskOpenCountResponse.d.ts

@@ -0,0 +1,54 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @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 declare function WorkflowTaskOpenCountResponseFromJSON(json: any): WorkflowTaskOpenCountResponse;
+export declare function WorkflowTaskOpenCountResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowTaskOpenCountResponse;
+export declare function WorkflowTaskOpenCountResponseToJSON(value?: WorkflowTaskOpenCountResponse | null): any;

package/dist/models/WorkflowTaskOpenCountResponse.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowTaskOpenCountResponseToJSON = exports.WorkflowTaskOpenCountResponseFromJSONTyped = exports.WorkflowTaskOpenCountResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+function WorkflowTaskOpenCountResponseFromJSON(json) {
+    return WorkflowTaskOpenCountResponseFromJSONTyped(json, false);
+}
+exports.WorkflowTaskOpenCountResponseFromJSON = WorkflowTaskOpenCountResponseFromJSON;
+function WorkflowTaskOpenCountResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'open_count': !(0, runtime_1.exists)(json, 'open_count') ? undefined : json['open_count'],
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.WorkflowTaskOpenCountResponseFromJSONTyped = WorkflowTaskOpenCountResponseFromJSONTyped;
+function WorkflowTaskOpenCountResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'open_count': value.open_count,
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.WorkflowTaskOpenCountResponseToJSON = WorkflowTaskOpenCountResponseToJSON;

package/dist/models/WorkflowUsersResponse.d.ts

@@ -31,6 +31,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}

package/dist/models/WorkflowUsersResponse.js

@@ -30,6 +30,7 @@ function WorkflowUsersResponseFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
         'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'my_user_id': !(0, runtime_1.exists)(json, 'my_user_id') ? undefined : json['my_user_id'],
         'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
         'users': !(0, runtime_1.exists)(json, 'users') ? undefined : (json['users'].map(WorkflowUser_1.WorkflowUserFromJSON)),
         'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
@@ -46,6 +47,7 @@ function WorkflowUsersResponseToJSON(value) {
     return {
         'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
         'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'my_user_id': value.my_user_id,
         'success': value.success,
         'users': value.users === undefined ? undefined : (value.users.map(WorkflowUser_1.WorkflowUserToJSON)),
         'warning': (0, Warning_1.WarningToJSON)(value.warning),

package/dist/models/index.d.ts

@@ -830,6 +830,7 @@ export * from './WorkflowGroupsResponse';
 export * from './WorkflowNote';
 export * from './WorkflowTask';
 export * from './WorkflowTaskHistory';
+export * from './WorkflowTaskOpenCountResponse';
 export * from './WorkflowTaskResponse';
 export * from './WorkflowTaskTagsResponse';
 export * from './WorkflowTasksRequest';

package/dist/models/index.js

@@ -848,6 +848,7 @@ __exportStar(require("./WorkflowGroupsResponse"), exports);
 __exportStar(require("./WorkflowNote"), exports);
 __exportStar(require("./WorkflowTask"), exports);
 __exportStar(require("./WorkflowTaskHistory"), exports);
+__exportStar(require("./WorkflowTaskOpenCountResponse"), exports);
 __exportStar(require("./WorkflowTaskResponse"), exports);
 __exportStar(require("./WorkflowTaskTagsResponse"), exports);
 __exportStar(require("./WorkflowTasksRequest"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.204",
+  "version": "4.0.205",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/WorkflowApi.ts

@@ -30,6 +30,9 @@ import {
     WorkflowTask,
     WorkflowTaskFromJSON,
     WorkflowTaskToJSON,
+    WorkflowTaskOpenCountResponse,
+    WorkflowTaskOpenCountResponseFromJSON,
+    WorkflowTaskOpenCountResponseToJSON,
     WorkflowTaskResponse,
     WorkflowTaskResponseFromJSON,
     WorkflowTaskResponseToJSON,
@@ -209,6 +212,21 @@ export interface WorkflowApiInterface {
      */
     getWorkflowTaskByObjectType(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTasksResponse>;
 
+    /**
+     * Retrieve workflow task open count 
+     * @summary Retrieve workflow task open count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowTaskOpenCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskOpenCountResponse>>;
+
+    /**
+     * Retrieve workflow task open count 
+     * Retrieve workflow task open count
+     */
+    getWorkflowTaskOpenCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskOpenCountResponse>;
+
     /**
      * Retrieves a unique list of all the existing workflow task tags. 
      * @summary Get a list of existing workflow task tags
@@ -574,6 +592,43 @@ export class WorkflowApi extends runtime.BaseAPI implements WorkflowApiInterface
         return await response.value();
     }
 
+    /**
+     * Retrieve workflow task open count 
+     * Retrieve workflow task open count
+     */
+    async getWorkflowTaskOpenCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskOpenCountResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["workflow_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/workflow/tasks/open_count`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowTaskOpenCountResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve workflow task open count 
+     * Retrieve workflow task open count
+     */
+    async getWorkflowTaskOpenCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskOpenCountResponse> {
+        const response = await this.getWorkflowTaskOpenCountRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a unique list of all the existing workflow task tags. 
      * Get a list of existing workflow task tags

package/src/models/WorkflowTaskOpenCountResponse.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @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 function WorkflowTaskOpenCountResponseFromJSON(json: any): WorkflowTaskOpenCountResponse {
+    return WorkflowTaskOpenCountResponseFromJSONTyped(json, false);
+}
+
+export function WorkflowTaskOpenCountResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowTaskOpenCountResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'open_count': !exists(json, 'open_count') ? undefined : json['open_count'],
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function WorkflowTaskOpenCountResponseToJSON(value?: WorkflowTaskOpenCountResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'open_count': value.open_count,
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/WorkflowUsersResponse.ts

@@ -56,6 +56,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}
@@ -88,6 +94,7 @@ export function WorkflowUsersResponseFromJSONTyped(json: any, ignoreDiscriminato
         
         'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
         'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'my_user_id': !exists(json, 'my_user_id') ? undefined : json['my_user_id'],
         'success': !exists(json, 'success') ? undefined : json['success'],
         'users': !exists(json, 'users') ? undefined : ((json['users'] as Array<any>).map(WorkflowUserFromJSON)),
         'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
@@ -105,6 +112,7 @@ export function WorkflowUsersResponseToJSON(value?: WorkflowUsersResponse | null
         
         'error': ModelErrorToJSON(value.error),
         'metadata': ResponseMetadataToJSON(value.metadata),
+        'my_user_id': value.my_user_id,
         'success': value.success,
         'users': value.users === undefined ? undefined : ((value.users as Array<any>).map(WorkflowUserToJSON)),
         'warning': WarningToJSON(value.warning),

package/src/models/index.ts

@@ -832,6 +832,7 @@ export * from './WorkflowGroupsResponse';
 export * from './WorkflowNote';
 export * from './WorkflowTask';
 export * from './WorkflowTaskHistory';
+export * from './WorkflowTaskOpenCountResponse';
 export * from './WorkflowTaskResponse';
 export * from './WorkflowTaskTagsResponse';
 export * from './WorkflowTasksRequest';