@botpress/client 0.36.1 → 0.36.2

package/dist/index.d.ts

@@ -12830,6 +12830,134 @@ interface Interface {
         language: string;
     };
 }
+/**
+ * Plugin definition
+ */
+interface Plugin {
+    /**
+     * ID of the [Plugin](#schema_plugin)
+     */
+    id: string;
+    /**
+     * Name of the [Plugin](#schema_plugin)
+     */
+    name: string;
+    /**
+     * Version of the [Plugin](#schema_plugin)
+     */
+    version: string;
+    /**
+     * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
+     */
+    createdAt: string;
+    /**
+     * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
+     */
+    updatedAt: string;
+    /**
+     * Configuration definition
+     */
+    configuration: {
+        /**
+         * Title of the configuration
+         */
+        title?: string;
+        /**
+         * Description of the configuration
+         */
+        description?: string;
+        /**
+         * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+         */
+        schema: {
+            [k: string]: any;
+        };
+    };
+    states: {
+        [k: string]: {
+            /**
+             * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
+             */
+            type: "conversation" | "user" | "bot" | "task";
+            /**
+             * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
+             */
+            schema: {
+                [k: string]: any;
+            };
+            /**
+             * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
+             */
+            expiry?: number;
+        };
+    };
+    events: {
+        /**
+         * Event Definition
+         */
+        [k: string]: {
+            /**
+             * Title of the event
+             */
+            title?: string;
+            /**
+             * Description of the event
+             */
+            description?: string;
+            schema: {
+                [k: string]: any;
+            };
+        };
+    };
+    actions: {
+        /**
+         * Action definition
+         */
+        [k: string]: {
+            /**
+             * Title of the action
+             */
+            title?: string;
+            /**
+             * Description of the action
+             */
+            description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
+            input: {
+                schema: {
+                    [k: string]: any;
+                };
+            };
+            output: {
+                schema: {
+                    [k: string]: any;
+                };
+            };
+        };
+    };
+    /**
+     * User object configuration
+     */
+    user: {
+        tags: {
+            /**
+             * Definition of a tag that can be provided on the object
+             */
+            [k: string]: {
+                /**
+                 * Title of the tag
+                 */
+                title?: string;
+                /**
+                 * Description of the tag
+                 */
+                description?: string;
+            };
+        };
+    };
+    code: string;
+}
 interface Workspace {
     id: string;
     name: string;
@@ -14159,7 +14287,7 @@ declare class Client extends Client$1 implements IClient {
     /**
      * Create/update and upload a file in a single step. Returns an object containing the file metadata and the URL to retrieve the file.
      */
-    readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
+    readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, indexing, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
 }
 
-export { type Account, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientParams, type ClientProps, type ClientReturn, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type IClient, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, PayloadTooLargeError, PaymentRequiredError, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workflow, type Workspace, type WorkspaceMember, errorFrom, isApiError };
+export { type Account, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientParams, type ClientProps, type ClientReturn, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type IClient, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, PayloadTooLargeError, PaymentRequiredError, type Plugin, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workflow, type Workspace, type WorkspaceMember, errorFrom, isApiError };