@botpress/client 0.11.1 → 0.11.3
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 +1 -1
- package/dist/bundle.cjs.map +3 -3
- package/dist/gen/api.d.ts +200 -41
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +3 -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.16.
|
|
5
|
+
* The version of the OpenAPI document: 0.16.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -38,6 +38,64 @@ export interface Account {
|
|
|
38
38
|
*/
|
|
39
39
|
'createdAt': string;
|
|
40
40
|
}
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
* @interface Activity
|
|
45
|
+
*/
|
|
46
|
+
export interface Activity {
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof Activity
|
|
51
|
+
*/
|
|
52
|
+
'id': string;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof Activity
|
|
57
|
+
*/
|
|
58
|
+
'description': string;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof Activity
|
|
63
|
+
*/
|
|
64
|
+
'taskId': string;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof Activity
|
|
69
|
+
*/
|
|
70
|
+
'category': ActivityCategoryEnum;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {{ [key: string]: any; }}
|
|
74
|
+
* @memberof Activity
|
|
75
|
+
*/
|
|
76
|
+
'data': {
|
|
77
|
+
[key: string]: any;
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* Creation date of the activity in ISO 8601 format
|
|
81
|
+
* @type {string}
|
|
82
|
+
* @memberof Activity
|
|
83
|
+
*/
|
|
84
|
+
'createdAt': string;
|
|
85
|
+
}
|
|
86
|
+
export declare const ActivityCategoryEnum: {
|
|
87
|
+
readonly Unknown: "unknown";
|
|
88
|
+
readonly Capture: "capture";
|
|
89
|
+
readonly BotMessage: "bot_message";
|
|
90
|
+
readonly UserMessage: "user_message";
|
|
91
|
+
readonly AgentMessage: "agent_message";
|
|
92
|
+
readonly Event: "event";
|
|
93
|
+
readonly Action: "action";
|
|
94
|
+
readonly TaskStatus: "task_status";
|
|
95
|
+
readonly SubtaskStatus: "subtask_status";
|
|
96
|
+
readonly Exception: "exception";
|
|
97
|
+
};
|
|
98
|
+
export type ActivityCategoryEnum = typeof ActivityCategoryEnum[keyof typeof ActivityCategoryEnum];
|
|
41
99
|
/**
|
|
42
100
|
*
|
|
43
101
|
* @export
|
|
@@ -89,7 +147,7 @@ export interface Bot {
|
|
|
89
147
|
*/
|
|
90
148
|
'updatedAt': string;
|
|
91
149
|
/**
|
|
92
|
-
*
|
|
150
|
+
* Title describing the task
|
|
93
151
|
* @type {string}
|
|
94
152
|
* @memberof Bot
|
|
95
153
|
*/
|
|
@@ -255,31 +313,31 @@ export interface BotIntegrationsValue {
|
|
|
255
313
|
*/
|
|
256
314
|
'enabled': boolean;
|
|
257
315
|
/**
|
|
258
|
-
* Type of the
|
|
316
|
+
* Type of the task
|
|
259
317
|
* @type {string}
|
|
260
318
|
* @memberof BotIntegrationsValue
|
|
261
319
|
*/
|
|
262
320
|
'name': string;
|
|
263
321
|
/**
|
|
264
|
-
* Type of the
|
|
322
|
+
* Type of the task
|
|
265
323
|
* @type {string}
|
|
266
324
|
* @memberof BotIntegrationsValue
|
|
267
325
|
*/
|
|
268
326
|
'version': string;
|
|
269
327
|
/**
|
|
270
|
-
*
|
|
328
|
+
* Title describing the task
|
|
271
329
|
* @type {string}
|
|
272
330
|
* @memberof BotIntegrationsValue
|
|
273
331
|
*/
|
|
274
332
|
'webhookUrl': string;
|
|
275
333
|
/**
|
|
276
|
-
* Type of the
|
|
334
|
+
* Type of the task
|
|
277
335
|
* @type {string}
|
|
278
336
|
* @memberof BotIntegrationsValue
|
|
279
337
|
*/
|
|
280
338
|
'webhookId': string;
|
|
281
339
|
/**
|
|
282
|
-
*
|
|
340
|
+
* Title describing the task
|
|
283
341
|
* @type {string}
|
|
284
342
|
* @memberof BotIntegrationsValue
|
|
285
343
|
*/
|
|
@@ -299,7 +357,7 @@ export interface BotIntegrationsValue {
|
|
|
299
357
|
*/
|
|
300
358
|
'status': BotIntegrationsValueStatusEnum;
|
|
301
359
|
/**
|
|
302
|
-
*
|
|
360
|
+
* Title describing the task
|
|
303
361
|
* @type {string}
|
|
304
362
|
* @memberof BotIntegrationsValue
|
|
305
363
|
*/
|
|
@@ -397,7 +455,7 @@ export interface BotRecurringEventsValue {
|
|
|
397
455
|
*/
|
|
398
456
|
'schedule': BotRecurringEventsValueSchedule;
|
|
399
457
|
/**
|
|
400
|
-
* Type of the
|
|
458
|
+
* Type of the task
|
|
401
459
|
* @type {string}
|
|
402
460
|
* @memberof BotRecurringEventsValue
|
|
403
461
|
*/
|
|
@@ -430,7 +488,7 @@ export interface BotRecurringEventsValue {
|
|
|
430
488
|
*/
|
|
431
489
|
export interface BotRecurringEventsValueSchedule {
|
|
432
490
|
/**
|
|
433
|
-
* Type of the
|
|
491
|
+
* Type of the task
|
|
434
492
|
* @type {string}
|
|
435
493
|
* @memberof BotRecurringEventsValueSchedule
|
|
436
494
|
*/
|
|
@@ -1125,7 +1183,7 @@ export interface CreateBotBodyRecurringEventsValueSchedule {
|
|
|
1125
1183
|
*/
|
|
1126
1184
|
export interface CreateBotBodyStatesValue {
|
|
1127
1185
|
/**
|
|
1128
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `
|
|
1186
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
1129
1187
|
* @type {string}
|
|
1130
1188
|
* @memberof CreateBotBodyStatesValue
|
|
1131
1189
|
*/
|
|
@@ -1149,6 +1207,7 @@ export declare const CreateBotBodyStatesValueTypeEnum: {
|
|
|
1149
1207
|
readonly Conversation: "conversation";
|
|
1150
1208
|
readonly User: "user";
|
|
1151
1209
|
readonly Bot: "bot";
|
|
1210
|
+
readonly Task: "task";
|
|
1152
1211
|
};
|
|
1153
1212
|
export type CreateBotBodyStatesValueTypeEnum = typeof CreateBotBodyStatesValueTypeEnum[keyof typeof CreateBotBodyStatesValueTypeEnum];
|
|
1154
1213
|
/**
|
|
@@ -1675,7 +1734,7 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
|
|
|
1675
1734
|
*/
|
|
1676
1735
|
'required'?: boolean;
|
|
1677
1736
|
/**
|
|
1678
|
-
*
|
|
1737
|
+
* Title describing the task
|
|
1679
1738
|
* @type {string}
|
|
1680
1739
|
* @memberof CreateIntegrationBodyConfigurationIdentifier
|
|
1681
1740
|
*/
|
|
@@ -1688,13 +1747,13 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
|
|
|
1688
1747
|
*/
|
|
1689
1748
|
export interface CreateIntegrationBodyIdentifier {
|
|
1690
1749
|
/**
|
|
1691
|
-
*
|
|
1750
|
+
* Title describing the task
|
|
1692
1751
|
* @type {string}
|
|
1693
1752
|
* @memberof CreateIntegrationBodyIdentifier
|
|
1694
1753
|
*/
|
|
1695
1754
|
'fallbackHandlerScript'?: string;
|
|
1696
1755
|
/**
|
|
1697
|
-
*
|
|
1756
|
+
* Title describing the task
|
|
1698
1757
|
* @type {string}
|
|
1699
1758
|
* @memberof CreateIntegrationBodyIdentifier
|
|
1700
1759
|
*/
|
|
@@ -1927,15 +1986,15 @@ export interface CreateTaskBody {
|
|
|
1927
1986
|
* @type {string}
|
|
1928
1987
|
* @memberof CreateTaskBody
|
|
1929
1988
|
*/
|
|
1930
|
-
'title'
|
|
1989
|
+
'title'?: string;
|
|
1931
1990
|
/**
|
|
1932
1991
|
* All the notes related to the execution of the current task
|
|
1933
1992
|
* @type {string}
|
|
1934
1993
|
* @memberof CreateTaskBody
|
|
1935
1994
|
*/
|
|
1936
|
-
'
|
|
1995
|
+
'description'?: string;
|
|
1937
1996
|
/**
|
|
1938
|
-
*
|
|
1997
|
+
* Unique identifier of the integration that was installed on the bot
|
|
1939
1998
|
* @type {string}
|
|
1940
1999
|
* @memberof CreateTaskBody
|
|
1941
2000
|
*/
|
|
@@ -2278,7 +2337,7 @@ export interface Event {
|
|
|
2278
2337
|
*/
|
|
2279
2338
|
'createdAt': string;
|
|
2280
2339
|
/**
|
|
2281
|
-
* Type of the
|
|
2340
|
+
* Type of the task
|
|
2282
2341
|
* @type {string}
|
|
2283
2342
|
* @memberof Event
|
|
2284
2343
|
*/
|
|
@@ -3328,13 +3387,13 @@ export interface Integration {
|
|
|
3328
3387
|
*/
|
|
3329
3388
|
'identifier': IntegrationIdentifier;
|
|
3330
3389
|
/**
|
|
3331
|
-
* Type of the
|
|
3390
|
+
* Type of the task
|
|
3332
3391
|
* @type {string}
|
|
3333
3392
|
* @memberof Integration
|
|
3334
3393
|
*/
|
|
3335
3394
|
'name': string;
|
|
3336
3395
|
/**
|
|
3337
|
-
* Type of the
|
|
3396
|
+
* Type of the task
|
|
3338
3397
|
* @type {string}
|
|
3339
3398
|
* @memberof Integration
|
|
3340
3399
|
*/
|
|
@@ -3508,7 +3567,7 @@ export interface IntegrationConfiguration {
|
|
|
3508
3567
|
*/
|
|
3509
3568
|
export interface IntegrationConfigurationIdentifier {
|
|
3510
3569
|
/**
|
|
3511
|
-
*
|
|
3570
|
+
* Title describing the task
|
|
3512
3571
|
* @type {string}
|
|
3513
3572
|
* @memberof IntegrationConfigurationIdentifier
|
|
3514
3573
|
*/
|
|
@@ -3720,6 +3779,25 @@ export interface IssueGroupedDataValue {
|
|
|
3720
3779
|
*/
|
|
3721
3780
|
'pretty'?: string;
|
|
3722
3781
|
}
|
|
3782
|
+
/**
|
|
3783
|
+
*
|
|
3784
|
+
* @export
|
|
3785
|
+
* @interface ListActivitiesResponse
|
|
3786
|
+
*/
|
|
3787
|
+
export interface ListActivitiesResponse {
|
|
3788
|
+
/**
|
|
3789
|
+
*
|
|
3790
|
+
* @type {Array<Activity>}
|
|
3791
|
+
* @memberof ListActivitiesResponse
|
|
3792
|
+
*/
|
|
3793
|
+
'activities': Array<Activity>;
|
|
3794
|
+
/**
|
|
3795
|
+
*
|
|
3796
|
+
* @type {ListConversationsResponseMeta}
|
|
3797
|
+
* @memberof ListActivitiesResponse
|
|
3798
|
+
*/
|
|
3799
|
+
'meta': ListConversationsResponseMeta;
|
|
3800
|
+
}
|
|
3723
3801
|
/**
|
|
3724
3802
|
*
|
|
3725
3803
|
* @export
|
|
@@ -4488,7 +4566,7 @@ export interface Message {
|
|
|
4488
4566
|
*/
|
|
4489
4567
|
'createdAt': string;
|
|
4490
4568
|
/**
|
|
4491
|
-
* Type of the
|
|
4569
|
+
* Type of the task
|
|
4492
4570
|
* @type {string}
|
|
4493
4571
|
* @memberof Message
|
|
4494
4572
|
*/
|
|
@@ -4845,13 +4923,13 @@ export interface State {
|
|
|
4845
4923
|
*/
|
|
4846
4924
|
'userId'?: string;
|
|
4847
4925
|
/**
|
|
4848
|
-
* Type of the
|
|
4926
|
+
* Type of the task
|
|
4849
4927
|
* @type {string}
|
|
4850
4928
|
* @memberof State
|
|
4851
4929
|
*/
|
|
4852
4930
|
'name': string;
|
|
4853
4931
|
/**
|
|
4854
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot` or `integration`) that the state is related to
|
|
4932
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
|
|
4855
4933
|
* @type {string}
|
|
4856
4934
|
* @memberof State
|
|
4857
4935
|
*/
|
|
@@ -4869,6 +4947,7 @@ export declare const StateTypeEnum: {
|
|
|
4869
4947
|
readonly Conversation: "conversation";
|
|
4870
4948
|
readonly User: "user";
|
|
4871
4949
|
readonly Bot: "bot";
|
|
4950
|
+
readonly Task: "task";
|
|
4872
4951
|
readonly Integration: "integration";
|
|
4873
4952
|
};
|
|
4874
4953
|
export type StateTypeEnum = typeof StateTypeEnum[keyof typeof StateTypeEnum];
|
|
@@ -4944,7 +5023,7 @@ export interface TableSchema {
|
|
|
4944
5023
|
[key: string]: TableSchemaPropertiesValue;
|
|
4945
5024
|
};
|
|
4946
5025
|
/**
|
|
4947
|
-
*
|
|
5026
|
+
* Additional properties can be provided, but they will be ignored if no column matches.
|
|
4948
5027
|
* @type {boolean}
|
|
4949
5028
|
* @memberof TableSchema
|
|
4950
5029
|
*/
|
|
@@ -5027,6 +5106,12 @@ export interface TableSchemaPropertiesValueXZui {
|
|
|
5027
5106
|
* @memberof TableSchemaPropertiesValueXZui
|
|
5028
5107
|
*/
|
|
5029
5108
|
'index': number;
|
|
5109
|
+
/**
|
|
5110
|
+
* [deprecated] ID of the column.
|
|
5111
|
+
* @type {string}
|
|
5112
|
+
* @memberof TableSchemaPropertiesValueXZui
|
|
5113
|
+
*/
|
|
5114
|
+
'id'?: string;
|
|
5030
5115
|
/**
|
|
5031
5116
|
* Indicates if the column is vectorized and searchable.
|
|
5032
5117
|
* @type {boolean}
|
|
@@ -5063,7 +5148,7 @@ export interface Task {
|
|
|
5063
5148
|
* @type {string}
|
|
5064
5149
|
* @memberof Task
|
|
5065
5150
|
*/
|
|
5066
|
-
'
|
|
5151
|
+
'description': string;
|
|
5067
5152
|
/**
|
|
5068
5153
|
* Type of the task
|
|
5069
5154
|
* @type {string}
|
|
@@ -5142,6 +5227,8 @@ export declare const TaskStatusEnum: {
|
|
|
5142
5227
|
readonly Completed: "completed";
|
|
5143
5228
|
readonly Blocked: "blocked";
|
|
5144
5229
|
readonly Paused: "paused";
|
|
5230
|
+
readonly Timeout: "timeout";
|
|
5231
|
+
readonly Cancelled: "cancelled";
|
|
5145
5232
|
};
|
|
5146
5233
|
export type TaskStatusEnum = typeof TaskStatusEnum[keyof typeof TaskStatusEnum];
|
|
5147
5234
|
/**
|
|
@@ -5354,7 +5441,7 @@ export interface UpdateBotBodyRecurringEventsValue {
|
|
|
5354
5441
|
*/
|
|
5355
5442
|
export interface UpdateBotBodyStatesValue {
|
|
5356
5443
|
/**
|
|
5357
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `
|
|
5444
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
5358
5445
|
* @type {string}
|
|
5359
5446
|
* @memberof UpdateBotBodyStatesValue
|
|
5360
5447
|
*/
|
|
@@ -5378,6 +5465,7 @@ export declare const UpdateBotBodyStatesValueTypeEnum: {
|
|
|
5378
5465
|
readonly Conversation: "conversation";
|
|
5379
5466
|
readonly User: "user";
|
|
5380
5467
|
readonly Bot: "bot";
|
|
5468
|
+
readonly Task: "task";
|
|
5381
5469
|
};
|
|
5382
5470
|
export type UpdateBotBodyStatesValueTypeEnum = typeof UpdateBotBodyStatesValueTypeEnum[keyof typeof UpdateBotBodyStatesValueTypeEnum];
|
|
5383
5471
|
/**
|
|
@@ -5450,12 +5538,18 @@ export interface UpdateBotResponse {
|
|
|
5450
5538
|
* @interface UpdateConversationBody
|
|
5451
5539
|
*/
|
|
5452
5540
|
export interface UpdateConversationBody {
|
|
5541
|
+
/**
|
|
5542
|
+
*
|
|
5543
|
+
* @type {string}
|
|
5544
|
+
* @memberof UpdateConversationBody
|
|
5545
|
+
*/
|
|
5546
|
+
'currentTaskId'?: string;
|
|
5453
5547
|
/**
|
|
5454
5548
|
* Tags for the [Conversation](#schema_conversation)
|
|
5455
5549
|
* @type {{ [key: string]: string; }}
|
|
5456
5550
|
* @memberof UpdateConversationBody
|
|
5457
5551
|
*/
|
|
5458
|
-
'tags'
|
|
5552
|
+
'tags'?: {
|
|
5459
5553
|
[key: string]: string;
|
|
5460
5554
|
};
|
|
5461
5555
|
}
|
|
@@ -5707,7 +5801,7 @@ export interface UpdateIntegrationBodyConfiguration {
|
|
|
5707
5801
|
*/
|
|
5708
5802
|
export interface UpdateIntegrationBodyConfigurationIdentifier {
|
|
5709
5803
|
/**
|
|
5710
|
-
*
|
|
5804
|
+
* Title describing the task
|
|
5711
5805
|
* @type {string}
|
|
5712
5806
|
* @memberof UpdateIntegrationBodyConfigurationIdentifier
|
|
5713
5807
|
*/
|
|
@@ -5726,13 +5820,13 @@ export interface UpdateIntegrationBodyConfigurationIdentifier {
|
|
|
5726
5820
|
*/
|
|
5727
5821
|
export interface UpdateIntegrationBodyIdentifier {
|
|
5728
5822
|
/**
|
|
5729
|
-
*
|
|
5823
|
+
* Title describing the task
|
|
5730
5824
|
* @type {string}
|
|
5731
5825
|
* @memberof UpdateIntegrationBodyIdentifier
|
|
5732
5826
|
*/
|
|
5733
5827
|
'extractScript'?: string | null;
|
|
5734
5828
|
/**
|
|
5735
|
-
*
|
|
5829
|
+
* Title describing the task
|
|
5736
5830
|
* @type {string}
|
|
5737
5831
|
* @memberof UpdateIntegrationBodyIdentifier
|
|
5738
5832
|
*/
|
|
@@ -5844,7 +5938,7 @@ export interface UpdateTaskBody {
|
|
|
5844
5938
|
* @type {string}
|
|
5845
5939
|
* @memberof UpdateTaskBody
|
|
5846
5940
|
*/
|
|
5847
|
-
'
|
|
5941
|
+
'description'?: string;
|
|
5848
5942
|
/**
|
|
5849
5943
|
* Content related to the task
|
|
5850
5944
|
* @type {{ [key: string]: any; }}
|
|
@@ -5881,6 +5975,8 @@ export declare const UpdateTaskBodyStatusEnum: {
|
|
|
5881
5975
|
readonly Completed: "completed";
|
|
5882
5976
|
readonly Blocked: "blocked";
|
|
5883
5977
|
readonly Paused: "paused";
|
|
5978
|
+
readonly Timeout: "timeout";
|
|
5979
|
+
readonly Cancelled: "cancelled";
|
|
5884
5980
|
};
|
|
5885
5981
|
export type UpdateTaskBodyStatusEnum = typeof UpdateTaskBodyStatusEnum[keyof typeof UpdateTaskBodyStatusEnum];
|
|
5886
5982
|
/**
|
|
@@ -7050,6 +7146,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7050
7146
|
* @throws {RequiredError}
|
|
7051
7147
|
*/
|
|
7052
7148
|
introspect: (introspectBody?: IntrospectBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7149
|
+
/**
|
|
7150
|
+
* List activities of a task
|
|
7151
|
+
* @param {string} taskId ID of the task to list activities for
|
|
7152
|
+
* @param {string} botId ID of the bot to list activities for
|
|
7153
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
7154
|
+
* @param {*} [options] Override http request option.
|
|
7155
|
+
* @throws {RequiredError}
|
|
7156
|
+
*/
|
|
7157
|
+
listActivities: (taskId: string, botId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7053
7158
|
/**
|
|
7054
7159
|
* List Events for a Bot Issue
|
|
7055
7160
|
* @param {string} id Bot ID
|
|
@@ -7155,14 +7260,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
7155
7260
|
* @param {string} [conversationId] Conversation id
|
|
7156
7261
|
* @param {string} [userId] User id
|
|
7157
7262
|
* @param {string} [parentTaskId] Parent task id
|
|
7158
|
-
* @param {ListTasksStatusEnum} [status] Status
|
|
7263
|
+
* @param {Array<ListTasksStatusEnum>} [status] Status
|
|
7159
7264
|
* @param {string} [type] Type
|
|
7160
7265
|
* @param {*} [options] Override http request option.
|
|
7161
7266
|
* @throws {RequiredError}
|
|
7162
7267
|
*/
|
|
7163
7268
|
listTasks: (nextToken?: string, tags?: {
|
|
7164
7269
|
[key: string]: string;
|
|
7165
|
-
} | undefined, conversationId?: string, userId?: string, parentTaskId?: string, status?: ListTasksStatusEnum
|
|
7270
|
+
} | undefined, conversationId?: string, userId?: string, parentTaskId?: string, status?: Array<ListTasksStatusEnum>, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7166
7271
|
/**
|
|
7167
7272
|
* Get usage history
|
|
7168
7273
|
* @param {ListUsageHistoryTypeEnum} type Type of usage
|
|
@@ -7794,6 +7899,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7794
7899
|
* @throws {RequiredError}
|
|
7795
7900
|
*/
|
|
7796
7901
|
introspect(introspectBody?: IntrospectBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntrospectResponse>>;
|
|
7902
|
+
/**
|
|
7903
|
+
* List activities of a task
|
|
7904
|
+
* @param {string} taskId ID of the task to list activities for
|
|
7905
|
+
* @param {string} botId ID of the bot to list activities for
|
|
7906
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
7907
|
+
* @param {*} [options] Override http request option.
|
|
7908
|
+
* @throws {RequiredError}
|
|
7909
|
+
*/
|
|
7910
|
+
listActivities(taskId: string, botId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActivitiesResponse>>;
|
|
7797
7911
|
/**
|
|
7798
7912
|
* List Events for a Bot Issue
|
|
7799
7913
|
* @param {string} id Bot ID
|
|
@@ -7899,14 +8013,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7899
8013
|
* @param {string} [conversationId] Conversation id
|
|
7900
8014
|
* @param {string} [userId] User id
|
|
7901
8015
|
* @param {string} [parentTaskId] Parent task id
|
|
7902
|
-
* @param {ListTasksStatusEnum} [status] Status
|
|
8016
|
+
* @param {Array<ListTasksStatusEnum>} [status] Status
|
|
7903
8017
|
* @param {string} [type] Type
|
|
7904
8018
|
* @param {*} [options] Override http request option.
|
|
7905
8019
|
* @throws {RequiredError}
|
|
7906
8020
|
*/
|
|
7907
8021
|
listTasks(nextToken?: string, tags?: {
|
|
7908
8022
|
[key: string]: string;
|
|
7909
|
-
} | undefined, conversationId?: string, userId?: string, parentTaskId?: string, status?: ListTasksStatusEnum
|
|
8023
|
+
} | undefined, conversationId?: string, userId?: string, parentTaskId?: string, status?: Array<ListTasksStatusEnum>, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponse>>;
|
|
7910
8024
|
/**
|
|
7911
8025
|
* Get usage history
|
|
7912
8026
|
* @param {ListUsageHistoryTypeEnum} type Type of usage
|
|
@@ -8513,6 +8627,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8513
8627
|
* @throws {RequiredError}
|
|
8514
8628
|
*/
|
|
8515
8629
|
introspect(requestParameters?: DefaultApiIntrospectRequest, options?: AxiosRequestConfig): AxiosPromise<IntrospectResponse>;
|
|
8630
|
+
/**
|
|
8631
|
+
* List activities of a task
|
|
8632
|
+
* @param {DefaultApiListActivitiesRequest} requestParameters Request parameters.
|
|
8633
|
+
* @param {*} [options] Override http request option.
|
|
8634
|
+
* @throws {RequiredError}
|
|
8635
|
+
*/
|
|
8636
|
+
listActivities(requestParameters: DefaultApiListActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<ListActivitiesResponse>;
|
|
8516
8637
|
/**
|
|
8517
8638
|
* List Events for a Bot Issue
|
|
8518
8639
|
* @param {DefaultApiListBotIssueEventsRequest} requestParameters Request parameters.
|
|
@@ -9523,7 +9644,7 @@ export interface DefaultApiGetPublicIntegrationByIdRequest {
|
|
|
9523
9644
|
export interface DefaultApiGetStateRequest {
|
|
9524
9645
|
/**
|
|
9525
9646
|
* State type
|
|
9526
|
-
* @type {'conversation' | 'user' | 'bot' | 'integration'}
|
|
9647
|
+
* @type {'conversation' | 'user' | 'bot' | 'integration' | 'task'}
|
|
9527
9648
|
* @memberof DefaultApiGetState
|
|
9528
9649
|
*/
|
|
9529
9650
|
readonly type: GetStateTypeEnum;
|
|
@@ -9655,6 +9776,31 @@ export interface DefaultApiIntrospectRequest {
|
|
|
9655
9776
|
*/
|
|
9656
9777
|
readonly introspectBody?: IntrospectBody;
|
|
9657
9778
|
}
|
|
9779
|
+
/**
|
|
9780
|
+
* Request parameters for listActivities operation in DefaultApi.
|
|
9781
|
+
* @export
|
|
9782
|
+
* @interface DefaultApiListActivitiesRequest
|
|
9783
|
+
*/
|
|
9784
|
+
export interface DefaultApiListActivitiesRequest {
|
|
9785
|
+
/**
|
|
9786
|
+
* ID of the task to list activities for
|
|
9787
|
+
* @type {string}
|
|
9788
|
+
* @memberof DefaultApiListActivities
|
|
9789
|
+
*/
|
|
9790
|
+
readonly taskId: string;
|
|
9791
|
+
/**
|
|
9792
|
+
* ID of the bot to list activities for
|
|
9793
|
+
* @type {string}
|
|
9794
|
+
* @memberof DefaultApiListActivities
|
|
9795
|
+
*/
|
|
9796
|
+
readonly botId: string;
|
|
9797
|
+
/**
|
|
9798
|
+
* Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
9799
|
+
* @type {string}
|
|
9800
|
+
* @memberof DefaultApiListActivities
|
|
9801
|
+
*/
|
|
9802
|
+
readonly nextToken?: string;
|
|
9803
|
+
}
|
|
9658
9804
|
/**
|
|
9659
9805
|
* Request parameters for listBotIssueEvents operation in DefaultApi.
|
|
9660
9806
|
* @export
|
|
@@ -9937,10 +10083,10 @@ export interface DefaultApiListTasksRequest {
|
|
|
9937
10083
|
readonly parentTaskId?: string;
|
|
9938
10084
|
/**
|
|
9939
10085
|
* Status
|
|
9940
|
-
* @type {'pending' | 'in_progress' | 'failed' | 'completed' | 'blocked' | 'paused'}
|
|
10086
|
+
* @type {Array<'pending' | 'in_progress' | 'failed' | 'completed' | 'blocked' | 'paused' | 'timeout' | 'cancelled'>}
|
|
9941
10087
|
* @memberof DefaultApiListTasks
|
|
9942
10088
|
*/
|
|
9943
|
-
readonly status?: ListTasksStatusEnum
|
|
10089
|
+
readonly status?: Array<ListTasksStatusEnum>;
|
|
9944
10090
|
/**
|
|
9945
10091
|
* Type
|
|
9946
10092
|
* @type {string}
|
|
@@ -10085,7 +10231,7 @@ export interface DefaultApiListWorkspacesRequest {
|
|
|
10085
10231
|
export interface DefaultApiPatchStateRequest {
|
|
10086
10232
|
/**
|
|
10087
10233
|
* State type
|
|
10088
|
-
* @type {'conversation' | 'user' | 'bot' | 'integration'}
|
|
10234
|
+
* @type {'conversation' | 'user' | 'bot' | 'integration' | 'task'}
|
|
10089
10235
|
* @memberof DefaultApiPatchState
|
|
10090
10236
|
*/
|
|
10091
10237
|
readonly type: PatchStateTypeEnum;
|
|
@@ -10167,7 +10313,7 @@ export interface DefaultApiSetAccountPreferenceRequest {
|
|
|
10167
10313
|
export interface DefaultApiSetStateRequest {
|
|
10168
10314
|
/**
|
|
10169
10315
|
* State type
|
|
10170
|
-
* @type {'conversation' | 'user' | 'bot' | 'integration'}
|
|
10316
|
+
* @type {'conversation' | 'user' | 'bot' | 'integration' | 'task'}
|
|
10171
10317
|
* @memberof DefaultApiSetState
|
|
10172
10318
|
*/
|
|
10173
10319
|
readonly type: SetStateTypeEnum;
|
|
@@ -10867,6 +11013,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
10867
11013
|
* @memberof DefaultApi
|
|
10868
11014
|
*/
|
|
10869
11015
|
introspect(requestParameters?: DefaultApiIntrospectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IntrospectResponse, any>>;
|
|
11016
|
+
/**
|
|
11017
|
+
* List activities of a task
|
|
11018
|
+
* @param {DefaultApiListActivitiesRequest} requestParameters Request parameters.
|
|
11019
|
+
* @param {*} [options] Override http request option.
|
|
11020
|
+
* @throws {RequiredError}
|
|
11021
|
+
* @memberof DefaultApi
|
|
11022
|
+
*/
|
|
11023
|
+
listActivities(requestParameters: DefaultApiListActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActivitiesResponse, any>>;
|
|
10870
11024
|
/**
|
|
10871
11025
|
* List Events for a Bot Issue
|
|
10872
11026
|
* @param {DefaultApiListBotIssueEventsRequest} requestParameters Request parameters.
|
|
@@ -11176,6 +11330,7 @@ export declare const GetStateTypeEnum: {
|
|
|
11176
11330
|
readonly User: "user";
|
|
11177
11331
|
readonly Bot: "bot";
|
|
11178
11332
|
readonly Integration: "integration";
|
|
11333
|
+
readonly Task: "task";
|
|
11179
11334
|
};
|
|
11180
11335
|
export type GetStateTypeEnum = typeof GetStateTypeEnum[keyof typeof GetStateTypeEnum];
|
|
11181
11336
|
/**
|
|
@@ -11226,6 +11381,8 @@ export declare const ListTasksStatusEnum: {
|
|
|
11226
11381
|
readonly Completed: "completed";
|
|
11227
11382
|
readonly Blocked: "blocked";
|
|
11228
11383
|
readonly Paused: "paused";
|
|
11384
|
+
readonly Timeout: "timeout";
|
|
11385
|
+
readonly Cancelled: "cancelled";
|
|
11229
11386
|
};
|
|
11230
11387
|
export type ListTasksStatusEnum = typeof ListTasksStatusEnum[keyof typeof ListTasksStatusEnum];
|
|
11231
11388
|
/**
|
|
@@ -11274,6 +11431,7 @@ export declare const PatchStateTypeEnum: {
|
|
|
11274
11431
|
readonly User: "user";
|
|
11275
11432
|
readonly Bot: "bot";
|
|
11276
11433
|
readonly Integration: "integration";
|
|
11434
|
+
readonly Task: "task";
|
|
11277
11435
|
};
|
|
11278
11436
|
export type PatchStateTypeEnum = typeof PatchStateTypeEnum[keyof typeof PatchStateTypeEnum];
|
|
11279
11437
|
/**
|
|
@@ -11284,5 +11442,6 @@ export declare const SetStateTypeEnum: {
|
|
|
11284
11442
|
readonly User: "user";
|
|
11285
11443
|
readonly Bot: "bot";
|
|
11286
11444
|
readonly Integration: "integration";
|
|
11445
|
+
readonly Task: "task";
|
|
11287
11446
|
};
|
|
11288
11447
|
export type SetStateTypeEnum = typeof SetStateTypeEnum[keyof typeof SetStateTypeEnum];
|
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, DefaultApiListParticipantsRequest, DefaultApiAddParticipantRequest, DefaultApiGetParticipantRequest, DefaultApiRemoveParticipantRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiGetTaskRequest, DefaultApiCreateTaskRequest, DefaultApiUpdateTaskRequest, DefaultApiDeleteTaskRequest, DefaultApiListTasksRequest, DefaultApiRunVrlRequest, DefaultApiCreatePersonalAccessTokenRequest, DefaultApiDeletePersonalAccessTokenRequest, DefaultApiSetAccountPreferenceRequest, DefaultApiGetAccountPreferenceRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiListBotIssuesRequest, DefaultApiDeleteBotIssueRequest, DefaultApiListBotIssueEventsRequest, DefaultApiGetWorkspaceBillingDetailsRequest, DefaultApiSetWorkspacePaymentMethodRequest, DefaultApiListWorkspaceInvoicesRequest, DefaultApiChargeWorkspaceUnpaidInvoicesRequest, DefaultApiCreateWorkspaceRequest, DefaultApiGetWorkspaceRequest, DefaultApiListWorkspaceUsagesRequest, DefaultApiBreakDownWorkspaceUsageByBotRequest, DefaultApiGetWorkspaceQuotaRequest, DefaultApiListWorkspaceQuotasRequest, DefaultApiUpdateWorkspaceRequest, DefaultApiCheckHandleAvailabilityRequest, DefaultApiListWorkspacesRequest, DefaultApiChangeWorkspacePlanRequest, DefaultApiDeleteWorkspaceRequest, DefaultApiGetAuditRecordsRequest, DefaultApiListWorkspaceMembersRequest, DefaultApiDeleteWorkspaceMemberRequest, DefaultApiCreateWorkspaceMemberRequest, DefaultApiUpdateWorkspaceMemberRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationLogsRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiGetUsageRequest, DefaultApiListUsageHistoryRequest, DefaultApiChangeAISpendQuotaRequest, 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, DefaultApiGetTaskRequest, DefaultApiCreateTaskRequest, DefaultApiUpdateTaskRequest, DefaultApiDeleteTaskRequest, DefaultApiListTasksRequest, DefaultApiRunVrlRequest, DefaultApiCreatePersonalAccessTokenRequest, DefaultApiDeletePersonalAccessTokenRequest, DefaultApiSetAccountPreferenceRequest, DefaultApiGetAccountPreferenceRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiListBotIssuesRequest, DefaultApiDeleteBotIssueRequest, DefaultApiListBotIssueEventsRequest, DefaultApiGetWorkspaceBillingDetailsRequest, DefaultApiSetWorkspacePaymentMethodRequest, DefaultApiListWorkspaceInvoicesRequest, DefaultApiChargeWorkspaceUnpaidInvoicesRequest, DefaultApiCreateWorkspaceRequest, DefaultApiGetWorkspaceRequest, DefaultApiListWorkspaceUsagesRequest, DefaultApiBreakDownWorkspaceUsageByBotRequest, DefaultApiGetWorkspaceQuotaRequest, DefaultApiListWorkspaceQuotasRequest, DefaultApiUpdateWorkspaceRequest, DefaultApiCheckHandleAvailabilityRequest, DefaultApiListWorkspacesRequest, DefaultApiChangeWorkspacePlanRequest, DefaultApiDeleteWorkspaceRequest, DefaultApiGetAuditRecordsRequest, DefaultApiListWorkspaceMembersRequest, DefaultApiDeleteWorkspaceMemberRequest, DefaultApiCreateWorkspaceMemberRequest, DefaultApiUpdateWorkspaceMemberRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationLogsRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiGetUsageRequest, DefaultApiListUsageHistoryRequest, DefaultApiChangeAISpendQuotaRequest, DefaultApiListActivitiesRequest, 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);
|
|
@@ -94,6 +94,7 @@ export declare class ApiClient {
|
|
|
94
94
|
getUsage: (props: GetUsageProps) => Promise<import("./api").GetUsageResponse>;
|
|
95
95
|
listUsageHistory: (props: ListUsageHistoryProps) => Promise<import("./api").ListUsageHistoryResponse>;
|
|
96
96
|
changeAISpendQuota: (changeAISpendQuotaBody: ChangeAISpendQuotaProps) => Promise<object>;
|
|
97
|
+
listActivities: (props: ListActivitiesProps) => Promise<import("./api").ListActivitiesResponse>;
|
|
97
98
|
introspect: (introspectBody: IntrospectProps) => Promise<import("./api").IntrospectResponse>;
|
|
98
99
|
createFile: (createFileBody: CreateFileProps) => Promise<import("./api").CreateFileResponse>;
|
|
99
100
|
getFile: (props: GetFileProps) => Promise<import("./api").GetFileResponse>;
|
|
@@ -186,6 +187,7 @@ export type DeleteIntegrationProps = Merge<DefaultApiDeleteIntegrationRequest, {
|
|
|
186
187
|
export type GetUsageProps = Merge<DefaultApiGetUsageRequest, {}>;
|
|
187
188
|
export type ListUsageHistoryProps = Merge<DefaultApiListUsageHistoryRequest, {}>;
|
|
188
189
|
export type ChangeAISpendQuotaProps = Merge<Except<DefaultApiChangeAISpendQuotaRequest, 'changeAISpendQuotaBody'>, NonNullable<DefaultApiChangeAISpendQuotaRequest['changeAISpendQuotaBody']>>;
|
|
190
|
+
export type ListActivitiesProps = Merge<DefaultApiListActivitiesRequest, {}>;
|
|
189
191
|
export type IntrospectProps = Merge<Except<DefaultApiIntrospectRequest, 'introspectBody'>, NonNullable<DefaultApiIntrospectRequest['introspectBody']>>;
|
|
190
192
|
export type CreateFileProps = Merge<Except<DefaultApiCreateFileRequest, 'createFileBody'>, NonNullable<DefaultApiCreateFileRequest['createFileBody']>>;
|
|
191
193
|
export type GetFileProps = Merge<DefaultApiGetFileRequest, {}>;
|
package/dist/gen/common.d.ts
CHANGED
package/dist/gen/index.d.ts
CHANGED