@botpress/client 1.36.0 → 1.37.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
@@ -138,6 +138,10 @@ interface CreateConversationResponse$1 {
138
138
  tags: {
139
139
  [k: string]: string;
140
140
  };
141
+ /**
142
+ * Number of messages in the conversation
143
+ */
144
+ messageCount: number;
141
145
  };
142
146
  }
143
147
 
@@ -191,6 +195,10 @@ interface GetConversationResponse$1 {
191
195
  tags: {
192
196
  [k: string]: string;
193
197
  };
198
+ /**
199
+ * Number of messages in the conversation
200
+ */
201
+ messageCount: number;
194
202
  };
195
203
  }
196
204
 
@@ -251,6 +259,10 @@ interface ListConversationsResponse$1 {
251
259
  tags: {
252
260
  [k: string]: string;
253
261
  };
262
+ /**
263
+ * Number of messages in the conversation
264
+ */
265
+ messageCount: number;
254
266
  }[];
255
267
  meta: {
256
268
  /**
@@ -328,6 +340,13 @@ interface GetOrCreateConversationResponse$1 {
328
340
  tags: {
329
341
  [k: string]: string;
330
342
  };
343
+ /**
344
+ * Number of messages in the conversation
345
+ */
346
+ messageCount: number;
347
+ };
348
+ meta: {
349
+ created: boolean;
331
350
  };
332
351
  }
333
352
 
@@ -392,6 +411,10 @@ interface UpdateConversationResponse$1 {
392
411
  tags: {
393
412
  [k: string]: string;
394
413
  };
414
+ /**
415
+ * Number of messages in the conversation
416
+ */
417
+ messageCount: number;
395
418
  };
396
419
  }
397
420
 
