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

package/build/api.d.ts

@@ -293,6 +293,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
@@ -612,13 +631,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
      */
@@ -722,21 +735,17 @@ export interface Conversation {
         [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}
@@ -759,6 +768,64 @@ export declare const ConversationIngressEnum: {
     readonly Webhook: "webhook";
 };
 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 declare const ConversationAnticipateTypeEnum: {
+    readonly Did: "did";
+    readonly Literal: "literal";
+    readonly Context: "context";
+};
+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
@@ -772,13 +839,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
      */
@@ -882,21 +943,17 @@ export interface ConversationBase {
         [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}
@@ -1137,13 +1194,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
      */
@@ -1247,21 +1298,17 @@ export interface ConversationCreateRequest {
         [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}
@@ -1378,13 +1425,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
      */
@@ -1488,21 +1529,17 @@ export interface ConversationGetResponse {
         [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}
@@ -1625,13 +1662,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
      */
@@ -1735,21 +1766,17 @@ export interface ConversationUpdateRequest {
         [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}
@@ -1848,13 +1875,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
      */
@@ -1958,21 +1979,17 @@ export interface ConversationWithId {
         [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}
@@ -3959,13 +3976,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
      */
@@ -4069,21 +4080,17 @@ export interface ListConversationsResponseInner {
         [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}
@@ -6748,13 +6755,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
      */
@@ -6858,21 +6859,17 @@ export interface ScheduleCreateRequest {
         [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}
@@ -6976,13 +6973,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
      */
@@ -7086,21 +7077,17 @@ export interface ScheduleGetResponse {
         [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}
@@ -7178,13 +7165,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
      */
@@ -7288,21 +7269,17 @@ export interface ScheduleGroupCreateRequest {
         [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}
@@ -7411,13 +7388,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
      */
@@ -7521,21 +7492,17 @@ export interface ScheduleGroupGetResponse {
         [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}
@@ -7657,13 +7624,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
      */
@@ -7767,21 +7728,17 @@ export interface ScheduleGroupUpdateRequest {
         [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}
@@ -7916,13 +7873,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
      */
@@ -8026,21 +7977,17 @@ export interface ScheduleUpdateRequest {
         [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}
@@ -8138,13 +8085,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
      */
@@ -8248,21 +8189,17 @@ export interface ScheduledConversation {
         [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}
@@ -8335,13 +8272,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
      */
@@ -8445,21 +8376,17 @@ export interface ScheduledConversationGroup {
         [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}