@botpress/client 1.30.0 → 1.32.0

package/dist/index.d.ts

@@ -3149,6 +3149,52 @@ type TrackAnalyticsInput$1 = TrackAnalyticsRequestBody$1 & TrackAnalyticsRequest
 interface TrackAnalyticsResponse$1 {
 }
 
+interface CaptureObservationRequestHeaders$1 {
+}
+interface CaptureObservationRequestQuery$1 {
+}
+interface CaptureObservationRequestParams$1 {
+}
+interface CaptureObservationRequestBody$1 {
+    /**
+     * Name of the observation
+     */
+    name: string;
+    /**
+     * Data of the observation
+     */
+    data: {
+        [k: string]: any;
+    };
+    /**
+     * ID of the message associated with the observation
+     */
+    messageId?: string;
+    /**
+     * ID of the event associated with the observation
+     */
+    eventId?: string;
+    /**
+     * ID of the conversation associated with the observation
+     */
+    conversationId?: string;
+    /**
+     * ID of the user associated with the observation
+     */
+    userId?: string;
+    /**
+     * ID of the error associated with the observation
+     */
+    errorId?: string;
+    /**
+     * ID of the trace associated with the observation
+     */
+    traceId?: string;
+}
+type CaptureObservationInput$1 = CaptureObservationRequestBody$1 & CaptureObservationRequestHeaders$1 & CaptureObservationRequestQuery$1 & CaptureObservationRequestParams$1;
+interface CaptureObservationResponse$1 {
+}
+
 type ClientProps$b = {
     toAxiosRequest: typeof toAxiosRequest$5;
     toApiError: typeof toApiError$5;
@@ -3205,6 +3251,7 @@ declare class Client$b {
     readonly getOrCreateWorkflow: (input: GetOrCreateWorkflowInput$1) => Promise<GetOrCreateWorkflowResponse$1>;
     readonly listTagValues: (input: ListTagValuesInput$1) => Promise<ListTagValuesResponse$1>;
     readonly trackAnalytics: (input: TrackAnalyticsInput$1) => Promise<TrackAnalyticsResponse$1>;
+    readonly captureObservation: (input: CaptureObservationInput$1) => Promise<CaptureObservationResponse$1>;
 }
 declare function toApiError$5(err: unknown): Error;
 
@@ -5836,7 +5883,7 @@ interface CreateBotRequestBody$1 {
         name: string;
     }[];
     /**
-     * URL of the [Bot](#schema_bot); Only available for dev bots
+     * URL of the [Bot](#schema_bot)
      */
     url?: string;
     /**
@@ -6270,9 +6317,9 @@ interface UpdateBotRequestParams$1 {
 }
 interface UpdateBotRequestBody$1 {
     /**
-     * URL of the [Bot](#schema_bot); Only available for dev bots
+     * URL of the [Bot](#schema_bot)
      */
-    url?: string;
+    url?: string | null;
     /**
      * Type of the [Bot](#schema_bot) authentication (`iam`)
      */
@@ -7585,6 +7632,9 @@ interface ListActionRunsResponse$1 {
          * ISO 8601 timestamp of the action run
          */
         timestamp: string;
+        /**
+         * Alias of the integration instance used for this action run
+         */
         integrationName?: string;
         actionType: string;
         /**
@@ -7593,12 +7643,20 @@ interface ListActionRunsResponse$1 {
         input: {
             [k: string]: any;
         };
+        /**
+         * Present if the length of the action's input exceeds 190 KB.
+         */
+        inputTruncated?: boolean;
         /**
          * Output of the action
          */
         output: {
             [k: string]: any;
         } | null;
+        /**
+         * Present if the length of the action's output exceeds 190 KB.
+         */
+        outputTruncated?: boolean;
         status: "SUCCESS" | "FAILURE";
         durationMs: number;
         cached: boolean;
@@ -8124,7 +8182,7 @@ interface CreateWorkspaceResponse$1 {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -8178,7 +8236,7 @@ interface GetWorkspaceResponse$1 {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -8350,7 +8408,7 @@ interface UpdateWorkspaceResponse$3 {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -8407,7 +8465,7 @@ interface UpdateWorkspaceResponse$2 {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -15032,6 +15090,19 @@ type ParsedRequest$3 = {
 };
 declare const toAxiosRequest$3: (req: ParsedRequest$3) => AxiosRequestConfig;
 
+interface GetBillingReadonlyRequestHeaders {
+}
+interface GetBillingReadonlyRequestQuery {
+}
+interface GetBillingReadonlyRequestParams {
+}
+interface GetBillingReadonlyRequestBody {
+}
+type GetBillingReadonlyInput = GetBillingReadonlyRequestBody & GetBillingReadonlyRequestHeaders & GetBillingReadonlyRequestQuery & GetBillingReadonlyRequestParams;
+interface GetBillingReadonlyResponse {
+    billingReadonly: boolean;
+}
+
 interface GetPlanRequestHeaders {
 }
 interface GetPlanRequestQuery {
@@ -15287,6 +15358,7 @@ declare class Client$7 {
     private axiosInstance;
     private props;
     constructor(axiosInstance: AxiosInstance, props?: Partial<ClientProps$7>);
+    readonly getBillingReadonly: (input: GetBillingReadonlyInput) => Promise<GetBillingReadonlyResponse>;
     readonly getPlan: (input: GetPlanInput) => Promise<GetPlanResponse>;
     readonly listPlans: (input: ListPlansInput) => Promise<ListPlansResponse>;
     readonly getAddon: (input: GetAddonInput) => Promise<GetAddonResponse>;
@@ -21380,6 +21452,52 @@ type TrackAnalyticsInput = TrackAnalyticsRequestBody & TrackAnalyticsRequestHead
 interface TrackAnalyticsResponse {
 }
 
+interface CaptureObservationRequestHeaders {
+}
+interface CaptureObservationRequestQuery {
+}
+interface CaptureObservationRequestParams {
+}
+interface CaptureObservationRequestBody {
+    /**
+     * Name of the observation
+     */
+    name: string;
+    /**
+     * Data of the observation
+     */
+    data: {
+        [k: string]: any;
+    };
+    /**
+     * ID of the message associated with the observation
+     */
+    messageId?: string;
+    /**
+     * ID of the event associated with the observation
+     */
+    eventId?: string;
+    /**
+     * ID of the conversation associated with the observation
+     */
+    conversationId?: string;
+    /**
+     * ID of the user associated with the observation
+     */
+    userId?: string;
+    /**
+     * ID of the error associated with the observation
+     */
+    errorId?: string;
+    /**
+     * ID of the trace associated with the observation
+     */
+    traceId?: string;
+}
+type CaptureObservationInput = CaptureObservationRequestBody & CaptureObservationRequestHeaders & CaptureObservationRequestQuery & CaptureObservationRequestParams;
+interface CaptureObservationResponse {
+}
+
 interface RunVrlRequestHeaders {
 }
 interface RunVrlRequestQuery {
@@ -23844,7 +23962,7 @@ interface CreateBotRequestBody {
         name: string;
     }[];
     /**
-     * URL of the [Bot](#schema_bot); Only available for dev bots
+     * URL of the [Bot](#schema_bot)
      */
     url?: string;
     /**
@@ -24278,9 +24396,9 @@ interface UpdateBotRequestParams {
 }
 interface UpdateBotRequestBody {
     /**
-     * URL of the [Bot](#schema_bot); Only available for dev bots
+     * URL of the [Bot](#schema_bot)
      */
-    url?: string;
+    url?: string | null;
     /**
      * Type of the [Bot](#schema_bot) authentication (`iam`)
      */
@@ -25593,6 +25711,9 @@ interface ListActionRunsResponse {
          * ISO 8601 timestamp of the action run
          */
         timestamp: string;
+        /**
+         * Alias of the integration instance used for this action run
+         */
         integrationName?: string;
         actionType: string;
         /**
@@ -25601,12 +25722,20 @@ interface ListActionRunsResponse {
         input: {
             [k: string]: any;
         };
+        /**
+         * Present if the length of the action's input exceeds 190 KB.
+         */
+        inputTruncated?: boolean;
         /**
          * Output of the action
          */
         output: {
             [k: string]: any;
         } | null;
+        /**
+         * Present if the length of the action's output exceeds 190 KB.
+         */
+        outputTruncated?: boolean;
         status: "SUCCESS" | "FAILURE";
         durationMs: number;
         cached: boolean;
@@ -26132,7 +26261,7 @@ interface CreateWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -26186,7 +26315,7 @@ interface GetWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -26358,7 +26487,7 @@ interface UpdateWorkspaceResponse$1 {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -26415,7 +26544,7 @@ interface UpdateWorkspaceResponse {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -36630,7 +36759,7 @@ interface Workspace {
     createdAt: string;
     updatedAt: string;
     botCount: number;
-    billingVersion: "v1" | "v2" | "v3";
+    billingVersion: "v1" | "v2" | "v3" | "v4";
     plan: "community" | "team" | "enterprise" | "plus";
     blocked: boolean;
     spendingLimit: number;
@@ -37431,6 +37560,7 @@ declare class Client$1 {
     readonly getOrCreateWorkflow: (input: GetOrCreateWorkflowInput) => Promise<GetOrCreateWorkflowResponse>;
     readonly listTagValues: (input: ListTagValuesInput) => Promise<ListTagValuesResponse>;
     readonly trackAnalytics: (input: TrackAnalyticsInput) => Promise<TrackAnalyticsResponse>;
+    readonly captureObservation: (input: CaptureObservationInput) => Promise<CaptureObservationResponse>;
     readonly runVrl: (input: RunVrlInput) => Promise<RunVrlResponse>;
     readonly getAccount: (input: GetAccountInput) => Promise<GetAccountResponse>;
     readonly updateAccount: (input: UpdateAccountInput) => Promise<UpdateAccountResponse>;
@@ -38266,8 +38396,15 @@ 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' | '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;
+type OperationTimeoutType = 'OperationTimeout';
+/**
+ *  The operation timed out.
+ */
+declare class OperationTimeoutError extends BaseApiError<504, OperationTimeoutType, 'The operation timed out.'> {
+    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' | 'ResourceGone' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded' | 'BreakingChanges' | 'OperationTimeout';
+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 | OperationTimeoutError;
 declare const errorFrom: (err: unknown) => ApiError;
 
 declare class UploadFileError extends Error {
@@ -38276,4 +38413,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, 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$3 as admin, index$2 as billing, errorFrom, index$1 as files, isApiError, index$4 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, OperationTimeoutError, 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$3 as admin, index$2 as billing, errorFrom, index$1 as files, isApiError, index$4 as runtime, index as tables };