@botpress/client 1.34.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/index.d.ts CHANGED
@@ -108,7 +108,8 @@ interface CreateConversationResponse$1 {
108
108
  */
109
109
  id: string;
110
110
  /**
111
- * Id of the current [Task](#schema_task)
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
- * Id of the current [Task](#schema_task)
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
- * Id of the current [Task](#schema_task)
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
- * Id of the current [Task](#schema_task)
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
- * Id of the current [Task](#schema_task)
365
+ * @deprecated
366
+ * Unused. This field will be removed in the future.
358
367
  */
359
368
  currentTaskId?: string;
360
369
  /**
@@ -438,6 +447,12 @@ interface ListParticipantsResponse$1 {
438
447
  * Picture URL of the [User](#schema_user)
439
448
  */
440
449
  pictureUrl?: string;
450
+ /**
451
+ * Optional attributes
452
+ */
453
+ attributes?: {
454
+ [k: string]: string;
455
+ };
441
456
  }[];
442
457
  meta: {
443
458
  /**
@@ -492,6 +507,12 @@ interface AddParticipantResponse$1 {
492
507
  * Picture URL of the [User](#schema_user)
493
508
  */
494
509
  pictureUrl?: string;
510
+ /**
511
+ * Optional attributes
512
+ */
513
+ attributes?: {
514
+ [k: string]: string;
515
+ };
495
516
  };
496
517
  }
497
518
 
@@ -537,6 +558,12 @@ interface GetParticipantResponse$1 {
537
558
  * Picture URL of the [User](#schema_user)
538
559
  */
539
560
  pictureUrl?: string;
561
+ /**
562
+ * Optional attributes
563
+ */
564
+ attributes?: {
565
+ [k: string]: string;
566
+ };
540
567
  };
541
568
  }
542
569
 
