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

package/build/api.d.ts

@@ -561,6 +561,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
@@ -579,10 +617,17 @@ export interface Conversation {
      * @memberof Conversation
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof Conversation
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof Conversation
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -598,12 +643,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}
@@ -630,12 +682,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}
@@ -661,32 +720,113 @@ 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 declare const ConversationBaseEnvironmentPropsChannelResolutionPathEnum: {
+    readonly Production: "twilio_production";
+    readonly LegacyPmt: "twilio_legacy_pmt";
+    readonly FreeBridge: "twilio_free_bridge";
+};
+export type ConversationBaseEnvironmentPropsChannelResolutionPathEnum = typeof ConversationBaseEnvironmentPropsChannelResolutionPathEnum[keyof typeof ConversationBaseEnvironmentPropsChannelResolutionPathEnum];
+/**
+ * Canonical channel that initiated and should continue the customer conversation.
+ * @export
+ * @enum {string}
+ */
+export declare const ConversationChannel: {
+    readonly Web: "web";
+    readonly DemoPhoneTest: "demo_phone_test";
+    readonly SmsPhone: "sms_phone";
+    readonly Outlook: "outlook";
+    readonly Gmail: "gmail";
+    readonly Iphone: "iphone";
+    readonly Android: "android";
+    readonly Teams: "teams";
+    readonly Discord: "discord";
+    readonly Whatsapp: "whatsapp";
+};
+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 declare const ConversationChannelPropsChannelResolutionPathEnum: {
+    readonly Production: "twilio_production";
+    readonly LegacyPmt: "twilio_legacy_pmt";
+    readonly FreeBridge: "twilio_free_bridge";
+};
+export type ConversationChannelPropsChannelResolutionPathEnum = typeof ConversationChannelPropsChannelResolutionPathEnum[keyof typeof ConversationChannelPropsChannelResolutionPathEnum];
 /**
  *
  * @export
@@ -861,10 +1001,17 @@ export interface ConversationCreateRequest {
      * @memberof ConversationCreateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ConversationCreateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationCreateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -880,12 +1027,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}
@@ -975,7 +1129,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}
  */
@@ -1003,10 +1157,17 @@ export interface ConversationGetResponse {
      * @memberof ConversationGetResponse
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ConversationGetResponse
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationGetResponse
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -1022,12 +1183,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}
@@ -1152,10 +1320,17 @@ export interface ConversationUpdateRequest {
      * @memberof ConversationUpdateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ConversationUpdateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationUpdateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -1246,10 +1421,17 @@ export interface ConversationWithId {
      * @memberof ConversationWithId
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ConversationWithId
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationWithId
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -1265,12 +1447,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}
@@ -1858,12 +2047,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}
@@ -2714,6 +2910,12 @@ export interface GenerateResponse {
      * @memberof GenerateResponse
      */
     'confidence'?: number;
+    /**
+     *
+     * @type {TokenUsage}
+     * @memberof GenerateResponse
+     */
+    'usage'?: TokenUsage;
 }
 /**
  *
@@ -3247,10 +3449,17 @@ export interface ListConversationsResponseInner {
      * @memberof ListConversationsResponseInner
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ListConversationsResponseInner
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ListConversationsResponseInner
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -3266,12 +3475,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}
@@ -5235,10 +5451,17 @@ export interface MessageCreateRequestConvoOneOf {
      * @memberof MessageCreateRequestConvoOneOf
      */
     'agentIdOrPhoneOrEmail'?: string;
+    /**
+     *
+     * @type {ConversationChannel}
+     * @memberof MessageCreateRequestConvoOneOf
+     */
+    'channel'?: ConversationChannel;
     /**
      *
      * @type {ConversationEnvironment}
      * @memberof MessageCreateRequestConvoOneOf
+     * @deprecated
      */
     'environment'?: ConversationEnvironment;
 }
@@ -5782,7 +6005,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}
@@ -5801,6 +6030,12 @@ export interface PmtTransformResponse {
      * @memberof PmtTransformResponse
      */
     'errors'?: Array<string>;
+    /**
+     *
+     * @type {TokenUsage}
+     * @memberof PmtTransformResponse
+     */
+    'usage'?: TokenUsage;
 }
 export declare const PmtTransformResponseTypeEnum: {
     readonly Question: "question";
@@ -5926,10 +6161,17 @@ export interface ScheduleCreateRequest {
      * @memberof ScheduleCreateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleCreateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleCreateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -5945,12 +6187,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}
@@ -6044,10 +6293,17 @@ export interface ScheduleGetResponse {
      * @memberof ScheduleGetResponse
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGetResponse
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGetResponse
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6063,12 +6319,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}
@@ -6136,10 +6399,17 @@ export interface ScheduleGroupCreateRequest {
      * @memberof ScheduleGroupCreateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGroupCreateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGroupCreateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6234,10 +6504,17 @@ export interface ScheduleGroupGetResponse {
      * @memberof ScheduleGroupGetResponse
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGroupGetResponse
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGroupGetResponse
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6351,10 +6628,17 @@ export interface ScheduleGroupUpdateRequest {
      * @memberof ScheduleGroupUpdateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGroupUpdateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGroupUpdateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6481,10 +6765,17 @@ export interface ScheduleUpdateRequest {
      * @memberof ScheduleUpdateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleUpdateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleUpdateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6500,12 +6791,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}
@@ -6599,10 +6897,17 @@ export interface ScheduledConversation {
      * @memberof ScheduledConversation
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ScheduledConversation
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduledConversation
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6618,12 +6923,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}
@@ -6686,10 +6998,17 @@ export interface ScheduledConversationGroup {
      * @memberof ScheduledConversationGroup
      */
     'initialContexts'?: Array<string>;
+    /**
+     *
+     * @type {ConversationChannelProps}
+     * @memberof ScheduledConversationGroup
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      *
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduledConversationGroup
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6804,6 +7123,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
@@ -7466,6 +7872,12 @@ export interface WorkflowResponseSlot {
      * @memberof WorkflowResponseSlot
      */
     'resetIntent'?: boolean;
+    /**
+     *
+     * @type {TokenUsage}
+     * @memberof WorkflowResponseSlot
+     */
+    'usage'?: TokenUsage;
 }
 /**
  * @type WorkflowResponseSlotForward
@@ -7655,6 +8067,14 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     config: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets a conversation
@@ -8150,6 +8570,14 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     config(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Config200Response>>;
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContextualizerResponse>>;
     /**
      *
      * @summary Gets a conversation
@@ -8651,6 +9079,14 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     config(options?: any): AxiosPromise<Config200Response>;
+    /**
+     * 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>;
     /**
      *
      * @summary Gets a conversation
@@ -9165,6 +9601,15 @@ export declare class Scout9ApiGenerated extends BaseAPI {
      * @memberof Scout9Api
      */
     config(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Config200Response, any>>;
+    /**
+     * 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
+     */
+    contextualize(contextualizerRequest: ContextualizerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextualizerResponse, any>>;
     /**
      *
      * @summary Gets a conversation