@botpress/client 0.5.1 → 0.5.2

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.7.1
5
+ * The version of the OpenAPI document: 0.7.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2152,6 +2152,19 @@ export interface GetStateResponse {
2152
2152
  */
2153
2153
  'state': State;
2154
2154
  }
2155
+ /**
2156
+ *
2157
+ * @export
2158
+ * @interface GetUsageResponse
2159
+ */
2160
+ export interface GetUsageResponse {
2161
+ /**
2162
+ *
2163
+ * @type {Usage}
2164
+ * @memberof GetUsageResponse
2165
+ */
2166
+ 'usage': Usage;
2167
+ }
2155
2168
  /**
2156
2169
  *
2157
2170
  * @export
@@ -2165,6 +2178,55 @@ export interface GetUserResponse {
2165
2178
  */
2166
2179
  'user': User;
2167
2180
  }
2181
+ /**
2182
+ *
2183
+ * @export
2184
+ * @interface GetWorkspaceQuotaResponse
2185
+ */
2186
+ export interface GetWorkspaceQuotaResponse {
2187
+ /**
2188
+ *
2189
+ * @type {GetWorkspaceQuotaResponseQuota}
2190
+ * @memberof GetWorkspaceQuotaResponse
2191
+ */
2192
+ 'quota': GetWorkspaceQuotaResponseQuota;
2193
+ }
2194
+ /**
2195
+ *
2196
+ * @export
2197
+ * @interface GetWorkspaceQuotaResponseQuota
2198
+ */
2199
+ export interface GetWorkspaceQuotaResponseQuota {
2200
+ /**
2201
+ * Period of the quota that it is applied to
2202
+ * @type {string}
2203
+ * @memberof GetWorkspaceQuotaResponseQuota
2204
+ */
2205
+ 'period': string;
2206
+ /**
2207
+ * Value of the quota that is used
2208
+ * @type {number}
2209
+ * @memberof GetWorkspaceQuotaResponseQuota
2210
+ */
2211
+ 'value': number;
2212
+ /**
2213
+ * Usage type that can be used
2214
+ * @type {string}
2215
+ * @memberof GetWorkspaceQuotaResponseQuota
2216
+ */
2217
+ 'type': GetWorkspaceQuotaResponseQuotaTypeEnum;
2218
+ }
2219
+ export declare const GetWorkspaceQuotaResponseQuotaTypeEnum: {
2220
+ readonly InvocationTimeout: "invocation_timeout";
2221
+ readonly InvocationCalls: "invocation_calls";
2222
+ readonly StorageCount: "storage_count";
2223
+ readonly BotCount: "bot_count";
2224
+ readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
2225
+ readonly BotRatelimit: "bot_ratelimit";
2226
+ readonly TableRowCount: "table_row_count";
2227
+ readonly WorkspaceMemberCount: "workspace_member_count";
2228
+ };
2229
+ export type GetWorkspaceQuotaResponseQuotaTypeEnum = typeof GetWorkspaceQuotaResponseQuotaTypeEnum[keyof typeof GetWorkspaceQuotaResponseQuotaTypeEnum];
2168
2230
  /**
2169
2231
  *
2170
2232
  * @export
@@ -2737,6 +2799,19 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
2737
2799
  */
2738
2800
  'iconUrl': string;
2739
2801
  }
