@scout9/admin 1.0.0-alpha.0.0.66 → 1.0.0-alpha.0.0.68

package/src/api.ts

@@ -577,6 +577,44 @@ export interface ContextTrainingInner {
      */
     'text': string;
 }
+/**
+ * 
+ * @export
+ * @interface ContextualizerRequest
+ */
+export interface ContextualizerRequest {
+    /**
+     * 
+     * @type {Array<Message>}
+     * @memberof ContextualizerRequest
+     */
+    'messages': Array<Message>;
+    /**
+     * 
+     * @type {Conversation}
+     * @memberof ContextualizerRequest
+     */
+    'conversation': Conversation;
+}
+/**
+ * 
+ * @export
+ * @interface ContextualizerResponse
+ */
+export interface ContextualizerResponse {
+    /**
+     * 
+     * @type {Array<Message>}
+     * @memberof ContextualizerResponse
+     */
+    'messages': Array<Message>;
+    /**
+     * 
+     * @type {TokenUsage}
+     * @memberof ContextualizerResponse
+     */
+    'usage'?: TokenUsage;
+}
 /**
  * 
  * @export
@@ -595,10 +633,17 @@ export interface Conversation {
      * @memberof Conversation
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof Conversation
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof Conversation
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -614,12 +659,19 @@ export interface Conversation {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof Conversation
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof Conversation
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -648,12 +700,19 @@ export interface ConversationAllOf {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof ConversationAllOf
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof ConversationAllOf
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -681,32 +740,124 @@ export interface ConversationBase {
      * @memberof ConversationBase
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ConversationBase
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationBase
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
 }
 /**
- * Environment properties for the conversation
+ * Deprecated legacy environment properties. Use channelProps.
  * @export
  * @interface ConversationBaseEnvironmentProps
  */
 export interface ConversationBaseEnvironmentProps {
     /**
-     * HTML subject line
+     * Subject line for email-style channels such as Gmail and Outlook.
      * @type {string}
      * @memberof ConversationBaseEnvironmentProps
      */
     'subject'?: string;
     /**
-     * Used to sync email messages with the conversation
+     * Provider thread id used to sync Gmail/Outlook channel messages with this conversation.
      * @type {string}
      * @memberof ConversationBaseEnvironmentProps
      */
     'platformEmailThreadId'?: string;
+    /**
+     * Twilio message sid that initiated this conversation.
+     * @type {string}
+     * @memberof ConversationBaseEnvironmentProps
+     */
+    'smsMessageSid'?: string;
+    /**
+     * Persisted channel-resolution path used for the current conversation.
+     * @type {string}
+     * @memberof ConversationBaseEnvironmentProps
+     */
+    'channelResolutionPath'?: ConversationBaseEnvironmentPropsChannelResolutionPathEnum;
 }
