ultracart_rest_api_v2_typescript 3.10.68 → 3.10.69

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.68
+## ultracart_rest_api_v2_typescript@3.10.69
 
 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.68 --save
+npm install ultracart_rest_api_v2_typescript@3.10.69 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.69 | 11/21/2022 | conversation context method |
 | 3.10.68 | 11/21/2022 | adjusted conversation event model |
 | 3.10.67 | 11/15/2022 | conversation methods bug fix |
 | 3.10.66 | 11/15/2022 | conversations - enw events for add coupon and items |

package/api.ts

@@ -7219,6 +7219,44 @@ export interface ConversationTwilioAccount {
     twilio_phone_numbers?: Array<string>;
 }
 
+/**
+ * 
+ * @export
+ * @interface ConversationWebchatContext
+ */
+export interface ConversationWebchatContext {
+    /**
+     * 
+     * @type {Cart}
+     * @memberof ConversationWebchatContext
+     */
+    cart?: Cart;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationWebchatContext
+     */
+    current_url?: string;
+    /**
+     * 
+     * @type {Array<HitPageView>}
+     * @memberof ConversationWebchatContext
+     */
+    page_view?: Array<HitPageView>;
+    /**
+     * 
+     * @type {HitSessionStart}
+     * @memberof ConversationWebchatContext
+     */
+    session_start?: HitSessionStart;
+    /**
+     * 
+     * @type {HitSessionUtm}
+     * @memberof ConversationWebchatContext
+     */
+    session_utm?: HitSessionUtm;
+}
+
 /**
  * 
  * @export
@@ -7621,7 +7659,8 @@ export namespace ConversationWebsocketMessage {
         ReadMessage = <any> 'read message',
         Typing = <any> 'typing',
         AddCoupon = <any> 'add coupon',
-        AddItem = <any> 'add item'
+        AddItem = <any> 'add item',
+        WebchatContext = <any> 'webchat context'
     }
     /**
      * @export
@@ -19663,6 +19702,308 @@ export interface HTTPHeader {
     value?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface HitPageView
+ */
+export interface HitPageView {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitPageView
+     */
+    bounce?: boolean;
+    /**
+     * 
+     * @type {Array<HitPageViewMetaData>}
+     * @memberof HitPageView
+     */
+    meta_data?: Array<HitPageViewMetaData>;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitPageView
+     */
+    method?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitPageView
+     */
+    prefetch?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitPageView
+     */
+    query?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitPageView
+     */
+    recording?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitPageView
+     */
+    redirect?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitPageView
+     */
+    referrer?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof HitPageView
+     */
+    time_on_page?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitPageView
+     */
+    title?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitPageView
+     */
+    url?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface HitPageViewMetaData
+ */
+export interface HitPageViewMetaData {
+    /**
+     * 
+     * @type {string}
+     * @memberof HitPageViewMetaData
+     */
+    key?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitPageViewMetaData
+     */
+    value?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface HitSessionStart
+ */
+export interface HitSessionStart {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    bot?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    bounce?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    channel?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    device_switch_detected?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    fake_bot?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    geolocation_country?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    geolocation_latitude?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    geolocation_longitude?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    geolocation_province?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    no_cookie_support?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    prefetch?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    referrer?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    screen_height?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    screen_width?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    time_on_Site?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    user_agent?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    user_ip?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface HitSessionUtm
+ */
+export interface HitSessionUtm {
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    fb_ad_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    fbclid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    gbraid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    gclid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    msclkid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    ttclid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    uc_message_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_campaign?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_content?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_medium?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_source?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_term?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    vmcid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    wbraid?: string;
+}
+
 /**
  * 
  * @export
@@ -41189,6 +41530,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get a webchat conversation context 
+         * @summary Get a webchat conversation context
+         * @param {string} conversation_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationContext(conversation_uuid: string, options: any = {}): FetchArgs {
+            // verify required parameter 'conversation_uuid' is not null or undefined
+            if (conversation_uuid === null || conversation_uuid === undefined) {
+                throw new RequiredError('conversation_uuid','Required parameter conversation_uuid was null or undefined when calling getConversationContext.');
+            }
+            const localVarPath = `/conversation/conversations/{conversation_uuid}/context`
+                .replace(`{${"conversation_uuid"}}`, encodeURIComponent(String(conversation_uuid)));
+            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", ["conversation_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 conversation messages since a particular time 
          * @summary Retrieve conversation messages
@@ -41707,6 +42100,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Get a webchat conversation context 
+         * @summary Get a webchat conversation context
+         * @param {string} conversation_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationContext(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatContext> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationContext(conversation_uuid, 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 conversation messages since a particular time 
          * @summary Retrieve conversation messages
@@ -41918,6 +42332,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         getConversation(conversation_uuid: string, limit?: number, options?: any) {
             return ConversationApiFp(configuration).getConversation(conversation_uuid, limit, options)(fetch, basePath);
         },
+        /**
+         * Get a webchat conversation context 
+         * @summary Get a webchat conversation context
+         * @param {string} conversation_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationContext(conversation_uuid: string, options?: any) {
+            return ConversationApiFp(configuration).getConversationContext(conversation_uuid, options)(fetch, basePath);
+        },
         /**
          * Retrieve conversation messages since a particular time 
          * @summary Retrieve conversation messages
@@ -42041,6 +42465,16 @@ export interface ConversationApiInterface {
      */
     getConversation(conversation_uuid: string, limit?: number, options?: any): Promise<ConversationResponse>;
 
+    /**
+     * Get a webchat conversation context 
+     * @summary Get a webchat conversation context
+     * @param {string} conversation_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
+
     /**
      * Retrieve conversation messages since a particular time 
      * @summary Retrieve conversation messages
@@ -42170,6 +42604,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).getConversation(conversation_uuid, limit, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Get a webchat conversation context 
+     * @summary Get a webchat conversation context
+     * @param {string} conversation_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public getConversationContext(conversation_uuid: string, options?: any) {
+        return ConversationApiFp(this.configuration).getConversationContext(conversation_uuid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieve conversation messages since a particular time 
      * @summary Retrieve conversation messages

package/dist/api.d.ts

@@ -7046,6 +7046,43 @@ export interface ConversationTwilioAccount {
      */
     twilio_phone_numbers?: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface ConversationWebchatContext
+ */
+export interface ConversationWebchatContext {
+    /**
+     *
+     * @type {Cart}
+     * @memberof ConversationWebchatContext
+     */
+    cart?: Cart;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationWebchatContext
+     */
+    current_url?: string;
+    /**
+     *
+     * @type {Array<HitPageView>}
+     * @memberof ConversationWebchatContext
+     */
+    page_view?: Array<HitPageView>;
+    /**
+     *
+     * @type {HitSessionStart}
+     * @memberof ConversationWebchatContext
+     */
+    session_start?: HitSessionStart;
+    /**
+     *
+     * @type {HitSessionUtm}
+     * @memberof ConversationWebchatContext
+     */
+    session_utm?: HitSessionUtm;
+}
 /**
  *
  * @export
@@ -7440,7 +7477,8 @@ export declare namespace ConversationWebsocketMessage {
         ReadMessage,
         Typing,
         AddCoupon,
-        AddItem
+        AddItem,
+        WebchatContext
     }
     /**
      * @export
@@ -19232,6 +19270,304 @@ export interface HTTPHeader {
      */
     value?: string;
 }
+/**
+ *
+ * @export
+ * @interface HitPageView
+ */
+export interface HitPageView {
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitPageView
+     */
+    bounce?: boolean;
+    /**
+     *
+     * @type {Array<HitPageViewMetaData>}
+     * @memberof HitPageView
+     */
+    meta_data?: Array<HitPageViewMetaData>;
+    /**
+     *
+     * @type {string}
+     * @memberof HitPageView
+     */
+    method?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitPageView
+     */
+    prefetch?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof HitPageView
+     */
+    query?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitPageView
+     */
+    recording?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitPageView
+     */
+    redirect?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof HitPageView
+     */
+    referrer?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof HitPageView
+     */
+    time_on_page?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof HitPageView
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitPageView
+     */
+    url?: string;
+}
+/**
+ *
+ * @export
+ * @interface HitPageViewMetaData
+ */
+export interface HitPageViewMetaData {
+    /**
+     *
+     * @type {string}
+     * @memberof HitPageViewMetaData
+     */
+    key?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitPageViewMetaData
+     */
+    value?: string;
+}
+/**
+ *
+ * @export
+ * @interface HitSessionStart
+ */
+export interface HitSessionStart {
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    bot?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    bounce?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    channel?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    device_switch_detected?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    fake_bot?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    geolocation_country?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    geolocation_latitude?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    geolocation_longitude?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    geolocation_province?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    no_cookie_support?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof HitSessionStart
+     */
+    prefetch?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    referrer?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    screen_height?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    screen_width?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof HitSessionStart
+     */
+    time_on_Site?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    user_agent?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionStart
+     */
+    user_ip?: string;
+}
+/**
+ *
+ * @export
+ * @interface HitSessionUtm
+ */
+export interface HitSessionUtm {
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    fb_ad_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    fbclid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    gbraid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    gclid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    msclkid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    ttclid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    uc_message_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_campaign?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_content?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_medium?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_source?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    utm_term?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    vmcid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HitSessionUtm
+     */
+    wbraid?: string;
+}
 /**
  *
  * @export
@@ -37320,6 +37656,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     getConversation(conversation_uuid: string, limit?: number, options?: any): FetchArgs;
+    /**
+     * Get a webchat conversation context
+     * @summary Get a webchat conversation context
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationContext(conversation_uuid: string, options?: any): FetchArgs;
     /**
      * Retrieve conversation messages since a particular time
      * @summary Retrieve conversation messages
@@ -37418,6 +37762,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getConversation(conversation_uuid: string, limit?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationResponse>;
+    /**
+     * Get a webchat conversation context
+     * @summary Get a webchat conversation context
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationContext(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatContext>;
     /**
      * Retrieve conversation messages since a particular time
      * @summary Retrieve conversation messages
@@ -37516,6 +37868,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     getConversation(conversation_uuid: string, limit?: number, options?: any): Promise<ConversationResponse>;
+    /**
+     * Get a webchat conversation context
+     * @summary Get a webchat conversation context
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
     /**
      * Retrieve conversation messages since a particular time
      * @summary Retrieve conversation messages
@@ -37618,6 +37978,15 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     getConversation(conversation_uuid: string, limit?: number, options?: any): Promise<ConversationResponse>;
+    /**
+     * Get a webchat conversation context
+     * @summary Get a webchat conversation context
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
     /**
      * Retrieve conversation messages since a particular time
      * @summary Retrieve conversation messages
@@ -37729,6 +38098,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     getConversation(conversation_uuid: string, limit?: number, options?: any): Promise<ConversationResponse>;
+    /**
+     * Get a webchat conversation context
+     * @summary Get a webchat conversation context
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
     /**
      * Retrieve conversation messages since a particular time
      * @summary Retrieve conversation messages

package/dist/api.js

@@ -507,6 +507,7 @@ var ConversationWebsocketMessage;
         EventTypeEnum[EventTypeEnum["Typing"] = 'typing'] = "Typing";
         EventTypeEnum[EventTypeEnum["AddCoupon"] = 'add coupon'] = "AddCoupon";
         EventTypeEnum[EventTypeEnum["AddItem"] = 'add item'] = "AddItem";
+        EventTypeEnum[EventTypeEnum["WebchatContext"] = 'webchat context'] = "WebchatContext";
     })(EventTypeEnum = ConversationWebsocketMessage.EventTypeEnum || (ConversationWebsocketMessage.EventTypeEnum = {}));
     /**
      * @export
@@ -5589,6 +5590,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get a webchat conversation context
+         * @summary Get a webchat conversation context
+         * @param {string} conversation_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationContext: function (conversation_uuid, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'conversation_uuid' is not null or undefined
+            if (conversation_uuid === null || conversation_uuid === undefined) {
+                throw new RequiredError('conversation_uuid', 'Required parameter conversation_uuid was null or undefined when calling getConversationContext.');
+            }
+            var localVarPath = "/conversation/conversations/{conversation_uuid}/context"
+                .replace("{".concat("conversation_uuid", "}"), encodeURIComponent(String(conversation_uuid)));
+            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", ["conversation_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 conversation messages since a particular time
          * @summary Retrieve conversation messages
@@ -6055,6 +6102,28 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Get a webchat conversation context
+         * @summary Get a webchat conversation context
+         * @param {string} conversation_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationContext: function (conversation_uuid, options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationContext(conversation_uuid, 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 conversation messages since a particular time
          * @summary Retrieve conversation messages
@@ -6274,6 +6343,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         getConversation: function (conversation_uuid, limit, options) {
             return (0, exports.ConversationApiFp)(configuration).getConversation(conversation_uuid, limit, options)(fetch, basePath);
         },
+        /**
+         * Get a webchat conversation context
+         * @summary Get a webchat conversation context
+         * @param {string} conversation_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationContext: function (conversation_uuid, options) {
+            return (0, exports.ConversationApiFp)(configuration).getConversationContext(conversation_uuid, options)(fetch, basePath);
+        },
         /**
          * Retrieve conversation messages since a particular time
          * @summary Retrieve conversation messages
@@ -6405,6 +6484,17 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.getConversation = function (conversation_uuid, limit, options) {
         return (0, exports.ConversationApiFp)(this.configuration).getConversation(conversation_uuid, limit, options)(this.fetch, this.basePath);
     };
+    /**
+     * Get a webchat conversation context
+     * @summary Get a webchat conversation context
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.getConversationContext = function (conversation_uuid, options) {
+        return (0, exports.ConversationApiFp)(this.configuration).getConversationContext(conversation_uuid, options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieve conversation messages since a particular time
      * @summary Retrieve conversation messages

package/package.json

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