@botpress/client 1.39.0 → 1.41.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
@@ -96,6 +96,12 @@ interface CreateConversationRequestBody$1 {
96
96
  * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
97
97
  */
98
98
  integrationName?: string;
99
+ /**
100
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
101
+ */
102
+ properties?: {
103
+ [k: string]: string;
104
+ };
99
105
  }
100
106
  type CreateConversationInput$1 = CreateConversationRequestBody$1 & CreateConversationRequestHeaders$1 & CreateConversationRequestQuery$1 & CreateConversationRequestParams$1;
101
107
  interface CreateConversationResponse$1 {
@@ -142,6 +148,12 @@ interface CreateConversationResponse$1 {
142
148
  * Number of messages in the conversation
143
149
  */
144
150
  messageCount: number;
151
+ /**
152
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
153
+ */
154
+ properties?: {
155
+ [k: string]: string;
156
+ };
145
157
  };
146
158
  }
147
159
 
@@ -199,6 +211,12 @@ interface GetConversationResponse$1 {
199
211
  * Number of messages in the conversation
200
212
  */
201
213
  messageCount: number;
214
+ /**
215
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
216
+ */
217
+ properties?: {
218
+ [k: string]: string;
219
+ };
202
220
  };
203
221
  }
204
222
 
@@ -216,6 +234,8 @@ interface ListConversationsRequestQuery$1 {
216
234
  channel?: string;
217
235
  afterDate?: string;
218
236
  beforeDate?: string;
237
+ minMessageCount?: number;
238
+ maxMessageCount?: number;
219
239
  }
220
240
  interface ListConversationsRequestParams$1 {
221
241
  }
@@ -263,6 +283,12 @@ interface ListConversationsResponse$1 {
263
283
  * Number of messages in the conversation
264
284
  */
265
285
  messageCount: number;
286
+ /**
287
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
288
+ */
289
+ properties?: {
290
+ [k: string]: string;
291
+ };
266
292
  }[];