+
+export const ConversationBaseEnvironmentPropsChannelResolutionPathEnum = {
+    Production: 'twilio_production',
+    LegacyPmt: 'twilio_legacy_pmt',
+    FreeBridge: 'twilio_free_bridge'
+} as const;
+
+export type ConversationBaseEnvironmentPropsChannelResolutionPathEnum = typeof ConversationBaseEnvironmentPropsChannelResolutionPathEnum[keyof typeof ConversationBaseEnvironmentPropsChannelResolutionPathEnum];
+
+/**
+ * Canonical channel that initiated and should continue the customer conversation.
+ * @export
+ * @enum {string}
+ */
+
+export const ConversationChannel = {
+    Web: 'web',
+    DemoPhoneTest: 'demo_phone_test',
+    SmsPhone: 'sms_phone',
+    Outlook: 'outlook',
+    Gmail: 'gmail',
+    Iphone: 'iphone',
+    Android: 'android',
+    Teams: 'teams',
+    Discord: 'discord',
+    Whatsapp: 'whatsapp'
+} as const;
+
+export type ConversationChannel = typeof ConversationChannel[keyof typeof ConversationChannel];
+
+
+/**
+ * Channel-specific properties needed to continue a conversation on its canonical channel.
+ * @export
+ * @interface ConversationChannelProps
+ */
+export interface ConversationChannelProps {
+    [key: string]: any;
+
+    /**
+     * Subject line for email-style channels such as Gmail and Outlook.
+     * @type {string}
+     * @memberof ConversationChannelProps
+     */
+    'subject'?: string;
+    /**
+     * Provider thread id used to sync Gmail/Outlook channel messages with this conversation.
+     * @type {string}
+     * @memberof ConversationChannelProps
+     */
+    'platformEmailThreadId'?: string;
+    /**
+     * Twilio message sid that initiated this conversation.
+     * @type {string}
+     * @memberof ConversationChannelProps
+     */
+    'smsMessageSid'?: string;
+    /**
+     * Persisted channel-resolution path used for the current conversation.
+     * @type {string}
+     * @memberof ConversationChannelProps
+     */
+    'channelResolutionPath'?: ConversationChannelPropsChannelResolutionPathEnum;
+}
+
+export const ConversationChannelPropsChannelResolutionPathEnum = {
+    Production: 'twilio_production',
+    LegacyPmt: 'twilio_legacy_pmt',
+    FreeBridge: 'twilio_free_bridge'
+} as const;
+
+export type ConversationChannelPropsChannelResolutionPathEnum = typeof ConversationChannelPropsChannelResolutionPathEnum[keyof typeof ConversationChannelPropsChannelResolutionPathEnum];
+
 /**
  * 
  * @export
@@ -884,10 +1035,17 @@ export interface ConversationCreateRequest {
      * @memberof ConversationCreateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ConversationCreateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationCreateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -903,12 +1061,19 @@ export interface ConversationCreateRequest {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof ConversationCreateRequest
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof ConversationCreateRequest
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -1000,7 +1165,7 @@ export interface ConversationCreateResponseAllOf {
     'initiated': string;
 }
 /**
- * Environment this conversation is in (phone, web, or email) - this determines which device to send messages to
+ * Deprecated broad environment bucket (phone, web, or email). Use ConversationChannel for routing.
  * @export
  * @enum {string}
  */
