@botpress/client 0.39.0 → 0.41.0

package/dist/index.d.ts

@@ -1721,7 +1721,11 @@ interface ConfigureIntegrationRequestBody {
     /**
      * Unique identifier of the integration that was installed on the bot
      */
-    identifier: string;
+    identifier?: string;
+    /**
+     * Recurring schedule on which `register()` will be called on the integration
+     */
+    scheduleRegisterCall?: "hourly" | "daily" | "weekly" | "bi-weekly" | "monthly" | "bi-monthly" | "quarterly" | "yearly";
 }
 type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureIntegrationRequestHeaders & ConfigureIntegrationRequestQuery & ConfigureIntegrationRequestParams;
 interface ConfigureIntegrationResponse {
@@ -2658,6 +2662,30 @@ interface GetOrCreateWorkflowResponse {
     };
 }
 
+interface ListTagValuesRequestHeaders {
+}
+interface ListTagValuesRequestQuery {
+    nextToken?: string;
+    type: "user" | "conversation" | "message";
+}
+interface ListTagValuesRequestParams {
+    key: string;
+}
+interface ListTagValuesRequestBody {
+}
+type ListTagValuesInput = ListTagValuesRequestBody & ListTagValuesRequestHeaders & ListTagValuesRequestQuery & ListTagValuesRequestParams;
+interface ListTagValuesResponse {
+    tags: {
+        value: string;
+    }[];
+    meta: {
+        /**
+         * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
+         */
+        nextToken?: string;
+    };
+}
+
 interface TrackAnalyticsRequestHeaders {
 }
 interface TrackAnalyticsRequestQuery {
@@ -5034,6 +5062,10 @@ interface GetBotLogsRequestHeaders {
 interface GetBotLogsRequestQuery {
     timeStart: string;
     timeEnd: string;
+    level?: string;
+    userId?: string;
+    workflowId?: string;
+    conversationId?: string;
     nextToken?: string;
 }
 interface GetBotLogsRequestParams {
@@ -5047,6 +5079,9 @@ interface GetBotLogsResponse {
         timestamp: string;
         level: string;
         message: string;
+        workflowId?: string;
+        userId?: string;
+        conversationId?: string;
     }[];
     nextToken?: string;
 }
@@ -7713,6 +7748,9 @@ interface GetIntegrationLogsRequestHeaders {
 interface GetIntegrationLogsRequestQuery {
     timeStart: string;
     timeEnd: string;
+    level?: string;
+    userId?: string;
+    conversationId?: string;
     nextToken?: string;
 }
 interface GetIntegrationLogsRequestParams {
@@ -7726,6 +7764,9 @@ interface GetIntegrationLogsResponse {
         timestamp: string;
         level: string;
         message: string;
+        workflowId?: string;
+        userId?: string;
+        conversationId?: string;
     }[];
     nextToken?: string;
 }
@@ -8995,6 +9036,18 @@ interface CreatePluginRequestBody {
         };
     };
     code: string;
+    dependencies?: {
+        interfaces?: {
+            [k: string]: {
+                id: string;
+            };
+        };
+        integrations?: {
+            [k: string]: {
+                id: string;
+            };
+        };
+    };
 }
 type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
 interface CreatePluginResponse {
@@ -9104,6 +9157,22 @@ interface CreatePluginResponse {
                 };
             };
         };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
         /**
          * User object configuration
          */
@@ -9245,6 +9314,22 @@ interface GetPluginResponse {
                 };
             };
         };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
         /**
          * User object configuration
          */
@@ -9387,6 +9472,22 @@ interface GetPluginByNameResponse {
                 };
             };
         };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
         /**
          * User object configuration
          */
@@ -9522,6 +9623,18 @@ interface UpdatePluginRequestBody {
         };
     } | null;
     code?: string;
+    dependencies?: {
+        interfaces?: {
+            [k: string]: {
+                id: string;
+            } | null;
+        };
+        integrations?: {
+            [k: string]: {
+                id: string;
+            } | null;
+        };
+    };
 }
 type UpdatePluginInput = UpdatePluginRequestBody & UpdatePluginRequestHeaders & UpdatePluginRequestQuery & UpdatePluginRequestParams;
 interface UpdatePluginResponse {
@@ -9631,6 +9744,22 @@ interface UpdatePluginResponse {
                 };
             };
         };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
         /**
          * User object configuration
          */
