@botpress/client 0.12.3 → 0.12.4

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.19.3
5
+ * The version of the OpenAPI document: 0.20.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -418,6 +418,12 @@ export interface BotIntegrationsValue {
418
418
  * @memberof BotIntegrationsValue
419
419
  */
420
420
  'iconUrl': string;
421
+ /**
422
+ * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
423
+ * @type {boolean}
424
+ * @memberof BotIntegrationsValue
425
+ */
426
+ 'public': boolean;
421
427
  }
422
428
  export declare const BotIntegrationsValueStatusEnum: {
423
429
  readonly RegistrationPending: "registration_pending";
@@ -1593,6 +1599,12 @@ export interface CreateIntegrationBody {
1593
1599
  * @memberof CreateIntegrationBody
1594
1600
  */
1595
1601
  'description'?: string;
1602
+ /**
1603
+ * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
1604
+ * @type {boolean}
1605
+ * @memberof CreateIntegrationBody
1606
+ */
1607
+ 'public'?: boolean;
1596
1608
  }
1597
1609
  /**
1598
1610
  *
@@ -3302,6 +3314,12 @@ export interface GetPublicIntegrationByIdResponseIntegration {
3302
3314
  * @memberof GetPublicIntegrationByIdResponseIntegration
3303
3315
  */
3304
3316
  'readmeUrl': string;
3317
+ /**
3318
+ * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
3319
+ * @type {boolean}
3320
+ * @memberof GetPublicIntegrationByIdResponseIntegration
3321
+ */
3322
+ 'public': boolean;
3305
3323
  /**
3306
3324
  * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
3307
3325
  * @type {Array<string>}
@@ -4311,6 +4329,12 @@ export interface Integration {
4311
4329
  * @memberof Integration
4312
4330
  */
4313
4331
  'readmeUrl': string;
4332
+ /**
4333
+ * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
4334
+ * @type {boolean}
4335
+ * @memberof Integration
4336
+ */
4337
+ 'public': boolean;
4314
4338
  /**
4315
4339
  * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
4316
4340
  * @type {Array<string>}
@@ -4932,6 +4956,12 @@ export interface ListIntegrationsResponseIntegrationsInner {
4932
4956
  * @memberof ListIntegrationsResponseIntegrationsInner
4933
4957
  */
4934
4958
  'iconUrl': string;
4959
+ /**
4960
+ * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
4961
+ * @type {boolean}
4962
+ * @memberof ListIntegrationsResponseIntegrationsInner
4963
+ */
4964
+ 'public': boolean;
4935
4965
  }
4936
4966
  /**
4937
4967
  *
@@ -5082,6 +5112,12 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
5082
5112
  * @memberof ListPublicIntegrationsResponseIntegrationsInner
5083
5113
  */
5084
5114
  'iconUrl': string;
5115
+ /**
5116
+ * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
5117
+ * @type {boolean}
5118
+ * @memberof ListPublicIntegrationsResponseIntegrationsInner
5119
+ */
5120
+ 'public': boolean;
5085
5121
  /**
5086
5122
  *
5087
5123
  * @type {ListPublicIntegrationsResponseIntegrationsInnerOwnerWorkspace}
@@ -6761,6 +6797,12 @@ export interface UpdateIntegrationBody {
6761
6797
  * @memberof UpdateIntegrationBody
6762
6798
  */
6763
6799
  'url'?: string;
6800
+ /**
6801
+ * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
6802
+ * @type {boolean}
6803
+ * @memberof UpdateIntegrationBody
6804
+ */
6805
+ 'public'?: boolean;
6764
6806
  }
6765
6807
  /**
6766
6808
  *
@@ -8707,13 +8749,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
8707
8749
  * @param {string} botId Bot ID
8708
8750
  * @param {string} query Query expressed in natural language to retrieve matching text passages within all files using semantical search.
8709
8751
  * @param {{ [key: string]: string; }} [tags] Filter by tags
8752
+ * @param {string} [contextDepth] The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10
8710
8753
  * @param {string} [limit] The maximum number of passages to return.
8711
8754
  * @param {*} [options] Override http request option.
8712
8755
  * @throws {RequiredError}
8713
8756
  */
8714
8757
  searchFiles: (botId: string, query: string, tags?: {
8715
8758
  [key: string]: string;
8716
- } | undefined, limit?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8759
+ } | undefined, contextDepth?: string, limit?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
8717
8760
  /**
8718
8761
  * Set a preference for the account
8719
8762
  * @param {string} key Preference key
@@ -9614,13 +9657,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
9614
9657
  * @param {string} botId Bot ID
9615
9658
  * @param {string} query Query expressed in natural language to retrieve matching text passages within all files using semantical search.
9616
9659
  * @param {{ [key: string]: string; }} [tags] Filter by tags
9660
+ * @param {string} [contextDepth] The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10
9617
9661
  * @param {string} [limit] The maximum number of passages to return.
9618
9662
  * @param {*} [options] Override http request option.
9619
9663
  * @throws {RequiredError}
9620
9664
  */
9621
9665
  searchFiles(botId: string, query: string, tags?: {
9622
9666
  [key: string]: string;
9623
- } | undefined, limit?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchFilesResponse>>;
9667
+ } | undefined, contextDepth?: string, limit?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchFilesResponse>>;
9624
9668
  /**
9625
9669
  * Set a preference for the account
9626
9670
  * @param {string} key Preference key
@@ -12245,6 +12289,12 @@ export interface DefaultApiSearchFilesRequest {
12245
12289
  readonly tags?: {
12246
12290
  [key: string]: string;
12247
12291
  };
12292
+ /**
12293
+ * The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10
12294
+ * @type {string}
12295
+ * @memberof DefaultApiSearchFiles
12296
+ */
12297
+ readonly contextDepth?: string;
12248
12298
  /**
12249
12299
  * The maximum number of passages to return.
12250
12300
  * @type {string}
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.19.3
5
+ * The version of the OpenAPI document: 0.20.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.19.3
6
+ * The version of the OpenAPI document: 0.20.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.19.3
5
+ * The version of the OpenAPI document: 0.20.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -191,7 +191,14 @@ type LimitExceededType = 'LimitExceeded';
191
191
  export declare class LimitExceededError extends BaseApiError<413, LimitExceededType, 'The request exceeds the allowed limit. Limits are a hard limit that cannot be increased.'> {
192
192
  constructor(message: string, error?: Error, id?: string);
193
193
  }
194
- export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceConstraint' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded';
195
- export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceConstraintError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError | QuotaExceededError | LimitExceededError;
194
+ type BreakingChangesType = 'BreakingChanges';
195
+ /**
196
+ * Request payload contains breaking changes which is not allowed for this resource without a version increment.
197
+ */
198
+ export declare class BreakingChangesError extends BaseApiError<400, BreakingChangesType, 'Request payload contains breaking changes which is not allowed for this resource without a version increment.'> {
199
+ constructor(message: string, error?: Error, id?: string);
200
+ }
201
+ export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceConstraint' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded' | 'BreakingChanges';
202
+ export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceConstraintError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError | QuotaExceededError | LimitExceededError | BreakingChangesError;
196
203
  export declare const errorFrom: (err: unknown) => ApiError;
197
204
  export {};
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.19.3
5
+ * The version of the OpenAPI document: 0.20.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).