@botpress/client 0.13.0 → 0.13.1

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.21.0
5
+ * The version of the OpenAPI document: 0.22.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1963,6 +1963,12 @@ export interface CreateTableBody {
1963
1963
  * @memberof CreateTableBody
1964
1964
  */
1965
1965
  'factor'?: number;
1966
+ /**
1967
+ * A table designated as \"frozen\" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
1968
+ * @type {boolean}
1969
+ * @memberof CreateTableBody
1970
+ */
1971
+ 'frozen'?: boolean;
1966
1972
  /**
1967
1973
  * Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
1968
1974
  * @type {{ [key: string]: any; }}
@@ -3189,6 +3195,12 @@ export interface GetOrCreateTableBody {
3189
3195
  * @memberof GetOrCreateTableBody
3190
3196
  */
3191
3197
  'factor'?: number;
3198
+ /**
3199
+ * A table designated as \"frozen\" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
3200
+ * @type {boolean}
3201
+ * @memberof GetOrCreateTableBody
3202
+ */
3203
+ 'frozen'?: boolean;
3192
3204
  /**
3193
3205
  * Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
3194
3206
  * @type {{ [key: string]: any; }}
@@ -6195,6 +6207,12 @@ export interface Table {
6195
6207
  * @memberof Table
6196
6208
  */
6197
6209
  'factor'?: number;
6210
+ /**
6211
+ * A table designated as \"frozen\" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
6212
+ * @type {boolean}
6213
+ * @memberof Table
6214
+ */
6215
+ 'frozen'?: boolean;
6198
6216
  /**
6199
6217
  *
6200
6218
  * @type {TableSchema}
@@ -7264,6 +7282,12 @@ export interface UpdateTableBody {
7264
7282
  * @memberof UpdateTableBody
7265
7283
  */
7266
7284
  'name'?: string;
7285
+ /**
7286
+ * A table designated as \"frozen\" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
7287
+ * @type {boolean}
7288
+ * @memberof UpdateTableBody
7289
+ */
7290
+ 'frozen'?: boolean;
7267
7291
  /**
7268
7292
  * Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
7269
7293
  * @type {{ [key: string]: any; }}
@@ -8276,17 +8300,17 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8276
8300
  createEvent: (createEventBody?: CreateEventBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8277
8301
  /**
8278
8302
  * Creates a file.
8279
- * @param {string} xName File name
8303
+ * @param {string} [xName] File name
8280
8304
  * @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
8281
8305
  * @param {string} [xAccessPolicies] File access policies, comma-separated. Add \&quot;public_content\&quot; to allow public access to the file content. Add \&quot;integrations\&quot; to allo read, search and list operations for any integration installed in the bot.
8282
- * @param {boolean} [xIndex] Set to a value of \&quot;true\&quot; to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
8306
+ * @param {boolean} [xIndex] Set to a value of \&quot;true\&quot; to index the file in vector storage (default: false). Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
8283
8307
  * @param {string} [contentType] File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \&quot;application/octet-stream\&quot;.
8284
8308
  * @param {string} [contentLength] File content length
8285
8309
  * @param {CreateFileBody} [createFileBody] The file to upload.
8286
8310
  * @param {*} [options] Override http request option.
8287
8311
  * @throws {RequiredError}
8288
8312
  */
8289
- createFile: (xName: string, xTags?: string, xAccessPolicies?: string, xIndex?: boolean, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8313
+ createFile: (xName?: string, xTags?: string, xAccessPolicies?: string, xIndex?: boolean, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8290
8314
  /**
8291
8315
  * Create integration
8292
8316
  * @param {CreateIntegrationBody} [createIntegrationBody] Integration
@@ -9219,17 +9243,17 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9219
9243
  createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
9220
9244
  /**
9221
9245
  * Creates a file.
9222
- * @param {string} xName File name
9246
+ * @param {string} [xName] File name
9223
9247
  * @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
9224
9248
  * @param {string} [xAccessPolicies] File access policies, comma-separated. Add \&quot;public_content\&quot; to allow public access to the file content. Add \&quot;integrations\&quot; to allo read, search and list operations for any integration installed in the bot.
9225
- * @param {boolean} [xIndex] Set to a value of \&quot;true\&quot; to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
9249
+ * @param {boolean} [xIndex] Set to a value of \&quot;true\&quot; to index the file in vector storage (default: false). Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
9226
9250
  * @param {string} [contentType] File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \&quot;application/octet-stream\&quot;.
9227
9251
  * @param {string} [contentLength] File content length
9228
9252
  * @param {CreateFileBody} [createFileBody] The file to upload.
9229
9253
  * @param {*} [options] Override http request option.
9230
9254
  * @throws {RequiredError}
9231
9255
  */
9232
- createFile(xName: string, xTags?: string, xAccessPolicies?: string, xIndex?: boolean, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
9256
+ createFile(xName?: string, xTags?: string, xAccessPolicies?: string, xIndex?: boolean, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
9233
9257
  /**
9234
9258
  * Create integration
9235
9259
  * @param {CreateIntegrationBody} [createIntegrationBody] Integration
@@ -10163,7 +10187,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
10163
10187
  * @param {*} [options] Override http request option.
10164
10188
  * @throws {RequiredError}
10165
10189
  */
10166
- createFile(requestParameters: DefaultApiCreateFileRequest, options?: AxiosRequestConfig): AxiosPromise<CreateFileResponse>;
10190
+ createFile(requestParameters?: DefaultApiCreateFileRequest, options?: AxiosRequestConfig): AxiosPromise<CreateFileResponse>;
10167
10191
  /**
10168
10192
  * Create integration
10169
10193
  * @param {DefaultApiCreateIntegrationRequest} requestParameters Request parameters.
@@ -11090,7 +11114,7 @@ export interface DefaultApiCreateFileRequest {
11090
11114
  * @type {string}
11091
11115
  * @memberof DefaultApiCreateFile
11092
11116
  */
11093
- readonly xName: string;
11117
+ readonly xName?: string;
11094
11118
  /**
11095
11119
  * File tags as URL-encoded JSON string representing an object of key-value pairs.
11096
11120
  * @type {string}
@@ -11104,7 +11128,7 @@ export interface DefaultApiCreateFileRequest {
11104
11128
  */
11105
11129
  readonly xAccessPolicies?: string;
11106
11130
  /**
11107
- * Set to a value of \&quot;true\&quot; to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
11131
+ * Set to a value of \&quot;true\&quot; to index the file in vector storage (default: false). Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
11108
11132
  * @type {boolean}
11109
11133
  * @memberof DefaultApiCreateFile
11110
11134
  */
@@ -13117,7 +13141,7 @@ export declare class DefaultApi extends BaseAPI {
13117
13141
  * @throws {RequiredError}
13118
13142
  * @memberof DefaultApi
13119
13143
  */
13120
- createFile(requestParameters: DefaultApiCreateFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFileResponse, any>>;
13144
+ createFile(requestParameters?: DefaultApiCreateFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFileResponse, any>>;
13121
13145
  /**
13122
13146
  * Create integration
13123
13147
  * @param {DefaultApiCreateIntegrationRequest} 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.21.0
5
+ * The version of the OpenAPI document: 0.22.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Botpress API
4
4
  * API for Botpress Cloud
5
5
  *
6
- * The version of the OpenAPI document: 0.21.0
6
+ * The version of the OpenAPI document: 0.22.0
7
7
  *
8
8
  *
9
9
  * 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.21.0
5
+ * The version of the OpenAPI document: 0.22.0
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.21.0
5
+ * The version of the OpenAPI document: 0.22.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).