@scout9/admin 1.0.0-alpha.0.0.69 → 1.0.0-alpha.0.0.70

package/src/api.ts

@@ -308,6 +308,25 @@ export interface BlockInfo {
      */
     'time'?: string;
 }
+/**
+ * Command-flow configuration attached to this conversation.
+ * @export
+ * @interface CommandConfiguration
+ */
+export interface CommandConfiguration {
+    /**
+     * Command entity id.
+     * @type {string}
+     * @memberof CommandConfiguration
+     */
+    'entity': string;
+    /**
+     * Command route/path.
+     * @type {string}
+     * @memberof CommandConfiguration
+     */
+    'path': string;
+}
 /**
  * @type Condition
  * @export
@@ -628,13 +647,7 @@ export interface Conversation {
      */
     '$id'?: string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof Conversation
-     */
-    '$business': string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof Conversation
      */
@@ -736,17 +749,17 @@ export interface Conversation {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof Conversation
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof Conversation
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -773,6 +786,65 @@ export const ConversationIngressEnum = {
 
 export type ConversationIngressEnum = typeof ConversationIngressEnum[keyof typeof ConversationIngressEnum];
 
+/**
+ * Metadata for anticipating a preflight response.
+ * @export
+ * @interface ConversationAnticipate
+ */
+export interface ConversationAnticipate {
+    /**
+     * Determines the runtime to address the next response.
+     * @type {string}
+     * @memberof ConversationAnticipate
+     */
+    'type': ConversationAnticipateTypeEnum;
+    /**
+     * Slot values collected or expected by anticipation logic.
+     * @type {{ [key: string]: Array<any>; }}
+     * @memberof ConversationAnticipate
+     */
+    'slots': { [key: string]: Array<any>; };
+    /**
+     * For type \'did\'.
+     * @type {string}
+     * @memberof ConversationAnticipate
+     */
+    'did'?: string;
+    /**
+     * For literal keywords, this map helps identify which slot the keyword matches.
+     * @type {Array<ConversationAnticipateMapInner>}
+     * @memberof ConversationAnticipate
+     */
+    'map'?: Array<ConversationAnticipateMapInner>;
+}
+
+export const ConversationAnticipateTypeEnum = {
+    Did: 'did',
+    Literal: 'literal',
+    Context: 'context'
+} as const;
+
+export type ConversationAnticipateTypeEnum = typeof ConversationAnticipateTypeEnum[keyof typeof ConversationAnticipateTypeEnum];
+
+/**
+ * 
+ * @export
+ * @interface ConversationAnticipateMapInner
+ */
+export interface ConversationAnticipateMapInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationAnticipateMapInner
+     */
+    'slot': string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ConversationAnticipateMapInner
+     */
+    'keywords': Array<string>;
+}
 /**
  * Base props all conversation types will have
  * @export
@@ -786,13 +858,7 @@ export interface ConversationBase {
      */
     '$id'?: string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ConversationBase
-     */
-    '$business'?: string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ConversationBase
      */
@@ -894,17 +960,17 @@ export interface ConversationBase {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ConversationBase
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ConversationBase
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -1160,13 +1226,7 @@ export interface ConversationCreateRequest {
      */
     '$id'?: string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ConversationCreateRequest
-     */
-    '$business': string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ConversationCreateRequest
      */
@@ -1268,17 +1328,17 @@ export interface ConversationCreateRequest {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ConversationCreateRequest
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ConversationCreateRequest
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -1399,13 +1459,7 @@ export interface ConversationGetResponse {
      */
     '$id': string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ConversationGetResponse
-     */
-    '$business': string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ConversationGetResponse
      */
@@ -1507,17 +1561,17 @@ export interface ConversationGetResponse {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ConversationGetResponse
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ConversationGetResponse
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -1644,13 +1698,7 @@ export interface ConversationUpdateRequest {
      */
     '$id': string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ConversationUpdateRequest
-     */
-    '$business'?: string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ConversationUpdateRequest
      */
@@ -1752,17 +1800,17 @@ export interface ConversationUpdateRequest {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ConversationUpdateRequest
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ConversationUpdateRequest
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -1865,13 +1913,7 @@ export interface ConversationWithId {
      */
     '$id': string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ConversationWithId
-     */
-    '$business': string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ConversationWithId
      */
@@ -1973,17 +2015,17 @@ export interface ConversationWithId {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ConversationWithId
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ConversationWithId
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -3993,13 +4035,7 @@ export interface ListConversationsResponseInner {
      */
     '$id': string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ListConversationsResponseInner
-     */
-    '$business': string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ListConversationsResponseInner
      */
@@ -4101,17 +4137,17 @@ export interface ListConversationsResponseInner {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ListConversationsResponseInner
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ListConversationsResponseInner
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -6869,13 +6905,7 @@ export interface ScheduleCreateRequest {
      */
     '$id'?: string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ScheduleCreateRequest
-     */
-    '$business': string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ScheduleCreateRequest
      */
@@ -6977,17 +7007,17 @@ export interface ScheduleCreateRequest {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ScheduleCreateRequest
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ScheduleCreateRequest
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -7095,13 +7125,7 @@ export interface ScheduleGetResponse {
      */
     '$id'?: string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ScheduleGetResponse
-     */
-    '$business': string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ScheduleGetResponse
      */
@@ -7203,17 +7227,17 @@ export interface ScheduleGetResponse {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ScheduleGetResponse
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ScheduleGetResponse
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -7295,13 +7319,7 @@ export interface ScheduleGroupCreateRequest {
      */
     '$id'?: string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ScheduleGroupCreateRequest
-     */
-    '$business'?: string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ScheduleGroupCreateRequest
      */
@@ -7403,17 +7421,17 @@ export interface ScheduleGroupCreateRequest {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ScheduleGroupCreateRequest
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ScheduleGroupCreateRequest
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -7527,13 +7545,7 @@ export interface ScheduleGroupGetResponse {
      */
     '$id': string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ScheduleGroupGetResponse
-     */
-    '$business'?: string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ScheduleGroupGetResponse
      */
@@ -7635,17 +7647,17 @@ export interface ScheduleGroupGetResponse {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ScheduleGroupGetResponse
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ScheduleGroupGetResponse
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -7771,13 +7783,7 @@ export interface ScheduleGroupUpdateRequest {
      */
     '$id': string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ScheduleGroupUpdateRequest
-     */
-    '$business'?: string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ScheduleGroupUpdateRequest
      */
@@ -7879,17 +7885,17 @@ export interface ScheduleGroupUpdateRequest {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ScheduleGroupUpdateRequest
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ScheduleGroupUpdateRequest
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -8028,13 +8034,7 @@ export interface ScheduleUpdateRequest {
      */
     '$id'?: string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ScheduleUpdateRequest
-     */
-    '$business': string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ScheduleUpdateRequest
      */
@@ -8136,17 +8136,17 @@ export interface ScheduleUpdateRequest {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ScheduleUpdateRequest
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ScheduleUpdateRequest
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -8248,13 +8248,7 @@ export interface ScheduledConversation {
      */
     '$id'?: string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ScheduledConversation
-     */
-    '$business': string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ScheduledConversation
      */
@@ -8356,17 +8350,17 @@ export interface ScheduledConversation {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ScheduledConversation
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ScheduledConversation
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}
@@ -8443,13 +8437,7 @@ export interface ScheduledConversationGroup {
      */
     '$id'?: string;
     /**
-     * Business/organization this conversation belongs to
-     * @type {string}
-     * @memberof ScheduledConversationGroup
-     */
-    '$business'?: string;
-    /**
-     * Default agent persona id assigned to the conversation(s)
+     * The user id assigned to this conversation
      * @type {string}
      * @memberof ScheduledConversationGroup
      */
@@ -8551,17 +8539,17 @@ export interface ScheduledConversationGroup {
      */
     'metadata'?: { [key: string]: any; };
     /**
-     * Metadata for anticipating a preflight response.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {ConversationAnticipate}
      * @memberof ScheduledConversationGroup
      */
-    'anticipate'?: { [key: string]: any; };
+    'anticipate'?: ConversationAnticipate;
     /**
-     * Command-flow configuration attached to this conversation.
-     * @type {{ [key: string]: any; }}
+     * 
+     * @type {CommandConfiguration}
      * @memberof ScheduledConversationGroup
      */
-    'command'?: { [key: string]: any; };
+    'command'?: CommandConfiguration;
     /**
      * Overrides the Persona Model ingress mode for this conversation.
      * @type {string}