@@ -1223,6 +1250,12 @@ interface InitializeIncomingMessageRequestBody$1 {
1223
1250
  * URI of the user picture
1224
1251
  */
1225
1252
  pictureUrl?: string;
1253
+ /**
1254
+ * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
1255
+ */
1256
+ attributes?: {
1257
+ [k: string]: string;
1258
+ };
1226
1259
  /**
1227
1260
  * Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
1228
1261
  */
@@ -1306,6 +1339,12 @@ interface InitializeIncomingMessageResponse$1 {
1306
1339
  * Picture URL of the [User](#schema_user)
1307
1340
  */
1308
1341
  pictureUrl?: string;
1342
+ /**
1343
+ * Optional attributes
1344
+ */
1345
+ attributes?: {
1346
+ [k: string]: string;
1347
+ };
1309
1348
  };
1310
1349
  /**
1311
1350
  * The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
@@ -1316,7 +1355,8 @@ interface InitializeIncomingMessageResponse$1 {
1316
1355
  */
1317
1356
  id: string;
1318
1357
  /**
1319
- * Id of the current [Task](#schema_task)
1358
+ * @deprecated
1359
+ * Unused. This field will be removed in the future.
1320
1360
  */
1321
1361
  currentTaskId?: string;
1322
1362
  /**
@@ -1518,6 +1558,12 @@ interface CreateUserRequestBody$1 {
1518
1558
  * URI of the user picture
1519
1559
  */
1520
1560
  pictureUrl?: string;
1561
+ /**
1562
+ * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
1563
+ */
1564
+ attributes?: {
1565
+ [k: string]: string;
1566
+ };
1521
1567
  }
1522
1568
  type CreateUserInput$1 = CreateUserRequestBody$1 & CreateUserRequestHeaders$1 & CreateUserRequestQuery$1 & CreateUserRequestParams$1;
1523
1569
  interface CreateUserResponse$1 {
@@ -1551,6 +1597,12 @@ interface CreateUserResponse$1 {
1551
1597
  * Picture URL of the [User](#schema_user)
1552
1598
  */
1553
1599
  pictureUrl?: string;
1600
+ /**
1601
+ * Optional attributes
1602
+ */
1603
+ attributes?: {
1604
+ [k: string]: string;
1605
+ };
1554
1606
  };
1555
1607
  }
1556
1608
 
@@ -1595,6 +1647,12 @@ interface GetUserResponse$1 {
1595
1647
  * Picture URL of the [User](#schema_user)
1596
1648
  */
1597
1649
  pictureUrl?: string;
1650
+ /**
1651
+ * Optional attributes
1652
+ */
1653
+ attributes?: {
1654
+ [k: string]: string;
1655
+ };
1598
1656
  };
1599
1657
  }
1600
1658
 
@@ -1645,6 +1703,12 @@ interface ListUsersResponse$1 {
1645
1703
  * Picture URL of the [User](#schema_user)
1646
1704
  */
1647
1705
  pictureUrl?: string;
1706
+ /**
1707
+ * Optional attributes
1708
+ */
1709
+ attributes?: {
1710
+ [k: string]: string;
1711
+ };
1648
1712
  }[];
1649
1713
  meta: {
1650
1714
  /**
@@ -1680,6 +1744,12 @@ interface GetOrCreateUserRequestBody$1 {
1680
1744
  * URI of the user picture
1681
1745
  */
1682
1746
  pictureUrl?: string;
1747
+ /**
1748
+ * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
1749
+ */
1750
+ attributes?: {
1751
+ [k: string]: string;
1752
+ };
1683
1753
  /**
1684
1754
  * Optional list of tag names to use for strict matching when looking up existing users. If provided, all specified tags must match exactly for a user to be considered a match. For example, with an existing user whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
1685
1755
  */
@@ -1717,6 +1787,12 @@ interface GetOrCreateUserResponse$1 {
1717
1787
  * Picture URL of the [User](#schema_user)
1718
1788
  */
1719
1789
  pictureUrl?: string;
1790
+ /**
1791
+ * Optional attributes
1792
+ */
1793
+ attributes?: {
1794
+ [k: string]: string;
1795
+ };
1720
1796
  };
1721
1797
  }
1722
1798
 
@@ -1742,6 +1818,12 @@ interface UpdateUserRequestBody$1 {
1742
1818
  * URI of the user picture
1743
1819
  */
1744
1820
  pictureUrl?: string | null;
1821
+ /**
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.
1823
+ */
1824
+ attributes?: {
1825
+ [k: string]: string | null;
1826
+ };
1745
1827
  }
1746
1828
  type UpdateUserInput$1 = UpdateUserRequestBody$1 & UpdateUserRequestHeaders$1 & UpdateUserRequestQuery$1 & UpdateUserRequestParams$1;
1747
1829
  interface UpdateUserResponse$1 {
@@ -1775,6 +1857,12 @@ interface UpdateUserResponse$1 {
1775
1857
  * Picture URL of the [User](#schema_user)
1776
1858
  */
1777
1859
  pictureUrl?: string;
1860
+ /**
1861
+ * Optional attributes
1862
+ */
1863
+ attributes?: {
1864
+ [k: string]: string;
1865
+ };
1778
1866
  };
1779
1867
  }
1780
1868
 
@@ -1796,7 +1884,7 @@ interface SetStateExpiryRequestHeaders$1 {
1796
1884
  interface SetStateExpiryRequestQuery$1 {
1797
1885
  }
1798
1886
  interface SetStateExpiryRequestParams$1 {
1799
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
1887
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
1800
1888
  id: string;
1801
1889
  name: string;
1802
1890
  }
@@ -1841,9 +1929,9 @@ interface SetStateExpiryResponse$1 {
1841
1929
  */
1842
1930
  name: string;
1843
1931
  /**
1844
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
1932
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
1845
1933
  */
1846
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
1934
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
1847
1935
  /**
1848
1936
  * Payload is the content of the state defined by your bot.
1849
1937
  */
@@ -1858,7 +1946,7 @@ interface GetStateRequestHeaders$1 {
1858
1946
  interface GetStateRequestQuery$1 {
1859
1947
  }
1860
1948
  interface GetStateRequestParams$1 {
1861
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
1949
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
1862
1950
  id: string;
1863
1951
  name: string;
1864
1952
  }
@@ -1899,9 +1987,9 @@ interface GetStateResponse$1 {
1899
1987
  */
1900
1988
  name: string;
1901
1989
  /**
1902
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
1990
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
1903
1991
  */
1904
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
1992
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
1905
1993
  /**
1906
1994
  * Payload is the content of the state defined by your bot.
1907
1995
  */
@@ -1919,7 +2007,7 @@ interface SetStateRequestHeaders$1 {
1919
2007
  interface SetStateRequestQuery$1 {
1920
2008
  }
1921
2009
  interface SetStateRequestParams$1 {
1922
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
2010
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
1923
2011
  id: string;
1924
2012
  name: string;
1925
2013
  }
@@ -1970,9 +2058,9 @@ interface SetStateResponse$1 {
1970
2058
  */
1971
2059
  name: string;
1972
2060
  /**
1973
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
2061
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
1974
2062
  */
1975
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
2063
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
1976
2064
  /**
1977
2065
  * Payload is the content of the state defined by your bot.
1978
2066
  */
@@ -1987,7 +2075,7 @@ interface GetOrSetStateRequestHeaders$1 {
1987
2075
  interface GetOrSetStateRequestQuery$1 {
1988
2076
  }
1989
2077
  interface GetOrSetStateRequestParams$1 {
1990
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
2078
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
1991
2079
  id: string;
1992
2080
  name: string;
1993
2081
  }
@@ -2038,9 +2126,9 @@ interface GetOrSetStateResponse$1 {
2038
2126
  */
2039
2127
  name: string;
2040
2128
  /**
2041
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
2129
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
2042
2130
  */
2043
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
2131
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
2044
2132
  /**
2045
2133
  * Payload is the content of the state defined by your bot.
2046
2134
  */
@@ -2058,7 +2146,7 @@ interface PatchStateRequestHeaders$1 {
2058
2146
  interface PatchStateRequestQuery$1 {
2059
2147
  }
2060
2148
  interface PatchStateRequestParams$1 {
2061
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
2149
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
2062
2150
  id: string;
2063
2151
  name: string;
2064
2152
  }
@@ -2105,9 +2193,9 @@ interface PatchStateResponse$1 {
2105
2193
  */
2106
2194
  name: string;
2107
2195
  /**
2108
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
2196
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
2109
2197
  */
2110
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
2198
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
2111
2199
  /**
2112
2200
  * Payload is the content of the state defined by your bot.
2113
2201
  */
@@ -2172,409 +2260,6 @@ type ConfigureIntegrationInput$1 = ConfigureIntegrationRequestBody$1 & Configure
2172
2260
  interface ConfigureIntegrationResponse$1 {
2173
2261
  }
2174
2262
 
2175
- interface GetTaskRequestHeaders$1 {
2176
- }
2177
- interface GetTaskRequestQuery$1 {
2178
- }
2179
- interface GetTaskRequestParams$1 {
2180
- id: string;
2181
- }
2182
- interface GetTaskRequestBody$1 {
2183
- }
2184
- type GetTaskInput$1 = GetTaskRequestBody$1 & GetTaskRequestHeaders$1 & GetTaskRequestQuery$1 & GetTaskRequestParams$1;
2185
- interface GetTaskResponse$1 {
2186
- /**
2187
- * Task definition
2188
- */
2189
- task: {
2190
- /**
2191
- * Id of the [Task](#schema_task)
2192
- */
2193
- id: string;
2194
- /**
2195
- * Title describing the task
2196
- */
2197
- title: string;
2198
- /**
2199
- * All the notes related to the execution of the current task
2200
- */
2201
- description: string;
2202
- /**
2203
- * Type of the task
2204
- */
2205
- type: string;
2206
- /**
2207
- * Content related to the task
2208
- */
2209
- data: {
2210
- [k: string]: any;
2211
- };
2212
- /**
2213
- * Status of the task
2214
- */
2215
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
2216
- /**
2217
- * Parent task id is the parent task that created this task
2218
- */
2219
- parentTaskId?: string;
2220
- /**
2221
- * Conversation id related to this task
2222
- */
2223
- conversationId?: string;
2224
- /**
2225
- * Specific user related to this task
2226
- */
2227
- userId?: string;
2228
- /**
2229
- * The timeout date where the task should be failed in the ISO 8601 format
2230
- */
2231
- timeoutAt: string;
2232
- /**
2233
- * Creation date of the task in ISO 8601 format
2234
- */
2235
- createdAt: string;
2236
- /**
2237
- * Updating date of the task in ISO 8601 format
2238
- */
2239
- updatedAt: string;
2240
- /**
2241
- * If the task fails this is the reason behind it
2242
- */
2243
- failureReason?: string;
2244
- /**
2245
- * 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.
2246
- */
2247
- tags: {
2248
- [k: string]: string;
2249
- };
2250
- };
2251
- }
2252
-
2253
- interface CreateTaskRequestHeaders$1 {
2254
- }
2255
- interface CreateTaskRequestQuery$1 {
2256
- }
2257
- interface CreateTaskRequestParams$1 {
2258
- }
2259
- interface CreateTaskRequestBody$1 {
2260
- /**
2261
- * Title describing the task
2262
- */
2263
- title?: string;
2264
- /**
2265
- * All the notes related to the execution of the current task
2266
- */
2267
- description?: string;
2268
- /**
2269
- * Type of the task
2270
- */
2271
- type: string;
2272
- /**
2273
- * Content related to the task
2274
- */
2275
- data?: {
2276
- [k: string]: any;
2277
- };
2278
- /**
2279
- * Parent task id is the parent task that created this task
2280
- */
2281
- parentTaskId?: string;
2282
- /**
2283
- * Conversation id related to this task
2284
- */
2285
- conversationId: string;
2286
- /**
2287
- * Specific user related to this task
2288
- */
2289
- userId?: string;
2290
- /**
2291
- * The timeout date where the task should be failed in the ISO 8601 format
2292
- */
2293
- timeoutAt?: string;
2294
- /**
2295
- * Tags for the [Task](#schema_task)
2296
- */
2297
- tags?: {
2298
- [k: string]: string;
2299
- };
2300
- }
2301
- type CreateTaskInput$1 = CreateTaskRequestBody$1 & CreateTaskRequestHeaders$1 & CreateTaskRequestQuery$1 & CreateTaskRequestParams$1;
2302
- interface CreateTaskResponse$1 {
2303
- /**
2304
- * Task definition
2305
- */
2306
- task: {
2307
- /**
2308
- * Id of the [Task](#schema_task)
2309
- */
2310
- id: string;
2311
- /**
2312
- * Title describing the task
2313
- */
2314
- title: string;
2315
- /**
2316
- * All the notes related to the execution of the current task
2317
- */
2318
- description: string;
2319
- /**
2320
- * Type of the task
2321
- */
2322
- type: string;
2323
- /**
2324
- * Content related to the task
2325
- */
2326
- data: {
2327
- [k: string]: any;
2328
- };
2329
- /**
2330
- * Status of the task
2331
- */
2332
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
2333
- /**
2334
- * Parent task id is the parent task that created this task
2335
- */
2336
- parentTaskId?: string;
2337
- /**
2338
- * Conversation id related to this task
2339
- */
2340
- conversationId?: string;
2341
- /**
2342
- * Specific user related to this task
2343
- */
2344
- userId?: string;
2345
- /**
2346
- * The timeout date where the task should be failed in the ISO 8601 format
2347
- */
2348
- timeoutAt: string;
2349
- /**
2350
- * Creation date of the task in ISO 8601 format
2351
- */
2352
- createdAt: string;
2353
- /**
2354
- * Updating date of the task in ISO 8601 format
2355
- */
2356
- updatedAt: string;
2357
- /**
2358
- * If the task fails this is the reason behind it
2359
- */
2360
- failureReason?: string;
2361
- /**
2362
- * 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.
2363
- */
2364
- tags: {
2365
- [k: string]: string;
2366
- };
2367
- };
2368
- }
2369
-
2370
- interface UpdateTaskRequestHeaders$1 {
2371
- }
2372
- interface UpdateTaskRequestQuery$1 {
2373
- }
2374
- interface UpdateTaskRequestParams$1 {
2375
- id: string;
2376
- }
2377
- interface UpdateTaskRequestBody$1 {
2378
- /**
2379
- * Title describing the task
2380
- */
2381
- title?: string;
2382
- /**
2383
- * All the notes related to the execution of the current task
2384
- */
2385
- description?: string;
2386
- /**
2387
- * Content related to the task
2388
- */
2389
- data?: {
2390
- [k: string]: any;
2391
- };
2392
- /**
2393
- * The timeout date where the task should be failed in the ISO 8601 format
2394
- */
2395
- timeoutAt?: string;
2396
- /**
2397
- * Status of the task
2398
- */
2399
- status?: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
2400
- /**
2401
- * Tags for the [Task](#schema_task)
2402
- */
2403
- tags?: {
2404
- [k: string]: string;
2405
- };
2406
- }
2407
- type UpdateTaskInput$1 = UpdateTaskRequestBody$1 & UpdateTaskRequestHeaders$1 & UpdateTaskRequestQuery$1 & UpdateTaskRequestParams$1;
2408
- interface UpdateTaskResponse$1 {
2409
- /**
2410
- * Task definition
2411
- */
2412
- task: {
2413
- /**
2414
- * Id of the [Task](#schema_task)
2415
- */
2416
- id: string;
2417
- /**
2418
- * Title describing the task
2419
- */
2420
- title: string;
2421
- /**
2422
- * All the notes related to the execution of the current task
2423
- */
2424
- description: string;
2425
- /**
2426
- * Type of the task
2427
- */
2428
- type: string;
2429
- /**
2430
- * Content related to the task
2431
- */
2432
- data: {
2433
- [k: string]: any;
2434
- };
2435
- /**
2436
- * Status of the task
2437
- */
2438
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
2439
- /**
2440
- * Parent task id is the parent task that created this task
2441
- */
2442
- parentTaskId?: string;
2443
- /**
2444
- * Conversation id related to this task
2445
- */
2446
- conversationId?: string;
2447
- /**
2448
- * Specific user related to this task
2449
- */
2450
- userId?: string;
2451
- /**
2452
- * The timeout date where the task should be failed in the ISO 8601 format
2453
- */
2454
- timeoutAt: string;
2455
- /**
2456
- * Creation date of the task in ISO 8601 format
2457
- */
2458
- createdAt: string;
2459
- /**
2460
- * Updating date of the task in ISO 8601 format
2461
- */
2462
- updatedAt: string;
2463
- /**
2464
- * If the task fails this is the reason behind it
2465
- */
2466
- failureReason?: string;
2467
- /**
2468
- * 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.
2469
- */
2470
- tags: {
2471
- [k: string]: string;
2472
- };
2473
- };
2474
- }
2475
-
2476
- interface DeleteTaskRequestHeaders$1 {
2477
- }
2478
- interface DeleteTaskRequestQuery$1 {
2479
- }
2480
- interface DeleteTaskRequestParams$1 {
2481
- id: string;
2482
- }
2483
- interface DeleteTaskRequestBody$1 {
2484
- }
2485
- type DeleteTaskInput$1 = DeleteTaskRequestBody$1 & DeleteTaskRequestHeaders$1 & DeleteTaskRequestQuery$1 & DeleteTaskRequestParams$1;
2486
- interface DeleteTaskResponse$1 {
2487
- }
2488
-
2489
- interface ListTasksRequestHeaders$1 {
2490
- }
2491
- interface ListTasksRequestQuery$1 {
2492
- nextToken?: string;
2493
- tags?: {
2494
- [k: string]: string;
2495
- };
2496
- conversationId?: string;
2497
- userId?: string;
2498
- parentTaskId?: string;
2499
- status?: ("pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled")[];
2500
- type?: string;
2501
- }
2502
- interface ListTasksRequestParams$1 {
2503
- }
2504
- interface ListTasksRequestBody$1 {
2505
- }
2506
- type ListTasksInput$1 = ListTasksRequestBody$1 & ListTasksRequestHeaders$1 & ListTasksRequestQuery$1 & ListTasksRequestParams$1;
2507
- interface ListTasksResponse$1 {
2508
- tasks: {
2509
- /**
2510
- * Id of the [Task](#schema_task)
2511
- */
2512
- id: string;
2513
- /**
2514
- * Title describing the task
2515
- */
2516
- title: string;
2517
- /**
2518
- * All the notes related to the execution of the current task
2519
- */
2520
- description: string;
2521
- /**
2522
- * Type of the task
2523
- */
2524
- type: string;
2525
- /**
2526
- * Content related to the task
2527
- */
2528
- data: {
2529
- [k: string]: any;
2530
- };
2531
- /**
2532
- * Status of the task
2533
- */
2534
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
2535
- /**
2536
- * Parent task id is the parent task that created this task
2537
- */
2538
- parentTaskId?: string;
2539
- /**
2540
- * Conversation id related to this task
2541
- */
2542
- conversationId?: string;
2543
- /**
2544
- * Specific user related to this task
2545
- */
2546
- userId?: string;
2547
- /**
2548
- * The timeout date where the task should be failed in the ISO 8601 format
2549
- */
2550
- timeoutAt: string;
2551
- /**
2552
- * Creation date of the task in ISO 8601 format
2553
- */
2554
- createdAt: string;
2555
- /**
2556
- * Updating date of the task in ISO 8601 format
2557
- */
2558
- updatedAt: string;
2559
- /**
2560
- * If the task fails this is the reason behind it
2561
- */
2562
- failureReason?: string;
2563
- /**
2564
- * 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.
2565
- */
2566
- tags: {
2567
- [k: string]: string;
2568
- };
2569
- }[];
2570
- meta: {
2571
- /**
2572
- * 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.
2573
- */
2574
- nextToken?: string;
2575
- };
2576
- }
2577
-
2578
2263
  interface CreateWorkflowRequestHeaders$1 {
2579
2264
  }
2580
2265
  interface CreateWorkflowRequestQuery$1 {
@@ -3156,6 +2841,10 @@ interface CaptureObservationRequestQuery$1 {
3156
2841
  interface CaptureObservationRequestParams$1 {
3157
2842
  }
3158
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;
3159
2848
  /**
3160
2849
  * Name of the observation
3161
2850
  */
@@ -3238,11 +2927,6 @@ declare class Client$b {
3238
2927
  readonly patchState: (input: PatchStateInput$1) => Promise<PatchStateResponse$1>;
3239
2928
  readonly callAction: (input: CallActionInput$1) => Promise<CallActionResponse$1>;
3240
2929
  readonly configureIntegration: (input: ConfigureIntegrationInput$1) => Promise<ConfigureIntegrationResponse$1>;
3241
- readonly getTask: (input: GetTaskInput$1) => Promise<GetTaskResponse$1>;
3242
- readonly createTask: (input: CreateTaskInput$1) => Promise<CreateTaskResponse$1>;
3243
- readonly updateTask: (input: UpdateTaskInput$1) => Promise<UpdateTaskResponse$1>;
3244
- readonly deleteTask: (input: DeleteTaskInput$1) => Promise<DeleteTaskResponse$1>;
3245
- readonly listTasks: (input: ListTasksInput$1) => Promise<ListTasksResponse$1>;
3246
2930
  readonly createWorkflow: (input: CreateWorkflowInput$1) => Promise<CreateWorkflowResponse$1>;
3247
2931
  readonly getWorkflow: (input: GetWorkflowInput$1) => Promise<GetWorkflowResponse$1>;
3248
2932
  readonly updateWorkflow: (input: UpdateWorkflowInput$1) => Promise<UpdateWorkflowResponse$1>;
@@ -3303,6 +2987,9 @@ declare class Client$a extends Client$b {
3303
2987
  };
3304
2988
  name?: string;
3305
2989
  pictureUrl?: string;
2990
+ attributes?: {
2991
+ [k: string]: string;
2992
+ };
3306
2993
  }>;
3307
2994
  events: (props: {
3308
2995
  status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
@@ -3366,33 +3053,7 @@ declare class Client$a extends Client$b {
3366
3053
  };
3367
3054
  name?: string;
3368
3055
  pictureUrl?: string;
3369
- }>;
3370
- tasks: (props: {
3371
- status?: ("timeout" | "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "cancelled")[] | undefined;
3372
- tags?: {
3373
- [x: string]: string;
3374
- } | undefined;
3375
- type?: string | undefined;
3376
- userId?: string | undefined;
3377
- conversationId?: string | undefined;
3378
- parentTaskId?: string | undefined;
3379
- }) => AsyncCollection<{
3380
- id: string;
3381
- title: string;
3382
- description: string;
3383
- type: string;
3384
- data: {
3385
- [k: string]: any;
3386
- };
3387
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
3388
- parentTaskId?: string;
3389
- conversationId?: string;
3390
- userId?: string;
3391
- timeoutAt: string;
3392
- createdAt: string;
3393
- updatedAt: string;
3394
- failureReason?: string;
3395
- tags: {
3056
+ attributes?: {
3396
3057
  [k: string]: string;
3397
3058
  };
3398
3059
  }>;
@@ -3688,6 +3349,12 @@ interface ListPublicIntegrationsResponse$1 {
3688
3349
  */
3689
3350
  interfaces?: string[];
3690
3351
  };
3352
+ /**
3353
+ * Optional key-value attributes from the integration definition
3354
+ */
3355
+ attributes?: {
3356
+ [k: string]: string;
3357
+ };
3691
3358
  }[];
3692
3359
  meta: {
3693
3360
  /**
@@ -4662,9 +4329,9 @@ interface GetPublicPluginByIdResponse$1 {
4662
4329
  states: {
4663
4330
  [k: string]: {
4664
4331
  /**
4665
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
4332
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
4666
4333
  */
4667
- type: "conversation" | "user" | "bot" | "task";
4334
+ type: "conversation" | "user" | "bot";
4668
4335
  /**
4669
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.
4670
4337
  */
@@ -4891,9 +4558,9 @@ interface GetDereferencedPublicPluginByIdResponse$1 {
4891
4558
  states: {
4892
4559
  [k: string]: {
4893
4560
  /**
4894
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
4561
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
4895
4562
  */
4896
- type: "conversation" | "user" | "bot" | "task";
4563
+ type: "conversation" | "user" | "bot";
4897
4564
  /**
4898
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.
4899
4566
  */
@@ -5112,9 +4779,9 @@ interface GetPublicPluginResponse$1 {
5112
4779
  states: {
5113
4780
  [k: string]: {
5114
4781
  /**
5115
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
4782
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
5116
4783
  */
5117
- type: "conversation" | "user" | "bot" | "task";
4784
+ type: "conversation" | "user" | "bot";
5118
4785
  /**
5119
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.
5120
4787
  */
@@ -5700,9 +5367,9 @@ interface CreateBotRequestBody$1 {
5700
5367
  states?: {
5701
5368
  [k: string]: {
5702
5369
  /**
5703
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
5370
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
5704
5371
  */
5705
- type: "conversation" | "user" | "bot" | "task";
5372
+ type: "conversation" | "user" | "bot";
5706
5373
  /**
5707
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.
5708
5375
  */
@@ -6138,9 +5805,9 @@ interface CreateBotResponse$1 {
6138
5805
  states: {
6139
5806
  [k: string]: {
6140
5807
  /**
6141
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
5808
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
6142
5809
  */
6143
- type: "conversation" | "user" | "bot" | "task";
5810
+ type: "conversation" | "user" | "bot";
6144
5811
  /**
6145
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.
6146
5813
  */
@@ -6466,9 +6133,9 @@ interface UpdateBotRequestBody$1 {
6466
6133
  states?: {
6467
6134
  [k: string]: {
6468
6135
  /**
6469
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
6136
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
6470
6137
  */
6471
- type: "conversation" | "user" | "bot" | "task";
6138
+ type: "conversation" | "user" | "bot";
6472
6139
  /**
6473
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.
6474
6141
  */
@@ -6818,9 +6485,9 @@ interface UpdateBotResponse$1 {
6818
6485
  states: {
6819
6486
  [k: string]: {
6820
6487
  /**
6821
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
6488
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
6822
6489
  */
6823
- type: "conversation" | "user" | "bot" | "task";
6490
+ type: "conversation" | "user" | "bot";
6824
6491
  /**
6825
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.
6826
6493
  */
@@ -7326,9 +6993,9 @@ interface GetBotResponse$1 {
7326
6993
  states: {
7327
6994
  [k: string]: {
7328
6995
  /**
7329
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
6996
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
7330
6997
  */
7331
- type: "conversation" | "user" | "bot" | "task";
6998
+ type: "conversation" | "user" | "bot";
7332
6999
  /**
7333
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.
7334
7001
  */
@@ -8571,7 +8238,7 @@ interface GetAuditRecordsResponse$1 {
8571
8238
  resourceId: string | null;
8572
8239
  resourceName?: string | null;
8573
8240
  value?: string | null;
8574
- action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
8241
+ action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "UPDATE_WORKSPACE_PLAN_READONLY" | "UPDATE_WORKSPACE_ADDONS_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
8575
8242
  }[];
8576
8243
  meta: {
8577
8244
  /**
@@ -11051,6 +10718,12 @@ interface ListIntegrationsResponse$1 {
11051
10718
  handle: string | null;
11052
10719
  name: string;
11053
10720
  };
10721
+ /**
10722
+ * Optional key-value attributes from the integration definition
10723
+ */
10724
+ attributes?: {
10725
+ [k: string]: string;
10726
+ };
11054
10727
  }[];
11055
10728
  meta: {
11056
10729
  /**
@@ -12973,9 +12646,9 @@ interface CreatePluginRequestBody$1 {
12973
12646
  states?: {
12974
12647
  [k: string]: {
12975
12648
  /**
12976
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
12649
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
12977
12650
  */
12978
- type: "conversation" | "user" | "bot" | "task";
12651
+ type: "conversation" | "user" | "bot";
12979
12652
  /**
12980
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.
12981
12654
  */
@@ -13213,9 +12886,9 @@ interface CreatePluginResponse$1 {
13213
12886
  states: {
13214
12887
  [k: string]: {
13215
12888
  /**
13216
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
12889
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
13217
12890
  */
13218
- type: "conversation" | "user" | "bot" | "task";
12891
+ type: "conversation" | "user" | "bot";
13219
12892
  /**
13220
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.
13221
12894
  */
@@ -13433,9 +13106,9 @@ interface GetPluginResponse$1 {
13433
13106
  states: {
13434
13107
  [k: string]: {
13435
13108
  /**
13436
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
13109
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
13437
13110
  */
13438
- type: "conversation" | "user" | "bot" | "task";
13111
+ type: "conversation" | "user" | "bot";
13439
13112
  /**
13440
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.
13441
13114
  */
@@ -13662,9 +13335,9 @@ interface GetDereferencedPluginResponse$1 {
13662
13335
  states: {
13663
13336
  [k: string]: {
13664
13337
  /**
13665
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
13338
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
13666
13339
  */
13667
- type: "conversation" | "user" | "bot" | "task";
13340
+ type: "conversation" | "user" | "bot";
13668
13341
  /**
13669
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.
13670
13343
  */
@@ -13883,9 +13556,9 @@ interface GetPluginByNameResponse$1 {
13883
13556
  states: {
13884
13557
  [k: string]: {
13885
13558
  /**
13886
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
13559
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
13887
13560
  */
13888
- type: "conversation" | "user" | "bot" | "task";
13561
+ type: "conversation" | "user" | "bot";
13889
13562
  /**
13890
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.
13891
13564
  */
@@ -14079,9 +13752,9 @@ interface UpdatePluginRequestBody$1 {
14079
13752
  states?: {
14080
13753
  [k: string]: {
14081
13754
  /**
14082
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
13755
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
14083
13756
  */
14084
- type: "conversation" | "user" | "bot" | "task";
13757
+ type: "conversation" | "user" | "bot";
14085
13758
  /**
14086
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.
14087
13760
  */
@@ -14307,9 +13980,9 @@ interface UpdatePluginResponse$1 {
14307
13980
  states: {
14308
13981
  [k: string]: {
14309
13982
  /**
14310
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
13983
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
14311
13984
  */
14312
- type: "conversation" | "user" | "bot" | "task";
13985
+ type: "conversation" | "user" | "bot";
14313
13986
  /**
14314
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.
14315
13988
  */
@@ -14978,6 +14651,9 @@ declare class Client$8 extends Client$9 {
14978
14651
  actions?: string[];
14979
14652
  interfaces?: string[];
14980
14653
  };
14654
+ attributes?: {
14655
+ [k: string]: string;
14656
+ };
14981
14657
  }>;
14982
14658
  bots: (props: {
14983
14659
  tags?: {
@@ -15069,6 +14745,9 @@ declare class Client$8 extends Client$9 {
15069
14745
  handle: string | null;
15070
14746
  name: string;
15071
14747
  };
14748
+ attributes?: {
14749
+ [k: string]: string;
14750
+ };
15072
14751
  }>;
15073
14752
  interfaces: (props: {
15074
14753
  name?: string | undefined;
@@ -15160,7 +14839,46 @@ interface GetBillingReadonlyRequestBody {
15160
14839
  }
15161
14840
  type GetBillingReadonlyInput = GetBillingReadonlyRequestBody & GetBillingReadonlyRequestHeaders & GetBillingReadonlyRequestQuery & GetBillingReadonlyRequestParams;
15162
14841
  interface GetBillingReadonlyResponse {
15163
- billingReadonly: boolean;
14842
+ planReadonly: boolean;
14843
+ addonsReadonly: boolean;
14844
+ }
14845
+
14846
+ interface GetBillingAddressRequestHeaders {
14847
+ }
14848
+ interface GetBillingAddressRequestQuery {
14849
+ }
14850
+ interface GetBillingAddressRequestParams {
14851
+ }
14852
+ interface GetBillingAddressRequestBody {
14853
+ }
14854
+ type GetBillingAddressInput = GetBillingAddressRequestBody & GetBillingAddressRequestHeaders & GetBillingAddressRequestQuery & GetBillingAddressRequestParams;
14855
+ interface GetBillingAddressResponse {
14856
+ address: {
14857
+ lineOne?: string;
14858
+ lineTwo?: string;
14859
+ city?: string;
14860
+ state?: string;
14861
+ postalCode?: string;
14862
+ country?: string;
14863
+ } | null;
14864
+ }
14865
+
14866
+ interface SetBillingAddressRequestHeaders {
14867
+ }
14868
+ interface SetBillingAddressRequestQuery {
14869
+ }
14870
+ interface SetBillingAddressRequestParams {
14871
+ }
14872
+ interface SetBillingAddressRequestBody {
14873
+ lineOne?: string;
14874
+ lineTwo?: string;
14875
+ city?: string;
14876
+ state?: string;
14877
+ postalCode?: string;
14878
+ country?: string;
14879
+ }
14880
+ type SetBillingAddressInput = SetBillingAddressRequestBody & SetBillingAddressRequestHeaders & SetBillingAddressRequestQuery & SetBillingAddressRequestParams;
14881
+ interface SetBillingAddressResponse {
15164
14882
  }
15165
14883
 
15166
14884
  interface GetPlanRequestHeaders {
@@ -15271,59 +14989,16 @@ interface GetAddonResponse {
15271
14989
  };
15272
14990
  }
15273
14991
 
15274
- interface GetCurrentSubscriptionRequestHeaders {
14992
+ interface GetSubscriptionRequestHeaders {
15275
14993
  }
15276
- interface GetCurrentSubscriptionRequestQuery {
14994
+ interface GetSubscriptionRequestQuery {
15277
14995
  }
15278
- interface GetCurrentSubscriptionRequestParams {
14996
+ interface GetSubscriptionRequestParams {
15279
14997
  }
15280
- interface GetCurrentSubscriptionRequestBody {
14998
+ interface GetSubscriptionRequestBody {
15281
14999
  }
15282
- type GetCurrentSubscriptionInput = GetCurrentSubscriptionRequestBody & GetCurrentSubscriptionRequestHeaders & GetCurrentSubscriptionRequestQuery & GetCurrentSubscriptionRequestParams;
15283
- interface GetCurrentSubscriptionResponse {
15284
- plan: {
15285
- current: {
15286
- status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15287
- planId: string;
15288
- interval: "month" | "year";
15289
- price: number;
15290
- proratedPrice?: number;
15291
- cancelAtPeriodEnd: boolean;
15292
- periodEnd: string;
15293
- };
15294
- next: {
15295
- planId: string;
15296
- interval: "month" | "year";
15297
- price: number | null;
15298
- effectiveDate: string;
15299
- } | null;
15300
- };
15301
- addons: {
15302
- [k: string]: {
15303
- current: {
15304
- quantity: number;
15305
- price: number;
15306
- proratedPrice?: number;
15307
- };
15308
- next: {
15309
- quantity: number;
15310
- price: number;
15311
- effectiveDate: string;
15312
- } | null;
15313
- };
15314
- };
15315
- }
15316
-
15317
- interface GetNextSubscriptionRequestHeaders {
15318
- }
15319
- interface GetNextSubscriptionRequestQuery {
15320
- }
15321
- interface GetNextSubscriptionRequestParams {
15322
- }
15323
- interface GetNextSubscriptionRequestBody {
15324
- }
15325
- type GetNextSubscriptionInput = GetNextSubscriptionRequestBody & GetNextSubscriptionRequestHeaders & GetNextSubscriptionRequestQuery & GetNextSubscriptionRequestParams;
15326
- interface GetNextSubscriptionResponse {
15000
+ type GetSubscriptionInput = GetSubscriptionRequestBody & GetSubscriptionRequestHeaders & GetSubscriptionRequestQuery & GetSubscriptionRequestParams;
15001
+ interface GetSubscriptionResponse {
15327
15002
  plan: {
15328
15003
  current: {
15329
15004
  status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
@@ -15548,6 +15223,205 @@ interface SetAddonsResponse {
15548
15223
  };
15549
15224
  }
15550
15225
 
15226
+ interface SetCancelAtPeriodEndRequestHeaders {
15227
+ }
15228
+ interface SetCancelAtPeriodEndRequestQuery {
15229
+ }
15230
+ interface SetCancelAtPeriodEndRequestParams {
15231
+ }
15232
+ interface SetCancelAtPeriodEndRequestBody {
15233
+ cancelAtPeriodEnd: boolean;
15234
+ }
15235
+ type SetCancelAtPeriodEndInput = SetCancelAtPeriodEndRequestBody & SetCancelAtPeriodEndRequestHeaders & SetCancelAtPeriodEndRequestQuery & SetCancelAtPeriodEndRequestParams;
15236
+ /**
15237
+ * Subscription details including current plan, addons, and costs
15238
+ */
15239
+ interface SetCancelAtPeriodEndResponse {
15240
+ plan: {
15241
+ current: {
15242
+ status: "active" | "canceled" | "past_due" | "action_required" | "grace_period";
15243
+ planId: string;
15244
+ interval: "month" | "year";
15245
+ price: number;
15246
+ proratedPrice?: number;
15247
+ cancelAtPeriodEnd: boolean;
15248
+ periodEnd: string;
15249
+ };
15250
+ next: {
15251
+ planId: string;
15252
+ interval: "month" | "year";
15253
+ price: number | null;
15254
+ effectiveDate: string;
15255
+ } | null;
15256
+ };
15257
+ addons: {
15258
+ [k: string]: {
15259
+ current: {
15260
+ quantity: number;
15261
+ price: number;
15262
+ proratedPrice?: number;
15263
+ };
15264
+ next: {
15265
+ quantity: number;
15266
+ price: number;
15267
+ effectiveDate: string;
15268
+ } | null;
15269
+ };
15270
+ };
15271
+ }
15272
+
15273
+ interface GetAutoRechargeSettingsRequestHeaders {
15274
+ }
15275
+ interface GetAutoRechargeSettingsRequestQuery {
15276
+ }
15277
+ interface GetAutoRechargeSettingsRequestParams {
15278
+ }
15279
+ interface GetAutoRechargeSettingsRequestBody {
15280
+ }
15281
+ type GetAutoRechargeSettingsInput = GetAutoRechargeSettingsRequestBody & GetAutoRechargeSettingsRequestHeaders & GetAutoRechargeSettingsRequestQuery & GetAutoRechargeSettingsRequestParams;
15282
+ interface GetAutoRechargeSettingsResponse {
15283
+ settings: {
15284
+ table_row_count: {
15285
+ enabled: boolean;
15286
+ threshold?: number;
15287
+ limit?: number;
15288
+ disabledReason?: string;
15289
+ };
15290
+ invocation_calls: {
15291
+ enabled: boolean;
15292
+ threshold?: number;
15293
+ limit?: number;
15294
+ disabledReason?: string;
15295
+ };
15296
+ knowledgebase_vector_storage: {
15297
+ enabled: boolean;
15298
+ threshold?: number;
15299
+ limit?: number;
15300
+ disabledReason?: string;
15301
+ };
15302
+ storage_count: {
15303
+ enabled: boolean;
15304
+ threshold?: number;
15305
+ limit?: number;
15306
+ disabledReason?: string;
15307
+ };
15308
+ };
15309
+ }
15310
+
15311
+ interface SetAutoRechargeSettingsRequestHeaders {
15312
+ }
15313
+ interface SetAutoRechargeSettingsRequestQuery {
15314
+ }
15315
+ interface SetAutoRechargeSettingsRequestParams {
15316
+ }
15317
+ interface SetAutoRechargeSettingsRequestBody {
15318
+ settings: {
15319
+ table_row_count?: {
15320
+ enabled: boolean;
15321
+ threshold?: number;
15322
+ limit?: number;
15323
+ disabledReason?: string;
15324
+ };
15325
+ invocation_calls?: {
15326
+ enabled: boolean;
15327
+ threshold?: number;
15328
+ limit?: number;
15329
+ disabledReason?: string;
15330
+ };
15331
+ knowledgebase_vector_storage?: {
15332
+ enabled: boolean;
15333
+ threshold?: number;
15334
+ limit?: number;
15335
+ disabledReason?: string;
15336
+ };
15337
+ storage_count?: {
15338
+ enabled: boolean;
15339
+ threshold?: number;
15340
+ limit?: number;
15341
+ disabledReason?: string;
15342
+ };
15343
+ };
15344
+ }
15345
+ type SetAutoRechargeSettingsInput = SetAutoRechargeSettingsRequestBody & SetAutoRechargeSettingsRequestHeaders & SetAutoRechargeSettingsRequestQuery & SetAutoRechargeSettingsRequestParams;
15346
+ interface SetAutoRechargeSettingsResponse {
15347
+ settings: {
15348
+ table_row_count: {
15349
+ enabled: boolean;
15350
+ threshold?: number;
15351
+ limit?: number;
15352
+ disabledReason?: string;
15353
+ };
15354
+ invocation_calls: {
15355
+ enabled: boolean;
15356
+ threshold?: number;
15357
+ limit?: number;
15358
+ disabledReason?: string;
15359
+ };
15360
+ knowledgebase_vector_storage: {
15361
+ enabled: boolean;
15362
+ threshold?: number;
15363
+ limit?: number;
15364
+ disabledReason?: string;
15365
+ };
15366
+ storage_count: {
15367
+ enabled: boolean;
15368
+ threshold?: number;
15369
+ limit?: number;
15370
+ disabledReason?: string;
15371
+ };
15372
+ };
15373
+ }
15374
+
15375
+ interface GetTrialsRequestHeaders {
15376
+ }
15377
+ interface GetTrialsRequestQuery {
15378
+ }
15379
+ interface GetTrialsRequestParams {
15380
+ }
15381
+ interface GetTrialsRequestBody {
15382
+ }
15383
+ type GetTrialsInput = GetTrialsRequestBody & GetTrialsRequestHeaders & GetTrialsRequestQuery & GetTrialsRequestParams;
15384
+ interface GetTrialsResponse {
15385
+ trials: {
15386
+ id: string;
15387
+ trialPlan: string;
15388
+ fromPlan: string;
15389
+ endsAt: string;
15390
+ isActive: boolean;
15391
+ }[];
15392
+ }
15393
+
15394
+ interface CreateTrialRequestHeaders {
15395
+ }
15396
+ interface CreateTrialRequestQuery {
15397
+ }
15398
+ interface CreateTrialRequestParams {
15399
+ }
15400
+ interface CreateTrialRequestBody {
15401
+ lengthInDays: number;
15402
+ plan: string;
15403
+ }
15404
+ type CreateTrialInput = CreateTrialRequestBody & CreateTrialRequestHeaders & CreateTrialRequestQuery & CreateTrialRequestParams;
15405
+ interface CreateTrialResponse {
15406
+ id: string;
15407
+ trialPlan: string;
15408
+ fromPlan: string;
15409
+ endsAt: string;
15410
+ isActive: boolean;
15411
+ }
15412
+
15413
+ interface RemoveTrialRequestHeaders {
15414
+ }
15415
+ interface RemoveTrialRequestQuery {
15416
+ }
15417
+ interface RemoveTrialRequestParams {
15418
+ }
15419
+ interface RemoveTrialRequestBody {
15420
+ }
15421
+ type RemoveTrialInput = RemoveTrialRequestBody & RemoveTrialRequestHeaders & RemoveTrialRequestQuery & RemoveTrialRequestParams;
15422
+ interface RemoveTrialResponse {
15423
+ }
15424
+
15551
15425
  interface ListInvoicesRequestHeaders {
15552
15426
  }
15553
15427
  interface ListInvoicesRequestQuery {
@@ -15682,15 +15556,22 @@ declare class Client$7 {
15682
15556
  private props;
15683
15557
  constructor(axiosInstance: AxiosInstance, props?: Partial<ClientProps$7>);
15684
15558
  readonly getBillingReadonly: (input: GetBillingReadonlyInput) => Promise<GetBillingReadonlyResponse>;
15559
+ readonly getBillingAddress: (input: GetBillingAddressInput) => Promise<GetBillingAddressResponse>;
15560
+ readonly setBillingAddress: (input: SetBillingAddressInput) => Promise<SetBillingAddressResponse>;
15685
15561
  readonly getPlan: (input: GetPlanInput) => Promise<GetPlanResponse$1>;
15686
15562
  readonly listPlans: (input: ListPlansInput) => Promise<ListPlansResponse>;
15687
15563
  readonly getAddon: (input: GetAddonInput) => Promise<GetAddonResponse$1>;
15688
15564
  readonly listAddons: (input: ListAddonsInput) => Promise<ListAddonsResponse>;
15689
- readonly getCurrentSubscription: (input: GetCurrentSubscriptionInput) => Promise<GetCurrentSubscriptionResponse>;
15690
- readonly getNextSubscription: (input: GetNextSubscriptionInput) => Promise<GetNextSubscriptionResponse>;
15565
+ readonly getSubscription: (input: GetSubscriptionInput) => Promise<GetSubscriptionResponse>;
15691
15566
  readonly previewSubscriptionUpdate: (input: PreviewSubscriptionUpdateInput) => Promise<PreviewSubscriptionUpdateResponse>;
15692
15567
  readonly setPlan: (input: SetPlanInput) => Promise<SetPlanResponse>;
15693
15568
  readonly setAddons: (input: SetAddonsInput) => Promise<SetAddonsResponse>;
15569
+ readonly setCancelAtPeriodEnd: (input: SetCancelAtPeriodEndInput) => Promise<SetCancelAtPeriodEndResponse>;
15570
+ readonly getAutoRechargeSettings: (input: GetAutoRechargeSettingsInput) => Promise<GetAutoRechargeSettingsResponse>;
15571
+ readonly setAutoRechargeSettings: (input: SetAutoRechargeSettingsInput) => Promise<SetAutoRechargeSettingsResponse>;
15572
+ readonly getTrials: (input: GetTrialsInput) => Promise<GetTrialsResponse>;
15573
+ readonly createTrial: (input: CreateTrialInput) => Promise<CreateTrialResponse>;
15574
+ readonly removeTrial: (input: RemoveTrialInput) => Promise<RemoveTrialResponse>;
15694
15575
  readonly listInvoices: (input: ListInvoicesInput) => Promise<ListInvoicesResponse>;
15695
15576
  readonly payInvoice: (input: PayInvoiceInput) => Promise<PayInvoiceResponse>;
15696
15577
  readonly getPaymentMethod: (input: GetPaymentMethodInput) => Promise<GetPaymentMethodResponse>;
@@ -18740,7 +18621,8 @@ interface CreateConversationResponse {
18740
18621
  */
18741
18622
  id: string;
18742
18623
  /**
18743
- * Id of the current [Task](#schema_task)
18624
+ * @deprecated
18625
+ * Unused. This field will be removed in the future.
18744
18626
  */
18745
18627
  currentTaskId?: string;
18746
18628
  /**
@@ -18792,7 +18674,8 @@ interface GetConversationResponse {
18792
18674
  */
18793
18675
  id: string;
18794
18676
  /**
18795
- * Id of the current [Task](#schema_task)
18677
+ * @deprecated
18678
+ * Unused. This field will be removed in the future.
18796
18679
  */
18797
18680
  currentTaskId?: string;
18798
18681
  /**
@@ -18851,7 +18734,8 @@ interface ListConversationsResponse {
18851
18734
  */
18852
18735
  id: string;
18853
18736
  /**
18854
- * Id of the current [Task](#schema_task)
18737
+ * @deprecated
18738
+ * Unused. This field will be removed in the future.
18855
18739
  */
18856
18740
  currentTaskId?: string;
18857
18741
  /**
@@ -18927,7 +18811,8 @@ interface GetOrCreateConversationResponse {
18927
18811
  */
18928
18812
  id: string;
18929
18813
  /**
18930
- * Id of the current [Task](#schema_task)
18814
+ * @deprecated
18815
+ * Unused. This field will be removed in the future.
18931
18816
  */
18932
18817
  currentTaskId?: string;
18933
18818
  /**
@@ -18967,6 +18852,10 @@ interface UpdateConversationRequestParams {
18967
18852
  id: string;
18968
18853
  }
18969
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
+ */
18970
18859
  currentTaskId?: string;
18971
18860
  /**
18972
18861
  * Tags for the [Conversation](#schema_conversation)
@@ -18986,7 +18875,8 @@ interface UpdateConversationResponse {
18986
18875
  */
18987
18876
  id: string;
18988
18877
  /**
18989
- * Id of the current [Task](#schema_task)
18878
+ * @deprecated
18879
+ * Unused. This field will be removed in the future.
18990
18880
  */
18991
18881
  currentTaskId?: string;
18992
18882
  /**
@@ -19070,6 +18960,12 @@ interface ListParticipantsResponse {
19070
18960
  * Picture URL of the [User](#schema_user)
19071
18961
  */
19072
18962
  pictureUrl?: string;
18963
+ /**
18964
+ * Optional attributes
18965
+ */
18966
+ attributes?: {
18967
+ [k: string]: string;
18968
+ };
19073
18969
  }[];
19074
18970
  meta: {
19075
18971
  /**
@@ -19124,6 +19020,12 @@ interface AddParticipantResponse {
19124
19020
  * Picture URL of the [User](#schema_user)
19125
19021
  */
19126
19022
  pictureUrl?: string;
19023
+ /**
19024
+ * Optional attributes
19025
+ */
19026
+ attributes?: {
19027
+ [k: string]: string;
19028
+ };
19127
19029
  };
19128
19030
  }
19129
19031
 
@@ -19169,6 +19071,12 @@ interface GetParticipantResponse {
19169
19071
  * Picture URL of the [User](#schema_user)
19170
19072
  */
19171
19073
  pictureUrl?: string;
19074
+ /**
19075
+ * Optional attributes
19076
+ */
19077
+ attributes?: {
19078
+ [k: string]: string;
19079
+ };
19172
19080
  };
19173
19081
  }
19174
19082
 
@@ -19855,6 +19763,12 @@ interface InitializeIncomingMessageRequestBody {
19855
19763
  * URI of the user picture
19856
19764
  */
19857
19765
  pictureUrl?: string;
19766
+ /**
19767
+ * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
19768
+ */
19769
+ attributes?: {
19770
+ [k: string]: string;
19771
+ };
19858
19772
  /**
19859
19773
  * Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
19860
19774
  */
@@ -19938,6 +19852,12 @@ interface InitializeIncomingMessageResponse {
19938
19852
  * Picture URL of the [User](#schema_user)
19939
19853
  */
19940
19854
  pictureUrl?: string;
19855
+ /**
19856
+ * Optional attributes
19857
+ */
19858
+ attributes?: {
19859
+ [k: string]: string;
19860
+ };
19941
19861
  };
19942
19862
  /**
19943
19863
  * The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
@@ -19948,7 +19868,8 @@ interface InitializeIncomingMessageResponse {
19948
19868
  */
19949
19869
  id: string;
19950
19870
  /**
19951
- * Id of the current [Task](#schema_task)
19871
+ * @deprecated
19872
+ * Unused. This field will be removed in the future.
19952
19873
  */
19953
19874
  currentTaskId?: string;
19954
19875
  /**
@@ -20150,6 +20071,12 @@ interface CreateUserRequestBody {
20150
20071
  * URI of the user picture
20151
20072
  */
20152
20073
  pictureUrl?: string;
20074
+ /**
20075
+ * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
20076
+ */
20077
+ attributes?: {
20078
+ [k: string]: string;
20079
+ };
20153
20080
  }
20154
20081
  type CreateUserInput = CreateUserRequestBody & CreateUserRequestHeaders & CreateUserRequestQuery & CreateUserRequestParams;
20155
20082
  interface CreateUserResponse {
@@ -20183,6 +20110,12 @@ interface CreateUserResponse {
20183
20110
  * Picture URL of the [User](#schema_user)
20184
20111
  */
20185
20112
  pictureUrl?: string;
20113
+ /**
20114
+ * Optional attributes
20115
+ */
20116
+ attributes?: {
20117
+ [k: string]: string;
20118
+ };
20186
20119
  };
20187
20120
  }
20188
20121
 
@@ -20227,6 +20160,12 @@ interface GetUserResponse {
20227
20160
  * Picture URL of the [User](#schema_user)
20228
20161
  */
20229
20162
  pictureUrl?: string;
20163
+ /**
20164
+ * Optional attributes
20165
+ */
20166
+ attributes?: {
20167
+ [k: string]: string;
20168
+ };
20230
20169
  };
20231
20170
  }
20232
20171
 
@@ -20277,6 +20216,12 @@ interface ListUsersResponse {
20277
20216
  * Picture URL of the [User](#schema_user)
20278
20217
  */
20279
20218
  pictureUrl?: string;
20219
+ /**
20220
+ * Optional attributes
20221
+ */
20222
+ attributes?: {
20223
+ [k: string]: string;
20224
+ };
20280
20225
  }[];
20281
20226
  meta: {
20282
20227
  /**
@@ -20312,6 +20257,12 @@ interface GetOrCreateUserRequestBody {
20312
20257
  * URI of the user picture
20313
20258
  */
20314
20259
  pictureUrl?: string;
20260
+ /**
20261
+ * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
20262
+ */
20263
+ attributes?: {
20264
+ [k: string]: string;
20265
+ };
20315
20266
  /**
20316
20267
  * Optional list of tag names to use for strict matching when looking up existing users. If provided, all specified tags must match exactly for a user to be considered a match. For example, with an existing user whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
20317
20268
  */
@@ -20349,6 +20300,12 @@ interface GetOrCreateUserResponse {
20349
20300
  * Picture URL of the [User](#schema_user)
20350
20301
  */
20351
20302
  pictureUrl?: string;
20303
+ /**
20304
+ * Optional attributes
20305
+ */
20306
+ attributes?: {
20307
+ [k: string]: string;
20308
+ };
20352
20309
  };
20353
20310
  }
20354
20311
 
@@ -20374,6 +20331,12 @@ interface UpdateUserRequestBody {
20374
20331
  * URI of the user picture
20375
20332
  */
20376
20333
  pictureUrl?: string | null;
20334
+ /**
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.
20336
+ */
20337
+ attributes?: {
20338
+ [k: string]: string | null;
20339
+ };
20377
20340
  }
20378
20341
  type UpdateUserInput = UpdateUserRequestBody & UpdateUserRequestHeaders & UpdateUserRequestQuery & UpdateUserRequestParams;
20379
20342
  interface UpdateUserResponse {
@@ -20407,6 +20370,12 @@ interface UpdateUserResponse {
20407
20370
  * Picture URL of the [User](#schema_user)
20408
20371
  */
20409
20372
  pictureUrl?: string;
20373
+ /**
20374
+ * Optional attributes
20375
+ */
20376
+ attributes?: {
20377
+ [k: string]: string;
20378
+ };
20410
20379
  };
20411
20380
  }
20412
20381
 
@@ -20428,7 +20397,7 @@ interface SetStateExpiryRequestHeaders {
20428
20397
  interface SetStateExpiryRequestQuery {
20429
20398
  }
20430
20399
  interface SetStateExpiryRequestParams {
20431
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
20400
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20432
20401
  id: string;
20433
20402
  name: string;
20434
20403
  }
@@ -20473,9 +20442,9 @@ interface SetStateExpiryResponse {
20473
20442
  */
20474
20443
  name: string;
20475
20444
  /**
20476
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
20445
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
20477
20446
  */
20478
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
20447
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20479
20448
  /**
20480
20449
  * Payload is the content of the state defined by your bot.
20481
20450
  */
@@ -20490,7 +20459,7 @@ interface GetStateRequestHeaders {
20490
20459
  interface GetStateRequestQuery {
20491
20460
  }
20492
20461
  interface GetStateRequestParams {
20493
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
20462
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20494
20463
  id: string;
20495
20464
  name: string;
20496
20465
  }
@@ -20531,9 +20500,9 @@ interface GetStateResponse {
20531
20500
  */
20532
20501
  name: string;
20533
20502
  /**
20534
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
20503
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
20535
20504
  */
20536
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
20505
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20537
20506
  /**
20538
20507
  * Payload is the content of the state defined by your bot.
20539
20508
  */
@@ -20551,7 +20520,7 @@ interface SetStateRequestHeaders {
20551
20520
  interface SetStateRequestQuery {
20552
20521
  }
20553
20522
  interface SetStateRequestParams {
20554
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
20523
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20555
20524
  id: string;
20556
20525
  name: string;
20557
20526
  }
@@ -20602,9 +20571,9 @@ interface SetStateResponse {
20602
20571
  */
20603
20572
  name: string;
20604
20573
  /**
20605
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
20574
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
20606
20575
  */
20607
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
20576
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20608
20577
  /**
20609
20578
  * Payload is the content of the state defined by your bot.
20610
20579
  */
@@ -20619,7 +20588,7 @@ interface GetOrSetStateRequestHeaders {
20619
20588
  interface GetOrSetStateRequestQuery {
20620
20589
  }
20621
20590
  interface GetOrSetStateRequestParams {
20622
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
20591
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20623
20592
  id: string;
20624
20593
  name: string;
20625
20594
  }
@@ -20670,9 +20639,9 @@ interface GetOrSetStateResponse {
20670
20639
  */
20671
20640
  name: string;
20672
20641
  /**
20673
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
20642
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
20674
20643
  */
20675
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
20644
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20676
20645
  /**
20677
20646
  * Payload is the content of the state defined by your bot.
20678
20647
  */
@@ -20690,7 +20659,7 @@ interface PatchStateRequestHeaders {
20690
20659
  interface PatchStateRequestQuery {
20691
20660
  }
20692
20661
  interface PatchStateRequestParams {
20693
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
20662
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20694
20663
  id: string;
20695
20664
  name: string;
20696
20665
  }
@@ -20737,9 +20706,9 @@ interface PatchStateResponse {
20737
20706
  */
20738
20707
  name: string;
20739
20708
  /**
20740
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
20709
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
20741
20710
  */
20742
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
20711
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
20743
20712
  /**
20744
20713
  * Payload is the content of the state defined by your bot.
20745
20714
  */
@@ -20804,409 +20773,6 @@ type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureInte
20804
20773
  interface ConfigureIntegrationResponse {
20805
20774
  }
20806
20775
 
20807
- interface GetTaskRequestHeaders {
20808
- }
20809
- interface GetTaskRequestQuery {
20810
- }
20811
- interface GetTaskRequestParams {
20812
- id: string;
20813
- }
20814
- interface GetTaskRequestBody {
20815
- }
20816
- type GetTaskInput = GetTaskRequestBody & GetTaskRequestHeaders & GetTaskRequestQuery & GetTaskRequestParams;
20817
- interface GetTaskResponse {
20818
- /**
20819
- * Task definition
20820
- */
20821
- task: {
20822
- /**
20823
- * Id of the [Task](#schema_task)
20824
- */
20825
- id: string;
20826
- /**
20827
- * Title describing the task
20828
- */
20829
- title: string;
20830
- /**
20831
- * All the notes related to the execution of the current task
20832
- */
20833
- description: string;
20834
- /**
20835
- * Type of the task
20836
- */
20837
- type: string;
20838
- /**
20839
- * Content related to the task
20840
- */
20841
- data: {
20842
- [k: string]: any;
20843
- };
20844
- /**
20845
- * Status of the task
20846
- */
20847
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
20848
- /**
20849
- * Parent task id is the parent task that created this task
20850
- */
20851
- parentTaskId?: string;
20852
- /**
20853
- * Conversation id related to this task
20854
- */
20855
- conversationId?: string;
20856
- /**
20857
- * Specific user related to this task
20858
- */
20859
- userId?: string;
20860
- /**
20861
- * The timeout date where the task should be failed in the ISO 8601 format
20862
- */
20863
- timeoutAt: string;
20864
- /**
20865
- * Creation date of the task in ISO 8601 format
20866
- */
20867
- createdAt: string;
20868
- /**
20869
- * Updating date of the task in ISO 8601 format
20870
- */
20871
- updatedAt: string;
20872
- /**
20873
- * If the task fails this is the reason behind it
20874
- */
20875
- failureReason?: string;
20876
- /**
20877
- * 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.
20878
- */
20879
- tags: {
20880
- [k: string]: string;
20881
- };
20882
- };
20883
- }
20884
-
20885
- interface CreateTaskRequestHeaders {
20886
- }
20887
- interface CreateTaskRequestQuery {
20888
- }
20889
- interface CreateTaskRequestParams {
20890
- }
20891
- interface CreateTaskRequestBody {
20892
- /**
20893
- * Title describing the task
20894
- */
20895
- title?: string;
20896
- /**
20897
- * All the notes related to the execution of the current task
20898
- */
20899
- description?: string;
20900
- /**
20901
- * Type of the task
20902
- */
20903
- type: string;
20904
- /**
20905
- * Content related to the task
20906
- */
20907
- data?: {
20908
- [k: string]: any;
20909
- };
20910
- /**
20911
- * Parent task id is the parent task that created this task
20912
- */
20913
- parentTaskId?: string;
20914
- /**
20915
- * Conversation id related to this task
20916
- */
20917
- conversationId: string;
20918
- /**
20919
- * Specific user related to this task
20920
- */
20921
- userId?: string;
20922
- /**
20923
- * The timeout date where the task should be failed in the ISO 8601 format
20924
- */
20925
- timeoutAt?: string;
20926
- /**
20927
- * Tags for the [Task](#schema_task)
20928
- */
20929
- tags?: {
20930
- [k: string]: string;
20931
- };
20932
- }
20933
- type CreateTaskInput = CreateTaskRequestBody & CreateTaskRequestHeaders & CreateTaskRequestQuery & CreateTaskRequestParams;
20934
- interface CreateTaskResponse {
20935
- /**
20936
- * Task definition
20937
- */
20938
- task: {
20939
- /**
20940
- * Id of the [Task](#schema_task)
20941
- */
20942
- id: string;
20943
- /**
20944
- * Title describing the task
20945
- */
20946
- title: string;
20947
- /**
20948
- * All the notes related to the execution of the current task
20949
- */
20950
- description: string;
20951
- /**
20952
- * Type of the task
20953
- */
20954
- type: string;
20955
- /**
20956
- * Content related to the task
20957
- */
20958
- data: {
20959
- [k: string]: any;
20960
- };
20961
- /**
20962
- * Status of the task
20963
- */
20964
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
20965
- /**
20966
- * Parent task id is the parent task that created this task
20967
- */
20968
- parentTaskId?: string;
20969
- /**
20970
- * Conversation id related to this task
20971
- */
20972
- conversationId?: string;
20973
- /**
20974
- * Specific user related to this task
20975
- */
20976
- userId?: string;
20977
- /**
20978
- * The timeout date where the task should be failed in the ISO 8601 format
20979
- */
20980
- timeoutAt: string;
20981
- /**
20982
- * Creation date of the task in ISO 8601 format
20983
- */
20984
- createdAt: string;
20985
- /**
20986
- * Updating date of the task in ISO 8601 format
20987
- */
20988
- updatedAt: string;
20989
- /**
20990
- * If the task fails this is the reason behind it
20991
- */
20992
- failureReason?: string;
20993
- /**
20994
- * 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.
20995
- */
20996
- tags: {
20997
- [k: string]: string;
20998
- };
20999
- };
21000
- }
21001
-
21002
- interface UpdateTaskRequestHeaders {
21003
- }
21004
- interface UpdateTaskRequestQuery {
21005
- }
21006
- interface UpdateTaskRequestParams {
21007
- id: string;
21008
- }
21009
- interface UpdateTaskRequestBody {
21010
- /**
21011
- * Title describing the task
21012
- */
21013
- title?: string;
21014
- /**
21015
- * All the notes related to the execution of the current task
21016
- */
21017
- description?: string;
21018
- /**
21019
- * Content related to the task
21020
- */
21021
- data?: {
21022
- [k: string]: any;
21023
- };
21024
- /**
21025
- * The timeout date where the task should be failed in the ISO 8601 format
21026
- */
21027
- timeoutAt?: string;
21028
- /**
21029
- * Status of the task
21030
- */
21031
- status?: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
21032
- /**
21033
- * Tags for the [Task](#schema_task)
21034
- */
21035
- tags?: {
21036
- [k: string]: string;
21037
- };
21038
- }
21039
- type UpdateTaskInput = UpdateTaskRequestBody & UpdateTaskRequestHeaders & UpdateTaskRequestQuery & UpdateTaskRequestParams;
21040
- interface UpdateTaskResponse {
21041
- /**
21042
- * Task definition
21043
- */
21044
- task: {
21045
- /**
21046
- * Id of the [Task](#schema_task)
21047
- */
21048
- id: string;
21049
- /**
21050
- * Title describing the task
21051
- */
21052
- title: string;
21053
- /**
21054
- * All the notes related to the execution of the current task
21055
- */
21056
- description: string;
21057
- /**
21058
- * Type of the task
21059
- */
21060
- type: string;
21061
- /**
21062
- * Content related to the task
21063
- */
21064
- data: {
21065
- [k: string]: any;
21066
- };
21067
- /**
21068
- * Status of the task
21069
- */
21070
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
21071
- /**
21072
- * Parent task id is the parent task that created this task
21073
- */
21074
- parentTaskId?: string;
21075
- /**
21076
- * Conversation id related to this task
21077
- */
21078
- conversationId?: string;
21079
- /**
21080
- * Specific user related to this task
21081
- */
21082
- userId?: string;
21083
- /**
21084
- * The timeout date where the task should be failed in the ISO 8601 format
21085
- */
21086
- timeoutAt: string;
21087
- /**
21088
- * Creation date of the task in ISO 8601 format
21089
- */
21090
- createdAt: string;
21091
- /**
21092
- * Updating date of the task in ISO 8601 format
21093
- */
21094
- updatedAt: string;
21095
- /**
21096
- * If the task fails this is the reason behind it
21097
- */
21098
- failureReason?: string;
21099
- /**
21100
- * 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.
21101
- */
21102
- tags: {
21103
- [k: string]: string;
21104
- };
21105
- };
21106
- }
21107
-
21108
- interface DeleteTaskRequestHeaders {
21109
- }
21110
- interface DeleteTaskRequestQuery {
21111
- }
21112
- interface DeleteTaskRequestParams {
21113
- id: string;
21114
- }
21115
- interface DeleteTaskRequestBody {
21116
- }
21117
- type DeleteTaskInput = DeleteTaskRequestBody & DeleteTaskRequestHeaders & DeleteTaskRequestQuery & DeleteTaskRequestParams;
21118
- interface DeleteTaskResponse {
21119
- }
21120
-
21121
- interface ListTasksRequestHeaders {
21122
- }
21123
- interface ListTasksRequestQuery {
21124
- nextToken?: string;
21125
- tags?: {
21126
- [k: string]: string;
21127
- };
21128
- conversationId?: string;
21129
- userId?: string;
21130
- parentTaskId?: string;
21131
- status?: ("pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled")[];
21132
- type?: string;
21133
- }
21134
- interface ListTasksRequestParams {
21135
- }
21136
- interface ListTasksRequestBody {
21137
- }
21138
- type ListTasksInput = ListTasksRequestBody & ListTasksRequestHeaders & ListTasksRequestQuery & ListTasksRequestParams;
21139
- interface ListTasksResponse {
21140
- tasks: {
21141
- /**
21142
- * Id of the [Task](#schema_task)
21143
- */
21144
- id: string;
21145
- /**
21146
- * Title describing the task
21147
- */
21148
- title: string;
21149
- /**
21150
- * All the notes related to the execution of the current task
21151
- */
21152
- description: string;
21153
- /**
21154
- * Type of the task
21155
- */
21156
- type: string;
21157
- /**
21158
- * Content related to the task
21159
- */
21160
- data: {
21161
- [k: string]: any;
21162
- };
21163
- /**
21164
- * Status of the task
21165
- */
21166
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
21167
- /**
21168
- * Parent task id is the parent task that created this task
21169
- */
21170
- parentTaskId?: string;
21171
- /**
21172
- * Conversation id related to this task
21173
- */
21174
- conversationId?: string;
21175
- /**
21176
- * Specific user related to this task
21177
- */
21178
- userId?: string;
21179
- /**
21180
- * The timeout date where the task should be failed in the ISO 8601 format
21181
- */
21182
- timeoutAt: string;
21183
- /**
21184
- * Creation date of the task in ISO 8601 format
21185
- */
21186
- createdAt: string;
21187
- /**
21188
- * Updating date of the task in ISO 8601 format
21189
- */
21190
- updatedAt: string;
21191
- /**
21192
- * If the task fails this is the reason behind it
21193
- */
21194
- failureReason?: string;
21195
- /**
21196
- * 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.
21197
- */
21198
- tags: {
21199
- [k: string]: string;
21200
- };
21201
- }[];
21202
- meta: {
21203
- /**
21204
- * 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.
21205
- */
21206
- nextToken?: string;
21207
- };
21208
- }
21209
-
21210
20776
  interface CreateWorkflowRequestHeaders {
21211
20777
  }
21212
20778
  interface CreateWorkflowRequestQuery {
@@ -21788,6 +21354,10 @@ interface CaptureObservationRequestQuery {
21788
21354
  interface CaptureObservationRequestParams {
21789
21355
  }
21790
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;
21791
21361
  /**
21792
21362
  * Name of the observation
21793
21363
  */
@@ -22096,6 +21666,12 @@ interface ListPublicIntegrationsResponse {
22096
21666
  */
22097
21667
  interfaces?: string[];
22098
21668
  };
21669
+ /**
21670
+ * Optional key-value attributes from the integration definition
21671
+ */
21672
+ attributes?: {
21673
+ [k: string]: string;
21674
+ };
22099
21675
  }[];
22100
21676
  meta: {
22101
21677
  /**
@@ -23070,9 +22646,9 @@ interface GetPublicPluginByIdResponse {
23070
22646
  states: {
23071
22647
  [k: string]: {
23072
22648
  /**
23073
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
22649
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
23074
22650
  */
23075
- type: "conversation" | "user" | "bot" | "task";
22651
+ type: "conversation" | "user" | "bot";
23076
22652
  /**
23077
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.
23078
22654
  */
@@ -23299,9 +22875,9 @@ interface GetDereferencedPublicPluginByIdResponse {
23299
22875
  states: {
23300
22876
  [k: string]: {
23301
22877
  /**
23302
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
22878
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
23303
22879
  */
23304
- type: "conversation" | "user" | "bot" | "task";
22880
+ type: "conversation" | "user" | "bot";
23305
22881
  /**
23306
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.
23307
22883
  */
@@ -23520,9 +23096,9 @@ interface GetPublicPluginResponse {
23520
23096
  states: {
23521
23097
  [k: string]: {
23522
23098
  /**
23523
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
23099
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
23524
23100
  */
23525
- type: "conversation" | "user" | "bot" | "task";
23101
+ type: "conversation" | "user" | "bot";
23526
23102
  /**
23527
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.
23528
23104
  */
@@ -24108,9 +23684,9 @@ interface CreateBotRequestBody {
24108
23684
  states?: {
24109
23685
  [k: string]: {
24110
23686
  /**
24111
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
23687
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
24112
23688
  */
24113
- type: "conversation" | "user" | "bot" | "task";
23689
+ type: "conversation" | "user" | "bot";
24114
23690
  /**
24115
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.
24116
23692
  */
@@ -24546,9 +24122,9 @@ interface CreateBotResponse {
24546
24122
  states: {
24547
24123
  [k: string]: {
24548
24124
  /**
24549
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
24125
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
24550
24126
  */
24551
- type: "conversation" | "user" | "bot" | "task";
24127
+ type: "conversation" | "user" | "bot";
24552
24128
  /**
24553
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.
24554
24130
  */
@@ -24874,9 +24450,9 @@ interface UpdateBotRequestBody {
24874
24450
  states?: {
24875
24451
  [k: string]: {
24876
24452
  /**
24877
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
24453
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
24878
24454
  */
24879
- type: "conversation" | "user" | "bot" | "task";
24455
+ type: "conversation" | "user" | "bot";
24880
24456
  /**
24881
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.
24882
24458
  */
@@ -25226,9 +24802,9 @@ interface UpdateBotResponse {
25226
24802
  states: {
25227
24803
  [k: string]: {
25228
24804
  /**
25229
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
24805
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
25230
24806
  */
25231
- type: "conversation" | "user" | "bot" | "task";
24807
+ type: "conversation" | "user" | "bot";
25232
24808
  /**
25233
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.
25234
24810
  */
@@ -25734,9 +25310,9 @@ interface GetBotResponse {
25734
25310
  states: {
25735
25311
  [k: string]: {
25736
25312
  /**
25737
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
25313
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
25738
25314
  */
25739
- type: "conversation" | "user" | "bot" | "task";
25315
+ type: "conversation" | "user" | "bot";
25740
25316
  /**
25741
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.
25742
25318
  */
@@ -26979,7 +26555,7 @@ interface GetAuditRecordsResponse {
26979
26555
  resourceId: string | null;
26980
26556
  resourceName?: string | null;
26981
26557
  value?: string | null;
26982
- action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
26558
+ action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY" | "UPDATE_WORKSPACE_PLAN_READONLY" | "UPDATE_WORKSPACE_ADDONS_READONLY" | "EXECUTE_AUTO_RECHARGE_SUCCESS" | "EXECUTE_AUTO_RECHARGE_FAILED";
26983
26559
  }[];
26984
26560
  meta: {
26985
26561
  /**
@@ -29460,6 +29036,12 @@ interface ListIntegrationsResponse {
29460
29036
  handle: string | null;
29461
29037
  name: string;
29462
29038
  };
29039
+ /**
29040
+ * Optional key-value attributes from the integration definition
29041
+ */
29042
+ attributes?: {
29043
+ [k: string]: string;
29044
+ };
29463
29045
  }[];
29464
29046
  meta: {
29465
29047
  /**
@@ -31382,9 +30964,9 @@ interface CreatePluginRequestBody {
31382
30964
  states?: {
31383
30965
  [k: string]: {
31384
30966
  /**
31385
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
30967
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
31386
30968
  */
31387
- type: "conversation" | "user" | "bot" | "task";
30969
+ type: "conversation" | "user" | "bot";
31388
30970
  /**
31389
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.
31390
30972
  */
@@ -31622,9 +31204,9 @@ interface CreatePluginResponse {
31622
31204
  states: {
31623
31205
  [k: string]: {
31624
31206
  /**
31625
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
31207
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
31626
31208
  */
31627
- type: "conversation" | "user" | "bot" | "task";
31209
+ type: "conversation" | "user" | "bot";
31628
31210
  /**
31629
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.
31630
31212
  */
@@ -31842,9 +31424,9 @@ interface GetPluginResponse {
31842
31424
  states: {
31843
31425
  [k: string]: {
31844
31426
  /**
31845
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
31427
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
31846
31428
  */
31847
- type: "conversation" | "user" | "bot" | "task";
31429
+ type: "conversation" | "user" | "bot";
31848
31430
  /**
31849
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.
31850
31432
  */
@@ -32071,9 +31653,9 @@ interface GetDereferencedPluginResponse {
32071
31653
  states: {
32072
31654
  [k: string]: {
32073
31655
  /**
32074
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
31656
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
32075
31657
  */
32076
- type: "conversation" | "user" | "bot" | "task";
31658
+ type: "conversation" | "user" | "bot";
32077
31659
  /**
32078
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.
32079
31661
  */
@@ -32292,9 +31874,9 @@ interface GetPluginByNameResponse {
32292
31874
  states: {
32293
31875
  [k: string]: {
32294
31876
  /**
32295
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
31877
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
32296
31878
  */
32297
- type: "conversation" | "user" | "bot" | "task";
31879
+ type: "conversation" | "user" | "bot";
32298
31880
  /**
32299
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.
32300
31882
  */
@@ -32488,9 +32070,9 @@ interface UpdatePluginRequestBody {
32488
32070
  states?: {
32489
32071
  [k: string]: {
32490
32072
  /**
32491
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
32073
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
32492
32074
  */
32493
- type: "conversation" | "user" | "bot" | "task";
32075
+ type: "conversation" | "user" | "bot";
32494
32076
  /**
32495
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.
32496
32078
  */
@@ -32716,9 +32298,9 @@ interface UpdatePluginResponse {
32716
32298
  states: {
32717
32299
  [k: string]: {
32718
32300
  /**
32719
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
32301
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
32720
32302
  */
32721
- type: "conversation" | "user" | "bot" | "task";
32303
+ type: "conversation" | "user" | "bot";
32722
32304
  /**
32723
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.
32724
32306
  */
@@ -36211,9 +35793,9 @@ interface Bot {
36211
35793
  states: {
36212
35794
  [k: string]: {
36213
35795
  /**
36214
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
35796
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
36215
35797
  */
36216
- type: "conversation" | "user" | "bot" | "task";
35798
+ type: "conversation" | "user" | "bot";
36217
35799
  /**
36218
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.
36219
35801
  */
@@ -36979,9 +36561,9 @@ interface Plugin {
36979
36561
  states: {
36980
36562
  [k: string]: {
36981
36563
  /**
36982
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
36564
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
36983
36565
  */
36984
- type: "conversation" | "user" | "bot" | "task";
36566
+ type: "conversation" | "user" | "bot";
36985
36567
  /**
36986
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.
36987
36569
  */
@@ -37280,6 +36862,12 @@ interface User {
37280
36862
  * Picture URL of the [User](#schema_user)
37281
36863
  */
37282
36864
  pictureUrl?: string;
36865
+ /**
36866
+ * Optional attributes
36867
+ */
36868
+ attributes?: {
36869
+ [k: string]: string;
36870
+ };
37283
36871
  }
37284
36872
  /**
37285
36873
  * The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
@@ -37290,7 +36878,8 @@ interface Conversation {
37290
36878
  */
37291
36879
  id: string;
37292
36880
  /**
37293
- * Id of the current [Task](#schema_task)
36881
+ * @deprecated
36882
+ * Unused. This field will be removed in the future.
37294
36883
  */
37295
36884
  currentTaskId?: string;
37296
36885
  /**
@@ -37442,9 +37031,9 @@ interface State {
37442
37031
  */
37443
37032
  name: string;
37444
37033
  /**
37445
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
37034
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
37446
37035
  */
37447
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
37036
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
37448
37037
  /**
37449
37038
  * Payload is the content of the state defined by your bot.
37450
37039
  */
@@ -37452,71 +37041,6 @@ interface State {
37452
37041
  [k: string]: any;
37453
37042
  };
37454
37043
  }
37455
- /**
37456
- * Task definition
37457
- */
37458
- interface Task {
37459
- /**
37460
- * Id of the [Task](#schema_task)
37461
- */
37462
- id: string;
37463
- /**
37464
- * Title describing the task
37465
- */
37466
- title: string;
37467
- /**
37468
- * All the notes related to the execution of the current task
37469
- */
37470
- description: string;
37471
- /**
37472
- * Type of the task
37473
- */
37474
- type: string;
37475
- /**
37476
- * Content related to the task
37477
- */
37478
- data: {
37479
- [k: string]: any;
37480
- };
37481
- /**
37482
- * Status of the task
37483
- */
37484
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
37485
- /**
37486
- * Parent task id is the parent task that created this task
37487
- */
37488
- parentTaskId?: string;
37489
- /**
37490
- * Conversation id related to this task
37491
- */
37492
- conversationId?: string;
37493
- /**
37494
- * Specific user related to this task
37495
- */
37496
- userId?: string;
37497
- /**
37498
- * The timeout date where the task should be failed in the ISO 8601 format
37499
- */
37500
- timeoutAt: string;
37501
- /**
37502
- * Creation date of the task in ISO 8601 format
37503
- */
37504
- createdAt: string;
37505
- /**
37506
- * Updating date of the task in ISO 8601 format
37507
- */
37508
- updatedAt: string;
37509
- /**
37510
- * If the task fails this is the reason behind it
37511
- */
37512
- failureReason?: string;
37513
- /**
37514
- * 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.
37515
- */
37516
- tags: {
37517
- [k: string]: string;
37518
- };
37519
- }
37520
37044
  /**
37521
37045
  * Workflow definition
37522
37046
  */
@@ -37938,11 +37462,6 @@ declare class Client$1 {
37938
37462
  readonly patchState: (input: PatchStateInput) => Promise<PatchStateResponse>;
37939
37463
  readonly callAction: (input: CallActionInput) => Promise<CallActionResponse>;
37940
37464
  readonly configureIntegration: (input: ConfigureIntegrationInput) => Promise<ConfigureIntegrationResponse>;
37941
- readonly getTask: (input: GetTaskInput) => Promise<GetTaskResponse>;
37942
- readonly createTask: (input: CreateTaskInput) => Promise<CreateTaskResponse>;
37943
- readonly updateTask: (input: UpdateTaskInput) => Promise<UpdateTaskResponse>;
37944
- readonly deleteTask: (input: DeleteTaskInput) => Promise<DeleteTaskResponse>;
37945
- readonly listTasks: (input: ListTasksInput) => Promise<ListTasksResponse>;
37946
37465
  readonly createWorkflow: (input: CreateWorkflowInput) => Promise<CreateWorkflowResponse>;
37947
37466
  readonly getWorkflow: (input: GetWorkflowInput) => Promise<GetWorkflowResponse>;
37948
37467
  readonly updateWorkflow: (input: UpdateWorkflowInput) => Promise<UpdateWorkflowResponse>;
@@ -38148,6 +37667,9 @@ declare class Client extends Client$1 implements IClient {
38148
37667
  };
38149
37668
  name?: string;
38150
37669
  pictureUrl?: string;
37670
+ attributes?: {
37671
+ [k: string]: string;
37672
+ };
38151
37673
  }>;
38152
37674
  events: (props: {
38153
37675
  status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
@@ -38211,33 +37733,7 @@ declare class Client extends Client$1 implements IClient {
38211
37733
  };
38212
37734
  name?: string;
38213
37735
  pictureUrl?: string;
38214
- }>;
38215
- tasks: (props: {
38216
- status?: ("timeout" | "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "cancelled")[] | undefined;
38217
- tags?: {
38218
- [x: string]: string;
38219
- } | undefined;
38220
- type?: string | undefined;
38221
- userId?: string | undefined;
38222
- conversationId?: string | undefined;
38223
- parentTaskId?: string | undefined;
38224
- }) => AsyncCollection<{
38225
- id: string;
38226
- title: string;
38227
- description: string;
38228
- type: string;
38229
- data: {
38230
- [k: string]: any;
38231
- };
38232
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
38233
- parentTaskId?: string;
38234
- conversationId?: string;
38235
- userId?: string;
38236
- timeoutAt: string;
38237
- createdAt: string;
38238
- updatedAt: string;
38239
- failureReason?: string;
38240
- tags: {
37736
+ attributes?: {
38241
37737
  [k: string]: string;
38242
37738
  };
38243
37739
  }>;
@@ -38281,6 +37777,9 @@ declare class Client extends Client$1 implements IClient {
38281
37777
  actions?: string[];
38282
37778
  interfaces?: string[];
38283
37779
  };
37780
+ attributes?: {
37781
+ [k: string]: string;
37782
+ };
38284
37783
  }>;
38285
37784
  bots: (props: {
38286
37785
  tags?: {
@@ -38364,6 +37863,9 @@ declare class Client extends Client$1 implements IClient {
38364
37863
  handle: string | null;
38365
37864
  name: string;
38366
37865
  };
37866
+ attributes?: {
37867
+ [k: string]: string;
37868
+ };
38367
37869
  }>;
38368
37870
  interfaces: (props: {
38369
37871
  name?: string | undefined;
@@ -38541,7 +38043,7 @@ declare class Client extends Client$1 implements IClient {
38541
38043
  conversationId?: string | undefined;
38542
38044
  name?: string | undefined;
38543
38045
  parentWorkflowId?: string | undefined;
38544
- statuses?: ("pending" | "failed" | "in_progress" | "completed" | "paused" | "cancelled" | "listening" | "timedout")[] | undefined;
38046
+ statuses?: ("pending" | "failed" | "in_progress" | "listening" | "completed" | "paused" | "timedout" | "cancelled")[] | undefined;
38545
38047
  }) => AsyncCollection<{
38546
38048
  id: string;
38547
38049
  name: string;
@@ -38806,4 +38308,4 @@ declare class UploadFileError extends Error {
38806
38308
  constructor(message: string, innerError?: AxiosError | undefined, file?: UpsertFileResponse["file"] | undefined);
38807
38309
  }
38808
38310
 
38809
- 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, type Task, 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 };
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 };