@botpress/client 0.0.11 → 0.0.13
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 +2 -2
- package/dist/gen/api.d.ts +423 -592
- package/dist/gen/base.d.ts +2 -3
- package/dist/gen/client.d.ts +7 -3
- package/dist/gen/common.d.ts +4 -4
- package/dist/gen/errors.d.ts +6 -0
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +3 -3
- package/dist/index.mjs +1 -1
- package/package.json +9 -9
- package/dist/oauth.d.ts +0 -24
package/dist/gen/api.d.ts
CHANGED
|
@@ -9,9 +9,10 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { Configuration } from './configuration';
|
|
13
|
-
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
-
import { RequestArgs
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
15
16
|
/**
|
|
16
17
|
*
|
|
17
18
|
* @export
|
|
@@ -104,6 +105,12 @@ export interface Bot {
|
|
|
104
105
|
* @memberof Bot
|
|
105
106
|
*/
|
|
106
107
|
'dev': boolean;
|
|
108
|
+
/**
|
|
109
|
+
* Id of the user that created the bot
|
|
110
|
+
* @type {string}
|
|
111
|
+
* @memberof Bot
|
|
112
|
+
*/
|
|
113
|
+
'createdBy'?: string;
|
|
107
114
|
/**
|
|
108
115
|
* Media files associated with the [Bot](#schema_bot)
|
|
109
116
|
* @type {Array<BotMediasInner>}
|
|
@@ -782,6 +789,30 @@ export interface CreateIntegrationBody {
|
|
|
782
789
|
* @memberof CreateIntegrationBody
|
|
783
790
|
*/
|
|
784
791
|
'dev'?: boolean;
|
|
792
|
+
/**
|
|
793
|
+
* Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
|
|
794
|
+
* @type {string}
|
|
795
|
+
* @memberof CreateIntegrationBody
|
|
796
|
+
*/
|
|
797
|
+
'icon'?: string;
|
|
798
|
+
/**
|
|
799
|
+
* Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.
|
|
800
|
+
* @type {string}
|
|
801
|
+
* @memberof CreateIntegrationBody
|
|
802
|
+
*/
|
|
803
|
+
'readme'?: string;
|
|
804
|
+
/**
|
|
805
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
806
|
+
* @type {string}
|
|
807
|
+
* @memberof CreateIntegrationBody
|
|
808
|
+
*/
|
|
809
|
+
'title'?: string;
|
|
810
|
+
/**
|
|
811
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
812
|
+
* @type {string}
|
|
813
|
+
* @memberof CreateIntegrationBody
|
|
814
|
+
*/
|
|
815
|
+
'description'?: string;
|
|
785
816
|
}
|
|
786
817
|
/**
|
|
787
818
|
*
|
|
@@ -1313,6 +1344,19 @@ export interface GetIntegrationByNameResponse {
|
|
|
1313
1344
|
*/
|
|
1314
1345
|
'integration': Integration;
|
|
1315
1346
|
}
|
|
1347
|
+
/**
|
|
1348
|
+
*
|
|
1349
|
+
* @export
|
|
1350
|
+
* @interface GetIntegrationLogsResponse
|
|
1351
|
+
*/
|
|
1352
|
+
export interface GetIntegrationLogsResponse {
|
|
1353
|
+
/**
|
|
1354
|
+
*
|
|
1355
|
+
* @type {Array<GetBotLogsResponseLogsInner>}
|
|
1356
|
+
* @memberof GetIntegrationLogsResponse
|
|
1357
|
+
*/
|
|
1358
|
+
'logs': Array<GetBotLogsResponseLogsInner>;
|
|
1359
|
+
}
|
|
1316
1360
|
/**
|
|
1317
1361
|
*
|
|
1318
1362
|
* @export
|
|
@@ -1419,6 +1463,12 @@ export interface GetOrCreateMessageBody {
|
|
|
1419
1463
|
'tags': {
|
|
1420
1464
|
[key: string]: string;
|
|
1421
1465
|
};
|
|
1466
|
+
/**
|
|
1467
|
+
*
|
|
1468
|
+
* @type {CreateMessageBodySchedule}
|
|
1469
|
+
* @memberof GetOrCreateMessageBody
|
|
1470
|
+
*/
|
|
1471
|
+
'schedule'?: CreateMessageBodySchedule;
|
|
1422
1472
|
}
|
|
1423
1473
|
/**
|
|
1424
1474
|
*
|
|
@@ -1519,6 +1569,61 @@ export interface GetUserResponse {
|
|
|
1519
1569
|
*/
|
|
1520
1570
|
'user': User;
|
|
1521
1571
|
}
|
|
1572
|
+
/**
|
|
1573
|
+
*
|
|
1574
|
+
* @export
|
|
1575
|
+
* @interface GetWorkspaceResponse
|
|
1576
|
+
*/
|
|
1577
|
+
export interface GetWorkspaceResponse {
|
|
1578
|
+
/**
|
|
1579
|
+
*
|
|
1580
|
+
* @type {string}
|
|
1581
|
+
* @memberof GetWorkspaceResponse
|
|
1582
|
+
*/
|
|
1583
|
+
'id': string;
|
|
1584
|
+
/**
|
|
1585
|
+
*
|
|
1586
|
+
* @type {string}
|
|
1587
|
+
* @memberof GetWorkspaceResponse
|
|
1588
|
+
*/
|
|
1589
|
+
'name': string;
|
|
1590
|
+
/**
|
|
1591
|
+
*
|
|
1592
|
+
* @type {string}
|
|
1593
|
+
* @memberof GetWorkspaceResponse
|
|
1594
|
+
*/
|
|
1595
|
+
'ownerId': string;
|
|
1596
|
+
/**
|
|
1597
|
+
*
|
|
1598
|
+
* @type {string}
|
|
1599
|
+
* @memberof GetWorkspaceResponse
|
|
1600
|
+
*/
|
|
1601
|
+
'createdAt': string;
|
|
1602
|
+
/**
|
|
1603
|
+
*
|
|
1604
|
+
* @type {string}
|
|
1605
|
+
* @memberof GetWorkspaceResponse
|
|
1606
|
+
*/
|
|
1607
|
+
'updatedAt': string;
|
|
1608
|
+
/**
|
|
1609
|
+
*
|
|
1610
|
+
* @type {string}
|
|
1611
|
+
* @memberof GetWorkspaceResponse
|
|
1612
|
+
*/
|
|
1613
|
+
'accountType': string;
|
|
1614
|
+
/**
|
|
1615
|
+
*
|
|
1616
|
+
* @type {boolean}
|
|
1617
|
+
* @memberof GetWorkspaceResponse
|
|
1618
|
+
*/
|
|
1619
|
+
'blocked': boolean;
|
|
1620
|
+
/**
|
|
1621
|
+
*
|
|
1622
|
+
* @type {number}
|
|
1623
|
+
* @memberof GetWorkspaceResponse
|
|
1624
|
+
*/
|
|
1625
|
+
'spendingLimit': number;
|
|
1626
|
+
}
|
|
1522
1627
|
/**
|
|
1523
1628
|
*
|
|
1524
1629
|
* @export
|
|
@@ -1605,6 +1710,30 @@ export interface Integration {
|
|
|
1605
1710
|
* @memberof Integration
|
|
1606
1711
|
*/
|
|
1607
1712
|
'dev': boolean;
|
|
1713
|
+
/**
|
|
1714
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
1715
|
+
* @type {string}
|
|
1716
|
+
* @memberof Integration
|
|
1717
|
+
*/
|
|
1718
|
+
'title': string;
|
|
1719
|
+
/**
|
|
1720
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
1721
|
+
* @type {string}
|
|
1722
|
+
* @memberof Integration
|
|
1723
|
+
*/
|
|
1724
|
+
'description': string;
|
|
1725
|
+
/**
|
|
1726
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
1727
|
+
* @type {string}
|
|
1728
|
+
* @memberof Integration
|
|
1729
|
+
*/
|
|
1730
|
+
'iconUrl': string;
|
|
1731
|
+
/**
|
|
1732
|
+
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
1733
|
+
* @type {string}
|
|
1734
|
+
* @memberof Integration
|
|
1735
|
+
*/
|
|
1736
|
+
'readmeUrl': string;
|
|
1608
1737
|
}
|
|
1609
1738
|
/**
|
|
1610
1739
|
*
|
|
@@ -1890,6 +2019,24 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
|
|
|
1890
2019
|
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
1891
2020
|
*/
|
|
1892
2021
|
'updatedAt': string;
|
|
2022
|
+
/**
|
|
2023
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
2024
|
+
* @type {string}
|
|
2025
|
+
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
2026
|
+
*/
|
|
2027
|
+
'title': string;
|
|
2028
|
+
/**
|
|
2029
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
2030
|
+
* @type {string}
|
|
2031
|
+
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
2032
|
+
*/
|
|
2033
|
+
'description': string;
|
|
2034
|
+
/**
|
|
2035
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
2036
|
+
* @type {string}
|
|
2037
|
+
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
2038
|
+
*/
|
|
2039
|
+
'iconUrl': string;
|
|
1893
2040
|
}
|
|
1894
2041
|
/**
|
|
1895
2042
|
*
|
|
@@ -2462,6 +2609,30 @@ export interface UpdateIntegrationBody {
|
|
|
2462
2609
|
* @memberof UpdateIntegrationBody
|
|
2463
2610
|
*/
|
|
2464
2611
|
'url'?: string;
|
|
2612
|
+
/**
|
|
2613
|
+
* Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
|
|
2614
|
+
* @type {string}
|
|
2615
|
+
* @memberof UpdateIntegrationBody
|
|
2616
|
+
*/
|
|
2617
|
+
'icon'?: string;
|
|
2618
|
+
/**
|
|
2619
|
+
* Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.
|
|
2620
|
+
* @type {string}
|
|
2621
|
+
* @memberof UpdateIntegrationBody
|
|
2622
|
+
*/
|
|
2623
|
+
'readme'?: string;
|
|
2624
|
+
/**
|
|
2625
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
2626
|
+
* @type {string}
|
|
2627
|
+
* @memberof UpdateIntegrationBody
|
|
2628
|
+
*/
|
|
2629
|
+
'title'?: string;
|
|
2630
|
+
/**
|
|
2631
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
2632
|
+
* @type {string}
|
|
2633
|
+
* @memberof UpdateIntegrationBody
|
|
2634
|
+
*/
|
|
2635
|
+
'description'?: string;
|
|
2465
2636
|
}
|
|
2466
2637
|
/**
|
|
2467
2638
|
*
|
|
@@ -2565,6 +2736,61 @@ export interface User {
|
|
|
2565
2736
|
[key: string]: string;
|
|
2566
2737
|
};
|
|
2567
2738
|
}
|
|
2739
|
+
/**
|
|
2740
|
+
*
|
|
2741
|
+
* @export
|
|
2742
|
+
* @interface Workspace
|
|
2743
|
+
*/
|
|
2744
|
+
export interface Workspace {
|
|
2745
|
+
/**
|
|
2746
|
+
*
|
|
2747
|
+
* @type {string}
|
|
2748
|
+
* @memberof Workspace
|
|
2749
|
+
*/
|
|
2750
|
+
'id': string;
|
|
2751
|
+
/**
|
|
2752
|
+
*
|
|
2753
|
+
* @type {string}
|
|
2754
|
+
* @memberof Workspace
|
|
2755
|
+
*/
|
|
2756
|
+
'name': string;
|
|
2757
|
+
/**
|
|
2758
|
+
*
|
|
2759
|
+
* @type {string}
|
|
2760
|
+
* @memberof Workspace
|
|
2761
|
+
*/
|
|
2762
|
+
'ownerId': string;
|
|
2763
|
+
/**
|
|
2764
|
+
*
|
|
2765
|
+
* @type {string}
|
|
2766
|
+
* @memberof Workspace
|
|
2767
|
+
*/
|
|
2768
|
+
'createdAt': string;
|
|
2769
|
+
/**
|
|
2770
|
+
*
|
|
2771
|
+
* @type {string}
|
|
2772
|
+
* @memberof Workspace
|
|
2773
|
+
*/
|
|
2774
|
+
'updatedAt': string;
|
|
2775
|
+
/**
|
|
2776
|
+
*
|
|
2777
|
+
* @type {string}
|
|
2778
|
+
* @memberof Workspace
|
|
2779
|
+
*/
|
|
2780
|
+
'accountType': string;
|
|
2781
|
+
/**
|
|
2782
|
+
*
|
|
2783
|
+
* @type {boolean}
|
|
2784
|
+
* @memberof Workspace
|
|
2785
|
+
*/
|
|
2786
|
+
'blocked': boolean;
|
|
2787
|
+
/**
|
|
2788
|
+
*
|
|
2789
|
+
* @type {number}
|
|
2790
|
+
* @memberof Workspace
|
|
2791
|
+
*/
|
|
2792
|
+
'spendingLimit': number;
|
|
2793
|
+
}
|
|
2568
2794
|
/**
|
|
2569
2795
|
* DefaultApi - axios parameter creator
|
|
2570
2796
|
* @export
|
|
@@ -2749,6 +2975,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2749
2975
|
* @throws {RequiredError}
|
|
2750
2976
|
*/
|
|
2751
2977
|
getIntegrationByName: (name: string, version: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2978
|
+
/**
|
|
2979
|
+
* Get integration logs
|
|
2980
|
+
* @param {string} id Integration Id
|
|
2981
|
+
* @param {*} [options] Override http request option.
|
|
2982
|
+
* @throws {RequiredError}
|
|
2983
|
+
*/
|
|
2984
|
+
getIntegrationLogs: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2752
2985
|
/**
|
|
2753
2986
|
* Retrieves the [Message](#schema_message) object for a valid identifier.
|
|
2754
2987
|
* @param {string} id Id of the Message
|
|
@@ -2808,6 +3041,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2808
3041
|
* @throws {RequiredError}
|
|
2809
3042
|
*/
|
|
2810
3043
|
getUser: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3044
|
+
/**
|
|
3045
|
+
* Get workspace details
|
|
3046
|
+
* @param {string} id Workspace ID
|
|
3047
|
+
* @param {*} [options] Override http request option.
|
|
3048
|
+
* @throws {RequiredError}
|
|
3049
|
+
*/
|
|
3050
|
+
getWorkspace: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2811
3051
|
/**
|
|
2812
3052
|
* Introspect the API
|
|
2813
3053
|
* @param {IntrospectBody} [introspectBody]
|
|
@@ -2836,10 +3076,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2836
3076
|
/**
|
|
2837
3077
|
* Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
2838
3078
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3079
|
+
* @param {string} [type] Filter by event type
|
|
2839
3080
|
* @param {*} [options] Override http request option.
|
|
2840
3081
|
* @throws {RequiredError}
|
|
2841
3082
|
*/
|
|
2842
|
-
listEvents: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3083
|
+
listEvents: (nextToken?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2843
3084
|
/**
|
|
2844
3085
|
* List Files
|
|
2845
3086
|
* @param {string} botId Bot ID
|
|
@@ -3148,6 +3389,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3148
3389
|
* @throws {RequiredError}
|
|
3149
3390
|
*/
|
|
3150
3391
|
getIntegrationByName(name: string, version: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationByNameResponse>>;
|
|
3392
|
+
/**
|
|
3393
|
+
* Get integration logs
|
|
3394
|
+
* @param {string} id Integration Id
|
|
3395
|
+
* @param {*} [options] Override http request option.
|
|
3396
|
+
* @throws {RequiredError}
|
|
3397
|
+
*/
|
|
3398
|
+
getIntegrationLogs(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIntegrationLogsResponse>>;
|
|
3151
3399
|
/**
|
|
3152
3400
|
* Retrieves the [Message](#schema_message) object for a valid identifier.
|
|
3153
3401
|
* @param {string} id Id of the Message
|
|
@@ -3207,6 +3455,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3207
3455
|
* @throws {RequiredError}
|
|
3208
3456
|
*/
|
|
3209
3457
|
getUser(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserResponse>>;
|
|
3458
|
+
/**
|
|
3459
|
+
* Get workspace details
|
|
3460
|
+
* @param {string} id Workspace ID
|
|
3461
|
+
* @param {*} [options] Override http request option.
|
|
3462
|
+
* @throws {RequiredError}
|
|
3463
|
+
*/
|
|
3464
|
+
getWorkspace(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWorkspaceResponse>>;
|
|
3210
3465
|
/**
|
|
3211
3466
|
* Introspect the API
|
|
3212
3467
|
* @param {IntrospectBody} [introspectBody]
|
|
@@ -3235,10 +3490,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3235
3490
|
/**
|
|
3236
3491
|
* Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
3237
3492
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3493
|
+
* @param {string} [type] Filter by event type
|
|
3238
3494
|
* @param {*} [options] Override http request option.
|
|
3239
3495
|
* @throws {RequiredError}
|
|
3240
3496
|
*/
|
|
3241
|
-
listEvents(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
|
|
3497
|
+
listEvents(nextToken?: string, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
|
|
3242
3498
|
/**
|
|
3243
3499
|
* List Files
|
|
3244
3500
|
* @param {string} botId Bot ID
|
|
@@ -3370,849 +3626,376 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3370
3626
|
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3371
3627
|
/**
|
|
3372
3628
|
* Call an action
|
|
3373
|
-
* @param {
|
|
3629
|
+
* @param {DefaultApiCallActionRequest} requestParameters Request parameters.
|
|
3374
3630
|
* @param {*} [options] Override http request option.
|
|
3375
3631
|
* @throws {RequiredError}
|
|
3376
3632
|
*/
|
|
3377
|
-
callAction(
|
|
3633
|
+
callAction(requestParameters?: DefaultApiCallActionRequest, options?: AxiosRequestConfig): AxiosPromise<CallActionResponse>;
|
|
3378
3634
|
/**
|
|
3379
3635
|
* An integration can call this endpoint to configure itself
|
|
3380
|
-
* @param {
|
|
3636
|
+
* @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
|
|
3381
3637
|
* @param {*} [options] Override http request option.
|
|
3382
3638
|
* @throws {RequiredError}
|
|
3383
3639
|
*/
|
|
3384
|
-
configureIntegration(
|
|
3640
|
+
configureIntegration(requestParameters?: DefaultApiConfigureIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3385
3641
|
/**
|
|
3386
3642
|
* Create bot
|
|
3387
|
-
* @param {
|
|
3643
|
+
* @param {DefaultApiCreateBotRequest} requestParameters Request parameters.
|
|
3388
3644
|
* @param {*} [options] Override http request option.
|
|
3389
3645
|
* @throws {RequiredError}
|
|
3390
3646
|
*/
|
|
3391
|
-
createBot(
|
|
3647
|
+
createBot(requestParameters?: DefaultApiCreateBotRequest, options?: AxiosRequestConfig): AxiosPromise<CreateBotResponse>;
|
|
3392
3648
|
/**
|
|
3393
3649
|
* Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details.
|
|
3394
|
-
* @param {
|
|
3650
|
+
* @param {DefaultApiCreateConversationRequest} requestParameters Request parameters.
|
|
3395
3651
|
* @param {*} [options] Override http request option.
|
|
3396
3652
|
* @throws {RequiredError}
|
|
3397
3653
|
*/
|
|
3398
|
-
createConversation(
|
|
3654
|
+
createConversation(requestParameters?: DefaultApiCreateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateConversationResponse>;
|
|
3399
3655
|
/**
|
|
3400
3656
|
* Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details.
|
|
3401
|
-
* @param {
|
|
3657
|
+
* @param {DefaultApiCreateEventRequest} requestParameters Request parameters.
|
|
3402
3658
|
* @param {*} [options] Override http request option.
|
|
3403
3659
|
* @throws {RequiredError}
|
|
3404
3660
|
*/
|
|
3405
|
-
createEvent(
|
|
3661
|
+
createEvent(requestParameters?: DefaultApiCreateEventRequest, options?: AxiosRequestConfig): AxiosPromise<CreateEventResponse>;
|
|
3406
3662
|
/**
|
|
3407
3663
|
* Create File
|
|
3408
|
-
* @param {
|
|
3664
|
+
* @param {DefaultApiCreateFileRequest} requestParameters Request parameters.
|
|
3409
3665
|
* @param {*} [options] Override http request option.
|
|
3410
3666
|
* @throws {RequiredError}
|
|
3411
3667
|
*/
|
|
3412
|
-
createFile(
|
|
3668
|
+
createFile(requestParameters?: DefaultApiCreateFileRequest, options?: AxiosRequestConfig): AxiosPromise<CreateFileResponse>;
|
|
3413
3669
|
/**
|
|
3414
3670
|
* Create integration
|
|
3415
|
-
* @param {
|
|
3671
|
+
* @param {DefaultApiCreateIntegrationRequest} requestParameters Request parameters.
|
|
3416
3672
|
* @param {*} [options] Override http request option.
|
|
3417
3673
|
* @throws {RequiredError}
|
|
3418
3674
|
*/
|
|
3419
|
-
createIntegration(
|
|
3675
|
+
createIntegration(requestParameters?: DefaultApiCreateIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateIntegrationResponse>;
|
|
3420
3676
|
/**
|
|
3421
3677
|
* Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details.
|
|
3422
|
-
* @param {
|
|
3678
|
+
* @param {DefaultApiCreateMessageRequest} requestParameters Request parameters.
|
|
3423
3679
|
* @param {*} [options] Override http request option.
|
|
3424
3680
|
* @throws {RequiredError}
|
|
3425
3681
|
*/
|
|
3426
|
-
createMessage(
|
|
3682
|
+
createMessage(requestParameters?: DefaultApiCreateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<CreateMessageResponse>;
|
|
3427
3683
|
/**
|
|
3428
3684
|
* 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.
|
|
3429
|
-
* @param {
|
|
3685
|
+
* @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
|
|
3430
3686
|
* @param {*} [options] Override http request option.
|
|
3431
3687
|
* @throws {RequiredError}
|
|
3432
3688
|
*/
|
|
3433
|
-
createUser(
|
|
3689
|
+
createUser(requestParameters?: DefaultApiCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<CreateUserResponse>;
|
|
3434
3690
|
/**
|
|
3435
3691
|
* Delete bot
|
|
3436
|
-
* @param {
|
|
3692
|
+
* @param {DefaultApiDeleteBotRequest} requestParameters Request parameters.
|
|
3437
3693
|
* @param {*} [options] Override http request option.
|
|
3438
3694
|
* @throws {RequiredError}
|
|
3439
3695
|
*/
|
|
3440
|
-
deleteBot(
|
|
3696
|
+
deleteBot(requestParameters: DefaultApiDeleteBotRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3441
3697
|
/**
|
|
3442
3698
|
* Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
|
|
3443
|
-
* @param {
|
|
3699
|
+
* @param {DefaultApiDeleteConversationRequest} requestParameters Request parameters.
|
|
3444
3700
|
* @param {*} [options] Override http request option.
|
|
3445
3701
|
* @throws {RequiredError}
|
|
3446
3702
|
*/
|
|
3447
|
-
deleteConversation(
|
|
3703
|
+
deleteConversation(requestParameters: DefaultApiDeleteConversationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3448
3704
|
/**
|
|
3449
3705
|
* Delete File
|
|
3450
|
-
* @param {
|
|
3706
|
+
* @param {DefaultApiDeleteFileRequest} requestParameters Request parameters.
|
|
3451
3707
|
* @param {*} [options] Override http request option.
|
|
3452
3708
|
* @throws {RequiredError}
|
|
3453
3709
|
*/
|
|
3454
|
-
deleteFile(
|
|
3710
|
+
deleteFile(requestParameters: DefaultApiDeleteFileRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3455
3711
|
/**
|
|
3456
3712
|
* Delete integration
|
|
3457
|
-
* @param {
|
|
3713
|
+
* @param {DefaultApiDeleteIntegrationRequest} requestParameters Request parameters.
|
|
3458
3714
|
* @param {*} [options] Override http request option.
|
|
3459
3715
|
* @throws {RequiredError}
|
|
3460
3716
|
*/
|
|
3461
|
-
deleteIntegration(
|
|
3717
|
+
deleteIntegration(requestParameters: DefaultApiDeleteIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3462
3718
|
/**
|
|
3463
3719
|
* Permanently deletes a [Message](#schema_message). It cannot be undone.
|
|
3464
|
-
* @param {
|
|
3720
|
+
* @param {DefaultApiDeleteMessageRequest} requestParameters Request parameters.
|
|
3465
3721
|
* @param {*} [options] Override http request option.
|
|
3466
3722
|
* @throws {RequiredError}
|
|
3467
3723
|
*/
|
|
3468
|
-
deleteMessage(
|
|
3724
|
+
deleteMessage(requestParameters: DefaultApiDeleteMessageRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3469
3725
|
/**
|
|
3470
3726
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
3471
|
-
* @param {
|
|
3727
|
+
* @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
|
|
3472
3728
|
* @param {*} [options] Override http request option.
|
|
3473
3729
|
* @throws {RequiredError}
|
|
3474
3730
|
*/
|
|
3475
|
-
deleteUser(
|
|
3731
|
+
deleteUser(requestParameters: DefaultApiDeleteUserRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3476
3732
|
/**
|
|
3477
3733
|
* Download File
|
|
3478
|
-
* @param {
|
|
3734
|
+
* @param {DefaultApiDownloadFileRequest} requestParameters Request parameters.
|
|
3479
3735
|
* @param {*} [options] Override http request option.
|
|
3480
3736
|
* @throws {RequiredError}
|
|
3481
3737
|
*/
|
|
3482
|
-
downloadFile(
|
|
3738
|
+
downloadFile(requestParameters: DefaultApiDownloadFileRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
|
|
3483
3739
|
/**
|
|
3484
3740
|
* Get bot details
|
|
3485
|
-
* @param {
|
|
3741
|
+
* @param {DefaultApiGetBotRequest} requestParameters Request parameters.
|
|
3486
3742
|
* @param {*} [options] Override http request option.
|
|
3487
3743
|
* @throws {RequiredError}
|
|
3488
3744
|
*/
|
|
3489
|
-
getBot(
|
|
3745
|
+
getBot(requestParameters: DefaultApiGetBotRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotResponse>;
|
|
3490
3746
|
/**
|
|
3491
3747
|
* Get bot analytics
|
|
3492
|
-
* @param {
|
|
3493
|
-
* @param {string} startDate Start date/time (inclusive)
|
|
3494
|
-
* @param {string} endDate End date/time (exclusive)
|
|
3748
|
+
* @param {DefaultApiGetBotAnalyticsRequest} requestParameters Request parameters.
|
|
3495
3749
|
* @param {*} [options] Override http request option.
|
|
3496
3750
|
* @throws {RequiredError}
|
|
3497
3751
|
*/
|
|
3498
|
-
getBotAnalytics(
|
|
3752
|
+
getBotAnalytics(requestParameters: DefaultApiGetBotAnalyticsRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotAnalyticsResponse>;
|
|
3499
3753
|
/**
|
|
3500
3754
|
* Get bot logs
|
|
3501
|
-
* @param {
|
|
3755
|
+
* @param {DefaultApiGetBotLogsRequest} requestParameters Request parameters.
|
|
3502
3756
|
* @param {*} [options] Override http request option.
|
|
3503
3757
|
* @throws {RequiredError}
|
|
3504
3758
|
*/
|
|
3505
|
-
getBotLogs(
|
|
3759
|
+
getBotLogs(requestParameters: DefaultApiGetBotLogsRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotLogsResponse>;
|
|
3506
3760
|
/**
|
|
3507
3761
|
* Get the webchat code/URL for a bot
|
|
3508
|
-
* @param {
|
|
3509
|
-
* @param {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'} type type of script to get
|
|
3762
|
+
* @param {DefaultApiGetBotWebchatRequest} requestParameters Request parameters.
|
|
3510
3763
|
* @param {*} [options] Override http request option.
|
|
3511
3764
|
* @throws {RequiredError}
|
|
3512
3765
|
*/
|
|
3513
|
-
getBotWebchat(
|
|
3766
|
+
getBotWebchat(requestParameters: DefaultApiGetBotWebchatRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotWebchatResponse>;
|
|
3514
3767
|
/**
|
|
3515
3768
|
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
|
|
3516
|
-
* @param {
|
|
3769
|
+
* @param {DefaultApiGetConversationRequest} requestParameters Request parameters.
|
|
3517
3770
|
* @param {*} [options] Override http request option.
|
|
3518
3771
|
* @throws {RequiredError}
|
|
3519
3772
|
*/
|
|
3520
|
-
getConversation(
|
|
3773
|
+
getConversation(requestParameters: DefaultApiGetConversationRequest, options?: AxiosRequestConfig): AxiosPromise<GetConversationResponse>;
|
|
3521
3774
|
/**
|
|
3522
3775
|
* Retrieves the [Event](#schema_event) object for a valid identifiers.
|
|
3523
|
-
* @param {
|
|
3776
|
+
* @param {DefaultApiGetEventRequest} requestParameters Request parameters.
|
|
3524
3777
|
* @param {*} [options] Override http request option.
|
|
3525
3778
|
* @throws {RequiredError}
|
|
3526
3779
|
*/
|
|
3527
|
-
getEvent(
|
|
3780
|
+
getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
|
|
3528
3781
|
/**
|
|
3529
3782
|
* Get File
|
|
3530
|
-
* @param {
|
|
3783
|
+
* @param {DefaultApiGetFileRequest} requestParameters Request parameters.
|
|
3531
3784
|
* @param {*} [options] Override http request option.
|
|
3532
3785
|
* @throws {RequiredError}
|
|
3533
3786
|
*/
|
|
3534
|
-
getFile(
|
|
3787
|
+
getFile(requestParameters: DefaultApiGetFileRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileResponse>;
|
|
3535
3788
|
/**
|
|
3536
3789
|
* Get integration
|
|
3537
|
-
* @param {
|
|
3790
|
+
* @param {DefaultApiGetIntegrationRequest} requestParameters Request parameters.
|
|
3538
3791
|
* @param {*} [options] Override http request option.
|
|
3539
3792
|
* @throws {RequiredError}
|
|
3540
3793
|
*/
|
|
3541
|
-
getIntegration(
|
|
3794
|
+
getIntegration(requestParameters: DefaultApiGetIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationResponse>;
|
|
3542
3795
|
/**
|
|
3543
3796
|
* Get integration
|
|
3544
|
-
* @param {
|
|
3545
|
-
* @param {
|
|
3797
|
+
* @param {DefaultApiGetIntegrationByNameRequest} requestParameters Request parameters.
|
|
3798
|
+
* @param {*} [options] Override http request option.
|
|
3799
|
+
* @throws {RequiredError}
|
|
3800
|
+
*/
|
|
3801
|
+
getIntegrationByName(requestParameters: DefaultApiGetIntegrationByNameRequest, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationByNameResponse>;
|
|
3802
|
+
/**
|
|
3803
|
+
* Get integration logs
|
|
3804
|
+
* @param {DefaultApiGetIntegrationLogsRequest} requestParameters Request parameters.
|
|
3546
3805
|
* @param {*} [options] Override http request option.
|
|
3547
3806
|
* @throws {RequiredError}
|
|
3548
3807
|
*/
|
|
3549
|
-
|
|
3808
|
+
getIntegrationLogs(requestParameters: DefaultApiGetIntegrationLogsRequest, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationLogsResponse>;
|
|
3550
3809
|
/**
|
|
3551
3810
|
* Retrieves the [Message](#schema_message) object for a valid identifier.
|
|
3552
|
-
* @param {
|
|
3811
|
+
* @param {DefaultApiGetMessageRequest} requestParameters Request parameters.
|
|
3553
3812
|
* @param {*} [options] Override http request option.
|
|
3554
3813
|
* @throws {RequiredError}
|
|
3555
3814
|
*/
|
|
3556
|
-
getMessage(
|
|
3815
|
+
getMessage(requestParameters: DefaultApiGetMessageRequest, options?: AxiosRequestConfig): AxiosPromise<GetMessageResponse>;
|
|
3557
3816
|
/**
|
|
3558
3817
|
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier. If the conversation does not exist, it will be created.
|
|
3559
|
-
* @param {
|
|
3818
|
+
* @param {DefaultApiGetOrCreateConversationRequest} requestParameters Request parameters.
|
|
3560
3819
|
* @param {*} [options] Override http request option.
|
|
3561
3820
|
* @throws {RequiredError}
|
|
3562
3821
|
*/
|
|
3563
|
-
getOrCreateConversation(
|
|
3822
|
+
getOrCreateConversation(requestParameters?: DefaultApiGetOrCreateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateConversationResponse>;
|
|
3564
3823
|
/**
|
|
3565
3824
|
* Retrieves the [Message](#schema_message) object for a valid identifier. If the message does not exist, it will be created.
|
|
3566
|
-
* @param {
|
|
3825
|
+
* @param {DefaultApiGetOrCreateMessageRequest} requestParameters Request parameters.
|
|
3567
3826
|
* @param {*} [options] Override http request option.
|
|
3568
3827
|
* @throws {RequiredError}
|
|
3569
3828
|
*/
|
|
3570
|
-
getOrCreateMessage(
|
|
3829
|
+
getOrCreateMessage(requestParameters?: DefaultApiGetOrCreateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateMessageResponse>;
|
|
3571
3830
|
/**
|
|
3572
3831
|
* Retrieves the [User](#schema_user) object for a valid identifier. If the user does not exist, it will be created.
|
|
3573
|
-
* @param {
|
|
3832
|
+
* @param {DefaultApiGetOrCreateUserRequest} requestParameters Request parameters.
|
|
3574
3833
|
* @param {*} [options] Override http request option.
|
|
3575
3834
|
* @throws {RequiredError}
|
|
3576
3835
|
*/
|
|
3577
|
-
getOrCreateUser(
|
|
3836
|
+
getOrCreateUser(requestParameters?: DefaultApiGetOrCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateUserResponse>;
|
|
3578
3837
|
/**
|
|
3579
3838
|
* Get public integration by name and version
|
|
3580
|
-
* @param {
|
|
3581
|
-
* @param {string} version Integration version. Either a semver version or tag \"latest\"
|
|
3839
|
+
* @param {DefaultApiGetPublicIntegrationRequest} requestParameters Request parameters.
|
|
3582
3840
|
* @param {*} [options] Override http request option.
|
|
3583
3841
|
* @throws {RequiredError}
|
|
3584
3842
|
*/
|
|
3585
|
-
getPublicIntegration(
|
|
3843
|
+
getPublicIntegration(requestParameters: DefaultApiGetPublicIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationResponse>;
|
|
3586
3844
|
/**
|
|
3587
3845
|
* Get public integration by Id
|
|
3588
|
-
* @param {
|
|
3846
|
+
* @param {DefaultApiGetPublicIntegrationByIdRequest} requestParameters Request parameters.
|
|
3589
3847
|
* @param {*} [options] Override http request option.
|
|
3590
3848
|
* @throws {RequiredError}
|
|
3591
3849
|
*/
|
|
3592
|
-
getPublicIntegrationById(
|
|
3850
|
+
getPublicIntegrationById(requestParameters: DefaultApiGetPublicIntegrationByIdRequest, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationByIdResponse>;
|
|
3593
3851
|
/**
|
|
3594
3852
|
* Retrieves the [State](#schema_state) object for a valid identifiers.
|
|
3595
|
-
* @param {
|
|
3596
|
-
* @param {string} id State id
|
|
3597
|
-
* @param {string} name State name
|
|
3853
|
+
* @param {DefaultApiGetStateRequest} requestParameters Request parameters.
|
|
3598
3854
|
* @param {*} [options] Override http request option.
|
|
3599
3855
|
* @throws {RequiredError}
|
|
3600
3856
|
*/
|
|
3601
|
-
getState(
|
|
3857
|
+
getState(requestParameters: DefaultApiGetStateRequest, options?: AxiosRequestConfig): AxiosPromise<GetStateResponse>;
|
|
3602
3858
|
/**
|
|
3603
3859
|
* Retrieves the [User](#schema_user) object for a valid identifier.
|
|
3604
|
-
* @param {
|
|
3605
|
-
* @param {*} [options] Override http request option.
|
|
3606
|
-
* @throws {RequiredError}
|
|
3607
|
-
*/
|
|
3608
|
-
getUser(id: string, options?: any): AxiosPromise<GetUserResponse>;
|
|
3609
|
-
/**
|
|
3610
|
-
* Introspect the API
|
|
3611
|
-
* @param {IntrospectBody} [introspectBody]
|
|
3612
|
-
* @param {*} [options] Override http request option.
|
|
3613
|
-
* @throws {RequiredError}
|
|
3614
|
-
*/
|
|
3615
|
-
introspect(introspectBody?: IntrospectBody, options?: any): AxiosPromise<IntrospectResponse>;
|
|
3616
|
-
/**
|
|
3617
|
-
* List bots
|
|
3618
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3619
|
-
* @param {*} [options] Override http request option.
|
|
3620
|
-
* @throws {RequiredError}
|
|
3621
|
-
*/
|
|
3622
|
-
listBots(nextToken?: string, options?: any): AxiosPromise<ListBotsResponse>;
|
|
3623
|
-
/**
|
|
3624
|
-
* Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3625
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3626
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
3627
|
-
* @param {Array<string>} [participantIds] Filter by participant ids
|
|
3628
|
-
* @param {*} [options] Override http request option.
|
|
3629
|
-
* @throws {RequiredError}
|
|
3630
|
-
*/
|
|
3631
|
-
listConversations(nextToken?: string, tags?: {
|
|
3632
|
-
[key: string]: string;
|
|
3633
|
-
} | undefined, participantIds?: Array<string>, options?: any): AxiosPromise<ListConversationsResponse>;
|
|
3634
|
-
/**
|
|
3635
|
-
* Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
3636
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3637
|
-
* @param {*} [options] Override http request option.
|
|
3638
|
-
* @throws {RequiredError}
|
|
3639
|
-
*/
|
|
3640
|
-
listEvents(nextToken?: string, options?: any): AxiosPromise<ListEventsResponse>;
|
|
3641
|
-
/**
|
|
3642
|
-
* List Files
|
|
3643
|
-
* @param {string} botId Bot ID
|
|
3644
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3645
|
-
* @param {*} [options] Override http request option.
|
|
3646
|
-
* @throws {RequiredError}
|
|
3647
|
-
*/
|
|
3648
|
-
listFiles(botId: string, nextToken?: string, options?: any): AxiosPromise<ListFilesResponse>;
|
|
3649
|
-
/**
|
|
3650
|
-
* List integrations
|
|
3651
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3652
|
-
* @param {string} [name] Integration Name
|
|
3653
|
-
* @param {string} [version] Integration version. Either a semver version or tag \"latest\"
|
|
3654
|
-
* @param {*} [options] Override http request option.
|
|
3655
|
-
* @throws {RequiredError}
|
|
3656
|
-
*/
|
|
3657
|
-
listIntegrations(nextToken?: string, name?: string, version?: string, options?: any): AxiosPromise<ListIntegrationsResponse>;
|
|
3658
|
-
/**
|
|
3659
|
-
* Retrieves a list of [Messages](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
3660
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3661
|
-
* @param {string} [conversationId] Conversation id
|
|
3662
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
3663
|
-
* @param {*} [options] Override http request option.
|
|
3664
|
-
* @throws {RequiredError}
|
|
3665
|
-
*/
|
|
3666
|
-
listMessages(nextToken?: string, conversationId?: string, tags?: {
|
|
3667
|
-
[key: string]: string;
|
|
3668
|
-
} | undefined, options?: any): AxiosPromise<ListMessagesResponse>;
|
|
3669
|
-
/**
|
|
3670
|
-
* List public integration
|
|
3671
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3672
|
-
* @param {string} [name] Integration Name
|
|
3673
|
-
* @param {string} [version] Integration version. Either a semver version or tag \"latest\"
|
|
3674
|
-
* @param {*} [options] Override http request option.
|
|
3675
|
-
* @throws {RequiredError}
|
|
3676
|
-
*/
|
|
3677
|
-
listPublicIntegrations(nextToken?: string, name?: string, version?: string, options?: any): AxiosPromise<ListPublicIntegrationsResponse>;
|
|
3678
|
-
/**
|
|
3679
|
-
* 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).
|
|
3680
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3681
|
-
* @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
|
|
3682
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
3683
|
-
* @param {*} [options] Override http request option.
|
|
3684
|
-
* @throws {RequiredError}
|
|
3685
|
-
*/
|
|
3686
|
-
listUsers(nextToken?: string, conversationId?: string, tags?: {
|
|
3687
|
-
[key: string]: string;
|
|
3688
|
-
} | undefined, options?: any): AxiosPromise<ListUsersResponse>;
|
|
3689
|
-
/**
|
|
3690
|
-
* List workspaces the user has access to
|
|
3691
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3692
|
-
* @param {*} [options] Override http request option.
|
|
3693
|
-
* @throws {RequiredError}
|
|
3694
|
-
*/
|
|
3695
|
-
listWorkspaces(nextToken?: string, options?: any): AxiosPromise<ListWorkspacesResponse>;
|
|
3696
|
-
/**
|
|
3697
|
-
* Updates the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3698
|
-
* @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
|
|
3699
|
-
* @param {string} id State id
|
|
3700
|
-
* @param {string} name State name
|
|
3701
|
-
* @param {PatchStateBody} [patchStateBody] State content
|
|
3702
|
-
* @param {*} [options] Override http request option.
|
|
3703
|
-
* @throws {RequiredError}
|
|
3704
|
-
*/
|
|
3705
|
-
patchState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, patchStateBody?: PatchStateBody, options?: any): AxiosPromise<PatchStateResponse>;
|
|
3706
|
-
/**
|
|
3707
|
-
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
3708
|
-
* @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
|
|
3709
|
-
* @param {string} id State id
|
|
3710
|
-
* @param {string} name State name
|
|
3711
|
-
* @param {SetStateBody} [setStateBody] State content
|
|
3712
|
-
* @param {*} [options] Override http request option.
|
|
3713
|
-
* @throws {RequiredError}
|
|
3714
|
-
*/
|
|
3715
|
-
setState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, setStateBody?: SetStateBody, options?: any): AxiosPromise<SetStateResponse>;
|
|
3716
|
-
/**
|
|
3717
|
-
* Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
|
|
3718
|
-
* @param {string} id Bot ID
|
|
3719
|
-
* @param {TransferBotBody} [transferBotBody] Bot transfer request
|
|
3720
|
-
* @param {*} [options] Override http request option.
|
|
3721
|
-
* @throws {RequiredError}
|
|
3722
|
-
*/
|
|
3723
|
-
transferBot(id: string, transferBotBody?: TransferBotBody, options?: any): AxiosPromise<object>;
|
|
3724
|
-
/**
|
|
3725
|
-
* Update bot
|
|
3726
|
-
* @param {string} id Bot ID
|
|
3727
|
-
* @param {UpdateBotBody} [updateBotBody] Bot metadata
|
|
3728
|
-
* @param {*} [options] Override http request option.
|
|
3729
|
-
* @throws {RequiredError}
|
|
3730
|
-
*/
|
|
3731
|
-
updateBot(id: string, updateBotBody?: UpdateBotBody, options?: any): AxiosPromise<UpdateBotResponse>;
|
|
3732
|
-
/**
|
|
3733
|
-
* Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
3734
|
-
* @param {string} id Conversation id
|
|
3735
|
-
* @param {UpdateConversationBody} [updateConversationBody] Conversation data
|
|
3736
|
-
* @param {*} [options] Override http request option.
|
|
3737
|
-
* @throws {RequiredError}
|
|
3738
|
-
*/
|
|
3739
|
-
updateConversation(id: string, updateConversationBody?: UpdateConversationBody, options?: any): AxiosPromise<UpdateConversationResponse>;
|
|
3740
|
-
/**
|
|
3741
|
-
* Update integration
|
|
3742
|
-
* @param {string} id Integration Id
|
|
3743
|
-
* @param {UpdateIntegrationBody} [updateIntegrationBody] Integration
|
|
3744
|
-
* @param {*} [options] Override http request option.
|
|
3745
|
-
* @throws {RequiredError}
|
|
3746
|
-
*/
|
|
3747
|
-
updateIntegration(id: string, updateIntegrationBody?: UpdateIntegrationBody, options?: any): AxiosPromise<UpdateIntegrationResponse>;
|
|
3748
|
-
/**
|
|
3749
|
-
* Update a message
|
|
3750
|
-
* @param {string} id Message id
|
|
3751
|
-
* @param {UpdateMessageBody} [updateMessageBody] Message data
|
|
3752
|
-
* @param {*} [options] Override http request option.
|
|
3753
|
-
* @throws {RequiredError}
|
|
3754
|
-
*/
|
|
3755
|
-
updateMessage(id: string, updateMessageBody?: UpdateMessageBody, options?: any): AxiosPromise<UpdateMessageResponse>;
|
|
3756
|
-
/**
|
|
3757
|
-
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
3758
|
-
* @param {string} id User ID
|
|
3759
|
-
* @param {UpdateUserBody} [updateUserBody] User data
|
|
3760
|
-
* @param {*} [options] Override http request option.
|
|
3761
|
-
* @throws {RequiredError}
|
|
3762
|
-
*/
|
|
3763
|
-
updateUser(id: string, updateUserBody?: UpdateUserBody, options?: any): AxiosPromise<UpdateUserResponse>;
|
|
3764
|
-
};
|
|
3765
|
-
/**
|
|
3766
|
-
* DefaultApi - interface
|
|
3767
|
-
* @export
|
|
3768
|
-
* @interface DefaultApi
|
|
3769
|
-
*/
|
|
3770
|
-
export interface DefaultApiInterface {
|
|
3771
|
-
/**
|
|
3772
|
-
* Call an action
|
|
3773
|
-
* @param {CallActionBody} [callActionBody] Action payload
|
|
3774
|
-
* @param {*} [options] Override http request option.
|
|
3775
|
-
* @throws {RequiredError}
|
|
3776
|
-
* @memberof DefaultApiInterface
|
|
3777
|
-
*/
|
|
3778
|
-
callAction(callActionBody?: CallActionBody, options?: AxiosRequestConfig): AxiosPromise<CallActionResponse>;
|
|
3779
|
-
/**
|
|
3780
|
-
* An integration can call this endpoint to configure itself
|
|
3781
|
-
* @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
|
|
3782
|
-
* @param {*} [options] Override http request option.
|
|
3783
|
-
* @throws {RequiredError}
|
|
3784
|
-
* @memberof DefaultApiInterface
|
|
3785
|
-
*/
|
|
3786
|
-
configureIntegration(configureIntegrationBody?: ConfigureIntegrationBody, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3787
|
-
/**
|
|
3788
|
-
* Create bot
|
|
3789
|
-
* @param {CreateBotBody} [createBotBody] Bot metadata
|
|
3790
|
-
* @param {*} [options] Override http request option.
|
|
3791
|
-
* @throws {RequiredError}
|
|
3792
|
-
* @memberof DefaultApiInterface
|
|
3793
|
-
*/
|
|
3794
|
-
createBot(createBotBody?: CreateBotBody, options?: AxiosRequestConfig): AxiosPromise<CreateBotResponse>;
|
|
3795
|
-
/**
|
|
3796
|
-
* Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details.
|
|
3797
|
-
* @param {CreateConversationBody} [createConversationBody] Conversation data
|
|
3798
|
-
* @param {*} [options] Override http request option.
|
|
3799
|
-
* @throws {RequiredError}
|
|
3800
|
-
* @memberof DefaultApiInterface
|
|
3801
|
-
*/
|
|
3802
|
-
createConversation(createConversationBody?: CreateConversationBody, options?: AxiosRequestConfig): AxiosPromise<CreateConversationResponse>;
|
|
3803
|
-
/**
|
|
3804
|
-
* Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details.
|
|
3805
|
-
* @param {CreateEventBody} [createEventBody] Event data
|
|
3806
|
-
* @param {*} [options] Override http request option.
|
|
3807
|
-
* @throws {RequiredError}
|
|
3808
|
-
* @memberof DefaultApiInterface
|
|
3809
|
-
*/
|
|
3810
|
-
createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): AxiosPromise<CreateEventResponse>;
|
|
3811
|
-
/**
|
|
3812
|
-
* Create File
|
|
3813
|
-
* @param {CreateFileBody} [createFileBody] Create File
|
|
3814
|
-
* @param {*} [options] Override http request option.
|
|
3815
|
-
* @throws {RequiredError}
|
|
3816
|
-
* @memberof DefaultApiInterface
|
|
3817
|
-
*/
|
|
3818
|
-
createFile(createFileBody?: CreateFileBody, options?: AxiosRequestConfig): AxiosPromise<CreateFileResponse>;
|
|
3819
|
-
/**
|
|
3820
|
-
* Create integration
|
|
3821
|
-
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
3822
|
-
* @param {*} [options] Override http request option.
|
|
3823
|
-
* @throws {RequiredError}
|
|
3824
|
-
* @memberof DefaultApiInterface
|
|
3825
|
-
*/
|
|
3826
|
-
createIntegration(createIntegrationBody?: CreateIntegrationBody, options?: AxiosRequestConfig): AxiosPromise<CreateIntegrationResponse>;
|
|
3827
|
-
/**
|
|
3828
|
-
* Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details.
|
|
3829
|
-
* @param {CreateMessageBody} [createMessageBody] Message data
|
|
3830
|
-
* @param {*} [options] Override http request option.
|
|
3831
|
-
* @throws {RequiredError}
|
|
3832
|
-
* @memberof DefaultApiInterface
|
|
3833
|
-
*/
|
|
3834
|
-
createMessage(createMessageBody?: CreateMessageBody, options?: AxiosRequestConfig): AxiosPromise<CreateMessageResponse>;
|
|
3835
|
-
/**
|
|
3836
|
-
* 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.
|
|
3837
|
-
* @param {CreateUserBody} [createUserBody] User data
|
|
3838
|
-
* @param {*} [options] Override http request option.
|
|
3839
|
-
* @throws {RequiredError}
|
|
3840
|
-
* @memberof DefaultApiInterface
|
|
3841
|
-
*/
|
|
3842
|
-
createUser(createUserBody?: CreateUserBody, options?: AxiosRequestConfig): AxiosPromise<CreateUserResponse>;
|
|
3843
|
-
/**
|
|
3844
|
-
* Delete bot
|
|
3845
|
-
* @param {string} id Bot ID
|
|
3846
|
-
* @param {*} [options] Override http request option.
|
|
3847
|
-
* @throws {RequiredError}
|
|
3848
|
-
* @memberof DefaultApiInterface
|
|
3849
|
-
*/
|
|
3850
|
-
deleteBot(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3851
|
-
/**
|
|
3852
|
-
* Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
|
|
3853
|
-
* @param {string} id Conversation id
|
|
3854
|
-
* @param {*} [options] Override http request option.
|
|
3855
|
-
* @throws {RequiredError}
|
|
3856
|
-
* @memberof DefaultApiInterface
|
|
3857
|
-
*/
|
|
3858
|
-
deleteConversation(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3859
|
-
/**
|
|
3860
|
-
* Delete File
|
|
3861
|
-
* @param {string} id File ID
|
|
3862
|
-
* @param {*} [options] Override http request option.
|
|
3863
|
-
* @throws {RequiredError}
|
|
3864
|
-
* @memberof DefaultApiInterface
|
|
3865
|
-
*/
|
|
3866
|
-
deleteFile(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3867
|
-
/**
|
|
3868
|
-
* Delete integration
|
|
3869
|
-
* @param {string} id Integration Id
|
|
3870
|
-
* @param {*} [options] Override http request option.
|
|
3871
|
-
* @throws {RequiredError}
|
|
3872
|
-
* @memberof DefaultApiInterface
|
|
3873
|
-
*/
|
|
3874
|
-
deleteIntegration(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3875
|
-
/**
|
|
3876
|
-
* Permanently deletes a [Message](#schema_message). It cannot be undone.
|
|
3877
|
-
* @param {string} id Message id
|
|
3878
|
-
* @param {*} [options] Override http request option.
|
|
3879
|
-
* @throws {RequiredError}
|
|
3880
|
-
* @memberof DefaultApiInterface
|
|
3881
|
-
*/
|
|
3882
|
-
deleteMessage(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3883
|
-
/**
|
|
3884
|
-
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
3885
|
-
* @param {string} id User ID
|
|
3886
|
-
* @param {*} [options] Override http request option.
|
|
3887
|
-
* @throws {RequiredError}
|
|
3888
|
-
* @memberof DefaultApiInterface
|
|
3889
|
-
*/
|
|
3890
|
-
deleteUser(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
3891
|
-
/**
|
|
3892
|
-
* Download File
|
|
3893
|
-
* @param {string} id File ID
|
|
3894
|
-
* @param {*} [options] Override http request option.
|
|
3895
|
-
* @throws {RequiredError}
|
|
3896
|
-
* @memberof DefaultApiInterface
|
|
3897
|
-
*/
|
|
3898
|
-
downloadFile(id: string, options?: AxiosRequestConfig): AxiosPromise<any>;
|
|
3899
|
-
/**
|
|
3900
|
-
* Get bot details
|
|
3901
|
-
* @param {string} id Bot ID
|
|
3902
|
-
* @param {*} [options] Override http request option.
|
|
3903
|
-
* @throws {RequiredError}
|
|
3904
|
-
* @memberof DefaultApiInterface
|
|
3905
|
-
*/
|
|
3906
|
-
getBot(id: string, options?: AxiosRequestConfig): AxiosPromise<GetBotResponse>;
|
|
3907
|
-
/**
|
|
3908
|
-
* Get bot analytics
|
|
3909
|
-
* @param {string} id Bot ID
|
|
3910
|
-
* @param {string} startDate Start date/time (inclusive)
|
|
3911
|
-
* @param {string} endDate End date/time (exclusive)
|
|
3912
|
-
* @param {*} [options] Override http request option.
|
|
3913
|
-
* @throws {RequiredError}
|
|
3914
|
-
* @memberof DefaultApiInterface
|
|
3915
|
-
*/
|
|
3916
|
-
getBotAnalytics(id: string, startDate: string, endDate: string, options?: AxiosRequestConfig): AxiosPromise<GetBotAnalyticsResponse>;
|
|
3917
|
-
/**
|
|
3918
|
-
* Get bot logs
|
|
3919
|
-
* @param {string} id Bot ID
|
|
3920
|
-
* @param {*} [options] Override http request option.
|
|
3921
|
-
* @throws {RequiredError}
|
|
3922
|
-
* @memberof DefaultApiInterface
|
|
3923
|
-
*/
|
|
3924
|
-
getBotLogs(id: string, options?: AxiosRequestConfig): AxiosPromise<GetBotLogsResponse>;
|
|
3925
|
-
/**
|
|
3926
|
-
* Get the webchat code/URL for a bot
|
|
3927
|
-
* @param {string} id Bot ID
|
|
3928
|
-
* @param {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'} type type of script to get
|
|
3929
|
-
* @param {*} [options] Override http request option.
|
|
3930
|
-
* @throws {RequiredError}
|
|
3931
|
-
* @memberof DefaultApiInterface
|
|
3932
|
-
*/
|
|
3933
|
-
getBotWebchat(id: string, type: 'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl', options?: AxiosRequestConfig): AxiosPromise<GetBotWebchatResponse>;
|
|
3934
|
-
/**
|
|
3935
|
-
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
|
|
3936
|
-
* @param {string} id Conversation id
|
|
3937
|
-
* @param {*} [options] Override http request option.
|
|
3938
|
-
* @throws {RequiredError}
|
|
3939
|
-
* @memberof DefaultApiInterface
|
|
3940
|
-
*/
|
|
3941
|
-
getConversation(id: string, options?: AxiosRequestConfig): AxiosPromise<GetConversationResponse>;
|
|
3942
|
-
/**
|
|
3943
|
-
* Retrieves the [Event](#schema_event) object for a valid identifiers.
|
|
3944
|
-
* @param {string} id Event id
|
|
3945
|
-
* @param {*} [options] Override http request option.
|
|
3946
|
-
* @throws {RequiredError}
|
|
3947
|
-
* @memberof DefaultApiInterface
|
|
3948
|
-
*/
|
|
3949
|
-
getEvent(id: string, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
|
|
3950
|
-
/**
|
|
3951
|
-
* Get File
|
|
3952
|
-
* @param {string} id File ID
|
|
3953
|
-
* @param {*} [options] Override http request option.
|
|
3954
|
-
* @throws {RequiredError}
|
|
3955
|
-
* @memberof DefaultApiInterface
|
|
3956
|
-
*/
|
|
3957
|
-
getFile(id: string, options?: AxiosRequestConfig): AxiosPromise<GetFileResponse>;
|
|
3958
|
-
/**
|
|
3959
|
-
* Get integration
|
|
3960
|
-
* @param {string} id Integration Id
|
|
3961
|
-
* @param {*} [options] Override http request option.
|
|
3962
|
-
* @throws {RequiredError}
|
|
3963
|
-
* @memberof DefaultApiInterface
|
|
3964
|
-
*/
|
|
3965
|
-
getIntegration(id: string, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationResponse>;
|
|
3966
|
-
/**
|
|
3967
|
-
* Get integration
|
|
3968
|
-
* @param {string} name Integration Name
|
|
3969
|
-
* @param {string} version Integration version. Either a semver version or tag \"latest\"
|
|
3970
|
-
* @param {*} [options] Override http request option.
|
|
3971
|
-
* @throws {RequiredError}
|
|
3972
|
-
* @memberof DefaultApiInterface
|
|
3973
|
-
*/
|
|
3974
|
-
getIntegrationByName(name: string, version: string, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationByNameResponse>;
|
|
3975
|
-
/**
|
|
3976
|
-
* Retrieves the [Message](#schema_message) object for a valid identifier.
|
|
3977
|
-
* @param {string} id Id of the Message
|
|
3978
|
-
* @param {*} [options] Override http request option.
|
|
3979
|
-
* @throws {RequiredError}
|
|
3980
|
-
* @memberof DefaultApiInterface
|
|
3981
|
-
*/
|
|
3982
|
-
getMessage(id: string, options?: AxiosRequestConfig): AxiosPromise<GetMessageResponse>;
|
|
3983
|
-
/**
|
|
3984
|
-
* Retrieves the [Conversation](#schema_conversation) object for a valid identifier. If the conversation does not exist, it will be created.
|
|
3985
|
-
* @param {GetOrCreateConversationBody} [getOrCreateConversationBody] Conversation data
|
|
3986
|
-
* @param {*} [options] Override http request option.
|
|
3987
|
-
* @throws {RequiredError}
|
|
3988
|
-
* @memberof DefaultApiInterface
|
|
3989
|
-
*/
|
|
3990
|
-
getOrCreateConversation(getOrCreateConversationBody?: GetOrCreateConversationBody, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateConversationResponse>;
|
|
3991
|
-
/**
|
|
3992
|
-
* Retrieves the [Message](#schema_message) object for a valid identifier. If the message does not exist, it will be created.
|
|
3993
|
-
* @param {GetOrCreateMessageBody} [getOrCreateMessageBody] Message data
|
|
3994
|
-
* @param {*} [options] Override http request option.
|
|
3995
|
-
* @throws {RequiredError}
|
|
3996
|
-
* @memberof DefaultApiInterface
|
|
3997
|
-
*/
|
|
3998
|
-
getOrCreateMessage(getOrCreateMessageBody?: GetOrCreateMessageBody, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateMessageResponse>;
|
|
3999
|
-
/**
|
|
4000
|
-
* Retrieves the [User](#schema_user) object for a valid identifier. If the user does not exist, it will be created.
|
|
4001
|
-
* @param {GetOrCreateUserBody} [getOrCreateUserBody] User data
|
|
4002
|
-
* @param {*} [options] Override http request option.
|
|
4003
|
-
* @throws {RequiredError}
|
|
4004
|
-
* @memberof DefaultApiInterface
|
|
4005
|
-
*/
|
|
4006
|
-
getOrCreateUser(getOrCreateUserBody?: GetOrCreateUserBody, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateUserResponse>;
|
|
4007
|
-
/**
|
|
4008
|
-
* Get public integration by name and version
|
|
4009
|
-
* @param {string} name Integration Name
|
|
4010
|
-
* @param {string} version Integration version. Either a semver version or tag \"latest\"
|
|
4011
|
-
* @param {*} [options] Override http request option.
|
|
4012
|
-
* @throws {RequiredError}
|
|
4013
|
-
* @memberof DefaultApiInterface
|
|
4014
|
-
*/
|
|
4015
|
-
getPublicIntegration(name: string, version: string, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationResponse>;
|
|
4016
|
-
/**
|
|
4017
|
-
* Get public integration by Id
|
|
4018
|
-
* @param {string} id Integration Id
|
|
4019
|
-
* @param {*} [options] Override http request option.
|
|
4020
|
-
* @throws {RequiredError}
|
|
4021
|
-
* @memberof DefaultApiInterface
|
|
4022
|
-
*/
|
|
4023
|
-
getPublicIntegrationById(id: string, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationByIdResponse>;
|
|
4024
|
-
/**
|
|
4025
|
-
* Retrieves the [State](#schema_state) object for a valid identifiers.
|
|
4026
|
-
* @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
|
|
4027
|
-
* @param {string} id State id
|
|
4028
|
-
* @param {string} name State name
|
|
3860
|
+
* @param {DefaultApiGetUserRequest} requestParameters Request parameters.
|
|
4029
3861
|
* @param {*} [options] Override http request option.
|
|
4030
3862
|
* @throws {RequiredError}
|
|
4031
|
-
* @memberof DefaultApiInterface
|
|
4032
3863
|
*/
|
|
4033
|
-
|
|
3864
|
+
getUser(requestParameters: DefaultApiGetUserRequest, options?: AxiosRequestConfig): AxiosPromise<GetUserResponse>;
|
|
4034
3865
|
/**
|
|
4035
|
-
*
|
|
4036
|
-
* @param {
|
|
3866
|
+
* Get workspace details
|
|
3867
|
+
* @param {DefaultApiGetWorkspaceRequest} requestParameters Request parameters.
|
|
4037
3868
|
* @param {*} [options] Override http request option.
|
|
4038
3869
|
* @throws {RequiredError}
|
|
4039
|
-
* @memberof DefaultApiInterface
|
|
4040
3870
|
*/
|
|
4041
|
-
|
|
3871
|
+
getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
|
|
4042
3872
|
/**
|
|
4043
3873
|
* Introspect the API
|
|
4044
|
-
* @param {
|
|
3874
|
+
* @param {DefaultApiIntrospectRequest} requestParameters Request parameters.
|
|
4045
3875
|
* @param {*} [options] Override http request option.
|
|
4046
3876
|
* @throws {RequiredError}
|
|
4047
|
-
* @memberof DefaultApiInterface
|
|
4048
3877
|
*/
|
|
4049
|
-
introspect(
|
|
3878
|
+
introspect(requestParameters?: DefaultApiIntrospectRequest, options?: AxiosRequestConfig): AxiosPromise<IntrospectResponse>;
|
|
4050
3879
|
/**
|
|
4051
3880
|
* List bots
|
|
4052
|
-
* @param {
|
|
3881
|
+
* @param {DefaultApiListBotsRequest} requestParameters Request parameters.
|
|
4053
3882
|
* @param {*} [options] Override http request option.
|
|
4054
3883
|
* @throws {RequiredError}
|
|
4055
|
-
* @memberof DefaultApiInterface
|
|
4056
3884
|
*/
|
|
4057
|
-
listBots(
|
|
3885
|
+
listBots(requestParameters?: DefaultApiListBotsRequest, options?: AxiosRequestConfig): AxiosPromise<ListBotsResponse>;
|
|
4058
3886
|
/**
|
|
4059
3887
|
* Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
4060
|
-
* @param {
|
|
4061
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
4062
|
-
* @param {Array<string>} [participantIds] Filter by participant ids
|
|
3888
|
+
* @param {DefaultApiListConversationsRequest} requestParameters Request parameters.
|
|
4063
3889
|
* @param {*} [options] Override http request option.
|
|
4064
3890
|
* @throws {RequiredError}
|
|
4065
|
-
* @memberof DefaultApiInterface
|
|
4066
3891
|
*/
|
|
4067
|
-
listConversations(
|
|
4068
|
-
[key: string]: string;
|
|
4069
|
-
}, participantIds?: Array<string>, options?: AxiosRequestConfig): AxiosPromise<ListConversationsResponse>;
|
|
3892
|
+
listConversations(requestParameters?: DefaultApiListConversationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListConversationsResponse>;
|
|
4070
3893
|
/**
|
|
4071
3894
|
* Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
4072
|
-
* @param {
|
|
3895
|
+
* @param {DefaultApiListEventsRequest} requestParameters Request parameters.
|
|
4073
3896
|
* @param {*} [options] Override http request option.
|
|
4074
3897
|
* @throws {RequiredError}
|
|
4075
|
-
* @memberof DefaultApiInterface
|
|
4076
3898
|
*/
|
|
4077
|
-
listEvents(
|
|
3899
|
+
listEvents(requestParameters?: DefaultApiListEventsRequest, options?: AxiosRequestConfig): AxiosPromise<ListEventsResponse>;
|
|
4078
3900
|
/**
|
|
4079
3901
|
* List Files
|
|
4080
|
-
* @param {
|
|
4081
|
-
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
3902
|
+
* @param {DefaultApiListFilesRequest} requestParameters Request parameters.
|
|
4082
3903
|
* @param {*} [options] Override http request option.
|
|
4083
3904
|
* @throws {RequiredError}
|
|
4084
|
-
* @memberof DefaultApiInterface
|
|
4085
3905
|
*/
|
|
4086
|
-
listFiles(
|
|
3906
|
+
listFiles(requestParameters: DefaultApiListFilesRequest, options?: AxiosRequestConfig): AxiosPromise<ListFilesResponse>;
|
|
4087
3907
|
/**
|
|
4088
3908
|
* List integrations
|
|
4089
|
-
* @param {
|
|
4090
|
-
* @param {string} [name] Integration Name
|
|
4091
|
-
* @param {string} [version] Integration version. Either a semver version or tag \"latest\"
|
|
3909
|
+
* @param {DefaultApiListIntegrationsRequest} requestParameters Request parameters.
|
|
4092
3910
|
* @param {*} [options] Override http request option.
|
|
4093
3911
|
* @throws {RequiredError}
|
|
4094
|
-
* @memberof DefaultApiInterface
|
|
4095
3912
|
*/
|
|
4096
|
-
listIntegrations(
|
|
3913
|
+
listIntegrations(requestParameters?: DefaultApiListIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListIntegrationsResponse>;
|
|
4097
3914
|
/**
|
|
4098
3915
|
* Retrieves a list of [Messages](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
4099
|
-
* @param {
|
|
4100
|
-
* @param {string} [conversationId] Conversation id
|
|
4101
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
3916
|
+
* @param {DefaultApiListMessagesRequest} requestParameters Request parameters.
|
|
4102
3917
|
* @param {*} [options] Override http request option.
|
|
4103
3918
|
* @throws {RequiredError}
|
|
4104
|
-
* @memberof DefaultApiInterface
|
|
4105
3919
|
*/
|
|
4106
|
-
listMessages(
|
|
4107
|
-
[key: string]: string;
|
|
4108
|
-
}, options?: AxiosRequestConfig): AxiosPromise<ListMessagesResponse>;
|
|
3920
|
+
listMessages(requestParameters?: DefaultApiListMessagesRequest, options?: AxiosRequestConfig): AxiosPromise<ListMessagesResponse>;
|
|
4109
3921
|
/**
|
|
4110
3922
|
* List public integration
|
|
4111
|
-
* @param {
|
|
4112
|
-
* @param {string} [name] Integration Name
|
|
4113
|
-
* @param {string} [version] Integration version. Either a semver version or tag \"latest\"
|
|
3923
|
+
* @param {DefaultApiListPublicIntegrationsRequest} requestParameters Request parameters.
|
|
4114
3924
|
* @param {*} [options] Override http request option.
|
|
4115
3925
|
* @throws {RequiredError}
|
|
4116
|
-
* @memberof DefaultApiInterface
|
|
4117
3926
|
*/
|
|
4118
|
-
listPublicIntegrations(
|
|
3927
|
+
listPublicIntegrations(requestParameters?: DefaultApiListPublicIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListPublicIntegrationsResponse>;
|
|
4119
3928
|
/**
|
|
4120
3929
|
* 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).
|
|
4121
|
-
* @param {
|
|
4122
|
-
* @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
|
|
4123
|
-
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
3930
|
+
* @param {DefaultApiListUsersRequest} requestParameters Request parameters.
|
|
4124
3931
|
* @param {*} [options] Override http request option.
|
|
4125
3932
|
* @throws {RequiredError}
|
|
4126
|
-
* @memberof DefaultApiInterface
|
|
4127
3933
|
*/
|
|
4128
|
-
listUsers(
|
|
4129
|
-
[key: string]: string;
|
|
4130
|
-
}, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
|
|
3934
|
+
listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
|
|
4131
3935
|
/**
|
|
4132
3936
|
* List workspaces the user has access to
|
|
4133
|
-
* @param {
|
|
3937
|
+
* @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
|
|
4134
3938
|
* @param {*} [options] Override http request option.
|
|
4135
3939
|
* @throws {RequiredError}
|
|
4136
|
-
* @memberof DefaultApiInterface
|
|
4137
3940
|
*/
|
|
4138
|
-
listWorkspaces(
|
|
3941
|
+
listWorkspaces(requestParameters?: DefaultApiListWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspacesResponse>;
|
|
4139
3942
|
/**
|
|
4140
3943
|
* Updates the [State](#schema_state) object by setting the values of the parameters passed.
|
|
4141
|
-
* @param {
|
|
4142
|
-
* @param {string} id State id
|
|
4143
|
-
* @param {string} name State name
|
|
4144
|
-
* @param {PatchStateBody} [patchStateBody] State content
|
|
3944
|
+
* @param {DefaultApiPatchStateRequest} requestParameters Request parameters.
|
|
4145
3945
|
* @param {*} [options] Override http request option.
|
|
4146
3946
|
* @throws {RequiredError}
|
|
4147
|
-
* @memberof DefaultApiInterface
|
|
4148
3947
|
*/
|
|
4149
|
-
patchState(
|
|
3948
|
+
patchState(requestParameters: DefaultApiPatchStateRequest, options?: AxiosRequestConfig): AxiosPromise<PatchStateResponse>;
|
|
4150
3949
|
/**
|
|
4151
3950
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
4152
|
-
* @param {
|
|
4153
|
-
* @param {string} id State id
|
|
4154
|
-
* @param {string} name State name
|
|
4155
|
-
* @param {SetStateBody} [setStateBody] State content
|
|
3951
|
+
* @param {DefaultApiSetStateRequest} requestParameters Request parameters.
|
|
4156
3952
|
* @param {*} [options] Override http request option.
|
|
4157
3953
|
* @throws {RequiredError}
|
|
4158
|
-
* @memberof DefaultApiInterface
|
|
4159
3954
|
*/
|
|
4160
|
-
setState(
|
|
3955
|
+
setState(requestParameters: DefaultApiSetStateRequest, options?: AxiosRequestConfig): AxiosPromise<SetStateResponse>;
|
|
4161
3956
|
/**
|
|
4162
3957
|
* Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
|
|
4163
|
-
* @param {
|
|
4164
|
-
* @param {TransferBotBody} [transferBotBody] Bot transfer request
|
|
3958
|
+
* @param {DefaultApiTransferBotRequest} requestParameters Request parameters.
|
|
4165
3959
|
* @param {*} [options] Override http request option.
|
|
4166
3960
|
* @throws {RequiredError}
|
|
4167
|
-
* @memberof DefaultApiInterface
|
|
4168
3961
|
*/
|
|
4169
|
-
transferBot(
|
|
3962
|
+
transferBot(requestParameters: DefaultApiTransferBotRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
4170
3963
|
/**
|
|
4171
3964
|
* Update bot
|
|
4172
|
-
* @param {
|
|
4173
|
-
* @param {UpdateBotBody} [updateBotBody] Bot metadata
|
|
3965
|
+
* @param {DefaultApiUpdateBotRequest} requestParameters Request parameters.
|
|
4174
3966
|
* @param {*} [options] Override http request option.
|
|
4175
3967
|
* @throws {RequiredError}
|
|
4176
|
-
* @memberof DefaultApiInterface
|
|
4177
3968
|
*/
|
|
4178
|
-
updateBot(
|
|
3969
|
+
updateBot(requestParameters: DefaultApiUpdateBotRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateBotResponse>;
|
|
4179
3970
|
/**
|
|
4180
3971
|
* Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
4181
|
-
* @param {
|
|
4182
|
-
* @param {UpdateConversationBody} [updateConversationBody] Conversation data
|
|
3972
|
+
* @param {DefaultApiUpdateConversationRequest} requestParameters Request parameters.
|
|
4183
3973
|
* @param {*} [options] Override http request option.
|
|
4184
3974
|
* @throws {RequiredError}
|
|
4185
|
-
* @memberof DefaultApiInterface
|
|
4186
3975
|
*/
|
|
4187
|
-
updateConversation(
|
|
3976
|
+
updateConversation(requestParameters: DefaultApiUpdateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateConversationResponse>;
|
|
4188
3977
|
/**
|
|
4189
3978
|
* Update integration
|
|
4190
|
-
* @param {
|
|
4191
|
-
* @param {UpdateIntegrationBody} [updateIntegrationBody] Integration
|
|
3979
|
+
* @param {DefaultApiUpdateIntegrationRequest} requestParameters Request parameters.
|
|
4192
3980
|
* @param {*} [options] Override http request option.
|
|
4193
3981
|
* @throws {RequiredError}
|
|
4194
|
-
* @memberof DefaultApiInterface
|
|
4195
3982
|
*/
|
|
4196
|
-
updateIntegration(
|
|
3983
|
+
updateIntegration(requestParameters: DefaultApiUpdateIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateIntegrationResponse>;
|
|
4197
3984
|
/**
|
|
4198
3985
|
* Update a message
|
|
4199
|
-
* @param {
|
|
4200
|
-
* @param {UpdateMessageBody} [updateMessageBody] Message data
|
|
3986
|
+
* @param {DefaultApiUpdateMessageRequest} requestParameters Request parameters.
|
|
4201
3987
|
* @param {*} [options] Override http request option.
|
|
4202
3988
|
* @throws {RequiredError}
|
|
4203
|
-
* @memberof DefaultApiInterface
|
|
4204
3989
|
*/
|
|
4205
|
-
updateMessage(
|
|
3990
|
+
updateMessage(requestParameters: DefaultApiUpdateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateMessageResponse>;
|
|
4206
3991
|
/**
|
|
4207
3992
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
4208
|
-
* @param {
|
|
4209
|
-
* @param {UpdateUserBody} [updateUserBody] User data
|
|
3993
|
+
* @param {DefaultApiUpdateUserRequest} requestParameters Request parameters.
|
|
4210
3994
|
* @param {*} [options] Override http request option.
|
|
4211
3995
|
* @throws {RequiredError}
|
|
4212
|
-
* @memberof DefaultApiInterface
|
|
4213
3996
|
*/
|
|
4214
|
-
updateUser(
|
|
4215
|
-
}
|
|
3997
|
+
updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateUserResponse>;
|
|
3998
|
+
};
|
|
4216
3999
|
/**
|
|
4217
4000
|
* Request parameters for callAction operation in DefaultApi.
|
|
4218
4001
|
* @export
|
|
@@ -4562,6 +4345,19 @@ export interface DefaultApiGetIntegrationByNameRequest {
|
|
|
4562
4345
|
*/
|
|
4563
4346
|
readonly version: string;
|
|
4564
4347
|
}
|
|
4348
|
+
/**
|
|
4349
|
+
* Request parameters for getIntegrationLogs operation in DefaultApi.
|
|
4350
|
+
* @export
|
|
4351
|
+
* @interface DefaultApiGetIntegrationLogsRequest
|
|
4352
|
+
*/
|
|
4353
|
+
export interface DefaultApiGetIntegrationLogsRequest {
|
|
4354
|
+
/**
|
|
4355
|
+
* Integration Id
|
|
4356
|
+
* @type {string}
|
|
4357
|
+
* @memberof DefaultApiGetIntegrationLogs
|
|
4358
|
+
*/
|
|
4359
|
+
readonly id: string;
|
|
4360
|
+
}
|
|
4565
4361
|
/**
|
|
4566
4362
|
* Request parameters for getMessage operation in DefaultApi.
|
|
4567
4363
|
* @export
|
|
@@ -4684,6 +4480,19 @@ export interface DefaultApiGetUserRequest {
|
|
|
4684
4480
|
*/
|
|
4685
4481
|
readonly id: string;
|
|
4686
4482
|
}
|
|
4483
|
+
/**
|
|
4484
|
+
* Request parameters for getWorkspace operation in DefaultApi.
|
|
4485
|
+
* @export
|
|
4486
|
+
* @interface DefaultApiGetWorkspaceRequest
|
|
4487
|
+
*/
|
|
4488
|
+
export interface DefaultApiGetWorkspaceRequest {
|
|
4489
|
+
/**
|
|
4490
|
+
* Workspace ID
|
|
4491
|
+
* @type {string}
|
|
4492
|
+
* @memberof DefaultApiGetWorkspace
|
|
4493
|
+
*/
|
|
4494
|
+
readonly id: string;
|
|
4495
|
+
}
|
|
4687
4496
|
/**
|
|
4688
4497
|
* Request parameters for introspect operation in DefaultApi.
|
|
4689
4498
|
* @export
|
|
@@ -4749,6 +4558,12 @@ export interface DefaultApiListEventsRequest {
|
|
|
4749
4558
|
* @memberof DefaultApiListEvents
|
|
4750
4559
|
*/
|
|
4751
4560
|
readonly nextToken?: string;
|
|
4561
|
+
/**
|
|
4562
|
+
* Filter by event type
|
|
4563
|
+
* @type {string}
|
|
4564
|
+
* @memberof DefaultApiListEvents
|
|
4565
|
+
*/
|
|
4566
|
+
readonly type?: string;
|
|
4752
4567
|
}
|
|
4753
4568
|
/**
|
|
4754
4569
|
* Request parameters for listFiles operation in DefaultApi.
|
|
@@ -5068,7 +4883,7 @@ export interface DefaultApiUpdateUserRequest {
|
|
|
5068
4883
|
* @class DefaultApi
|
|
5069
4884
|
* @extends {BaseAPI}
|
|
5070
4885
|
*/
|
|
5071
|
-
export declare class DefaultApi extends BaseAPI
|
|
4886
|
+
export declare class DefaultApi extends BaseAPI {
|
|
5072
4887
|
/**
|
|
5073
4888
|
* Call an action
|
|
5074
4889
|
* @param {DefaultApiCallActionRequest} requestParameters Request parameters.
|
|
@@ -5269,6 +5084,14 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
|
|
|
5269
5084
|
* @memberof DefaultApi
|
|
5270
5085
|
*/
|
|
5271
5086
|
getIntegrationByName(requestParameters: DefaultApiGetIntegrationByNameRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIntegrationByNameResponse, any>>;
|
|
5087
|
+
/**
|
|
5088
|
+
* Get integration logs
|
|
5089
|
+
* @param {DefaultApiGetIntegrationLogsRequest} requestParameters Request parameters.
|
|
5090
|
+
* @param {*} [options] Override http request option.
|
|
5091
|
+
* @throws {RequiredError}
|
|
5092
|
+
* @memberof DefaultApi
|
|
5093
|
+
*/
|
|
5094
|
+
getIntegrationLogs(requestParameters: DefaultApiGetIntegrationLogsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIntegrationLogsResponse, any>>;
|
|
5272
5095
|
/**
|
|
5273
5096
|
* Retrieves the [Message](#schema_message) object for a valid identifier.
|
|
5274
5097
|
* @param {DefaultApiGetMessageRequest} requestParameters Request parameters.
|
|
@@ -5333,6 +5156,14 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
|
|
|
5333
5156
|
* @memberof DefaultApi
|
|
5334
5157
|
*/
|
|
5335
5158
|
getUser(requestParameters: DefaultApiGetUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserResponse, any>>;
|
|
5159
|
+
/**
|
|
5160
|
+
* Get workspace details
|
|
5161
|
+
* @param {DefaultApiGetWorkspaceRequest} requestParameters Request parameters.
|
|
5162
|
+
* @param {*} [options] Override http request option.
|
|
5163
|
+
* @throws {RequiredError}
|
|
5164
|
+
* @memberof DefaultApi
|
|
5165
|
+
*/
|
|
5166
|
+
getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkspaceResponse, any>>;
|
|
5336
5167
|
/**
|
|
5337
5168
|
* Introspect the API
|
|
5338
5169
|
* @param {DefaultApiIntrospectRequest} requestParameters Request parameters.
|