ultracart_rest_api_v2_typescript 3.10.185 → 3.10.186

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.185
+## ultracart_rest_api_v2_typescript@3.10.186
 
 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.185 --save
+npm install ultracart_rest_api_v2_typescript@3.10.186 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.186 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
 | 3.10.185 | 03/08/2024 | added getWorkflowTaskTags method |
 | 3.10.184 | 02/27/2024 | esp - sms statistic layer |
 | 3.10.183 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |

package/api.ts

@@ -9323,6 +9323,18 @@ export interface ConversationPbxQueue {
      * @memberof ConversationPbxQueue
      */
     voicemail?: boolean;
+    /**
+     * Wait time in seconds before critical
+     * @type {number}
+     * @memberof ConversationPbxQueue
+     */
+    wait_critical_seconds?: number;
+    /**
+     * Wait time in seconds before warning
+     * @type {number}
+     * @memberof ConversationPbxQueue
+     */
+    wait_warning_seconds?: number;
 }
 
 /**
@@ -42989,6 +43001,70 @@ export namespace Weight {
     }
 }
 
+/**
+ * 
+ * @export
+ * @interface WorkflowAgentAuth
+ */
+export interface WorkflowAgentAuth {
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowAgentAuth
+     */
+    jwt?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowAgentAuth
+     */
+    merchant_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowAgentAuth
+     */
+    websocket_url?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface WorkflowAgentAuthResponse
+ */
+export interface WorkflowAgentAuthResponse {
+    /**
+     * 
+     * @type {WorkflowAgentAuth}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    agent_auth?: WorkflowAgentAuth;
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -100595,6 +100671,52 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
  */
 export const WorkflowApiFetchParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Retrieve a JWT to authorize an agent to make a websocket connection. 
+         * @summary Get agent websocket authorization
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowAgentWebsocketAuthorization(options: any = {}): FetchArgs {
+            const localVarPath = `/workflow/agent/auth`;
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'PUT' }, 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_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;
+            }
+
+            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 list of groups that workflow tasks can be assigned to 
          * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -101156,6 +101278,26 @@ export const WorkflowApiFetchParamCreator = function (configuration?: Configurat
  */
 export const WorkflowApiFp = function(configuration?: Configuration) {
     return {
+        /**
+         * Retrieve a JWT to authorize an agent to make a websocket connection. 
+         * @summary Get agent websocket authorization
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowAgentWebsocketAuthorization(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowAgentAuthResponse> {
+            const localVarFetchArgs = WorkflowApiFetchParamCreator(configuration).getWorkflowAgentWebsocketAuthorization(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 list of groups that workflow tasks can be assigned to 
          * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -101380,6 +101522,15 @@ export const WorkflowApiFp = function(configuration?: Configuration) {
  */
 export const WorkflowApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
     return {
+        /**
+         * Retrieve a JWT to authorize an agent to make a websocket connection. 
+         * @summary Get agent websocket authorization
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowAgentWebsocketAuthorization(options?: any) {
+            return WorkflowApiFp(configuration).getWorkflowAgentWebsocketAuthorization(options)(fetch, basePath);
+        },
         /**
          * Retrieve a list of groups that workflow tasks can be assigned to 
          * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -101494,6 +101645,15 @@ export const WorkflowApiFactory = function (configuration?: Configuration, fetch
  * @interface WorkflowApi
  */
 export interface WorkflowApiInterface {
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection. 
+     * @summary Get agent websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowAgentWebsocketAuthorization(options?: any): Promise<WorkflowAgentAuthResponse>;
+
     /**
      * Retrieve a list of groups that workflow tasks can be assigned to 
      * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -101608,6 +101768,17 @@ export interface WorkflowApiInterface {
  * @extends {BaseAPI}
  */
 export class WorkflowApi extends BaseAPI implements WorkflowApiInterface {
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection. 
+     * @summary Get agent websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApi
+     */
+    public getWorkflowAgentWebsocketAuthorization(options?: any) {
+        return WorkflowApiFp(this.configuration).getWorkflowAgentWebsocketAuthorization(options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieve a list of groups that workflow tasks can be assigned to 
      * @summary Retrieve a list of groups that workflow tasks can be assigned to

package/dist/api.d.ts

@@ -9102,6 +9102,18 @@ export interface ConversationPbxQueue {
      * @memberof ConversationPbxQueue
      */
     voicemail?: boolean;
+    /**
+     * Wait time in seconds before critical
+     * @type {number}
+     * @memberof ConversationPbxQueue
+     */
+    wait_critical_seconds?: number;
+    /**
+     * Wait time in seconds before warning
+     * @type {number}
+     * @memberof ConversationPbxQueue
+     */
+    wait_warning_seconds?: number;
 }
 /**
  *
@@ -42080,6 +42092,68 @@ export declare namespace Weight {
         OZ
     }
 }
+/**
+ *
+ * @export
+ * @interface WorkflowAgentAuth
+ */
+export interface WorkflowAgentAuth {
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowAgentAuth
+     */
+    jwt?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowAgentAuth
+     */
+    merchant_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowAgentAuth
+     */
+    websocket_url?: string;
+}
+/**
+ *
+ * @export
+ * @interface WorkflowAgentAuthResponse
+ */
+export interface WorkflowAgentAuthResponse {
+    /**
+     *
+     * @type {WorkflowAgentAuth}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    agent_auth?: WorkflowAgentAuth;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof WorkflowAgentAuthResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -65691,6 +65765,13 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
  * @export
  */
 export declare const WorkflowApiFetchParamCreator: (configuration?: Configuration) => {
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * @summary Get agent websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflowAgentWebsocketAuthorization(options?: any): FetchArgs;
     /**
      * Retrieve a list of groups that workflow tasks can be assigned to
      * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -65782,6 +65863,13 @@ export declare const WorkflowApiFetchParamCreator: (configuration?: Configuratio
  * @export
  */
 export declare const WorkflowApiFp: (configuration?: Configuration) => {
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * @summary Get agent websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflowAgentWebsocketAuthorization(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WorkflowAgentAuthResponse>;
     /**
      * Retrieve a list of groups that workflow tasks can be assigned to
      * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -65873,6 +65961,13 @@ export declare const WorkflowApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const WorkflowApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * @summary Get agent websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflowAgentWebsocketAuthorization(options?: any): Promise<WorkflowAgentAuthResponse>;
     /**
      * Retrieve a list of groups that workflow tasks can be assigned to
      * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -65965,6 +66060,14 @@ export declare const WorkflowApiFactory: (configuration?: Configuration, fetch?:
  * @interface WorkflowApi
  */
 export interface WorkflowApiInterface {
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * @summary Get agent websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowAgentWebsocketAuthorization(options?: any): Promise<WorkflowAgentAuthResponse>;
     /**
      * Retrieve a list of groups that workflow tasks can be assigned to
      * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -66068,6 +66171,14 @@ export interface WorkflowApiInterface {
  * @extends {BaseAPI}
  */
 export declare class WorkflowApi extends BaseAPI implements WorkflowApiInterface {
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * @summary Get agent websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApi
+     */
+    getWorkflowAgentWebsocketAuthorization(options?: any): Promise<WorkflowAgentAuthResponse>;
     /**
      * Retrieve a list of groups that workflow tasks can be assigned to
      * @summary Retrieve a list of groups that workflow tasks can be assigned to

package/dist/api.js

@@ -49687,6 +49687,46 @@ exports.WebhookApi = WebhookApi;
  */
 var WorkflowApiFetchParamCreator = function (configuration) {
     return {
+        /**
+         * Retrieve a JWT to authorize an agent to make a websocket connection.
+         * @summary Get agent websocket authorization
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowAgentWebsocketAuthorization: function (options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/workflow/agent/auth";
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'PUT' }, 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_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;
+            }
+            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 list of groups that workflow tasks can be assigned to
          * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -50178,6 +50218,27 @@ exports.WorkflowApiFetchParamCreator = WorkflowApiFetchParamCreator;
  */
 var WorkflowApiFp = function (configuration) {
     return {
+        /**
+         * Retrieve a JWT to authorize an agent to make a websocket connection.
+         * @summary Get agent websocket authorization
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowAgentWebsocketAuthorization: function (options) {
+            var localVarFetchArgs = (0, exports.WorkflowApiFetchParamCreator)(configuration).getWorkflowAgentWebsocketAuthorization(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 list of groups that workflow tasks can be assigned to
          * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -50412,6 +50473,15 @@ exports.WorkflowApiFp = WorkflowApiFp;
  */
 var WorkflowApiFactory = function (configuration, fetch, basePath) {
     return {
+        /**
+         * Retrieve a JWT to authorize an agent to make a websocket connection.
+         * @summary Get agent websocket authorization
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getWorkflowAgentWebsocketAuthorization: function (options) {
+            return (0, exports.WorkflowApiFp)(configuration).getWorkflowAgentWebsocketAuthorization(options)(fetch, basePath);
+        },
         /**
          * Retrieve a list of groups that workflow tasks can be assigned to
          * @summary Retrieve a list of groups that workflow tasks can be assigned to
@@ -50531,6 +50601,16 @@ var WorkflowApi = /** @class */ (function (_super) {
     function WorkflowApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Retrieve a JWT to authorize an agent to make a websocket connection.
+     * @summary Get agent websocket authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApi
+     */
+    WorkflowApi.prototype.getWorkflowAgentWebsocketAuthorization = function (options) {
+        return (0, exports.WorkflowApiFp)(this.configuration).getWorkflowAgentWebsocketAuthorization(options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieve a list of groups that workflow tasks can be assigned to
      * @summary Retrieve a list of groups that workflow tasks can be assigned to

package/package.json

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