@botpress/client 0.16.1 → 0.17.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/gen/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.10
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -37,6 +37,12 @@ export interface Account {
37
37
  * @memberof Account
38
38
  */
39
39
  'displayName'?: string;
40
+ /**
41
+ *
42
+ * @type {boolean}
43
+ * @memberof Account
44
+ */
45
+ 'emailVerified': boolean;
40
46
  /**
41
47
  *
42
48
  * @type {string}
@@ -744,6 +750,12 @@ export interface Column {
744
750
  * @memberof Column
745
751
  */
746
752
  'typings'?: string;
753
+ /**
754
+ *
755
+ * @type {TableSchemaPropertiesValueXZuiComputed}
756
+ * @memberof Column
757
+ */
758
+ 'computed'?: TableSchemaPropertiesValueXZuiComputed;
747
759
  /**
748
760
  *
749
761
  * @type {{ [key: string]: any; }}
@@ -1877,6 +1889,12 @@ export interface CreateTableBody {
1877
1889
  'tags'?: {
1878
1890
  [key: string]: string;
1879
1891
  };
1892
+ /**
1893
+ * Indicates if the table is enabled for computation.
1894
+ * @type {boolean}
1895
+ * @memberof CreateTableBody
1896
+ */
1897
+ 'isComputeEnabled'?: boolean;
1880
1898
  }
1881
1899
  /**
1882
1900
  *
@@ -1905,6 +1923,12 @@ export interface CreateTableRowsBody {
1905
1923
  'rows': Array<{
1906
1924
  [key: string]: any;
1907
1925
  }>;
1926
+ /**
1927
+ * Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.
1928
+ * @type {boolean}
1929
+ * @memberof CreateTableRowsBody
1930
+ */
1931
+ 'waitComputed'?: boolean;
1908
1932
  }
1909
1933
  /**
1910
1934
  *
@@ -2573,6 +2597,12 @@ export interface GetAccountResponseAccount {
2573
2597
  * @memberof GetAccountResponseAccount
2574
2598
  */
2575
2599
  'displayName'?: string;
2600
+ /**
2601
+ *
2602
+ * @type {boolean}
2603
+ * @memberof GetAccountResponseAccount
2604
+ */
2605
+ 'emailVerified': boolean;
2576
2606
  /**
2577
2607
  *
2578
2608
  * @type {string}
@@ -3209,6 +3239,12 @@ export interface GetOrCreateTableBody {
3209
3239
  'tags'?: {
3210
3240
  [key: string]: string;
3211
3241
  };
3242
+ /**
3243
+ * Indicates if the table is enabled for computation.
3244
+ * @type {boolean}
3245
+ * @memberof GetOrCreateTableBody
3246
+ */
3247
+ 'isComputeEnabled'?: boolean;
3212
3248
  }
3213
3249
  /**
3214
3250
  *
@@ -3235,11 +3271,17 @@ export interface GetOrCreateTableResponse {
3235
3271
  */
3236
3272
  'rows': number;
3237
3273
  /**
3238
- * The number of rows pending indexing, relevant for search functionalities.
3274
+ * The number of stale rows that are waiting to be processed
3275
+ * @type {number}
3276
+ * @memberof GetOrCreateTableResponse
3277
+ */
3278
+ 'stale': number;
3279
+ /**
3280
+ * The number of rows that are waiting to be indexed (for search)
3239
3281
  * @type {number}
3240
3282
  * @memberof GetOrCreateTableResponse
3241
3283
  */
3242
- 'indexingCount': number;
3284
+ 'indexing': number;
3243
3285
  }
3244
3286
  /**
3245
3287
  *
@@ -3988,11 +4030,17 @@ export interface GetTableResponse {
3988
4030
  */
3989
4031
  'rows': number;
3990
4032
  /**
3991
- * The number of rows pending indexing, relevant for search functionalities.
4033
+ * The number of stale rows that are waiting to be processed
4034
+ * @type {number}
4035
+ * @memberof GetTableResponse
4036
+ */
4037
+ 'stale': number;
4038
+ /**
4039
+ * The number of rows that are waiting to be indexed (for search)
3992
4040
  * @type {number}
3993
4041
  * @memberof GetTableResponse
3994
4042
  */
3995
- 'indexingCount': number;
4043
+ 'indexing': number;
3996
4044
  }
3997
4045
  /**
3998
4046
  *
@@ -4065,6 +4113,52 @@ export interface GetUserResponse {
4065
4113
  */
4066
4114
  'user': User;
4067
4115
  }