@@ -13081,6 +13210,22 @@ interface Plugin {
             };
         };
     };
+    dependencies: {
+        interfaces: {
+            [k: string]: {
+                id: string;
+                name: string;
+                version: string;
+            };
+        };
+        integrations: {
+            [k: string]: {
+                id: string;
+                name: string;
+                version: string;
+            };
+        };
+    };
     /**
      * User object configuration
      */
@@ -13790,6 +13935,7 @@ declare class Client$1 {
     readonly deleteWorkflow: (input: DeleteWorkflowInput) => Promise<DeleteWorkflowResponse>;
     readonly listWorkflows: (input: ListWorkflowsInput) => Promise<ListWorkflowsResponse>;
     readonly getOrCreateWorkflow: (input: GetOrCreateWorkflowInput) => Promise<GetOrCreateWorkflowResponse>;
+    readonly listTagValues: (input: ListTagValuesInput) => Promise<ListTagValuesResponse>;
     readonly trackAnalytics: (input: TrackAnalyticsInput) => Promise<TrackAnalyticsResponse>;
     readonly runVrl: (input: RunVrlInput) => Promise<RunVrlResponse>;
     readonly getAccount: (input: GetAccountInput) => Promise<GetAccountResponse>;
@@ -13972,14 +14118,16 @@ declare abstract class BaseApiError<Code extends ErrorCode, Type extends string,
     readonly message: string;
     readonly error?: Error | undefined;
     readonly id?: string | undefined;
+    readonly metadata?: Record<string, unknown> | undefined;
     readonly isApiError = true;
-    constructor(code: Code, description: Description, type: Type, message: string, error?: Error | undefined, id?: string | undefined);
+    constructor(code: Code, description: Description, type: Type, message: string, error?: Error | undefined, id?: string | undefined, metadata?: Record<string, unknown> | undefined);
     format(): string;
     toJSON(): {
         id: string | undefined;
         code: Code;
         type: Type;
         message: string;
+        metadata: Record<string, unknown> | undefined;
     };
     static generateId(): string;
     private static getPrefix;
@@ -13990,178 +14138,171 @@ type UnknownType = 'Unknown';
  *  An unknown error occurred
  */
 declare class UnknownError extends BaseApiError<500, UnknownType, 'An unknown error occurred'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type InternalType = 'Internal';
 /**
  *  An internal error occurred
  */
 declare class InternalError extends BaseApiError<500, InternalType, 'An internal error occurred'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type UnauthorizedType = 'Unauthorized';
 /**
  *  The request requires to be authenticated.
  */
 declare class UnauthorizedError extends BaseApiError<401, UnauthorizedType, 'The request requires to be authenticated.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type ForbiddenType = 'Forbidden';
 /**
  *  The requested action can\'t be peform by this resource.
  */
 declare class ForbiddenError extends BaseApiError<403, ForbiddenType, 'The requested action can\'t be peform by this resource.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type PayloadTooLargeType = 'PayloadTooLarge';
 /**
  *  The request payload is too large.
  */
 declare class PayloadTooLargeError extends BaseApiError<413, PayloadTooLargeType, 'The request payload is too large.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type InvalidPayloadType = 'InvalidPayload';
 /**
  *  The request payload is invalid.
  */
 declare class InvalidPayloadError extends BaseApiError<400, InvalidPayloadType, 'The request payload is invalid.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type UnsupportedMediaTypeType = 'UnsupportedMediaType';
 /**
  *  The request is invalid because the content-type is not supported.
  */
 declare class UnsupportedMediaTypeError extends BaseApiError<415, UnsupportedMediaTypeType, 'The request is invalid because the content-type is not supported.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type MethodNotFoundType = 'MethodNotFound';
 /**
  *  The requested method does not exist.
  */
 declare class MethodNotFoundError extends BaseApiError<405, MethodNotFoundType, 'The requested method does not exist.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type ResourceNotFoundType = 'ResourceNotFound';
 /**
  *  The requested resource does not exist.
  */
 declare class ResourceNotFoundError extends BaseApiError<404, ResourceNotFoundType, 'The requested resource does not exist.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type InvalidJsonSchemaType = 'InvalidJsonSchema';
 /**
  *  The provided JSON schema is invalid.
  */
 declare class InvalidJsonSchemaError extends BaseApiError<400, InvalidJsonSchemaType, 'The provided JSON schema is invalid.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type InvalidDataFormatType = 'InvalidDataFormat';
 /**
  *  The provided data doesn\'t respect the provided JSON schema.
  */
 declare class InvalidDataFormatError extends BaseApiError<400, InvalidDataFormatType, 'The provided data doesn\'t respect the provided JSON schema.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type InvalidIdentifierType = 'InvalidIdentifier';
 /**
  *  The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.
  */
 declare class InvalidIdentifierError extends BaseApiError<400, InvalidIdentifierType, 'The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type RelationConflictType = 'RelationConflict';
 /**
  *  The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren\'t linked together.
  */
 declare class RelationConflictError extends BaseApiError<409, RelationConflictType, 'The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren\'t linked together.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type ReferenceConstraintType = 'ReferenceConstraint';
 /**
  *  The resource cannot be deleted because it\'s referenced by another resource
  */
 declare class ReferenceConstraintError extends BaseApiError<409, ReferenceConstraintType, 'The resource cannot be deleted because it\'s referenced by another resource'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type ResourceLockedConflictType = 'ResourceLockedConflict';
 /**
  *  The resource is current locked and cannot be operated on until the lock is released.
  */
 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);
