@botpress/client 0.11.0 → 0.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bundle.cjs +8 -8
- package/dist/bundle.cjs.map +4 -4
- package/dist/gen/api.d.ts +969 -70
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +15 -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.3
|
|
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
|
*/
|
|
@@ -658,6 +716,12 @@ export interface ChangeWorkspacePlanResponse {
|
|
|
658
716
|
* @memberof ChangeWorkspacePlanResponse
|
|
659
717
|
*/
|
|
660
718
|
'isPublic'?: boolean;
|
|
719
|
+
/**
|
|
720
|
+
*
|
|
721
|
+
* @type {string}
|
|
722
|
+
* @memberof ChangeWorkspacePlanResponse
|
|
723
|
+
*/
|
|
724
|
+
'handle'?: string;
|
|
661
725
|
}
|
|
662
726
|
export declare const ChangeWorkspacePlanResponseAccountTypeEnum: {
|
|
663
727
|
readonly Free: "free";
|
|
@@ -751,6 +815,44 @@ export interface ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner {
|
|
|
751
815
|
*/
|
|
752
816
|
'failedReason': string;
|
|
753
817
|
}
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @export
|
|
821
|
+
* @interface CheckHandleAvailabilityBody
|
|
822
|
+
*/
|
|
823
|
+
export interface CheckHandleAvailabilityBody {
|
|
824
|
+
/**
|
|
825
|
+
*
|
|
826
|
+
* @type {string}
|
|
827
|
+
* @memberof CheckHandleAvailabilityBody
|
|
828
|
+
*/
|
|
829
|
+
'handle': string;
|
|
830
|
+
}
|
|
831
|
+
/**
|
|
832
|
+
*
|
|
833
|
+
* @export
|
|
834
|
+
* @interface CheckHandleAvailabilityResponse
|
|
835
|
+
*/
|
|
836
|
+
export interface CheckHandleAvailabilityResponse {
|
|
837
|
+
/**
|
|
838
|
+
*
|
|
839
|
+
* @type {boolean}
|
|
840
|
+
* @memberof CheckHandleAvailabilityResponse
|
|
841
|
+
*/
|
|
842
|
+
'available': boolean;
|
|
843
|
+
/**
|
|
844
|
+
*
|
|
845
|
+
* @type {Array<string>}
|
|
846
|
+
* @memberof CheckHandleAvailabilityResponse
|
|
847
|
+
*/
|
|
848
|
+
'suggestions': Array<string>;
|
|
849
|
+
/**
|
|
850
|
+
*
|
|
851
|
+
* @type {string}
|
|
852
|
+
* @memberof CheckHandleAvailabilityResponse
|
|
853
|
+
*/
|
|
854
|
+
'usedBy'?: string;
|
|
855
|
+
}
|
|
754
856
|
/**
|
|
755
857
|
*
|
|
756
858
|
* @export
|
|
@@ -835,6 +937,12 @@ export interface Conversation {
|
|
|
835
937
|
* @memberof Conversation
|
|
836
938
|
*/
|
|
837
939
|
'id': string;
|
|
940
|
+
/**
|
|
941
|
+
* Id of the current [Task](#schema_task)
|
|
942
|
+
* @type {string}
|
|
943
|
+
* @memberof Conversation
|
|
944
|
+
*/
|
|
945
|
+
'currentTaskId'?: string;
|
|
838
946
|
/**
|
|
839
947
|
* Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
|
|
840
948
|
* @type {string}
|
|
@@ -1625,7 +1733,7 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
|
|
|
1625
1733
|
*/
|
|
1626
1734
|
'required'?: boolean;
|
|
1627
1735
|
/**
|
|
1628
|
-
*
|
|
1736
|
+
* Title describing the task
|
|
1629
1737
|
* @type {string}
|
|
1630
1738
|
* @memberof CreateIntegrationBodyConfigurationIdentifier
|
|
1631
1739
|
*/
|
|
@@ -1638,13 +1746,13 @@ export interface CreateIntegrationBodyConfigurationIdentifier {
|
|
|
1638
1746
|
*/
|
|
1639
1747
|
export interface CreateIntegrationBodyIdentifier {
|
|
1640
1748
|
/**
|
|
1641
|
-
*
|
|
1749
|
+
* Title describing the task
|
|
1642
1750
|
* @type {string}
|
|
1643
1751
|
* @memberof CreateIntegrationBodyIdentifier
|
|
1644
1752
|
*/
|
|
1645
1753
|
'fallbackHandlerScript'?: string;
|
|
1646
1754
|
/**
|
|
1647
|
-
*
|
|
1755
|
+
* Title describing the task
|
|
1648
1756
|
* @type {string}
|
|
1649
1757
|
* @memberof CreateIntegrationBodyIdentifier
|
|
1650
1758
|
*/
|
|
@@ -1866,6 +1974,84 @@ export interface CreatePersonalAccessTokenResponsePat {
|
|
|
1866
1974
|
*/
|
|
1867
1975
|
'value': string;
|
|
1868
1976
|
}
|
|
1977
|
+
/**
|
|
1978
|
+
*
|
|
1979
|
+
* @export
|
|
1980
|
+
* @interface CreateTaskBody
|
|
1981
|
+
*/
|
|
1982
|
+
export interface CreateTaskBody {
|
|
1983
|
+
/**
|
|
1984
|
+
* Title describing the task
|
|
1985
|
+
* @type {string}
|
|
1986
|
+
* @memberof CreateTaskBody
|
|
1987
|
+
*/
|
|
1988
|
+
'title'?: string;
|
|
1989
|
+
/**
|
|
1990
|
+
* All the notes related to the execution of the current task
|
|
1991
|
+
* @type {string}
|
|
1992
|
+
* @memberof CreateTaskBody
|
|
1993
|
+
*/
|
|
1994
|
+
'description'?: string;
|
|
1995
|
+
/**
|
|
1996
|
+
* Unique identifier of the integration that was installed on the bot
|
|
1997
|
+
* @type {string}
|
|
1998
|
+
* @memberof CreateTaskBody
|
|
1999
|
+
*/
|
|
2000
|
+
'type': string;
|
|
2001
|
+
/**
|
|
2002
|
+
* Content related to the task
|
|
2003
|
+
* @type {{ [key: string]: any; }}
|
|
2004
|
+
* @memberof CreateTaskBody
|
|
2005
|
+
*/
|
|
2006
|
+
'data'?: {
|
|
2007
|
+
[key: string]: any;
|
|
2008
|
+
};
|
|
2009
|
+
/**
|
|
2010
|
+
* Parent task id is the parent task that created this task
|
|
2011
|
+
* @type {string}
|
|
2012
|
+
* @memberof CreateTaskBody
|
|
2013
|
+
*/
|
|
2014
|
+
'parentTaskId'?: string;
|
|
2015
|
+
/**
|
|
2016
|
+
* Conversation id related to this task
|
|
2017
|
+
* @type {string}
|
|
2018
|
+
* @memberof CreateTaskBody
|
|
2019
|
+
*/
|
|
2020
|
+
'conversationId': string;
|
|
2021
|
+
/**
|
|
2022
|
+
* Specific user related to this task
|
|
2023
|
+
* @type {string}
|
|
2024
|
+
* @memberof CreateTaskBody
|
|
2025
|
+
*/
|
|
2026
|
+
'userId'?: string;
|
|
2027
|
+
/**
|
|
2028
|
+
* The timeout date where the task should be failed in the ISO 8601 format
|
|
2029
|
+
* @type {string}
|
|
2030
|
+
* @memberof CreateTaskBody
|
|
2031
|
+
*/
|
|
2032
|
+
'timeoutAt'?: string;
|
|
2033
|
+
/**
|
|
2034
|
+
* Tags for the [Task](#schema_task)
|
|
2035
|
+
* @type {{ [key: string]: string; }}
|
|
2036
|
+
* @memberof CreateTaskBody
|
|
2037
|
+
*/
|
|
2038
|
+
'tags'?: {
|
|
2039
|
+
[key: string]: string;
|
|
2040
|
+
};
|
|
2041
|
+
}
|
|
2042
|
+
/**
|
|
2043
|
+
*
|
|
2044
|
+
* @export
|
|
2045
|
+
* @interface CreateTaskResponse
|
|
2046
|
+
*/
|
|
2047
|
+
export interface CreateTaskResponse {
|
|
2048
|
+
/**
|
|
2049
|
+
*
|
|
2050
|
+
* @type {Task}
|
|
2051
|
+
* @memberof CreateTaskResponse
|
|
2052
|
+
*/
|
|
2053
|
+
'task': Task;
|
|
2054
|
+
}
|
|
1869
2055
|
/**
|
|
1870
2056
|
*
|
|
1871
2057
|
* @export
|
|
@@ -2108,6 +2294,12 @@ export interface CreateWorkspaceResponse {
|
|
|
2108
2294
|
* @memberof CreateWorkspaceResponse
|
|
2109
2295
|
*/
|
|
2110
2296
|
'isPublic'?: boolean;
|
|
2297
|
+
/**
|
|
2298
|
+
*
|
|
2299
|
+
* @type {string}
|
|
2300
|
+
* @memberof CreateWorkspaceResponse
|
|
2301
|
+
*/
|
|
2302
|
+
'handle'?: string;
|
|
2111
2303
|
}
|
|
2112
2304
|
export declare const CreateWorkspaceResponseAccountTypeEnum: {
|
|
2113
2305
|
readonly Free: "free";
|
|
@@ -2144,7 +2336,7 @@ export interface Event {
|
|
|
2144
2336
|
*/
|
|
2145
2337
|
'createdAt': string;
|
|
2146
2338
|
/**
|
|
2147
|
-
* Type of the
|
|
2339
|
+
* Type of the task
|
|
2148
2340
|
* @type {string}
|
|
2149
2341
|
* @memberof Event
|
|
2150
2342
|
*/
|
|
@@ -2176,12 +2368,25 @@ export interface Event {
|
|
|
2176
2368
|
*/
|
|
2177
2369
|
'messageId'?: string;
|
|
2178
2370
|
/**
|
|
2179
|
-
*
|
|
2371
|
+
*
|
|
2180
2372
|
* @type {string}
|
|
2181
2373
|
* @memberof Event
|
|
2182
2374
|
*/
|
|
2183
|
-
'status':
|
|
2375
|
+
'status': EventStatusEnum;
|
|
2376
|
+
/**
|
|
2377
|
+
* Reason why the event failed to be processed
|
|
2378
|
+
* @type {string}
|
|
2379
|
+
* @memberof Event
|
|
2380
|
+
*/
|
|
2381
|
+
'failureReason': string | null;
|
|
2184
2382
|
}
|
|
2383
|
+
export declare const EventStatusEnum: {
|
|
2384
|
+
readonly Pending: "pending";
|
|
2385
|
+
readonly Processed: "processed";
|
|
2386
|
+
readonly Ignored: "ignored";
|
|
2387
|
+
readonly Failed: "failed";
|
|
2388
|
+
};
|
|
2389
|
+
export type EventStatusEnum = typeof EventStatusEnum[keyof typeof EventStatusEnum];
|
|
2185
2390
|
/**
|
|
2186
2391
|
*
|
|
2187
2392
|
* @export
|
|
@@ -2807,6 +3012,19 @@ export interface GetStateResponse {
|
|
|
2807
3012
|
*/
|
|
2808
3013
|
'state': State;
|
|
2809
3014
|
}
|
|
3015
|
+
/**
|
|
3016
|
+
*
|
|
3017
|
+
* @export
|
|
3018
|
+
* @interface GetTaskResponse
|
|
3019
|
+
*/
|
|
3020
|
+
export interface GetTaskResponse {
|
|
3021
|
+
/**
|
|
3022
|
+
*
|
|
3023
|
+
* @type {Task}
|
|
3024
|
+
* @memberof GetTaskResponse
|
|
3025
|
+
*/
|
|
3026
|
+
'task': Task;
|
|
3027
|
+
}
|
|
2810
3028
|
/**
|
|
2811
3029
|
*
|
|
2812
3030
|
* @export
|
|
@@ -3114,6 +3332,12 @@ export interface GetWorkspaceResponse {
|
|
|
3114
3332
|
* @memberof GetWorkspaceResponse
|
|
3115
3333
|
*/
|
|
3116
3334
|
'isPublic'?: boolean;
|
|
3335
|
+
/**
|
|
3336
|
+
*
|
|
3337
|
+
* @type {string}
|
|
3338
|
+
* @memberof GetWorkspaceResponse
|
|
3339
|
+
*/
|
|
3340
|
+
'handle'?: string;
|
|
3117
3341
|
}
|
|
3118
3342
|
export declare const GetWorkspaceResponseAccountTypeEnum: {
|
|
3119
3343
|
readonly Free: "free";
|
|
@@ -3162,13 +3386,13 @@ export interface Integration {
|
|
|
3162
3386
|
*/
|
|
3163
3387
|
'identifier': IntegrationIdentifier;
|
|
3164
3388
|
/**
|
|
3165
|
-
* Type of the
|
|
3389
|
+
* Type of the task
|
|
3166
3390
|
* @type {string}
|
|
3167
3391
|
* @memberof Integration
|
|
3168
3392
|
*/
|
|
3169
3393
|
'name': string;
|
|
3170
3394
|
/**
|
|
3171
|
-
* Type of the
|
|
3395
|
+
* Type of the task
|
|
3172
3396
|
* @type {string}
|
|
3173
3397
|
* @memberof Integration
|
|
3174
3398
|
*/
|
|
@@ -3342,7 +3566,7 @@ export interface IntegrationConfiguration {
|
|
|
3342
3566
|
*/
|
|
3343
3567
|
export interface IntegrationConfigurationIdentifier {
|
|
3344
3568
|
/**
|
|
3345
|
-
*
|
|
3569
|
+
* Title describing the task
|
|
3346
3570
|
* @type {string}
|
|
3347
3571
|
* @memberof IntegrationConfigurationIdentifier
|
|
3348
3572
|
*/
|
|
@@ -3554,6 +3778,25 @@ export interface IssueGroupedDataValue {
|
|
|
3554
3778
|
*/
|
|
3555
3779
|
'pretty'?: string;
|
|
3556
3780
|
}
|
|
3781
|
+
/**
|
|
3782
|
+
*
|
|
3783
|
+
* @export
|
|
3784
|
+
* @interface ListActivitiesResponse
|
|
3785
|
+
*/
|
|
3786
|
+
export interface ListActivitiesResponse {
|
|
3787
|
+
/**
|
|
3788
|
+
*
|
|
3789
|
+
* @type {Array<Activity>}
|
|
3790
|
+
* @memberof ListActivitiesResponse
|
|
3791
|
+
*/
|
|
3792
|
+
'activities': Array<Activity>;
|
|
3793
|
+
/**
|
|
3794
|
+
*
|
|
3795
|
+
* @type {ListConversationsResponseMeta}
|
|
3796
|
+
* @memberof ListActivitiesResponse
|
|
3797
|
+
*/
|
|
3798
|
+
'meta': ListConversationsResponseMeta;
|
|
3799
|
+
}
|
|
3557
3800
|
/**
|
|
3558
3801
|
*
|
|
3559
3802
|
* @export
|
|
@@ -4003,6 +4246,25 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
|
|
|
4003
4246
|
*/
|
|
4004
4247
|
'iconUrl': string;
|
|
4005
4248
|
}
|
|
4249
|
+
/**
|
|
4250
|
+
*
|
|
4251
|
+
* @export
|
|
4252
|
+
* @interface ListTasksResponse
|
|
4253
|
+
*/
|
|
4254
|
+
export interface ListTasksResponse {
|
|
4255
|
+
/**
|
|
4256
|
+
*
|
|
4257
|
+
* @type {Array<Task>}
|
|
4258
|
+
* @memberof ListTasksResponse
|
|
4259
|
+
*/
|
|
4260
|
+
'tasks': Array<Task>;
|
|
4261
|
+
/**
|
|
4262
|
+
*
|
|
4263
|
+
* @type {ListConversationsResponseMeta}
|
|
4264
|
+
* @memberof ListTasksResponse
|
|
4265
|
+
*/
|
|
4266
|
+
'meta': ListConversationsResponseMeta;
|
|
4267
|
+
}
|
|
4006
4268
|
/**
|
|
4007
4269
|
*
|
|
4008
4270
|
* @export
|
|
@@ -4303,7 +4565,7 @@ export interface Message {
|
|
|
4303
4565
|
*/
|
|
4304
4566
|
'createdAt': string;
|
|
4305
4567
|
/**
|
|
4306
|
-
* Type of the
|
|
4568
|
+
* Type of the task
|
|
4307
4569
|
* @type {string}
|
|
4308
4570
|
* @memberof Message
|
|
4309
4571
|
*/
|
|
@@ -4660,7 +4922,7 @@ export interface State {
|
|
|
4660
4922
|
*/
|
|
4661
4923
|
'userId'?: string;
|
|
4662
4924
|
/**
|
|
4663
|
-
* Type of the
|
|
4925
|
+
* Type of the task
|
|
4664
4926
|
* @type {string}
|
|
4665
4927
|
* @memberof State
|
|
4666
4928
|
*/
|
|
@@ -4712,19 +4974,11 @@ export interface Table {
|
|
|
4712
4974
|
*/
|
|
4713
4975
|
'factor'?: number;
|
|
4714
4976
|
/**
|
|
4715
|
-
*
|
|
4716
|
-
* @type {
|
|
4977
|
+
*
|
|
4978
|
+
* @type {TableSchema}
|
|
4717
4979
|
* @memberof Table
|
|
4718
4980
|
*/
|
|
4719
|
-
'
|
|
4720
|
-
/**
|
|
4721
|
-
* Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
|
|
4722
|
-
* @type {{ [key: string]: any; }}
|
|
4723
|
-
* @memberof Table
|
|
4724
|
-
*/
|
|
4725
|
-
'schema': {
|
|
4726
|
-
[key: string]: any;
|
|
4727
|
-
};
|
|
4981
|
+
'schema': TableSchema;
|
|
4728
4982
|
/**
|
|
4729
4983
|
* Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.
|
|
4730
4984
|
* @type {{ [key: string]: string; }}
|
|
@@ -4749,62 +5003,226 @@ export interface Table {
|
|
|
4749
5003
|
/**
|
|
4750
5004
|
*
|
|
4751
5005
|
* @export
|
|
4752
|
-
* @interface
|
|
5006
|
+
* @interface TableSchema
|
|
4753
5007
|
*/
|
|
4754
|
-
export interface
|
|
5008
|
+
export interface TableSchema {
|
|
4755
5009
|
/**
|
|
4756
|
-
*
|
|
5010
|
+
*
|
|
4757
5011
|
* @type {string}
|
|
4758
|
-
* @memberof
|
|
5012
|
+
* @memberof TableSchema
|
|
4759
5013
|
*/
|
|
4760
|
-
'
|
|
5014
|
+
'$schema': string;
|
|
4761
5015
|
/**
|
|
4762
|
-
*
|
|
5016
|
+
* List of keys/columns in the table.
|
|
5017
|
+
* @type {{ [key: string]: TableSchemaPropertiesValue; }}
|
|
5018
|
+
* @memberof TableSchema
|
|
5019
|
+
*/
|
|
5020
|
+
'properties': {
|
|
5021
|
+
[key: string]: TableSchemaPropertiesValue;
|
|
5022
|
+
};
|
|
5023
|
+
/**
|
|
5024
|
+
* Additional properties can be provided, but they will be ignored if no column matches.
|
|
5025
|
+
* @type {boolean}
|
|
5026
|
+
* @memberof TableSchema
|
|
5027
|
+
*/
|
|
5028
|
+
'additionalProperties': boolean;
|
|
5029
|
+
/**
|
|
5030
|
+
* Array of required properties.
|
|
5031
|
+
* @type {Array<string>}
|
|
5032
|
+
* @memberof TableSchema
|
|
5033
|
+
*/
|
|
5034
|
+
'required'?: Array<string>;
|
|
5035
|
+
/**
|
|
5036
|
+
*
|
|
4763
5037
|
* @type {string}
|
|
4764
|
-
* @memberof
|
|
5038
|
+
* @memberof TableSchema
|
|
4765
5039
|
*/
|
|
4766
|
-
'
|
|
5040
|
+
'type': TableSchemaTypeEnum;
|
|
5041
|
+
}
|
|
5042
|
+
export declare const TableSchemaTypeEnum: {
|
|
5043
|
+
readonly Object: "object";
|
|
5044
|
+
};
|
|
5045
|
+
export type TableSchemaTypeEnum = typeof TableSchemaTypeEnum[keyof typeof TableSchemaTypeEnum];
|
|
5046
|
+
/**
|
|
5047
|
+
*
|
|
5048
|
+
* @export
|
|
5049
|
+
* @interface TableSchemaPropertiesValue
|
|
5050
|
+
*/
|
|
5051
|
+
export interface TableSchemaPropertiesValue {
|
|
4767
5052
|
/**
|
|
4768
|
-
*
|
|
5053
|
+
*
|
|
4769
5054
|
* @type {string}
|
|
4770
|
-
* @memberof
|
|
5055
|
+
* @memberof TableSchemaPropertiesValue
|
|
5056
|
+
*/
|
|
5057
|
+
'type': TableSchemaPropertiesValueTypeEnum;
|
|
5058
|
+
/**
|
|
5059
|
+
*
|
|
5060
|
+
* @type {string}
|
|
5061
|
+
* @memberof TableSchemaPropertiesValue
|
|
5062
|
+
*/
|
|
5063
|
+
'format'?: TableSchemaPropertiesValueFormatEnum;
|
|
5064
|
+
/**
|
|
5065
|
+
*
|
|
5066
|
+
* @type {string}
|
|
5067
|
+
* @memberof TableSchemaPropertiesValue
|
|
4771
5068
|
*/
|
|
4772
5069
|
'description'?: string;
|
|
5070
|
+
/**
|
|
5071
|
+
*
|
|
5072
|
+
* @type {boolean}
|
|
5073
|
+
* @memberof TableSchemaPropertiesValue
|
|
5074
|
+
*/
|
|
5075
|
+
'nullable'?: boolean;
|
|
5076
|
+
/**
|
|
5077
|
+
*
|
|
5078
|
+
* @type {TableSchemaPropertiesValueXZui}
|
|
5079
|
+
* @memberof TableSchemaPropertiesValue
|
|
5080
|
+
*/
|
|
5081
|
+
'x-zui': TableSchemaPropertiesValueXZui;
|
|
5082
|
+
}
|
|
5083
|
+
export declare const TableSchemaPropertiesValueTypeEnum: {
|
|
5084
|
+
readonly String: "string";
|
|
5085
|
+
readonly Number: "number";
|
|
5086
|
+
readonly Boolean: "boolean";
|
|
5087
|
+
readonly Object: "object";
|
|
5088
|
+
readonly Null: "null";
|
|
5089
|
+
};
|
|
5090
|
+
export type TableSchemaPropertiesValueTypeEnum = typeof TableSchemaPropertiesValueTypeEnum[keyof typeof TableSchemaPropertiesValueTypeEnum];
|
|
5091
|
+
export declare const TableSchemaPropertiesValueFormatEnum: {
|
|
5092
|
+
readonly DateTime: "date-time";
|
|
5093
|
+
};
|
|
5094
|
+
export type TableSchemaPropertiesValueFormatEnum = typeof TableSchemaPropertiesValueFormatEnum[keyof typeof TableSchemaPropertiesValueFormatEnum];
|
|
5095
|
+
/**
|
|
5096
|
+
*
|
|
5097
|
+
* @export
|
|
5098
|
+
* @interface TableSchemaPropertiesValueXZui
|
|
5099
|
+
*/
|
|
5100
|
+
export interface TableSchemaPropertiesValueXZui {
|
|
5101
|
+
/**
|
|
5102
|
+
*
|
|
5103
|
+
* @type {number}
|
|
5104
|
+
* @memberof TableSchemaPropertiesValueXZui
|
|
5105
|
+
*/
|
|
5106
|
+
'index': number;
|
|
4773
5107
|
/**
|
|
4774
5108
|
* Indicates if the column is vectorized and searchable.
|
|
4775
5109
|
* @type {boolean}
|
|
4776
|
-
* @memberof
|
|
5110
|
+
* @memberof TableSchemaPropertiesValueXZui
|
|
4777
5111
|
*/
|
|
4778
5112
|
'searchable'?: boolean;
|
|
4779
5113
|
/**
|
|
4780
|
-
*
|
|
5114
|
+
* TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\"
|
|
4781
5115
|
* @type {string}
|
|
4782
|
-
* @memberof
|
|
5116
|
+
* @memberof TableSchemaPropertiesValueXZui
|
|
4783
5117
|
*/
|
|
4784
|
-
'
|
|
5118
|
+
'typings'?: string;
|
|
5119
|
+
}
|
|
5120
|
+
/**
|
|
5121
|
+
* Task definition
|
|
5122
|
+
* @export
|
|
5123
|
+
* @interface Task
|
|
5124
|
+
*/
|
|
5125
|
+
export interface Task {
|
|
4785
5126
|
/**
|
|
4786
|
-
*
|
|
5127
|
+
* ID of the [Conversation](#schema_conversation)
|
|
4787
5128
|
* @type {string}
|
|
4788
|
-
* @memberof
|
|
5129
|
+
* @memberof Task
|
|
4789
5130
|
*/
|
|
4790
|
-
'
|
|
5131
|
+
'id': string;
|
|
4791
5132
|
/**
|
|
4792
|
-
*
|
|
5133
|
+
* Title describing the task
|
|
5134
|
+
* @type {string}
|
|
5135
|
+
* @memberof Task
|
|
5136
|
+
*/
|
|
5137
|
+
'title': string;
|
|
5138
|
+
/**
|
|
5139
|
+
* All the notes related to the execution of the current task
|
|
5140
|
+
* @type {string}
|
|
5141
|
+
* @memberof Task
|
|
5142
|
+
*/
|
|
5143
|
+
'description': string;
|
|
5144
|
+
/**
|
|
5145
|
+
* Type of the task
|
|
5146
|
+
* @type {string}
|
|
5147
|
+
* @memberof Task
|
|
5148
|
+
*/
|
|
5149
|
+
'type': string;
|
|
5150
|
+
/**
|
|
5151
|
+
* Content related to the task
|
|
4793
5152
|
* @type {{ [key: string]: any; }}
|
|
4794
|
-
* @memberof
|
|
5153
|
+
* @memberof Task
|
|
4795
5154
|
*/
|
|
4796
|
-
'
|
|
5155
|
+
'data': {
|
|
4797
5156
|
[key: string]: any;
|
|
4798
5157
|
};
|
|
5158
|
+
/**
|
|
5159
|
+
* Status of the task
|
|
5160
|
+
* @type {string}
|
|
5161
|
+
* @memberof Task
|
|
5162
|
+
*/
|
|
5163
|
+
'status': TaskStatusEnum;
|
|
5164
|
+
/**
|
|
5165
|
+
* Parent task id is the parent task that created this task
|
|
5166
|
+
* @type {string}
|
|
5167
|
+
* @memberof Task
|
|
5168
|
+
*/
|
|
5169
|
+
'parentTaskId'?: string;
|
|
5170
|
+
/**
|
|
5171
|
+
* Conversation id related to this task
|
|
5172
|
+
* @type {string}
|
|
5173
|
+
* @memberof Task
|
|
5174
|
+
*/
|
|
5175
|
+
'conversationId'?: string;
|
|
5176
|
+
/**
|
|
5177
|
+
* Specific user related to this task
|
|
5178
|
+
* @type {string}
|
|
5179
|
+
* @memberof Task
|
|
5180
|
+
*/
|
|
5181
|
+
'userId'?: string;
|
|
5182
|
+
/**
|
|
5183
|
+
* The timeout date where the task should be failed in the ISO 8601 format
|
|
5184
|
+
* @type {string}
|
|
5185
|
+
* @memberof Task
|
|
5186
|
+
*/
|
|
5187
|
+
'timeoutAt': string;
|
|
5188
|
+
/**
|
|
5189
|
+
* Creation date of the task in ISO 8601 format
|
|
5190
|
+
* @type {string}
|
|
5191
|
+
* @memberof Task
|
|
5192
|
+
*/
|
|
5193
|
+
'createdAt': string;
|
|
5194
|
+
/**
|
|
5195
|
+
* Updating date of the task in ISO 8601 format
|
|
5196
|
+
* @type {string}
|
|
5197
|
+
* @memberof Task
|
|
5198
|
+
*/
|
|
5199
|
+
'updatedAt': string;
|
|
5200
|
+
/**
|
|
5201
|
+
* If the task fails this is the reason behind it
|
|
5202
|
+
* @type {string}
|
|
5203
|
+
* @memberof Task
|
|
5204
|
+
*/
|
|
5205
|
+
'failureReason'?: string;
|
|
5206
|
+
/**
|
|
5207
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them.
|
|
5208
|
+
* @type {{ [key: string]: string; }}
|
|
5209
|
+
* @memberof Task
|
|
5210
|
+
*/
|
|
5211
|
+
'tags': {
|
|
5212
|
+
[key: string]: string;
|
|
5213
|
+
};
|
|
4799
5214
|
}
|
|
4800
|
-
export declare const
|
|
4801
|
-
readonly
|
|
4802
|
-
readonly
|
|
4803
|
-
readonly
|
|
4804
|
-
readonly
|
|
4805
|
-
readonly
|
|
5215
|
+
export declare const TaskStatusEnum: {
|
|
5216
|
+
readonly Pending: "pending";
|
|
5217
|
+
readonly InProgress: "in_progress";
|
|
5218
|
+
readonly Failed: "failed";
|
|
5219
|
+
readonly Completed: "completed";
|
|
5220
|
+
readonly Blocked: "blocked";
|
|
5221
|
+
readonly Paused: "paused";
|
|
5222
|
+
readonly Timeout: "timeout";
|
|
5223
|
+
readonly Cancelled: "cancelled";
|
|
4806
5224
|
};
|
|
4807
|
-
export type
|
|
5225
|
+
export type TaskStatusEnum = typeof TaskStatusEnum[keyof typeof TaskStatusEnum];
|
|
4808
5226
|
/**
|
|
4809
5227
|
*
|
|
4810
5228
|
* @export
|
|
@@ -5368,7 +5786,7 @@ export interface UpdateIntegrationBodyConfiguration {
|
|
|
5368
5786
|
*/
|
|
5369
5787
|
export interface UpdateIntegrationBodyConfigurationIdentifier {
|
|
5370
5788
|
/**
|
|
5371
|
-
*
|
|
5789
|
+
* Title describing the task
|
|
5372
5790
|
* @type {string}
|
|
5373
5791
|
* @memberof UpdateIntegrationBodyConfigurationIdentifier
|
|
5374
5792
|
*/
|
|
@@ -5387,13 +5805,13 @@ export interface UpdateIntegrationBodyConfigurationIdentifier {
|
|
|
5387
5805
|
*/
|
|
5388
5806
|
export interface UpdateIntegrationBodyIdentifier {
|
|
5389
5807
|
/**
|
|
5390
|
-
*
|
|
5808
|
+
* Title describing the task
|
|
5391
5809
|
* @type {string}
|
|
5392
5810
|
* @memberof UpdateIntegrationBodyIdentifier
|
|
5393
5811
|
*/
|
|
5394
5812
|
'extractScript'?: string | null;
|
|
5395
5813
|
/**
|
|
5396
|
-
*
|
|
5814
|
+
* Title describing the task
|
|
5397
5815
|
* @type {string}
|
|
5398
5816
|
* @memberof UpdateIntegrationBodyIdentifier
|
|
5399
5817
|
*/
|
|
@@ -5467,26 +5885,97 @@ export interface UpdateIntegrationResponse {
|
|
|
5467
5885
|
*/
|
|
5468
5886
|
export interface UpdateMessageBody {
|
|
5469
5887
|
/**
|
|
5470
|
-
* Set of [Tags](#tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
5888
|
+
* Set of [Tags](#tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
5889
|
+
* @type {{ [key: string]: string; }}
|
|
5890
|
+
* @memberof UpdateMessageBody
|
|
5891
|
+
*/
|
|
5892
|
+
'tags': {
|
|
5893
|
+
[key: string]: string;
|
|
5894
|
+
};
|
|
5895
|
+
}
|
|
5896
|
+
/**
|
|
5897
|
+
*
|
|
5898
|
+
* @export
|
|
5899
|
+
* @interface UpdateMessageResponse
|
|
5900
|
+
*/
|
|
5901
|
+
export interface UpdateMessageResponse {
|
|
5902
|
+
/**
|
|
5903
|
+
*
|
|
5904
|
+
* @type {Message}
|
|
5905
|
+
* @memberof UpdateMessageResponse
|
|
5906
|
+
*/
|
|
5907
|
+
'message': Message;
|
|
5908
|
+
}
|
|
5909
|
+
/**
|
|
5910
|
+
*
|
|
5911
|
+
* @export
|
|
5912
|
+
* @interface UpdateTaskBody
|
|
5913
|
+
*/
|
|
5914
|
+
export interface UpdateTaskBody {
|
|
5915
|
+
/**
|
|
5916
|
+
* Title describing the task
|
|
5917
|
+
* @type {string}
|
|
5918
|
+
* @memberof UpdateTaskBody
|
|
5919
|
+
*/
|
|
5920
|
+
'title'?: string;
|
|
5921
|
+
/**
|
|
5922
|
+
* All the notes related to the execution of the current task
|
|
5923
|
+
* @type {string}
|
|
5924
|
+
* @memberof UpdateTaskBody
|
|
5925
|
+
*/
|
|
5926
|
+
'description'?: string;
|
|
5927
|
+
/**
|
|
5928
|
+
* Content related to the task
|
|
5929
|
+
* @type {{ [key: string]: any; }}
|
|
5930
|
+
* @memberof UpdateTaskBody
|
|
5931
|
+
*/
|
|
5932
|
+
'data'?: {
|
|
5933
|
+
[key: string]: any;
|
|
5934
|
+
};
|
|
5935
|
+
/**
|
|
5936
|
+
* The timeout date where the task should be failed in the ISO 8601 format
|
|
5937
|
+
* @type {string}
|
|
5938
|
+
* @memberof UpdateTaskBody
|
|
5939
|
+
*/
|
|
5940
|
+
'timeoutAt'?: string;
|
|
5941
|
+
/**
|
|
5942
|
+
* Status of the task
|
|
5943
|
+
* @type {string}
|
|
5944
|
+
* @memberof UpdateTaskBody
|
|
5945
|
+
*/
|
|
5946
|
+
'status'?: UpdateTaskBodyStatusEnum;
|
|
5947
|
+
/**
|
|
5948
|
+
* Tags for the [Task](#schema_task)
|
|
5471
5949
|
* @type {{ [key: string]: string; }}
|
|
5472
|
-
* @memberof
|
|
5950
|
+
* @memberof UpdateTaskBody
|
|
5473
5951
|
*/
|
|
5474
|
-
'tags'
|
|
5952
|
+
'tags'?: {
|
|
5475
5953
|
[key: string]: string;
|
|
5476
5954
|
};
|
|
5477
5955
|
}
|
|
5956
|
+
export declare const UpdateTaskBodyStatusEnum: {
|
|
5957
|
+
readonly Pending: "pending";
|
|
5958
|
+
readonly InProgress: "in_progress";
|
|
5959
|
+
readonly Failed: "failed";
|
|
5960
|
+
readonly Completed: "completed";
|
|
5961
|
+
readonly Blocked: "blocked";
|
|
5962
|
+
readonly Paused: "paused";
|
|
5963
|
+
readonly Timeout: "timeout";
|
|
5964
|
+
readonly Cancelled: "cancelled";
|
|
5965
|
+
};
|
|
5966
|
+
export type UpdateTaskBodyStatusEnum = typeof UpdateTaskBodyStatusEnum[keyof typeof UpdateTaskBodyStatusEnum];
|
|
5478
5967
|
/**
|
|
5479
5968
|
*
|
|
5480
5969
|
* @export
|
|
5481
|
-
* @interface
|
|
5970
|
+
* @interface UpdateTaskResponse
|
|
5482
5971
|
*/
|
|
5483
|
-
export interface
|
|
5972
|
+
export interface UpdateTaskResponse {
|
|
5484
5973
|
/**
|
|
5485
5974
|
*
|
|
5486
|
-
* @type {
|
|
5487
|
-
* @memberof
|
|
5975
|
+
* @type {Task}
|
|
5976
|
+
* @memberof UpdateTaskResponse
|
|
5488
5977
|
*/
|
|
5489
|
-
'
|
|
5978
|
+
'task': Task;
|
|
5490
5979
|
}
|
|
5491
5980
|
/**
|
|
5492
5981
|
*
|
|
@@ -5582,6 +6071,12 @@ export interface UpdateWorkspaceBody {
|
|
|
5582
6071
|
* @memberof UpdateWorkspaceBody
|
|
5583
6072
|
*/
|
|
5584
6073
|
'isPublic'?: boolean;
|
|
6074
|
+
/**
|
|
6075
|
+
*
|
|
6076
|
+
* @type {string}
|
|
6077
|
+
* @memberof UpdateWorkspaceBody
|
|
6078
|
+
*/
|
|
6079
|
+
'handle'?: string;
|
|
5585
6080
|
}
|
|
5586
6081
|
/**
|
|
5587
6082
|
*
|
|
@@ -5759,6 +6254,12 @@ export interface UpdateWorkspaceResponse {
|
|
|
5759
6254
|
* @memberof UpdateWorkspaceResponse
|
|
5760
6255
|
*/
|
|
5761
6256
|
'isPublic'?: boolean;
|
|
6257
|
+
/**
|
|
6258
|
+
*
|
|
6259
|
+
* @type {string}
|
|
6260
|
+
* @memberof UpdateWorkspaceResponse
|
|
6261
|
+
*/
|
|
6262
|
+
'handle'?: string;
|
|
5762
6263
|
}
|
|
5763
6264
|
export declare const UpdateWorkspaceResponseAccountTypeEnum: {
|
|
5764
6265
|
readonly Free: "free";
|
|
@@ -5884,6 +6385,12 @@ export interface UpdateWorkspaceResponse1 {
|
|
|
5884
6385
|
* @memberof UpdateWorkspaceResponse1
|
|
5885
6386
|
*/
|
|
5886
6387
|
'isPublic'?: boolean;
|
|
6388
|
+
/**
|
|
6389
|
+
*
|
|
6390
|
+
* @type {string}
|
|
6391
|
+
* @memberof UpdateWorkspaceResponse1
|
|
6392
|
+
*/
|
|
6393
|
+
'handle'?: string;
|
|
5887
6394
|
}
|
|
5888
6395
|
export declare const UpdateWorkspaceResponse1AccountTypeEnum: {
|
|
5889
6396
|
readonly Free: "free";
|
|
@@ -6107,6 +6614,12 @@ export interface Workspace {
|
|
|
6107
6614
|
* @memberof Workspace
|
|
6108
6615
|
*/
|
|
6109
6616
|
'isPublic'?: boolean;
|
|
6617
|
+
/**
|
|
6618
|
+
*
|
|
6619
|
+
* @type {string}
|
|
6620
|
+
* @memberof Workspace
|
|
6621
|
+
*/
|
|
6622
|
+
'handle'?: string;
|
|
6110
6623
|
}
|
|
6111
6624
|
export declare const WorkspaceAccountTypeEnum: {
|
|
6112
6625
|
readonly Free: "free";
|
|
@@ -6222,6 +6735,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6222
6735
|
* @throws {RequiredError}
|
|
6223
6736
|
*/
|
|
6224
6737
|
chargeWorkspaceUnpaidInvoices: (id: string, chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6738
|
+
/**
|
|
6739
|
+
* Check if a workspace handle is available
|
|
6740
|
+
* @param {CheckHandleAvailabilityBody} [checkHandleAvailabilityBody] Workspace handle availability
|
|
6741
|
+
* @param {*} [options] Override http request option.
|
|
6742
|
+
* @throws {RequiredError}
|
|
6743
|
+
*/
|
|
6744
|
+
checkHandleAvailability: (checkHandleAvailabilityBody?: CheckHandleAvailabilityBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6225
6745
|
/**
|
|
6226
6746
|
* An integration can call this endpoint to configure itself
|
|
6227
6747
|
* @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
|
|
@@ -6278,6 +6798,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6278
6798
|
* @throws {RequiredError}
|
|
6279
6799
|
*/
|
|
6280
6800
|
createPersonalAccessToken: (createPersonalAccessTokenBody?: CreatePersonalAccessTokenBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6801
|
+
/**
|
|
6802
|
+
* Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.
|
|
6803
|
+
* @param {CreateTaskBody} [createTaskBody] Task data
|
|
6804
|
+
* @param {*} [options] Override http request option.
|
|
6805
|
+
* @throws {RequiredError}
|
|
6806
|
+
*/
|
|
6807
|
+
createTask: (createTaskBody?: CreateTaskBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6281
6808
|
/**
|
|
6282
6809
|
* 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.
|
|
6283
6810
|
* @param {CreateUserBody} [createUserBody] User data
|
|
@@ -6349,6 +6876,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6349
6876
|
* @throws {RequiredError}
|
|
6350
6877
|
*/
|
|
6351
6878
|
deletePersonalAccessToken: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6879
|
+
/**
|
|
6880
|
+
* Permanently deletes a [Task](#schema_task). It cannot be undone.
|
|
6881
|
+
* @param {string} id Task id
|
|
6882
|
+
* @param {*} [options] Override http request option.
|
|
6883
|
+
* @throws {RequiredError}
|
|
6884
|
+
*/
|
|
6885
|
+
deleteTask: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6352
6886
|
/**
|
|
6353
6887
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
6354
6888
|
* @param {string} id User ID
|
|
@@ -6544,6 +7078,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6544
7078
|
* @throws {RequiredError}
|
|
6545
7079
|
*/
|
|
6546
7080
|
getState: (type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7081
|
+
/**
|
|
7082
|
+
* Retrieves the [Task](#schema_task) object for a valid identifier.
|
|
7083
|
+
* @param {string} id Task id
|
|
7084
|
+
* @param {*} [options] Override http request option.
|
|
7085
|
+
* @throws {RequiredError}
|
|
7086
|
+
*/
|
|
7087
|
+
getTask: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6547
7088
|
/**
|
|
6548
7089
|
* Get usage
|
|
6549
7090
|
* @param {GetUsageTypeEnum} type Type of usage
|
|
@@ -6590,6 +7131,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6590
7131
|
* @throws {RequiredError}
|
|
6591
7132
|
*/
|
|
6592
7133
|
introspect: (introspectBody?: IntrospectBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7134
|
+
/**
|
|
7135
|
+
* List activities of a task
|
|
7136
|
+
* @param {string} taskId ID of the task to list activities for
|
|
7137
|
+
* @param {string} botId ID of the bot to list activities for
|
|
7138
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
7139
|
+
* @param {*} [options] Override http request option.
|
|
7140
|
+
* @throws {RequiredError}
|
|
7141
|
+
*/
|
|
7142
|
+
listActivities: (taskId: string, botId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6593
7143
|
/**
|
|
6594
7144
|
* List Events for a Bot Issue
|
|
6595
7145
|
* @param {string} id Bot ID
|
|
@@ -6688,6 +7238,21 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6688
7238
|
* @throws {RequiredError}
|
|
6689
7239
|
*/
|
|
6690
7240
|
listPublicIntegrations: (nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7241
|
+
/**
|
|
7242
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
7243
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
7244
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
7245
|
+
* @param {string} [conversationId] Conversation id
|
|
7246
|
+
* @param {string} [userId] User id
|
|
7247
|
+
* @param {string} [parentTaskId] Parent task id
|
|
7248
|
+
* @param {Array<ListTasksStatusEnum>} [status] Status
|
|
7249
|
+
* @param {string} [type] Type
|
|
7250
|
+
* @param {*} [options] Override http request option.
|
|
7251
|
+
* @throws {RequiredError}
|
|
7252
|
+
*/
|
|
7253
|
+
listTasks: (nextToken?: string, tags?: {
|
|
7254
|
+
[key: string]: string;
|
|
7255
|
+
} | undefined, conversationId?: string, userId?: string, parentTaskId?: string, status?: Array<ListTasksStatusEnum>, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6691
7256
|
/**
|
|
6692
7257
|
* Get usage history
|
|
6693
7258
|
* @param {ListUsageHistoryTypeEnum} type Type of usage
|
|
@@ -6836,6 +7401,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6836
7401
|
* @throws {RequiredError}
|
|
6837
7402
|
*/
|
|
6838
7403
|
updateMessage: (id: string, updateMessageBody?: UpdateMessageBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7404
|
+
/**
|
|
7405
|
+
* Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
7406
|
+
* @param {string} id Task id
|
|
7407
|
+
* @param {UpdateTaskBody} [updateTaskBody] Task data
|
|
7408
|
+
* @param {*} [options] Override http request option.
|
|
7409
|
+
* @throws {RequiredError}
|
|
7410
|
+
*/
|
|
7411
|
+
updateTask: (id: string, updateTaskBody?: UpdateTaskBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6839
7412
|
/**
|
|
6840
7413
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
6841
7414
|
* @param {string} id User ID
|
|
@@ -6913,6 +7486,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6913
7486
|
* @throws {RequiredError}
|
|
6914
7487
|
*/
|
|
6915
7488
|
chargeWorkspaceUnpaidInvoices(id: string, chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChargeWorkspaceUnpaidInvoicesResponse>>;
|
|
7489
|
+
/**
|
|
7490
|
+
* Check if a workspace handle is available
|
|
7491
|
+
* @param {CheckHandleAvailabilityBody} [checkHandleAvailabilityBody] Workspace handle availability
|
|
7492
|
+
* @param {*} [options] Override http request option.
|
|
7493
|
+
* @throws {RequiredError}
|
|
7494
|
+
*/
|
|
7495
|
+
checkHandleAvailability(checkHandleAvailabilityBody?: CheckHandleAvailabilityBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckHandleAvailabilityResponse>>;
|
|
6916
7496
|
/**
|
|
6917
7497
|
* An integration can call this endpoint to configure itself
|
|
6918
7498
|
* @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
|
|
@@ -6969,6 +7549,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6969
7549
|
* @throws {RequiredError}
|
|
6970
7550
|
*/
|
|
6971
7551
|
createPersonalAccessToken(createPersonalAccessTokenBody?: CreatePersonalAccessTokenBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePersonalAccessTokenResponse>>;
|
|
7552
|
+
/**
|
|
7553
|
+
* Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.
|
|
7554
|
+
* @param {CreateTaskBody} [createTaskBody] Task data
|
|
7555
|
+
* @param {*} [options] Override http request option.
|
|
7556
|
+
* @throws {RequiredError}
|
|
7557
|
+
*/
|
|
7558
|
+
createTask(createTaskBody?: CreateTaskBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTaskResponse>>;
|
|
6972
7559
|
/**
|
|
6973
7560
|
* 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.
|
|
6974
7561
|
* @param {CreateUserBody} [createUserBody] User data
|
|
@@ -7040,6 +7627,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7040
7627
|
* @throws {RequiredError}
|
|
7041
7628
|
*/
|
|
7042
7629
|
deletePersonalAccessToken(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
7630
|
+
/**
|
|
7631
|
+
* Permanently deletes a [Task](#schema_task). It cannot be undone.
|
|
7632
|
+
* @param {string} id Task id
|
|
7633
|
+
* @param {*} [options] Override http request option.
|
|
7634
|
+
* @throws {RequiredError}
|
|
7635
|
+
*/
|
|
7636
|
+
deleteTask(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
7043
7637
|
/**
|
|
7044
7638
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
7045
7639
|
* @param {string} id User ID
|
|
@@ -7237,6 +7831,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7237
7831
|
* @throws {RequiredError}
|
|
7238
7832
|
*/
|
|
7239
7833
|
getState(type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStateResponse>>;
|
|
7834
|
+
/**
|
|
7835
|
+
* Retrieves the [Task](#schema_task) object for a valid identifier.
|
|
7836
|
+
* @param {string} id Task id
|
|
7837
|
+
* @param {*} [options] Override http request option.
|
|
7838
|
+
* @throws {RequiredError}
|
|
7839
|
+
*/
|
|
7840
|
+
getTask(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaskResponse>>;
|
|
7240
7841
|
/**
|
|
7241
7842
|
* Get usage
|
|
7242
7843
|
* @param {GetUsageTypeEnum} type Type of usage
|
|
@@ -7283,6 +7884,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7283
7884
|
* @throws {RequiredError}
|
|
7284
7885
|
*/
|
|
7285
7886
|
introspect(introspectBody?: IntrospectBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntrospectResponse>>;
|
|
7887
|
+
/**
|
|
7888
|
+
* List activities of a task
|
|
7889
|
+
* @param {string} taskId ID of the task to list activities for
|
|
7890
|
+
* @param {string} botId ID of the bot to list activities for
|
|
7891
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
7892
|
+
* @param {*} [options] Override http request option.
|
|
7893
|
+
* @throws {RequiredError}
|
|
7894
|
+
*/
|
|
7895
|
+
listActivities(taskId: string, botId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActivitiesResponse>>;
|
|
7286
7896
|
/**
|
|
7287
7897
|
* List Events for a Bot Issue
|
|
7288
7898
|
* @param {string} id Bot ID
|
|
@@ -7381,6 +7991,21 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7381
7991
|
* @throws {RequiredError}
|
|
7382
7992
|
*/
|
|
7383
7993
|
listPublicIntegrations(nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPublicIntegrationsResponse>>;
|
|
7994
|
+
/**
|
|
7995
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
7996
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
7997
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
7998
|
+
* @param {string} [conversationId] Conversation id
|
|
7999
|
+
* @param {string} [userId] User id
|
|
8000
|
+
* @param {string} [parentTaskId] Parent task id
|
|
8001
|
+
* @param {Array<ListTasksStatusEnum>} [status] Status
|
|
8002
|
+
* @param {string} [type] Type
|
|
8003
|
+
* @param {*} [options] Override http request option.
|
|
8004
|
+
* @throws {RequiredError}
|
|
8005
|
+
*/
|
|
8006
|
+
listTasks(nextToken?: string, tags?: {
|
|
8007
|
+
[key: string]: string;
|
|
8008
|
+
} | undefined, conversationId?: string, userId?: string, parentTaskId?: string, status?: Array<ListTasksStatusEnum>, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponse>>;
|
|
7384
8009
|
/**
|
|
7385
8010
|
* Get usage history
|
|
7386
8011
|
* @param {ListUsageHistoryTypeEnum} type Type of usage
|
|
@@ -7529,6 +8154,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
7529
8154
|
* @throws {RequiredError}
|
|
7530
8155
|
*/
|
|
7531
8156
|
updateMessage(id: string, updateMessageBody?: UpdateMessageBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateMessageResponse>>;
|
|
8157
|
+
/**
|
|
8158
|
+
* Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
8159
|
+
* @param {string} id Task id
|
|
8160
|
+
* @param {UpdateTaskBody} [updateTaskBody] Task data
|
|
8161
|
+
* @param {*} [options] Override http request option.
|
|
8162
|
+
* @throws {RequiredError}
|
|
8163
|
+
*/
|
|
8164
|
+
updateTask(id: string, updateTaskBody?: UpdateTaskBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTaskResponse>>;
|
|
7532
8165
|
/**
|
|
7533
8166
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
7534
8167
|
* @param {string} id User ID
|
|
@@ -7601,6 +8234,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7601
8234
|
* @throws {RequiredError}
|
|
7602
8235
|
*/
|
|
7603
8236
|
chargeWorkspaceUnpaidInvoices(requestParameters: DefaultApiChargeWorkspaceUnpaidInvoicesRequest, options?: AxiosRequestConfig): AxiosPromise<ChargeWorkspaceUnpaidInvoicesResponse>;
|
|
8237
|
+
/**
|
|
8238
|
+
* Check if a workspace handle is available
|
|
8239
|
+
* @param {DefaultApiCheckHandleAvailabilityRequest} requestParameters Request parameters.
|
|
8240
|
+
* @param {*} [options] Override http request option.
|
|
8241
|
+
* @throws {RequiredError}
|
|
8242
|
+
*/
|
|
8243
|
+
checkHandleAvailability(requestParameters?: DefaultApiCheckHandleAvailabilityRequest, options?: AxiosRequestConfig): AxiosPromise<CheckHandleAvailabilityResponse>;
|
|
7604
8244
|
/**
|
|
7605
8245
|
* An integration can call this endpoint to configure itself
|
|
7606
8246
|
* @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
|
|
@@ -7657,6 +8297,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7657
8297
|
* @throws {RequiredError}
|
|
7658
8298
|
*/
|
|
7659
8299
|
createPersonalAccessToken(requestParameters?: DefaultApiCreatePersonalAccessTokenRequest, options?: AxiosRequestConfig): AxiosPromise<CreatePersonalAccessTokenResponse>;
|
|
8300
|
+
/**
|
|
8301
|
+
* Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.
|
|
8302
|
+
* @param {DefaultApiCreateTaskRequest} requestParameters Request parameters.
|
|
8303
|
+
* @param {*} [options] Override http request option.
|
|
8304
|
+
* @throws {RequiredError}
|
|
8305
|
+
*/
|
|
8306
|
+
createTask(requestParameters?: DefaultApiCreateTaskRequest, options?: AxiosRequestConfig): AxiosPromise<CreateTaskResponse>;
|
|
7660
8307
|
/**
|
|
7661
8308
|
* 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.
|
|
7662
8309
|
* @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
|
|
@@ -7727,6 +8374,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7727
8374
|
* @throws {RequiredError}
|
|
7728
8375
|
*/
|
|
7729
8376
|
deletePersonalAccessToken(requestParameters: DefaultApiDeletePersonalAccessTokenRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
8377
|
+
/**
|
|
8378
|
+
* Permanently deletes a [Task](#schema_task). It cannot be undone.
|
|
8379
|
+
* @param {DefaultApiDeleteTaskRequest} requestParameters Request parameters.
|
|
8380
|
+
* @param {*} [options] Override http request option.
|
|
8381
|
+
* @throws {RequiredError}
|
|
8382
|
+
*/
|
|
8383
|
+
deleteTask(requestParameters: DefaultApiDeleteTaskRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
7730
8384
|
/**
|
|
7731
8385
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
7732
8386
|
* @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
|
|
@@ -7909,6 +8563,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7909
8563
|
* @throws {RequiredError}
|
|
7910
8564
|
*/
|
|
7911
8565
|
getState(requestParameters: DefaultApiGetStateRequest, options?: AxiosRequestConfig): AxiosPromise<GetStateResponse>;
|
|
8566
|
+
/**
|
|
8567
|
+
* Retrieves the [Task](#schema_task) object for a valid identifier.
|
|
8568
|
+
* @param {DefaultApiGetTaskRequest} requestParameters Request parameters.
|
|
8569
|
+
* @param {*} [options] Override http request option.
|
|
8570
|
+
* @throws {RequiredError}
|
|
8571
|
+
*/
|
|
8572
|
+
getTask(requestParameters: DefaultApiGetTaskRequest, options?: AxiosRequestConfig): AxiosPromise<GetTaskResponse>;
|
|
7912
8573
|
/**
|
|
7913
8574
|
* Get usage
|
|
7914
8575
|
* @param {DefaultApiGetUsageRequest} requestParameters Request parameters.
|
|
@@ -7951,6 +8612,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7951
8612
|
* @throws {RequiredError}
|
|
7952
8613
|
*/
|
|
7953
8614
|
introspect(requestParameters?: DefaultApiIntrospectRequest, options?: AxiosRequestConfig): AxiosPromise<IntrospectResponse>;
|
|
8615
|
+
/**
|
|
8616
|
+
* List activities of a task
|
|
8617
|
+
* @param {DefaultApiListActivitiesRequest} requestParameters Request parameters.
|
|
8618
|
+
* @param {*} [options] Override http request option.
|
|
8619
|
+
* @throws {RequiredError}
|
|
8620
|
+
*/
|
|
8621
|
+
listActivities(requestParameters: DefaultApiListActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<ListActivitiesResponse>;
|
|
7954
8622
|
/**
|
|
7955
8623
|
* List Events for a Bot Issue
|
|
7956
8624
|
* @param {DefaultApiListBotIssueEventsRequest} requestParameters Request parameters.
|
|
@@ -8027,6 +8695,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8027
8695
|
* @throws {RequiredError}
|
|
8028
8696
|
*/
|
|
8029
8697
|
listPublicIntegrations(requestParameters?: DefaultApiListPublicIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListPublicIntegrationsResponse>;
|
|
8698
|
+
/**
|
|
8699
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
8700
|
+
* @param {DefaultApiListTasksRequest} requestParameters Request parameters.
|
|
8701
|
+
* @param {*} [options] Override http request option.
|
|
8702
|
+
* @throws {RequiredError}
|
|
8703
|
+
*/
|
|
8704
|
+
listTasks(requestParameters?: DefaultApiListTasksRequest, options?: AxiosRequestConfig): AxiosPromise<ListTasksResponse>;
|
|
8030
8705
|
/**
|
|
8031
8706
|
* Get usage history
|
|
8032
8707
|
* @param {DefaultApiListUsageHistoryRequest} requestParameters Request parameters.
|
|
@@ -8153,6 +8828,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
8153
8828
|
* @throws {RequiredError}
|
|
8154
8829
|
*/
|
|
8155
8830
|
updateMessage(requestParameters: DefaultApiUpdateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateMessageResponse>;
|
|
8831
|
+
/**
|
|
8832
|
+
* Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
8833
|
+
* @param {DefaultApiUpdateTaskRequest} requestParameters Request parameters.
|
|
8834
|
+
* @param {*} [options] Override http request option.
|
|
8835
|
+
* @throws {RequiredError}
|
|
8836
|
+
*/
|
|
8837
|
+
updateTask(requestParameters: DefaultApiUpdateTaskRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateTaskResponse>;
|
|
8156
8838
|
/**
|
|
8157
8839
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
8158
8840
|
* @param {DefaultApiUpdateUserRequest} requestParameters Request parameters.
|
|
@@ -8283,6 +8965,19 @@ export interface DefaultApiChargeWorkspaceUnpaidInvoicesRequest {
|
|
|
8283
8965
|
*/
|
|
8284
8966
|
readonly chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody;
|
|
8285
8967
|
}
|
|
8968
|
+
/**
|
|
8969
|
+
* Request parameters for checkHandleAvailability operation in DefaultApi.
|
|
8970
|
+
* @export
|
|
8971
|
+
* @interface DefaultApiCheckHandleAvailabilityRequest
|
|
8972
|
+
*/
|
|
8973
|
+
export interface DefaultApiCheckHandleAvailabilityRequest {
|
|
8974
|
+
/**
|
|
8975
|
+
* Workspace handle availability
|
|
8976
|
+
* @type {CheckHandleAvailabilityBody}
|
|
8977
|
+
* @memberof DefaultApiCheckHandleAvailability
|
|
8978
|
+
*/
|
|
8979
|
+
readonly checkHandleAvailabilityBody?: CheckHandleAvailabilityBody;
|
|
8980
|
+
}
|
|
8286
8981
|
/**
|
|
8287
8982
|
* Request parameters for configureIntegration operation in DefaultApi.
|
|
8288
8983
|
* @export
|
|
@@ -8387,6 +9082,19 @@ export interface DefaultApiCreatePersonalAccessTokenRequest {
|
|
|
8387
9082
|
*/
|
|
8388
9083
|
readonly createPersonalAccessTokenBody?: CreatePersonalAccessTokenBody;
|
|
8389
9084
|
}
|
|
9085
|
+
/**
|
|
9086
|
+
* Request parameters for createTask operation in DefaultApi.
|
|
9087
|
+
* @export
|
|
9088
|
+
* @interface DefaultApiCreateTaskRequest
|
|
9089
|
+
*/
|
|
9090
|
+
export interface DefaultApiCreateTaskRequest {
|
|
9091
|
+
/**
|
|
9092
|
+
* Task data
|
|
9093
|
+
* @type {CreateTaskBody}
|
|
9094
|
+
* @memberof DefaultApiCreateTask
|
|
9095
|
+
*/
|
|
9096
|
+
readonly createTaskBody?: CreateTaskBody;
|
|
9097
|
+
}
|
|
8390
9098
|
/**
|
|
8391
9099
|
* Request parameters for createUser operation in DefaultApi.
|
|
8392
9100
|
* @export
|
|
@@ -8523,6 +9231,19 @@ export interface DefaultApiDeletePersonalAccessTokenRequest {
|
|
|
8523
9231
|
*/
|
|
8524
9232
|
readonly id: string;
|
|
8525
9233
|
}
|
|
9234
|
+
/**
|
|
9235
|
+
* Request parameters for deleteTask operation in DefaultApi.
|
|
9236
|
+
* @export
|
|
9237
|
+
* @interface DefaultApiDeleteTaskRequest
|
|
9238
|
+
*/
|
|
9239
|
+
export interface DefaultApiDeleteTaskRequest {
|
|
9240
|
+
/**
|
|
9241
|
+
* Task id
|
|
9242
|
+
* @type {string}
|
|
9243
|
+
* @memberof DefaultApiDeleteTask
|
|
9244
|
+
*/
|
|
9245
|
+
readonly id: string;
|
|
9246
|
+
}
|
|
8526
9247
|
/**
|
|
8527
9248
|
* Request parameters for deleteUser operation in DefaultApi.
|
|
8528
9249
|
* @export
|
|
@@ -8925,6 +9646,19 @@ export interface DefaultApiGetStateRequest {
|
|
|
8925
9646
|
*/
|
|
8926
9647
|
readonly name: string;
|
|
8927
9648
|
}
|
|
9649
|
+
/**
|
|
9650
|
+
* Request parameters for getTask operation in DefaultApi.
|
|
9651
|
+
* @export
|
|
9652
|
+
* @interface DefaultApiGetTaskRequest
|
|
9653
|
+
*/
|
|
9654
|
+
export interface DefaultApiGetTaskRequest {
|
|
9655
|
+
/**
|
|
9656
|
+
* Task id
|
|
9657
|
+
* @type {string}
|
|
9658
|
+
* @memberof DefaultApiGetTask
|
|
9659
|
+
*/
|
|
9660
|
+
readonly id: string;
|
|
9661
|
+
}
|
|
8928
9662
|
/**
|
|
8929
9663
|
* Request parameters for getUsage operation in DefaultApi.
|
|
8930
9664
|
* @export
|
|
@@ -9027,6 +9761,31 @@ export interface DefaultApiIntrospectRequest {
|
|
|
9027
9761
|
*/
|
|
9028
9762
|
readonly introspectBody?: IntrospectBody;
|
|
9029
9763
|
}
|
|
9764
|
+
/**
|
|
9765
|
+
* Request parameters for listActivities operation in DefaultApi.
|
|
9766
|
+
* @export
|
|
9767
|
+
* @interface DefaultApiListActivitiesRequest
|
|
9768
|
+
*/
|
|
9769
|
+
export interface DefaultApiListActivitiesRequest {
|
|
9770
|
+
/**
|
|
9771
|
+
* ID of the task to list activities for
|
|
9772
|
+
* @type {string}
|
|
9773
|
+
* @memberof DefaultApiListActivities
|
|
9774
|
+
*/
|
|
9775
|
+
readonly taskId: string;
|
|
9776
|
+
/**
|
|
9777
|
+
* ID of the bot to list activities for
|
|
9778
|
+
* @type {string}
|
|
9779
|
+
* @memberof DefaultApiListActivities
|
|
9780
|
+
*/
|
|
9781
|
+
readonly botId: string;
|
|
9782
|
+
/**
|
|
9783
|
+
* Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
9784
|
+
* @type {string}
|
|
9785
|
+
* @memberof DefaultApiListActivities
|
|
9786
|
+
*/
|
|
9787
|
+
readonly nextToken?: string;
|
|
9788
|
+
}
|
|
9030
9789
|
/**
|
|
9031
9790
|
* Request parameters for listBotIssueEvents operation in DefaultApi.
|
|
9032
9791
|
* @export
|
|
@@ -9269,6 +10028,57 @@ export interface DefaultApiListPublicIntegrationsRequest {
|
|
|
9269
10028
|
*/
|
|
9270
10029
|
readonly version?: string;
|
|
9271
10030
|
}
|
|
10031
|
+
/**
|
|
10032
|
+
* Request parameters for listTasks operation in DefaultApi.
|
|
10033
|
+
* @export
|
|
10034
|
+
* @interface DefaultApiListTasksRequest
|
|
10035
|
+
*/
|
|
10036
|
+
export interface DefaultApiListTasksRequest {
|
|
10037
|
+
/**
|
|
10038
|
+
* Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
10039
|
+
* @type {string}
|
|
10040
|
+
* @memberof DefaultApiListTasks
|
|
10041
|
+
*/
|
|
10042
|
+
readonly nextToken?: string;
|
|
10043
|
+
/**
|
|
10044
|
+
* Filter by tags
|
|
10045
|
+
* @type {{ [key: string]: string; }}
|
|
10046
|
+
* @memberof DefaultApiListTasks
|
|
10047
|
+
*/
|
|
10048
|
+
readonly tags?: {
|
|
10049
|
+
[key: string]: string;
|
|
10050
|
+
};
|
|
10051
|
+
/**
|
|
10052
|
+
* Conversation id
|
|
10053
|
+
* @type {string}
|
|
10054
|
+
* @memberof DefaultApiListTasks
|
|
10055
|
+
*/
|
|
10056
|
+
readonly conversationId?: string;
|
|
10057
|
+
/**
|
|
10058
|
+
* User id
|
|
10059
|
+
* @type {string}
|
|
10060
|
+
* @memberof DefaultApiListTasks
|
|
10061
|
+
*/
|
|
10062
|
+
readonly userId?: string;
|
|
10063
|
+
/**
|
|
10064
|
+
* Parent task id
|
|
10065
|
+
* @type {string}
|
|
10066
|
+
* @memberof DefaultApiListTasks
|
|
10067
|
+
*/
|
|
10068
|
+
readonly parentTaskId?: string;
|
|
10069
|
+
/**
|
|
10070
|
+
* Status
|
|
10071
|
+
* @type {Array<'pending' | 'in_progress' | 'failed' | 'completed' | 'blocked' | 'paused' | 'timeout' | 'cancelled'>}
|
|
10072
|
+
* @memberof DefaultApiListTasks
|
|
10073
|
+
*/
|
|
10074
|
+
readonly status?: Array<ListTasksStatusEnum>;
|
|
10075
|
+
/**
|
|
10076
|
+
* Type
|
|
10077
|
+
* @type {string}
|
|
10078
|
+
* @memberof DefaultApiListTasks
|
|
10079
|
+
*/
|
|
10080
|
+
readonly type?: string;
|
|
10081
|
+
}
|
|
9272
10082
|
/**
|
|
9273
10083
|
* Request parameters for listUsageHistory operation in DefaultApi.
|
|
9274
10084
|
* @export
|
|
@@ -9625,6 +10435,25 @@ export interface DefaultApiUpdateMessageRequest {
|
|
|
9625
10435
|
*/
|
|
9626
10436
|
readonly updateMessageBody?: UpdateMessageBody;
|
|
9627
10437
|
}
|
|
10438
|
+
/**
|
|
10439
|
+
* Request parameters for updateTask operation in DefaultApi.
|
|
10440
|
+
* @export
|
|
10441
|
+
* @interface DefaultApiUpdateTaskRequest
|
|
10442
|
+
*/
|
|
10443
|
+
export interface DefaultApiUpdateTaskRequest {
|
|
10444
|
+
/**
|
|
10445
|
+
* Task id
|
|
10446
|
+
* @type {string}
|
|
10447
|
+
* @memberof DefaultApiUpdateTask
|
|
10448
|
+
*/
|
|
10449
|
+
readonly id: string;
|
|
10450
|
+
/**
|
|
10451
|
+
* Task data
|
|
10452
|
+
* @type {UpdateTaskBody}
|
|
10453
|
+
* @memberof DefaultApiUpdateTask
|
|
10454
|
+
*/
|
|
10455
|
+
readonly updateTaskBody?: UpdateTaskBody;
|
|
10456
|
+
}
|
|
9628
10457
|
/**
|
|
9629
10458
|
* Request parameters for updateUser operation in DefaultApi.
|
|
9630
10459
|
* @export
|
|
@@ -9737,6 +10566,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9737
10566
|
* @memberof DefaultApi
|
|
9738
10567
|
*/
|
|
9739
10568
|
chargeWorkspaceUnpaidInvoices(requestParameters: DefaultApiChargeWorkspaceUnpaidInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChargeWorkspaceUnpaidInvoicesResponse, any>>;
|
|
10569
|
+
/**
|
|
10570
|
+
* Check if a workspace handle is available
|
|
10571
|
+
* @param {DefaultApiCheckHandleAvailabilityRequest} requestParameters Request parameters.
|
|
10572
|
+
* @param {*} [options] Override http request option.
|
|
10573
|
+
* @throws {RequiredError}
|
|
10574
|
+
* @memberof DefaultApi
|
|
10575
|
+
*/
|
|
10576
|
+
checkHandleAvailability(requestParameters?: DefaultApiCheckHandleAvailabilityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckHandleAvailabilityResponse, any>>;
|
|
9740
10577
|
/**
|
|
9741
10578
|
* An integration can call this endpoint to configure itself
|
|
9742
10579
|
* @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
|
|
@@ -9801,6 +10638,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9801
10638
|
* @memberof DefaultApi
|
|
9802
10639
|
*/
|
|
9803
10640
|
createPersonalAccessToken(requestParameters?: DefaultApiCreatePersonalAccessTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePersonalAccessTokenResponse, any>>;
|
|
10641
|
+
/**
|
|
10642
|
+
* Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.
|
|
10643
|
+
* @param {DefaultApiCreateTaskRequest} requestParameters Request parameters.
|
|
10644
|
+
* @param {*} [options] Override http request option.
|
|
10645
|
+
* @throws {RequiredError}
|
|
10646
|
+
* @memberof DefaultApi
|
|
10647
|
+
*/
|
|
10648
|
+
createTask(requestParameters?: DefaultApiCreateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTaskResponse, any>>;
|
|
9804
10649
|
/**
|
|
9805
10650
|
* 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.
|
|
9806
10651
|
* @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
|
|
@@ -9881,6 +10726,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9881
10726
|
* @memberof DefaultApi
|
|
9882
10727
|
*/
|
|
9883
10728
|
deletePersonalAccessToken(requestParameters: DefaultApiDeletePersonalAccessTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
10729
|
+
/**
|
|
10730
|
+
* Permanently deletes a [Task](#schema_task). It cannot be undone.
|
|
10731
|
+
* @param {DefaultApiDeleteTaskRequest} requestParameters Request parameters.
|
|
10732
|
+
* @param {*} [options] Override http request option.
|
|
10733
|
+
* @throws {RequiredError}
|
|
10734
|
+
* @memberof DefaultApi
|
|
10735
|
+
*/
|
|
10736
|
+
deleteTask(requestParameters: DefaultApiDeleteTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
9884
10737
|
/**
|
|
9885
10738
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
9886
10739
|
* @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
|
|
@@ -10089,6 +10942,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
10089
10942
|
* @memberof DefaultApi
|
|
10090
10943
|
*/
|
|
10091
10944
|
getState(requestParameters: DefaultApiGetStateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStateResponse, any>>;
|
|
10945
|
+
/**
|
|
10946
|
+
* Retrieves the [Task](#schema_task) object for a valid identifier.
|
|
10947
|
+
* @param {DefaultApiGetTaskRequest} requestParameters Request parameters.
|
|
10948
|
+
* @param {*} [options] Override http request option.
|
|
10949
|
+
* @throws {RequiredError}
|
|
10950
|
+
* @memberof DefaultApi
|
|
10951
|
+
*/
|
|
10952
|
+
getTask(requestParameters: DefaultApiGetTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTaskResponse, any>>;
|
|
10092
10953
|
/**
|
|
10093
10954
|
* Get usage
|
|
10094
10955
|
* @param {DefaultApiGetUsageRequest} requestParameters Request parameters.
|
|
@@ -10137,6 +10998,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
10137
10998
|
* @memberof DefaultApi
|
|
10138
10999
|
*/
|
|
10139
11000
|
introspect(requestParameters?: DefaultApiIntrospectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IntrospectResponse, any>>;
|
|
11001
|
+
/**
|
|
11002
|
+
* List activities of a task
|
|
11003
|
+
* @param {DefaultApiListActivitiesRequest} requestParameters Request parameters.
|
|
11004
|
+
* @param {*} [options] Override http request option.
|
|
11005
|
+
* @throws {RequiredError}
|
|
11006
|
+
* @memberof DefaultApi
|
|
11007
|
+
*/
|
|
11008
|
+
listActivities(requestParameters: DefaultApiListActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActivitiesResponse, any>>;
|
|
10140
11009
|
/**
|
|
10141
11010
|
* List Events for a Bot Issue
|
|
10142
11011
|
* @param {DefaultApiListBotIssueEventsRequest} requestParameters Request parameters.
|
|
@@ -10224,6 +11093,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
10224
11093
|
* @memberof DefaultApi
|
|
10225
11094
|
*/
|
|
10226
11095
|
listPublicIntegrations(requestParameters?: DefaultApiListPublicIntegrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPublicIntegrationsResponse, any>>;
|
|
11096
|
+
/**
|
|
11097
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
11098
|
+
* @param {DefaultApiListTasksRequest} requestParameters Request parameters.
|
|
11099
|
+
* @param {*} [options] Override http request option.
|
|
11100
|
+
* @throws {RequiredError}
|
|
11101
|
+
* @memberof DefaultApi
|
|
11102
|
+
*/
|
|
11103
|
+
listTasks(requestParameters?: DefaultApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponse, any>>;
|
|
10227
11104
|
/**
|
|
10228
11105
|
* Get usage history
|
|
10229
11106
|
* @param {DefaultApiListUsageHistoryRequest} requestParameters Request parameters.
|
|
@@ -10368,6 +11245,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
10368
11245
|
* @memberof DefaultApi
|
|
10369
11246
|
*/
|
|
10370
11247
|
updateMessage(requestParameters: DefaultApiUpdateMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateMessageResponse, any>>;
|
|
11248
|
+
/**
|
|
11249
|
+
* Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
11250
|
+
* @param {DefaultApiUpdateTaskRequest} requestParameters Request parameters.
|
|
11251
|
+
* @param {*} [options] Override http request option.
|
|
11252
|
+
* @throws {RequiredError}
|
|
11253
|
+
* @memberof DefaultApi
|
|
11254
|
+
*/
|
|
11255
|
+
updateTask(requestParameters: DefaultApiUpdateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTaskResponse, any>>;
|
|
10371
11256
|
/**
|
|
10372
11257
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
10373
11258
|
* @param {DefaultApiUpdateUserRequest} requestParameters Request parameters.
|
|
@@ -10470,6 +11355,20 @@ export declare const GetWorkspaceQuotaTypeEnum: {
|
|
|
10470
11355
|
readonly AlwaysAlive: "always_alive";
|
|
10471
11356
|
};
|
|
10472
11357
|
export type GetWorkspaceQuotaTypeEnum = typeof GetWorkspaceQuotaTypeEnum[keyof typeof GetWorkspaceQuotaTypeEnum];
|
|
11358
|
+
/**
|
|
11359
|
+
* @export
|
|
11360
|
+
*/
|
|
11361
|
+
export declare const ListTasksStatusEnum: {
|
|
11362
|
+
readonly Pending: "pending";
|
|
11363
|
+
readonly InProgress: "in_progress";
|
|
11364
|
+
readonly Failed: "failed";
|
|
11365
|
+
readonly Completed: "completed";
|
|
11366
|
+
readonly Blocked: "blocked";
|
|
11367
|
+
readonly Paused: "paused";
|
|
11368
|
+
readonly Timeout: "timeout";
|
|
11369
|
+
readonly Cancelled: "cancelled";
|
|
11370
|
+
};
|
|
11371
|
+
export type ListTasksStatusEnum = typeof ListTasksStatusEnum[keyof typeof ListTasksStatusEnum];
|
|
10473
11372
|
/**
|
|
10474
11373
|
* @export
|
|
10475
11374
|
*/
|