4116
+ /**
4117
+ *
4118
+ * @export
4119
+ * @interface GetWorkspaceMemberResponse
4120
+ */
4121
+ export interface GetWorkspaceMemberResponse {
4122
+ /**
4123
+ *
4124
+ * @type {string}
4125
+ * @memberof GetWorkspaceMemberResponse
4126
+ */
4127
+ 'id': string;
4128
+ /**
4129
+ *
4130
+ * @type {string}
4131
+ * @memberof GetWorkspaceMemberResponse
4132
+ */
4133
+ 'userId'?: string;
4134
+ /**
4135
+ *
4136
+ * @type {string}
4137
+ * @memberof GetWorkspaceMemberResponse
4138
+ */
4139
+ 'email': string;
4140
+ /**
4141
+ *
4142
+ * @type {string}
4143
+ * @memberof GetWorkspaceMemberResponse
4144
+ */
4145
+ 'createdAt': string;
4146
+ /**
4147
+ *
4148
+ * @type {string}
4149
+ * @memberof GetWorkspaceMemberResponse
4150
+ */
4151
+ 'role': GetWorkspaceMemberResponseRoleEnum;
4152
+ }
4153
+ export declare const GetWorkspaceMemberResponseRoleEnum: {
4154
+ readonly Viewer: "viewer";
4155
+ readonly Billing: "billing";
4156
+ readonly Developer: "developer";
4157
+ readonly Manager: "manager";
4158
+ readonly Administrator: "administrator";
4159
+ readonly Owner: "owner";
4160
+ };
4161
+ export type GetWorkspaceMemberResponseRoleEnum = typeof GetWorkspaceMemberResponseRoleEnum[keyof typeof GetWorkspaceMemberResponseRoleEnum];
4068
4162
  /**
4069
4163
  *
4070
4164
  * @export
@@ -5796,6 +5890,20 @@ export interface Row {
5796
5890
  * @memberof Row
5797
5891
  */
5798
5892
  'updatedAt'?: string;
5893
+ /**
5894
+ *
5895
+ * @type {{ [key: string]: RowComputedValue; }}
5896
+ * @memberof Row
5897
+ */
5898
+ 'computed': {
5899
+ [key: string]: RowComputedValue;
5900
+ };
5901
+ /**
5902
+ * [Read-only] List of stale values that are waiting to be recomputed.
5903
+ * @type {Array<string>}
5904
+ * @memberof Row
5905
+ */
5906
+ 'stale'?: Array<string>;
5799
5907
  /**
5800
5908
  * Optional numeric value indicating similarity, when using findTableRows.
5801
5909
  * @type {number}
@@ -5803,6 +5911,37 @@ export interface Row {
5803
5911
  */
5804
5912
  'similarity'?: number;
5805
5913
  }
5914
+ /**
5915
+ *
5916
+ * @export
5917
+ * @interface RowComputedValue
5918
+ */
5919
+ export interface RowComputedValue {
5920
+ /**
5921
+ *
5922
+ * @type {string}
5923
+ * @memberof RowComputedValue
5924
+ */
5925
+ 'status': string;
5926
+ /**
5927
+ *
5928
+ * @type {string}
5929
+ * @memberof RowComputedValue
5930
+ */
5931
+ 'error'?: string;
5932
+ /**
5933
+ *
5934
+ * @type {string}
5935
+ * @memberof RowComputedValue
5936
+ */
5937
+ 'updatedBy'?: string;
5938
+ /**
5939
+ *
5940
+ * @type {string}
5941
+ * @memberof RowComputedValue
5942
+ */
5943
+ 'updatedAt'?: string;
5944
+ }
5806
5945
  /**
5807
5946
  *
5808
5947
  * @export
@@ -6169,6 +6308,12 @@ export interface Table {
6169
6308
  'tags'?: {
6170
6309
  [key: string]: string;
6171
6310
  };
6311
+ /**
6312
+ * Indicates if the table is enabled for computation.
6313
+ * @type {boolean}
6314
+ * @memberof Table
6315
+ */
6316
+ 'isComputeEnabled'?: boolean;
6172
6317
  /**
6173
6318
  * Timestamp of table creation.
6174
6319
  * @type {string}
@@ -6298,6 +6443,30 @@ export interface TableSchemaPropertiesValueXZui {
6298
6443
  * @memberof TableSchemaPropertiesValueXZui
6299
6444
  */
6300
6445
  'searchable'?: boolean;