2802
+ /**
2803
+ *
2804
+ * @export
2805
+ * @interface ListUsageHistoryResponse
2806
+ */
2807
+ export interface ListUsageHistoryResponse {
2808
+ /**
2809
+ *
2810
+ * @type {Array<Usage>}
2811
+ * @memberof ListUsageHistoryResponse
2812
+ */
2813
+ 'usages': Array<Usage>;
2814
+ }
2740
2815
  /**
2741
2816
  *
2742
2817
  * @export
@@ -2815,6 +2890,68 @@ export declare const ListWorkspaceMembersResponseMembersInnerRoleEnum: {
2815
2890
  readonly Owner: "owner";
2816
2891
  };
2817
2892
  export type ListWorkspaceMembersResponseMembersInnerRoleEnum = typeof ListWorkspaceMembersResponseMembersInnerRoleEnum[keyof typeof ListWorkspaceMembersResponseMembersInnerRoleEnum];
2893
+ /**
2894
+ *
2895
+ * @export
2896
+ * @interface ListWorkspaceQuotasResponse
2897
+ */
2898
+ export interface ListWorkspaceQuotasResponse {
2899
+ /**
2900
+ *
2901
+ * @type {Array<ListWorkspaceQuotasResponseQuotasInner>}
2902
+ * @memberof ListWorkspaceQuotasResponse
2903
+ */
2904
+ 'quotas': Array<ListWorkspaceQuotasResponseQuotasInner>;
2905
+ }
2906
+ /**
2907
+ *
2908
+ * @export
2909
+ * @interface ListWorkspaceQuotasResponseQuotasInner
2910
+ */
2911
+ export interface ListWorkspaceQuotasResponseQuotasInner {
2912
+ /**
2913
+ * Period of the quota that it is applied to
2914
+ * @type {string}
2915
+ * @memberof ListWorkspaceQuotasResponseQuotasInner
2916
+ */
2917
+ 'period': string;
2918
+ /**
2919
+ * Value of the quota that is used
2920
+ * @type {number}
2921
+ * @memberof ListWorkspaceQuotasResponseQuotasInner
2922
+ */
2923
+ 'value': number;
2924
+ /**
2925
+ * Usage type that can be used
2926
+ * @type {string}
2927
+ * @memberof ListWorkspaceQuotasResponseQuotasInner
2928
+ */
2929
+ 'type': ListWorkspaceQuotasResponseQuotasInnerTypeEnum;
2930
+ }
2931
+ export declare const ListWorkspaceQuotasResponseQuotasInnerTypeEnum: {
2932
+ readonly InvocationTimeout: "invocation_timeout";
2933
+ readonly InvocationCalls: "invocation_calls";
2934
+ readonly StorageCount: "storage_count";
2935
+ readonly BotCount: "bot_count";
2936
+ readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
2937
+ readonly BotRatelimit: "bot_ratelimit";
2938
+ readonly TableRowCount: "table_row_count";
2939
+ readonly WorkspaceMemberCount: "workspace_member_count";
2940
+ };
2941
+ export type ListWorkspaceQuotasResponseQuotasInnerTypeEnum = typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum[keyof typeof ListWorkspaceQuotasResponseQuotasInnerTypeEnum];
2942
+ /**
2943
+ *
2944
+ * @export
2945
+ * @interface ListWorkspaceUsagesResponse
2946
+ */
2947
+ export interface ListWorkspaceUsagesResponse {
2948
+ /**
2949
+ *
2950
+ * @type {Array<Usage>}
2951
+ * @memberof ListWorkspaceUsagesResponse
2952
+ */
2953
+ 'usages': Array<Usage>;
2954
+ }
2818
2955
  /**
2819
2956
  *
2820
2957
  * @export
@@ -3906,6 +4043,54 @@ export declare const UpdateWorkspaceResponse1AccountTypeEnum: {
3906
4043
  readonly Premium: "premium";
3907
4044
  };
3908
4045
  export type UpdateWorkspaceResponse1AccountTypeEnum = typeof UpdateWorkspaceResponse1AccountTypeEnum[keyof typeof UpdateWorkspaceResponse1AccountTypeEnum];
4046
+ /**
4047
+ *
4048
+ * @export
4049
+ * @interface Usage
4050
+ */
4051
+ export interface Usage {
4052
+ /**
4053
+ * Id of the usage that it is linked to. It can either be a workspace id or a bot id
4054
+ * @type {string}
4055
+ * @memberof Usage
4056
+ */
4057
+ 'id': string;
4058
+ /**
4059
+ * Period of the quota that it is applied to
4060
+ * @type {string}
4061
+ * @memberof Usage
4062
+ */
4063
+ 'period': string;
4064
+ /**
4065
+ * Value of the current usage
4066
+ * @type {number}
4067
+ * @memberof Usage
4068
+ */
4069
+ 'value': number;
4070
+ /**
4071
+ * Quota of the current usage
4072
+ * @type {number}
4073
+ * @memberof Usage
4074
+ */
4075
+ 'quota': number;
4076
+ /**
4077
+ * Usage type that can be used
4078
+ * @type {string}
4079
+ * @memberof Usage
4080
+ */
4081
+ 'type': UsageTypeEnum;
4082
+ }
4083
+ export declare const UsageTypeEnum: {
4084
+ readonly InvocationTimeout: "invocation_timeout";
4085
+ readonly InvocationCalls: "invocation_calls";
4086
+ readonly StorageCount: "storage_count";
4087
+ readonly BotCount: "bot_count";
4088
+ readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
4089
+ readonly BotRatelimit: "bot_ratelimit";
4090
+ readonly TableRowCount: "table_row_count";
4091
+ readonly WorkspaceMemberCount: "workspace_member_count";
4092
+ };
4093
+ export type UsageTypeEnum = typeof UsageTypeEnum[keyof typeof UsageTypeEnum];
3909
4094
  /**
3910
4095
  * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
3911
4096
  * @export
@@ -4358,6 +4543,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4358
4543
  * @throws {RequiredError}
4359
4544
  */
