@scout9/admin 1.0.0-alpha.0.0.40 → 1.0.0-alpha.0.0.42

package/build/api.d.ts

@@ -293,6 +293,62 @@ export interface BlockInfo {
      */
     'time'?: string;
 }
+/**
+ * @type CaptureContext200Response
+ * @export
+ */
+export type CaptureContext200Response = Array<{
+    [key: string]: any;
+}> | {
+    [key: string]: any;
+};
+/**
+ *
+ * @export
+ * @interface CaptureContextRequest
+ */
+export interface CaptureContextRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CaptureContextRequest
+     */
+    'prompt': string;
+    /**
+     *
+     * @type {CaptureContextRequestExamples}
+     * @memberof CaptureContextRequest
+     */
+    'examples'?: CaptureContextRequestExamples;
+}
+/**
+ * @type CaptureContextRequestExamples
+ * @export
+ */
+export type CaptureContextRequestExamples = Array<CaptureContextRequestExamplesOneOfInner> | Array<{
+    [key: string]: any;
+}>;
+/**
+ *
+ * @export
+ * @interface CaptureContextRequestExamplesOneOfInner
+ */
+export interface CaptureContextRequestExamplesOneOfInner {
+    /**
+     *
+     * @type {string}
+     * @memberof CaptureContextRequestExamplesOneOfInner
+     */
+    'input': string;
+    /**
+     *
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof CaptureContextRequestExamplesOneOfInner
+     */
+    'output': Array<{
+        [key: string]: any;
+    }>;
+}
 /**
  * @type Condition
  * @export
@@ -927,6 +983,25 @@ export interface ConversationCreateRequest {
      * @memberof ConversationCreateRequest
      */
     'environment': ConversationEnvironment;
+    /**
+     * Appends a prefix to the conversation id, if a conversation id is prefixed with test, or dev, it will mute text messages
+     * @type {string}
+     * @memberof ConversationCreateRequest
+     */
+    'idPrefix'?: string;
+}
+/**
+ *
+ * @export
+ * @interface ConversationCreateRequestAllOf
+ */
+export interface ConversationCreateRequestAllOf {
+    /**
+     * Appends a prefix to the conversation id, if a conversation id is prefixed with test, or dev, it will mute text messages
+     * @type {string}
+     * @memberof ConversationCreateRequestAllOf
+     */
+    'idPrefix'?: string;
 }
 /**
  *
@@ -2532,6 +2607,32 @@ export interface DeleteWorkflowsResponse {
      */
     '$operation': string;
 }
+/**
+ *
+ * @export
+ * @interface Did200Response
+ */
+export interface Did200Response {
+    /**
+     *
+     * @type {boolean}
+     * @memberof Did200Response
+     */
+    'value': boolean;
+}
+/**
+ *
+ * @export
+ * @interface DidRequest
+ */
+export interface DidRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof DidRequest
+     */
+    'prompt': string;
+}
 /**
  *
  * @export
@@ -4468,6 +4569,44 @@ export interface LogResponse {
  * @export
  */
 export type Logic = AndLogic | ConditionLogic | NotLogic | OrLogic;
+/**
+ *
+ * @export
+ * @interface Logs400Response
+ */
+export interface Logs400Response {
+    /**
+     *
+     * @type {string}
+     * @memberof Logs400Response
+     */
+    'status'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Logs400Response
+     */
+    'message'?: string;
+}
+/**
+ *
+ * @export
+ * @interface Logs500Response
+ */
+export interface Logs500Response {
+    /**
+     *
+     * @type {string}
+     * @memberof Logs500Response
+     */
+    'status'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Logs500Response
+     */
+    'message'?: string;
+}
 /**
  *
  * @export
@@ -6769,44 +6908,6 @@ export interface UpdateWorkflowsResponse {
      */
     '$operation': string;
 }