6446
+ /**
6447
+ * Indicates if the field is hidden in the UI
6448
+ * @type {boolean}
6449
+ * @memberof TableSchemaPropertiesValueXZui
6450
+ */
6451
+ 'hidden'?: boolean;
6452
+ /**
6453
+ * Order of the column in the UI
6454
+ * @type {number}
6455
+ * @memberof TableSchemaPropertiesValueXZui
6456
+ */
6457
+ 'order'?: number;
6458
+ /**
6459
+ * Width of the column in the UI
6460
+ * @type {number}
6461
+ * @memberof TableSchemaPropertiesValueXZui
6462
+ */
6463
+ 'width'?: number;
6464
+ /**
6465
+ *
6466
+ * @type {TableSchemaPropertiesValueXZuiComputed}
6467
+ * @memberof TableSchemaPropertiesValueXZui
6468
+ */
6469
+ 'computed'?: TableSchemaPropertiesValueXZuiComputed;
6301
6470
  /**
6302
6471
  * TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\"
6303
6472
  * @type {string}
@@ -6305,6 +6474,59 @@ export interface TableSchemaPropertiesValueXZui {
6305
6474
  */
6306
6475
  'typings'?: string;
6307
6476
  }
6477
+ /**
6478
+ *
6479
+ * @export
6480
+ * @interface TableSchemaPropertiesValueXZuiComputed
6481
+ */
6482
+ export interface TableSchemaPropertiesValueXZuiComputed {
6483
+ /**
6484
+ *
6485
+ * @type {string}
6486
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6487
+ */
6488
+ 'action': TableSchemaPropertiesValueXZuiComputedActionEnum;
6489
+ /**
6490
+ *
6491
+ * @type {Array<string>}
6492
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6493
+ */
6494
+ 'dependencies'?: Array<string>;
6495
+ /**
6496
+ * Prompt when action is \"ai\"
6497
+ * @type {string}
6498
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6499
+ */
6500
+ 'prompt'?: string;
6501
+ /**
6502
+ * Model to use when action is \"ai\"
6503
+ * @type {string}
6504
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6505
+ */
6506
+ 'model'?: TableSchemaPropertiesValueXZuiComputedModelEnum;
6507
+ /**
6508
+ * Code to execute when action is \"code\"
6509
+ * @type {string}
6510
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6511
+ */
6512
+ 'code'?: string;
6513
+ /**
6514
+ *
6515
+ * @type {boolean}
6516
+ * @memberof TableSchemaPropertiesValueXZuiComputed
6517
+ */
6518
+ 'enabled'?: boolean;
6519
+ }
6520
+ export declare const TableSchemaPropertiesValueXZuiComputedActionEnum: {
6521
+ readonly Ai: "ai";
6522
+ readonly Code: "code";
6523
+ };
6524
+ export type TableSchemaPropertiesValueXZuiComputedActionEnum = typeof TableSchemaPropertiesValueXZuiComputedActionEnum[keyof typeof TableSchemaPropertiesValueXZuiComputedActionEnum];
6525
+ export declare const TableSchemaPropertiesValueXZuiComputedModelEnum: {
6526
+ readonly _35Turbo: "gpt-3.5-turbo";
6527
+ readonly _4Turbo: "gpt-4-turbo";
6528
+ };
6529
+ export type TableSchemaPropertiesValueXZuiComputedModelEnum = typeof TableSchemaPropertiesValueXZuiComputedModelEnum[keyof typeof TableSchemaPropertiesValueXZuiComputedModelEnum];
6308
6530
  /**
6309
6531
  * Task definition
6310
6532
  * @export
@@ -6461,6 +6683,12 @@ export interface UpdateAccountBody {
6461
6683
  * @memberof UpdateAccountBody
6462
6684
  */
6463
6685
  'profilePicture'?: string;
6686
+ /**
6687
+ *
6688
+ * @type {boolean}
6689
+ * @memberof UpdateAccountBody
6690
+ */
6691
+ 'refresh'?: boolean;
6464
6692
  }
6465
6693
  /**
6466
6694
  *
@@ -7272,6 +7500,12 @@ export interface UpdateTableBody {
7272
7500
  'tags'?: {
7273
7501
  [key: string]: string;
7274
7502
  };
7503
+ /**
7504
+ * Indicates if the table is enabled for computation.
7505
+ * @type {boolean}
7506
+ * @memberof UpdateTableBody
7507
+ */
7508
+ 'isComputeEnabled'?: boolean;
7275
7509
  }
7276
7510
  /**
7277
7511
  *
@@ -7285,6 +7519,12 @@ export interface UpdateTableResponse {
7285
7519
  * @memberof UpdateTableResponse
7286
7520
  */
7287
7521
  'table': Table;
