@botpress/client 0.5.0 → 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/bundle.cjs +7 -7
- package/dist/bundle.cjs.map +3 -3
- package/dist/gen/api.d.ts +720 -1
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +16 -1
- package/dist/gen/common.d.ts +1 -1
- package/dist/gen/configuration.d.ts +1 -1
- package/dist/gen/errors.d.ts +16 -2
- package/dist/gen/index.d.ts +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +3 -3
- package/dist/index.mjs +1 -1
- package/package.json +2 -2
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.
|
|
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).
|
|
@@ -1357,6 +1357,63 @@ export interface CreateMessageResponse {
|
|
|
1357
1357
|
*/
|
|
1358
1358
|
'message': Message;
|
|
1359
1359
|
}
|
|
1360
|
+
/**
|
|
1361
|
+
*
|
|
1362
|
+
* @export
|
|
1363
|
+
* @interface CreatePersonalAccessTokenBody
|
|
1364
|
+
*/
|
|
1365
|
+
export interface CreatePersonalAccessTokenBody {
|
|
1366
|
+
/**
|
|
1367
|
+
* Note to identify the PAT
|
|
1368
|
+
* @type {string}
|
|
1369
|
+
* @memberof CreatePersonalAccessTokenBody
|
|
1370
|
+
*/
|
|
1371
|
+
'note': string;
|
|
1372
|
+
}
|
|
1373
|
+
/**
|
|
1374
|
+
*
|
|
1375
|
+
* @export
|
|
1376
|
+
* @interface CreatePersonalAccessTokenResponse
|
|
1377
|
+
*/
|
|
1378
|
+
export interface CreatePersonalAccessTokenResponse {
|
|
1379
|
+
/**
|
|
1380
|
+
*
|
|
1381
|
+
* @type {CreatePersonalAccessTokenResponsePat}
|
|
1382
|
+
* @memberof CreatePersonalAccessTokenResponse
|
|
1383
|
+
*/
|
|
1384
|
+
'pat': CreatePersonalAccessTokenResponsePat;
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
*
|
|
1388
|
+
* @export
|
|
1389
|
+
* @interface CreatePersonalAccessTokenResponsePat
|
|
1390
|
+
*/
|
|
1391
|
+
export interface CreatePersonalAccessTokenResponsePat {
|
|
1392
|
+
/**
|
|
1393
|
+
*
|
|
1394
|
+
* @type {string}
|
|
1395
|
+
* @memberof CreatePersonalAccessTokenResponsePat
|
|
1396
|
+
*/
|
|
1397
|
+
'id': string;
|
|
1398
|
+
/**
|
|
1399
|
+
*
|
|
1400
|
+
* @type {string}
|
|
1401
|
+
* @memberof CreatePersonalAccessTokenResponsePat
|
|
1402
|
+
*/
|
|
1403
|
+
'createdAt': string;
|
|
1404
|
+
/**
|
|
1405
|
+
*
|
|
1406
|
+
* @type {string}
|
|
1407
|
+
* @memberof CreatePersonalAccessTokenResponsePat
|
|
1408
|
+
*/
|
|
1409
|
+
'note': string;
|
|
1410
|
+
/**
|
|
1411
|
+
* The PAT value. This will only be returned here when created and cannot be retrieved later.
|
|
1412
|
+
* @type {string}
|
|
1413
|
+
* @memberof CreatePersonalAccessTokenResponsePat
|
|
1414
|
+
*/
|
|
1415
|
+
'value': string;
|
|
1416
|
+
}
|
|
1360
1417
|
/**
|
|
1361
1418
|
*
|
|
1362
1419
|
* @export
|
|
@@ -2095,6 +2152,19 @@ export interface GetStateResponse {
|
|
|
2095
2152
|
*/
|
|
2096
2153
|
'state': State;
|
|
2097
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
|
+
}
|
|
2098
2168
|
/**
|
|
2099
2169
|
*
|
|
2100
2170
|
* @export
|
|
@@ -2108,6 +2178,55 @@ export interface GetUserResponse {
|
|
|
2108
2178
|
*/
|
|
2109
2179
|
'user': User;
|
|
2110
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];
|
|
2111
2230
|
/**
|
|
2112
2231
|
*
|
|
2113
2232
|
* @export
|
|
@@ -2568,6 +2687,44 @@ export interface ListMessagesResponse {
|
|
|
2568
2687
|
*/
|
|
2569
2688
|
'meta': ListConversationsResponseMeta;
|
|
2570
2689
|
}
|
|
2690
|
+
/**
|
|
2691
|
+
*
|
|
2692
|
+
* @export
|
|
2693
|
+
* @interface ListPersonalAccessTokensResponse
|
|
2694
|
+
*/
|
|
2695
|
+
export interface ListPersonalAccessTokensResponse {
|
|
2696
|
+
/**
|
|
2697
|
+
*
|
|
2698
|
+
* @type {Array<ListPersonalAccessTokensResponsePatsInner>}
|
|
2699
|
+
* @memberof ListPersonalAccessTokensResponse
|
|
2700
|
+
*/
|
|
2701
|
+
'pats': Array<ListPersonalAccessTokensResponsePatsInner>;
|
|
2702
|
+
}
|
|
2703
|
+
/**
|
|
2704
|
+
*
|
|
2705
|
+
* @export
|
|
2706
|
+
* @interface ListPersonalAccessTokensResponsePatsInner
|
|
2707
|
+
*/
|
|
2708
|
+
export interface ListPersonalAccessTokensResponsePatsInner {
|
|
2709
|
+
/**
|
|
2710
|
+
*
|
|
2711
|
+
* @type {string}
|
|
2712
|
+
* @memberof ListPersonalAccessTokensResponsePatsInner
|
|
2713
|
+
*/
|
|
2714
|
+
'id': string;
|
|
2715
|
+
/**
|
|
2716
|
+
*
|
|
2717
|
+
* @type {string}
|
|
2718
|
+
* @memberof ListPersonalAccessTokensResponsePatsInner
|
|
2719
|
+
*/
|
|
2720
|
+
'createdAt': string;
|
|
2721
|
+
/**
|
|
2722
|
+
*
|
|
2723
|
+
* @type {string}
|
|
2724
|
+
* @memberof ListPersonalAccessTokensResponsePatsInner
|
|
2725
|
+
*/
|
|
2726
|
+
'note': string;
|
|
2727
|
+
}
|
|
2571
2728
|
/**
|
|
2572
2729
|
*
|
|
2573
2730
|
* @export
|
|
@@ -2642,6 +2799,19 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
|
|
|
2642
2799
|
*/
|
|
2643
2800
|
'iconUrl': string;
|
|
2644
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
|
+
}
|
|
2645
2815
|
/**
|
|
2646
2816
|
*
|
|
2647
2817
|
* @export
|
|
@@ -2720,6 +2890,68 @@ export declare const ListWorkspaceMembersResponseMembersInnerRoleEnum: {
|
|
|
2720
2890
|
readonly Owner: "owner";
|
|
2721
2891
|
};
|
|
2722
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
|
+
}
|
|
2723
2955
|
/**
|
|
2724
2956
|
*
|
|
2725
2957
|
* @export
|
|
@@ -3811,6 +4043,54 @@ export declare const UpdateWorkspaceResponse1AccountTypeEnum: {
|
|
|
3811
4043
|
readonly Premium: "premium";
|
|
3812
4044
|
};
|
|
3813
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];
|
|
3814
4094
|
/**
|
|
3815
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.
|
|
3816
4096
|
* @export
|
|
@@ -4019,6 +4299,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4019
4299
|
* @throws {RequiredError}
|
|
4020
4300
|
*/
|
|
4021
4301
|
createMessage: (createMessageBody?: CreateMessageBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4302
|
+
/**
|
|
4303
|
+
* Create a PAT
|
|
4304
|
+
* @param {CreatePersonalAccessTokenBody} [createPersonalAccessTokenBody]
|
|
4305
|
+
* @param {*} [options] Override http request option.
|
|
4306
|
+
* @throws {RequiredError}
|
|
4307
|
+
*/
|
|
4308
|
+
createPersonalAccessToken: (createPersonalAccessTokenBody?: CreatePersonalAccessTokenBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4022
4309
|
/**
|
|
4023
4310
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
4024
4311
|
* @param {CreateUserBody} [createUserBody] User data
|
|
@@ -4075,6 +4362,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4075
4362
|
* @throws {RequiredError}
|
|
4076
4363
|
*/
|
|
4077
4364
|
deleteMessage: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4365
|
+
/**
|
|
4366
|
+
* Delete a PAT
|
|
4367
|
+
* @param {string} id ID of Personal Access Token
|
|
4368
|
+
* @param {*} [options] Override http request option.
|
|
4369
|
+
* @throws {RequiredError}
|
|
4370
|
+
*/
|
|
4371
|
+
deletePersonalAccessToken: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4078
4372
|
/**
|
|
4079
4373
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
4080
4374
|
* @param {string} id User ID
|
|
@@ -4249,6 +4543,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4249
4543
|
* @throws {RequiredError}
|
|
4250
4544
|
*/
|
|
4251
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>;
|
|
4252
4555
|
/**
|
|
4253
4556
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
4254
4557
|
* @param {string} id User ID
|
|
@@ -4263,6 +4566,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4263
4566
|
* @throws {RequiredError}
|
|
4264
4567
|
*/
|
|
4265
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>;
|
|
4266
4578
|
/**
|
|
4267
4579
|
* Introspect the API
|
|
4268
4580
|
* @param {IntrospectBody} [introspectBody]
|
|
@@ -4324,6 +4636,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4324
4636
|
listMessages: (nextToken?: string, conversationId?: string, tags?: {
|
|
4325
4637
|
[key: string]: string;
|
|
4326
4638
|
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4639
|
+
/**
|
|
4640
|
+
* List PATs (Personal Access Tokens) of account.
|
|
4641
|
+
* @param {*} [options] Override http request option.
|
|
4642
|
+
* @throws {RequiredError}
|
|
4643
|
+
*/
|
|
4644
|
+
listPersonalAccessTokens: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
4327
4645
|
/**
|
|
4328
4646
|
* List public integration
|
|
4329
4647
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -4333,6 +4651,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4333
4651
|
* @throws {RequiredError}
|
|
4334
4652
|
*/
|
|
4335
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>;
|
|
4336
4662
|
/**
|
|
4337
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).
|
|
4338
4664
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -4351,6 +4677,23 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
4351
4677
|
* @throws {RequiredError}
|
|
4352
4678
|
*/
|
|
4353
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>;
|
|
4354
4697
|
/**
|
|
4355
4698
|
* List workspaces the user has access to
|
|
4356
4699
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -4512,6 +4855,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
4512
4855
|
* @throws {RequiredError}
|
|
4513
4856
|
*/
|
|
4514
4857
|
createMessage(createMessageBody?: CreateMessageBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMessageResponse>>;
|
|
4858
|
+
/**
|
|
4859
|
+
* Create a PAT
|
|
4860
|
+
* @param {CreatePersonalAccessTokenBody} [createPersonalAccessTokenBody]
|
|
4861
|
+
* @param {*} [options] Override http request option.
|
|
4862
|
+
* @throws {RequiredError}
|
|
4863
|
+
*/
|
|
4864
|
+
createPersonalAccessToken(createPersonalAccessTokenBody?: CreatePersonalAccessTokenBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePersonalAccessTokenResponse>>;
|
|
4515
4865
|
/**
|
|
4516
4866
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
4517
4867
|
* @param {CreateUserBody} [createUserBody] User data
|
|
@@ -4568,6 +4918,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
4568
4918
|
* @throws {RequiredError}
|
|
4569
4919
|
*/
|
|
4570
4920
|
deleteMessage(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
4921
|
+
/**
|
|
4922
|
+
* Delete a PAT
|
|
4923
|
+
* @param {string} id ID of Personal Access Token
|
|
4924
|
+
* @param {*} [options] Override http request option.
|
|
4925
|
+
* @throws {RequiredError}
|
|
4926
|
+
*/
|
|
4927
|
+
deletePersonalAccessToken(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
4571
4928
|
/**
|
|
4572
4929
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
4573
4930
|
* @param {string} id User ID
|
|
@@ -4742,6 +5099,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
4742
5099
|
* @throws {RequiredError}
|
|
4743
5100
|
*/
|
|
4744
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>>;
|
|
4745
5111
|
/**
|
|
4746
5112
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
4747
5113
|
* @param {string} id User ID
|
|
@@ -4756,6 +5122,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
4756
5122
|
* @throws {RequiredError}
|
|
4757
5123
|
*/
|
|
4758
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>>;
|
|
4759
5134
|
/**
|
|
4760
5135
|
* Introspect the API
|
|
4761
5136
|
* @param {IntrospectBody} [introspectBody]
|
|
@@ -4817,6 +5192,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
4817
5192
|
listMessages(nextToken?: string, conversationId?: string, tags?: {
|
|
4818
5193
|
[key: string]: string;
|
|
4819
5194
|
} | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMessagesResponse>>;
|
|
5195
|
+
/**
|
|
5196
|
+
* List PATs (Personal Access Tokens) of account.
|
|
5197
|
+
* @param {*} [options] Override http request option.
|
|
5198
|
+
* @throws {RequiredError}
|
|
5199
|
+
*/
|
|
5200
|
+
listPersonalAccessTokens(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPersonalAccessTokensResponse>>;
|
|
4820
5201
|
/**
|
|
4821
5202
|
* List public integration
|
|
4822
5203
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -4826,6 +5207,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
4826
5207
|
* @throws {RequiredError}
|
|
4827
5208
|
*/
|
|
4828
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>>;
|
|
4829
5218
|
/**
|
|
4830
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).
|
|
4831
5220
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -4844,6 +5233,23 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
4844
5233
|
* @throws {RequiredError}
|
|
4845
5234
|
*/
|
|
4846
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>>;
|
|
4847
5253
|
/**
|
|
4848
5254
|
* List workspaces the user has access to
|
|
4849
5255
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -5004,6 +5410,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
5004
5410
|
* @throws {RequiredError}
|
|
5005
5411
|
*/
|
|
5006
5412
|
createMessage(requestParameters?: DefaultApiCreateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<CreateMessageResponse>;
|
|
5413
|
+
/**
|
|
5414
|
+
* Create a PAT
|
|
5415
|
+
* @param {DefaultApiCreatePersonalAccessTokenRequest} requestParameters Request parameters.
|
|
5416
|
+
* @param {*} [options] Override http request option.
|
|
5417
|
+
* @throws {RequiredError}
|
|
5418
|
+
*/
|
|
5419
|
+
createPersonalAccessToken(requestParameters?: DefaultApiCreatePersonalAccessTokenRequest, options?: AxiosRequestConfig): AxiosPromise<CreatePersonalAccessTokenResponse>;
|
|
5007
5420
|
/**
|
|
5008
5421
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
5009
5422
|
* @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
|
|
@@ -5060,6 +5473,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
5060
5473
|
* @throws {RequiredError}
|
|
5061
5474
|
*/
|
|
5062
5475
|
deleteMessage(requestParameters: DefaultApiDeleteMessageRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
5476
|
+
/**
|
|
5477
|
+
* Delete a PAT
|
|
5478
|
+
* @param {DefaultApiDeletePersonalAccessTokenRequest} requestParameters Request parameters.
|
|
5479
|
+
* @param {*} [options] Override http request option.
|
|
5480
|
+
* @throws {RequiredError}
|
|
5481
|
+
*/
|
|
5482
|
+
deletePersonalAccessToken(requestParameters: DefaultApiDeletePersonalAccessTokenRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
5063
5483
|
/**
|
|
5064
5484
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
5065
5485
|
* @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
|
|
@@ -5220,6 +5640,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
5220
5640
|
* @throws {RequiredError}
|
|
5221
5641
|
*/
|
|
5222
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>;
|
|
5223
5650
|
/**
|
|
5224
5651
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
5225
5652
|
* @param {DefaultApiGetUserRequest} requestParameters Request parameters.
|
|
@@ -5234,6 +5661,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
5234
5661
|
* @throws {RequiredError}
|
|
5235
5662
|
*/
|
|
5236
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>;
|
|
5237
5671
|
/**
|
|
5238
5672
|
* Introspect the API
|
|
5239
5673
|
* @param {DefaultApiIntrospectRequest} requestParameters Request parameters.
|
|
@@ -5283,6 +5717,12 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
5283
5717
|
* @throws {RequiredError}
|
|
5284
5718
|
*/
|
|
5285
5719
|
listMessages(requestParameters?: DefaultApiListMessagesRequest, options?: AxiosRequestConfig): AxiosPromise<ListMessagesResponse>;
|
|
5720
|
+
/**
|
|
5721
|
+
* List PATs (Personal Access Tokens) of account.
|
|
5722
|
+
* @param {*} [options] Override http request option.
|
|
5723
|
+
* @throws {RequiredError}
|
|
5724
|
+
*/
|
|
5725
|
+
listPersonalAccessTokens(options?: AxiosRequestConfig): AxiosPromise<ListPersonalAccessTokensResponse>;
|
|
5286
5726
|
/**
|
|
5287
5727
|
* List public integration
|
|
5288
5728
|
* @param {DefaultApiListPublicIntegrationsRequest} requestParameters Request parameters.
|
|
@@ -5290,6 +5730,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
5290
5730
|
* @throws {RequiredError}
|
|
5291
5731
|
*/
|
|
5292
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>;
|
|
5293
5740
|
/**
|
|
5294
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).
|
|
5295
5742
|
* @param {DefaultApiListUsersRequest} requestParameters Request parameters.
|
|
@@ -5304,6 +5751,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
5304
5751
|
* @throws {RequiredError}
|
|
5305
5752
|
*/
|
|
5306
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>;
|
|
5307
5768
|
/**
|
|
5308
5769
|
* List workspaces the user has access to
|
|
5309
5770
|
* @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
|
|
@@ -5505,6 +5966,19 @@ export interface DefaultApiCreateMessageRequest {
|
|
|
5505
5966
|
*/
|
|
5506
5967
|
readonly createMessageBody?: CreateMessageBody;
|
|
5507
5968
|
}
|
|
5969
|
+
/**
|
|
5970
|
+
* Request parameters for createPersonalAccessToken operation in DefaultApi.
|
|
5971
|
+
* @export
|
|
5972
|
+
* @interface DefaultApiCreatePersonalAccessTokenRequest
|
|
5973
|
+
*/
|
|
5974
|
+
export interface DefaultApiCreatePersonalAccessTokenRequest {
|
|
5975
|
+
/**
|
|
5976
|
+
*
|
|
5977
|
+
* @type {CreatePersonalAccessTokenBody}
|
|
5978
|
+
* @memberof DefaultApiCreatePersonalAccessToken
|
|
5979
|
+
*/
|
|
5980
|
+
readonly createPersonalAccessTokenBody?: CreatePersonalAccessTokenBody;
|
|
5981
|
+
}
|
|
5508
5982
|
/**
|
|
5509
5983
|
* Request parameters for createUser operation in DefaultApi.
|
|
5510
5984
|
* @export
|
|
@@ -5609,6 +6083,19 @@ export interface DefaultApiDeleteMessageRequest {
|
|
|
5609
6083
|
*/
|
|
5610
6084
|
readonly id: string;
|
|
5611
6085
|
}
|
|
6086
|
+
/**
|
|
6087
|
+
* Request parameters for deletePersonalAccessToken operation in DefaultApi.
|
|
6088
|
+
* @export
|
|
6089
|
+
* @interface DefaultApiDeletePersonalAccessTokenRequest
|
|
6090
|
+
*/
|
|
6091
|
+
export interface DefaultApiDeletePersonalAccessTokenRequest {
|
|
6092
|
+
/**
|
|
6093
|
+
* ID of Personal Access Token
|
|
6094
|
+
* @type {string}
|
|
6095
|
+
* @memberof DefaultApiDeletePersonalAccessToken
|
|
6096
|
+
*/
|
|
6097
|
+
readonly id: string;
|
|
6098
|
+
}
|
|
5612
6099
|
/**
|
|
5613
6100
|
* Request parameters for deleteUser operation in DefaultApi.
|
|
5614
6101
|
* @export
|
|
@@ -5979,6 +6466,31 @@ export interface DefaultApiGetStateRequest {
|
|
|
5979
6466
|
*/
|
|
5980
6467
|
readonly name: string;
|
|
5981
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
|
+
}
|
|
5982
6494
|
/**
|
|
5983
6495
|
* Request parameters for getUser operation in DefaultApi.
|
|
5984
6496
|
* @export
|
|
@@ -6005,6 +6517,31 @@ export interface DefaultApiGetWorkspaceRequest {
|
|
|
6005
6517
|
*/
|
|
6006
6518
|
readonly id: string;
|
|
6007
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
|
+
}
|
|
6008
6545
|
/**
|
|
6009
6546
|
* Request parameters for introspect operation in DefaultApi.
|
|
6010
6547
|
* @export
|
|
@@ -6173,6 +6710,25 @@ export interface DefaultApiListPublicIntegrationsRequest {
|
|
|
6173
6710
|
*/
|
|
6174
6711
|
readonly version?: string;
|
|
6175
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
|
+
}
|
|
6176
6732
|
/**
|
|
6177
6733
|
* Request parameters for listUsers operation in DefaultApi.
|
|
6178
6734
|
* @export
|
|
@@ -6213,6 +6769,50 @@ export interface DefaultApiListWorkspaceMembersRequest {
|
|
|
6213
6769
|
*/
|
|
6214
6770
|
readonly nextToken?: string;
|
|
6215
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
|
+
}
|
|
6216
6816
|
/**
|
|
6217
6817
|
* Request parameters for listWorkspaces operation in DefaultApi.
|
|
6218
6818
|
* @export
|
|
@@ -6519,6 +7119,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
6519
7119
|
* @memberof DefaultApi
|
|
6520
7120
|
*/
|
|
6521
7121
|
createMessage(requestParameters?: DefaultApiCreateMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMessageResponse, any>>;
|
|
7122
|
+
/**
|
|
7123
|
+
* Create a PAT
|
|
7124
|
+
* @param {DefaultApiCreatePersonalAccessTokenRequest} requestParameters Request parameters.
|
|
7125
|
+
* @param {*} [options] Override http request option.
|
|
7126
|
+
* @throws {RequiredError}
|
|
7127
|
+
* @memberof DefaultApi
|
|
7128
|
+
*/
|
|
7129
|
+
createPersonalAccessToken(requestParameters?: DefaultApiCreatePersonalAccessTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePersonalAccessTokenResponse, any>>;
|
|
6522
7130
|
/**
|
|
6523
7131
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
6524
7132
|
* @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
|
|
@@ -6583,6 +7191,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
6583
7191
|
* @memberof DefaultApi
|
|
6584
7192
|
*/
|
|
6585
7193
|
deleteMessage(requestParameters: DefaultApiDeleteMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
7194
|
+
/**
|
|
7195
|
+
* Delete a PAT
|
|
7196
|
+
* @param {DefaultApiDeletePersonalAccessTokenRequest} requestParameters Request parameters.
|
|
7197
|
+
* @param {*} [options] Override http request option.
|
|
7198
|
+
* @throws {RequiredError}
|
|
7199
|
+
* @memberof DefaultApi
|
|
7200
|
+
*/
|
|
7201
|
+
deletePersonalAccessToken(requestParameters: DefaultApiDeletePersonalAccessTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
6586
7202
|
/**
|
|
6587
7203
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
6588
7204
|
* @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
|
|
@@ -6766,6 +7382,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
6766
7382
|
* @memberof DefaultApi
|
|
6767
7383
|
*/
|
|
6768
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>>;
|
|
6769
7393
|
/**
|
|
6770
7394
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
6771
7395
|
* @param {DefaultApiGetUserRequest} requestParameters Request parameters.
|
|
@@ -6782,6 +7406,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
6782
7406
|
* @memberof DefaultApi
|
|
6783
7407
|
*/
|
|
6784
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>>;
|
|
6785
7417
|
/**
|
|
6786
7418
|
* Introspect the API
|
|
6787
7419
|
* @param {DefaultApiIntrospectRequest} requestParameters Request parameters.
|
|
@@ -6838,6 +7470,13 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
6838
7470
|
* @memberof DefaultApi
|
|
6839
7471
|
*/
|
|
6840
7472
|
listMessages(requestParameters?: DefaultApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListMessagesResponse, any>>;
|
|
7473
|
+
/**
|
|
7474
|
+
* List PATs (Personal Access Tokens) of account.
|
|
7475
|
+
* @param {*} [options] Override http request option.
|
|
7476
|
+
* @throws {RequiredError}
|
|
7477
|
+
* @memberof DefaultApi
|
|
7478
|
+
*/
|
|
7479
|
+
listPersonalAccessTokens(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPersonalAccessTokensResponse, any>>;
|
|
6841
7480
|
/**
|
|
6842
7481
|
* List public integration
|
|
6843
7482
|
* @param {DefaultApiListPublicIntegrationsRequest} requestParameters Request parameters.
|
|
@@ -6846,6 +7485,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
6846
7485
|
* @memberof DefaultApi
|
|
6847
7486
|
*/
|
|
6848
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>>;
|
|
6849
7496
|
/**
|
|
6850
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).
|
|
6851
7498
|
* @param {DefaultApiListUsersRequest} requestParameters Request parameters.
|
|
@@ -6862,6 +7509,22 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
6862
7509
|
* @memberof DefaultApi
|
|
6863
7510
|
*/
|
|
6864
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>>;
|
|
6865
7528
|
/**
|
|
6866
7529
|
* List workspaces the user has access to
|
|
6867
7530
|
* @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
|
|
@@ -6971,6 +7634,62 @@ export declare const GetStateTypeEnum: {
|
|
|
6971
7634
|
readonly Integration: "integration";
|
|
6972
7635
|
};
|
|
6973
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];
|
|
6974
7693
|
/**
|
|
6975
7694
|
* @export
|
|
6976
7695
|
*/
|