+    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.
  */
 declare class ReferenceNotFoundError extends BaseApiError<400, ReferenceNotFoundType, 'The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type InvalidQueryType = 'InvalidQuery';
 /**
  *  The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.
  */
 declare class InvalidQueryError extends BaseApiError<400, InvalidQueryType, 'The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type RuntimeType = 'Runtime';
 /**
  *  An error happened during the execution of a runtime (bot or integration).
  */
 declare class RuntimeError extends BaseApiError<400, RuntimeType, 'An error happened during the execution of a runtime (bot or integration).'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type AlreadyExistsType = 'AlreadyExists';
 /**
  *  The record attempted to be created already exists.
  */
 declare class AlreadyExistsError extends BaseApiError<409, AlreadyExistsType, 'The record attempted to be created already exists.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type RateLimitedType = 'RateLimited';
 /**
  *  The request has been rate limited.
  */
 declare class RateLimitedError extends BaseApiError<429, RateLimitedType, 'The request has been rate limited.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type PaymentRequiredType = 'PaymentRequired';
 /**
  *  A payment is required to perform this request.
  */
 declare class PaymentRequiredError extends BaseApiError<402, PaymentRequiredType, 'A payment is required to perform this request.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type QuotaExceededType = 'QuotaExceeded';
 /**
  *  The request exceeds the allowed quota. Quotas are a soft limit that can be increased.
  */
 declare class QuotaExceededError extends BaseApiError<403, QuotaExceededType, 'The request exceeds the allowed quota. Quotas are a soft limit that can be increased.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type LimitExceededType = 'LimitExceeded';
 /**
  *  The request exceeds the allowed limit. Limits are a hard limit that cannot be increased.
  */
 declare class LimitExceededError extends BaseApiError<413, LimitExceededType, 'The request exceeds the allowed limit. Limits are a hard limit that cannot be increased.'> {
-    constructor(message: string, error?: Error, id?: string);
+    constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
 }
 type BreakingChangesType = 'BreakingChanges';
 /**
  *  Request payload contains breaking changes which is not allowed for this resource without a version increment.
  */
 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);
-}
-type UpstreamProviderType = 'UpstreamProvider';
-/**
- *  The upstream provider returned an error or is currently unavailable.
- */
-declare class UpstreamProviderError extends BaseApiError<424, UpstreamProviderType, 'The upstream provider returned an error or is currently unavailable.'> {
-    constructor(message: string, error?: Error, id?: string);
+    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' | 'UpstreamProvider';
-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 | UpstreamProviderError;
+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;
 declare const errorFrom: (err: unknown) => ApiError;
 
 declare class UploadFileError extends Error {
@@ -14405,4 +14546,4 @@ declare class Client extends Client$1 implements IClient {
     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, type Plugin, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, UpstreamProviderError, 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 };