@botpress/client 1.30.0 → 1.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -5836,7 +5836,7 @@ interface CreateBotRequestBody$1 {
5836
5836
  name: string;
5837
5837
  }[];
5838
5838
  /**
5839
- * URL of the [Bot](#schema_bot); Only available for dev bots
5839
+ * URL of the [Bot](#schema_bot)
5840
5840
  */
5841
5841
  url?: string;
5842
5842
  /**
@@ -6270,9 +6270,9 @@ interface UpdateBotRequestParams$1 {
6270
6270
  }
6271
6271
  interface UpdateBotRequestBody$1 {
6272
6272
  /**
6273
- * URL of the [Bot](#schema_bot); Only available for dev bots
6273
+ * URL of the [Bot](#schema_bot)
6274
6274
  */
6275
- url?: string;
6275
+ url?: string | null;
6276
6276
  /**
6277
6277
  * Type of the [Bot](#schema_bot) authentication (`iam`)
6278
6278
  */
@@ -7585,6 +7585,9 @@ interface ListActionRunsResponse$1 {
7585
7585
  * ISO 8601 timestamp of the action run
7586
7586
  */
7587
7587
  timestamp: string;
7588
+ /**
7589
+ * Alias of the integration instance used for this action run
7590
+ */
7588
7591
  integrationName?: string;
7589
7592
  actionType: string;
7590
7593
  /**
@@ -7593,12 +7596,20 @@ interface ListActionRunsResponse$1 {
7593
7596
  input: {
7594
7597
  [k: string]: any;
7595
7598
  };
7599
+ /**
7600
+ * Present if the length of the action's input exceeds 190 KB.
7601
+ */
7602
+ inputTruncated?: boolean;
7596
7603
  /**
7597
7604
  * Output of the action
7598
7605
  */
7599
7606
  output: {
7600
7607
  [k: string]: any;
7601
7608
  } | null;
7609
+ /**
7610
+ * Present if the length of the action's output exceeds 190 KB.
7611
+ */
7612
+ outputTruncated?: boolean;
7602
7613
  status: "SUCCESS" | "FAILURE";
7603
7614
  durationMs: number;
7604
7615
  cached: boolean;
@@ -8124,7 +8135,7 @@ interface CreateWorkspaceResponse$1 {
8124
8135
  createdAt: string;
8125
8136
  updatedAt: string;
8126
8137
  botCount: number;
8127
- billingVersion: "v1" | "v2" | "v3";
8138
+ billingVersion: "v1" | "v2" | "v3" | "v4";
8128
8139
  plan: "community" | "team" | "enterprise" | "plus";
8129
8140
  blocked: boolean;
8130
8141
  spendingLimit: number;
@@ -8178,7 +8189,7 @@ interface GetWorkspaceResponse$1 {
8178
8189
  createdAt: string;
8179
8190
  updatedAt: string;
8180
8191
  botCount: number;
8181
- billingVersion: "v1" | "v2" | "v3";
8192
+ billingVersion: "v1" | "v2" | "v3" | "v4";
8182
8193
  plan: "community" | "team" | "enterprise" | "plus";
8183
8194
  blocked: boolean;
8184
8195
  spendingLimit: number;
@@ -8350,7 +8361,7 @@ interface UpdateWorkspaceResponse$3 {
8350
8361
  createdAt: string;
8351
8362
  updatedAt: string;
8352
8363
  botCount: number;
8353
- billingVersion: "v1" | "v2" | "v3";
8364
+ billingVersion: "v1" | "v2" | "v3" | "v4";
8354
8365
  plan: "community" | "team" | "enterprise" | "plus";
8355
8366
  blocked: boolean;
8356
8367
  spendingLimit: number;
@@ -8407,7 +8418,7 @@ interface UpdateWorkspaceResponse$2 {
8407
8418
  createdAt: string;
8408
8419
  updatedAt: string;
8409
8420
  botCount: number;
8410
- billingVersion: "v1" | "v2" | "v3";
8421
+ billingVersion: "v1" | "v2" | "v3" | "v4";
8411
8422
  plan: "community" | "team" | "enterprise" | "plus";
8412
8423
  blocked: boolean;
8413
8424
  spendingLimit: number;
@@ -15032,6 +15043,19 @@ type ParsedRequest$3 = {
15032
15043
  };
15033
15044
  declare const toAxiosRequest$3: (req: ParsedRequest$3) => AxiosRequestConfig;
15034
15045
 
15046
+ interface GetBillingReadonlyRequestHeaders {
15047
+ }
15048
+ interface GetBillingReadonlyRequestQuery {
15049
+ }
15050
+ interface GetBillingReadonlyRequestParams {
15051
+ }
15052
+ interface GetBillingReadonlyRequestBody {
15053
+ }
15054
+ type GetBillingReadonlyInput = GetBillingReadonlyRequestBody & GetBillingReadonlyRequestHeaders & GetBillingReadonlyRequestQuery & GetBillingReadonlyRequestParams;
15055
+ interface GetBillingReadonlyResponse {
15056
+ billingReadonly: boolean;
15057
+ }
15058
+
15035
15059
  interface GetPlanRequestHeaders {
15036
15060
  }
15037
15061
  interface GetPlanRequestQuery {
@@ -15287,6 +15311,7 @@ declare class Client$7 {
15287
15311
  private axiosInstance;
15288
15312
  private props;
15289
15313
  constructor(axiosInstance: AxiosInstance, props?: Partial<ClientProps$7>);
15314
+ readonly getBillingReadonly: (input: GetBillingReadonlyInput) => Promise<GetBillingReadonlyResponse>;
15290
15315
  readonly getPlan: (input: GetPlanInput) => Promise<GetPlanResponse>;
15291
15316
  readonly listPlans: (input: ListPlansInput) => Promise<ListPlansResponse>;
15292
15317
  readonly getAddon: (input: GetAddonInput) => Promise<GetAddonResponse>;
@@ -23844,7 +23869,7 @@ interface CreateBotRequestBody {
23844
23869
  name: string;
23845
23870
  }[];
23846
23871
  /**
23847
- * URL of the [Bot](#schema_bot); Only available for dev bots
23872
+ * URL of the [Bot](#schema_bot)
23848
23873
  */
23849
23874
  url?: string;
23850
23875
  /**
@@ -24278,9 +24303,9 @@ interface UpdateBotRequestParams {
24278
24303
  }
24279
24304
  interface UpdateBotRequestBody {
24280
24305
  /**
24281
- * URL of the [Bot](#schema_bot); Only available for dev bots
24306
+ * URL of the [Bot](#schema_bot)
24282
24307
  */
24283
- url?: string;
24308
+ url?: string | null;
24284
24309
  /**
24285
24310
  * Type of the [Bot](#schema_bot) authentication (`iam`)
24286
24311
  */
@@ -25593,6 +25618,9 @@ interface ListActionRunsResponse {
25593
25618
  * ISO 8601 timestamp of the action run
25594
25619
  */
25595
25620
  timestamp: string;
25621
+ /**
25622
+ * Alias of the integration instance used for this action run
25623
+ */
25596
25624
  integrationName?: string;
25597
25625
  actionType: string;
25598
25626
  /**
@@ -25601,12 +25629,20 @@ interface ListActionRunsResponse {
25601
25629
  input: {
25602
25630
  [k: string]: any;
25603
25631
  };
25632
+ /**
25633
+ * Present if the length of the action's input exceeds 190 KB.
25634
+ */
25635
+ inputTruncated?: boolean;
25604
25636
  /**
25605
25637
  * Output of the action
25606
25638
  */
25607
25639
  output: {
25608
25640
  [k: string]: any;
25609
25641
  } | null;
25642
+ /**
25643
+ * Present if the length of the action's output exceeds 190 KB.
25644
+ */
25645
+ outputTruncated?: boolean;
25610
25646
  status: "SUCCESS" | "FAILURE";
25611
25647
  durationMs: number;
25612
25648
  cached: boolean;
@@ -26132,7 +26168,7 @@ interface CreateWorkspaceResponse {
26132
26168
  createdAt: string;
26133
26169
  updatedAt: string;
26134
26170
  botCount: number;
26135
- billingVersion: "v1" | "v2" | "v3";
26171
+ billingVersion: "v1" | "v2" | "v3" | "v4";
26136
26172
  plan: "community" | "team" | "enterprise" | "plus";
26137
26173
  blocked: boolean;
26138
26174
  spendingLimit: number;
@@ -26186,7 +26222,7 @@ interface GetWorkspaceResponse {
26186
26222
  createdAt: string;
26187
26223
  updatedAt: string;
26188
26224
  botCount: number;
26189
- billingVersion: "v1" | "v2" | "v3";
26225
+ billingVersion: "v1" | "v2" | "v3" | "v4";
26190
26226
  plan: "community" | "team" | "enterprise" | "plus";
26191
26227
  blocked: boolean;
26192
26228
  spendingLimit: number;
@@ -26358,7 +26394,7 @@ interface UpdateWorkspaceResponse$1 {
26358
26394
  createdAt: string;
26359
26395
  updatedAt: string;
26360
26396
  botCount: number;
26361
- billingVersion: "v1" | "v2" | "v3";
26397
+ billingVersion: "v1" | "v2" | "v3" | "v4";
26362
26398
  plan: "community" | "team" | "enterprise" | "plus";
26363
26399
  blocked: boolean;
26364
26400
  spendingLimit: number;
@@ -26415,7 +26451,7 @@ interface UpdateWorkspaceResponse {
26415
26451
  createdAt: string;
26416
26452
  updatedAt: string;
26417
26453
  botCount: number;
26418
- billingVersion: "v1" | "v2" | "v3";
26454
+ billingVersion: "v1" | "v2" | "v3" | "v4";
26419
26455
  plan: "community" | "team" | "enterprise" | "plus";
26420
26456
  blocked: boolean;
26421
26457
  spendingLimit: number;
@@ -36630,7 +36666,7 @@ interface Workspace {
36630
36666
  createdAt: string;
36631
36667
  updatedAt: string;
36632
36668
  botCount: number;
36633
- billingVersion: "v1" | "v2" | "v3";
36669
+ billingVersion: "v1" | "v2" | "v3" | "v4";
36634
36670
  plan: "community" | "team" | "enterprise" | "plus";
36635
36671
  blocked: boolean;
36636
36672
  spendingLimit: number;
@@ -38266,8 +38302,15 @@ type BreakingChangesType = 'BreakingChanges';
38266
38302
  declare class BreakingChangesError extends BaseApiError<400, BreakingChangesType, 'Request payload contains breaking changes which is not allowed for this resource without a version increment.'> {
38267
38303
  constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
38268
38304
  }
38269
- 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';
38270
- 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;
38305
+ type OperationTimeoutType = 'OperationTimeout';
38306
+ /**
38307
+ * The operation timed out.
38308
+ */
38309
+ declare class OperationTimeoutError extends BaseApiError<504, OperationTimeoutType, 'The operation timed out.'> {
38310
+ constructor(message: string, error?: Error, id?: string, metadata?: Record<string, unknown>);
38311
+ }
38312
+ 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';
38313
+ 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;
38271
38314
  declare const errorFrom: (err: unknown) => ApiError;
38272
38315
 
38273
38316
  declare class UploadFileError extends Error {
@@ -38276,4 +38319,4 @@ declare class UploadFileError extends Error {
38276
38319
  constructor(message: string, innerError?: AxiosError | undefined, file?: UpsertFileResponse["file"] | undefined);
38277
38320
  }
38278
38321
 
38279
- 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 };
38322
+ 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 };