ultra_cart_rest_api_v2 4.0.191 → 4.0.244

package/dist/com.ultracart.admin.v2/WorkflowApi.js

@@ -4,39 +4,43 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-
 var _ErrorResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/ErrorResponse"));
-
+var _WorkflowAgentAuthResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowAgentAuthResponse"));
 var _WorkflowAttachmentUploadUrlResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowAttachmentUploadUrlResponse"));
-
 var _WorkflowGroupsResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowGroupsResponse"));
-
 var _WorkflowTask = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowTask"));
-
+var _WorkflowTaskOpenCountResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowTaskOpenCountResponse"));
 var _WorkflowTaskResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowTaskResponse"));
-
+var _WorkflowTaskTagsResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowTaskTagsResponse"));
 var _WorkflowTasksRequest = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowTasksRequest"));
-
 var _WorkflowTasksResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowTasksResponse"));
-
+var _WorkflowUserResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowUserResponse"));
 var _WorkflowUsersResponse = _interopRequireDefault(require("../com.ultracart.admin.v2.models/WorkflowUsersResponse"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * 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.
+ *
+ */
 /**
 * Workflow service.
 * @module com.ultracart.admin.v2/WorkflowApi
-* @version 4.0.191
+* @version 4.0.244
 */
-var WorkflowApi = /*#__PURE__*/function () {
+var WorkflowApi = exports["default"] = /*#__PURE__*/function () {
   /**
   * Constructs a new WorkflowApi. 
   * @alias module:com.ultracart.admin.v2/WorkflowApi
@@ -46,29 +50,56 @@ var WorkflowApi = /*#__PURE__*/function () {
   */
   function WorkflowApi(apiClient) {
     _classCallCheck(this, WorkflowApi);
-
     this.apiClient = apiClient || _ApiClient["default"].instance;
   }
+
   /**
-   * Callback function to receive the result of the getWorkflowAssignmentGroups operation.
-   * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowAssignmentGroupsCallback
+   * Callback function to receive the result of the getWorkflowAgentWebsocketAuthorization operation.
+   * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowAgentWebsocketAuthorizationCallback
    * @param {String} error Error message, if any.
-   * @param {module:com.ultracart.admin.v2.models/WorkflowGroupsResponse} data The data returned by the service call.
+   * @param {module:com.ultracart.admin.v2.models/WorkflowAgentAuthResponse} data The data returned by the service call.
    * @param {String} response The complete HTTP response.
    */
 
   /**
-   * Retrieve a list of groups that workflow tasks can be assigned to
-   * Retrieve a list of groups that workflow tasks can be assigned to 
-   * @param {Object} opts Optional parameters
-   * @param {Number} opts._limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
-   * @param {Number} opts._offset Pagination of the record set.  Offset is a zero based index. (default to 0)
-   * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowAssignmentGroupsCallback} callback The callback function, accepting three arguments: error, data, response
-   * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowGroupsResponse}
+   * Get agent websocket authorization
+   * Retrieve a JWT to authorize an agent to make a websocket connection. 
+   * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowAgentWebsocketAuthorizationCallback} callback The callback function, accepting three arguments: error, data, response
+   * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowAgentAuthResponse}
    */
+  return _createClass(WorkflowApi, [{
+    key: "getWorkflowAgentWebsocketAuthorization",
+    value: function getWorkflowAgentWebsocketAuthorization(callback) {
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['ultraCartOauth', 'ultraCartSimpleApiKey'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _WorkflowAgentAuthResponse["default"];
+      return this.apiClient.callApi('/workflow/agent/auth', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
 
+    /**
+     * Callback function to receive the result of the getWorkflowAssignmentGroups operation.
+     * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowAssignmentGroupsCallback
+     * @param {String} error Error message, if any.
+     * @param {module:com.ultracart.admin.v2.models/WorkflowGroupsResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
 
-  _createClass(WorkflowApi, [{
+    /**
+     * Retrieve a list of groups that workflow tasks can be assigned to
+     * Retrieve a list of groups that workflow tasks can be assigned to 
+     * @param {Object} opts Optional parameters
+     * @param {Number} opts._limit The maximum number of records to return on this one API call. (Max 200) (default to 100)
+     * @param {Number} opts._offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+     * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowAssignmentGroupsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowGroupsResponse}
+     */
+  }, {
     key: "getWorkflowAssignmentGroups",
     value: function getWorkflowAssignmentGroups(opts, callback) {
       opts = opts || {};
@@ -86,6 +117,7 @@ var WorkflowApi = /*#__PURE__*/function () {
       var returnType = _WorkflowGroupsResponse["default"];
       return this.apiClient.callApi('/workflow/assignment_groups', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
+
     /**
      * Callback function to receive the result of the getWorkflowAssignmentUsers operation.
      * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowAssignmentUsersCallback
@@ -103,7 +135,6 @@ var WorkflowApi = /*#__PURE__*/function () {
      * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowAssignmentUsersCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowUsersResponse}
      */
-
   }, {
     key: "getWorkflowAssignmentUsers",
     value: function getWorkflowAssignmentUsers(opts, callback) {
@@ -122,6 +153,36 @@ var WorkflowApi = /*#__PURE__*/function () {
       var returnType = _WorkflowUsersResponse["default"];
       return this.apiClient.callApi('/workflow/assignment_users', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
+
+    /**
+     * Callback function to receive the result of the getWorkflowMe operation.
+     * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowMeCallback
+     * @param {String} error Error message, if any.
+     * @param {module:com.ultracart.admin.v2.models/WorkflowUserResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve a user object for myself
+     * Retrieve a user object for myself 
+     * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowMeCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowUserResponse}
+     */
+  }, {
+    key: "getWorkflowMe",
+    value: function getWorkflowMe(callback) {
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['ultraCartOauth', 'ultraCartSimpleApiKey'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _WorkflowUserResponse["default"];
+      return this.apiClient.callApi('/workflow/me', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
     /**
      * Callback function to receive the result of the getWorkflowTask operation.
      * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskCallback
@@ -137,16 +198,14 @@ var WorkflowApi = /*#__PURE__*/function () {
      * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowTaskResponse}
      */
-
   }, {
     key: "getWorkflowTask",
     value: function getWorkflowTask(task_uuid, callback) {
-      var postBody = null; // verify the required parameter 'task_uuid' is set
-
+      var postBody = null;
+      // verify the required parameter 'task_uuid' is set
       if (task_uuid === undefined || task_uuid === null) {
         throw new Error("Missing the required parameter 'task_uuid' when calling getWorkflowTask");
       }
-
       var pathParams = {
         'task_uuid': task_uuid
       };
@@ -159,6 +218,7 @@ var WorkflowApi = /*#__PURE__*/function () {
       var returnType = _WorkflowTaskResponse["default"];
       return this.apiClient.callApi('/workflow/tasks/{task_uuid}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
+
     /**
      * Callback function to receive the result of the getWorkflowTaskAttachmentUploadUrl operation.
      * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskAttachmentUploadUrlCallback
@@ -174,16 +234,14 @@ var WorkflowApi = /*#__PURE__*/function () {
      * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskAttachmentUploadUrlCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowAttachmentUploadUrlResponse}
      */
-
   }, {
     key: "getWorkflowTaskAttachmentUploadUrl",
     value: function getWorkflowTaskAttachmentUploadUrl(extension, callback) {
-      var postBody = null; // verify the required parameter 'extension' is set
-
+      var postBody = null;
+      // verify the required parameter 'extension' is set
       if (extension === undefined || extension === null) {
         throw new Error("Missing the required parameter 'extension' when calling getWorkflowTaskAttachmentUploadUrl");
       }
-
       var pathParams = {
         'extension': extension
       };
@@ -196,6 +254,7 @@ var WorkflowApi = /*#__PURE__*/function () {
       var returnType = _WorkflowAttachmentUploadUrlResponse["default"];
       return this.apiClient.callApi('/workflow/tasks/attachments/{extension}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
+
     /**
      * Callback function to receive the result of the getWorkflowTaskByObjectType operation.
      * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskByObjectTypeCallback
@@ -212,21 +271,18 @@ var WorkflowApi = /*#__PURE__*/function () {
      * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskByObjectTypeCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowTasksResponse}
      */
-
   }, {
     key: "getWorkflowTaskByObjectType",
     value: function getWorkflowTaskByObjectType(object_type, object_id, callback) {
-      var postBody = null; // verify the required parameter 'object_type' is set
-
+      var postBody = null;
+      // verify the required parameter 'object_type' is set
       if (object_type === undefined || object_type === null) {
         throw new Error("Missing the required parameter 'object_type' when calling getWorkflowTaskByObjectType");
-      } // verify the required parameter 'object_id' is set
-
-
+      }
+      // verify the required parameter 'object_id' is set
       if (object_id === undefined || object_id === null) {
         throw new Error("Missing the required parameter 'object_id' when calling getWorkflowTaskByObjectType");
       }
-
       var pathParams = {
         'object_type': object_type,
         'object_id': object_id
@@ -240,6 +296,65 @@ var WorkflowApi = /*#__PURE__*/function () {
       var returnType = _WorkflowTasksResponse["default"];
       return this.apiClient.callApi('/workflow/tasks/by/{object_type}/{object_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
+
+    /**
+     * Callback function to receive the result of the getWorkflowTaskOpenCount operation.
+     * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskOpenCountCallback
+     * @param {String} error Error message, if any.
+     * @param {module:com.ultracart.admin.v2.models/WorkflowTaskOpenCountResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve workflow task open count
+     * Retrieve workflow task open count 
+     * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskOpenCountCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowTaskOpenCountResponse}
+     */
+  }, {
+    key: "getWorkflowTaskOpenCount",
+    value: function getWorkflowTaskOpenCount(callback) {
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['ultraCartOauth', 'ultraCartSimpleApiKey'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _WorkflowTaskOpenCountResponse["default"];
+      return this.apiClient.callApi('/workflow/tasks/open_count', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the getWorkflowTaskTags operation.
+     * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskTagsCallback
+     * @param {String} error Error message, if any.
+     * @param {module:com.ultracart.admin.v2.models/WorkflowTaskTagsResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get a list of existing workflow task tags
+     * Retrieves a unique list of all the existing workflow task tags. 
+     * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTaskTagsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowTaskTagsResponse}
+     */
+  }, {
+    key: "getWorkflowTaskTags",
+    value: function getWorkflowTaskTags(callback) {
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['ultraCartOauth', 'ultraCartSimpleApiKey'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _WorkflowTaskTagsResponse["default"];
+      return this.apiClient.callApi('/workflow/tasks/tags', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
     /**
      * Callback function to receive the result of the getWorkflowTasks operation.
      * @callback module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTasksCallback
@@ -259,17 +374,15 @@ var WorkflowApi = /*#__PURE__*/function () {
      * @param {module:com.ultracart.admin.v2/WorkflowApi~getWorkflowTasksCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowTasksResponse}
      */
-
   }, {
     key: "getWorkflowTasks",
     value: function getWorkflowTasks(workflow_tasks_query, opts, callback) {
       opts = opts || {};
-      var postBody = workflow_tasks_query; // verify the required parameter 'workflow_tasks_query' is set
-
+      var postBody = workflow_tasks_query;
+      // verify the required parameter 'workflow_tasks_query' is set
       if (workflow_tasks_query === undefined || workflow_tasks_query === null) {
         throw new Error("Missing the required parameter 'workflow_tasks_query' when calling getWorkflowTasks");
       }
-
       var pathParams = {};
       var queryParams = {
         '_limit': opts['_limit'],
@@ -284,6 +397,7 @@ var WorkflowApi = /*#__PURE__*/function () {
       var returnType = _WorkflowTasksResponse["default"];
       return this.apiClient.callApi('/workflow/tasks/search', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
+
     /**
      * Callback function to receive the result of the insertWorkflowTask operation.
      * @callback module:com.ultracart.admin.v2/WorkflowApi~insertWorkflowTaskCallback
@@ -299,16 +413,14 @@ var WorkflowApi = /*#__PURE__*/function () {
      * @param {module:com.ultracart.admin.v2/WorkflowApi~insertWorkflowTaskCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowTaskResponse}
      */
-
   }, {
     key: "insertWorkflowTask",
     value: function insertWorkflowTask(workflow_task, callback) {
-      var postBody = workflow_task; // verify the required parameter 'workflow_task' is set
-
+      var postBody = workflow_task;
+      // verify the required parameter 'workflow_task' is set
       if (workflow_task === undefined || workflow_task === null) {
         throw new Error("Missing the required parameter 'workflow_task' when calling insertWorkflowTask");
       }
-
       var pathParams = {};
       var queryParams = {};
       var headerParams = {};
@@ -319,6 +431,7 @@ var WorkflowApi = /*#__PURE__*/function () {
       var returnType = _WorkflowTaskResponse["default"];
       return this.apiClient.callApi('/workflow/tasks', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
+
     /**
      * Callback function to receive the result of the updateWorkflowTask operation.
      * @callback module:com.ultracart.admin.v2/WorkflowApi~updateWorkflowTaskCallback
@@ -335,21 +448,18 @@ var WorkflowApi = /*#__PURE__*/function () {
      * @param {module:com.ultracart.admin.v2/WorkflowApi~updateWorkflowTaskCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:com.ultracart.admin.v2.models/WorkflowTaskResponse}
      */
-
   }, {
     key: "updateWorkflowTask",
     value: function updateWorkflowTask(task_uuid, workflow_task, callback) {
-      var postBody = workflow_task; // verify the required parameter 'task_uuid' is set
-
+      var postBody = workflow_task;
+      // verify the required parameter 'task_uuid' is set
       if (task_uuid === undefined || task_uuid === null) {
         throw new Error("Missing the required parameter 'task_uuid' when calling updateWorkflowTask");
-      } // verify the required parameter 'workflow_task' is set
-
-
+      }
+      // verify the required parameter 'workflow_task' is set
       if (workflow_task === undefined || workflow_task === null) {
         throw new Error("Missing the required parameter 'workflow_task' when calling updateWorkflowTask");
       }
-
       var pathParams = {
         'task_uuid': task_uuid
       };
@@ -363,8 +473,4 @@ var WorkflowApi = /*#__PURE__*/function () {
       return this.apiClient.callApi('/workflow/tasks/{task_uuid}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
   }]);
-
-  return WorkflowApi;
-}();
-
-exports["default"] = WorkflowApi;
+}();