@botpress/client 1.35.0 → 1.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bundle.cjs +13 -13
- package/dist/bundle.cjs.map +4 -4
- package/dist/index.cjs +5 -5
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.ts +184 -1058
- package/dist/index.mjs +5 -5
- package/dist/index.mjs.map +4 -4
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -108,7 +108,8 @@ interface CreateConversationResponse$1 {
|
|
|
108
108
|
*/
|
|
109
109
|
id: string;
|
|
110
110
|
/**
|
|
111
|
-
*
|
|
111
|
+
* @deprecated
|
|
112
|
+
* Unused. This field will be removed in the future.
|
|
112
113
|
*/
|
|
113
114
|
currentTaskId?: string;
|
|
114
115
|
/**
|
|
@@ -160,7 +161,8 @@ interface GetConversationResponse$1 {
|
|
|
160
161
|
*/
|
|
161
162
|
id: string;
|
|
162
163
|
/**
|
|
163
|
-
*
|
|
164
|
+
* @deprecated
|
|
165
|
+
* Unused. This field will be removed in the future.
|
|
164
166
|
*/
|
|
165
167
|
currentTaskId?: string;
|
|
166
168
|
/**
|
|
@@ -219,7 +221,8 @@ interface ListConversationsResponse$1 {
|
|
|
219
221
|
*/
|
|
220
222
|
id: string;
|
|
221
223
|
/**
|
|
222
|
-
*
|
|
224
|
+
* @deprecated
|
|
225
|
+
* Unused. This field will be removed in the future.
|
|
223
226
|
*/
|
|
224
227
|
currentTaskId?: string;
|
|
225
228
|
/**
|
|
@@ -295,7 +298,8 @@ interface GetOrCreateConversationResponse$1 {
|
|
|
295
298
|
*/
|
|
296
299
|
id: string;
|
|
297
300
|
/**
|
|
298
|
-
*
|
|
301
|
+
* @deprecated
|
|
302
|
+
* Unused. This field will be removed in the future.
|
|
299
303
|
*/
|
|
300
304
|
currentTaskId?: string;
|
|
301
305
|
/**
|
|
@@ -335,6 +339,10 @@ interface UpdateConversationRequestParams$1 {
|
|
|
335
339
|
id: string;
|
|
336
340
|
}
|
|
337
341
|
interface UpdateConversationRequestBody$1 {
|
|
342
|
+
/**
|
|
343
|
+
* @deprecated
|
|
344
|
+
* Unused. This parameter will be ignored if provided and should not be used when updating a conversation.
|
|
345
|
+
*/
|
|
338
346
|
currentTaskId?: string;
|
|
339
347
|
/**
|
|
340
348
|
* Tags for the [Conversation](#schema_conversation)
|
|
@@ -354,7 +362,8 @@ interface UpdateConversationResponse$1 {
|
|
|
354
362
|
*/
|
|
355
363
|
id: string;
|
|
356
364
|
/**
|
|
357
|
-
*
|
|
365
|
+
* @deprecated
|
|
366
|
+
* Unused. This field will be removed in the future.
|
|
358
367
|
*/
|
|
359
368
|
currentTaskId?: string;
|
|
360
369
|
/**
|
|
@@ -1242,7 +1251,7 @@ interface InitializeIncomingMessageRequestBody$1 {
|
|
|
1242
1251
|
*/
|
|
1243
1252
|
pictureUrl?: string;
|
|
1244
1253
|
/**
|
|
1245
|
-
* Optional attributes
|
|
1254
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
|
|
1246
1255
|
*/
|
|
1247
1256
|
attributes?: {
|
|
1248
1257
|
[k: string]: string;
|
|
@@ -1346,7 +1355,8 @@ interface InitializeIncomingMessageResponse$1 {
|
|
|
1346
1355
|
*/
|
|
1347
1356
|
id: string;
|
|
1348
1357
|
/**
|
|
1349
|
-
*
|
|
1358
|
+
* @deprecated
|
|
1359
|
+
* Unused. This field will be removed in the future.
|
|
1350
1360
|
*/
|
|
1351
1361
|
currentTaskId?: string;
|
|
1352
1362
|
/**
|
|
@@ -1549,7 +1559,7 @@ interface CreateUserRequestBody$1 {
|
|
|
1549
1559
|
*/
|
|
1550
1560
|
pictureUrl?: string;
|
|
1551
1561
|
/**
|
|
1552
|
-
* Optional attributes
|
|
1562
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
|
|
1553
1563
|
*/
|
|
1554
1564
|
attributes?: {
|
|
1555
1565
|
[k: string]: string;
|
|
@@ -1735,7 +1745,7 @@ interface GetOrCreateUserRequestBody$1 {
|
|
|
1735
1745
|
*/
|
|
1736
1746
|
pictureUrl?: string;
|
|
1737
1747
|
/**
|
|
1738
|
-
* Optional attributes
|
|
1748
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
|
|
1739
1749
|
*/
|
|
1740
1750
|
attributes?: {
|
|
1741
1751
|
[k: string]: string;
|
|
@@ -1809,7 +1819,7 @@ interface UpdateUserRequestBody$1 {
|
|
|
1809
1819
|
*/
|
|
1810
1820
|
pictureUrl?: string | null;
|
|
1811
1821
|
/**
|
|
1812
|
-
* Optional attributes. Set attributes to null to remove them
|
|
1822
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations. Set individual attributes to null to remove them.
|
|
1813
1823
|
*/
|
|
1814
1824
|
attributes?: {
|
|
1815
1825
|
[k: string]: string | null;
|
|
@@ -1874,7 +1884,7 @@ interface SetStateExpiryRequestHeaders$1 {
|
|
|
1874
1884
|
interface SetStateExpiryRequestQuery$1 {
|
|
1875
1885
|
}
|
|
1876
1886
|
interface SetStateExpiryRequestParams$1 {
|
|
1877
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
1887
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
1878
1888
|
id: string;
|
|
1879
1889
|
name: string;
|
|
1880
1890
|
}
|
|
@@ -1919,9 +1929,9 @@ interface SetStateExpiryResponse$1 {
|
|
|
1919
1929
|
*/
|
|
1920
1930
|
name: string;
|
|
1921
1931
|
/**
|
|
1922
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
1932
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
1923
1933
|
*/
|
|
1924
|
-
type: "conversation" | "user" | "bot" | "
|
|
1934
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
1925
1935
|
/**
|
|
1926
1936
|
* Payload is the content of the state defined by your bot.
|
|
1927
1937
|
*/
|
|
@@ -1936,7 +1946,7 @@ interface GetStateRequestHeaders$1 {
|
|
|
1936
1946
|
interface GetStateRequestQuery$1 {
|
|
1937
1947
|
}
|
|
1938
1948
|
interface GetStateRequestParams$1 {
|
|
1939
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
1949
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
1940
1950
|
id: string;
|
|
1941
1951
|
name: string;
|
|
1942
1952
|
}
|
|
@@ -1977,9 +1987,9 @@ interface GetStateResponse$1 {
|
|
|
1977
1987
|
*/
|
|
1978
1988
|
name: string;
|
|
1979
1989
|
/**
|
|
1980
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
1990
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
1981
1991
|
*/
|
|
1982
|
-
type: "conversation" | "user" | "bot" | "
|
|
1992
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
1983
1993
|
/**
|
|
1984
1994
|
* Payload is the content of the state defined by your bot.
|
|
1985
1995
|
*/
|
|
@@ -1997,7 +2007,7 @@ interface SetStateRequestHeaders$1 {
|
|
|
1997
2007
|
interface SetStateRequestQuery$1 {
|
|
1998
2008
|
}
|
|
1999
2009
|
interface SetStateRequestParams$1 {
|
|
2000
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
2010
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
2001
2011
|
id: string;
|
|
2002
2012
|
name: string;
|
|
2003
2013
|
}
|
|
@@ -2048,9 +2058,9 @@ interface SetStateResponse$1 {
|
|
|
2048
2058
|
*/
|
|
2049
2059
|
name: string;
|
|
2050
2060
|
/**
|
|
2051
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
2061
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
2052
2062
|
*/
|
|
2053
|
-
type: "conversation" | "user" | "bot" | "
|
|
2063
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
2054
2064
|
/**
|
|
2055
2065
|
* Payload is the content of the state defined by your bot.
|
|
2056
2066
|
*/
|
|
@@ -2065,7 +2075,7 @@ interface GetOrSetStateRequestHeaders$1 {
|
|
|
2065
2075
|
interface GetOrSetStateRequestQuery$1 {
|
|
2066
2076
|
}
|
|
2067
2077
|
interface GetOrSetStateRequestParams$1 {
|
|
2068
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
2078
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
2069
2079
|
id: string;
|
|
2070
2080
|
name: string;
|
|
2071
2081
|
}
|
|
@@ -2116,9 +2126,9 @@ interface GetOrSetStateResponse$1 {
|
|
|
2116
2126
|
*/
|
|
2117
2127
|
name: string;
|
|
2118
2128
|
/**
|
|
2119
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
2129
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
2120
2130
|
*/
|
|
2121
|
-
type: "conversation" | "user" | "bot" | "
|
|
2131
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
2122
2132
|
/**
|
|
2123
2133
|
* Payload is the content of the state defined by your bot.
|
|
2124
2134
|
*/
|
|
@@ -2136,7 +2146,7 @@ interface PatchStateRequestHeaders$1 {
|
|
|
2136
2146
|
interface PatchStateRequestQuery$1 {
|
|
2137
2147
|
}
|
|
2138
2148
|
interface PatchStateRequestParams$1 {
|
|
2139
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
2149
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
2140
2150
|
id: string;
|
|
2141
2151
|
name: string;
|
|
2142
2152
|
}
|
|
@@ -2183,9 +2193,9 @@ interface PatchStateResponse$1 {
|
|
|
2183
2193
|
*/
|
|
2184
2194
|
name: string;
|
|
2185
2195
|
/**
|
|
2186
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
2196
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
2187
2197
|
*/
|
|
2188
|
-
type: "conversation" | "user" | "bot" | "
|
|
2198
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
2189
2199
|
/**
|
|
2190
2200
|
* Payload is the content of the state defined by your bot.
|
|
2191
2201
|
*/
|
|
@@ -2250,409 +2260,6 @@ type ConfigureIntegrationInput$1 = ConfigureIntegrationRequestBody$1 & Configure
|
|
|
2250
2260
|
interface ConfigureIntegrationResponse$1 {
|
|
2251
2261
|
}
|
|
2252
2262
|
|
|
2253
|
-
interface GetTaskRequestHeaders$1 {
|
|
2254
|
-
}
|
|
2255
|
-
interface GetTaskRequestQuery$1 {
|
|
2256
|
-
}
|
|
2257
|
-
interface GetTaskRequestParams$1 {
|
|
2258
|
-
id: string;
|
|
2259
|
-
}
|
|
2260
|
-
interface GetTaskRequestBody$1 {
|
|
2261
|
-
}
|
|
2262
|
-
type GetTaskInput$1 = GetTaskRequestBody$1 & GetTaskRequestHeaders$1 & GetTaskRequestQuery$1 & GetTaskRequestParams$1;
|
|
2263
|
-
interface GetTaskResponse$1 {
|
|
2264
|
-
/**
|
|
2265
|
-
* Task definition
|
|
2266
|
-
*/
|
|
2267
|
-
task: {
|
|
2268
|
-
/**
|
|
2269
|
-
* Id of the [Task](#schema_task)
|
|
2270
|
-
*/
|
|
2271
|
-
id: string;
|
|
2272
|
-
/**
|
|
2273
|
-
* Title describing the task
|
|
2274
|
-
*/
|
|
2275
|
-
title: string;
|
|
2276
|
-
/**
|
|
2277
|
-
* All the notes related to the execution of the current task
|
|
2278
|
-
*/
|
|
2279
|
-
description: string;
|
|
2280
|
-
/**
|
|
2281
|
-
* Type of the task
|
|
2282
|
-
*/
|
|
2283
|
-
type: string;
|
|
2284
|
-
/**
|
|
2285
|
-
* Content related to the task
|
|
2286
|
-
*/
|
|
2287
|
-
data: {
|
|
2288
|
-
[k: string]: any;
|
|
2289
|
-
};
|
|
2290
|
-
/**
|
|
2291
|
-
* Status of the task
|
|
2292
|
-
*/
|
|
2293
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
2294
|
-
/**
|
|
2295
|
-
* Parent task id is the parent task that created this task
|
|
2296
|
-
*/
|
|
2297
|
-
parentTaskId?: string;
|
|
2298
|
-
/**
|
|
2299
|
-
* Conversation id related to this task
|
|
2300
|
-
*/
|
|
2301
|
-
conversationId?: string;
|
|
2302
|
-
/**
|
|
2303
|
-
* Specific user related to this task
|
|
2304
|
-
*/
|
|
2305
|
-
userId?: string;
|
|
2306
|
-
/**
|
|
2307
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
2308
|
-
*/
|
|
2309
|
-
timeoutAt: string;
|
|
2310
|
-
/**
|
|
2311
|
-
* Creation date of the task in ISO 8601 format
|
|
2312
|
-
*/
|
|
2313
|
-
createdAt: string;
|
|
2314
|
-
/**
|
|
2315
|
-
* Updating date of the task in ISO 8601 format
|
|
2316
|
-
*/
|
|
2317
|
-
updatedAt: string;
|
|
2318
|
-
/**
|
|
2319
|
-
* If the task fails this is the reason behind it
|
|
2320
|
-
*/
|
|
2321
|
-
failureReason?: string;
|
|
2322
|
-
/**
|
|
2323
|
-
* 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.
|
|
2324
|
-
*/
|
|
2325
|
-
tags: {
|
|
2326
|
-
[k: string]: string;
|
|
2327
|
-
};
|
|
2328
|
-
};
|
|
2329
|
-
}
|
|
2330
|
-
|
|
2331
|
-
interface CreateTaskRequestHeaders$1 {
|
|
2332
|
-
}
|
|
2333
|
-
interface CreateTaskRequestQuery$1 {
|
|
2334
|
-
}
|
|
2335
|
-
interface CreateTaskRequestParams$1 {
|
|
2336
|
-
}
|
|
2337
|
-
interface CreateTaskRequestBody$1 {
|
|
2338
|
-
/**
|
|
2339
|
-
* Title describing the task
|
|
2340
|
-
*/
|
|
2341
|
-
title?: string;
|
|
2342
|
-
/**
|
|
2343
|
-
* All the notes related to the execution of the current task
|
|
2344
|
-
*/
|
|
2345
|
-
description?: string;
|
|
2346
|
-
/**
|
|
2347
|
-
* Type of the task
|
|
2348
|
-
*/
|
|
2349
|
-
type: string;
|
|
2350
|
-
/**
|
|
2351
|
-
* Content related to the task
|
|
2352
|
-
*/
|
|
2353
|
-
data?: {
|
|
2354
|
-
[k: string]: any;
|
|
2355
|
-
};
|
|
2356
|
-
/**
|
|
2357
|
-
* Parent task id is the parent task that created this task
|
|
2358
|
-
*/
|
|
2359
|
-
parentTaskId?: string;
|
|
2360
|
-
/**
|
|
2361
|
-
* Conversation id related to this task
|
|
2362
|
-
*/
|
|
2363
|
-
conversationId: string;
|
|
2364
|
-
/**
|
|
2365
|
-
* Specific user related to this task
|
|
2366
|
-
*/
|
|
2367
|
-
userId?: string;
|
|
2368
|
-
/**
|
|
2369
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
2370
|
-
*/
|
|
2371
|
-
timeoutAt?: string;
|
|
2372
|
-
/**
|
|
2373
|
-
* Tags for the [Task](#schema_task)
|
|
2374
|
-
*/
|
|
2375
|
-
tags?: {
|
|
2376
|
-
[k: string]: string;
|
|
2377
|
-
};
|
|
2378
|
-
}
|
|
2379
|
-
type CreateTaskInput$1 = CreateTaskRequestBody$1 & CreateTaskRequestHeaders$1 & CreateTaskRequestQuery$1 & CreateTaskRequestParams$1;
|
|
2380
|
-
interface CreateTaskResponse$1 {
|
|
2381
|
-
/**
|
|
2382
|
-
* Task definition
|
|
2383
|
-
*/
|
|
2384
|
-
task: {
|
|
2385
|
-
/**
|
|
2386
|
-
* Id of the [Task](#schema_task)
|
|
2387
|
-
*/
|
|
2388
|
-
id: string;
|
|
2389
|
-
/**
|
|
2390
|
-
* Title describing the task
|
|
2391
|
-
*/
|
|
2392
|
-
title: string;
|
|
2393
|
-
/**
|
|
2394
|
-
* All the notes related to the execution of the current task
|
|
2395
|
-
*/
|
|
2396
|
-
description: string;
|
|
2397
|
-
/**
|
|
2398
|
-
* Type of the task
|
|
2399
|
-
*/
|
|
2400
|
-
type: string;
|
|
2401
|
-
/**
|
|
2402
|
-
* Content related to the task
|
|
2403
|
-
*/
|
|
2404
|
-
data: {
|
|
2405
|
-
[k: string]: any;
|
|
2406
|
-
};
|
|
2407
|
-
/**
|
|
2408
|
-
* Status of the task
|
|
2409
|
-
*/
|
|
2410
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
2411
|
-
/**
|
|
2412
|
-
* Parent task id is the parent task that created this task
|
|
2413
|
-
*/
|
|
2414
|
-
parentTaskId?: string;
|
|
2415
|
-
/**
|
|
2416
|
-
* Conversation id related to this task
|
|
2417
|
-
*/
|
|
2418
|
-
conversationId?: string;
|
|
2419
|
-
/**
|
|
2420
|
-
* Specific user related to this task
|
|
2421
|
-
*/
|
|
2422
|
-
userId?: string;
|
|
2423
|
-
/**
|
|
2424
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
2425
|
-
*/
|
|
2426
|
-
timeoutAt: string;
|
|
2427
|
-
/**
|
|
2428
|
-
* Creation date of the task in ISO 8601 format
|
|
2429
|
-
*/
|
|
2430
|
-
createdAt: string;
|
|
2431
|
-
/**
|
|
2432
|
-
* Updating date of the task in ISO 8601 format
|
|
2433
|
-
*/
|
|
2434
|
-
updatedAt: string;
|
|
2435
|
-
/**
|
|
2436
|
-
* If the task fails this is the reason behind it
|
|
2437
|
-
*/
|
|
2438
|
-
failureReason?: string;
|
|
2439
|
-
/**
|
|
2440
|
-
* 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.
|
|
2441
|
-
*/
|
|
2442
|
-
tags: {
|
|
2443
|
-
[k: string]: string;
|
|
2444
|
-
};
|
|
2445
|
-
};
|
|
2446
|
-
}
|
|
2447
|
-
|
|
2448
|
-
interface UpdateTaskRequestHeaders$1 {
|
|
2449
|
-
}
|
|
2450
|
-
interface UpdateTaskRequestQuery$1 {
|
|
2451
|
-
}
|
|
2452
|
-
interface UpdateTaskRequestParams$1 {
|
|
2453
|
-
id: string;
|
|
2454
|
-
}
|
|
2455
|
-
interface UpdateTaskRequestBody$1 {
|
|
2456
|
-
/**
|
|
2457
|
-
* Title describing the task
|
|
2458
|
-
*/
|
|
2459
|
-
title?: string;
|
|
2460
|
-
/**
|
|
2461
|
-
* All the notes related to the execution of the current task
|
|
2462
|
-
*/
|
|
2463
|
-
description?: string;
|
|
2464
|
-
/**
|
|
2465
|
-
* Content related to the task
|
|
2466
|
-
*/
|
|
2467
|
-
data?: {
|
|
2468
|
-
[k: string]: any;
|
|
2469
|
-
};
|
|
2470
|
-
/**
|
|
2471
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
2472
|
-
*/
|
|
2473
|
-
timeoutAt?: string;
|
|
2474
|
-
/**
|
|
2475
|
-
* Status of the task
|
|
2476
|
-
*/
|
|
2477
|
-
status?: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
2478
|
-
/**
|
|
2479
|
-
* Tags for the [Task](#schema_task)
|
|
2480
|
-
*/
|
|
2481
|
-
tags?: {
|
|
2482
|
-
[k: string]: string;
|
|
2483
|
-
};
|
|
2484
|
-
}
|
|
2485
|
-
type UpdateTaskInput$1 = UpdateTaskRequestBody$1 & UpdateTaskRequestHeaders$1 & UpdateTaskRequestQuery$1 & UpdateTaskRequestParams$1;
|
|
2486
|
-
interface UpdateTaskResponse$1 {
|
|
2487
|
-
/**
|
|
2488
|
-
* Task definition
|
|
2489
|
-
*/
|
|
2490
|
-
task: {
|
|
2491
|
-
/**
|
|
2492
|
-
* Id of the [Task](#schema_task)
|
|
2493
|
-
*/
|
|
2494
|
-
id: string;
|
|
2495
|
-
/**
|
|
2496
|
-
* Title describing the task
|
|
2497
|
-
*/
|
|
2498
|
-
title: string;
|
|
2499
|
-
/**
|
|
2500
|
-
* All the notes related to the execution of the current task
|
|
2501
|
-
*/
|
|
2502
|
-
description: string;
|
|
2503
|
-
/**
|
|
2504
|
-
* Type of the task
|
|
2505
|
-
*/
|
|
2506
|
-
type: string;
|
|
2507
|
-
/**
|
|
2508
|
-
* Content related to the task
|
|
2509
|
-
*/
|
|
2510
|
-
data: {
|
|
2511
|
-
[k: string]: any;
|
|
2512
|
-
};
|
|
2513
|
-
/**
|
|
2514
|
-
* Status of the task
|
|
2515
|
-
*/
|
|
2516
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
2517
|
-
/**
|
|
2518
|
-
* Parent task id is the parent task that created this task
|
|
2519
|
-
*/
|
|
2520
|
-
parentTaskId?: string;
|
|
2521
|
-
/**
|
|
2522
|
-
* Conversation id related to this task
|
|
2523
|
-
*/
|
|
2524
|
-
conversationId?: string;
|
|
2525
|
-
/**
|
|
2526
|
-
* Specific user related to this task
|
|
2527
|
-
*/
|
|
2528
|
-
userId?: string;
|
|
2529
|
-
/**
|
|
2530
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
2531
|
-
*/
|
|
2532
|
-
timeoutAt: string;
|
|
2533
|
-
/**
|
|
2534
|
-
* Creation date of the task in ISO 8601 format
|
|
2535
|
-
*/
|
|
2536
|
-
createdAt: string;
|
|
2537
|
-
/**
|
|
2538
|
-
* Updating date of the task in ISO 8601 format
|
|
2539
|
-
*/
|
|
2540
|
-
updatedAt: string;
|
|
2541
|
-
/**
|
|
2542
|
-
* If the task fails this is the reason behind it
|
|
2543
|
-
*/
|
|
2544
|
-
failureReason?: string;
|
|
2545
|
-
/**
|
|
2546
|
-
* 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.
|
|
2547
|
-
*/
|
|
2548
|
-
tags: {
|
|
2549
|
-
[k: string]: string;
|
|
2550
|
-
};
|
|
2551
|
-
};
|
|
2552
|
-
}
|
|
2553
|
-
|
|
2554
|
-
interface DeleteTaskRequestHeaders$1 {
|
|
2555
|
-
}
|
|
2556
|
-
interface DeleteTaskRequestQuery$1 {
|
|
2557
|
-
}
|
|
2558
|
-
interface DeleteTaskRequestParams$1 {
|
|
2559
|
-
id: string;
|
|
2560
|
-
}
|
|
2561
|
-
interface DeleteTaskRequestBody$1 {
|
|
2562
|
-
}
|
|
2563
|
-
type DeleteTaskInput$1 = DeleteTaskRequestBody$1 & DeleteTaskRequestHeaders$1 & DeleteTaskRequestQuery$1 & DeleteTaskRequestParams$1;
|
|
2564
|
-
interface DeleteTaskResponse$1 {
|
|
2565
|
-
}
|
|
2566
|
-
|
|
2567
|
-
interface ListTasksRequestHeaders$1 {
|
|
2568
|
-
}
|
|
2569
|
-
interface ListTasksRequestQuery$1 {
|
|
2570
|
-
nextToken?: string;
|
|
2571
|
-
tags?: {
|
|
2572
|
-
[k: string]: string;
|
|
2573
|
-
};
|
|
2574
|
-
conversationId?: string;
|
|
2575
|
-
userId?: string;
|
|
2576
|
-
parentTaskId?: string;
|
|
2577
|
-
status?: ("pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled")[];
|
|
2578
|
-
type?: string;
|
|
2579
|
-
}
|
|
2580
|
-
interface ListTasksRequestParams$1 {
|
|
2581
|
-
}
|
|
2582
|
-
interface ListTasksRequestBody$1 {
|
|
2583
|
-
}
|
|
2584
|
-
type ListTasksInput$1 = ListTasksRequestBody$1 & ListTasksRequestHeaders$1 & ListTasksRequestQuery$1 & ListTasksRequestParams$1;
|
|
2585
|
-
interface ListTasksResponse$1 {
|
|
2586
|
-
tasks: {
|
|
2587
|
-
/**
|
|
2588
|
-
* Id of the [Task](#schema_task)
|
|
2589
|
-
*/
|
|
2590
|
-
id: string;
|
|
2591
|
-
/**
|
|
2592
|
-
* Title describing the task
|
|
2593
|
-
*/
|
|
2594
|
-
title: string;
|
|
2595
|
-
/**
|
|
2596
|
-
* All the notes related to the execution of the current task
|
|
2597
|
-
*/
|
|
2598
|
-
description: string;
|
|
2599
|
-
/**
|
|
2600
|
-
* Type of the task
|
|
2601
|
-
*/
|
|
2602
|
-
type: string;
|
|
2603
|
-
/**
|
|
2604
|
-
* Content related to the task
|
|
2605
|
-
*/
|
|
2606
|
-
data: {
|
|
2607
|
-
[k: string]: any;
|
|
2608
|
-
};
|
|
2609
|
-
/**
|
|
2610
|
-
* Status of the task
|
|
2611
|
-
*/
|
|
2612
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
2613
|
-
/**
|
|
2614
|
-
* Parent task id is the parent task that created this task
|
|
2615
|
-
*/
|
|
2616
|
-
parentTaskId?: string;
|
|
2617
|
-
/**
|
|
2618
|
-
* Conversation id related to this task
|
|
2619
|
-
*/
|
|
2620
|
-
conversationId?: string;
|
|
2621
|
-
/**
|
|
2622
|
-
* Specific user related to this task
|
|
2623
|
-
*/
|
|
2624
|
-
userId?: string;
|
|
2625
|
-
/**
|
|
2626
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
2627
|
-
*/
|
|
2628
|
-
timeoutAt: string;
|
|
2629
|
-
/**
|
|
2630
|
-
* Creation date of the task in ISO 8601 format
|
|
2631
|
-
*/
|
|
2632
|
-
createdAt: string;
|
|
2633
|
-
/**
|
|
2634
|
-
* Updating date of the task in ISO 8601 format
|
|
2635
|
-
*/
|
|
2636
|
-
updatedAt: string;
|
|
2637
|
-
/**
|
|
2638
|
-
* If the task fails this is the reason behind it
|
|
2639
|
-
*/
|
|
2640
|
-
failureReason?: string;
|
|
2641
|
-
/**
|
|
2642
|
-
* 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.
|
|
2643
|
-
*/
|
|
2644
|
-
tags: {
|
|
2645
|
-
[k: string]: string;
|
|
2646
|
-
};
|
|
2647
|
-
}[];
|
|
2648
|
-
meta: {
|
|
2649
|
-
/**
|
|
2650
|
-
* The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
|
|
2651
|
-
*/
|
|
2652
|
-
nextToken?: string;
|
|
2653
|
-
};
|
|
2654
|
-
}
|
|
2655
|
-
|
|
2656
2263
|
interface CreateWorkflowRequestHeaders$1 {
|
|
2657
2264
|
}
|
|
2658
2265
|
interface CreateWorkflowRequestQuery$1 {
|
|
@@ -3234,6 +2841,10 @@ interface CaptureObservationRequestQuery$1 {
|
|
|
3234
2841
|
interface CaptureObservationRequestParams$1 {
|
|
3235
2842
|
}
|
|
3236
2843
|
interface CaptureObservationRequestBody$1 {
|
|
2844
|
+
/**
|
|
2845
|
+
* Caller-defined identifier for the observation (e.g. llmz context ID). Uniqueness is not enforced nor guaranteed.
|
|
2846
|
+
*/
|
|
2847
|
+
id?: string;
|
|
3237
2848
|
/**
|
|
3238
2849
|
* Name of the observation
|
|
3239
2850
|
*/
|
|
@@ -3316,11 +2927,6 @@ declare class Client$b {
|
|
|
3316
2927
|
readonly patchState: (input: PatchStateInput$1) => Promise<PatchStateResponse$1>;
|
|
3317
2928
|
readonly callAction: (input: CallActionInput$1) => Promise<CallActionResponse$1>;
|
|
3318
2929
|
readonly configureIntegration: (input: ConfigureIntegrationInput$1) => Promise<ConfigureIntegrationResponse$1>;
|
|
3319
|
-
readonly getTask: (input: GetTaskInput$1) => Promise<GetTaskResponse$1>;
|
|
3320
|
-
readonly createTask: (input: CreateTaskInput$1) => Promise<CreateTaskResponse$1>;
|
|
3321
|
-
readonly updateTask: (input: UpdateTaskInput$1) => Promise<UpdateTaskResponse$1>;
|
|
3322
|
-
readonly deleteTask: (input: DeleteTaskInput$1) => Promise<DeleteTaskResponse$1>;
|
|
3323
|
-
readonly listTasks: (input: ListTasksInput$1) => Promise<ListTasksResponse$1>;
|
|
3324
2930
|
readonly createWorkflow: (input: CreateWorkflowInput$1) => Promise<CreateWorkflowResponse$1>;
|
|
3325
2931
|
readonly getWorkflow: (input: GetWorkflowInput$1) => Promise<GetWorkflowResponse$1>;
|
|
3326
2932
|
readonly updateWorkflow: (input: UpdateWorkflowInput$1) => Promise<UpdateWorkflowResponse$1>;
|
|
@@ -3451,35 +3057,6 @@ declare class Client$a extends Client$b {
|
|
|
3451
3057
|
[k: string]: string;
|
|
3452
3058
|
};
|
|
3453
3059
|
}>;
|
|
3454
|
-
tasks: (props: {
|
|
3455
|
-
status?: ("timeout" | "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "cancelled")[] | undefined;
|
|
3456
|
-
tags?: {
|
|
3457
|
-
[x: string]: string;
|
|
3458
|
-
} | undefined;
|
|
3459
|
-
type?: string | undefined;
|
|
3460
|
-
userId?: string | undefined;
|
|
3461
|
-
conversationId?: string | undefined;
|
|
3462
|
-
parentTaskId?: string | undefined;
|
|
3463
|
-
}) => AsyncCollection<{
|
|
3464
|
-
id: string;
|
|
3465
|
-
title: string;
|
|
3466
|
-
description: string;
|
|
3467
|
-
type: string;
|
|
3468
|
-
data: {
|
|
3469
|
-
[k: string]: any;
|
|
3470
|
-
};
|
|
3471
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
3472
|
-
parentTaskId?: string;
|
|
3473
|
-
conversationId?: string;
|
|
3474
|
-
userId?: string;
|
|
3475
|
-
timeoutAt: string;
|
|
3476
|
-
createdAt: string;
|
|
3477
|
-
updatedAt: string;
|
|
3478
|
-
failureReason?: string;
|
|
3479
|
-
tags: {
|
|
3480
|
-
[k: string]: string;
|
|
3481
|
-
};
|
|
3482
|
-
}>;
|
|
3483
3060
|
};
|
|
3484
3061
|
}
|
|
3485
3062
|
|
|
@@ -3772,6 +3349,12 @@ interface ListPublicIntegrationsResponse$1 {
|
|
|
3772
3349
|
*/
|
|
3773
3350
|
interfaces?: string[];
|
|
3774
3351
|
};
|
|
3352
|
+
/**
|
|
3353
|
+
* Optional key-value attributes from the integration definition
|
|
3354
|
+
*/
|
|
3355
|
+
attributes?: {
|
|
3356
|
+
[k: string]: string;
|
|
3357
|
+
};
|
|
3775
3358
|
}[];
|
|
3776
3359
|
meta: {
|
|
3777
3360
|
/**
|
|
@@ -4746,9 +4329,9 @@ interface GetPublicPluginByIdResponse$1 {
|
|
|
4746
4329
|
states: {
|
|
4747
4330
|
[k: string]: {
|
|
4748
4331
|
/**
|
|
4749
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
4332
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
4750
4333
|
*/
|
|
4751
|
-
type: "conversation" | "user" | "bot"
|
|
4334
|
+
type: "conversation" | "user" | "bot";
|
|
4752
4335
|
/**
|
|
4753
4336
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
4754
4337
|
*/
|
|
@@ -4975,9 +4558,9 @@ interface GetDereferencedPublicPluginByIdResponse$1 {
|
|
|
4975
4558
|
states: {
|
|
4976
4559
|
[k: string]: {
|
|
4977
4560
|
/**
|
|
4978
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
4561
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
4979
4562
|
*/
|
|
4980
|
-
type: "conversation" | "user" | "bot"
|
|
4563
|
+
type: "conversation" | "user" | "bot";
|
|
4981
4564
|
/**
|
|
4982
4565
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
4983
4566
|
*/
|
|
@@ -5196,9 +4779,9 @@ interface GetPublicPluginResponse$1 {
|
|
|
5196
4779
|
states: {
|
|
5197
4780
|
[k: string]: {
|
|
5198
4781
|
/**
|
|
5199
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
4782
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
5200
4783
|
*/
|
|
5201
|
-
type: "conversation" | "user" | "bot"
|
|
4784
|
+
type: "conversation" | "user" | "bot";
|
|
5202
4785
|
/**
|
|
5203
4786
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
5204
4787
|
*/
|
|
@@ -5784,9 +5367,9 @@ interface CreateBotRequestBody$1 {
|
|
|
5784
5367
|
states?: {
|
|
5785
5368
|
[k: string]: {
|
|
5786
5369
|
/**
|
|
5787
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
5370
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
5788
5371
|
*/
|
|
5789
|
-
type: "conversation" | "user" | "bot"
|
|
5372
|
+
type: "conversation" | "user" | "bot";
|
|
5790
5373
|
/**
|
|
5791
5374
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
5792
5375
|
*/
|
|
@@ -6222,9 +5805,9 @@ interface CreateBotResponse$1 {
|
|
|
6222
5805
|
states: {
|
|
6223
5806
|
[k: string]: {
|
|
6224
5807
|
/**
|
|
6225
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
5808
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
6226
5809
|
*/
|
|
6227
|
-
type: "conversation" | "user" | "bot"
|
|
5810
|
+
type: "conversation" | "user" | "bot";
|
|
6228
5811
|
/**
|
|
6229
5812
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
6230
5813
|
*/
|
|
@@ -6550,9 +6133,9 @@ interface UpdateBotRequestBody$1 {
|
|
|
6550
6133
|
states?: {
|
|
6551
6134
|
[k: string]: {
|
|
6552
6135
|
/**
|
|
6553
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
6136
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
6554
6137
|
*/
|
|
6555
|
-
type: "conversation" | "user" | "bot"
|
|
6138
|
+
type: "conversation" | "user" | "bot";
|
|
6556
6139
|
/**
|
|
6557
6140
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
6558
6141
|
*/
|
|
@@ -6902,9 +6485,9 @@ interface UpdateBotResponse$1 {
|
|
|
6902
6485
|
states: {
|
|
6903
6486
|
[k: string]: {
|
|
6904
6487
|
/**
|
|
6905
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
6488
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
6906
6489
|
*/
|
|
6907
|
-
type: "conversation" | "user" | "bot"
|
|
6490
|
+
type: "conversation" | "user" | "bot";
|
|
6908
6491
|
/**
|
|
6909
6492
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
6910
6493
|
*/
|
|
@@ -7410,9 +6993,9 @@ interface GetBotResponse$1 {
|
|
|
7410
6993
|
states: {
|
|
7411
6994
|
[k: string]: {
|
|
7412
6995
|
/**
|
|
7413
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
6996
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
7414
6997
|
*/
|
|
7415
|
-
type: "conversation" | "user" | "bot"
|
|
6998
|
+
type: "conversation" | "user" | "bot";
|
|
7416
6999
|
/**
|
|
7417
7000
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
7418
7001
|
*/
|
|
@@ -11135,6 +10718,12 @@ interface ListIntegrationsResponse$1 {
|
|
|
11135
10718
|
handle: string | null;
|
|
11136
10719
|
name: string;
|
|
11137
10720
|
};
|
|
10721
|
+
/**
|
|
10722
|
+
* Optional key-value attributes from the integration definition
|
|
10723
|
+
*/
|
|
10724
|
+
attributes?: {
|
|
10725
|
+
[k: string]: string;
|
|
10726
|
+
};
|
|
11138
10727
|
}[];
|
|
11139
10728
|
meta: {
|
|
11140
10729
|
/**
|
|
@@ -13057,9 +12646,9 @@ interface CreatePluginRequestBody$1 {
|
|
|
13057
12646
|
states?: {
|
|
13058
12647
|
[k: string]: {
|
|
13059
12648
|
/**
|
|
13060
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
12649
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
13061
12650
|
*/
|
|
13062
|
-
type: "conversation" | "user" | "bot"
|
|
12651
|
+
type: "conversation" | "user" | "bot";
|
|
13063
12652
|
/**
|
|
13064
12653
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
13065
12654
|
*/
|
|
@@ -13297,9 +12886,9 @@ interface CreatePluginResponse$1 {
|
|
|
13297
12886
|
states: {
|
|
13298
12887
|
[k: string]: {
|
|
13299
12888
|
/**
|
|
13300
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
12889
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
13301
12890
|
*/
|
|
13302
|
-
type: "conversation" | "user" | "bot"
|
|
12891
|
+
type: "conversation" | "user" | "bot";
|
|
13303
12892
|
/**
|
|
13304
12893
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
13305
12894
|
*/
|
|
@@ -13517,9 +13106,9 @@ interface GetPluginResponse$1 {
|
|
|
13517
13106
|
states: {
|
|
13518
13107
|
[k: string]: {
|
|
13519
13108
|
/**
|
|
13520
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
13109
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
13521
13110
|
*/
|
|
13522
|
-
type: "conversation" | "user" | "bot"
|
|
13111
|
+
type: "conversation" | "user" | "bot";
|
|
13523
13112
|
/**
|
|
13524
13113
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
13525
13114
|
*/
|
|
@@ -13746,9 +13335,9 @@ interface GetDereferencedPluginResponse$1 {
|
|
|
13746
13335
|
states: {
|
|
13747
13336
|
[k: string]: {
|
|
13748
13337
|
/**
|
|
13749
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
13338
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
13750
13339
|
*/
|
|
13751
|
-
type: "conversation" | "user" | "bot"
|
|
13340
|
+
type: "conversation" | "user" | "bot";
|
|
13752
13341
|
/**
|
|
13753
13342
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
13754
13343
|
*/
|
|
@@ -13967,9 +13556,9 @@ interface GetPluginByNameResponse$1 {
|
|
|
13967
13556
|
states: {
|
|
13968
13557
|
[k: string]: {
|
|
13969
13558
|
/**
|
|
13970
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
13559
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
13971
13560
|
*/
|
|
13972
|
-
type: "conversation" | "user" | "bot"
|
|
13561
|
+
type: "conversation" | "user" | "bot";
|
|
13973
13562
|
/**
|
|
13974
13563
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
13975
13564
|
*/
|
|
@@ -14163,9 +13752,9 @@ interface UpdatePluginRequestBody$1 {
|
|
|
14163
13752
|
states?: {
|
|
14164
13753
|
[k: string]: {
|
|
14165
13754
|
/**
|
|
14166
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
13755
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
14167
13756
|
*/
|
|
14168
|
-
type: "conversation" | "user" | "bot"
|
|
13757
|
+
type: "conversation" | "user" | "bot";
|
|
14169
13758
|
/**
|
|
14170
13759
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
14171
13760
|
*/
|
|
@@ -14391,9 +13980,9 @@ interface UpdatePluginResponse$1 {
|
|
|
14391
13980
|
states: {
|
|
14392
13981
|
[k: string]: {
|
|
14393
13982
|
/**
|
|
14394
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
13983
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
14395
13984
|
*/
|
|
14396
|
-
type: "conversation" | "user" | "bot"
|
|
13985
|
+
type: "conversation" | "user" | "bot";
|
|
14397
13986
|
/**
|
|
14398
13987
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
14399
13988
|
*/
|
|
@@ -15062,6 +14651,9 @@ declare class Client$8 extends Client$9 {
|
|
|
15062
14651
|
actions?: string[];
|
|
15063
14652
|
interfaces?: string[];
|
|
15064
14653
|
};
|
|
14654
|
+
attributes?: {
|
|
14655
|
+
[k: string]: string;
|
|
14656
|
+
};
|
|
15065
14657
|
}>;
|
|
15066
14658
|
bots: (props: {
|
|
15067
14659
|
tags?: {
|
|
@@ -15153,6 +14745,9 @@ declare class Client$8 extends Client$9 {
|
|
|
15153
14745
|
handle: string | null;
|
|
15154
14746
|
name: string;
|
|
15155
14747
|
};
|
|
14748
|
+
attributes?: {
|
|
14749
|
+
[k: string]: string;
|
|
14750
|
+
};
|
|
15156
14751
|
}>;
|
|
15157
14752
|
interfaces: (props: {
|
|
15158
14753
|
name?: string | undefined;
|
|
@@ -19026,7 +18621,8 @@ interface CreateConversationResponse {
|
|
|
19026
18621
|
*/
|
|
19027
18622
|
id: string;
|
|
19028
18623
|
/**
|
|
19029
|
-
*
|
|
18624
|
+
* @deprecated
|
|
18625
|
+
* Unused. This field will be removed in the future.
|
|
19030
18626
|
*/
|
|
19031
18627
|
currentTaskId?: string;
|
|
19032
18628
|
/**
|
|
@@ -19078,7 +18674,8 @@ interface GetConversationResponse {
|
|
|
19078
18674
|
*/
|
|
19079
18675
|
id: string;
|
|
19080
18676
|
/**
|
|
19081
|
-
*
|
|
18677
|
+
* @deprecated
|
|
18678
|
+
* Unused. This field will be removed in the future.
|
|
19082
18679
|
*/
|
|
19083
18680
|
currentTaskId?: string;
|
|
19084
18681
|
/**
|
|
@@ -19137,7 +18734,8 @@ interface ListConversationsResponse {
|
|
|
19137
18734
|
*/
|
|
19138
18735
|
id: string;
|
|
19139
18736
|
/**
|
|
19140
|
-
*
|
|
18737
|
+
* @deprecated
|
|
18738
|
+
* Unused. This field will be removed in the future.
|
|
19141
18739
|
*/
|
|
19142
18740
|
currentTaskId?: string;
|
|
19143
18741
|
/**
|
|
@@ -19213,7 +18811,8 @@ interface GetOrCreateConversationResponse {
|
|
|
19213
18811
|
*/
|
|
19214
18812
|
id: string;
|
|
19215
18813
|
/**
|
|
19216
|
-
*
|
|
18814
|
+
* @deprecated
|
|
18815
|
+
* Unused. This field will be removed in the future.
|
|
19217
18816
|
*/
|
|
19218
18817
|
currentTaskId?: string;
|
|
19219
18818
|
/**
|
|
@@ -19253,6 +18852,10 @@ interface UpdateConversationRequestParams {
|
|
|
19253
18852
|
id: string;
|
|
19254
18853
|
}
|
|
19255
18854
|
interface UpdateConversationRequestBody {
|
|
18855
|
+
/**
|
|
18856
|
+
* @deprecated
|
|
18857
|
+
* Unused. This parameter will be ignored if provided and should not be used when updating a conversation.
|
|
18858
|
+
*/
|
|
19256
18859
|
currentTaskId?: string;
|
|
19257
18860
|
/**
|
|
19258
18861
|
* Tags for the [Conversation](#schema_conversation)
|
|
@@ -19272,7 +18875,8 @@ interface UpdateConversationResponse {
|
|
|
19272
18875
|
*/
|
|
19273
18876
|
id: string;
|
|
19274
18877
|
/**
|
|
19275
|
-
*
|
|
18878
|
+
* @deprecated
|
|
18879
|
+
* Unused. This field will be removed in the future.
|
|
19276
18880
|
*/
|
|
19277
18881
|
currentTaskId?: string;
|
|
19278
18882
|
/**
|
|
@@ -20160,7 +19764,7 @@ interface InitializeIncomingMessageRequestBody {
|
|
|
20160
19764
|
*/
|
|
20161
19765
|
pictureUrl?: string;
|
|
20162
19766
|
/**
|
|
20163
|
-
* Optional attributes
|
|
19767
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
|
|
20164
19768
|
*/
|
|
20165
19769
|
attributes?: {
|
|
20166
19770
|
[k: string]: string;
|
|
@@ -20264,7 +19868,8 @@ interface InitializeIncomingMessageResponse {
|
|
|
20264
19868
|
*/
|
|
20265
19869
|
id: string;
|
|
20266
19870
|
/**
|
|
20267
|
-
*
|
|
19871
|
+
* @deprecated
|
|
19872
|
+
* Unused. This field will be removed in the future.
|
|
20268
19873
|
*/
|
|
20269
19874
|
currentTaskId?: string;
|
|
20270
19875
|
/**
|
|
@@ -20467,7 +20072,7 @@ interface CreateUserRequestBody {
|
|
|
20467
20072
|
*/
|
|
20468
20073
|
pictureUrl?: string;
|
|
20469
20074
|
/**
|
|
20470
|
-
* Optional attributes
|
|
20075
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
|
|
20471
20076
|
*/
|
|
20472
20077
|
attributes?: {
|
|
20473
20078
|
[k: string]: string;
|
|
@@ -20653,7 +20258,7 @@ interface GetOrCreateUserRequestBody {
|
|
|
20653
20258
|
*/
|
|
20654
20259
|
pictureUrl?: string;
|
|
20655
20260
|
/**
|
|
20656
|
-
* Optional attributes
|
|
20261
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
|
|
20657
20262
|
*/
|
|
20658
20263
|
attributes?: {
|
|
20659
20264
|
[k: string]: string;
|
|
@@ -20727,7 +20332,7 @@ interface UpdateUserRequestBody {
|
|
|
20727
20332
|
*/
|
|
20728
20333
|
pictureUrl?: string | null;
|
|
20729
20334
|
/**
|
|
20730
|
-
* Optional attributes. Set attributes to null to remove them
|
|
20335
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations. Set individual attributes to null to remove them.
|
|
20731
20336
|
*/
|
|
20732
20337
|
attributes?: {
|
|
20733
20338
|
[k: string]: string | null;
|
|
@@ -20792,7 +20397,7 @@ interface SetStateExpiryRequestHeaders {
|
|
|
20792
20397
|
interface SetStateExpiryRequestQuery {
|
|
20793
20398
|
}
|
|
20794
20399
|
interface SetStateExpiryRequestParams {
|
|
20795
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
20400
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
20796
20401
|
id: string;
|
|
20797
20402
|
name: string;
|
|
20798
20403
|
}
|
|
@@ -20837,9 +20442,9 @@ interface SetStateExpiryResponse {
|
|
|
20837
20442
|
*/
|
|
20838
20443
|
name: string;
|
|
20839
20444
|
/**
|
|
20840
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
20445
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
20841
20446
|
*/
|
|
20842
|
-
type: "conversation" | "user" | "bot" | "
|
|
20447
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
20843
20448
|
/**
|
|
20844
20449
|
* Payload is the content of the state defined by your bot.
|
|
20845
20450
|
*/
|
|
@@ -20854,7 +20459,7 @@ interface GetStateRequestHeaders {
|
|
|
20854
20459
|
interface GetStateRequestQuery {
|
|
20855
20460
|
}
|
|
20856
20461
|
interface GetStateRequestParams {
|
|
20857
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
20462
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
20858
20463
|
id: string;
|
|
20859
20464
|
name: string;
|
|
20860
20465
|
}
|
|
@@ -20895,9 +20500,9 @@ interface GetStateResponse {
|
|
|
20895
20500
|
*/
|
|
20896
20501
|
name: string;
|
|
20897
20502
|
/**
|
|
20898
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
20503
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
20899
20504
|
*/
|
|
20900
|
-
type: "conversation" | "user" | "bot" | "
|
|
20505
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
20901
20506
|
/**
|
|
20902
20507
|
* Payload is the content of the state defined by your bot.
|
|
20903
20508
|
*/
|
|
@@ -20915,7 +20520,7 @@ interface SetStateRequestHeaders {
|
|
|
20915
20520
|
interface SetStateRequestQuery {
|
|
20916
20521
|
}
|
|
20917
20522
|
interface SetStateRequestParams {
|
|
20918
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
20523
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
20919
20524
|
id: string;
|
|
20920
20525
|
name: string;
|
|
20921
20526
|
}
|
|
@@ -20966,9 +20571,9 @@ interface SetStateResponse {
|
|
|
20966
20571
|
*/
|
|
20967
20572
|
name: string;
|
|
20968
20573
|
/**
|
|
20969
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
20574
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
20970
20575
|
*/
|
|
20971
|
-
type: "conversation" | "user" | "bot" | "
|
|
20576
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
20972
20577
|
/**
|
|
20973
20578
|
* Payload is the content of the state defined by your bot.
|
|
20974
20579
|
*/
|
|
@@ -20983,7 +20588,7 @@ interface GetOrSetStateRequestHeaders {
|
|
|
20983
20588
|
interface GetOrSetStateRequestQuery {
|
|
20984
20589
|
}
|
|
20985
20590
|
interface GetOrSetStateRequestParams {
|
|
20986
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
20591
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
20987
20592
|
id: string;
|
|
20988
20593
|
name: string;
|
|
20989
20594
|
}
|
|
@@ -21034,9 +20639,9 @@ interface GetOrSetStateResponse {
|
|
|
21034
20639
|
*/
|
|
21035
20640
|
name: string;
|
|
21036
20641
|
/**
|
|
21037
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
20642
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
21038
20643
|
*/
|
|
21039
|
-
type: "conversation" | "user" | "bot" | "
|
|
20644
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
21040
20645
|
/**
|
|
21041
20646
|
* Payload is the content of the state defined by your bot.
|
|
21042
20647
|
*/
|
|
@@ -21054,7 +20659,7 @@ interface PatchStateRequestHeaders {
|
|
|
21054
20659
|
interface PatchStateRequestQuery {
|
|
21055
20660
|
}
|
|
21056
20661
|
interface PatchStateRequestParams {
|
|
21057
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
20662
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
21058
20663
|
id: string;
|
|
21059
20664
|
name: string;
|
|
21060
20665
|
}
|
|
@@ -21101,9 +20706,9 @@ interface PatchStateResponse {
|
|
|
21101
20706
|
*/
|
|
21102
20707
|
name: string;
|
|
21103
20708
|
/**
|
|
21104
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
20709
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
21105
20710
|
*/
|
|
21106
|
-
type: "conversation" | "user" | "bot" | "
|
|
20711
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
21107
20712
|
/**
|
|
21108
20713
|
* Payload is the content of the state defined by your bot.
|
|
21109
20714
|
*/
|
|
@@ -21168,409 +20773,6 @@ type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureInte
|
|
|
21168
20773
|
interface ConfigureIntegrationResponse {
|
|
21169
20774
|
}
|
|
21170
20775
|
|
|
21171
|
-
interface GetTaskRequestHeaders {
|
|
21172
|
-
}
|
|
21173
|
-
interface GetTaskRequestQuery {
|
|
21174
|
-
}
|
|
21175
|
-
interface GetTaskRequestParams {
|
|
21176
|
-
id: string;
|
|
21177
|
-
}
|
|
21178
|
-
interface GetTaskRequestBody {
|
|
21179
|
-
}
|
|
21180
|
-
type GetTaskInput = GetTaskRequestBody & GetTaskRequestHeaders & GetTaskRequestQuery & GetTaskRequestParams;
|
|
21181
|
-
interface GetTaskResponse {
|
|
21182
|
-
/**
|
|
21183
|
-
* Task definition
|
|
21184
|
-
*/
|
|
21185
|
-
task: {
|
|
21186
|
-
/**
|
|
21187
|
-
* Id of the [Task](#schema_task)
|
|
21188
|
-
*/
|
|
21189
|
-
id: string;
|
|
21190
|
-
/**
|
|
21191
|
-
* Title describing the task
|
|
21192
|
-
*/
|
|
21193
|
-
title: string;
|
|
21194
|
-
/**
|
|
21195
|
-
* All the notes related to the execution of the current task
|
|
21196
|
-
*/
|
|
21197
|
-
description: string;
|
|
21198
|
-
/**
|
|
21199
|
-
* Type of the task
|
|
21200
|
-
*/
|
|
21201
|
-
type: string;
|
|
21202
|
-
/**
|
|
21203
|
-
* Content related to the task
|
|
21204
|
-
*/
|
|
21205
|
-
data: {
|
|
21206
|
-
[k: string]: any;
|
|
21207
|
-
};
|
|
21208
|
-
/**
|
|
21209
|
-
* Status of the task
|
|
21210
|
-
*/
|
|
21211
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
21212
|
-
/**
|
|
21213
|
-
* Parent task id is the parent task that created this task
|
|
21214
|
-
*/
|
|
21215
|
-
parentTaskId?: string;
|
|
21216
|
-
/**
|
|
21217
|
-
* Conversation id related to this task
|
|
21218
|
-
*/
|
|
21219
|
-
conversationId?: string;
|
|
21220
|
-
/**
|
|
21221
|
-
* Specific user related to this task
|
|
21222
|
-
*/
|
|
21223
|
-
userId?: string;
|
|
21224
|
-
/**
|
|
21225
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
21226
|
-
*/
|
|
21227
|
-
timeoutAt: string;
|
|
21228
|
-
/**
|
|
21229
|
-
* Creation date of the task in ISO 8601 format
|
|
21230
|
-
*/
|
|
21231
|
-
createdAt: string;
|
|
21232
|
-
/**
|
|
21233
|
-
* Updating date of the task in ISO 8601 format
|
|
21234
|
-
*/
|
|
21235
|
-
updatedAt: string;
|
|
21236
|
-
/**
|
|
21237
|
-
* If the task fails this is the reason behind it
|
|
21238
|
-
*/
|
|
21239
|
-
failureReason?: string;
|
|
21240
|
-
/**
|
|
21241
|
-
* 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.
|
|
21242
|
-
*/
|
|
21243
|
-
tags: {
|
|
21244
|
-
[k: string]: string;
|
|
21245
|
-
};
|
|
21246
|
-
};
|
|
21247
|
-
}
|
|
21248
|
-
|
|
21249
|
-
interface CreateTaskRequestHeaders {
|
|
21250
|
-
}
|
|
21251
|
-
interface CreateTaskRequestQuery {
|
|
21252
|
-
}
|
|
21253
|
-
interface CreateTaskRequestParams {
|
|
21254
|
-
}
|
|
21255
|
-
interface CreateTaskRequestBody {
|
|
21256
|
-
/**
|
|
21257
|
-
* Title describing the task
|
|
21258
|
-
*/
|
|
21259
|
-
title?: string;
|
|
21260
|
-
/**
|
|
21261
|
-
* All the notes related to the execution of the current task
|
|
21262
|
-
*/
|
|
21263
|
-
description?: string;
|
|
21264
|
-
/**
|
|
21265
|
-
* Type of the task
|
|
21266
|
-
*/
|
|
21267
|
-
type: string;
|
|
21268
|
-
/**
|
|
21269
|
-
* Content related to the task
|
|
21270
|
-
*/
|
|
21271
|
-
data?: {
|
|
21272
|
-
[k: string]: any;
|
|
21273
|
-
};
|
|
21274
|
-
/**
|
|
21275
|
-
* Parent task id is the parent task that created this task
|
|
21276
|
-
*/
|
|
21277
|
-
parentTaskId?: string;
|
|
21278
|
-
/**
|
|
21279
|
-
* Conversation id related to this task
|
|
21280
|
-
*/
|
|
21281
|
-
conversationId: string;
|
|
21282
|
-
/**
|
|
21283
|
-
* Specific user related to this task
|
|
21284
|
-
*/
|
|
21285
|
-
userId?: string;
|
|
21286
|
-
/**
|
|
21287
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
21288
|
-
*/
|
|
21289
|
-
timeoutAt?: string;
|
|
21290
|
-
/**
|
|
21291
|
-
* Tags for the [Task](#schema_task)
|
|
21292
|
-
*/
|
|
21293
|
-
tags?: {
|
|
21294
|
-
[k: string]: string;
|
|
21295
|
-
};
|
|
21296
|
-
}
|
|
21297
|
-
type CreateTaskInput = CreateTaskRequestBody & CreateTaskRequestHeaders & CreateTaskRequestQuery & CreateTaskRequestParams;
|
|
21298
|
-
interface CreateTaskResponse {
|
|
21299
|
-
/**
|
|
21300
|
-
* Task definition
|
|
21301
|
-
*/
|
|
21302
|
-
task: {
|
|
21303
|
-
/**
|
|
21304
|
-
* Id of the [Task](#schema_task)
|
|
21305
|
-
*/
|
|
21306
|
-
id: string;
|
|
21307
|
-
/**
|
|
21308
|
-
* Title describing the task
|
|
21309
|
-
*/
|
|
21310
|
-
title: string;
|
|
21311
|
-
/**
|
|
21312
|
-
* All the notes related to the execution of the current task
|
|
21313
|
-
*/
|
|
21314
|
-
description: string;
|
|
21315
|
-
/**
|
|
21316
|
-
* Type of the task
|
|
21317
|
-
*/
|
|
21318
|
-
type: string;
|
|
21319
|
-
/**
|
|
21320
|
-
* Content related to the task
|
|
21321
|
-
*/
|
|
21322
|
-
data: {
|
|
21323
|
-
[k: string]: any;
|
|
21324
|
-
};
|
|
21325
|
-
/**
|
|
21326
|
-
* Status of the task
|
|
21327
|
-
*/
|
|
21328
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
21329
|
-
/**
|
|
21330
|
-
* Parent task id is the parent task that created this task
|
|
21331
|
-
*/
|
|
21332
|
-
parentTaskId?: string;
|
|
21333
|
-
/**
|
|
21334
|
-
* Conversation id related to this task
|
|
21335
|
-
*/
|
|
21336
|
-
conversationId?: string;
|
|
21337
|
-
/**
|
|
21338
|
-
* Specific user related to this task
|
|
21339
|
-
*/
|
|
21340
|
-
userId?: string;
|
|
21341
|
-
/**
|
|
21342
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
21343
|
-
*/
|
|
21344
|
-
timeoutAt: string;
|
|
21345
|
-
/**
|
|
21346
|
-
* Creation date of the task in ISO 8601 format
|
|
21347
|
-
*/
|
|
21348
|
-
createdAt: string;
|
|
21349
|
-
/**
|
|
21350
|
-
* Updating date of the task in ISO 8601 format
|
|
21351
|
-
*/
|
|
21352
|
-
updatedAt: string;
|
|
21353
|
-
/**
|
|
21354
|
-
* If the task fails this is the reason behind it
|
|
21355
|
-
*/
|
|
21356
|
-
failureReason?: string;
|
|
21357
|
-
/**
|
|
21358
|
-
* 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.
|
|
21359
|
-
*/
|
|
21360
|
-
tags: {
|
|
21361
|
-
[k: string]: string;
|
|
21362
|
-
};
|
|
21363
|
-
};
|
|
21364
|
-
}
|
|
21365
|
-
|
|
21366
|
-
interface UpdateTaskRequestHeaders {
|
|
21367
|
-
}
|
|
21368
|
-
interface UpdateTaskRequestQuery {
|
|
21369
|
-
}
|
|
21370
|
-
interface UpdateTaskRequestParams {
|
|
21371
|
-
id: string;
|
|
21372
|
-
}
|
|
21373
|
-
interface UpdateTaskRequestBody {
|
|
21374
|
-
/**
|
|
21375
|
-
* Title describing the task
|
|
21376
|
-
*/
|
|
21377
|
-
title?: string;
|
|
21378
|
-
/**
|
|
21379
|
-
* All the notes related to the execution of the current task
|
|
21380
|
-
*/
|
|
21381
|
-
description?: string;
|
|
21382
|
-
/**
|
|
21383
|
-
* Content related to the task
|
|
21384
|
-
*/
|
|
21385
|
-
data?: {
|
|
21386
|
-
[k: string]: any;
|
|
21387
|
-
};
|
|
21388
|
-
/**
|
|
21389
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
21390
|
-
*/
|
|
21391
|
-
timeoutAt?: string;
|
|
21392
|
-
/**
|
|
21393
|
-
* Status of the task
|
|
21394
|
-
*/
|
|
21395
|
-
status?: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
21396
|
-
/**
|
|
21397
|
-
* Tags for the [Task](#schema_task)
|
|
21398
|
-
*/
|
|
21399
|
-
tags?: {
|
|
21400
|
-
[k: string]: string;
|
|
21401
|
-
};
|
|
21402
|
-
}
|
|
21403
|
-
type UpdateTaskInput = UpdateTaskRequestBody & UpdateTaskRequestHeaders & UpdateTaskRequestQuery & UpdateTaskRequestParams;
|
|
21404
|
-
interface UpdateTaskResponse {
|
|
21405
|
-
/**
|
|
21406
|
-
* Task definition
|
|
21407
|
-
*/
|
|
21408
|
-
task: {
|
|
21409
|
-
/**
|
|
21410
|
-
* Id of the [Task](#schema_task)
|
|
21411
|
-
*/
|
|
21412
|
-
id: string;
|
|
21413
|
-
/**
|
|
21414
|
-
* Title describing the task
|
|
21415
|
-
*/
|
|
21416
|
-
title: string;
|
|
21417
|
-
/**
|
|
21418
|
-
* All the notes related to the execution of the current task
|
|
21419
|
-
*/
|
|
21420
|
-
description: string;
|
|
21421
|
-
/**
|
|
21422
|
-
* Type of the task
|
|
21423
|
-
*/
|
|
21424
|
-
type: string;
|
|
21425
|
-
/**
|
|
21426
|
-
* Content related to the task
|
|
21427
|
-
*/
|
|
21428
|
-
data: {
|
|
21429
|
-
[k: string]: any;
|
|
21430
|
-
};
|
|
21431
|
-
/**
|
|
21432
|
-
* Status of the task
|
|
21433
|
-
*/
|
|
21434
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
21435
|
-
/**
|
|
21436
|
-
* Parent task id is the parent task that created this task
|
|
21437
|
-
*/
|
|
21438
|
-
parentTaskId?: string;
|
|
21439
|
-
/**
|
|
21440
|
-
* Conversation id related to this task
|
|
21441
|
-
*/
|
|
21442
|
-
conversationId?: string;
|
|
21443
|
-
/**
|
|
21444
|
-
* Specific user related to this task
|
|
21445
|
-
*/
|
|
21446
|
-
userId?: string;
|
|
21447
|
-
/**
|
|
21448
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
21449
|
-
*/
|
|
21450
|
-
timeoutAt: string;
|
|
21451
|
-
/**
|
|
21452
|
-
* Creation date of the task in ISO 8601 format
|
|
21453
|
-
*/
|
|
21454
|
-
createdAt: string;
|
|
21455
|
-
/**
|
|
21456
|
-
* Updating date of the task in ISO 8601 format
|
|
21457
|
-
*/
|
|
21458
|
-
updatedAt: string;
|
|
21459
|
-
/**
|
|
21460
|
-
* If the task fails this is the reason behind it
|
|
21461
|
-
*/
|
|
21462
|
-
failureReason?: string;
|
|
21463
|
-
/**
|
|
21464
|
-
* 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.
|
|
21465
|
-
*/
|
|
21466
|
-
tags: {
|
|
21467
|
-
[k: string]: string;
|
|
21468
|
-
};
|
|
21469
|
-
};
|
|
21470
|
-
}
|
|
21471
|
-
|
|
21472
|
-
interface DeleteTaskRequestHeaders {
|
|
21473
|
-
}
|
|
21474
|
-
interface DeleteTaskRequestQuery {
|
|
21475
|
-
}
|
|
21476
|
-
interface DeleteTaskRequestParams {
|
|
21477
|
-
id: string;
|
|
21478
|
-
}
|
|
21479
|
-
interface DeleteTaskRequestBody {
|
|
21480
|
-
}
|
|
21481
|
-
type DeleteTaskInput = DeleteTaskRequestBody & DeleteTaskRequestHeaders & DeleteTaskRequestQuery & DeleteTaskRequestParams;
|
|
21482
|
-
interface DeleteTaskResponse {
|
|
21483
|
-
}
|
|
21484
|
-
|
|
21485
|
-
interface ListTasksRequestHeaders {
|
|
21486
|
-
}
|
|
21487
|
-
interface ListTasksRequestQuery {
|
|
21488
|
-
nextToken?: string;
|
|
21489
|
-
tags?: {
|
|
21490
|
-
[k: string]: string;
|
|
21491
|
-
};
|
|
21492
|
-
conversationId?: string;
|
|
21493
|
-
userId?: string;
|
|
21494
|
-
parentTaskId?: string;
|
|
21495
|
-
status?: ("pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled")[];
|
|
21496
|
-
type?: string;
|
|
21497
|
-
}
|
|
21498
|
-
interface ListTasksRequestParams {
|
|
21499
|
-
}
|
|
21500
|
-
interface ListTasksRequestBody {
|
|
21501
|
-
}
|
|
21502
|
-
type ListTasksInput = ListTasksRequestBody & ListTasksRequestHeaders & ListTasksRequestQuery & ListTasksRequestParams;
|
|
21503
|
-
interface ListTasksResponse {
|
|
21504
|
-
tasks: {
|
|
21505
|
-
/**
|
|
21506
|
-
* Id of the [Task](#schema_task)
|
|
21507
|
-
*/
|
|
21508
|
-
id: string;
|
|
21509
|
-
/**
|
|
21510
|
-
* Title describing the task
|
|
21511
|
-
*/
|
|
21512
|
-
title: string;
|
|
21513
|
-
/**
|
|
21514
|
-
* All the notes related to the execution of the current task
|
|
21515
|
-
*/
|
|
21516
|
-
description: string;
|
|
21517
|
-
/**
|
|
21518
|
-
* Type of the task
|
|
21519
|
-
*/
|
|
21520
|
-
type: string;
|
|
21521
|
-
/**
|
|
21522
|
-
* Content related to the task
|
|
21523
|
-
*/
|
|
21524
|
-
data: {
|
|
21525
|
-
[k: string]: any;
|
|
21526
|
-
};
|
|
21527
|
-
/**
|
|
21528
|
-
* Status of the task
|
|
21529
|
-
*/
|
|
21530
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
21531
|
-
/**
|
|
21532
|
-
* Parent task id is the parent task that created this task
|
|
21533
|
-
*/
|
|
21534
|
-
parentTaskId?: string;
|
|
21535
|
-
/**
|
|
21536
|
-
* Conversation id related to this task
|
|
21537
|
-
*/
|
|
21538
|
-
conversationId?: string;
|
|
21539
|
-
/**
|
|
21540
|
-
* Specific user related to this task
|
|
21541
|
-
*/
|
|
21542
|
-
userId?: string;
|
|
21543
|
-
/**
|
|
21544
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
21545
|
-
*/
|
|
21546
|
-
timeoutAt: string;
|
|
21547
|
-
/**
|
|
21548
|
-
* Creation date of the task in ISO 8601 format
|
|
21549
|
-
*/
|
|
21550
|
-
createdAt: string;
|
|
21551
|
-
/**
|
|
21552
|
-
* Updating date of the task in ISO 8601 format
|
|
21553
|
-
*/
|
|
21554
|
-
updatedAt: string;
|
|
21555
|
-
/**
|
|
21556
|
-
* If the task fails this is the reason behind it
|
|
21557
|
-
*/
|
|
21558
|
-
failureReason?: string;
|
|
21559
|
-
/**
|
|
21560
|
-
* 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.
|
|
21561
|
-
*/
|
|
21562
|
-
tags: {
|
|
21563
|
-
[k: string]: string;
|
|
21564
|
-
};
|
|
21565
|
-
}[];
|
|
21566
|
-
meta: {
|
|
21567
|
-
/**
|
|
21568
|
-
* The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
|
|
21569
|
-
*/
|
|
21570
|
-
nextToken?: string;
|
|
21571
|
-
};
|
|
21572
|
-
}
|
|
21573
|
-
|
|
21574
20776
|
interface CreateWorkflowRequestHeaders {
|
|
21575
20777
|
}
|
|
21576
20778
|
interface CreateWorkflowRequestQuery {
|
|
@@ -22152,6 +21354,10 @@ interface CaptureObservationRequestQuery {
|
|
|
22152
21354
|
interface CaptureObservationRequestParams {
|
|
22153
21355
|
}
|
|
22154
21356
|
interface CaptureObservationRequestBody {
|
|
21357
|
+
/**
|
|
21358
|
+
* Caller-defined identifier for the observation (e.g. llmz context ID). Uniqueness is not enforced nor guaranteed.
|
|
21359
|
+
*/
|
|
21360
|
+
id?: string;
|
|
22155
21361
|
/**
|
|
22156
21362
|
* Name of the observation
|
|
22157
21363
|
*/
|
|
@@ -22460,6 +21666,12 @@ interface ListPublicIntegrationsResponse {
|
|
|
22460
21666
|
*/
|
|
22461
21667
|
interfaces?: string[];
|
|
22462
21668
|
};
|
|
21669
|
+
/**
|
|
21670
|
+
* Optional key-value attributes from the integration definition
|
|
21671
|
+
*/
|
|
21672
|
+
attributes?: {
|
|
21673
|
+
[k: string]: string;
|
|
21674
|
+
};
|
|
22463
21675
|
}[];
|
|
22464
21676
|
meta: {
|
|
22465
21677
|
/**
|
|
@@ -23434,9 +22646,9 @@ interface GetPublicPluginByIdResponse {
|
|
|
23434
22646
|
states: {
|
|
23435
22647
|
[k: string]: {
|
|
23436
22648
|
/**
|
|
23437
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
22649
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
23438
22650
|
*/
|
|
23439
|
-
type: "conversation" | "user" | "bot"
|
|
22651
|
+
type: "conversation" | "user" | "bot";
|
|
23440
22652
|
/**
|
|
23441
22653
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
23442
22654
|
*/
|
|
@@ -23663,9 +22875,9 @@ interface GetDereferencedPublicPluginByIdResponse {
|
|
|
23663
22875
|
states: {
|
|
23664
22876
|
[k: string]: {
|
|
23665
22877
|
/**
|
|
23666
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
22878
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
23667
22879
|
*/
|
|
23668
|
-
type: "conversation" | "user" | "bot"
|
|
22880
|
+
type: "conversation" | "user" | "bot";
|
|
23669
22881
|
/**
|
|
23670
22882
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
23671
22883
|
*/
|
|
@@ -23884,9 +23096,9 @@ interface GetPublicPluginResponse {
|
|
|
23884
23096
|
states: {
|
|
23885
23097
|
[k: string]: {
|
|
23886
23098
|
/**
|
|
23887
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
23099
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
23888
23100
|
*/
|
|
23889
|
-
type: "conversation" | "user" | "bot"
|
|
23101
|
+
type: "conversation" | "user" | "bot";
|
|
23890
23102
|
/**
|
|
23891
23103
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
23892
23104
|
*/
|
|
@@ -24472,9 +23684,9 @@ interface CreateBotRequestBody {
|
|
|
24472
23684
|
states?: {
|
|
24473
23685
|
[k: string]: {
|
|
24474
23686
|
/**
|
|
24475
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
23687
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
24476
23688
|
*/
|
|
24477
|
-
type: "conversation" | "user" | "bot"
|
|
23689
|
+
type: "conversation" | "user" | "bot";
|
|
24478
23690
|
/**
|
|
24479
23691
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
24480
23692
|
*/
|
|
@@ -24910,9 +24122,9 @@ interface CreateBotResponse {
|
|
|
24910
24122
|
states: {
|
|
24911
24123
|
[k: string]: {
|
|
24912
24124
|
/**
|
|
24913
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
24125
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
24914
24126
|
*/
|
|
24915
|
-
type: "conversation" | "user" | "bot"
|
|
24127
|
+
type: "conversation" | "user" | "bot";
|
|
24916
24128
|
/**
|
|
24917
24129
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
24918
24130
|
*/
|
|
@@ -25238,9 +24450,9 @@ interface UpdateBotRequestBody {
|
|
|
25238
24450
|
states?: {
|
|
25239
24451
|
[k: string]: {
|
|
25240
24452
|
/**
|
|
25241
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
24453
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
25242
24454
|
*/
|
|
25243
|
-
type: "conversation" | "user" | "bot"
|
|
24455
|
+
type: "conversation" | "user" | "bot";
|
|
25244
24456
|
/**
|
|
25245
24457
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
25246
24458
|
*/
|
|
@@ -25590,9 +24802,9 @@ interface UpdateBotResponse {
|
|
|
25590
24802
|
states: {
|
|
25591
24803
|
[k: string]: {
|
|
25592
24804
|
/**
|
|
25593
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
24805
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
25594
24806
|
*/
|
|
25595
|
-
type: "conversation" | "user" | "bot"
|
|
24807
|
+
type: "conversation" | "user" | "bot";
|
|
25596
24808
|
/**
|
|
25597
24809
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
25598
24810
|
*/
|
|
@@ -26098,9 +25310,9 @@ interface GetBotResponse {
|
|
|
26098
25310
|
states: {
|
|
26099
25311
|
[k: string]: {
|
|
26100
25312
|
/**
|
|
26101
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
25313
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
26102
25314
|
*/
|
|
26103
|
-
type: "conversation" | "user" | "bot"
|
|
25315
|
+
type: "conversation" | "user" | "bot";
|
|
26104
25316
|
/**
|
|
26105
25317
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
26106
25318
|
*/
|
|
@@ -29824,6 +29036,12 @@ interface ListIntegrationsResponse {
|
|
|
29824
29036
|
handle: string | null;
|
|
29825
29037
|
name: string;
|
|
29826
29038
|
};
|
|
29039
|
+
/**
|
|
29040
|
+
* Optional key-value attributes from the integration definition
|
|
29041
|
+
*/
|
|
29042
|
+
attributes?: {
|
|
29043
|
+
[k: string]: string;
|
|
29044
|
+
};
|
|
29827
29045
|
}[];
|
|
29828
29046
|
meta: {
|
|
29829
29047
|
/**
|
|
@@ -31746,9 +30964,9 @@ interface CreatePluginRequestBody {
|
|
|
31746
30964
|
states?: {
|
|
31747
30965
|
[k: string]: {
|
|
31748
30966
|
/**
|
|
31749
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
30967
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
31750
30968
|
*/
|
|
31751
|
-
type: "conversation" | "user" | "bot"
|
|
30969
|
+
type: "conversation" | "user" | "bot";
|
|
31752
30970
|
/**
|
|
31753
30971
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
31754
30972
|
*/
|
|
@@ -31986,9 +31204,9 @@ interface CreatePluginResponse {
|
|
|
31986
31204
|
states: {
|
|
31987
31205
|
[k: string]: {
|
|
31988
31206
|
/**
|
|
31989
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
31207
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
31990
31208
|
*/
|
|
31991
|
-
type: "conversation" | "user" | "bot"
|
|
31209
|
+
type: "conversation" | "user" | "bot";
|
|
31992
31210
|
/**
|
|
31993
31211
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
31994
31212
|
*/
|
|
@@ -32206,9 +31424,9 @@ interface GetPluginResponse {
|
|
|
32206
31424
|
states: {
|
|
32207
31425
|
[k: string]: {
|
|
32208
31426
|
/**
|
|
32209
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
31427
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
32210
31428
|
*/
|
|
32211
|
-
type: "conversation" | "user" | "bot"
|
|
31429
|
+
type: "conversation" | "user" | "bot";
|
|
32212
31430
|
/**
|
|
32213
31431
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
32214
31432
|
*/
|
|
@@ -32435,9 +31653,9 @@ interface GetDereferencedPluginResponse {
|
|
|
32435
31653
|
states: {
|
|
32436
31654
|
[k: string]: {
|
|
32437
31655
|
/**
|
|
32438
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
31656
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
32439
31657
|
*/
|
|
32440
|
-
type: "conversation" | "user" | "bot"
|
|
31658
|
+
type: "conversation" | "user" | "bot";
|
|
32441
31659
|
/**
|
|
32442
31660
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
32443
31661
|
*/
|
|
@@ -32656,9 +31874,9 @@ interface GetPluginByNameResponse {
|
|
|
32656
31874
|
states: {
|
|
32657
31875
|
[k: string]: {
|
|
32658
31876
|
/**
|
|
32659
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
31877
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
32660
31878
|
*/
|
|
32661
|
-
type: "conversation" | "user" | "bot"
|
|
31879
|
+
type: "conversation" | "user" | "bot";
|
|
32662
31880
|
/**
|
|
32663
31881
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
32664
31882
|
*/
|
|
@@ -32852,9 +32070,9 @@ interface UpdatePluginRequestBody {
|
|
|
32852
32070
|
states?: {
|
|
32853
32071
|
[k: string]: {
|
|
32854
32072
|
/**
|
|
32855
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
32073
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
32856
32074
|
*/
|
|
32857
|
-
type: "conversation" | "user" | "bot"
|
|
32075
|
+
type: "conversation" | "user" | "bot";
|
|
32858
32076
|
/**
|
|
32859
32077
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
32860
32078
|
*/
|
|
@@ -33080,9 +32298,9 @@ interface UpdatePluginResponse {
|
|
|
33080
32298
|
states: {
|
|
33081
32299
|
[k: string]: {
|
|
33082
32300
|
/**
|
|
33083
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
32301
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
33084
32302
|
*/
|
|
33085
|
-
type: "conversation" | "user" | "bot"
|
|
32303
|
+
type: "conversation" | "user" | "bot";
|
|
33086
32304
|
/**
|
|
33087
32305
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
33088
32306
|
*/
|
|
@@ -36575,9 +35793,9 @@ interface Bot {
|
|
|
36575
35793
|
states: {
|
|
36576
35794
|
[k: string]: {
|
|
36577
35795
|
/**
|
|
36578
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
35796
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
36579
35797
|
*/
|
|
36580
|
-
type: "conversation" | "user" | "bot"
|
|
35798
|
+
type: "conversation" | "user" | "bot";
|
|
36581
35799
|
/**
|
|
36582
35800
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
36583
35801
|
*/
|
|
@@ -37343,9 +36561,9 @@ interface Plugin {
|
|
|
37343
36561
|
states: {
|
|
37344
36562
|
[k: string]: {
|
|
37345
36563
|
/**
|
|
37346
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
36564
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
37347
36565
|
*/
|
|
37348
|
-
type: "conversation" | "user" | "bot"
|
|
36566
|
+
type: "conversation" | "user" | "bot";
|
|
37349
36567
|
/**
|
|
37350
36568
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
37351
36569
|
*/
|
|
@@ -37660,7 +36878,8 @@ interface Conversation {
|
|
|
37660
36878
|
*/
|
|
37661
36879
|
id: string;
|
|
37662
36880
|
/**
|
|
37663
|
-
*
|
|
36881
|
+
* @deprecated
|
|
36882
|
+
* Unused. This field will be removed in the future.
|
|
37664
36883
|
*/
|
|
37665
36884
|
currentTaskId?: string;
|
|
37666
36885
|
/**
|
|
@@ -37812,9 +37031,9 @@ interface State {
|
|
|
37812
37031
|
*/
|
|
37813
37032
|
name: string;
|
|
37814
37033
|
/**
|
|
37815
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
37034
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
37816
37035
|
*/
|
|
37817
|
-
type: "conversation" | "user" | "bot" | "
|
|
37036
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
37818
37037
|
/**
|
|
37819
37038
|
* Payload is the content of the state defined by your bot.
|
|
37820
37039
|
*/
|
|
@@ -37822,71 +37041,6 @@ interface State {
|
|
|
37822
37041
|
[k: string]: any;
|
|
37823
37042
|
};
|
|
37824
37043
|
}
|
|
37825
|
-
/**
|
|
37826
|
-
* Task definition
|
|
37827
|
-
*/
|
|
37828
|
-
interface Task {
|
|
37829
|
-
/**
|
|
37830
|
-
* Id of the [Task](#schema_task)
|
|
37831
|
-
*/
|
|
37832
|
-
id: string;
|
|
37833
|
-
/**
|
|
37834
|
-
* Title describing the task
|
|
37835
|
-
*/
|
|
37836
|
-
title: string;
|
|
37837
|
-
/**
|
|
37838
|
-
* All the notes related to the execution of the current task
|
|
37839
|
-
*/
|
|
37840
|
-
description: string;
|
|
37841
|
-
/**
|
|
37842
|
-
* Type of the task
|
|
37843
|
-
*/
|
|
37844
|
-
type: string;
|
|
37845
|
-
/**
|
|
37846
|
-
* Content related to the task
|
|
37847
|
-
*/
|
|
37848
|
-
data: {
|
|
37849
|
-
[k: string]: any;
|
|
37850
|
-
};
|
|
37851
|
-
/**
|
|
37852
|
-
* Status of the task
|
|
37853
|
-
*/
|
|
37854
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
37855
|
-
/**
|
|
37856
|
-
* Parent task id is the parent task that created this task
|
|
37857
|
-
*/
|
|
37858
|
-
parentTaskId?: string;
|
|
37859
|
-
/**
|
|
37860
|
-
* Conversation id related to this task
|
|
37861
|
-
*/
|
|
37862
|
-
conversationId?: string;
|
|
37863
|
-
/**
|
|
37864
|
-
* Specific user related to this task
|
|
37865
|
-
*/
|
|
37866
|
-
userId?: string;
|
|
37867
|
-
/**
|
|
37868
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
37869
|
-
*/
|
|
37870
|
-
timeoutAt: string;
|
|
37871
|
-
/**
|
|
37872
|
-
* Creation date of the task in ISO 8601 format
|
|
37873
|
-
*/
|
|
37874
|
-
createdAt: string;
|
|
37875
|
-
/**
|
|
37876
|
-
* Updating date of the task in ISO 8601 format
|
|
37877
|
-
*/
|
|
37878
|
-
updatedAt: string;
|
|
37879
|
-
/**
|
|
37880
|
-
* If the task fails this is the reason behind it
|
|
37881
|
-
*/
|
|
37882
|
-
failureReason?: string;
|
|
37883
|
-
/**
|
|
37884
|
-
* 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.
|
|
37885
|
-
*/
|
|
37886
|
-
tags: {
|
|
37887
|
-
[k: string]: string;
|
|
37888
|
-
};
|
|
37889
|
-
}
|
|
37890
37044
|
/**
|
|
37891
37045
|
* Workflow definition
|
|
37892
37046
|
*/
|
|
@@ -38308,11 +37462,6 @@ declare class Client$1 {
|
|
|
38308
37462
|
readonly patchState: (input: PatchStateInput) => Promise<PatchStateResponse>;
|
|
38309
37463
|
readonly callAction: (input: CallActionInput) => Promise<CallActionResponse>;
|
|
38310
37464
|
readonly configureIntegration: (input: ConfigureIntegrationInput) => Promise<ConfigureIntegrationResponse>;
|
|
38311
|
-
readonly getTask: (input: GetTaskInput) => Promise<GetTaskResponse>;
|
|
38312
|
-
readonly createTask: (input: CreateTaskInput) => Promise<CreateTaskResponse>;
|
|
38313
|
-
readonly updateTask: (input: UpdateTaskInput) => Promise<UpdateTaskResponse>;
|
|
38314
|
-
readonly deleteTask: (input: DeleteTaskInput) => Promise<DeleteTaskResponse>;
|
|
38315
|
-
readonly listTasks: (input: ListTasksInput) => Promise<ListTasksResponse>;
|
|
38316
37465
|
readonly createWorkflow: (input: CreateWorkflowInput) => Promise<CreateWorkflowResponse>;
|
|
38317
37466
|
readonly getWorkflow: (input: GetWorkflowInput) => Promise<GetWorkflowResponse>;
|
|
38318
37467
|
readonly updateWorkflow: (input: UpdateWorkflowInput) => Promise<UpdateWorkflowResponse>;
|
|
@@ -38588,35 +37737,6 @@ declare class Client extends Client$1 implements IClient {
|
|
|
38588
37737
|
[k: string]: string;
|
|
38589
37738
|
};
|
|
38590
37739
|
}>;
|
|
38591
|
-
tasks: (props: {
|
|
38592
|
-
status?: ("timeout" | "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "cancelled")[] | undefined;
|
|
38593
|
-
tags?: {
|
|
38594
|
-
[x: string]: string;
|
|
38595
|
-
} | undefined;
|
|
38596
|
-
type?: string | undefined;
|
|
38597
|
-
userId?: string | undefined;
|
|
38598
|
-
conversationId?: string | undefined;
|
|
38599
|
-
parentTaskId?: string | undefined;
|
|
38600
|
-
}) => AsyncCollection<{
|
|
38601
|
-
id: string;
|
|
38602
|
-
title: string;
|
|
38603
|
-
description: string;
|
|
38604
|
-
type: string;
|
|
38605
|
-
data: {
|
|
38606
|
-
[k: string]: any;
|
|
38607
|
-
};
|
|
38608
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
38609
|
-
parentTaskId?: string;
|
|
38610
|
-
conversationId?: string;
|
|
38611
|
-
userId?: string;
|
|
38612
|
-
timeoutAt: string;
|
|
38613
|
-
createdAt: string;
|
|
38614
|
-
updatedAt: string;
|
|
38615
|
-
failureReason?: string;
|
|
38616
|
-
tags: {
|
|
38617
|
-
[k: string]: string;
|
|
38618
|
-
};
|
|
38619
|
-
}>;
|
|
38620
37740
|
publicIntegrations: (props: {
|
|
38621
37741
|
search?: string | undefined;
|
|
38622
37742
|
name?: string | undefined;
|
|
@@ -38657,6 +37777,9 @@ declare class Client extends Client$1 implements IClient {
|
|
|
38657
37777
|
actions?: string[];
|
|
38658
37778
|
interfaces?: string[];
|
|
38659
37779
|
};
|
|
37780
|
+
attributes?: {
|
|
37781
|
+
[k: string]: string;
|
|
37782
|
+
};
|
|
38660
37783
|
}>;
|
|
38661
37784
|
bots: (props: {
|
|
38662
37785
|
tags?: {
|
|
@@ -38740,6 +37863,9 @@ declare class Client extends Client$1 implements IClient {
|
|
|
38740
37863
|
handle: string | null;
|
|
38741
37864
|
name: string;
|
|
38742
37865
|
};
|
|
37866
|
+
attributes?: {
|
|
37867
|
+
[k: string]: string;
|
|
37868
|
+
};
|
|
38743
37869
|
}>;
|
|
38744
37870
|
interfaces: (props: {
|
|
38745
37871
|
name?: string | undefined;
|
|
@@ -38917,7 +38043,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
38917
38043
|
conversationId?: string | undefined;
|
|
38918
38044
|
name?: string | undefined;
|
|
38919
38045
|
parentWorkflowId?: string | undefined;
|
|
38920
|
-
statuses?: ("pending" | "failed" | "in_progress" | "
|
|
38046
|
+
statuses?: ("pending" | "failed" | "in_progress" | "listening" | "completed" | "paused" | "timedout" | "cancelled")[] | undefined;
|
|
38921
38047
|
}) => AsyncCollection<{
|
|
38922
38048
|
id: string;
|
|
38923
38049
|
name: string;
|
|
@@ -39182,4 +38308,4 @@ declare class UploadFileError extends Error {
|
|
|
39182
38308
|
constructor(message: string, innerError?: AxiosError | undefined, file?: UpsertFileResponse["file"] | undefined);
|
|
39183
38309
|
}
|
|
39184
38310
|
|
|
39185
|
-
export { type Account, type Activity, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientProps, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type Headers, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, OperationTimeoutError, PayloadTooLargeError, PaymentRequiredError, type Plugin, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceGoneError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table,
|
|
38311
|
+
export { type Account, type Activity, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientProps, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type Headers, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, OperationTimeoutError, PayloadTooLargeError, PaymentRequiredError, type Plugin, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceGoneError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Version, type Workflow, type Workspace, type WorkspaceMember, index$3 as admin, index$2 as billing, errorFrom, index$1 as files, isApiError, index$4 as runtime, index as tables };
|