@@ -1032,10 +1197,17 @@ export interface ConversationGetResponse {
      * @memberof ConversationGetResponse
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ConversationGetResponse
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationGetResponse
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -1051,12 +1223,19 @@ export interface ConversationGetResponse {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof ConversationGetResponse
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof ConversationGetResponse
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -1183,10 +1362,17 @@ export interface ConversationUpdateRequest {
      * @memberof ConversationUpdateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ConversationUpdateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationUpdateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -1277,10 +1463,17 @@ export interface ConversationWithId {
      * @memberof ConversationWithId
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ConversationWithId
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationWithId
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -1296,12 +1489,19 @@ export interface ConversationWithId {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof ConversationWithId
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof ConversationWithId
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -1888,12 +2088,19 @@ export interface CustomerGroupRecord {
      * @memberof CustomerGroupRecord
      */
     'id': string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof CustomerGroupRecord
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof CustomerGroupRecord
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Overrides the default $agent for this customer
      * @type {string}
@@ -2766,6 +2973,12 @@ export interface GenerateResponse {
      * @memberof GenerateResponse
      */
     'confidence'?: number;
+    /**
+     * 
+     * @type {TokenUsage}
+     * @memberof GenerateResponse
+     */
+    'usage'?: TokenUsage;
 }
 /**
  * 
@@ -3299,10 +3512,17 @@ export interface ListConversationsResponseInner {
      * @memberof ListConversationsResponseInner
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ListConversationsResponseInner
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ListConversationsResponseInner
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -3318,12 +3538,19 @@ export interface ListConversationsResponseInner {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof ListConversationsResponseInner
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof ListConversationsResponseInner
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -5366,10 +5593,17 @@ export interface MessageCreateRequestConvoOneOf {
      * @memberof MessageCreateRequestConvoOneOf
      */
     'agentIdOrPhoneOrEmail'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof MessageCreateRequestConvoOneOf
+     */
+    'channel'?: ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof MessageCreateRequestConvoOneOf
+     * @deprecated
      */
     'environment'?: ConversationEnvironment;
 }
@@ -5918,7 +6152,13 @@ export interface PmtTransformResponse {
      * @type {string}
      * @memberof PmtTransformResponse
      */
-    'message': string;
+    'message'?: string;
+    /**
+     * Formatted persona responses
+     * @type {Array<Message>}
+     * @memberof PmtTransformResponse
+     */
+    'messages'?: Array<Message>;
     /**
      * How confident this message meets the persona\'s own words
      * @type {number}
@@ -5937,6 +6177,12 @@ export interface PmtTransformResponse {
      * @memberof PmtTransformResponse
      */
     'errors'?: Array<string>;
+    /**
+     * 
+     * @type {TokenUsage}
+     * @memberof PmtTransformResponse
+     */
+    'usage'?: TokenUsage;
 }
 
 export const PmtTransformResponseTypeEnum = {
@@ -6069,10 +6315,17 @@ export interface ScheduleCreateRequest {
      * @memberof ScheduleCreateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleCreateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleCreateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6088,12 +6341,19 @@ export interface ScheduleCreateRequest {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof ScheduleCreateRequest
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof ScheduleCreateRequest
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -6189,10 +6449,17 @@ export interface ScheduleGetResponse {
      * @memberof ScheduleGetResponse
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGetResponse
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGetResponse
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6208,12 +6475,19 @@ export interface ScheduleGetResponse {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof ScheduleGetResponse
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof ScheduleGetResponse
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -6283,10 +6557,17 @@ export interface ScheduleGroupCreateRequest {
      * @memberof ScheduleGroupCreateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGroupCreateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGroupCreateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6382,10 +6663,17 @@ export interface ScheduleGroupGetResponse {
      * @memberof ScheduleGroupGetResponse
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGroupGetResponse
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGroupGetResponse
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6499,10 +6787,17 @@ export interface ScheduleGroupUpdateRequest {
      * @memberof ScheduleGroupUpdateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGroupUpdateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGroupUpdateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6629,10 +6924,17 @@ export interface ScheduleUpdateRequest {
      * @memberof ScheduleUpdateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleUpdateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleUpdateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6648,12 +6950,19 @@ export interface ScheduleUpdateRequest {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof ScheduleUpdateRequest
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof ScheduleUpdateRequest
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -6749,10 +7058,17 @@ export interface ScheduledConversation {
      * @memberof ScheduledConversation
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduledConversation
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduledConversation
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6768,12 +7084,19 @@ export interface ScheduledConversation {
      * @deprecated
      */
     '$customer'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof ScheduledConversation
+     */
+    'channel': ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof ScheduledConversation
+     * @deprecated
      */
-    'environment': ConversationEnvironment;
+    'environment'?: ConversationEnvironment;
     /**
      * Whether this conversation is a test or not
      * @type {boolean}
@@ -6838,10 +7161,17 @@ export interface ScheduledConversationGroup {
      * @memberof ScheduledConversationGroup
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduledConversationGroup
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduledConversationGroup
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6956,6 +7286,93 @@ export interface Scout9ProjectConfig {
      */
     'pmt': PmtConfig;
 }
+/**
+ * Usage statistics for the completion request
+ * @export
+ * @interface TokenUsage
+ */
+export interface TokenUsage {
+    /**
+     * Number of tokens in the generated completion
+     * @type {number}
+     * @memberof TokenUsage
+     */
+    'completion_tokens': number;
+    /**
+     * Number of tokens in the prompt
+     * @type {number}
+     * @memberof TokenUsage
+     */
+    'prompt_tokens': number;
+    /**
+     * Total number of tokens used in the request (prompt + completion)
+     * @type {number}
+     * @memberof TokenUsage
+     */
+    'total_tokens': number;
+    /**
+     * 
+     * @type {TokenUsageCompletionTokensDetails}
+     * @memberof TokenUsage
+     */
+    'completion_tokens_details'?: TokenUsageCompletionTokensDetails;
+    /**
+     * 
+     * @type {TokenUsagePromptTokensDetails}
+     * @memberof TokenUsage
+     */
+    'prompt_tokens_details'?: TokenUsagePromptTokensDetails;
+}
+/**
+ * Breakdown of tokens used in a completion
+ * @export
+ * @interface TokenUsageCompletionTokensDetails
+ */
+export interface TokenUsageCompletionTokensDetails {
+    /**
+     * Number of prediction tokens that appeared in the completion
+     * @type {number}
+     * @memberof TokenUsageCompletionTokensDetails
+     */
+    'accepted_prediction_tokens'?: number;
+    /**
+     * Audio input tokens generated by the model
+     * @type {number}
+     * @memberof TokenUsageCompletionTokensDetails
+     */
+    'audio_tokens'?: number;
+    /**
+     * Tokens generated by the model for reasoning
+     * @type {number}
+     * @memberof TokenUsageCompletionTokensDetails
+     */
+    'reasoning_tokens'?: number;
+    /**
+     * Number of prediction tokens that did not appear in the completion
+     * @type {number}
+     * @memberof TokenUsageCompletionTokensDetails
+     */
+    'rejected_prediction_tokens'?: number;
+}
+/**
+ * Breakdown of tokens used in the prompt
+ * @export
+ * @interface TokenUsagePromptTokensDetails
+ */
+export interface TokenUsagePromptTokensDetails {
+    /**
+     * Audio input tokens present in the prompt
+     * @type {number}
+     * @memberof TokenUsagePromptTokensDetails
+     */
+    'audio_tokens'?: number;
+    /**
+     * Cached tokens present in the prompt
+     * @type {number}
+     * @memberof TokenUsagePromptTokensDetails
+     */
+    'cached_tokens'?: number;
+}
 /**
  * 
  * @export
@@ -7616,6 +8033,12 @@ export interface WorkflowResponseSlot {
      * @memberof WorkflowResponseSlot
      */
     'resetIntent'?: boolean;
+    /**
+     * 
+     * @type {TokenUsage}
+     * @memberof WorkflowResponseSlot
+     */
+    'usage'?: TokenUsage;
 }
 /**
  * @type WorkflowResponseSlotForward
@@ -8173,6 +8596,42 @@ export const Scout9ApiAxiosParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Runs contextualization on workflow event messages and returns contextualized messages. 
+         * @summary Contextualize workflow event messages
+         * @param {ContextualizerRequest} contextualizerRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        contextualize: async (contextualizerRequest: ContextualizerRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'contextualizerRequest' is not null or undefined
+            assertParamExists('contextualize', 'contextualizerRequest', contextualizerRequest)
+            const localVarPath = `/v1-contextualize`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(contextualizerRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Gets a conversation
@@ -10112,6 +10571,17 @@ export const Scout9ApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.config(options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Runs contextualization on workflow event messages and returns contextualized messages. 
+         * @summary Contextualize workflow event messages
+         * @param {ContextualizerRequest} contextualizerRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async contextualize(contextualizerRequest: ContextualizerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextualizerResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.contextualize(contextualizerRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * 
          * @summary Gets a conversation
@@ -10774,6 +11244,16 @@ export const Scout9ApiFactory = function (configuration?: Configuration, basePat
         config(options?: any): AxiosPromise<Config200Response> {
             return localVarFp.config(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Runs contextualization on workflow event messages and returns contextualized messages. 
+         * @summary Contextualize workflow event messages
+         * @param {ContextualizerRequest} contextualizerRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        contextualize(contextualizerRequest: ContextualizerRequest, options?: any): AxiosPromise<ContextualizerResponse> {
+            return localVarFp.contextualize(contextualizerRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Gets a conversation
@@ -11411,6 +11891,18 @@ export class Scout9ApiGenerated extends BaseAPI {
         return Scout9ApiFp(this.configuration).config(options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Runs contextualization on workflow event messages and returns contextualized messages. 
+     * @summary Contextualize workflow event messages
+     * @param {ContextualizerRequest} contextualizerRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    public contextualize(contextualizerRequest: ContextualizerRequest, options?: AxiosRequestConfig) {
+        return Scout9ApiFp(this.configuration).contextualize(contextualizerRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Gets a conversation