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

package/src/api.ts

@@ -633,10 +633,17 @@ export interface Conversation {
      * @memberof Conversation
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof Conversation
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof Conversation
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -652,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}
@@ -686,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}
@@ -719,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
@@ -922,10 +1035,17 @@ export interface ConversationCreateRequest {
      * @memberof ConversationCreateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ConversationCreateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationCreateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -941,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}
@@ -1038,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}
  */
@@ -1070,10 +1197,17 @@ export interface ConversationGetResponse {
      * @memberof ConversationGetResponse
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ConversationGetResponse
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationGetResponse
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -1089,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}
@@ -1221,10 +1362,17 @@ export interface ConversationUpdateRequest {
      * @memberof ConversationUpdateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ConversationUpdateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationUpdateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -1315,10 +1463,17 @@ export interface ConversationWithId {
      * @memberof ConversationWithId
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ConversationWithId
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ConversationWithId
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -1334,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}
@@ -1926,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}
@@ -3343,10 +3512,17 @@ export interface ListConversationsResponseInner {
      * @memberof ListConversationsResponseInner
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ListConversationsResponseInner
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ListConversationsResponseInner
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -3362,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}
@@ -5410,10 +5593,17 @@ export interface MessageCreateRequestConvoOneOf {
      * @memberof MessageCreateRequestConvoOneOf
      */
     'agentIdOrPhoneOrEmail'?: string;
+    /**
+     * 
+     * @type {ConversationChannel}
+     * @memberof MessageCreateRequestConvoOneOf
+     */
+    'channel'?: ConversationChannel;
     /**
      * 
      * @type {ConversationEnvironment}
      * @memberof MessageCreateRequestConvoOneOf
+     * @deprecated
      */
     'environment'?: ConversationEnvironment;
 }
@@ -5962,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}
@@ -6119,10 +6315,17 @@ export interface ScheduleCreateRequest {
      * @memberof ScheduleCreateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleCreateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleCreateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6138,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}
@@ -6239,10 +6449,17 @@ export interface ScheduleGetResponse {
      * @memberof ScheduleGetResponse
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGetResponse
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGetResponse
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6258,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}
@@ -6333,10 +6557,17 @@ export interface ScheduleGroupCreateRequest {
      * @memberof ScheduleGroupCreateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGroupCreateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGroupCreateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6432,10 +6663,17 @@ export interface ScheduleGroupGetResponse {
      * @memberof ScheduleGroupGetResponse
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGroupGetResponse
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGroupGetResponse
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6549,10 +6787,17 @@ export interface ScheduleGroupUpdateRequest {
      * @memberof ScheduleGroupUpdateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleGroupUpdateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleGroupUpdateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6679,10 +6924,17 @@ export interface ScheduleUpdateRequest {
      * @memberof ScheduleUpdateRequest
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduleUpdateRequest
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduleUpdateRequest
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6698,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}
@@ -6799,10 +7058,17 @@ export interface ScheduledConversation {
      * @memberof ScheduledConversation
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduledConversation
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduledConversation
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**
@@ -6818,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}
@@ -6888,10 +7161,17 @@ export interface ScheduledConversationGroup {
      * @memberof ScheduledConversationGroup
      */
     'initialContexts'?: Array<string>;
+    /**
+     * 
+     * @type {ConversationChannelProps}
+     * @memberof ScheduledConversationGroup
+     */
+    'channelProps'?: ConversationChannelProps;
     /**
      * 
      * @type {ConversationBaseEnvironmentProps}
      * @memberof ScheduledConversationGroup
+     * @deprecated
      */
     'environmentProps'?: ConversationBaseEnvironmentProps;
     /**