4360
4545
  getState: (type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4546
+ /**
4547
+ * Get usage
4548
+ * @param {GetUsageTypeEnum} type Type of usage
4549
+ * @param {string} id id of a bot or a workspace depending on the usage type
4550
+ * @param {string} [period] Period to get
4551
+ * @param {*} [options] Override http request option.
4552
+ * @throws {RequiredError}
4553
+ */
4554
+ getUsage: (type: GetUsageTypeEnum, id: string, period?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4361
4555
  /**
4362
4556
  * Retrieves the [User](#schema_user) object for a valid identifier.
4363
4557
  * @param {string} id User ID
@@ -4372,6 +4566,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4372
4566
  * @throws {RequiredError}
4373
4567
  */
4374
4568
  getWorkspace: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4569
+ /**
4570
+ * Get workspace quota
4571
+ * @param {string} id Workspace ID
4572
+ * @param {GetWorkspaceQuotaTypeEnum} type Type of usage
4573
+ * @param {string} [period] Period to get
4574
+ * @param {*} [options] Override http request option.
4575
+ * @throws {RequiredError}
4576
+ */
4577
+ getWorkspaceQuota: (id: string, type: GetWorkspaceQuotaTypeEnum, period?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4375
4578
  /**
4376
4579
  * Introspect the API
4377
4580
  * @param {IntrospectBody} [introspectBody]
@@ -4448,6 +4651,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4448
4651
  * @throws {RequiredError}
4449
4652
  */
4450
4653
  listPublicIntegrations: (nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4654
+ /**
4655
+ * Get usage history
4656
+ * @param {ListUsageHistoryTypeEnum} type Type of usage
4657
+ * @param {string} id id of a bot or a workspace depending on the usage type
4658
+ * @param {*} [options] Override http request option.
4659
+ * @throws {RequiredError}
4660
+ */
4661
+ listUsageHistory: (type: ListUsageHistoryTypeEnum, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4451
4662
  /**
4452
4663
  * Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
4453
4664
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -4466,6 +4677,23 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
4466
4677
  * @throws {RequiredError}
4467
4678
  */
4468
4679
  listWorkspaceMembers: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4680
+ /**
4681
+ * List workspace quotas
4682
+ * @param {string} id Workspace ID
4683
+ * @param {string} [period] Period to get
4684
+ * @param {*} [options] Override http request option.
4685
+ * @throws {RequiredError}
4686
+ */
4687
+ listWorkspaceQuotas: (id: string, period?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4688
+ /**
4689
+ * List workspace usages
4690
+ * @param {string} id Workspace ID
4691
+ * @param {ListWorkspaceUsagesTypeEnum} type Type of usage
4692
+ * @param {string} [period] Period to get
4693
+ * @param {*} [options] Override http request option.
4694
+ * @throws {RequiredError}
4695
+ */
4696
+ listWorkspaceUsages: (id: string, type: ListWorkspaceUsagesTypeEnum, period?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4469
4697
  /**
4470
4698
  * List workspaces the user has access to
4471
4699
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -4871,6 +5099,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
4871
5099
  * @throws {RequiredError}
4872
5100
  */
4873
5101
  getState(type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStateResponse>>;
5102
+ /**
5103
+ * Get usage
5104
+ * @param {GetUsageTypeEnum} type Type of usage
5105
+ * @param {string} id id of a bot or a workspace depending on the usage type
5106
+ * @param {string} [period] Period to get
5107
+ * @param {*} [options] Override http request option.
5108
+ * @throws {RequiredError}
5109
+ */
5110
+ getUsage(type: GetUsageTypeEnum, id: string, period?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUsageResponse>>;
4874
5111
  /**
4875
5112
  * Retrieves the [User](#schema_user) object for a valid identifier.
4876
5113
  * @param {string} id User ID
@@ -4885,6 +5122,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
4885
5122
  * @throws {RequiredError}
4886
5123
  */
4887
5124
  getWorkspace(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceResponse>>;
5125
+ /**
5126
+ * Get workspace quota
5127
+ * @param {string} id Workspace ID
5128
+ * @param {GetWorkspaceQuotaTypeEnum} type Type of usage
5129
+ * @param {string} [period] Period to get
5130
+ * @param {*} [options] Override http request option.
5131
+ * @throws {RequiredError}
5132
+ */
5133
+ getWorkspaceQuota(id: string, type: GetWorkspaceQuotaTypeEnum, period?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceQuotaResponse>>;
4888
5134
  /**
4889
5135
  * Introspect the API
4890
5136
  * @param {IntrospectBody} [introspectBody]
@@ -4961,6 +5207,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
4961
5207
  * @throws {RequiredError}
4962
5208
  */
4963
5209
  listPublicIntegrations(nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPublicIntegrationsResponse>>;
5210
+ /**
5211
+ * Get usage history
5212
+ * @param {ListUsageHistoryTypeEnum} type Type of usage
5213
+ * @param {string} id id of a bot or a workspace depending on the usage type
5214
+ * @param {*} [options] Override http request option.
5215
+ * @throws {RequiredError}
5216
+ */
5217
+ listUsageHistory(type: ListUsageHistoryTypeEnum, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsageHistoryResponse>>;
4964
5218
  /**
4965
5219
  * Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
4966
5220
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -4979,6 +5233,23 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
4979
5233
  * @throws {RequiredError}
4980
5234
  */
4981
5235
  listWorkspaceMembers(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspaceMembersResponse>>;
5236
+ /**
5237
+ * List workspace quotas
5238
+ * @param {string} id Workspace ID
5239
+ * @param {string} [period] Period to get
5240
+ * @param {*} [options] Override http request option.
5241
+ * @throws {RequiredError}
5242
+ */
5243
+ listWorkspaceQuotas(id: string, period?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspaceQuotasResponse>>;
5244
+ /**
5245
+ * List workspace usages
5246
+ * @param {string} id Workspace ID
5247
+ * @param {ListWorkspaceUsagesTypeEnum} type Type of usage
5248
+ * @param {string} [period] Period to get
5249
+ * @param {*} [options] Override http request option.
5250
+ * @throws {RequiredError}
5251
+ */
5252
+ listWorkspaceUsages(id: string, type: ListWorkspaceUsagesTypeEnum, period?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkspaceUsagesResponse>>;
4982
5253
  /**
4983
5254
  * List workspaces the user has access to
4984
5255
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
@@ -5369,6 +5640,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
5369
5640
  * @throws {RequiredError}
5370
5641
  */
5371
5642
  getState(requestParameters: DefaultApiGetStateRequest, options?: AxiosRequestConfig): AxiosPromise<GetStateResponse>;
5643
+ /**
5644
+ * Get usage
5645
+ * @param {DefaultApiGetUsageRequest} requestParameters Request parameters.
5646
+ * @param {*} [options] Override http request option.
5647
+ * @throws {RequiredError}
5648
+ */
5649
+ getUsage(requestParameters: DefaultApiGetUsageRequest, options?: AxiosRequestConfig): AxiosPromise<GetUsageResponse>;
5372
5650
  /**
5373
5651
  * Retrieves the [User](#schema_user) object for a valid identifier.
5374
5652
  * @param {DefaultApiGetUserRequest} requestParameters Request parameters.
@@ -5383,6 +5661,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
5383
5661
  * @throws {RequiredError}
5384
5662
  */
5385
5663
  getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
5664
+ /**
5665
+ * Get workspace quota
5666
+ * @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
5667
+ * @param {*} [options] Override http request option.
5668
+ * @throws {RequiredError}
5669
+ */
5670
+ getWorkspaceQuota(requestParameters: DefaultApiGetWorkspaceQuotaRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceQuotaResponse>;
5386
5671
  /**
5387
5672
  * Introspect the API
5388
5673
  * @param {DefaultApiIntrospectRequest} requestParameters Request parameters.
@@ -5445,6 +5730,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
5445
5730
  * @throws {RequiredError}
5446
5731
  */
5447
5732
  listPublicIntegrations(requestParameters?: DefaultApiListPublicIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListPublicIntegrationsResponse>;
5733
+ /**
5734
+ * Get usage history
5735
+ * @param {DefaultApiListUsageHistoryRequest} requestParameters Request parameters.
5736
+ * @param {*} [options] Override http request option.
5737
+ * @throws {RequiredError}
5738
+ */
5739
+ listUsageHistory(requestParameters: DefaultApiListUsageHistoryRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsageHistoryResponse>;
5448
5740
  /**
5449
5741
  * Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
5450
5742
  * @param {DefaultApiListUsersRequest} requestParameters Request parameters.
@@ -5459,6 +5751,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
5459
5751
  * @throws {RequiredError}
5460
5752
  */
5461
5753
  listWorkspaceMembers(requestParameters?: DefaultApiListWorkspaceMembersRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspaceMembersResponse>;
5754
+ /**
5755
+ * List workspace quotas
5756
+ * @param {DefaultApiListWorkspaceQuotasRequest} requestParameters Request parameters.
5757
+ * @param {*} [options] Override http request option.
5758
+ * @throws {RequiredError}
5759
+ */
5760
+ listWorkspaceQuotas(requestParameters: DefaultApiListWorkspaceQuotasRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspaceQuotasResponse>;
5761
+ /**
5762
+ * List workspace usages
5763
+ * @param {DefaultApiListWorkspaceUsagesRequest} requestParameters Request parameters.
5764
+ * @param {*} [options] Override http request option.
5765
+ * @throws {RequiredError}
5766
+ */
5767
+ listWorkspaceUsages(requestParameters: DefaultApiListWorkspaceUsagesRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspaceUsagesResponse>;
5462
5768
  /**
5463
5769
  * List workspaces the user has access to
5464
5770
  * @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
@@ -6160,6 +6466,31 @@ export interface DefaultApiGetStateRequest {
6160
6466
  */
6161
6467
  readonly name: string;
6162
6468
  }
6469
+ /**
6470
+ * Request parameters for getUsage operation in DefaultApi.
6471
+ * @export
6472
+ * @interface DefaultApiGetUsageRequest
6473
+ */
6474
+ export interface DefaultApiGetUsageRequest {
6475
+ /**
6476
+ * Type of usage
6477
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count'}
6478
+ * @memberof DefaultApiGetUsage
6479
+ */
6480
+ readonly type: GetUsageTypeEnum;
6481
+ /**
6482
+ * id of a bot or a workspace depending on the usage type
6483
+ * @type {string}
6484
+ * @memberof DefaultApiGetUsage
6485
+ */
6486
+ readonly id: string;
6487
+ /**
6488
+ * Period to get
6489
+ * @type {string}
6490
+ * @memberof DefaultApiGetUsage
6491
+ */
6492
+ readonly period?: string;
6493
+ }
6163
6494
  /**
6164
6495
  * Request parameters for getUser operation in DefaultApi.
6165
6496
  * @export
@@ -6186,6 +6517,31 @@ export interface DefaultApiGetWorkspaceRequest {
6186
6517
  */
6187
6518
  readonly id: string;
6188
6519
  }
6520
+ /**
6521
+ * Request parameters for getWorkspaceQuota operation in DefaultApi.
6522
+ * @export
6523
+ * @interface DefaultApiGetWorkspaceQuotaRequest
6524
+ */
6525
+ export interface DefaultApiGetWorkspaceQuotaRequest {
6526
+ /**
6527
+ * Workspace ID
6528
+ * @type {string}
6529
+ * @memberof DefaultApiGetWorkspaceQuota
6530
+ */
6531
+ readonly id: string;
6532
+ /**
6533
+ * Type of usage
6534
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count'}
6535
+ * @memberof DefaultApiGetWorkspaceQuota
6536
+ */
6537
+ readonly type: GetWorkspaceQuotaTypeEnum;
6538
+ /**
6539
+ * Period to get
6540
+ * @type {string}
6541
+ * @memberof DefaultApiGetWorkspaceQuota
6542
+ */
6543
+ readonly period?: string;
6544
+ }
6189
6545
  /**
6190
6546
  * Request parameters for introspect operation in DefaultApi.
6191
6547
  * @export
@@ -6354,6 +6710,25 @@ export interface DefaultApiListPublicIntegrationsRequest {
6354
6710
  */
6355
6711
  readonly version?: string;
6356
6712
  }
6713
+ /**
6714
+ * Request parameters for listUsageHistory operation in DefaultApi.
6715
+ * @export
6716
+ * @interface DefaultApiListUsageHistoryRequest
6717
+ */
6718
+ export interface DefaultApiListUsageHistoryRequest {
6719
+ /**
6720
+ * Type of usage
6721
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count'}
6722
+ * @memberof DefaultApiListUsageHistory
6723
+ */
6724
+ readonly type: ListUsageHistoryTypeEnum;
6725
+ /**
6726
+ * id of a bot or a workspace depending on the usage type
6727
+ * @type {string}
6728
+ * @memberof DefaultApiListUsageHistory
6729
+ */
6730
+ readonly id: string;
6731
+ }
6357
6732
  /**
6358
6733
  * Request parameters for listUsers operation in DefaultApi.
6359
6734
  * @export
@@ -6394,6 +6769,50 @@ export interface DefaultApiListWorkspaceMembersRequest {
6394
6769
  */
6395
6770
  readonly nextToken?: string;
6396
6771
  }
6772
+ /**
6773
+ * Request parameters for listWorkspaceQuotas operation in DefaultApi.
6774
+ * @export
6775
+ * @interface DefaultApiListWorkspaceQuotasRequest
6776
+ */
6777
+ export interface DefaultApiListWorkspaceQuotasRequest {
6778
+ /**
6779
+ * Workspace ID
6780
+ * @type {string}
6781
+ * @memberof DefaultApiListWorkspaceQuotas
6782
+ */
6783
+ readonly id: string;
6784
+ /**
6785
+ * Period to get
6786
+ * @type {string}
6787
+ * @memberof DefaultApiListWorkspaceQuotas
6788
+ */
6789
+ readonly period?: string;
6790
+ }
6791
+ /**
6792
+ * Request parameters for listWorkspaceUsages operation in DefaultApi.
6793
+ * @export
6794
+ * @interface DefaultApiListWorkspaceUsagesRequest
6795
+ */
6796
+ export interface DefaultApiListWorkspaceUsagesRequest {
6797
+ /**
6798
+ * Workspace ID
6799
+ * @type {string}
6800
+ * @memberof DefaultApiListWorkspaceUsages
6801
+ */
6802
+ readonly id: string;
6803
+ /**
6804
+ * Type of usage
6805
+ * @type {'invocation_timeout' | 'invocation_calls' | 'storage_count' | 'bot_count' | 'knowledgebase_vector_count' | 'bot_ratelimit' | 'table_row_count' | 'workspace_member_count'}
6806
+ * @memberof DefaultApiListWorkspaceUsages
6807
+ */
6808
+ readonly type: ListWorkspaceUsagesTypeEnum;
6809
+ /**
6810
+ * Period to get
6811
+ * @type {string}
6812
+ * @memberof DefaultApiListWorkspaceUsages
6813
+ */
6814
+ readonly period?: string;
6815
+ }
6397
6816
  /**
6398
6817
  * Request parameters for listWorkspaces operation in DefaultApi.
6399
6818
  * @export
@@ -6963,6 +7382,14 @@ export declare class DefaultApi extends BaseAPI {
6963
7382
  * @memberof DefaultApi
6964
7383
  */
6965
7384
  getState(requestParameters: DefaultApiGetStateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStateResponse, any>>;
7385
+ /**
7386
+ * Get usage
7387
+ * @param {DefaultApiGetUsageRequest} requestParameters Request parameters.
7388
+ * @param {*} [options] Override http request option.
7389
+ * @throws {RequiredError}
7390
+ * @memberof DefaultApi
7391
+ */
7392
+ getUsage(requestParameters: DefaultApiGetUsageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUsageResponse, any>>;
6966
7393
  /**
6967
7394
  * Retrieves the [User](#schema_user) object for a valid identifier.
6968
7395
  * @param {DefaultApiGetUserRequest} requestParameters Request parameters.
@@ -6979,6 +7406,14 @@ export declare class DefaultApi extends BaseAPI {
6979
7406
  * @memberof DefaultApi
6980
7407
  */
6981
7408
  getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceResponse, any>>;
7409
+ /**
7410
+ * Get workspace quota
7411
+ * @param {DefaultApiGetWorkspaceQuotaRequest} requestParameters Request parameters.
7412
+ * @param {*} [options] Override http request option.
7413
+ * @throws {RequiredError}
7414
+ * @memberof DefaultApi
7415
+ */
7416
+ getWorkspaceQuota(requestParameters: DefaultApiGetWorkspaceQuotaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceQuotaResponse, any>>;
6982
7417
  /**
6983
7418
  * Introspect the API
6984
7419
  * @param {DefaultApiIntrospectRequest} requestParameters Request parameters.
@@ -7050,6 +7485,14 @@ export declare class DefaultApi extends BaseAPI {
7050
7485
  * @memberof DefaultApi
7051
7486
  */
7052
7487
  listPublicIntegrations(requestParameters?: DefaultApiListPublicIntegrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPublicIntegrationsResponse, any>>;
7488
+ /**
7489
+ * Get usage history
7490
+ * @param {DefaultApiListUsageHistoryRequest} requestParameters Request parameters.
7491
+ * @param {*} [options] Override http request option.
7492
+ * @throws {RequiredError}
7493
+ * @memberof DefaultApi
7494
+ */
7495
+ listUsageHistory(requestParameters: DefaultApiListUsageHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListUsageHistoryResponse, any>>;
7053
7496
  /**
7054
7497
  * Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
7055
7498
  * @param {DefaultApiListUsersRequest} requestParameters Request parameters.
@@ -7066,6 +7509,22 @@ export declare class DefaultApi extends BaseAPI {
7066
7509
  * @memberof DefaultApi
7067
7510
  */
7068
7511
  listWorkspaceMembers(requestParameters?: DefaultApiListWorkspaceMembersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkspaceMembersResponse, any>>;
7512
+ /**
7513
+ * List workspace quotas
7514
+ * @param {DefaultApiListWorkspaceQuotasRequest} requestParameters Request parameters.
7515
+ * @param {*} [options] Override http request option.
7516
+ * @throws {RequiredError}
7517
+ * @memberof DefaultApi
7518
+ */
7519
+ listWorkspaceQuotas(requestParameters: DefaultApiListWorkspaceQuotasRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkspaceQuotasResponse, any>>;
7520
+ /**
7521
+ * List workspace usages
7522
+ * @param {DefaultApiListWorkspaceUsagesRequest} requestParameters Request parameters.
7523
+ * @param {*} [options] Override http request option.
7524
+ * @throws {RequiredError}
7525
+ * @memberof DefaultApi
7526
+ */
7527
+ listWorkspaceUsages(requestParameters: DefaultApiListWorkspaceUsagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkspaceUsagesResponse, any>>;
7069
7528
  /**
7070
7529
  * List workspaces the user has access to
7071
7530
  * @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
@@ -7175,6 +7634,62 @@ export declare const GetStateTypeEnum: {
7175
7634
  readonly Integration: "integration";
7176
7635
  };
7177
7636
  export type GetStateTypeEnum = typeof GetStateTypeEnum[keyof typeof GetStateTypeEnum];
7637
+ /**
7638
+ * @export
7639
+ */
7640
+ export declare const GetUsageTypeEnum: {
7641
+ readonly InvocationTimeout: "invocation_timeout";
7642
+ readonly InvocationCalls: "invocation_calls";
7643
+ readonly StorageCount: "storage_count";
7644
+ readonly BotCount: "bot_count";
7645
+ readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
7646
+ readonly BotRatelimit: "bot_ratelimit";
7647
+ readonly TableRowCount: "table_row_count";
7648
+ readonly WorkspaceMemberCount: "workspace_member_count";
7649
+ };
7650
+ export type GetUsageTypeEnum = typeof GetUsageTypeEnum[keyof typeof GetUsageTypeEnum];
7651
+ /**
7652
+ * @export
7653
+ */
7654
+ export declare const GetWorkspaceQuotaTypeEnum: {
7655
+ readonly InvocationTimeout: "invocation_timeout";
7656
+ readonly InvocationCalls: "invocation_calls";
7657
+ readonly StorageCount: "storage_count";
7658
+ readonly BotCount: "bot_count";
7659
+ readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
7660
+ readonly BotRatelimit: "bot_ratelimit";
7661
+ readonly TableRowCount: "table_row_count";
7662
+ readonly WorkspaceMemberCount: "workspace_member_count";
7663
+ };
7664
+ export type GetWorkspaceQuotaTypeEnum = typeof GetWorkspaceQuotaTypeEnum[keyof typeof GetWorkspaceQuotaTypeEnum];
7665
+ /**
7666
+ * @export
7667
+ */
7668
+ export declare const ListUsageHistoryTypeEnum: {
7669
+ readonly InvocationTimeout: "invocation_timeout";
7670
+ readonly InvocationCalls: "invocation_calls";
7671
+ readonly StorageCount: "storage_count";
7672
+ readonly BotCount: "bot_count";
7673
+ readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
7674
+ readonly BotRatelimit: "bot_ratelimit";
7675
+ readonly TableRowCount: "table_row_count";
7676
+ readonly WorkspaceMemberCount: "workspace_member_count";
7677
+ };
7678
+ export type ListUsageHistoryTypeEnum = typeof ListUsageHistoryTypeEnum[keyof typeof ListUsageHistoryTypeEnum];
7679
+ /**
7680
+ * @export
7681
+ */
7682
+ export declare const ListWorkspaceUsagesTypeEnum: {
7683
+ readonly InvocationTimeout: "invocation_timeout";
7684
+ readonly InvocationCalls: "invocation_calls";
7685
+ readonly StorageCount: "storage_count";
7686
+ readonly BotCount: "bot_count";
7687
+ readonly KnowledgebaseVectorCount: "knowledgebase_vector_count";
7688
+ readonly BotRatelimit: "bot_ratelimit";
7689
+ readonly TableRowCount: "table_row_count";
7690
+ readonly WorkspaceMemberCount: "workspace_member_count";
7691
+ };
7692
+ export type ListWorkspaceUsagesTypeEnum = typeof ListWorkspaceUsagesTypeEnum[keyof typeof ListWorkspaceUsagesTypeEnum];
7178
7693
  /**
7179
7694
  * @export
7180
7695
  */