@botpress/client 1.26.0 → 1.27.0

package/dist/index.d.ts

@@ -2716,6 +2716,10 @@ interface GetOrCreateWorkflowRequestBody$1 {
      * Optional list of tag names to use for strict matching when looking up existing workflows. If provided, all specified tags must match exactly for a workflow to be considered a match. For example, with an existing workflow whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
      */
     discriminateByTags?: string[];
+    /**
+     * When provided, will only match workflows whose status corresponds to the status group.
+     */
+    discriminateByStatusGroup?: "active" | "finished";
 }
 type GetOrCreateWorkflowInput$1 = GetOrCreateWorkflowRequestBody$1 & GetOrCreateWorkflowRequestHeaders$1 & GetOrCreateWorkflowRequestQuery$1 & GetOrCreateWorkflowRequestParams$1;
 interface GetOrCreateWorkflowResponse$1 {
@@ -5565,9 +5569,20 @@ interface CreateBotResponse$1 {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -6058,6 +6073,23 @@ interface UpdateBotRequestBody$1 {
             interfaces?: {
                 [k: string]: {
                     integrationId: string;
+                    /**
+                     * When an alias is provided, the plugin will use the integration corresponding to this alias. If not provided, the first integration matching the integrationId will be used.
+                     */
+                    integrationAlias?: string;
+                    /**
+                     * When an alias is provided, the plugin will use the integration interface corresponding to this alias.
+                     */
+                    integrationInterfaceAlias?: string;
+                };
+            };
+            /**
+             * A mapping of plugin integration aliases to their backing integrations
+             */
+            integrations?: {
+                [k: string]: {
+                    integrationId: string;
+                    integrationAlias: string;
                 };
             };
         } | null;
@@ -6196,9 +6228,20 @@ interface UpdateBotResponse$1 {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -6659,9 +6702,20 @@ interface GetBotResponse$1 {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -7324,6 +7378,7 @@ interface DeployBotVersionResponse$1 {
 interface CreateIntegrationShareableIdRequestHeaders$1 {
 }
 interface CreateIntegrationShareableIdRequestQuery$1 {
+    integrationInstanceAlias?: string;
 }
 interface CreateIntegrationShareableIdRequestParams$1 {
     botId: string;
@@ -7339,6 +7394,7 @@ interface CreateIntegrationShareableIdResponse$1 {
 interface DeleteIntegrationShareableIdRequestHeaders$1 {
 }
 interface DeleteIntegrationShareableIdRequestQuery$1 {
+    integrationInstanceAlias?: string;
 }
 interface DeleteIntegrationShareableIdRequestParams$1 {
     botId: string;
@@ -7353,6 +7409,7 @@ interface DeleteIntegrationShareableIdResponse$1 {
 interface GetIntegrationShareableIdRequestHeaders$1 {
 }
 interface GetIntegrationShareableIdRequestQuery$1 {
+    integrationInstanceAlias?: string;
 }
 interface GetIntegrationShareableIdRequestParams$1 {
     botId: string;
@@ -7369,6 +7426,7 @@ interface GetIntegrationShareableIdResponse$1 {
 interface UnlinkSandboxedConversationsRequestHeaders$1 {
 }
 interface UnlinkSandboxedConversationsRequestQuery$1 {
+    integrationInstanceAlias?: string;
 }
 interface UnlinkSandboxedConversationsRequestParams$1 {
     botId: string;
@@ -7639,6 +7697,7 @@ interface CreateWorkspaceResponse$1 {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface GetPublicWorkspaceRequestHeaders$1 {
@@ -7692,6 +7751,7 @@ interface GetWorkspaceResponse$1 {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface ListWorkspaceUsagesRequestHeaders$1 {
@@ -7863,6 +7923,7 @@ interface UpdateWorkspaceResponse$3 {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface CheckHandleAvailabilityRequestHeaders$1 {
@@ -7919,6 +7980,7 @@ interface UpdateWorkspaceResponse$2 {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface ListPublicWorkspacesRequestHeaders$1 {
@@ -7988,7 +8050,7 @@ interface GetAuditRecordsResponse$1 {
         resourceId: string | null;
         resourceName?: string | null;
         value?: string | null;
-        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY";
+        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
     }[];
     meta: {
         /**
@@ -16944,6 +17006,10 @@ interface FindTableRowsRequestBody$1 {
      * Search term to apply to the row search. When using this parameter, some rows which doesn't match the search term will be returned, use the similarity field to know how much the row matches the search term.
      */
     search?: string;
+    /**
+     * Specify which columns to return in the response. Supports both top-level columns (e.g., "name") and nested attributes using dot notation (e.g., "attributes.price"). System columns (id, createdAt, updatedAt, etc.) are always included. If omitted, all columns are returned.
+     */
+    select?: string[];
     /**
      * Specifies the column by which to order the results. By default it is ordered by id. Build-in columns: id, createdAt, updatedAt
      */
@@ -19959,6 +20025,10 @@ interface GetOrCreateWorkflowRequestBody {
      * Optional list of tag names to use for strict matching when looking up existing workflows. If provided, all specified tags must match exactly for a workflow to be considered a match. For example, with an existing workflow whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
      */
     discriminateByTags?: string[];
+    /**
+     * When provided, will only match workflows whose status corresponds to the status group.
+     */
+    discriminateByStatusGroup?: "active" | "finished";
 }
 type GetOrCreateWorkflowInput = GetOrCreateWorkflowRequestBody & GetOrCreateWorkflowRequestHeaders & GetOrCreateWorkflowRequestQuery & GetOrCreateWorkflowRequestParams;
 interface GetOrCreateWorkflowResponse {
@@ -22597,9 +22667,20 @@ interface CreateBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -23090,6 +23171,23 @@ interface UpdateBotRequestBody {
             interfaces?: {
                 [k: string]: {
                     integrationId: string;
+                    /**
+                     * When an alias is provided, the plugin will use the integration corresponding to this alias. If not provided, the first integration matching the integrationId will be used.
+                     */
+                    integrationAlias?: string;
+                    /**
+                     * When an alias is provided, the plugin will use the integration interface corresponding to this alias.
+                     */
+                    integrationInterfaceAlias?: string;
+                };
+            };
+            /**
+             * A mapping of plugin integration aliases to their backing integrations
+             */
+            integrations?: {
+                [k: string]: {
+                    integrationId: string;
+                    integrationAlias: string;
                 };
             };
         } | null;
@@ -23228,9 +23326,20 @@ interface UpdateBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -23691,9 +23800,20 @@ interface GetBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        integrationAlias: string;
+                        integrationInterfaceAlias?: string;
                         interfaceId: string;
                     };
                 };
+                /**
+                 * A mapping of plugin integration aliases to their backing integrations
+                 */
+                integrations?: {
+                    [k: string]: {
+                        integrationId: string;
+                        integrationAlias: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -24356,6 +24476,7 @@ interface DeployBotVersionResponse {
 interface CreateIntegrationShareableIdRequestHeaders {
 }
 interface CreateIntegrationShareableIdRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface CreateIntegrationShareableIdRequestParams {
     botId: string;
@@ -24371,6 +24492,7 @@ interface CreateIntegrationShareableIdResponse {
 interface DeleteIntegrationShareableIdRequestHeaders {
 }
 interface DeleteIntegrationShareableIdRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface DeleteIntegrationShareableIdRequestParams {
     botId: string;
@@ -24385,6 +24507,7 @@ interface DeleteIntegrationShareableIdResponse {
 interface GetIntegrationShareableIdRequestHeaders {
 }
 interface GetIntegrationShareableIdRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface GetIntegrationShareableIdRequestParams {
     botId: string;
@@ -24401,6 +24524,7 @@ interface GetIntegrationShareableIdResponse {
 interface UnlinkSandboxedConversationsRequestHeaders {
 }
 interface UnlinkSandboxedConversationsRequestQuery {
+    integrationInstanceAlias?: string;
 }
 interface UnlinkSandboxedConversationsRequestParams {
     botId: string;
@@ -24671,6 +24795,7 @@ interface CreateWorkspaceResponse {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface GetPublicWorkspaceRequestHeaders {
@@ -24724,6 +24849,7 @@ interface GetWorkspaceResponse {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface ListWorkspaceUsagesRequestHeaders {
@@ -24895,6 +25021,7 @@ interface UpdateWorkspaceResponse$1 {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface CheckHandleAvailabilityRequestHeaders {
@@ -24951,6 +25078,7 @@ interface UpdateWorkspaceResponse {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 
 interface ListPublicWorkspacesRequestHeaders {
@@ -25020,7 +25148,7 @@ interface GetAuditRecordsResponse {
         resourceId: string | null;
         resourceName?: string | null;
         value?: string | null;
-        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY";
+        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
     }[];
     meta: {
         /**
@@ -33501,6 +33629,10 @@ interface FindTableRowsRequestBody {
      * Search term to apply to the row search. When using this parameter, some rows which doesn't match the search term will be returned, use the similarity field to know how much the row matches the search term.
      */
     search?: string;
+    /**
+     * Specify which columns to return in the response. Supports both top-level columns (e.g., "name") and nested attributes using dot notation (e.g., "attributes.price"). System columns (id, createdAt, updatedAt, etc.) are always included. If omitted, all columns are returned.
+     */
+    select?: string[];
     /**
      * Specifies the column by which to order the results. By default it is ordered by id. Build-in columns: id, createdAt, updatedAt
      */
@@ -33917,9 +34049,20 @@ interface Bot {
             interfaces?: {
                 [k: string]: {
                     integrationId: string;
+                    integrationAlias: string;
+                    integrationInterfaceAlias?: string;
                     interfaceId: string;
                 };
             };
+            /**
+             * A mapping of plugin integration aliases to their backing integrations
+             */
+            integrations?: {
+                [k: string]: {
+                    integrationId: string;
+                    integrationAlias: string;
+                };
+            };
             /**
              * ID of the [Plugin](#schema_plugin)
              */
@@ -34953,6 +35096,7 @@ interface Workspace {
     socialAccounts?: string[];
     isPublic?: boolean;
     handle?: string;
+    activeTrialId: string | null;
 }
 interface WorkspaceMember {
     id: string;
@@ -36340,6 +36484,7 @@ declare const codes: {
     readonly HTTP_STATUS_METHOD_NOT_ALLOWED: 405;
     readonly HTTP_STATUS_REQUEST_TIMEOUT: 408;
     readonly HTTP_STATUS_CONFLICT: 409;
+    readonly HTTP_STATUS_GONE: 410;
     readonly HTTP_STATUS_PAYLOAD_TOO_LARGE: 413;
     readonly HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE: 415;
     readonly HTTP_STATUS_DEPENDENCY_FAILED: 424;
@@ -36478,6 +36623,13 @@ type ResourceLockedConflictType = 'ResourceLockedConflict';
 declare class ResourceLockedConflictError extends BaseApiError<409, ResourceLockedConflictType, 'The resource is current locked and cannot be operated on until the lock is released.'> {
     constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
+type ResourceGoneType = 'ResourceGone';
+/**
+ *  The requested resource is no longer available.
+ */
+declare class ResourceGoneError extends BaseApiError<410, ResourceGoneType, 'The requested resource is no longer available.'> {
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
+}
 type ReferenceNotFoundType = 'ReferenceNotFound';
 /**
  *  The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.
@@ -36541,8 +36693,8 @@ type BreakingChangesType = 'BreakingChanges';
 declare class BreakingChangesError extends BaseApiError<400, BreakingChangesType, 'Request payload contains breaking changes which is not allowed for this resource without a version increment.'> {
     constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
-type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceConstraint' | 'ResourceLockedConflict' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded' | 'BreakingChanges';
-type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceConstraintError | ResourceLockedConflictError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError | QuotaExceededError | LimitExceededError | BreakingChangesError;
+type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceConstraint' | 'ResourceLockedConflict' | 'ResourceGone' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded' | 'BreakingChanges';
+type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceConstraintError | ResourceLockedConflictError | ResourceGoneError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError | QuotaExceededError | LimitExceededError | BreakingChangesError;
 declare const errorFrom: (err: unknown) => ApiError;
 
 declare class UploadFileError extends Error {
@@ -36551,4 +36703,4 @@ declare class UploadFileError extends Error {
     constructor(message: string, innerError?: AxiosError | undefined, file?: UpsertFileResponse["file"] | undefined);
 }
 
-export { type Account, type Activity, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientProps, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type Headers, 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, type Task, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Version, type Workflow, type Workspace, type WorkspaceMember, index$2 as admin, errorFrom, index$1 as files, isApiError, index$3 as runtime, index as tables };
+export { type Account, type Activity, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientProps, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type Headers, 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, ResourceGoneError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, type Task, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Version, type Workflow, type Workspace, type WorkspaceMember, index$2 as admin, errorFrom, index$1 as files, isApiError, index$3 as runtime, index as tables };