267
293
  meta: {
268
294
  /**
@@ -294,6 +320,12 @@ interface GetOrCreateConversationRequestBody$1 {
294
320
  * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
295
321
  */
296
322
  integrationName?: string;
323
+ /**
324
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
325
+ */
326
+ properties?: {
327
+ [k: string]: string;
328
+ };
297
329
  /**
298
330
  * Optional list of tag names to use for strict matching when looking up existing conversations. If provided, all specified tags must match exactly for a conversation to be considered a match. For example, with an existing conversation 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.
299
331
  */
@@ -344,6 +376,12 @@ interface GetOrCreateConversationResponse$1 {
344
376
  * Number of messages in the conversation
345
377
  */
346
378
  messageCount: number;
379
+ /**
380
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
381
+ */
382
+ properties?: {
383
+ [k: string]: string;
384
+ };
347
385
  };
348
386
  meta: {
349
387
  created: boolean;
@@ -369,6 +407,12 @@ interface UpdateConversationRequestBody$1 {
369
407
  tags?: {
370
408
  [k: string]: string;
371
409
  };
410
+ /**
411
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
412
+ */
413
+ properties?: {
414
+ [k: string]: string | null;
415
+ };
372
416
  }
373
417
  type UpdateConversationInput$1 = UpdateConversationRequestBody$1 & UpdateConversationRequestHeaders$1 & UpdateConversationRequestQuery$1 & UpdateConversationRequestParams$1;
374
418
  interface UpdateConversationResponse$1 {
@@ -415,6 +459,12 @@ interface UpdateConversationResponse$1 {
415
459
  * Number of messages in the conversation
416
460
  */
417
461
  messageCount: number;
462
+ /**
463
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
464
+ */
465
+ properties?: {
466
+ [k: string]: string;
467
+ };
418
468
  };
419
469
  }
420
470
 
@@ -1295,7 +1345,7 @@ interface InitializeIncomingMessageRequestBody$1 {
1295
1345
  */
1296
1346
  pictureUrl?: string;
1297
1347
  /**
1298
- * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1348
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1299
1349
  */
1300
1350
  properties?: {
1301
1351
  [k: string]: string;
@@ -1329,6 +1379,12 @@ interface InitializeIncomingMessageRequestBody$1 {
1329
1379
  * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
1330
1380
  */
1331
1381
  integrationName?: string;
1382
+ /**
1383
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1384
+ */
1385
+ properties?: {
1386
+ [k: string]: string;
1387
+ };
1332
1388
  /**
1333
1389
  * 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.
1334
1390
  */
@@ -1446,6 +1502,12 @@ interface InitializeIncomingMessageResponse$1 {
1446
1502
  * Number of messages in the conversation
1447
1503
  */
1448
1504
  messageCount: number;
1505
+ /**
1506
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1507
+ */
1508
+ properties?: {
1509
+ [k: string]: string;
1510
+ };
1449
1511
  };
1450
1512
  /**
1451
1513
  * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
@@ -1620,7 +1682,7 @@ interface CreateUserRequestBody$1 {
1620
1682
  */
1621
1683
  pictureUrl?: string;
1622
1684
  /**
1623
- * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1685
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1624
1686
  */
1625
1687
  properties?: {
1626
1688
  [k: string]: string;
@@ -1831,7 +1893,7 @@ interface GetOrCreateUserRequestBody$1 {
1831
1893
  */
1832
1894
  pictureUrl?: string;
1833
1895
  /**
1834
- * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1896
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1835
1897
  */
1836
1898
  properties?: {
1837
1899
  [k: string]: string;
@@ -1928,7 +1990,7 @@ interface UpdateUserRequestBody$1 {
1928
1990
  [k: string]: string | null;
1929
1991
  };
1930
1992
  /**
1931
- * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
1993
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
1932
1994
  */
1933
1995
  properties?: {
1934
1996
  [k: string]: string | null;
@@ -2053,6 +2115,14 @@ interface SetStateExpiryResponse$1 {
2053
2115
  payload: {
2054
2116
  [k: string]: any;
2055
2117
  };
2118
+ /**
2119
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2120
+ */
2121
+ expiry?: number;
2122
+ /**
2123
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2124
+ */
2125
+ expiresAt?: string;
2056
2126
  };
2057
2127
  }
2058
2128
 
@@ -2111,6 +2181,14 @@ interface GetStateResponse$1 {
2111
2181
  payload: {
2112
2182
  [k: string]: any;
2113
2183
  };
2184
+ /**
2185
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2186
+ */
2187
+ expiry?: number;
2188
+ /**
2189
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2190
+ */
2191
+ expiresAt?: string;
2114
2192
  };
2115
2193
  meta: {
2116
2194
  cached: boolean;
@@ -2182,6 +2260,14 @@ interface SetStateResponse$1 {
2182
2260
  payload: {
2183
2261
  [k: string]: any;
2184
2262
  };
2263
+ /**
2264
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2265
+ */
2266
+ expiry?: number;
2267
+ /**
2268
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2269
+ */
2270
+ expiresAt?: string;
2185
2271
  };
2186
2272
  }
2187
2273
 
@@ -2250,6 +2336,14 @@ interface GetOrSetStateResponse$1 {
2250
2336
  payload: {
2251
2337
  [k: string]: any;
2252
2338
  };
2339
+ /**
2340
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2341
+ */
2342
+ expiry?: number;
2343
+ /**
2344
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2345
+ */
2346
+ expiresAt?: string;
2253
2347
  };
2254
2348
  meta: {
2255
2349
  cached: boolean;
@@ -2272,6 +2366,10 @@ interface PatchStateRequestBody$1 {
2272
2366
  payload: {
2273
2367
  [k: string]: any;
2274
2368
  };
2369
+ /**
2370
+ * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
2371
+ */
2372
+ expiry?: number | null;
2275
2373
  }
2276
2374
  type PatchStateInput$1 = PatchStateRequestBody$1 & PatchStateRequestHeaders$1 & PatchStateRequestQuery$1 & PatchStateRequestParams$1;
2277
2375
  interface PatchStateResponse$1 {
@@ -2317,6 +2415,14 @@ interface PatchStateResponse$1 {
2317
2415
  payload: {
2318
2416
  [k: string]: any;
2319
2417
  };
2418
+ /**
2419
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2420
+ */
2421
+ expiry?: number;
2422
+ /**
2423
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2424
+ */
2425
+ expiresAt?: string;
2320
2426
  };
2321
2427
  }
2322
2428
 
@@ -3079,6 +3185,8 @@ declare class Client$a extends Client$b {
3079
3185
  participantIds?: string[] | undefined;
3080
3186
  afterDate?: string | undefined;
3081
3187
  beforeDate?: string | undefined;
3188
+ minMessageCount?: number | undefined;
3189
+ maxMessageCount?: number | undefined;
3082
3190
  }) => AsyncCollection<{
3083
3191
  id: string;
3084
3192
  currentTaskId?: string;
@@ -3091,6 +3199,9 @@ declare class Client$a extends Client$b {
3091
3199
  [k: string]: string;
3092
3200
  };
3093
3201
  messageCount: number;
3202
+ properties?: {
3203
+ [k: string]: string;
3204
+ };
3094
3205
  }>;
3095
3206
  participants: (props: {
3096
3207
  id: string;
@@ -5757,6 +5868,10 @@ interface CreateBotRequestBody$1 {
5757
5868
  * Type of the [Bot](#schema_bot)
5758
5869
  */
5759
5870
  type?: "studio" | "adk" | "desk";
5871
+ /**
5872
+ * Maximum execution time (in seconds).
5873
+ */
5874
+ maxExecutionTime?: number;
5760
5875
  }
5761
5876
  type CreateBotInput$1 = CreateBotRequestBody$1 & CreateBotRequestHeaders$1 & CreateBotRequestQuery$1 & CreateBotRequestParams$1;
5762
5877
  interface CreateBotResponse$1 {
@@ -6922,6 +7037,8 @@ interface ListBotsRequestQuery$1 {
6922
7037
  tags?: {
6923
7038
  [k: string]: string;
6924
7039
  };
7040
+ integrationNames?: string[];
7041
+ pluginNames?: string[];
6925
7042
  nextToken?: string;
6926
7043
  sortField?: "createdAt" | "updatedAt";
6927
7044
  sortDirection?: "asc" | "desc";
@@ -8118,7 +8235,7 @@ interface CreateWorkspaceResponse$1 {
8118
8235
  updatedAt: string;
8119
8236
  botCount: number;
8120
8237
  billingVersion: "v1" | "v2" | "v3" | "v4";
8121
- plan: "community" | "team" | "enterprise" | "plus";
8238
+ plan: "community" | "team" | "enterprise" | "plus" | "managed";
8122
8239
  blocked: boolean;
8123
8240
  spendingLimit: number;
8124
8241
  about?: string;
@@ -8172,7 +8289,7 @@ interface GetWorkspaceResponse$1 {
8172
8289
  updatedAt: string;
8173
8290
  botCount: number;
8174
8291
  billingVersion: "v1" | "v2" | "v3" | "v4";
8175
- plan: "community" | "team" | "enterprise" | "plus";
8292
+ plan: "community" | "team" | "enterprise" | "plus" | "managed";
8176
8293
  blocked: boolean;
8177
8294
  spendingLimit: number;
8178
8295
  about?: string;
@@ -8344,7 +8461,7 @@ interface UpdateWorkspaceResponse$3 {
8344
8461
  updatedAt: string;
8345
8462
  botCount: number;
8346
8463
  billingVersion: "v1" | "v2" | "v3" | "v4";
8347
- plan: "community" | "team" | "enterprise" | "plus";
8464
+ plan: "community" | "team" | "enterprise" | "plus" | "managed";
8348
8465
  blocked: boolean;
8349
8466
  spendingLimit: number;
8350
8467
  about?: string;
@@ -8401,7 +8518,7 @@ interface UpdateWorkspaceResponse$2 {
8401
8518
  updatedAt: string;
8402
8519
  botCount: number;
8403
8520
  billingVersion: "v1" | "v2" | "v3" | "v4";
8404
- plan: "community" | "team" | "enterprise" | "plus";
8521
+ plan: "community" | "team" | "enterprise" | "plus" | "managed";
8405
8522
  blocked: boolean;
8406
8523
  spendingLimit: number;
8407
8524
  about?: string;
@@ -15044,6 +15161,8 @@ declare class Client$8 extends Client$9 {
15044
15161
  sortField?: "createdAt" | "updatedAt" | undefined;
15045
15162
  sortDirection?: "asc" | "desc" | undefined;
15046
15163
  dev?: boolean | undefined;
15164
+ integrationNames?: string[] | undefined;
15165
+ pluginNames?: string[] | undefined;
15047
15166
  }) => AsyncCollection<{
15048
15167
  id: string;
15049
15168
  createdAt: string;
@@ -15343,8 +15462,11 @@ interface GetAddonResponse$1 {
15343
15462
  name: string;
15344
15463
  description: string;
15345
15464
  price: number;
15346
- feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions";
15465
+ feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "indexed_file_count" | "saved_versions";
15347
15466
  increment: number;
15467
+ increments?: {
15468
+ [k: string]: number;
15469
+ };
15348
15470
  metadata?: {
15349
15471
  [k: string]: string;
15350
15472
  };
@@ -15365,8 +15487,11 @@ interface GetAddonResponse {
15365
15487
  name: string;
15366
15488
  description: string;
15367
15489
  price: number;
15368
- feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions";
15490
+ feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "indexed_file_count" | "saved_versions";
15369
15491
  increment: number;
15492
+ increments?: {
15493
+ [k: string]: number;
15494
+ };
15370
15495
  metadata?: {
15371
15496
  [k: string]: string;
15372
15497
  };
@@ -15839,6 +15964,41 @@ type RemoveTrialInput = RemoveTrialRequestBody & RemoveTrialRequestHeaders & Rem
15839
15964
  interface RemoveTrialResponse {
15840
15965
  }
15841
15966
 
15967
+ interface CreateCreditGrantRequestHeaders {
15968
+ }
15969
+ interface CreateCreditGrantRequestQuery {
15970
+ }
15971
+ interface CreateCreditGrantRequestParams {
15972
+ }
15973
+ interface CreateCreditGrantRequestBody {
15974
+ /**
15975
+ * Nanodollar value of the credit grant (e.g. 10_000_000_000 = $10.00 USD)
15976
+ */
15977
+ amount: number;
15978
+ feature: "integration_spend";
15979
+ }
15980
+ type CreateCreditGrantInput = CreateCreditGrantRequestBody & CreateCreditGrantRequestHeaders & CreateCreditGrantRequestQuery & CreateCreditGrantRequestParams;
15981
+ interface CreateCreditGrantResponse {
15982
+ id: string;
15983
+ workspace_id: string;
15984
+ invoice_id: string;
15985
+ /**
15986
+ * Dollar value of the credit grant (e.g. 10 = $10.00 USD)
15987
+ */
15988
+ amount: number;
15989
+ feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "indexed_file_count" | "saved_versions";
15990
+ /**
15991
+ * Start of the period (inclusive)
15992
+ */
15993
+ period_start: string;
15994
+ /**
15995
+ * End of the period (exclusive)
15996
+ */
15997
+ period_end: string;
15998
+ updatedAt: string;
15999
+ createdAt: string;
16000
+ }
16001
+
15842
16002
  interface ListInvoicesRequestHeaders {
15843
16003
  }
15844
16004
  interface ListInvoicesRequestQuery {
@@ -15989,6 +16149,7 @@ declare class Client$7 {
15989
16149
  readonly getTrials: (input: GetTrialsInput) => Promise<GetTrialsResponse>;
15990
16150
  readonly createTrial: (input: CreateTrialInput) => Promise<CreateTrialResponse>;
15991
16151
  readonly removeTrial: (input: RemoveTrialInput) => Promise<RemoveTrialResponse>;
16152
+ readonly createCreditGrant: (input: CreateCreditGrantInput) => Promise<CreateCreditGrantResponse>;
15992
16153
  readonly listInvoices: (input: ListInvoicesInput) => Promise<ListInvoicesResponse>;
15993
16154
  readonly payInvoice: (input: PayInvoiceInput) => Promise<PayInvoiceResponse>;
15994
16155
  readonly getPaymentMethod: (input: GetPaymentMethodInput) => Promise<GetPaymentMethodResponse>;
@@ -19034,6 +19195,12 @@ interface CreateConversationRequestBody {
19034
19195
  * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
19035
19196
  */
19036
19197
  integrationName?: string;
19198
+ /**
19199
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
19200
+ */
19201
+ properties?: {
19202
+ [k: string]: string;
19203
+ };
19037
19204
  }
19038
19205
  type CreateConversationInput = CreateConversationRequestBody & CreateConversationRequestHeaders & CreateConversationRequestQuery & CreateConversationRequestParams;
19039
19206
  interface CreateConversationResponse {
@@ -19080,6 +19247,12 @@ interface CreateConversationResponse {
19080
19247
  * Number of messages in the conversation
19081
19248
  */
19082
19249
  messageCount: number;
19250
+ /**
19251
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
19252
+ */
19253
+ properties?: {
19254
+ [k: string]: string;
19255
+ };
19083
19256
  };
19084
19257
  }
19085
19258
 
@@ -19137,6 +19310,12 @@ interface GetConversationResponse {
19137
19310
  * Number of messages in the conversation
19138
19311
  */
19139
19312
  messageCount: number;
19313
+ /**
19314
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
19315
+ */
19316
+ properties?: {
19317
+ [k: string]: string;
19318
+ };
19140
19319
  };
19141
19320
  }
19142
19321
 
@@ -19154,6 +19333,8 @@ interface ListConversationsRequestQuery {
19154
19333
  channel?: string;
19155
19334
  afterDate?: string;
19156
19335
  beforeDate?: string;
19336
+ minMessageCount?: number;
19337
+ maxMessageCount?: number;
19157
19338
  }
19158
19339
  interface ListConversationsRequestParams {
19159
19340
  }
@@ -19201,6 +19382,12 @@ interface ListConversationsResponse {
19201
19382
  * Number of messages in the conversation
19202
19383
  */
19203
19384
  messageCount: number;
19385
+ /**
19386
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
19387
+ */
19388
+ properties?: {
19389
+ [k: string]: string;
19390
+ };
19204
19391
  }[];
19205
19392
  meta: {
19206
19393
  /**
@@ -19232,6 +19419,12 @@ interface GetOrCreateConversationRequestBody {
19232
19419
  * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
19233
19420
  */
19234
19421
  integrationName?: string;
19422
+ /**
19423
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
19424
+ */
19425
+ properties?: {
19426
+ [k: string]: string;
19427
+ };
19235
19428
  /**
19236
19429
  * Optional list of tag names to use for strict matching when looking up existing conversations. If provided, all specified tags must match exactly for a conversation to be considered a match. For example, with an existing conversation 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.
19237
19430
  */
@@ -19282,6 +19475,12 @@ interface GetOrCreateConversationResponse {
19282
19475
  * Number of messages in the conversation
19283
19476
  */
19284
19477
  messageCount: number;
19478
+ /**
19479
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
19480
+ */
19481
+ properties?: {
19482
+ [k: string]: string;
19483
+ };
19285
19484
  };
19286
19485
  meta: {
19287
19486
  created: boolean;
@@ -19307,6 +19506,12 @@ interface UpdateConversationRequestBody {
19307
19506
  tags?: {
19308
19507
  [k: string]: string;
19309
19508
  };
19509
+ /**
19510
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
19511
+ */
19512
+ properties?: {
19513
+ [k: string]: string | null;
19514
+ };
19310
19515
  }
19311
19516
  type UpdateConversationInput = UpdateConversationRequestBody & UpdateConversationRequestHeaders & UpdateConversationRequestQuery & UpdateConversationRequestParams;
19312
19517
  interface UpdateConversationResponse {
@@ -19353,6 +19558,12 @@ interface UpdateConversationResponse {
19353
19558
  * Number of messages in the conversation
19354
19559
  */
19355
19560
  messageCount: number;
19561
+ /**
19562
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
19563
+ */
19564
+ properties?: {
19565
+ [k: string]: string;
19566
+ };
19356
19567
  };
19357
19568
  }
19358
19569
 
@@ -20233,7 +20444,7 @@ interface InitializeIncomingMessageRequestBody {
20233
20444
  */
20234
20445
  pictureUrl?: string;
20235
20446
  /**
20236
- * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20447
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20237
20448
  */
20238
20449
  properties?: {
20239
20450
  [k: string]: string;
@@ -20267,6 +20478,12 @@ interface InitializeIncomingMessageRequestBody {
20267
20478
  * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
20268
20479
  */
20269
20480
  integrationName?: string;
20481
+ /**
20482
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20483
+ */
20484
+ properties?: {
20485
+ [k: string]: string;
20486
+ };
20270
20487
  /**
20271
20488
  * 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.
20272
20489
  */
@@ -20384,6 +20601,12 @@ interface InitializeIncomingMessageResponse {
20384
20601
  * Number of messages in the conversation
20385
20602
  */
20386
20603
  messageCount: number;
20604
+ /**
20605
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20606
+ */
20607
+ properties?: {
20608
+ [k: string]: string;
20609
+ };
20387
20610
  };
20388
20611
  /**
20389
20612
  * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
@@ -20558,7 +20781,7 @@ interface CreateUserRequestBody {
20558
20781
  */
20559
20782
  pictureUrl?: string;
20560
20783
  /**
20561
- * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20784
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20562
20785
  */
20563
20786
  properties?: {
20564
20787
  [k: string]: string;
@@ -20769,7 +20992,7 @@ interface GetOrCreateUserRequestBody {
20769
20992
  */
20770
20993
  pictureUrl?: string;
20771
20994
  /**
20772
- * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20995
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20773
20996
  */
20774
20997
  properties?: {
20775
20998
  [k: string]: string;
@@ -20866,7 +21089,7 @@ interface UpdateUserRequestBody {
20866
21089
  [k: string]: string | null;
20867
21090
  };
20868
21091
  /**
20869
- * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
21092
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
20870
21093
  */
20871
21094
  properties?: {
20872
21095
  [k: string]: string | null;
@@ -20991,6 +21214,14 @@ interface SetStateExpiryResponse {
20991
21214
  payload: {
20992
21215
  [k: string]: any;
20993
21216
  };
21217
+ /**
21218
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21219
+ */
21220
+ expiry?: number;
21221
+ /**
21222
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21223
+ */
21224
+ expiresAt?: string;
20994
21225
  };
20995
21226
  }
20996
21227
 
@@ -21049,6 +21280,14 @@ interface GetStateResponse {
21049
21280
  payload: {
21050
21281
  [k: string]: any;
21051
21282
  };
21283
+ /**
21284
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21285
+ */
21286
+ expiry?: number;
21287
+ /**
21288
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21289
+ */
21290
+ expiresAt?: string;
21052
21291
  };
21053
21292
  meta: {
21054
21293
  cached: boolean;
@@ -21120,6 +21359,14 @@ interface SetStateResponse {
21120
21359
  payload: {
21121
21360
  [k: string]: any;
21122
21361
  };
21362
+ /**
21363
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21364
+ */
21365
+ expiry?: number;
21366
+ /**
21367
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21368
+ */
21369
+ expiresAt?: string;
21123
21370
  };
21124
21371
  }
21125
21372
 
@@ -21188,6 +21435,14 @@ interface GetOrSetStateResponse {
21188
21435
  payload: {
21189
21436
  [k: string]: any;
21190
21437
  };
21438
+ /**
21439
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21440
+ */
21441
+ expiry?: number;
21442
+ /**
21443
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21444
+ */
21445
+ expiresAt?: string;
21191
21446
  };
21192
21447
  meta: {
21193
21448
  cached: boolean;
@@ -21210,6 +21465,10 @@ interface PatchStateRequestBody {
21210
21465
  payload: {
21211
21466
  [k: string]: any;
21212
21467
  };
21468
+ /**
21469
+ * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
21470
+ */
21471
+ expiry?: number | null;
21213
21472
  }
21214
21473
  type PatchStateInput = PatchStateRequestBody & PatchStateRequestHeaders & PatchStateRequestQuery & PatchStateRequestParams;
21215
21474
  interface PatchStateResponse {
@@ -21255,6 +21514,14 @@ interface PatchStateResponse {
21255
21514
  payload: {
21256
21515
  [k: string]: any;
21257
21516
  };
21517
+ /**
21518
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21519
+ */
21520
+ expiry?: number;
21521
+ /**
21522
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21523
+ */
21524
+ expiresAt?: string;
21258
21525
  };
21259
21526
  }
21260
21527
 
@@ -24492,6 +24759,10 @@ interface CreateBotRequestBody {
24492
24759
  * Type of the [Bot](#schema_bot)
24493
24760
  */
24494
24761
  type?: "studio" | "adk" | "desk";
24762
+ /**
24763
+ * Maximum execution time (in seconds).
24764
+ */
24765
+ maxExecutionTime?: number;
24495
24766
  }
24496
24767
  type CreateBotInput = CreateBotRequestBody & CreateBotRequestHeaders & CreateBotRequestQuery & CreateBotRequestParams;
24497
24768
  interface CreateBotResponse {
@@ -25657,6 +25928,8 @@ interface ListBotsRequestQuery {
25657
25928
  tags?: {
25658
25929
  [k: string]: string;
25659
25930
  };
25931
+ integrationNames?: string[];
25932
+ pluginNames?: string[];
25660
25933
  nextToken?: string;
25661
25934
  sortField?: "createdAt" | "updatedAt";
25662
25935
  sortDirection?: "asc" | "desc";
@@ -26853,7 +27126,7 @@ interface CreateWorkspaceResponse {
26853
27126
  updatedAt: string;
26854
27127
  botCount: number;
26855
27128
  billingVersion: "v1" | "v2" | "v3" | "v4";
26856
- plan: "community" | "team" | "enterprise" | "plus";
27129
+ plan: "community" | "team" | "enterprise" | "plus" | "managed";
26857
27130
  blocked: boolean;
26858
27131
  spendingLimit: number;
26859
27132
  about?: string;
@@ -26907,7 +27180,7 @@ interface GetWorkspaceResponse {
26907
27180
  updatedAt: string;
26908
27181
  botCount: number;
26909
27182
  billingVersion: "v1" | "v2" | "v3" | "v4";
26910
- plan: "community" | "team" | "enterprise" | "plus";
27183
+ plan: "community" | "team" | "enterprise" | "plus" | "managed";
26911
27184
  blocked: boolean;
26912
27185
  spendingLimit: number;
26913
27186
  about?: string;
@@ -27079,7 +27352,7 @@ interface UpdateWorkspaceResponse$1 {
27079
27352
  updatedAt: string;
27080
27353
  botCount: number;
27081
27354
  billingVersion: "v1" | "v2" | "v3" | "v4";
27082
- plan: "community" | "team" | "enterprise" | "plus";
27355
+ plan: "community" | "team" | "enterprise" | "plus" | "managed";
27083
27356
  blocked: boolean;
27084
27357
  spendingLimit: number;
27085
27358
  about?: string;
@@ -27136,7 +27409,7 @@ interface UpdateWorkspaceResponse {
27136
27409
  updatedAt: string;
27137
27410
  botCount: number;
27138
27411
  billingVersion: "v1" | "v2" | "v3" | "v4";
27139
- plan: "community" | "team" | "enterprise" | "plus";
27412
+ plan: "community" | "team" | "enterprise" | "plus" | "managed";
27140
27413
  blocked: boolean;
27141
27414
  spendingLimit: number;
27142
27415
  about?: string;
@@ -37568,7 +37841,7 @@ interface Workspace {
37568
37841
  updatedAt: string;
37569
37842
  botCount: number;
37570
37843
  billingVersion: "v1" | "v2" | "v3" | "v4";
37571
- plan: "community" | "team" | "enterprise" | "plus";
37844
+ plan: "community" | "team" | "enterprise" | "plus" | "managed";
37572
37845
  blocked: boolean;
37573
37846
  spendingLimit: number;
37574
37847
  about?: string;
@@ -37753,6 +38026,12 @@ interface Conversation {
37753
38026
  * Number of messages in the conversation
37754
38027
  */
37755
38028
  messageCount: number;
38029
+ /**
38030
+ * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
38031
+ */
38032
+ properties?: {
38033
+ [k: string]: string;
38034
+ };
37756
38035
  }
37757
38036
  /**
37758
38037
  * The event object represents an action or an occurrence.
@@ -37885,6 +38164,14 @@ interface State {
37885
38164
  payload: {
37886
38165
  [k: string]: any;
37887
38166
  };
38167
+ /**
38168
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
38169
+ */
38170
+ expiry?: number;
38171
+ /**
38172
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
38173
+ */
38174
+ expiresAt?: string;
37888
38175
  }
37889
38176
  /**
37890
38177
  * Workflow definition
@@ -38490,6 +38777,8 @@ declare class Client extends Client$1 implements IClient {
38490
38777
  participantIds?: string[] | undefined;
38491
38778
  afterDate?: string | undefined;
38492
38779
  beforeDate?: string | undefined;
38780
+ minMessageCount?: number | undefined;
38781
+ maxMessageCount?: number | undefined;
38493
38782
  }) => AsyncCollection<{
38494
38783
  id: string;
38495
38784
  currentTaskId?: string;
@@ -38502,6 +38791,9 @@ declare class Client extends Client$1 implements IClient {
38502
38791
  [k: string]: string;
38503
38792
  };
38504
38793
  messageCount: number;
38794
+ properties?: {
38795
+ [k: string]: string;
38796
+ };
38505
38797
  }>;
38506
38798
  participants: (props: {
38507
38799
  id: string;
@@ -38641,6 +38933,8 @@ declare class Client extends Client$1 implements IClient {
38641
38933
  sortField?: "createdAt" | "updatedAt" | undefined;
38642
38934
  sortDirection?: "asc" | "desc" | undefined;
38643
38935
  dev?: boolean | undefined;
38936
+ integrationNames?: string[] | undefined;
38937
+ pluginNames?: string[] | undefined;
38644
38938
  }) => AsyncCollection<{
38645
38939
  id: string;
38646
38940
  createdAt: string;