@botpress/client 0.9.4 → 0.9.5

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.15.6
5
+ * The version of the OpenAPI document: 0.15.7
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -174,18 +174,6 @@ export interface Bot {
174
174
  * @memberof Bot
175
175
  */
176
176
  'createdBy'?: string;
177
- /**
178
- * Indicates if the [Bot](#schema_bot) should be executed in accelerated mode
179
- * @type {boolean}
180
- * @memberof Bot
181
- */
182
- 'alwaysAlive': boolean;
183
- /**
184
- * Status of the bot
185
- * @type {string}
186
- * @memberof Bot
187
- */
188
- 'status': BotStatusEnum;
189
177
  /**
190
178
  * Media files associated with the [Bot](#schema_bot)
191
179
  * @type {Array<BotMediasInner>}
@@ -193,11 +181,6 @@ export interface Bot {
193
181
  */
194
182
  'medias': Array<BotMediasInner>;
195
183
  }
196
- export declare const BotStatusEnum: {
197
- readonly Active: "active";
198
- readonly Deploying: "deploying";
199
- };
200
- export type BotStatusEnum = typeof BotStatusEnum[keyof typeof BotStatusEnum];
201
184
  /**
202
185
  * Configuration of the bot
203
186
  * @export
@@ -2028,6 +2011,40 @@ export interface GetAccountResponseAccount {
2028
2011
  */
2029
2012
  'createdAt': string;
2030
2013
  }
2014
+ /**
2015
+ *
2016
+ * @export
2017
+ * @interface GetAllWorkspaceQuotaCompletionResponse
2018
+ */
2019
+ export interface GetAllWorkspaceQuotaCompletionResponse {
2020
+ /**
2021
+ *
2022
+ * @type {string}
2023
+ * @memberof GetAllWorkspaceQuotaCompletionResponse
2024
+ */
2025
+ 'type': GetAllWorkspaceQuotaCompletionResponseTypeEnum;
2026
+ /**
2027
+ *
2028
+ * @type {number}
2029
+ * @memberof GetAllWorkspaceQuotaCompletionResponse
2030
+ */
2031
+ 'completion': number;
2032
+ }
2033
+ export declare const GetAllWorkspaceQuotaCompletionResponseTypeEnum: {
2034
+ readonly InvocationTimeout: "invocation_timeout";
2035
+ readonly InvocationCalls: "invocation_calls";
2036
+ readonly StorageCount: "storage_count";
2037
+ readonly BotCount: "bot_count";
2038
+ readonly KnowledgebaseVectorStorage: "knowledgebase_vector_storage";
2039
+ readonly WorkspaceRatelimit: "workspace_ratelimit";
2040
+ readonly TableRowCount: "table_row_count";
2041
+ readonly WorkspaceMemberCount: "workspace_member_count";
2042
+ readonly IntegrationsOwnedCount: "integrations_owned_count";
2043
+ readonly AiSpend: "ai_spend";
2044
+ readonly OpenaiSpend: "openai_spend";
2045
+ readonly BingSearchSpend: "bing_search_spend";
2046
+ };
2047
+ export type GetAllWorkspaceQuotaCompletionResponseTypeEnum = typeof GetAllWorkspaceQuotaCompletionResponseTypeEnum[keyof typeof GetAllWorkspaceQuotaCompletionResponseTypeEnum];
2031
2048
  /**
2032
2049
  *
2033
2050
  * @export
@@ -2763,7 +2780,6 @@ export declare const GetWorkspaceQuotaResponseQuotaTypeEnum: {
2763
2780
  readonly AiSpend: "ai_spend";
2764
2781
  readonly OpenaiSpend: "openai_spend";
2765
2782
  readonly BingSearchSpend: "bing_search_spend";
2766
- readonly AlwaysAlive: "always_alive";
2767
2783
  };
2768
2784
  export type GetWorkspaceQuotaResponseQuotaTypeEnum = typeof GetWorkspaceQuotaResponseQuotaTypeEnum[keyof typeof GetWorkspaceQuotaResponseQuotaTypeEnum];
2769
2785
  /**
@@ -3961,7 +3977,6 @@ export declare const ListWorkspaceQuotasResponseQuotasInnerTypeEnum: {
3961
3977
  readonly AiSpend: "ai_spend";
3962
3978
  readonly OpenaiSpend: "openai_spend";
3963
3979
  readonly BingSearchSpend: "bing_search_spend";
3964
- readonly AlwaysAlive: "always_alive";
3965
3980
  };
3966
3981
  export type ListWorkspaceQuotasResponseQuotasInnerTypeEnum = typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum[keyof typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum];
3967
3982
  /**
@@ -4423,12 +4438,6 @@ export interface UpdateBotBody {
4423
4438
  * @memberof UpdateBotBody
4424
4439
  */