7522
+ /**
7523
+ * List of columns that have become stale following the modification.
7524
+ * @type {Array<string>}
7525
+ * @memberof UpdateTableResponse
7526
+ */
7527
+ 'staleColumns'?: Array<string>;
7288
7528
  }
7289
7529
  /**
7290
7530
  *
@@ -7298,6 +7538,12 @@ export interface UpdateTableRowsBody {
7298
7538
  * @memberof UpdateTableRowsBody
7299
7539
  */
7300
7540
  'rows': Array<UpdateTableRowsBodyRowsInner>;
7541
+ /**
7542
+ * Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.
7543
+ * @type {boolean}
7544
+ * @memberof UpdateTableRowsBody
7545
+ */
7546
+ 'waitComputed'?: boolean;
7301
7547
  }
7302
7548
  /**
7303
7549
  *
@@ -7858,6 +8104,12 @@ export interface UpsertTableRowsBody {
7858
8104
  * @memberof UpsertTableRowsBody
7859
8105
  */
7860
8106
  'keyColumn'?: string;
8107
+ /**
8108
+ * Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.
8109
+ * @type {boolean}
8110
+ * @memberof UpsertTableRowsBody
8111
+ */
8112
+ 'waitComputed'?: boolean;
7861
8113
  }
7862
8114
  /**
7863
8115
  *
@@ -8696,6 +8948,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8696
8948
  * @throws {RequiredError}
8697
8949
  */
8698
8950
  getWorkspace: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8951
+ /**
8952
+ * Get details of the account authenticating with this endpoint.
8953
+ * @param {*} [options] Override http request option.
8954
+ * @throws {RequiredError}
8955
+ */
8956
+ getWorkspaceMember: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
8699
8957
  /**
8700
8958
  * Get workspace quota
8701
8959
  * @param {string} id Workspace ID
@@ -9620,6 +9878,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9620
9878
  * @throws {RequiredError}
9621
9879
  */
9622
9880
  getWorkspace(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceResponse>>;
9881
+ /**
9882
+ * Get details of the account authenticating with this endpoint.
9883
+ * @param {*} [options] Override http request option.
9884
+ * @throws {RequiredError}
9885
+ */
9886
+ getWorkspaceMember(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceMemberResponse>>;
9623
9887
  /**
9624
9888
  * Get workspace quota
9625
9889
  * @param {string} id Workspace ID
@@ -10513,6 +10777,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10513
10777
  * @throws {RequiredError}
10514
10778
  */
10515
10779
  getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
10780
+ /**
10781
+ * Get details of the account authenticating with this endpoint.
10782
+ * @param {*} [options] Override http request option.
10783
+ * @throws {RequiredError}
10784
+ */
10785
+ getWorkspaceMember(options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceMemberResponse>;
10516
10786
  /**
10517
10787
  * Get workspace quota
10518
10788
  * @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
@@ -13442,6 +13712,13 @@ export declare class DefaultApi extends BaseAPI {
13442
13712
  * @memberof DefaultApi
13443
13713
  */
13444
13714
  getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceResponse, any>>;
13715
+ /**
13716
+ * Get details of the account authenticating with this endpoint.
13717
+ * @param {*} [options] Override http request option.
13718
+ * @throws {RequiredError}
13719
+ * @memberof DefaultApi
13720
+ */
13721
+ getWorkspaceMember(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceMemberResponse, any>>;
13445
13722
  /**
13446
13723
  * Get workspace quota
13447
13724
  * @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.10
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -99,6 +99,7 @@ export declare class ApiClient {
99
99
  deleteWorkspace: (props: DeleteWorkspaceProps) => Promise<object>;
100
100
  getAuditRecords: (props: GetAuditRecordsProps) => Promise<import("./api").GetAuditRecordsResponse>;
101
101
  listWorkspaceMembers: (props: ListWorkspaceMembersProps) => Promise<import("./api").ListWorkspaceMembersResponse>;
102
+ getWorkspaceMember: () => Promise<import("./api").GetWorkspaceMemberResponse>;
102
103
  deleteWorkspaceMember: (props: DeleteWorkspaceMemberProps) => Promise<object>;
103
104
  createWorkspaceMember: (createWorkspaceMemberBody: CreateWorkspaceMemberProps) => Promise<import("./api").CreateWorkspaceMemberResponse>;
104
105
  updateWorkspaceMember: ({ id, ...updateWorkspaceMemberBody }: UpdateWorkspaceMemberProps) => Promise<import("./api").UpdateWorkspaceMemberResponse>;
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.10
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.10
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.27.10
5
+ * The version of the OpenAPI document: 0.27.15
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).