@@ -447,6 +470,12 @@ interface ListParticipantsResponse$1 {
447
470
  * Picture URL of the [User](#schema_user)
448
471
  */
449
472
  pictureUrl?: string;
473
+ /**
474
+ * Optional properties
475
+ */
476
+ properties?: {
477
+ [k: string]: string;
478
+ };
450
479
  /**
451
480
  * Optional attributes
452
481
  */
@@ -507,6 +536,12 @@ interface AddParticipantResponse$1 {
507
536
  * Picture URL of the [User](#schema_user)
508
537
  */
509
538
  pictureUrl?: string;
539
+ /**
540
+ * Optional properties
541
+ */
542
+ properties?: {
543
+ [k: string]: string;
544
+ };
510
545
  /**
511
546
  * Optional attributes
512
547
  */
@@ -558,6 +593,12 @@ interface GetParticipantResponse$1 {
558
593
  * Picture URL of the [User](#schema_user)
559
594
  */
560
595
  pictureUrl?: string;
596
+ /**
597
+ * Optional properties
598
+ */
599
+ properties?: {
600
+ [k: string]: string;
601
+ };
561
602
  /**
562
603
  * Optional attributes
563
604
  */
@@ -909,7 +950,7 @@ interface GetOrCreateMessageRequestBody$1 {
909
950
  /**
910
951
  * Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
911
952
  */
912
- payload: {
953
+ payload?: {
913
954
  [k: string]: any;
914
955
  };
915
956
  /**
@@ -1000,6 +1041,9 @@ interface GetOrCreateMessageResponse$1 {
1000
1041
  */
1001
1042
  origin?: "synthetic";
1002
1043
  };
1044
+ meta: {
1045
+ created: boolean;
1046
+ };
1003
1047
  }
1004
1048
 
1005
1049
  interface GetMessageRequestHeaders$1 {
@@ -1251,7 +1295,14 @@ interface InitializeIncomingMessageRequestBody$1 {
1251
1295
  */
1252
1296
  pictureUrl?: string;
1253
1297
  /**
1254
- * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
1298
+ * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1299
+ */
1300
+ properties?: {
1301
+ [k: string]: string;
1302
+ };
1303
+ /**
1304
+ * @deprecated
1305
+ * DEPRECATED - Use properties instead.
1255
1306
  */
1256
1307
  attributes?: {
1257
1308
  [k: string]: string;
@@ -1339,6 +1390,12 @@ interface InitializeIncomingMessageResponse$1 {
1339
1390
  * Picture URL of the [User](#schema_user)
1340
1391
  */
1341
1392
  pictureUrl?: string;
1393
+ /**
1394
+ * Optional properties
1395
+ */
1396
+ properties?: {
1397
+ [k: string]: string;
1398
+ };
1342
1399
  /**
1343
1400
  * Optional attributes
1344
1401
  */
@@ -1385,6 +1442,10 @@ interface InitializeIncomingMessageResponse$1 {
1385
1442
  tags: {
1386
1443
  [k: string]: string;
1387
1444
  };
1445
+ /**
1446
+ * Number of messages in the conversation
1447
+ */
1448
+ messageCount: number;
1388
1449
  };
1389
1450
  /**
1390
1451
  * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
@@ -1559,7 +1620,14 @@ interface CreateUserRequestBody$1 {
1559
1620
  */
1560
1621
  pictureUrl?: string;
1561
1622
  /**
1562
- * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
1623
+ * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1624
+ */
1625
+ properties?: {
1626
+ [k: string]: string;
1627
+ };
1628
+ /**
1629
+ * @deprecated
1630
+ * DEPRECATED - Use properties instead.
1563
1631
  */
1564
1632
  attributes?: {
1565
1633
  [k: string]: string;
@@ -1597,6 +1665,12 @@ interface CreateUserResponse$1 {
1597
1665
  * Picture URL of the [User](#schema_user)
1598
1666
  */
1599
1667
  pictureUrl?: string;
1668
+ /**
1669
+ * Optional properties
1670
+ */
1671
+ properties?: {
1672
+ [k: string]: string;
1673
+ };
1600
1674
  /**
1601
1675
  * Optional attributes
1602
1676
  */
@@ -1647,6 +1721,12 @@ interface GetUserResponse$1 {
1647
1721
  * Picture URL of the [User](#schema_user)
1648
1722
  */
1649
1723
  pictureUrl?: string;
1724
+ /**
1725
+ * Optional properties
1726
+ */
1727
+ properties?: {
1728
+ [k: string]: string;
1729
+ };
1650
1730
  /**
1651
1731
  * Optional attributes
1652
1732
  */
@@ -1703,6 +1783,12 @@ interface ListUsersResponse$1 {
1703
1783
  * Picture URL of the [User](#schema_user)
1704
1784
  */
1705
1785
  pictureUrl?: string;
1786
+ /**
1787
+ * Optional properties
1788
+ */
1789
+ properties?: {
1790
+ [k: string]: string;
1791
+ };
1706
1792
  /**
1707
1793
  * Optional attributes
1708
1794
  */
@@ -1745,7 +1831,14 @@ interface GetOrCreateUserRequestBody$1 {
1745
1831
  */
1746
1832
  pictureUrl?: string;
1747
1833
  /**
1748
- * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
1834
+ * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
1835
+ */
1836
+ properties?: {
1837
+ [k: string]: string;
1838
+ };
1839
+ /**
1840
+ * @deprecated
1841
+ * DEPRECATED - Use properties instead.
1749
1842
  */
1750
1843
  attributes?: {
1751
1844
  [k: string]: string;
@@ -1787,6 +1880,12 @@ interface GetOrCreateUserResponse$1 {
1787
1880
  * Picture URL of the [User](#schema_user)
1788
1881
  */
1789
1882
  pictureUrl?: string;
1883
+ /**
1884
+ * Optional properties
1885
+ */
1886
+ properties?: {
1887
+ [k: string]: string;
1888
+ };
1790
1889
  /**
1791
1890
  * Optional attributes
1792
1891
  */
@@ -1794,6 +1893,9 @@ interface GetOrCreateUserResponse$1 {
1794
1893
  [k: string]: string;
1795
1894
  };
1796
1895
  };
1896
+ meta: {
1897
+ created: boolean;
1898
+ };
1797
1899
  }
1798
1900
 
1799
1901
  interface UpdateUserRequestHeaders$1 {
@@ -1819,11 +1921,18 @@ interface UpdateUserRequestBody$1 {
1819
1921
  */
1820
1922
  pictureUrl?: string | null;
1821
1923
  /**
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.
1924
+ * @deprecated
1925
+ * DEPRECATED - Use properties instead.
1823
1926
  */
1824
1927
  attributes?: {
1825
1928
  [k: string]: string | null;
1826
1929
  };
1930
+ /**
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.
1932
+ */
1933
+ properties?: {
1934
+ [k: string]: string | null;
1935
+ };
1827
1936
  }
1828
1937
  type UpdateUserInput$1 = UpdateUserRequestBody$1 & UpdateUserRequestHeaders$1 & UpdateUserRequestQuery$1 & UpdateUserRequestParams$1;
1829
1938
  interface UpdateUserResponse$1 {
@@ -1857,6 +1966,12 @@ interface UpdateUserResponse$1 {
1857
1966
  * Picture URL of the [User](#schema_user)
1858
1967
  */
1859
1968
  pictureUrl?: string;
1969
+ /**
1970
+ * Optional properties
1971
+ */
1972
+ properties?: {
1973
+ [k: string]: string;
1974
+ };
1860
1975
  /**
1861
1976
  * Optional attributes
1862
1977
  */
@@ -2975,6 +3090,7 @@ declare class Client$a extends Client$b {
2975
3090
  tags: {
2976
3091
  [k: string]: string;
2977
3092
  };
3093
+ messageCount: number;
2978
3094
  }>;
2979
3095
  participants: (props: {
2980
3096
  id: string;
@@ -2987,6 +3103,9 @@ declare class Client$a extends Client$b {
2987
3103
  };
2988
3104
  name?: string;
2989
3105
  pictureUrl?: string;
3106
+ properties?: {
3107
+ [k: string]: string;
3108
+ };
2990
3109
  attributes?: {
2991
3110
  [k: string]: string;
2992
3111
  };
@@ -3053,6 +3172,9 @@ declare class Client$a extends Client$b {
3053
3172
  };
3054
3173
  name?: string;
3055
3174
  pictureUrl?: string;
3175
+ properties?: {
3176
+ [k: string]: string;
3177
+ };
3056
3178
  attributes?: {
3057
3179
  [k: string]: string;
3058
3180
  };
@@ -4457,6 +4579,26 @@ interface GetPublicPluginByIdResponse$1 {
4457
4579
  };
4458
4580
  };
4459
4581
  };
4582
+ /**
4583
+ * Message object configuration
4584
+ */
4585
+ message: {
4586
+ tags: {
4587
+ /**
4588
+ * Definition of a tag that can be provided on the object
4589
+ */
4590
+ [k: string]: {
4591
+ /**
4592
+ * Title of the tag
4593
+ */
4594
+ title?: string;
4595
+ /**
4596
+ * Description of the tag
4597
+ */
4598
+ description?: string;
4599
+ };
4600
+ };
4601
+ };
4460
4602
  /**
4461
4603
  * Optional attributes
4462
4604
  */
@@ -4686,6 +4828,26 @@ interface GetDereferencedPublicPluginByIdResponse$1 {
4686
4828
  };
4687
4829
  };
4688
4830
  };
4831
+ /**
4832
+ * Message object configuration
4833
+ */
4834
+ message: {
4835
+ tags: {
4836
+ /**
4837
+ * Definition of a tag that can be provided on the object
4838
+ */
4839
+ [k: string]: {
4840
+ /**
4841
+ * Title of the tag
4842
+ */
4843
+ title?: string;
4844
+ /**
4845
+ * Description of the tag
4846
+ */
4847
+ description?: string;
4848
+ };
4849
+ };
4850
+ };
4689
4851
  /**
4690
4852
  * Optional attributes
4691
4853
  */
@@ -4907,6 +5069,26 @@ interface GetPublicPluginResponse$1 {
4907
5069
  };
4908
5070
  };
4909
5071
  };
5072
+ /**
5073
+ * Message object configuration
5074
+ */
5075
+ message: {
5076
+ tags: {
5077
+ /**
5078
+ * Definition of a tag that can be provided on the object
5079
+ */
5080
+ [k: string]: {
5081
+ /**
5082
+ * Title of the tag
5083
+ */
5084
+ title?: string;
5085
+ /**
5086
+ * Description of the tag
5087
+ */
5088
+ description?: string;
5089
+ };
5090
+ };
5091
+ };
4910
5092
  /**
4911
5093
  * Optional attributes
4912
5094
  */
@@ -12758,6 +12940,26 @@ interface CreatePluginRequestBody$1 {
12758
12940
  };
12759
12941
  };
12760
12942
  };
12943
+ /**
12944
+ * Message object configuration
12945
+ */
12946
+ message?: {
12947
+ tags: {
12948
+ /**
12949
+ * Definition of a tag that can be provided on the object
12950
+ */
12951
+ [k: string]: {
12952
+ /**
12953
+ * Title of the tag
12954
+ */
12955
+ title?: string;
12956
+ /**
12957
+ * Description of the tag
12958
+ */
12959
+ description?: string;
12960
+ };
12961
+ };
12962
+ };
12761
12963
  /**
12762
12964
  * Optional attributes
12763
12965
  */
@@ -13014,6 +13216,26 @@ interface CreatePluginResponse$1 {
13014
13216
  };
13015
13217
  };
13016
13218
  };
13219
+ /**
13220
+ * Message object configuration
13221
+ */
13222
+ message: {
13223
+ tags: {
13224
+ /**
13225
+ * Definition of a tag that can be provided on the object
13226
+ */
13227
+ [k: string]: {
13228
+ /**
13229
+ * Title of the tag
13230
+ */
13231
+ title?: string;
13232
+ /**
13233
+ * Description of the tag
13234
+ */
13235
+ description?: string;
13236
+ };
13237
+ };
13238
+ };
13017
13239
  /**
13018
13240
  * Optional attributes
13019
13241
  */
@@ -13234,6 +13456,26 @@ interface GetPluginResponse$1 {
13234
13456
  };
13235
13457
  };
13236
13458
  };
13459
+ /**
13460
+ * Message object configuration
13461
+ */
13462
+ message: {
13463
+ tags: {
13464
+ /**
13465
+ * Definition of a tag that can be provided on the object
13466
+ */
13467
+ [k: string]: {
13468
+ /**
13469
+ * Title of the tag
13470
+ */
13471
+ title?: string;
13472
+ /**
13473
+ * Description of the tag
13474
+ */
13475
+ description?: string;
13476
+ };
13477
+ };
13478
+ };
13237
13479
  /**
13238
13480
  * Optional attributes
13239
13481
  */
@@ -13463,6 +13705,26 @@ interface GetDereferencedPluginResponse$1 {
13463
13705
  };
13464
13706
  };
13465
13707
  };
13708
+ /**
13709
+ * Message object configuration
13710
+ */
13711
+ message: {
13712
+ tags: {
13713
+ /**
13714
+ * Definition of a tag that can be provided on the object
13715
+ */
13716
+ [k: string]: {
13717
+ /**
13718
+ * Title of the tag
13719
+ */
13720
+ title?: string;
13721
+ /**
13722
+ * Description of the tag
13723
+ */
13724
+ description?: string;
13725
+ };
13726
+ };
13727
+ };
13466
13728
  /**
13467
13729
  * Optional attributes
13468
13730
  */
@@ -13684,6 +13946,26 @@ interface GetPluginByNameResponse$1 {
13684
13946
  };
13685
13947
  };
13686
13948
  };
13949
+ /**
13950
+ * Message object configuration
13951
+ */
13952
+ message: {
13953
+ tags: {
13954
+ /**
13955
+ * Definition of a tag that can be provided on the object
13956
+ */
13957
+ [k: string]: {
13958
+ /**
13959
+ * Title of the tag
13960
+ */
13961
+ title?: string;
13962
+ /**
13963
+ * Description of the tag
13964
+ */
13965
+ description?: string;
13966
+ };
13967
+ };
13968
+ };
13687
13969
  /**
13688
13970
  * Optional attributes
13689
13971
  */
@@ -13852,6 +14134,23 @@ interface UpdatePluginRequestBody$1 {
13852
14134
  } | null;
13853
14135
  };
13854
14136
  };
14137
+ message?: {
14138
+ tags: {
14139
+ /**
14140
+ * Definition of a tag that can be provided on the object
14141
+ */
14142
+ [k: string]: {
14143
+ /**
14144
+ * Title of the tag
14145
+ */
14146
+ title?: string;
14147
+ /**
14148
+ * Description of the tag
14149
+ */
14150
+ description?: string;
14151
+ } | null;
14152
+ };
14153
+ };
13855
14154
  /**
13856
14155
  * Optional attributes. Set attributes to null to remove them
13857
14156
  */
@@ -14108,6 +14407,26 @@ interface UpdatePluginResponse$1 {
14108
14407
  };
14109
14408
  };
14110
14409
  };
14410
+ /**
14411
+ * Message object configuration
14412
+ */
14413
+ message: {
14414
+ tags: {
14415
+ /**
14416
+ * Definition of a tag that can be provided on the object
14417
+ */
14418
+ [k: string]: {
14419
+ /**
14420
+ * Title of the tag
14421
+ */
14422
+ title?: string;
14423
+ /**
14424
+ * Description of the tag
14425
+ */
14426
+ description?: string;
14427
+ };
14428
+ };
14429
+ };
14111
14430
  /**
14112
14431
  * Optional attributes
14113
14432
  */
@@ -14854,12 +15173,12 @@ interface GetBillingAddressRequestBody {
14854
15173
  type GetBillingAddressInput = GetBillingAddressRequestBody & GetBillingAddressRequestHeaders & GetBillingAddressRequestQuery & GetBillingAddressRequestParams;
14855
15174
  interface GetBillingAddressResponse {
14856
15175
  address: {
14857
- lineOne?: string;
15176
+ lineOne: string;
14858
15177
  lineTwo?: string;
14859
- city?: string;
15178
+ city: string;
14860
15179
  state?: string;
14861
- postalCode?: string;
14862
- country?: string;
15180
+ postalCode: string;
15181
+ country: string;
14863
15182
  } | null;
14864
15183
  }
14865
15184
 
@@ -14870,12 +15189,12 @@ interface SetBillingAddressRequestQuery {
14870
15189
  interface SetBillingAddressRequestParams {
14871
15190
  }
14872
15191
  interface SetBillingAddressRequestBody {
14873
- lineOne?: string;
15192
+ lineOne: string;
14874
15193
  lineTwo?: string;
14875
- city?: string;
15194
+ city: string;
14876
15195
  state?: string;
14877
- postalCode?: string;
14878
- country?: string;
15196
+ postalCode: string;
15197
+ country: string;
14879
15198
  }
14880
15199
  type SetBillingAddressInput = SetBillingAddressRequestBody & SetBillingAddressRequestHeaders & SetBillingAddressRequestQuery & SetBillingAddressRequestParams;
14881
15200
  interface SetBillingAddressResponse {
@@ -15071,6 +15390,7 @@ interface PreviewSubscriptionUpdateResponse {
15071
15390
  [k: string]: {
15072
15391
  quantity: number;
15073
15392
  effectiveDate: string;
15393
+ autoAdjusted?: boolean;
15074
15394
  };
15075
15395
  };
15076
15396
  };
@@ -17692,9 +18012,13 @@ interface DuplicateTableResponse$1 {
17692
18012
  updatedAt?: string;
17693
18013
  };
17694
18014
  /**
17695
- * The total number of rows present in the table.
18015
+ * The total number of rows present in the source table.
17696
18016
  */
17697
18017
  rows: number;
18018
+ job?: {
18019
+ id: string;
18020
+ status: string;
18021
+ };
17698
18022
  }
17699
18023
 
17700
18024
  interface ExportTableRequestHeaders$1 {
@@ -17714,7 +18038,7 @@ interface ExportTableResponse$1 {
17714
18038
  id: string;
17715
18039
  botId: string;
17716
18040
  tableId: string;
17717
- type: "export" | "import" | "clear_column" | "clear_vectors";
18041
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
17718
18042
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
17719
18043
  progress?: number;
17720
18044
  inputFileId: string | null;
@@ -17739,7 +18063,7 @@ interface GetTableJobsResponse$1 {
17739
18063
  id: string;
17740
18064
  botId: string;
17741
18065
  tableId: string;
17742
- type: "export" | "import" | "clear_column" | "clear_vectors";
18066
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
17743
18067
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
17744
18068
  progress?: number;
17745
18069
  inputFileId: string | null;
@@ -17768,7 +18092,7 @@ interface ImportTableResponse$1 {
17768
18092
  id: string;
17769
18093
  botId: string;
17770
18094
  tableId: string;
17771
- type: "export" | "import" | "clear_column" | "clear_vectors";
18095
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
17772
18096
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
17773
18097
  progress?: number;
17774
18098
  inputFileId: string | null;
@@ -18344,7 +18668,7 @@ interface DeleteTableRowsRequestBody$1 {
18344
18668
  */
18345
18669
  ids?: number[];
18346
18670
  /**
18347
- * Filter to apply when deleting rows. Example: \{ "name": \{ "$eq": "John" \} \}
18671
+ * Filter to apply when deleting rows. Deletion with a filter is performed asynchronously in batches and returns a job object to track progress. Example: \{ "createdAt": \{ "$lt": "2026-01-01" \} \}
18348
18672
  */
18349
18673
  filter?: {
18350
18674
  [k: string]: any;
@@ -18357,6 +18681,10 @@ interface DeleteTableRowsRequestBody$1 {
18357
18681
  type DeleteTableRowsInput$1 = DeleteTableRowsRequestBody$1 & DeleteTableRowsRequestHeaders$1 & DeleteTableRowsRequestQuery$1 & DeleteTableRowsRequestParams$1;
18358
18682
  interface DeleteTableRowsResponse$1 {
18359
18683
  deletedRows: number;
18684
+ job?: {
18685
+ id: string;
18686
+ status: string;
18687
+ };
18360
18688
  }
18361
18689
 
18362
18690
  interface UpdateTableRowsRequestHeaders$1 {
@@ -18651,6 +18979,10 @@ interface CreateConversationResponse {
18651
18979
  tags: {
18652
18980
  [k: string]: string;
18653
18981
  };
18982
+ /**
18983
+ * Number of messages in the conversation
18984
+ */
18985
+ messageCount: number;
18654
18986
  };
18655
18987
  }
18656
18988
 
@@ -18704,6 +19036,10 @@ interface GetConversationResponse {
18704
19036
  tags: {
18705
19037
  [k: string]: string;
18706
19038
  };
19039
+ /**
19040
+ * Number of messages in the conversation
19041
+ */
19042
+ messageCount: number;
18707
19043
  };
18708
19044
  }
18709
19045
 
@@ -18764,6 +19100,10 @@ interface ListConversationsResponse {
18764
19100
  tags: {
18765
19101
  [k: string]: string;
18766
19102
  };
19103
+ /**
19104
+ * Number of messages in the conversation
19105
+ */
19106
+ messageCount: number;
18767
19107
  }[];
18768
19108
  meta: {
18769
19109
  /**
@@ -18841,6 +19181,13 @@ interface GetOrCreateConversationResponse {
18841
19181
  tags: {
18842
19182
  [k: string]: string;
18843
19183
  };
19184
+ /**
19185
+ * Number of messages in the conversation
19186
+ */
19187
+ messageCount: number;
19188
+ };
19189
+ meta: {
19190
+ created: boolean;
18844
19191
  };
18845
19192
  }
18846
19193
 
@@ -18905,6 +19252,10 @@ interface UpdateConversationResponse {
18905
19252
  tags: {
18906
19253
  [k: string]: string;
18907
19254
  };
19255
+ /**
19256
+ * Number of messages in the conversation
19257
+ */
19258
+ messageCount: number;
18908
19259
  };
18909
19260
  }
18910
19261
 
@@ -18960,6 +19311,12 @@ interface ListParticipantsResponse {
18960
19311
  * Picture URL of the [User](#schema_user)
18961
19312
  */
18962
19313
  pictureUrl?: string;
19314
+ /**
19315
+ * Optional properties
19316
+ */
19317
+ properties?: {
19318
+ [k: string]: string;
19319
+ };
18963
19320
  /**
18964
19321
  * Optional attributes
18965
19322
  */
@@ -19020,6 +19377,12 @@ interface AddParticipantResponse {
19020
19377
  * Picture URL of the [User](#schema_user)
19021
19378
  */
19022
19379
  pictureUrl?: string;
19380
+ /**
19381
+ * Optional properties
19382
+ */
19383
+ properties?: {
19384
+ [k: string]: string;
19385
+ };
19023
19386
  /**
19024
19387
  * Optional attributes
19025
19388
  */
@@ -19071,6 +19434,12 @@ interface GetParticipantResponse {
19071
19434
  * Picture URL of the [User](#schema_user)
19072
19435
  */
19073
19436
  pictureUrl?: string;
19437
+ /**
19438
+ * Optional properties
19439
+ */
19440
+ properties?: {
19441
+ [k: string]: string;
19442
+ };
19074
19443
  /**
19075
19444
  * Optional attributes
19076
19445
  */
@@ -19422,7 +19791,7 @@ interface GetOrCreateMessageRequestBody {
19422
19791
  /**
19423
19792
  * Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
19424
19793
  */
19425
- payload: {
19794
+ payload?: {
19426
19795
  [k: string]: any;
19427
19796
  };
19428
19797
  /**
@@ -19513,6 +19882,9 @@ interface GetOrCreateMessageResponse {
19513
19882
  */
19514
19883
  origin?: "synthetic";
19515
19884
  };
19885
+ meta: {
19886
+ created: boolean;
19887
+ };
19516
19888
  }
19517
19889
 
19518
19890
  interface GetMessageRequestHeaders {
@@ -19764,7 +20136,14 @@ interface InitializeIncomingMessageRequestBody {
19764
20136
  */
19765
20137
  pictureUrl?: string;
19766
20138
  /**
19767
- * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
20139
+ * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20140
+ */
20141
+ properties?: {
20142
+ [k: string]: string;
20143
+ };
20144
+ /**
20145
+ * @deprecated
20146
+ * DEPRECATED - Use properties instead.
19768
20147
  */
19769
20148
  attributes?: {
19770
20149
  [k: string]: string;
@@ -19852,6 +20231,12 @@ interface InitializeIncomingMessageResponse {
19852
20231
  * Picture URL of the [User](#schema_user)
19853
20232
  */
19854
20233
  pictureUrl?: string;
20234
+ /**
20235
+ * Optional properties
20236
+ */
20237
+ properties?: {
20238
+ [k: string]: string;
20239
+ };
19855
20240
  /**
19856
20241
  * Optional attributes
19857
20242
  */
@@ -19898,6 +20283,10 @@ interface InitializeIncomingMessageResponse {
19898
20283
  tags: {
19899
20284
  [k: string]: string;
19900
20285
  };
20286
+ /**
20287
+ * Number of messages in the conversation
20288
+ */
20289
+ messageCount: number;
19901
20290
  };
19902
20291
  /**
19903
20292
  * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
@@ -20072,7 +20461,14 @@ interface CreateUserRequestBody {
20072
20461
  */
20073
20462
  pictureUrl?: string;
20074
20463
  /**
20075
- * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
20464
+ * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20465
+ */
20466
+ properties?: {
20467
+ [k: string]: string;
20468
+ };
20469
+ /**
20470
+ * @deprecated
20471
+ * DEPRECATED - Use properties instead.
20076
20472
  */
20077
20473
  attributes?: {
20078
20474
  [k: string]: string;
@@ -20110,6 +20506,12 @@ interface CreateUserResponse {
20110
20506
  * Picture URL of the [User](#schema_user)
20111
20507
  */
20112
20508
  pictureUrl?: string;
20509
+ /**
20510
+ * Optional properties
20511
+ */
20512
+ properties?: {
20513
+ [k: string]: string;
20514
+ };
20113
20515
  /**
20114
20516
  * Optional attributes
20115
20517
  */
@@ -20160,6 +20562,12 @@ interface GetUserResponse {
20160
20562
  * Picture URL of the [User](#schema_user)
20161
20563
  */
20162
20564
  pictureUrl?: string;
20565
+ /**
20566
+ * Optional properties
20567
+ */
20568
+ properties?: {
20569
+ [k: string]: string;
20570
+ };
20163
20571
  /**
20164
20572
  * Optional attributes
20165
20573
  */
@@ -20216,6 +20624,12 @@ interface ListUsersResponse {
20216
20624
  * Picture URL of the [User](#schema_user)
20217
20625
  */
20218
20626
  pictureUrl?: string;
20627
+ /**
20628
+ * Optional properties
20629
+ */
20630
+ properties?: {
20631
+ [k: string]: string;
20632
+ };
20219
20633
  /**
20220
20634
  * Optional attributes
20221
20635
  */
@@ -20258,7 +20672,14 @@ interface GetOrCreateUserRequestBody {
20258
20672
  */
20259
20673
  pictureUrl?: string;
20260
20674
  /**
20261
- * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
20675
+ * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
20676
+ */
20677
+ properties?: {
20678
+ [k: string]: string;
20679
+ };
20680
+ /**
20681
+ * @deprecated
20682
+ * DEPRECATED - Use properties instead.
20262
20683
  */
20263
20684
  attributes?: {
20264
20685
  [k: string]: string;
@@ -20300,6 +20721,12 @@ interface GetOrCreateUserResponse {
20300
20721
  * Picture URL of the [User](#schema_user)
20301
20722
  */
20302
20723
  pictureUrl?: string;
20724
+ /**
20725
+ * Optional properties
20726
+ */
20727
+ properties?: {
20728
+ [k: string]: string;
20729
+ };
20303
20730
  /**
20304
20731
  * Optional attributes
20305
20732
  */
@@ -20307,6 +20734,9 @@ interface GetOrCreateUserResponse {
20307
20734
  [k: string]: string;
20308
20735
  };
20309
20736
  };
20737
+ meta: {
20738
+ created: boolean;
20739
+ };
20310
20740
  }
20311
20741
 
20312
20742
  interface UpdateUserRequestHeaders {
@@ -20332,11 +20762,18 @@ interface UpdateUserRequestBody {
20332
20762
  */
20333
20763
  pictureUrl?: string | null;
20334
20764
  /**
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.
20765
+ * @deprecated
20766
+ * DEPRECATED - Use properties instead.
20336
20767
  */
20337
20768
  attributes?: {
20338
20769
  [k: string]: string | null;
20339
20770
  };
20771
+ /**
20772
+ * 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.
20773
+ */
20774
+ properties?: {
20775
+ [k: string]: string | null;
20776
+ };
20340
20777
  }
20341
20778
  type UpdateUserInput = UpdateUserRequestBody & UpdateUserRequestHeaders & UpdateUserRequestQuery & UpdateUserRequestParams;
20342
20779
  interface UpdateUserResponse {
@@ -20370,6 +20807,12 @@ interface UpdateUserResponse {
20370
20807
  * Picture URL of the [User](#schema_user)
20371
20808
  */
20372
20809
  pictureUrl?: string;
20810
+ /**
20811
+ * Optional properties
20812
+ */
20813
+ properties?: {
20814
+ [k: string]: string;
20815
+ };
20373
20816
  /**
20374
20817
  * Optional attributes
20375
20818
  */
@@ -22774,6 +23217,26 @@ interface GetPublicPluginByIdResponse {
22774
23217
  };
22775
23218
  };
22776
23219
  };
23220
+ /**
23221
+ * Message object configuration
23222
+ */
23223
+ message: {
23224
+ tags: {
23225
+ /**
23226
+ * Definition of a tag that can be provided on the object
23227
+ */
23228
+ [k: string]: {
23229
+ /**
23230
+ * Title of the tag
23231
+ */
23232
+ title?: string;
23233
+ /**
23234
+ * Description of the tag
23235
+ */
23236
+ description?: string;
23237
+ };
23238
+ };
23239
+ };
22777
23240
  /**
22778
23241
  * Optional attributes
22779
23242
  */
@@ -23003,6 +23466,26 @@ interface GetDereferencedPublicPluginByIdResponse {
23003
23466
  };
23004
23467
  };
23005
23468
  };
23469
+ /**
23470
+ * Message object configuration
23471
+ */
23472
+ message: {
23473
+ tags: {
23474
+ /**
23475
+ * Definition of a tag that can be provided on the object
23476
+ */
23477
+ [k: string]: {
23478
+ /**
23479
+ * Title of the tag
23480
+ */
23481
+ title?: string;
23482
+ /**
23483
+ * Description of the tag
23484
+ */
23485
+ description?: string;
23486
+ };
23487
+ };
23488
+ };
23006
23489
  /**
23007
23490
  * Optional attributes
23008
23491
  */
@@ -23224,6 +23707,26 @@ interface GetPublicPluginResponse {
23224
23707
  };
23225
23708
  };
23226
23709
  };
23710
+ /**
23711
+ * Message object configuration
23712
+ */
23713
+ message: {
23714
+ tags: {
23715
+ /**
23716
+ * Definition of a tag that can be provided on the object
23717
+ */
23718
+ [k: string]: {
23719
+ /**
23720
+ * Title of the tag
23721
+ */
23722
+ title?: string;
23723
+ /**
23724
+ * Description of the tag
23725
+ */
23726
+ description?: string;
23727
+ };
23728
+ };
23729
+ };
23227
23730
  /**
23228
23731
  * Optional attributes
23229
23732
  */
@@ -31076,6 +31579,26 @@ interface CreatePluginRequestBody {
31076
31579
  };
31077
31580
  };
31078
31581
  };
31582
+ /**
31583
+ * Message object configuration
31584
+ */
31585
+ message?: {
31586
+ tags: {
31587
+ /**
31588
+ * Definition of a tag that can be provided on the object
31589
+ */
31590
+ [k: string]: {
31591
+ /**
31592
+ * Title of the tag
31593
+ */
31594
+ title?: string;
31595
+ /**
31596
+ * Description of the tag
31597
+ */
31598
+ description?: string;
31599
+ };
31600
+ };
31601
+ };
31079
31602
  /**
31080
31603
  * Optional attributes
31081
31604
  */
@@ -31332,6 +31855,26 @@ interface CreatePluginResponse {
31332
31855
  };
31333
31856
  };
31334
31857
  };
31858
+ /**
31859
+ * Message object configuration
31860
+ */
31861
+ message: {
31862
+ tags: {
31863
+ /**
31864
+ * Definition of a tag that can be provided on the object
31865
+ */
31866
+ [k: string]: {
31867
+ /**
31868
+ * Title of the tag
31869
+ */
31870
+ title?: string;
31871
+ /**
31872
+ * Description of the tag
31873
+ */
31874
+ description?: string;
31875
+ };
31876
+ };
31877
+ };
31335
31878
  /**
31336
31879
  * Optional attributes
31337
31880
  */
@@ -31552,6 +32095,26 @@ interface GetPluginResponse {
31552
32095
  };
31553
32096
  };
31554
32097
  };
32098
+ /**
32099
+ * Message object configuration
32100
+ */
32101
+ message: {
32102
+ tags: {
32103
+ /**
32104
+ * Definition of a tag that can be provided on the object
32105
+ */
32106
+ [k: string]: {
32107
+ /**
32108
+ * Title of the tag
32109
+ */
32110
+ title?: string;
32111
+ /**
32112
+ * Description of the tag
32113
+ */
32114
+ description?: string;
32115
+ };
32116
+ };
32117
+ };
31555
32118
  /**
31556
32119
  * Optional attributes
31557
32120
  */
@@ -31781,6 +32344,26 @@ interface GetDereferencedPluginResponse {
31781
32344
  };
31782
32345
  };
31783
32346
  };
32347
+ /**
32348
+ * Message object configuration
32349
+ */
32350
+ message: {
32351
+ tags: {
32352
+ /**
32353
+ * Definition of a tag that can be provided on the object
32354
+ */
32355
+ [k: string]: {
32356
+ /**
32357
+ * Title of the tag
32358
+ */
32359
+ title?: string;
32360
+ /**
32361
+ * Description of the tag
32362
+ */
32363
+ description?: string;
32364
+ };
32365
+ };
32366
+ };
31784
32367
  /**
31785
32368
  * Optional attributes
31786
32369
  */
@@ -32002,6 +32585,26 @@ interface GetPluginByNameResponse {
32002
32585
  };
32003
32586
  };
32004
32587
  };
32588
+ /**
32589
+ * Message object configuration
32590
+ */
32591
+ message: {
32592
+ tags: {
32593
+ /**
32594
+ * Definition of a tag that can be provided on the object
32595
+ */
32596
+ [k: string]: {
32597
+ /**
32598
+ * Title of the tag
32599
+ */
32600
+ title?: string;
32601
+ /**
32602
+ * Description of the tag
32603
+ */
32604
+ description?: string;
32605
+ };
32606
+ };
32607
+ };
32005
32608
  /**
32006
32609
  * Optional attributes
32007
32610
  */
@@ -32170,6 +32773,23 @@ interface UpdatePluginRequestBody {
32170
32773
  } | null;
32171
32774
  };
32172
32775
  };
32776
+ message?: {
32777
+ tags: {
32778
+ /**
32779
+ * Definition of a tag that can be provided on the object
32780
+ */
32781
+ [k: string]: {
32782
+ /**
32783
+ * Title of the tag
32784
+ */
32785
+ title?: string;
32786
+ /**
32787
+ * Description of the tag
32788
+ */
32789
+ description?: string;
32790
+ } | null;
32791
+ };
32792
+ };
32173
32793
  /**
32174
32794
  * Optional attributes. Set attributes to null to remove them
32175
32795
  */
@@ -32426,6 +33046,26 @@ interface UpdatePluginResponse {
32426
33046
  };
32427
33047
  };
32428
33048
  };
33049
+ /**
33050
+ * Message object configuration
33051
+ */
33052
+ message: {
33053
+ tags: {
33054
+ /**
33055
+ * Definition of a tag that can be provided on the object
33056
+ */
33057
+ [k: string]: {
33058
+ /**
33059
+ * Title of the tag
33060
+ */
33061
+ title?: string;
33062
+ /**
33063
+ * Description of the tag
33064
+ */
33065
+ description?: string;
33066
+ };
33067
+ };
33068
+ };
32429
33069
  /**
32430
33070
  * Optional attributes
32431
33071
  */
@@ -34724,9 +35364,13 @@ interface DuplicateTableResponse {
34724
35364
  updatedAt?: string;
34725
35365
  };
34726
35366
  /**
34727
- * The total number of rows present in the table.
35367
+ * The total number of rows present in the source table.
34728
35368
  */
34729
35369
  rows: number;
35370
+ job?: {
35371
+ id: string;
35372
+ status: string;
35373
+ };
34730
35374
  }
34731
35375
 
34732
35376
  interface ExportTableRequestHeaders {
@@ -34746,7 +35390,7 @@ interface ExportTableResponse {
34746
35390
  id: string;
34747
35391
  botId: string;
34748
35392
  tableId: string;
34749
- type: "export" | "import" | "clear_column" | "clear_vectors";
35393
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
34750
35394
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
34751
35395
  progress?: number;
34752
35396
  inputFileId: string | null;
@@ -34771,7 +35415,7 @@ interface GetTableJobsResponse {
34771
35415
  id: string;
34772
35416
  botId: string;
34773
35417
  tableId: string;
34774
- type: "export" | "import" | "clear_column" | "clear_vectors";
35418
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
34775
35419
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
34776
35420
  progress?: number;
34777
35421
  inputFileId: string | null;
@@ -34800,7 +35444,7 @@ interface ImportTableResponse {
34800
35444
  id: string;
34801
35445
  botId: string;
34802
35446
  tableId: string;
34803
- type: "export" | "import" | "clear_column" | "clear_vectors";
35447
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
34804
35448
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
34805
35449
  progress?: number;
34806
35450
  inputFileId: string | null;
@@ -35376,7 +36020,7 @@ interface DeleteTableRowsRequestBody {
35376
36020
  */
35377
36021
  ids?: number[];
35378
36022
  /**
35379
- * Filter to apply when deleting rows. Example: \{ "name": \{ "$eq": "John" \} \}
36023
+ * Filter to apply when deleting rows. Deletion with a filter is performed asynchronously in batches and returns a job object to track progress. Example: \{ "createdAt": \{ "$lt": "2026-01-01" \} \}
35380
36024
  */
35381
36025
  filter?: {
35382
36026
  [k: string]: any;
@@ -35389,6 +36033,10 @@ interface DeleteTableRowsRequestBody {
35389
36033
  type DeleteTableRowsInput = DeleteTableRowsRequestBody & DeleteTableRowsRequestHeaders & DeleteTableRowsRequestQuery & DeleteTableRowsRequestParams;
35390
36034
  interface DeleteTableRowsResponse {
35391
36035
  deletedRows: number;
36036
+ job?: {
36037
+ id: string;
36038
+ status: string;
36039
+ };
35392
36040
  }
35393
36041
 
35394
36042
  interface UpdateTableRowsRequestHeaders {
@@ -36689,6 +37337,26 @@ interface Plugin {
36689
37337
  };
36690
37338
  };
36691
37339
  };
37340
+ /**
37341
+ * Message object configuration
37342
+ */
37343
+ message: {
37344
+ tags: {
37345
+ /**
37346
+ * Definition of a tag that can be provided on the object
37347
+ */
37348
+ [k: string]: {
37349
+ /**
37350
+ * Title of the tag
37351
+ */
37352
+ title?: string;
37353
+ /**
37354
+ * Description of the tag
37355
+ */
37356
+ description?: string;
37357
+ };
37358
+ };
37359
+ };
36692
37360
  /**
36693
37361
  * Optional attributes
36694
37362
  */
@@ -36862,6 +37530,12 @@ interface User {
36862
37530
  * Picture URL of the [User](#schema_user)
36863
37531
  */
36864
37532
  pictureUrl?: string;
37533
+ /**
37534
+ * Optional properties
37535
+ */
37536
+ properties?: {
37537
+ [k: string]: string;
37538
+ };
36865
37539
  /**
36866
37540
  * Optional attributes
36867
37541
  */
@@ -36908,6 +37582,10 @@ interface Conversation {
36908
37582
  tags: {
36909
37583
  [k: string]: string;
36910
37584
  };
37585
+ /**
37586
+ * Number of messages in the conversation
37587
+ */
37588
+ messageCount: number;
36911
37589
  }
36912
37590
  /**
36913
37591
  * The event object represents an action or an occurrence.
@@ -37655,6 +38333,7 @@ declare class Client extends Client$1 implements IClient {
37655
38333
  tags: {
37656
38334
  [k: string]: string;
37657
38335
  };
38336
+ messageCount: number;
37658
38337
  }>;
37659
38338
  participants: (props: {
37660
38339
  id: string;
@@ -37667,6 +38346,9 @@ declare class Client extends Client$1 implements IClient {
37667
38346
  };
37668
38347
  name?: string;
37669
38348
  pictureUrl?: string;
38349
+ properties?: {
38350
+ [k: string]: string;
38351
+ };
37670
38352
  attributes?: {
37671
38353
  [k: string]: string;
37672
38354
  };
@@ -37733,6 +38415,9 @@ declare class Client extends Client$1 implements IClient {
37733
38415
  };
37734
38416
  name?: string;
37735
38417
  pictureUrl?: string;
38418
+ properties?: {
38419
+ [k: string]: string;
38420
+ };
37736
38421
  attributes?: {
37737
38422
  [k: string]: string;
37738
38423
  };