-/**
- *
- * @export
- * @interface V1UtilsPlatformLogsGet400Response
- */
-export interface V1UtilsPlatformLogsGet400Response {
-    /**
-     *
-     * @type {string}
-     * @memberof V1UtilsPlatformLogsGet400Response
-     */
-    'status'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof V1UtilsPlatformLogsGet400Response
-     */
-    'message'?: string;
-}
-/**
- *
- * @export
- * @interface V1UtilsPlatformLogsGet500Response
- */
-export interface V1UtilsPlatformLogsGet500Response {
-    /**
-     *
-     * @type {string}
-     * @memberof V1UtilsPlatformLogsGet500Response
-     */
-    'status'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof V1UtilsPlatformLogsGet500Response
-     */
-    'message'?: string;
-}
 /**
  *
  * @export
@@ -7231,6 +7332,14 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     agentsUpdate: (updateAgentsRequest: UpdateAgentsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Natural language prompt to resolve a context value derived from the conversation.
+     * @param {CaptureContextRequest} captureContextRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    captureContext: (captureContextRequest: CaptureContextRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get the current project configuration
@@ -7531,6 +7640,14 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     deleteEntity: (type: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Natural language prompt to resolve to a boolean value.
+     * @param {DidRequest} didRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    did: (didRequest: DidRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get an entity by type and ID
@@ -7597,6 +7714,15 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     generate: (generateRequest: GenerateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns log data for a given range, specified by start and end Unix timestamps.
+     * @summary Retrieve platform run time logs
+     * @param {number} [start]
+     * @param {number} [end]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    logs: (start?: number, end?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Creates a new message and sends it to the conversation. If the conversation is scheduled, the message will be scheduled as well. @TODO does not support the ability to mute or delay send
      * @summary Create and send message
@@ -7690,15 +7816,6 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     updateEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Returns log data for a given range, specified by start and end Unix timestamps.
-     * @summary Retrieve log data based on time range
-     * @param {number} [start]
-     * @param {number} [end]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    v1UtilsPlatformLogsGet: (start?: number, end?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * Scout9Api - functional programming interface
@@ -7780,6 +7897,14 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     agentsUpdate(updateAgentsRequest: UpdateAgentsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateAgentsResponse>>;
+    /**
+     *
+     * @summary Natural language prompt to resolve a context value derived from the conversation.
+     * @param {CaptureContextRequest} captureContextRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    captureContext(captureContextRequest: CaptureContextRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CaptureContext200Response>>;
     /**
      *
      * @summary Get the current project configuration
@@ -8080,6 +8205,14 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteEntity(type: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Natural language prompt to resolve to a boolean value.
+     * @param {DidRequest} didRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    did(didRequest: DidRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Did200Response>>;
     /**
      *
      * @summary Get an entity by type and ID
@@ -8146,6 +8279,15 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     generate(generateRequest: GenerateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateResponse>>;
+    /**
+     * Returns log data for a given range, specified by start and end Unix timestamps.
+     * @summary Retrieve platform run time logs
+     * @param {number} [start]
+     * @param {number} [end]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    logs(start?: number, end?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogResponse>>;
     /**
      * Creates a new message and sends it to the conversation. If the conversation is scheduled, the message will be scheduled as well. @TODO does not support the ability to mute or delay send
      * @summary Create and send message
@@ -8241,15 +8383,6 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
-    /**
-     * Returns log data for a given range, specified by start and end Unix timestamps.
-     * @summary Retrieve log data based on time range
-     * @param {number} [start]
-     * @param {number} [end]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    v1UtilsPlatformLogsGet(start?: number, end?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogResponse>>;
 };
 /**
  * Scout9Api - factory interface
@@ -8331,6 +8464,14 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     agentsUpdate(updateAgentsRequest: UpdateAgentsRequest, options?: any): AxiosPromise<UpdateAgentsResponse>;
+    /**
+     *
+     * @summary Natural language prompt to resolve a context value derived from the conversation.
+     * @param {CaptureContextRequest} captureContextRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    captureContext(captureContextRequest: CaptureContextRequest, options?: any): AxiosPromise<CaptureContext200Response>;
     /**
      *
      * @summary Get the current project configuration
@@ -8631,6 +8772,14 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     deleteEntity(type: string, id: string, options?: any): AxiosPromise<void>;
+    /**
+     *
+     * @summary Natural language prompt to resolve to a boolean value.
+     * @param {DidRequest} didRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    did(didRequest: DidRequest, options?: any): AxiosPromise<Did200Response>;
     /**
      *
      * @summary Get an entity by type and ID
@@ -8697,6 +8846,15 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     generate(generateRequest: GenerateRequest, options?: any): AxiosPromise<GenerateResponse>;
+    /**
+     * Returns log data for a given range, specified by start and end Unix timestamps.
+     * @summary Retrieve platform run time logs
+     * @param {number} [start]
+     * @param {number} [end]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    logs(start?: number, end?: number, options?: any): AxiosPromise<LogResponse>;
     /**
      * Creates a new message and sends it to the conversation. If the conversation is scheduled, the message will be scheduled as well. @TODO does not support the ability to mute or delay send
      * @summary Create and send message
@@ -8792,15 +8950,6 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     updateEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
-    /**
-     * Returns log data for a given range, specified by start and end Unix timestamps.
-     * @summary Retrieve log data based on time range
-     * @param {number} [start]
-     * @param {number} [end]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    v1UtilsPlatformLogsGet(start?: number, end?: number, options?: any): AxiosPromise<LogResponse>;
 };
 /**
  * Scout9ApiGenerated - object-oriented interface
@@ -8893,6 +9042,15 @@ export declare class Scout9ApiGenerated extends BaseAPI {
      * @memberof Scout9Api
      */
     agentsUpdate(updateAgentsRequest: UpdateAgentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAgentsResponse, any>>;
+    /**
+     *
+     * @summary Natural language prompt to resolve a context value derived from the conversation.
+     * @param {CaptureContextRequest} captureContextRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    captureContext(captureContextRequest: CaptureContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CaptureContext200Response, any>>;
     /**
      *
      * @summary Get the current project configuration
@@ -9229,6 +9387,15 @@ export declare class Scout9ApiGenerated extends BaseAPI {
      * @memberof Scout9Api
      */
     deleteEntity(type: string, id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Natural language prompt to resolve to a boolean value.
+     * @param {DidRequest} didRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    did(didRequest: DidRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Did200Response, any>>;
     /**
      *
      * @summary Get an entity by type and ID
@@ -9302,6 +9469,16 @@ export declare class Scout9ApiGenerated extends BaseAPI {
      * @memberof Scout9Api
      */
     generate(generateRequest: GenerateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateResponse, any>>;
+    /**
+     * Returns log data for a given range, specified by start and end Unix timestamps.
+     * @summary Retrieve platform run time logs
+     * @param {number} [start]
+     * @param {number} [end]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof Scout9Api
+     */
+    logs(start?: number, end?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LogResponse, any>>;
     /**
      * Creates a new message and sends it to the conversation. If the conversation is scheduled, the message will be scheduled as well. @TODO does not support the ability to mute or delay send
      * @summary Create and send message
@@ -9408,16 +9585,6 @@ export declare class Scout9ApiGenerated extends BaseAPI {
      * @memberof Scout9Api
      */
     updateEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
-    /**
-     * Returns log data for a given range, specified by start and end Unix timestamps.
-     * @summary Retrieve log data based on time range
-     * @param {number} [start]
-     * @param {number} [end]
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof Scout9Api
-     */
-    v1UtilsPlatformLogsGet(start?: number, end?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LogResponse, any>>;
 }
 /**
  * Scout9Api - object-oriented interface