4425
4440
  'medias'?: Array<CreateBotBodyMediasInner>;
4426
- /**
4427
- * Indicates if the [Bot](#schema_bot) should be executed in accelerated mode
4428
- * @type {boolean}
4429
- * @memberof UpdateBotBody
4430
- */
4431
- 'alwaysAlive'?: boolean;
4432
4441
  }
4433
4442
  export declare const UpdateBotBodyAuthenticationEnum: {
4434
4443
  readonly Iam: "iam";
@@ -5313,7 +5322,6 @@ export declare const UsageTypeEnum: {
5313
5322
  readonly AiSpend: "ai_spend";
5314
5323
  readonly OpenaiSpend: "openai_spend";
5315
5324
  readonly BingSearchSpend: "bing_search_spend";
5316
- readonly AlwaysAlive: "always_alive";
5317
5325
  };
5318
5326
  export type UsageTypeEnum = typeof UsageTypeEnum[keyof typeof UsageTypeEnum];
5319
5327
  /**
@@ -5703,6 +5711,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
5703
5711
  * @throws {RequiredError}
5704
5712
  */
5705
5713
  getAccount: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
5714
+ /**
5715
+ * For a user, gets a map of workspace IDs to their highest quota completion rate
5716
+ * @param {*} [options] Override http request option.
5717
+ * @throws {RequiredError}
5718
+ */
5719
+ getAllWorkspaceQuotaCompletion: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
5706
5720
  /**
5707
5721
  * Get the audit records of a workspace, sorted from most recent to oldest.
5708
5722
  * @param {string} id Workspace ID
@@ -6366,6 +6380,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
6366
6380
  * @throws {RequiredError}
6367
6381
  */
6368
6382
  getAccount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponse>>;
6383
+ /**
6384
+ * For a user, gets a map of workspace IDs to their highest quota completion rate
6385
+ * @param {*} [options] Override http request option.
6386
+ * @throws {RequiredError}
6387
+ */
6388
+ getAllWorkspaceQuotaCompletion(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
6389
+ [key: string]: GetAllWorkspaceQuotaCompletionResponse;
6390
+ }>>;
6369
6391
  /**
6370
6392
  * Get the audit records of a workspace, sorted from most recent to oldest.
6371
6393
  * @param {string} id Workspace ID
@@ -7023,6 +7045,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
7023
7045
  * @throws {RequiredError}
7024
7046
  */
7025
7047
  getAccount(options?: AxiosRequestConfig): AxiosPromise<GetAccountResponse>;
7048
+ /**
7049
+ * For a user, gets a map of workspace IDs to their highest quota completion rate
7050
+ * @param {*} [options] Override http request option.
7051
+ * @throws {RequiredError}
7052
+ */
7053
+ getAllWorkspaceQuotaCompletion(options?: AxiosRequestConfig): AxiosPromise<{
7054
+ [key: string]: GetAllWorkspaceQuotaCompletionResponse;
7055
+ }>;
7026
7056
  /**
7027
7057
  * Get the audit records of a workspace, sorted from most recent to oldest.
7028
7058
  * @param {DefaultApiGetAuditRecordsRequest} requestParameters Request parameters.
@@ -7441,7 +7471,7 @@ export interface DefaultApiBreakDownWorkspaceUsageByBotRequest {
7441
7471
  readonly id: string;
7442
7472
  /**
7443
7473
  * Type of usage
7444
- * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend' | 'always_alive'}
7474
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend'}
7445
7475
  * @memberof DefaultApiBreakDownWorkspaceUsageByBot
7446
7476
  */
7447
7477
  readonly type: BreakDownWorkspaceUsageByBotTypeEnum;
@@ -8153,7 +8183,7 @@ export interface DefaultApiGetStateRequest {
8153
8183
  export interface DefaultApiGetUsageRequest {
8154
8184
  /**
8155
8185
  * Type of usage
8156
- * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend' | 'always_alive'}
8186
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend'}
8157
8187
  * @memberof DefaultApiGetUsage
8158
8188
  */
8159
8189
  readonly type: GetUsageTypeEnum;
@@ -8223,7 +8253,7 @@ export interface DefaultApiGetWorkspaceQuotaRequest {
8223
8253
  readonly id: string;
8224
8254
  /**
8225
8255
  * Type of usage
8226
- * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend' | 'always_alive'}
8256
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend'}
8227
8257
  * @memberof DefaultApiGetWorkspaceQuota
8228
8258
  */
8229
8259
  readonly type: GetWorkspaceQuotaTypeEnum;
@@ -8497,7 +8527,7 @@ export interface DefaultApiListPublicIntegrationsRequest {
8497
8527
  export interface DefaultApiListUsageHistoryRequest {
8498
8528
  /**
8499
8529
  * Type of usage
8500
- * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend' | 'always_alive'}
8530
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend'}
8501
8531
  * @memberof DefaultApiListUsageHistory
8502
8532
  */
8503
8533
  readonly type: ListUsageHistoryTypeEnum;
@@ -8594,7 +8624,7 @@ export interface DefaultApiListWorkspaceUsagesRequest {
8594
8624
  readonly id: string;
8595
8625
  /**
8596
8626
  * Type of usage
8597
- * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend' | 'always_alive'}
8627
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_storage' | 'workspace_ratelimit' | 'table_row_count' | 'workspace_member_count' | 'integrations_owned_count' | 'ai_spend' | 'openai_spend' | 'bing_search_spend'}
8598
8628
  * @memberof DefaultApiListWorkspaceUsages
8599
8629
  */
8600
8630
  readonly type: ListWorkspaceUsagesTypeEnum;
@@ -9108,6 +9138,15 @@ export declare class DefaultApi extends BaseAPI {
9108
9138
  * @memberof DefaultApi
9109
9139
  */
9110
9140
  getAccount(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountResponse, any>>;
9141
+ /**
9142
+ * For a user, gets a map of workspace IDs to their highest quota completion rate
9143
+ * @param {*} [options] Override http request option.
9144
+ * @throws {RequiredError}
9145
+ * @memberof DefaultApi
9146
+ */
9147
+ getAllWorkspaceQuotaCompletion(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<{
9148
+ [key: string]: GetAllWorkspaceQuotaCompletionResponse;
9149
+ }, any>>;
9111
9150
  /**
9112
9151
  * Get the audit records of a workspace, sorted from most recent to oldest.
9113
9152
  * @param {DefaultApiGetAuditRecordsRequest} requestParameters Request parameters.
@@ -9564,7 +9603,6 @@ export declare const BreakDownWorkspaceUsageByBotTypeEnum: {
9564
9603
  readonly AiSpend: "ai_spend";
9565
9604
  readonly OpenaiSpend: "openai_spend";
9566
9605
  readonly BingSearchSpend: "bing_search_spend";
9567
- readonly AlwaysAlive: "always_alive";
9568
9606
  };
9569
9607
  export type BreakDownWorkspaceUsageByBotTypeEnum = typeof BreakDownWorkspaceUsageByBotTypeEnum[keyof typeof BreakDownWorkspaceUsageByBotTypeEnum];
9570
9608
  /**
@@ -9603,7 +9641,6 @@ export declare const GetUsageTypeEnum: {
9603
9641
  readonly AiSpend: "ai_spend";
9604
9642
  readonly OpenaiSpend: "openai_spend";
9605
9643
  readonly BingSearchSpend: "bing_search_spend";
9606
- readonly AlwaysAlive: "always_alive";
9607
9644
  };
9608
9645
  export type GetUsageTypeEnum = typeof GetUsageTypeEnum[keyof typeof GetUsageTypeEnum];
9609
9646
  /**
@@ -9622,7 +9659,6 @@ export declare const GetWorkspaceQuotaTypeEnum: {
9622
9659
  readonly AiSpend: "ai_spend";
9623
9660
  readonly OpenaiSpend: "openai_spend";
9624
9661
  readonly BingSearchSpend: "bing_search_spend";
9625
- readonly AlwaysAlive: "always_alive";
9626
9662
  };
9627
9663
  export type GetWorkspaceQuotaTypeEnum = typeof GetWorkspaceQuotaTypeEnum[keyof typeof GetWorkspaceQuotaTypeEnum];
9628
9664
  /**
@@ -9641,7 +9677,6 @@ export declare const ListUsageHistoryTypeEnum: {
9641
9677
  readonly AiSpend: "ai_spend";
9642
9678
  readonly OpenaiSpend: "openai_spend";
9643
9679
  readonly BingSearchSpend: "bing_search_spend";
9644
- readonly AlwaysAlive: "always_alive";
9645
9680
  };
9646
9681
  export type ListUsageHistoryTypeEnum = typeof ListUsageHistoryTypeEnum[keyof typeof ListUsageHistoryTypeEnum];
9647
9682
  /**
@@ -9660,7 +9695,6 @@ export declare const ListWorkspaceUsagesTypeEnum: {
9660
9695
  readonly AiSpend: "ai_spend";
9661
9696
  readonly OpenaiSpend: "openai_spend";
9662
9697
  readonly BingSearchSpend: "bing_search_spend";
9663
- readonly AlwaysAlive: "always_alive";
9664
9698
  };
9665
9699
  export type ListWorkspaceUsagesTypeEnum = typeof ListWorkspaceUsagesTypeEnum[keyof typeof ListWorkspaceUsagesTypeEnum];
9666
9700
  /**
@@ -2,7 +2,7 @@
2
2
  * Botpress API
3
3
  * API for Botpress Cloud
4
4
  *
5
- * The version of the OpenAPI document: 0.15.6
5
+ * The version of the OpenAPI document: 0.15.7
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -61,6 +61,9 @@ export declare class ApiClient {
61
61
  getWorkspace: (props: GetWorkspaceProps) => Promise<import("./api").GetWorkspaceResponse>;
62
62
  listWorkspaceUsages: (props: ListWorkspaceUsagesProps) => Promise<import("./api").ListWorkspaceUsagesResponse>;
63
63
  breakDownWorkspaceUsageByBot: (props: BreakDownWorkspaceUsageByBotProps) => Promise<import("./api").BreakDownWorkspaceUsageByBotResponse>;
64
+ getAllWorkspaceQuotaCompletion: () => Promise<{
65
+ [key: string]: import("./api").GetAllWorkspaceQuotaCompletionResponse;
66
+ }>;
64
67
  getWorkspaceQuota: (props: GetWorkspaceQuotaProps) => Promise<import("./api").GetWorkspaceQuotaResponse>;
65
68
  listWorkspaceQuotas: (props: ListWorkspaceQuotasProps) => Promise<import("./api").ListWorkspaceQuotasResponse>;
66
69
  updateWorkspace: ({ id, ...updateWorkspaceBody }: UpdateWorkspaceProps) => Promise<import("./api").UpdateWorkspaceResponse1>;
@@ -3,7 +3,7 @@
3
3
  * Botpress API
4
4
  * API for Botpress Cloud
5
5
  *
6
- * The version of the OpenAPI document: 0.15.6
6
+ * The version of the OpenAPI document: 0.15.7
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.15.6
5
+ * The version of the OpenAPI document: 0.15.7
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.15.6
5
+ * The version of the OpenAPI document: 0.15.7
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).