@botpress/client 0.6.3 → 0.7.0
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 +5 -5
- package/dist/bundle.cjs.map +3 -3
- package/dist/gen/api.d.ts +280 -4
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +9 -1
- package/dist/gen/common.d.ts +1 -1
- package/dist/gen/configuration.d.ts +1 -1
- 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.
|
|
5
|
+
* The version of the OpenAPI document: 0.13.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -38,6 +38,32 @@ export interface Account {
|
|
|
38
38
|
*/
|
|
39
39
|
'createdAt': string;
|
|
40
40
|
}
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
* @interface AddParticipantBody
|
|
45
|
+
*/
|
|
46
|
+
export interface AddParticipantBody {
|
|
47
|
+
/**
|
|
48
|
+
* User id
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof AddParticipantBody
|
|
51
|
+
*/
|
|
52
|
+
'userId': string;
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @export
|
|
57
|
+
* @interface AddParticipantResponse
|
|
58
|
+
*/
|
|
59
|
+
export interface AddParticipantResponse {
|
|
60
|
+
/**
|
|
61
|
+
*
|
|
62
|
+
* @type {User}
|
|
63
|
+
* @memberof AddParticipantResponse
|
|
64
|
+
*/
|
|
65
|
+
'participant': User;
|
|
66
|
+
}
|
|
41
67
|
/**
|
|
42
68
|
*
|
|
43
69
|
* @export
|
|
@@ -256,7 +282,7 @@ export interface BotIntegrationsValue {
|
|
|
256
282
|
*/
|
|
257
283
|
'statusReason': string | null;
|
|
258
284
|
/**
|
|
259
|
-
*
|
|
285
|
+
* ID of the [Integration](#schema_integration)
|
|
260
286
|
* @type {string}
|
|
261
287
|
* @memberof BotIntegrationsValue
|
|
262
288
|
*/
|
|
@@ -1353,6 +1379,12 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
|
|
|
1353
1379
|
* @interface CreateIntegrationBodyIdentifier
|
|
1354
1380
|
*/
|
|
1355
1381
|
export interface CreateIntegrationBodyIdentifier {
|
|
1382
|
+
/**
|
|
1383
|
+
*
|
|
1384
|
+
* @type {string}
|
|
1385
|
+
* @memberof CreateIntegrationBodyIdentifier
|
|
1386
|
+
*/
|
|
1387
|
+
'fallbackHandlerScript'?: string;
|
|
1356
1388
|
/**
|
|
1357
1389
|
*
|
|
1358
1390
|
* @type {string}
|
|
@@ -2355,6 +2387,19 @@ export interface GetOrCreateUserResponse {
|
|
|
2355
2387
|
*/
|
|
2356
2388
|
'user': User;
|
|
2357
2389
|
}
|
|
2390
|
+
/**
|
|
2391
|
+
*
|
|
2392
|
+
* @export
|
|
2393
|
+
* @interface GetParticipantResponse
|
|
2394
|
+
*/
|
|
2395
|
+
export interface GetParticipantResponse {
|
|
2396
|
+
/**
|
|
2397
|
+
*
|
|
2398
|
+
* @type {User}
|
|
2399
|
+
* @memberof GetParticipantResponse
|
|
2400
|
+
*/
|
|
2401
|
+
'participant': User;
|
|
2402
|
+
}
|
|
2358
2403
|
/**
|
|
2359
2404
|
*
|
|
2360
2405
|
* @export
|
|
@@ -2676,7 +2721,7 @@ export type GetWorkspaceResponsePlanEnum = typeof GetWorkspaceResponsePlanEnum[k
|
|
|
2676
2721
|
*/
|
|
2677
2722
|
export interface Integration {
|
|
2678
2723
|
/**
|
|
2679
|
-
*
|
|
2724
|
+
* ID of the [Integration](#schema_integration)
|
|
2680
2725
|
* @type {string}
|
|
2681
2726
|
* @memberof Integration
|
|
2682
2727
|
*/
|
|
@@ -2892,6 +2937,12 @@ export interface IntegrationConfigurationIdentifier {
|
|
|
2892
2937
|
* @interface IntegrationIdentifier
|
|
2893
2938
|
*/
|
|
2894
2939
|
export interface IntegrationIdentifier {
|
|
2940
|
+
/**
|
|
2941
|
+
* VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn\'t have an identifier
|
|
2942
|
+
* @type {string}
|
|
2943
|
+
* @memberof IntegrationIdentifier
|
|
2944
|
+
*/
|
|
2945
|
+
'fallbackHandlerScript'?: string;
|
|
2895
2946
|
/**
|
|
2896
2947
|
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
|
|
2897
2948
|
* @type {string}
|
|
@@ -3398,6 +3449,25 @@ export interface ListMessagesResponse {
|
|
|
3398
3449
|
*/
|
|
3399
3450
|
'meta': ListConversationsResponseMeta;
|
|
3400
3451
|
}
|
|
3452
|
+
/**
|
|
3453
|
+
*
|
|
3454
|
+
* @export
|
|
3455
|
+
* @interface ListParticipantsResponse
|
|
3456
|
+
*/
|
|
3457
|
+
export interface ListParticipantsResponse {
|
|
3458
|
+
/**
|
|
3459
|
+
*
|
|
3460
|
+
* @type {Array<User>}
|
|
3461
|
+
* @memberof ListParticipantsResponse
|
|
3462
|
+
*/
|
|
3463
|
+
'participants': Array<User>;
|
|
3464
|
+
/**
|
|
3465
|
+
*
|
|
3466
|
+
* @type {ListConversationsResponseMeta}
|
|
3467
|
+
* @memberof ListParticipantsResponse
|
|
3468
|
+
*/
|
|
3469
|
+
'meta': ListConversationsResponseMeta;
|
|
3470
|
+
}
|
|
3401
3471
|
/**
|
|
3402
3472
|
*
|
|
3403
3473
|
* @export
|
|
@@ -3462,7 +3532,7 @@ export interface ListPublicIntegrationsResponse {
|
|
|
3462
3532
|
*/
|
|
3463
3533
|
export interface ListPublicIntegrationsResponseIntegrationsInner {
|
|
3464
3534
|
/**
|
|
3465
|
-
*
|
|
3535
|
+
* ID of the [Integration](#schema_integration)
|
|
3466
3536
|
* @type {string}
|
|
3467
3537
|
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
3468
3538
|
*/
|
|
@@ -4649,6 +4719,12 @@ export interface UpdateIntegrationBodyIdentifier {
|
|
|
4649
4719
|
* @memberof UpdateIntegrationBodyIdentifier
|
|
4650
4720
|
*/
|
|
4651
4721
|
'extractScript'?: string | null;
|
|
4722
|
+
/**
|
|
4723
|
+
*
|
|
4724
|
+
* @type {string}
|
|
4725
|
+
* @memberof UpdateIntegrationBodyIdentifier
|
|
4726
|
+
*/
|
|
4727
|
+
'fallbackHandlerScript'?: string | null;
|
|
4652
4728
|
}
|
|
4653
4729
|
/**
|
|
4654
4730
|
* State definition
|
|
@@ -5235,6 +5311,14 @@ export type WorkspaceMemberRoleEnum = typeof WorkspaceMemberRoleEnum[keyof typeo
|
|
|
5235
5311
|
* @export
|
|
5236
5312
|
*/
|
|
5237
5313
|
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5314
|
+
/**
|
|
5315
|
+
* Add a [Participant](#schema_participant) to a [Conversation](#schema_conversation).
|
|
5316
|
+
* @param {string} id Conversation id
|
|
5317
|
+
* @param {AddParticipantBody} [addParticipantBody] Participant data
|
|
5318
|
+
* @param {*} [options] Override http request option.
|
|
5319
|
+
* @throws {RequiredError}
|
|
5320
|
+
*/
|
|
5321
|
+
addParticipant: (id: string, addParticipantBody?: AddParticipantBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5238
5322
|
/**
|
|
5239
5323
|
* Call an action
|
|
5240
5324
|
* @param {CallActionBody} [callActionBody] Action payload
|
|
@@ -5535,6 +5619,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5535
5619
|
* @throws {RequiredError}
|
|
5536
5620
|
*/
|
|
5537
5621
|
getOrCreateUser: (getOrCreateUserBody?: GetOrCreateUserBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5622
|
+
/**
|
|
5623
|
+
* Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
|
|
5624
|
+
* @param {string} id Conversation id
|
|
5625
|
+
* @param {string} userId User id
|
|
5626
|
+
* @param {*} [options] Override http request option.
|
|
5627
|
+
* @throws {RequiredError}
|
|
5628
|
+
*/
|
|
5629
|
+
getParticipant: (id: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5538
5630
|
/**
|
|
5539
5631
|
* Get public integration by name and version
|
|
5540
5632
|
* @param {string} name Integration Name
|
|
@@ -5678,6 +5770,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5678
5770
|
listMessages: (nextToken?: string, conversationId?: string, tags?: {
|
|
5679
5771
|
[key: string]: string;
|
|
5680
5772
|
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5773
|
+
/**
|
|
5774
|
+
* Retrieves a list of [Participant](#schema_participant) for a given [Conversation](#schema_conversation).
|
|
5775
|
+
* @param {string} id Conversation id
|
|
5776
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
5777
|
+
* @param {*} [options] Override http request option.
|
|
5778
|
+
* @throws {RequiredError}
|
|
5779
|
+
*/
|
|
5780
|
+
listParticipants: (id: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5681
5781
|
/**
|
|
5682
5782
|
* List PATs (Personal Access Tokens) of account.
|
|
5683
5783
|
* @param {*} [options] Override http request option.
|
|
@@ -5760,6 +5860,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5760
5860
|
* @throws {RequiredError}
|
|
5761
5861
|
*/
|
|
5762
5862
|
patchState: (type: PatchStateTypeEnum, id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5863
|
+
/**
|
|
5864
|
+
* Remove a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
|
|
5865
|
+
* @param {string} id Conversation id
|
|
5866
|
+
* @param {string} userId User id
|
|
5867
|
+
* @param {*} [options] Override http request option.
|
|
5868
|
+
* @throws {RequiredError}
|
|
5869
|
+
*/
|
|
5870
|
+
removeParticipant: (id: string, userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5763
5871
|
/**
|
|
5764
5872
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
5765
5873
|
* @param {SetStateTypeEnum} type State type
|
|
@@ -5848,6 +5956,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5848
5956
|
* @export
|
|
5849
5957
|
*/
|
|
5850
5958
|
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
5959
|
+
/**
|
|
5960
|
+
* Add a [Participant](#schema_participant) to a [Conversation](#schema_conversation).
|
|
5961
|
+
* @param {string} id Conversation id
|
|
5962
|
+
* @param {AddParticipantBody} [addParticipantBody] Participant data
|
|
5963
|
+
* @param {*} [options] Override http request option.
|
|
5964
|
+
* @throws {RequiredError}
|
|
5965
|
+
*/
|
|
5966
|
+
addParticipant(id: string, addParticipantBody?: AddParticipantBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddParticipantResponse>>;
|
|
5851
5967
|
/**
|
|
5852
5968
|
* Call an action
|
|
5853
5969
|
* @param {CallActionBody} [callActionBody] Action payload
|
|
@@ -6148,6 +6264,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6148
6264
|
* @throws {RequiredError}
|
|
6149
6265
|
*/
|
|
6150
6266
|
getOrCreateUser(getOrCreateUserBody?: GetOrCreateUserBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrCreateUserResponse>>;
|
|
6267
|
+
/**
|
|
6268
|
+
* Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
|
|
6269
|
+
* @param {string} id Conversation id
|
|
6270
|
+
* @param {string} userId User id
|
|
6271
|
+
* @param {*} [options] Override http request option.
|
|
6272
|
+
* @throws {RequiredError}
|
|
6273
|
+
*/
|
|
6274
|
+
getParticipant(id: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetParticipantResponse>>;
|
|
6151
6275
|
/**
|
|
6152
6276
|
* Get public integration by name and version
|
|
6153
6277
|
* @param {string} name Integration Name
|
|
@@ -6291,6 +6415,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6291
6415
|
listMessages(nextToken?: string, conversationId?: string, tags?: {
|
|
6292
6416
|
[key: string]: string;
|
|
6293
6417
|
} | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMessagesResponse>>;
|
|
6418
|
+
/**
|
|
6419
|
+
* Retrieves a list of [Participant](#schema_participant) for a given [Conversation](#schema_conversation).
|
|
6420
|
+
* @param {string} id Conversation id
|
|
6421
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
6422
|
+
* @param {*} [options] Override http request option.
|
|
6423
|
+
* @throws {RequiredError}
|
|
6424
|
+
*/
|
|
6425
|
+
listParticipants(id: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListParticipantsResponse>>;
|
|
6294
6426
|
/**
|
|
6295
6427
|
* List PATs (Personal Access Tokens) of account.
|
|
6296
6428
|
* @param {*} [options] Override http request option.
|
|
@@ -6373,6 +6505,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6373
6505
|
* @throws {RequiredError}
|
|
6374
6506
|
*/
|
|
6375
6507
|
patchState(type: PatchStateTypeEnum, id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchStateResponse>>;
|
|
6508
|
+
/**
|
|
6509
|
+
* Remove a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
|
|
6510
|
+
* @param {string} id Conversation id
|
|
6511
|
+
* @param {string} userId User id
|
|
6512
|
+
* @param {*} [options] Override http request option.
|
|
6513
|
+
* @throws {RequiredError}
|
|
6514
|
+
*/
|
|
6515
|
+
removeParticipant(id: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
6376
6516
|
/**
|
|
6377
6517
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
6378
6518
|
* @param {SetStateTypeEnum} type State type
|
|
@@ -6461,6 +6601,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6461
6601
|
* @export
|
|
6462
6602
|
*/
|
|
6463
6603
|
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6604
|
+
/**
|
|
6605
|
+
* Add a [Participant](#schema_participant) to a [Conversation](#schema_conversation).
|
|
6606
|
+
* @param {DefaultApiAddParticipantRequest} requestParameters Request parameters.
|
|
6607
|
+
* @param {*} [options] Override http request option.
|
|
6608
|
+
* @throws {RequiredError}
|
|
6609
|
+
*/
|
|
6610
|
+
addParticipant(requestParameters: DefaultApiAddParticipantRequest, options?: AxiosRequestConfig): AxiosPromise<AddParticipantResponse>;
|
|
6464
6611
|
/**
|
|
6465
6612
|
* Call an action
|
|
6466
6613
|
* @param {DefaultApiCallActionRequest} requestParameters Request parameters.
|
|
@@ -6747,6 +6894,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
6747
6894
|
* @throws {RequiredError}
|
|
6748
6895
|
*/
|
|
6749
6896
|
getOrCreateUser(requestParameters?: DefaultApiGetOrCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateUserResponse>;
|
|
6897
|
+
/**
|
|
6898
|
+
* Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
|
|
6899
|
+
* @param {DefaultApiGetParticipantRequest} requestParameters Request parameters.
|
|
6900
|
+
* @param {*} [options] Override http request option.
|
|
6901
|
+
* @throws {RequiredError}
|
|
6902
|
+
*/
|
|
6903
|
+
getParticipant(requestParameters: DefaultApiGetParticipantRequest, options?: AxiosRequestConfig): AxiosPromise<GetParticipantResponse>;
|
|
6750
6904
|
/**
|
|
6751
6905
|
* Get public integration by name and version
|
|
6752
6906
|
* @param {DefaultApiGetPublicIntegrationRequest} requestParameters Request parameters.
|
|
@@ -6866,6 +7020,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
6866
7020
|
* @throws {RequiredError}
|
|
6867
7021
|
*/
|
|
6868
7022
|
listMessages(requestParameters?: DefaultApiListMessagesRequest, options?: AxiosRequestConfig): AxiosPromise<ListMessagesResponse>;
|
|
7023
|
+
/**
|
|
7024
|
+
* Retrieves a list of [Participant](#schema_participant) for a given [Conversation](#schema_conversation).
|
|
7025
|
+
* @param {DefaultApiListParticipantsRequest} requestParameters Request parameters.
|
|
7026
|
+
* @param {*} [options] Override http request option.
|
|
7027
|
+
* @throws {RequiredError}
|
|
7028
|
+
*/
|
|
7029
|
+
listParticipants(requestParameters: DefaultApiListParticipantsRequest, options?: AxiosRequestConfig): AxiosPromise<ListParticipantsResponse>;
|
|
6869
7030
|
/**
|
|
6870
7031
|
* List PATs (Personal Access Tokens) of account.
|
|
6871
7032
|
* @param {*} [options] Override http request option.
|
|
@@ -6935,6 +7096,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
6935
7096
|
* @throws {RequiredError}
|
|
6936
7097
|
*/
|
|
6937
7098
|
patchState(requestParameters: DefaultApiPatchStateRequest, options?: AxiosRequestConfig): AxiosPromise<PatchStateResponse>;
|
|
7099
|
+
/**
|
|
7100
|
+
* Remove a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
|
|
7101
|
+
* @param {DefaultApiRemoveParticipantRequest} requestParameters Request parameters.
|
|
7102
|
+
* @param {*} [options] Override http request option.
|
|
7103
|
+
* @throws {RequiredError}
|
|
7104
|
+
*/
|
|
7105
|
+
removeParticipant(requestParameters: DefaultApiRemoveParticipantRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
6938
7106
|
/**
|
|
6939
7107
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
6940
7108
|
* @param {DefaultApiSetStateRequest} requestParameters Request parameters.
|
|
@@ -7006,6 +7174,25 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7006
7174
|
*/
|
|
7007
7175
|
updateWorkspaceMember(requestParameters: DefaultApiUpdateWorkspaceMemberRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateWorkspaceMemberResponse>;
|
|
7008
7176
|
};
|
|
7177
|
+
/**
|
|
7178
|
+
* Request parameters for addParticipant operation in DefaultApi.
|
|
7179
|
+
* @export
|
|
7180
|
+
* @interface DefaultApiAddParticipantRequest
|
|
7181
|
+
*/
|
|
7182
|
+
export interface DefaultApiAddParticipantRequest {
|
|
7183
|
+
/**
|
|
7184
|
+
* Conversation id
|
|
7185
|
+
* @type {string}
|
|
7186
|
+
* @memberof DefaultApiAddParticipant
|
|
7187
|
+
*/
|
|
7188
|
+
readonly id: string;
|
|
7189
|
+
/**
|
|
7190
|
+
* Participant data
|
|
7191
|
+
* @type {AddParticipantBody}
|
|
7192
|
+
* @memberof DefaultApiAddParticipant
|
|
7193
|
+
*/
|
|
7194
|
+
readonly addParticipantBody?: AddParticipantBody;
|
|
7195
|
+
}
|
|
7009
7196
|
/**
|
|
7010
7197
|
* Request parameters for callAction operation in DefaultApi.
|
|
7011
7198
|
* @export
|
|
@@ -7610,6 +7797,25 @@ export interface DefaultApiGetOrCreateUserRequest {
|
|
|
7610
7797
|
*/
|
|
7611
7798
|
readonly getOrCreateUserBody?: GetOrCreateUserBody;
|
|
7612
7799
|
}
|
|
7800
|
+
/**
|
|
7801
|
+
* Request parameters for getParticipant operation in DefaultApi.
|
|
7802
|
+
* @export
|
|
7803
|
+
* @interface DefaultApiGetParticipantRequest
|
|
7804
|
+
*/
|
|
7805
|
+
export interface DefaultApiGetParticipantRequest {
|
|
7806
|
+
/**
|
|
7807
|
+
* Conversation id
|
|
7808
|
+
* @type {string}
|
|
7809
|
+
* @memberof DefaultApiGetParticipant
|
|
7810
|
+
*/
|
|
7811
|
+
readonly id: string;
|
|
7812
|
+
/**
|
|
7813
|
+
* User id
|
|
7814
|
+
* @type {string}
|
|
7815
|
+
* @memberof DefaultApiGetParticipant
|
|
7816
|
+
*/
|
|
7817
|
+
readonly userId: string;
|
|
7818
|
+
}
|
|
7613
7819
|
/**
|
|
7614
7820
|
* Request parameters for getPublicIntegration operation in DefaultApi.
|
|
7615
7821
|
* @export
|
|
@@ -7955,6 +8161,25 @@ export interface DefaultApiListMessagesRequest {
|
|
|
7955
8161
|
[key: string]: string;
|
|
7956
8162
|
};
|
|
7957
8163
|
}
|
|
8164
|
+
/**
|
|
8165
|
+
* Request parameters for listParticipants operation in DefaultApi.
|
|
8166
|
+
* @export
|
|
8167
|
+
* @interface DefaultApiListParticipantsRequest
|
|
8168
|
+
*/
|
|
8169
|
+
export interface DefaultApiListParticipantsRequest {
|
|
8170
|
+
/**
|
|
8171
|
+
* Conversation id
|
|
8172
|
+
* @type {string}
|
|
8173
|
+
* @memberof DefaultApiListParticipants
|
|
8174
|
+
*/
|
|
8175
|
+
readonly id: string;
|
|
8176
|
+
/**
|
|
8177
|
+
* Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
8178
|
+
* @type {string}
|
|
8179
|
+
* @memberof DefaultApiListParticipants
|
|
8180
|
+
*/
|
|
8181
|
+
readonly nextToken?: string;
|
|
8182
|
+
}
|
|
7958
8183
|
/**
|
|
7959
8184
|
* Request parameters for listPublicIntegrations operation in DefaultApi.
|
|
7960
8185
|
* @export
|
|
@@ -8140,6 +8365,25 @@ export interface DefaultApiPatchStateRequest {
|
|
|
8140
8365
|
*/
|
|
8141
8366
|
readonly patchStateBody?: PatchStateBody;
|
|
8142
8367
|
}
|
|
8368
|
+
/**
|
|
8369
|
+
* Request parameters for removeParticipant operation in DefaultApi.
|
|
8370
|
+
* @export
|
|
8371
|
+
* @interface DefaultApiRemoveParticipantRequest
|
|
8372
|
+
*/
|
|
8373
|
+
export interface DefaultApiRemoveParticipantRequest {
|
|
8374
|
+
/**
|
|
8375
|
+
* Conversation id
|
|
8376
|
+
* @type {string}
|
|
8377
|
+
* @memberof DefaultApiRemoveParticipant
|
|
8378
|
+
*/
|
|
8379
|
+
readonly id: string;
|
|
8380
|
+
/**
|
|
8381
|
+
* User id
|
|
8382
|
+
* @type {string}
|
|
8383
|
+
* @memberof DefaultApiRemoveParticipant
|
|
8384
|
+
*/
|
|
8385
|
+
readonly userId: string;
|
|
8386
|
+
}
|
|
8143
8387
|
/**
|
|
8144
8388
|
* Request parameters for setState operation in DefaultApi.
|
|
8145
8389
|
* @export
|
|
@@ -8349,6 +8593,14 @@ export interface DefaultApiUpdateWorkspaceMemberRequest {
|
|
|
8349
8593
|
* @extends {BaseAPI}
|
|
8350
8594
|
*/
|
|
8351
8595
|
export declare class DefaultApi extends BaseAPI {
|
|
8596
|
+
/**
|
|
8597
|
+
* Add a [Participant](#schema_participant) to a [Conversation](#schema_conversation).
|
|
8598
|
+
* @param {DefaultApiAddParticipantRequest} requestParameters Request parameters.
|
|
8599
|
+
* @param {*} [options] Override http request option.
|
|
8600
|
+
* @throws {RequiredError}
|
|
8601
|
+
* @memberof DefaultApi
|
|
8602
|
+
*/
|
|
8603
|
+
addParticipant(requestParameters: DefaultApiAddParticipantRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AddParticipantResponse, any>>;
|
|
8352
8604
|
/**
|
|
8353
8605
|
* Call an action
|
|
8354
8606
|
* @param {DefaultApiCallActionRequest} requestParameters Request parameters.
|
|
@@ -8676,6 +8928,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
8676
8928
|
* @memberof DefaultApi
|
|
8677
8929
|
*/
|
|
8678
8930
|
getOrCreateUser(requestParameters?: DefaultApiGetOrCreateUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrCreateUserResponse, any>>;
|
|
8931
|
+
/**
|
|
8932
|
+
* Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
|
|
8933
|
+
* @param {DefaultApiGetParticipantRequest} requestParameters Request parameters.
|
|
8934
|
+
* @param {*} [options] Override http request option.
|
|
8935
|
+
* @throws {RequiredError}
|
|
8936
|
+
* @memberof DefaultApi
|
|
8937
|
+
*/
|
|
8938
|
+
getParticipant(requestParameters: DefaultApiGetParticipantRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetParticipantResponse, any>>;
|
|
8679
8939
|
/**
|
|
8680
8940
|
* Get public integration by name and version
|
|
8681
8941
|
* @param {DefaultApiGetPublicIntegrationRequest} requestParameters Request parameters.
|
|
@@ -8812,6 +9072,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
8812
9072
|
* @memberof DefaultApi
|
|
8813
9073
|
*/
|
|
8814
9074
|
listMessages(requestParameters?: DefaultApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListMessagesResponse, any>>;
|
|
9075
|
+
/**
|
|
9076
|
+
* Retrieves a list of [Participant](#schema_participant) for a given [Conversation](#schema_conversation).
|
|
9077
|
+
* @param {DefaultApiListParticipantsRequest} requestParameters Request parameters.
|
|
9078
|
+
* @param {*} [options] Override http request option.
|
|
9079
|
+
* @throws {RequiredError}
|
|
9080
|
+
* @memberof DefaultApi
|
|
9081
|
+
*/
|
|
9082
|
+
listParticipants(requestParameters: DefaultApiListParticipantsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListParticipantsResponse, any>>;
|
|
8815
9083
|
/**
|
|
8816
9084
|
* List PATs (Personal Access Tokens) of account.
|
|
8817
9085
|
* @param {*} [options] Override http request option.
|
|
@@ -8891,6 +9159,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
8891
9159
|
* @memberof DefaultApi
|
|
8892
9160
|
*/
|
|
8893
9161
|
patchState(requestParameters: DefaultApiPatchStateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchStateResponse, any>>;
|
|
9162
|
+
/**
|
|
9163
|
+
* Remove a [Participant](#schema_participant) from a [Conversation](#schema_conversation).
|
|
9164
|
+
* @param {DefaultApiRemoveParticipantRequest} requestParameters Request parameters.
|
|
9165
|
+
* @param {*} [options] Override http request option.
|
|
9166
|
+
* @throws {RequiredError}
|
|
9167
|
+
* @memberof DefaultApi
|
|
9168
|
+
*/
|
|
9169
|
+
removeParticipant(requestParameters: DefaultApiRemoveParticipantRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
8894
9170
|
/**
|
|
8895
9171
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
8896
9172
|
* @param {DefaultApiSetStateRequest} requestParameters Request parameters.
|
package/dist/gen/base.d.ts
CHANGED
package/dist/gen/client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
2
|
import type { Merge, Except } from 'type-fest';
|
|
3
|
-
import { Configuration, DefaultApiCreateConversationRequest, DefaultApiGetConversationRequest, DefaultApiListConversationsRequest, DefaultApiGetOrCreateConversationRequest, DefaultApiUpdateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiCreatePersonalAccessTokenRequest, DefaultApiDeletePersonalAccessTokenRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiListBotIssuesRequest, DefaultApiDeleteBotIssueRequest, DefaultApiListBotIssueEventsRequest, DefaultApiGetWorkspaceBillingDetailsRequest, DefaultApiSetWorkspacePaymentMethodRequest, DefaultApiListWorkspaceInvoicesRequest, DefaultApiChargeWorkspaceUnpaidInvoicesRequest, DefaultApiCreateWorkspaceRequest, DefaultApiGetWorkspaceRequest, DefaultApiListWorkspaceUsagesRequest, DefaultApiGetWorkspaceQuotaRequest, DefaultApiListWorkspaceQuotasRequest, DefaultApiUpdateWorkspaceRequest, DefaultApiListWorkspacesRequest, DefaultApiChangeWorkspacePlanRequest, DefaultApiDeleteWorkspaceRequest, DefaultApiGetAuditRecordsRequest, DefaultApiListWorkspaceMembersRequest, DefaultApiDeleteWorkspaceMemberRequest, DefaultApiCreateWorkspaceMemberRequest, DefaultApiUpdateWorkspaceMemberRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationLogsRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiGetUsageRequest, DefaultApiListUsageHistoryRequest, DefaultApiIntrospectRequest, DefaultApiCreateFileRequest, DefaultApiGetFileRequest, DefaultApiDownloadFileRequest, DefaultApiDeleteFileRequest, DefaultApiListFilesRequest } from '.';
|
|
3
|
+
import { Configuration, DefaultApiCreateConversationRequest, DefaultApiGetConversationRequest, DefaultApiListConversationsRequest, DefaultApiGetOrCreateConversationRequest, DefaultApiUpdateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiListParticipantsRequest, DefaultApiAddParticipantRequest, DefaultApiGetParticipantRequest, DefaultApiRemoveParticipantRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiCreatePersonalAccessTokenRequest, DefaultApiDeletePersonalAccessTokenRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiListBotIssuesRequest, DefaultApiDeleteBotIssueRequest, DefaultApiListBotIssueEventsRequest, DefaultApiGetWorkspaceBillingDetailsRequest, DefaultApiSetWorkspacePaymentMethodRequest, DefaultApiListWorkspaceInvoicesRequest, DefaultApiChargeWorkspaceUnpaidInvoicesRequest, DefaultApiCreateWorkspaceRequest, DefaultApiGetWorkspaceRequest, DefaultApiListWorkspaceUsagesRequest, DefaultApiGetWorkspaceQuotaRequest, DefaultApiListWorkspaceQuotasRequest, DefaultApiUpdateWorkspaceRequest, DefaultApiListWorkspacesRequest, DefaultApiChangeWorkspacePlanRequest, DefaultApiDeleteWorkspaceRequest, DefaultApiGetAuditRecordsRequest, DefaultApiListWorkspaceMembersRequest, DefaultApiDeleteWorkspaceMemberRequest, DefaultApiCreateWorkspaceMemberRequest, DefaultApiUpdateWorkspaceMemberRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationLogsRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiGetUsageRequest, DefaultApiListUsageHistoryRequest, DefaultApiIntrospectRequest, DefaultApiCreateFileRequest, DefaultApiGetFileRequest, DefaultApiDownloadFileRequest, DefaultApiDeleteFileRequest, DefaultApiListFilesRequest } from '.';
|
|
4
4
|
export declare class ApiClient {
|
|
5
5
|
private _innerClient;
|
|
6
6
|
constructor(configuration?: Configuration, basePath?: string, axiosInstance?: AxiosInstance);
|
|
@@ -10,6 +10,10 @@ export declare class ApiClient {
|
|
|
10
10
|
getOrCreateConversation: (getOrCreateConversationBody: GetOrCreateConversationProps) => Promise<import("./api").GetOrCreateConversationResponse>;
|
|
11
11
|
updateConversation: ({ id, ...updateConversationBody }: UpdateConversationProps) => Promise<import("./api").UpdateConversationResponse>;
|
|
12
12
|
deleteConversation: (props: DeleteConversationProps) => Promise<object>;
|
|
13
|
+
listParticipants: (props: ListParticipantsProps) => Promise<import("./api").ListParticipantsResponse>;
|
|
14
|
+
addParticipant: ({ id, ...addParticipantBody }: AddParticipantProps) => Promise<import("./api").AddParticipantResponse>;
|
|
15
|
+
getParticipant: (props: GetParticipantProps) => Promise<import("./api").GetParticipantResponse>;
|
|
16
|
+
removeParticipant: (props: RemoveParticipantProps) => Promise<object>;
|
|
13
17
|
createEvent: (createEventBody: CreateEventProps) => Promise<import("./api").CreateEventResponse>;
|
|
14
18
|
getEvent: (props: GetEventProps) => Promise<import("./api").GetEventResponse>;
|
|
15
19
|
listEvents: (props: ListEventsProps) => Promise<import("./api").ListEventsResponse>;
|
|
@@ -89,6 +93,10 @@ export type ListConversationsProps = Merge<DefaultApiListConversationsRequest, {
|
|
|
89
93
|
export type GetOrCreateConversationProps = Merge<Except<DefaultApiGetOrCreateConversationRequest, 'getOrCreateConversationBody'>, NonNullable<DefaultApiGetOrCreateConversationRequest['getOrCreateConversationBody']>>;
|
|
90
94
|
export type UpdateConversationProps = Merge<Except<DefaultApiUpdateConversationRequest, 'updateConversationBody'>, NonNullable<DefaultApiUpdateConversationRequest['updateConversationBody']>>;
|
|
91
95
|
export type DeleteConversationProps = Merge<DefaultApiDeleteConversationRequest, {}>;
|
|
96
|
+
export type ListParticipantsProps = Merge<DefaultApiListParticipantsRequest, {}>;
|
|
97
|
+
export type AddParticipantProps = Merge<Except<DefaultApiAddParticipantRequest, 'addParticipantBody'>, NonNullable<DefaultApiAddParticipantRequest['addParticipantBody']>>;
|
|
98
|
+
export type GetParticipantProps = Merge<DefaultApiGetParticipantRequest, {}>;
|
|
99
|
+
export type RemoveParticipantProps = Merge<DefaultApiRemoveParticipantRequest, {}>;
|
|
92
100
|
export type CreateEventProps = Merge<Except<DefaultApiCreateEventRequest, 'createEventBody'>, NonNullable<DefaultApiCreateEventRequest['createEventBody']>>;
|
|
93
101
|
export type GetEventProps = Merge<DefaultApiGetEventRequest, {}>;
|
|
94
102
|
export type ListEventsProps = Merge<DefaultApiListEventsRequest, {}>;
|
package/dist/gen/common.d.ts
CHANGED
package/dist/gen/index.d.ts
CHANGED