ultracart_rest_api_v2_typescript 3.10.109 → 3.10.111

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.109
+## ultracart_rest_api_v2_typescript@3.10.111
 
 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.109 --save
+npm install ultracart_rest_api_v2_typescript@3.10.111 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.111 | 01/27/2023 | convo - added event_engage_customer property to message |
+| 3.10.110 | 01/27/2023 | conversations - getLocationsForEngagement method |
 | 3.10.109 | 01/26/2023 | typo in ConversationWebsocketMessage |
 | 3.10.108 | 01/25/2023 | conversation - added message type of engagement prompt |
 | 3.10.107 | 01/25/2023 | convo event for engage customer |

package/api.ts

@@ -7732,6 +7732,90 @@ export interface ConversationJoinRequest {
     participant_language_iso_code?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface ConversationLocationCountry
+ */
+export interface ConversationLocationCountry {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationLocationCountry
+     */
+    iso2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationLocationCountry
+     */
+    name?: string;
+    /**
+     * 
+     * @type {Array<ConversationLocationStateProvince>}
+     * @memberof ConversationLocationCountry
+     */
+    state_provinces?: Array<ConversationLocationStateProvince>;
+}
+
+/**
+ * 
+ * @export
+ * @interface ConversationLocationStateProvince
+ */
+export interface ConversationLocationStateProvince {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationLocationStateProvince
+     */
+    abbreviation?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationLocationStateProvince
+     */
+    name?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface ConversationLocationsResponse
+ */
+export interface ConversationLocationsResponse {
+    /**
+     * 
+     * @type {Array<ConversationLocationCountry>}
+     * @memberof ConversationLocationsResponse
+     */
+    countries?: Array<ConversationLocationCountry>;
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ConversationLocationsResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ConversationLocationsResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationLocationsResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ConversationLocationsResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -8835,6 +8919,12 @@ export interface ConversationWebsocketMessage {
      * @memberof ConversationWebsocketMessage
      */
     event_conversation_closed?: ConversationSummary;
+    /**
+     * 
+     * @type {ConversationWebchatQueueStatusQueueEntry}
+     * @memberof ConversationWebsocketMessage
+     */
+    event_engage_customer?: ConversationWebchatQueueStatusQueueEntry;
     /**
      * 
      * @type {ConversationSummary}
@@ -44837,6 +44927,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get location data for engagement configuration 
+         * @summary Get location data for engagement configuration
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLocationsForEngagement(options: any = {}): FetchArgs {
+            const localVarPath = `/conversation/locations`;
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, 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", ["conversation_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,
+            };
+        },
         /**
          * Insert a canned message 
          * @summary Insert a canned message
@@ -45923,6 +46059,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Get location data for engagement configuration 
+         * @summary Get location data for engagement configuration
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLocationsForEngagement(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationLocationsResponse> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getLocationsForEngagement(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;
+                    }
+                });
+            };
+        },
         /**
          * Insert a canned message 
          * @summary Insert a canned message
@@ -46377,6 +46533,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         getConversationsSearch(search_request: ConversationSearchRequest, options?: any) {
             return ConversationApiFp(configuration).getConversationsSearch(search_request, options)(fetch, basePath);
         },
+        /**
+         * Get location data for engagement configuration 
+         * @summary Get location data for engagement configuration
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLocationsForEngagement(options?: any) {
+            return ConversationApiFp(configuration).getLocationsForEngagement(options)(fetch, basePath);
+        },
         /**
          * Insert a canned message 
          * @summary Insert a canned message
@@ -46699,6 +46864,15 @@ export interface ConversationApiInterface {
      */
     getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
 
+    /**
+     * Get location data for engagement configuration 
+     * @summary Get location data for engagement configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getLocationsForEngagement(options?: any): Promise<ConversationLocationsResponse>;
+
     /**
      * Insert a canned message 
      * @summary Insert a canned message
@@ -47059,6 +47233,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).getConversationsSearch(search_request, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Get location data for engagement configuration 
+     * @summary Get location data for engagement configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public getLocationsForEngagement(options?: any) {
+        return ConversationApiFp(this.configuration).getLocationsForEngagement(options)(this.fetch, this.basePath);
+    }
+
     /**
      * Insert a canned message 
      * @summary Insert a canned message

package/dist/api.d.ts

@@ -7545,6 +7545,87 @@ export interface ConversationJoinRequest {
      */
     participant_language_iso_code?: string;
 }
+/**
+ *
+ * @export
+ * @interface ConversationLocationCountry
+ */
+export interface ConversationLocationCountry {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationLocationCountry
+     */
+    iso2?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationLocationCountry
+     */
+    name?: string;
+    /**
+     *
+     * @type {Array<ConversationLocationStateProvince>}
+     * @memberof ConversationLocationCountry
+     */
+    state_provinces?: Array<ConversationLocationStateProvince>;
+}
+/**
+ *
+ * @export
+ * @interface ConversationLocationStateProvince
+ */
+export interface ConversationLocationStateProvince {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationLocationStateProvince
+     */
+    abbreviation?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationLocationStateProvince
+     */
+    name?: string;
+}
+/**
+ *
+ * @export
+ * @interface ConversationLocationsResponse
+ */
+export interface ConversationLocationsResponse {
+    /**
+     *
+     * @type {Array<ConversationLocationCountry>}
+     * @memberof ConversationLocationsResponse
+     */
+    countries?: Array<ConversationLocationCountry>;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationLocationsResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationLocationsResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationLocationsResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationLocationsResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -8621,6 +8702,12 @@ export interface ConversationWebsocketMessage {
      * @memberof ConversationWebsocketMessage
      */
     event_conversation_closed?: ConversationSummary;
+    /**
+     *
+     * @type {ConversationWebchatQueueStatusQueueEntry}
+     * @memberof ConversationWebsocketMessage
+     */
+    event_engage_customer?: ConversationWebchatQueueStatusQueueEntry;
     /**
      *
      * @type {ConversationSummary}
@@ -39814,6 +39901,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     getConversationsSearch(search_request: ConversationSearchRequest, options?: any): FetchArgs;
+    /**
+     * Get location data for engagement configuration
+     * @summary Get location data for engagement configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLocationsForEngagement(options?: any): FetchArgs;
     /**
      * Insert a canned message
      * @summary Insert a canned message
@@ -40071,6 +40165,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getConversationsSearch(search_request: ConversationSearchRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationSearchResponse>;
+    /**
+     * Get location data for engagement configuration
+     * @summary Get location data for engagement configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLocationsForEngagement(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationLocationsResponse>;
     /**
      * Insert a canned message
      * @summary Insert a canned message
@@ -40328,6 +40429,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
+    /**
+     * Get location data for engagement configuration
+     * @summary Get location data for engagement configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLocationsForEngagement(options?: any): Promise<ConversationLocationsResponse>;
     /**
      * Insert a canned message
      * @summary Insert a canned message
@@ -40605,6 +40713,14 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
+    /**
+     * Get location data for engagement configuration
+     * @summary Get location data for engagement configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getLocationsForEngagement(options?: any): Promise<ConversationLocationsResponse>;
     /**
      * Insert a canned message
      * @summary Insert a canned message
@@ -40895,6 +41011,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     getConversationsSearch(search_request: ConversationSearchRequest, options?: any): Promise<ConversationSearchResponse>;
+    /**
+     * Get location data for engagement configuration
+     * @summary Get location data for engagement configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    getLocationsForEngagement(options?: any): Promise<ConversationLocationsResponse>;
     /**
      * Insert a canned message
      * @summary Insert a canned message

package/dist/api.js

@@ -7009,6 +7009,46 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get location data for engagement configuration
+         * @summary Get location data for engagement configuration
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLocationsForEngagement: function (options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/conversation/locations";
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'POST' }, 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", ["conversation_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,
+            };
+        },
         /**
          * Insert a canned message
          * @summary Insert a canned message
@@ -8032,6 +8072,27 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Get location data for engagement configuration
+         * @summary Get location data for engagement configuration
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLocationsForEngagement: function (options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getLocationsForEngagement(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;
+                    }
+                });
+            };
+        },
         /**
          * Insert a canned message
          * @summary Insert a canned message
@@ -8498,6 +8559,15 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         getConversationsSearch: function (search_request, options) {
             return (0, exports.ConversationApiFp)(configuration).getConversationsSearch(search_request, options)(fetch, basePath);
         },
+        /**
+         * Get location data for engagement configuration
+         * @summary Get location data for engagement configuration
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLocationsForEngagement: function (options) {
+            return (0, exports.ConversationApiFp)(configuration).getLocationsForEngagement(options)(fetch, basePath);
+        },
         /**
          * Insert a canned message
          * @summary Insert a canned message
@@ -8844,6 +8914,16 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.getConversationsSearch = function (search_request, options) {
         return (0, exports.ConversationApiFp)(this.configuration).getConversationsSearch(search_request, options)(this.fetch, this.basePath);
     };
+    /**
+     * Get location data for engagement configuration
+     * @summary Get location data for engagement configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.getLocationsForEngagement = function (options) {
+        return (0, exports.ConversationApiFp)(this.configuration).getLocationsForEngagement(options)(this.fetch, this.basePath);
+    };
     /**
      * Insert a canned message
      * @summary Insert a canned message

package/package.json

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