@wildix/stream-client 4.1.4 → 4.1.6

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.
Files changed (63) hide show
  1. package/dist-cjs/schemas/schemas_0.js +131 -127
  2. package/dist-es/schemas/schemas_0.js +131 -127
  3. package/dist-types/commands/AddChannelMemberCommand.d.ts +5 -0
  4. package/dist-types/commands/AddChannelMembersCommand.d.ts +5 -0
  5. package/dist-types/commands/AssignChannelCommand.d.ts +5 -0
  6. package/dist-types/commands/CreateGroupChannelCommand.d.ts +5 -0
  7. package/dist-types/commands/CreateKiteChannelCommand.d.ts +5 -0
  8. package/dist-types/commands/CreateSectionCommand.d.ts +5 -0
  9. package/dist-types/commands/DeleteChannelMemberCommand.d.ts +8 -2
  10. package/dist-types/commands/DeleteMessageCommand.d.ts +8 -2
  11. package/dist-types/commands/DeleteMessageReactionCommand.d.ts +5 -0
  12. package/dist-types/commands/DeleteSectionCommand.d.ts +8 -2
  13. package/dist-types/commands/GetChannelCommand.d.ts +5 -0
  14. package/dist-types/commands/GetChannelMemberCommand.d.ts +5 -0
  15. package/dist-types/commands/GetDirectChannelIdCommand.d.ts +5 -0
  16. package/dist-types/commands/GetFilePresignedDownloadUrlCommand.d.ts +5 -0
  17. package/dist-types/commands/GetInboxCommand.d.ts +5 -0
  18. package/dist-types/commands/GetMessageCommand.d.ts +5 -0
  19. package/dist-types/commands/GetOrCreateDirectChannelCommand.d.ts +5 -0
  20. package/dist-types/commands/GetOrCreateSmsChannelCommand.d.ts +5 -0
  21. package/dist-types/commands/GetOrCreateTelephonyChannelCommand.d.ts +5 -0
  22. package/dist-types/commands/GetOrCreateWhatsAppChannelCommand.d.ts +5 -0
  23. package/dist-types/commands/GetSmsChannelIdCommand.d.ts +5 -0
  24. package/dist-types/commands/GetTelephonyChannelIdCommand.d.ts +5 -0
  25. package/dist-types/commands/GetTokenCommand.d.ts +5 -0
  26. package/dist-types/commands/GetUploadedFileInfoCommand.d.ts +5 -0
  27. package/dist-types/commands/GetWhatsAppChannelIdCommand.d.ts +5 -0
  28. package/dist-types/commands/HideChannelCommand.d.ts +8 -2
  29. package/dist-types/commands/JoinChannelCommand.d.ts +5 -0
  30. package/dist-types/commands/LeaveChannelCommand.d.ts +8 -2
  31. package/dist-types/commands/ListChannelMembersCommand.d.ts +5 -0
  32. package/dist-types/commands/ListChannelMembersReadStatusCommand.d.ts +5 -0
  33. package/dist-types/commands/ListChannelsCommand.d.ts +5 -0
  34. package/dist-types/commands/ListMentionsCommand.d.ts +5 -0
  35. package/dist-types/commands/ListMessagesCommand.d.ts +5 -0
  36. package/dist-types/commands/MarkReadCommand.d.ts +5 -0
  37. package/dist-types/commands/MarkUnreadCommand.d.ts +5 -0
  38. package/dist-types/commands/MoveChannelToSectionCommand.d.ts +5 -0
  39. package/dist-types/commands/MuteChannelCommand.d.ts +5 -0
  40. package/dist-types/commands/PartialUpdateChannelCommand.d.ts +5 -0
  41. package/dist-types/commands/PartialUpdateMessageCommand.d.ts +5 -0
  42. package/dist-types/commands/PinChannelCommand.d.ts +8 -2
  43. package/dist-types/commands/PinMessageCommand.d.ts +5 -0
  44. package/dist-types/commands/QueryChannelsCommand.d.ts +5 -0
  45. package/dist-types/commands/RemoveChannelFromSectionCommand.d.ts +5 -0
  46. package/dist-types/commands/RenameSectionCommand.d.ts +5 -0
  47. package/dist-types/commands/SearchChannelsCommand.d.ts +5 -0
  48. package/dist-types/commands/SearchMessagesCommand.d.ts +5 -0
  49. package/dist-types/commands/SendGiphyCommand.d.ts +5 -0
  50. package/dist-types/commands/SendMessageCommand.d.ts +5 -0
  51. package/dist-types/commands/SendMessageReactionCommand.d.ts +5 -0
  52. package/dist-types/commands/SendSystemMessageCommand.d.ts +5 -0
  53. package/dist-types/commands/SendTypingStartCommand.d.ts +8 -2
  54. package/dist-types/commands/SendTypingStopCommand.d.ts +8 -2
  55. package/dist-types/commands/ShowChannelCommand.d.ts +8 -2
  56. package/dist-types/commands/UnmuteChannelCommand.d.ts +5 -0
  57. package/dist-types/commands/UnpinChannelCommand.d.ts +8 -2
  58. package/dist-types/commands/UnpinMessageCommand.d.ts +5 -0
  59. package/dist-types/commands/UpdateChannelCommand.d.ts +5 -0
  60. package/dist-types/commands/UpdateMessageCommand.d.ts +5 -0
  61. package/dist-types/commands/UploadFileCommand.d.ts +5 -0
  62. package/dist-types/models/models_0.d.ts +1718 -27
  63. package/package.json +2 -2
@@ -158,6 +158,10 @@ export interface AddChannelMemberInput {
158
158
  * @public
159
159
  */
160
160
  userId?: string | undefined;
161
+ /**
162
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
163
+ * @public
164
+ */
161
165
  channelId: string;
162
166
  silent?: boolean | undefined;
163
167
  memberId?: string | undefined;
@@ -185,6 +189,31 @@ export interface ChannelMember {
185
189
  * @public
186
190
  */
187
191
  export interface AddChannelMemberOutput {
192
+ /**
193
+ * The request ID of the request.
194
+ * @public
195
+ */
196
+ requestId?: string | undefined;
197
+ /**
198
+ * The duration of the request in milliseconds.
199
+ * @public
200
+ */
201
+ requestDuration?: number | undefined;
202
+ /**
203
+ * Displays the applicable rate limits for the current request.
204
+ * @public
205
+ */
206
+ rateLimit?: string | undefined;
207
+ /**
208
+ * Indicates how many requests a user can still make within the current time window.
209
+ * @public
210
+ */
211
+ rateLimitRemaining?: number | undefined;
212
+ /**
213
+ * Shows the time in seconds until the rate limit resets.
214
+ * @public
215
+ */
216
+ rateLimitReset?: number | undefined;
188
217
  /**
189
218
  * Channel membership row.
190
219
  * @public
@@ -205,6 +234,10 @@ export interface AddChannelMembersInput {
205
234
  * @public
206
235
  */
207
236
  userId?: string | undefined;
237
+ /**
238
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
239
+ * @public
240
+ */
208
241
  channelId: string;
209
242
  silent?: boolean | undefined;
210
243
  members?: string[] | undefined;
@@ -220,6 +253,31 @@ export interface AddChannelMembersInput {
220
253
  * @public
221
254
  */
222
255
  export interface AddChannelMembersOutput {
256
+ /**
257
+ * The request ID of the request.
258
+ * @public
259
+ */
260
+ requestId?: string | undefined;
261
+ /**
262
+ * The duration of the request in milliseconds.
263
+ * @public
264
+ */
265
+ requestDuration?: number | undefined;
266
+ /**
267
+ * Displays the applicable rate limits for the current request.
268
+ * @public
269
+ */
270
+ rateLimit?: string | undefined;
271
+ /**
272
+ * Indicates how many requests a user can still make within the current time window.
273
+ * @public
274
+ */
275
+ rateLimitRemaining?: number | undefined;
276
+ /**
277
+ * Shows the time in seconds until the rate limit resets.
278
+ * @public
279
+ */
280
+ rateLimitReset?: number | undefined;
223
281
  members: ChannelMember[];
224
282
  }
225
283
  /**
@@ -304,6 +362,10 @@ export interface AssignChannelInput {
304
362
  * @public
305
363
  */
306
364
  userId?: string | undefined;
365
+ /**
366
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
367
+ * @public
368
+ */
307
369
  channelId: string;
308
370
  silent?: boolean | undefined;
309
371
  service?: AssignChannelServiceRequest | undefined;
@@ -314,6 +376,31 @@ export interface AssignChannelInput {
314
376
  * @public
315
377
  */
316
378
  export interface AssignChannelOutput {
379
+ /**
380
+ * The request ID of the request.
381
+ * @public
382
+ */
383
+ requestId?: string | undefined;
384
+ /**
385
+ * The duration of the request in milliseconds.
386
+ * @public
387
+ */
388
+ requestDuration?: number | undefined;
389
+ /**
390
+ * Displays the applicable rate limits for the current request.
391
+ * @public
392
+ */
393
+ rateLimit?: string | undefined;
394
+ /**
395
+ * Indicates how many requests a user can still make within the current time window.
396
+ * @public
397
+ */
398
+ rateLimitRemaining?: number | undefined;
399
+ /**
400
+ * Shows the time in seconds until the rate limit resets.
401
+ * @public
402
+ */
403
+ rateLimitReset?: number | undefined;
317
404
  assigneeId?: string | undefined;
318
405
  serviceUri?: string | undefined;
319
406
  }
@@ -396,6 +483,10 @@ export interface LastMessagePreview {
396
483
  * @public
397
484
  */
398
485
  export interface Channel {
486
+ /**
487
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
488
+ * @public
489
+ */
399
490
  channelId: string;
400
491
  /**
401
492
  * Type of channel.
@@ -715,6 +806,31 @@ export interface CreateGroupChannelInput {
715
806
  * @public
716
807
  */
717
808
  export interface CreateGroupChannelOutput {
809
+ /**
810
+ * The request ID of the request.
811
+ * @public
812
+ */
813
+ requestId?: string | undefined;
814
+ /**
815
+ * The duration of the request in milliseconds.
816
+ * @public
817
+ */
818
+ requestDuration?: number | undefined;
819
+ /**
820
+ * Displays the applicable rate limits for the current request.
821
+ * @public
822
+ */
823
+ rateLimit?: string | undefined;
824
+ /**
825
+ * Indicates how many requests a user can still make within the current time window.
826
+ * @public
827
+ */
828
+ rateLimitRemaining?: number | undefined;
829
+ /**
830
+ * Shows the time in seconds until the rate limit resets.
831
+ * @public
832
+ */
833
+ rateLimitReset?: number | undefined;
718
834
  channel: Channel;
719
835
  }
720
836
  /**
@@ -805,6 +921,10 @@ export declare namespace Element {
805
921
  * @public
806
922
  */
807
923
  export interface MessageForwardRef {
924
+ /**
925
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
926
+ * @public
927
+ */
808
928
  channelId: string;
809
929
  messageId: string;
810
930
  }
@@ -813,6 +933,10 @@ export interface MessageForwardRef {
813
933
  * @public
814
934
  */
815
935
  export interface MessageQuoteRef {
936
+ /**
937
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
938
+ * @public
939
+ */
816
940
  channelId: string;
817
941
  messageId: string;
818
942
  }
@@ -957,6 +1081,10 @@ export interface CreateKiteChannelInput {
957
1081
  * @public
958
1082
  */
959
1083
  userId?: string | undefined;
1084
+ /**
1085
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1086
+ * @public
1087
+ */
960
1088
  channelId?: string | undefined;
961
1089
  /**
962
1090
  * Kite widget id or agent email.
@@ -975,6 +1103,31 @@ export interface CreateKiteChannelInput {
975
1103
  * @public
976
1104
  */
977
1105
  export interface CreateKiteChannelOutput {
1106
+ /**
1107
+ * The request ID of the request.
1108
+ * @public
1109
+ */
1110
+ requestId?: string | undefined;
1111
+ /**
1112
+ * The duration of the request in milliseconds.
1113
+ * @public
1114
+ */
1115
+ requestDuration?: number | undefined;
1116
+ /**
1117
+ * Displays the applicable rate limits for the current request.
1118
+ * @public
1119
+ */
1120
+ rateLimit?: string | undefined;
1121
+ /**
1122
+ * Indicates how many requests a user can still make within the current time window.
1123
+ * @public
1124
+ */
1125
+ rateLimitRemaining?: number | undefined;
1126
+ /**
1127
+ * Shows the time in seconds until the rate limit resets.
1128
+ * @public
1129
+ */
1130
+ rateLimitReset?: number | undefined;
978
1131
  channel: Channel;
979
1132
  }
980
1133
  /**
@@ -1048,6 +1201,31 @@ export interface Section {
1048
1201
  * @public
1049
1202
  */
1050
1203
  export interface CreateSectionOutput {
1204
+ /**
1205
+ * The request ID of the request.
1206
+ * @public
1207
+ */
1208
+ requestId?: string | undefined;
1209
+ /**
1210
+ * The duration of the request in milliseconds.
1211
+ * @public
1212
+ */
1213
+ requestDuration?: number | undefined;
1214
+ /**
1215
+ * Displays the applicable rate limits for the current request.
1216
+ * @public
1217
+ */
1218
+ rateLimit?: string | undefined;
1219
+ /**
1220
+ * Indicates how many requests a user can still make within the current time window.
1221
+ * @public
1222
+ */
1223
+ rateLimitRemaining?: number | undefined;
1224
+ /**
1225
+ * Shows the time in seconds until the rate limit resets.
1226
+ * @public
1227
+ */
1228
+ rateLimitReset?: number | undefined;
1051
1229
  /**
1052
1230
  * Inbox section with metadata, channel count, and unread counters.
1053
1231
  * @public
@@ -1068,6 +1246,10 @@ export interface DeleteChannelInput {
1068
1246
  * @public
1069
1247
  */
1070
1248
  userId?: string | undefined;
1249
+ /**
1250
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1251
+ * @public
1252
+ */
1071
1253
  channelId: string;
1072
1254
  }
1073
1255
  /**
@@ -1084,6 +1266,10 @@ export interface DeleteChannelMemberInput {
1084
1266
  * @public
1085
1267
  */
1086
1268
  userId?: string | undefined;
1269
+ /**
1270
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1271
+ * @public
1272
+ */
1087
1273
  channelId: string;
1088
1274
  memberId: string;
1089
1275
  silent?: boolean | undefined;
@@ -1092,6 +1278,31 @@ export interface DeleteChannelMemberInput {
1092
1278
  * @public
1093
1279
  */
1094
1280
  export interface DeleteChannelMemberOutput {
1281
+ /**
1282
+ * The request ID of the request.
1283
+ * @public
1284
+ */
1285
+ requestId?: string | undefined;
1286
+ /**
1287
+ * The duration of the request in milliseconds.
1288
+ * @public
1289
+ */
1290
+ requestDuration?: number | undefined;
1291
+ /**
1292
+ * Displays the applicable rate limits for the current request.
1293
+ * @public
1294
+ */
1295
+ rateLimit?: string | undefined;
1296
+ /**
1297
+ * Indicates how many requests a user can still make within the current time window.
1298
+ * @public
1299
+ */
1300
+ rateLimitRemaining?: number | undefined;
1301
+ /**
1302
+ * Shows the time in seconds until the rate limit resets.
1303
+ * @public
1304
+ */
1305
+ rateLimitReset?: number | undefined;
1095
1306
  }
1096
1307
  /**
1097
1308
  * @public
@@ -1107,6 +1318,10 @@ export interface DeleteMessageInput {
1107
1318
  * @public
1108
1319
  */
1109
1320
  userId?: string | undefined;
1321
+ /**
1322
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1323
+ * @public
1324
+ */
1110
1325
  channelId: string;
1111
1326
  messageId: string;
1112
1327
  }
@@ -1114,6 +1329,31 @@ export interface DeleteMessageInput {
1114
1329
  * @public
1115
1330
  */
1116
1331
  export interface DeleteMessageOutput {
1332
+ /**
1333
+ * The request ID of the request.
1334
+ * @public
1335
+ */
1336
+ requestId?: string | undefined;
1337
+ /**
1338
+ * The duration of the request in milliseconds.
1339
+ * @public
1340
+ */
1341
+ requestDuration?: number | undefined;
1342
+ /**
1343
+ * Displays the applicable rate limits for the current request.
1344
+ * @public
1345
+ */
1346
+ rateLimit?: string | undefined;
1347
+ /**
1348
+ * Indicates how many requests a user can still make within the current time window.
1349
+ * @public
1350
+ */
1351
+ rateLimitRemaining?: number | undefined;
1352
+ /**
1353
+ * Shows the time in seconds until the rate limit resets.
1354
+ * @public
1355
+ */
1356
+ rateLimitReset?: number | undefined;
1117
1357
  }
1118
1358
  /**
1119
1359
  * @public
@@ -1129,6 +1369,10 @@ export interface DeleteMessageReactionInput {
1129
1369
  * @public
1130
1370
  */
1131
1371
  userId?: string | undefined;
1372
+ /**
1373
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1374
+ * @public
1375
+ */
1132
1376
  channelId: string;
1133
1377
  messageId: string;
1134
1378
  /**
@@ -1242,6 +1486,10 @@ export interface Reaction {
1242
1486
  * @public
1243
1487
  */
1244
1488
  export interface MessageQuote {
1489
+ /**
1490
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1491
+ * @public
1492
+ */
1245
1493
  channelId: string;
1246
1494
  messageId: string;
1247
1495
  /**
@@ -1400,6 +1648,31 @@ export interface DeleteMessageReactionOutput {
1400
1648
  * @public
1401
1649
  */
1402
1650
  message: Message;
1651
+ /**
1652
+ * The request ID of the request.
1653
+ * @public
1654
+ */
1655
+ requestId?: string | undefined;
1656
+ /**
1657
+ * The duration of the request in milliseconds.
1658
+ * @public
1659
+ */
1660
+ requestDuration?: number | undefined;
1661
+ /**
1662
+ * Displays the applicable rate limits for the current request.
1663
+ * @public
1664
+ */
1665
+ rateLimit?: string | undefined;
1666
+ /**
1667
+ * Indicates how many requests a user can still make within the current time window.
1668
+ * @public
1669
+ */
1670
+ rateLimitRemaining?: number | undefined;
1671
+ /**
1672
+ * Shows the time in seconds until the rate limit resets.
1673
+ * @public
1674
+ */
1675
+ rateLimitReset?: number | undefined;
1403
1676
  }
1404
1677
  /**
1405
1678
  * @public
@@ -1425,6 +1698,31 @@ export interface DeleteSectionInput {
1425
1698
  * @public
1426
1699
  */
1427
1700
  export interface DeleteSectionOutput {
1701
+ /**
1702
+ * The request ID of the request.
1703
+ * @public
1704
+ */
1705
+ requestId?: string | undefined;
1706
+ /**
1707
+ * The duration of the request in milliseconds.
1708
+ * @public
1709
+ */
1710
+ requestDuration?: number | undefined;
1711
+ /**
1712
+ * Displays the applicable rate limits for the current request.
1713
+ * @public
1714
+ */
1715
+ rateLimit?: string | undefined;
1716
+ /**
1717
+ * Indicates how many requests a user can still make within the current time window.
1718
+ * @public
1719
+ */
1720
+ rateLimitRemaining?: number | undefined;
1721
+ /**
1722
+ * Shows the time in seconds until the rate limit resets.
1723
+ * @public
1724
+ */
1725
+ rateLimitReset?: number | undefined;
1428
1726
  }
1429
1727
  /**
1430
1728
  * @public
@@ -1440,12 +1738,41 @@ export interface GetChannelInput {
1440
1738
  * @public
1441
1739
  */
1442
1740
  userId?: string | undefined;
1741
+ /**
1742
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1743
+ * @public
1744
+ */
1443
1745
  channelId: string;
1444
1746
  }
1445
1747
  /**
1446
1748
  * @public
1447
1749
  */
1448
1750
  export interface GetChannelOutput {
1751
+ /**
1752
+ * The request ID of the request.
1753
+ * @public
1754
+ */
1755
+ requestId?: string | undefined;
1756
+ /**
1757
+ * The duration of the request in milliseconds.
1758
+ * @public
1759
+ */
1760
+ requestDuration?: number | undefined;
1761
+ /**
1762
+ * Displays the applicable rate limits for the current request.
1763
+ * @public
1764
+ */
1765
+ rateLimit?: string | undefined;
1766
+ /**
1767
+ * Indicates how many requests a user can still make within the current time window.
1768
+ * @public
1769
+ */
1770
+ rateLimitRemaining?: number | undefined;
1771
+ /**
1772
+ * Shows the time in seconds until the rate limit resets.
1773
+ * @public
1774
+ */
1775
+ rateLimitReset?: number | undefined;
1449
1776
  channel: Channel;
1450
1777
  }
1451
1778
  /**
@@ -1462,6 +1789,10 @@ export interface GetChannelMemberInput {
1462
1789
  * @public
1463
1790
  */
1464
1791
  userId?: string | undefined;
1792
+ /**
1793
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1794
+ * @public
1795
+ */
1465
1796
  channelId: string;
1466
1797
  memberId: string;
1467
1798
  }
@@ -1469,6 +1800,31 @@ export interface GetChannelMemberInput {
1469
1800
  * @public
1470
1801
  */
1471
1802
  export interface GetChannelMemberOutput {
1803
+ /**
1804
+ * The request ID of the request.
1805
+ * @public
1806
+ */
1807
+ requestId?: string | undefined;
1808
+ /**
1809
+ * The duration of the request in milliseconds.
1810
+ * @public
1811
+ */
1812
+ requestDuration?: number | undefined;
1813
+ /**
1814
+ * Displays the applicable rate limits for the current request.
1815
+ * @public
1816
+ */
1817
+ rateLimit?: string | undefined;
1818
+ /**
1819
+ * Indicates how many requests a user can still make within the current time window.
1820
+ * @public
1821
+ */
1822
+ rateLimitRemaining?: number | undefined;
1823
+ /**
1824
+ * Shows the time in seconds until the rate limit resets.
1825
+ * @public
1826
+ */
1827
+ rateLimitReset?: number | undefined;
1472
1828
  /**
1473
1829
  * Channel membership row.
1474
1830
  * @public
@@ -1500,6 +1856,35 @@ export interface GetDirectChannelIdInput {
1500
1856
  * @public
1501
1857
  */
1502
1858
  export interface GetDirectChannelIdOutput {
1859
+ /**
1860
+ * The request ID of the request.
1861
+ * @public
1862
+ */
1863
+ requestId?: string | undefined;
1864
+ /**
1865
+ * The duration of the request in milliseconds.
1866
+ * @public
1867
+ */
1868
+ requestDuration?: number | undefined;
1869
+ /**
1870
+ * Displays the applicable rate limits for the current request.
1871
+ * @public
1872
+ */
1873
+ rateLimit?: string | undefined;
1874
+ /**
1875
+ * Indicates how many requests a user can still make within the current time window.
1876
+ * @public
1877
+ */
1878
+ rateLimitRemaining?: number | undefined;
1879
+ /**
1880
+ * Shows the time in seconds until the rate limit resets.
1881
+ * @public
1882
+ */
1883
+ rateLimitReset?: number | undefined;
1884
+ /**
1885
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1886
+ * @public
1887
+ */
1503
1888
  channelId: string;
1504
1889
  }
1505
1890
  /**
@@ -1516,6 +1901,10 @@ export interface GetFilePresignedDownloadUrlInput {
1516
1901
  * @public
1517
1902
  */
1518
1903
  userId?: string | undefined;
1904
+ /**
1905
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
1906
+ * @public
1907
+ */
1519
1908
  channelId: string;
1520
1909
  messageId: string;
1521
1910
  /**
@@ -1539,27 +1928,52 @@ export interface GetFilePresignedDownloadUrlInput {
1539
1928
  */
1540
1929
  export interface GetFilePresignedDownloadUrlOutput {
1541
1930
  /**
1542
- * Presigned URL for downloading the file.
1931
+ * The request ID of the request.
1543
1932
  * @public
1544
1933
  */
1545
- presignedDownloadUrl: string;
1546
- }
1547
- /**
1548
- * @public
1549
- */
1550
- export interface GetInboxInput {
1934
+ requestId?: string | undefined;
1551
1935
  /**
1552
- * The unique identifier of the tenant when a service token is used.
1936
+ * The duration of the request in milliseconds.
1553
1937
  * @public
1554
1938
  */
1555
- companyId?: string | undefined;
1939
+ requestDuration?: number | undefined;
1556
1940
  /**
1557
- * The unique identifier of the user when a service or PBX token is used.
1941
+ * Displays the applicable rate limits for the current request.
1558
1942
  * @public
1559
1943
  */
1560
- userId?: string | undefined;
1561
- }
1562
- /**
1944
+ rateLimit?: string | undefined;
1945
+ /**
1946
+ * Indicates how many requests a user can still make within the current time window.
1947
+ * @public
1948
+ */
1949
+ rateLimitRemaining?: number | undefined;
1950
+ /**
1951
+ * Shows the time in seconds until the rate limit resets.
1952
+ * @public
1953
+ */
1954
+ rateLimitReset?: number | undefined;
1955
+ /**
1956
+ * Presigned URL for downloading the file.
1957
+ * @public
1958
+ */
1959
+ presignedDownloadUrl: string;
1960
+ }
1961
+ /**
1962
+ * @public
1963
+ */
1964
+ export interface GetInboxInput {
1965
+ /**
1966
+ * The unique identifier of the tenant when a service token is used.
1967
+ * @public
1968
+ */
1969
+ companyId?: string | undefined;
1970
+ /**
1971
+ * The unique identifier of the user when a service or PBX token is used.
1972
+ * @public
1973
+ */
1974
+ userId?: string | undefined;
1975
+ }
1976
+ /**
1563
1977
  * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
1564
1978
  * @public
1565
1979
  */
@@ -1630,6 +2044,10 @@ export interface InboxState {
1630
2044
  * @public
1631
2045
  */
1632
2046
  export interface InboxChannel {
2047
+ /**
2048
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
2049
+ * @public
2050
+ */
1633
2051
  channelId: string;
1634
2052
  /**
1635
2053
  * Type of channel.
@@ -1798,6 +2216,31 @@ export interface InboxChannel {
1798
2216
  * @public
1799
2217
  */
1800
2218
  export interface GetInboxOutput {
2219
+ /**
2220
+ * The request ID of the request.
2221
+ * @public
2222
+ */
2223
+ requestId?: string | undefined;
2224
+ /**
2225
+ * The duration of the request in milliseconds.
2226
+ * @public
2227
+ */
2228
+ requestDuration?: number | undefined;
2229
+ /**
2230
+ * Displays the applicable rate limits for the current request.
2231
+ * @public
2232
+ */
2233
+ rateLimit?: string | undefined;
2234
+ /**
2235
+ * Indicates how many requests a user can still make within the current time window.
2236
+ * @public
2237
+ */
2238
+ rateLimitRemaining?: number | undefined;
2239
+ /**
2240
+ * Shows the time in seconds until the rate limit resets.
2241
+ * @public
2242
+ */
2243
+ rateLimitReset?: number | undefined;
1801
2244
  /**
1802
2245
  * Recent channels with per-user state and last-message preview.
1803
2246
  * @public
@@ -1823,6 +2266,10 @@ export interface GetMessageInput {
1823
2266
  * @public
1824
2267
  */
1825
2268
  userId?: string | undefined;
2269
+ /**
2270
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
2271
+ * @public
2272
+ */
1826
2273
  channelId: string;
1827
2274
  messageId: string;
1828
2275
  }
@@ -1830,6 +2277,31 @@ export interface GetMessageInput {
1830
2277
  * @public
1831
2278
  */
1832
2279
  export interface GetMessageOutput {
2280
+ /**
2281
+ * The request ID of the request.
2282
+ * @public
2283
+ */
2284
+ requestId?: string | undefined;
2285
+ /**
2286
+ * The duration of the request in milliseconds.
2287
+ * @public
2288
+ */
2289
+ requestDuration?: number | undefined;
2290
+ /**
2291
+ * Displays the applicable rate limits for the current request.
2292
+ * @public
2293
+ */
2294
+ rateLimit?: string | undefined;
2295
+ /**
2296
+ * Indicates how many requests a user can still make within the current time window.
2297
+ * @public
2298
+ */
2299
+ rateLimitRemaining?: number | undefined;
2300
+ /**
2301
+ * Shows the time in seconds until the rate limit resets.
2302
+ * @public
2303
+ */
2304
+ rateLimitReset?: number | undefined;
1833
2305
  /**
1834
2306
  * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
1835
2307
  * @public
@@ -1861,6 +2333,31 @@ export interface GetOrCreateDirectChannelInput {
1861
2333
  * @public
1862
2334
  */
1863
2335
  export interface GetOrCreateDirectChannelOutput {
2336
+ /**
2337
+ * The request ID of the request.
2338
+ * @public
2339
+ */
2340
+ requestId?: string | undefined;
2341
+ /**
2342
+ * The duration of the request in milliseconds.
2343
+ * @public
2344
+ */
2345
+ requestDuration?: number | undefined;
2346
+ /**
2347
+ * Displays the applicable rate limits for the current request.
2348
+ * @public
2349
+ */
2350
+ rateLimit?: string | undefined;
2351
+ /**
2352
+ * Indicates how many requests a user can still make within the current time window.
2353
+ * @public
2354
+ */
2355
+ rateLimitRemaining?: number | undefined;
2356
+ /**
2357
+ * Shows the time in seconds until the rate limit resets.
2358
+ * @public
2359
+ */
2360
+ rateLimitReset?: number | undefined;
1864
2361
  channel: Channel;
1865
2362
  }
1866
2363
  /**
@@ -1898,6 +2395,31 @@ export interface GetOrCreateSmsChannelInput {
1898
2395
  * @public
1899
2396
  */
1900
2397
  export interface GetOrCreateSmsChannelOutput {
2398
+ /**
2399
+ * The request ID of the request.
2400
+ * @public
2401
+ */
2402
+ requestId?: string | undefined;
2403
+ /**
2404
+ * The duration of the request in milliseconds.
2405
+ * @public
2406
+ */
2407
+ requestDuration?: number | undefined;
2408
+ /**
2409
+ * Displays the applicable rate limits for the current request.
2410
+ * @public
2411
+ */
2412
+ rateLimit?: string | undefined;
2413
+ /**
2414
+ * Indicates how many requests a user can still make within the current time window.
2415
+ * @public
2416
+ */
2417
+ rateLimitRemaining?: number | undefined;
2418
+ /**
2419
+ * Shows the time in seconds until the rate limit resets.
2420
+ * @public
2421
+ */
2422
+ rateLimitReset?: number | undefined;
1901
2423
  channel: Channel;
1902
2424
  }
1903
2425
  /**
@@ -1934,6 +2456,31 @@ export interface GetOrCreateTelephonyChannelInput {
1934
2456
  * @public
1935
2457
  */
1936
2458
  export interface GetOrCreateTelephonyChannelOutput {
2459
+ /**
2460
+ * The request ID of the request.
2461
+ * @public
2462
+ */
2463
+ requestId?: string | undefined;
2464
+ /**
2465
+ * The duration of the request in milliseconds.
2466
+ * @public
2467
+ */
2468
+ requestDuration?: number | undefined;
2469
+ /**
2470
+ * Displays the applicable rate limits for the current request.
2471
+ * @public
2472
+ */
2473
+ rateLimit?: string | undefined;
2474
+ /**
2475
+ * Indicates how many requests a user can still make within the current time window.
2476
+ * @public
2477
+ */
2478
+ rateLimitRemaining?: number | undefined;
2479
+ /**
2480
+ * Shows the time in seconds until the rate limit resets.
2481
+ * @public
2482
+ */
2483
+ rateLimitReset?: number | undefined;
1937
2484
  channel: Channel;
1938
2485
  }
1939
2486
  /**
@@ -1971,6 +2518,31 @@ export interface GetOrCreateWhatsAppChannelInput {
1971
2518
  * @public
1972
2519
  */
1973
2520
  export interface GetOrCreateWhatsAppChannelOutput {
2521
+ /**
2522
+ * The request ID of the request.
2523
+ * @public
2524
+ */
2525
+ requestId?: string | undefined;
2526
+ /**
2527
+ * The duration of the request in milliseconds.
2528
+ * @public
2529
+ */
2530
+ requestDuration?: number | undefined;
2531
+ /**
2532
+ * Displays the applicable rate limits for the current request.
2533
+ * @public
2534
+ */
2535
+ rateLimit?: string | undefined;
2536
+ /**
2537
+ * Indicates how many requests a user can still make within the current time window.
2538
+ * @public
2539
+ */
2540
+ rateLimitRemaining?: number | undefined;
2541
+ /**
2542
+ * Shows the time in seconds until the rate limit resets.
2543
+ * @public
2544
+ */
2545
+ rateLimitReset?: number | undefined;
1974
2546
  channel: Channel;
1975
2547
  }
1976
2548
  /**
@@ -2007,6 +2579,35 @@ export interface GetSmsChannelIdInput {
2007
2579
  * @public
2008
2580
  */
2009
2581
  export interface GetSmsChannelIdOutput {
2582
+ /**
2583
+ * The request ID of the request.
2584
+ * @public
2585
+ */
2586
+ requestId?: string | undefined;
2587
+ /**
2588
+ * The duration of the request in milliseconds.
2589
+ * @public
2590
+ */
2591
+ requestDuration?: number | undefined;
2592
+ /**
2593
+ * Displays the applicable rate limits for the current request.
2594
+ * @public
2595
+ */
2596
+ rateLimit?: string | undefined;
2597
+ /**
2598
+ * Indicates how many requests a user can still make within the current time window.
2599
+ * @public
2600
+ */
2601
+ rateLimitRemaining?: number | undefined;
2602
+ /**
2603
+ * Shows the time in seconds until the rate limit resets.
2604
+ * @public
2605
+ */
2606
+ rateLimitReset?: number | undefined;
2607
+ /**
2608
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
2609
+ * @public
2610
+ */
2010
2611
  channelId: string;
2011
2612
  }
2012
2613
  /**
@@ -2043,6 +2644,35 @@ export interface GetTelephonyChannelIdInput {
2043
2644
  * @public
2044
2645
  */
2045
2646
  export interface GetTelephonyChannelIdOutput {
2647
+ /**
2648
+ * The request ID of the request.
2649
+ * @public
2650
+ */
2651
+ requestId?: string | undefined;
2652
+ /**
2653
+ * The duration of the request in milliseconds.
2654
+ * @public
2655
+ */
2656
+ requestDuration?: number | undefined;
2657
+ /**
2658
+ * Displays the applicable rate limits for the current request.
2659
+ * @public
2660
+ */
2661
+ rateLimit?: string | undefined;
2662
+ /**
2663
+ * Indicates how many requests a user can still make within the current time window.
2664
+ * @public
2665
+ */
2666
+ rateLimitRemaining?: number | undefined;
2667
+ /**
2668
+ * Shows the time in seconds until the rate limit resets.
2669
+ * @public
2670
+ */
2671
+ rateLimitReset?: number | undefined;
2672
+ /**
2673
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
2674
+ * @public
2675
+ */
2046
2676
  channelId: string;
2047
2677
  }
2048
2678
  /**
@@ -2069,6 +2699,31 @@ export interface GetTokenInput {
2069
2699
  * @public
2070
2700
  */
2071
2701
  export interface GetTokenOutput {
2702
+ /**
2703
+ * The request ID of the request.
2704
+ * @public
2705
+ */
2706
+ requestId?: string | undefined;
2707
+ /**
2708
+ * The duration of the request in milliseconds.
2709
+ * @public
2710
+ */
2711
+ requestDuration?: number | undefined;
2712
+ /**
2713
+ * Displays the applicable rate limits for the current request.
2714
+ * @public
2715
+ */
2716
+ rateLimit?: string | undefined;
2717
+ /**
2718
+ * Indicates how many requests a user can still make within the current time window.
2719
+ * @public
2720
+ */
2721
+ rateLimitRemaining?: number | undefined;
2722
+ /**
2723
+ * Shows the time in seconds until the rate limit resets.
2724
+ * @public
2725
+ */
2726
+ rateLimitReset?: number | undefined;
2072
2727
  /**
2073
2728
  * Authorization token.
2074
2729
  * @public
@@ -2094,6 +2749,10 @@ export interface GetUploadedFileInfoInput {
2094
2749
  * @public
2095
2750
  */
2096
2751
  userId?: string | undefined;
2752
+ /**
2753
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
2754
+ * @public
2755
+ */
2097
2756
  channelId: string;
2098
2757
  /**
2099
2758
  * File service identifier returned by `UploadFile`.
@@ -2151,6 +2810,31 @@ export interface UploadedFileInfo {
2151
2810
  * @public
2152
2811
  */
2153
2812
  export interface GetUploadedFileInfoOutput {
2813
+ /**
2814
+ * The request ID of the request.
2815
+ * @public
2816
+ */
2817
+ requestId?: string | undefined;
2818
+ /**
2819
+ * The duration of the request in milliseconds.
2820
+ * @public
2821
+ */
2822
+ requestDuration?: number | undefined;
2823
+ /**
2824
+ * Displays the applicable rate limits for the current request.
2825
+ * @public
2826
+ */
2827
+ rateLimit?: string | undefined;
2828
+ /**
2829
+ * Indicates how many requests a user can still make within the current time window.
2830
+ * @public
2831
+ */
2832
+ rateLimitRemaining?: number | undefined;
2833
+ /**
2834
+ * Shows the time in seconds until the rate limit resets.
2835
+ * @public
2836
+ */
2837
+ rateLimitReset?: number | undefined;
2154
2838
  /**
2155
2839
  * Metadata for a file uploaded to the channel file store but not yet attached to a message.
2156
2840
  * @public
@@ -2191,6 +2875,35 @@ export interface GetWhatsAppChannelIdInput {
2191
2875
  * @public
2192
2876
  */
2193
2877
  export interface GetWhatsAppChannelIdOutput {
2878
+ /**
2879
+ * The request ID of the request.
2880
+ * @public
2881
+ */
2882
+ requestId?: string | undefined;
2883
+ /**
2884
+ * The duration of the request in milliseconds.
2885
+ * @public
2886
+ */
2887
+ requestDuration?: number | undefined;
2888
+ /**
2889
+ * Displays the applicable rate limits for the current request.
2890
+ * @public
2891
+ */
2892
+ rateLimit?: string | undefined;
2893
+ /**
2894
+ * Indicates how many requests a user can still make within the current time window.
2895
+ * @public
2896
+ */
2897
+ rateLimitRemaining?: number | undefined;
2898
+ /**
2899
+ * Shows the time in seconds until the rate limit resets.
2900
+ * @public
2901
+ */
2902
+ rateLimitReset?: number | undefined;
2903
+ /**
2904
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
2905
+ * @public
2906
+ */
2194
2907
  channelId: string;
2195
2908
  }
2196
2909
  /**
@@ -2207,6 +2920,10 @@ export interface HardDeleteChannelInput {
2207
2920
  * @public
2208
2921
  */
2209
2922
  userId?: string | undefined;
2923
+ /**
2924
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
2925
+ * @public
2926
+ */
2210
2927
  channelId: string;
2211
2928
  }
2212
2929
  /**
@@ -2223,12 +2940,41 @@ export interface HideChannelInput {
2223
2940
  * @public
2224
2941
  */
2225
2942
  userId?: string | undefined;
2943
+ /**
2944
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
2945
+ * @public
2946
+ */
2226
2947
  channelId: string;
2227
2948
  }
2228
2949
  /**
2229
2950
  * @public
2230
2951
  */
2231
2952
  export interface HideChannelOutput {
2953
+ /**
2954
+ * The request ID of the request.
2955
+ * @public
2956
+ */
2957
+ requestId?: string | undefined;
2958
+ /**
2959
+ * The duration of the request in milliseconds.
2960
+ * @public
2961
+ */
2962
+ requestDuration?: number | undefined;
2963
+ /**
2964
+ * Displays the applicable rate limits for the current request.
2965
+ * @public
2966
+ */
2967
+ rateLimit?: string | undefined;
2968
+ /**
2969
+ * Indicates how many requests a user can still make within the current time window.
2970
+ * @public
2971
+ */
2972
+ rateLimitRemaining?: number | undefined;
2973
+ /**
2974
+ * Shows the time in seconds until the rate limit resets.
2975
+ * @public
2976
+ */
2977
+ rateLimitReset?: number | undefined;
2232
2978
  }
2233
2979
  /**
2234
2980
  * @public
@@ -2244,6 +2990,10 @@ export interface JoinChannelInput {
2244
2990
  * @public
2245
2991
  */
2246
2992
  userId?: string | undefined;
2993
+ /**
2994
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
2995
+ * @public
2996
+ */
2247
2997
  channelId: string;
2248
2998
  silent?: boolean | undefined;
2249
2999
  }
@@ -2251,6 +3001,31 @@ export interface JoinChannelInput {
2251
3001
  * @public
2252
3002
  */
2253
3003
  export interface JoinChannelOutput {
3004
+ /**
3005
+ * The request ID of the request.
3006
+ * @public
3007
+ */
3008
+ requestId?: string | undefined;
3009
+ /**
3010
+ * The duration of the request in milliseconds.
3011
+ * @public
3012
+ */
3013
+ requestDuration?: number | undefined;
3014
+ /**
3015
+ * Displays the applicable rate limits for the current request.
3016
+ * @public
3017
+ */
3018
+ rateLimit?: string | undefined;
3019
+ /**
3020
+ * Indicates how many requests a user can still make within the current time window.
3021
+ * @public
3022
+ */
3023
+ rateLimitRemaining?: number | undefined;
3024
+ /**
3025
+ * Shows the time in seconds until the rate limit resets.
3026
+ * @public
3027
+ */
3028
+ rateLimitReset?: number | undefined;
2254
3029
  channel: Channel;
2255
3030
  }
2256
3031
  /**
@@ -2267,6 +3042,10 @@ export interface LeaveChannelInput {
2267
3042
  * @public
2268
3043
  */
2269
3044
  userId?: string | undefined;
3045
+ /**
3046
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3047
+ * @public
3048
+ */
2270
3049
  channelId: string;
2271
3050
  silent?: boolean | undefined;
2272
3051
  }
@@ -2274,6 +3053,31 @@ export interface LeaveChannelInput {
2274
3053
  * @public
2275
3054
  */
2276
3055
  export interface LeaveChannelOutput {
3056
+ /**
3057
+ * The request ID of the request.
3058
+ * @public
3059
+ */
3060
+ requestId?: string | undefined;
3061
+ /**
3062
+ * The duration of the request in milliseconds.
3063
+ * @public
3064
+ */
3065
+ requestDuration?: number | undefined;
3066
+ /**
3067
+ * Displays the applicable rate limits for the current request.
3068
+ * @public
3069
+ */
3070
+ rateLimit?: string | undefined;
3071
+ /**
3072
+ * Indicates how many requests a user can still make within the current time window.
3073
+ * @public
3074
+ */
3075
+ rateLimitRemaining?: number | undefined;
3076
+ /**
3077
+ * Shows the time in seconds until the rate limit resets.
3078
+ * @public
3079
+ */
3080
+ rateLimitReset?: number | undefined;
2277
3081
  }
2278
3082
  /**
2279
3083
  * @public
@@ -2289,6 +3093,10 @@ export interface ListChannelMembersInput {
2289
3093
  * @public
2290
3094
  */
2291
3095
  userId?: string | undefined;
3096
+ /**
3097
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3098
+ * @public
3099
+ */
2292
3100
  channelId: string;
2293
3101
  limit?: number | undefined;
2294
3102
  offset?: number | undefined;
@@ -2297,6 +3105,31 @@ export interface ListChannelMembersInput {
2297
3105
  * @public
2298
3106
  */
2299
3107
  export interface ListChannelMembersOutput {
3108
+ /**
3109
+ * The request ID of the request.
3110
+ * @public
3111
+ */
3112
+ requestId?: string | undefined;
3113
+ /**
3114
+ * The duration of the request in milliseconds.
3115
+ * @public
3116
+ */
3117
+ requestDuration?: number | undefined;
3118
+ /**
3119
+ * Displays the applicable rate limits for the current request.
3120
+ * @public
3121
+ */
3122
+ rateLimit?: string | undefined;
3123
+ /**
3124
+ * Indicates how many requests a user can still make within the current time window.
3125
+ * @public
3126
+ */
3127
+ rateLimitRemaining?: number | undefined;
3128
+ /**
3129
+ * Shows the time in seconds until the rate limit resets.
3130
+ * @public
3131
+ */
3132
+ rateLimitReset?: number | undefined;
2300
3133
  members: ChannelMember[];
2301
3134
  }
2302
3135
  /**
@@ -2313,12 +3146,41 @@ export interface ListChannelMembersReadStatusInput {
2313
3146
  * @public
2314
3147
  */
2315
3148
  userId?: string | undefined;
3149
+ /**
3150
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3151
+ * @public
3152
+ */
2316
3153
  channelId: string;
2317
3154
  }
2318
3155
  /**
2319
3156
  * @public
2320
3157
  */
2321
3158
  export interface ListChannelMembersReadStatusOutput {
3159
+ /**
3160
+ * The request ID of the request.
3161
+ * @public
3162
+ */
3163
+ requestId?: string | undefined;
3164
+ /**
3165
+ * The duration of the request in milliseconds.
3166
+ * @public
3167
+ */
3168
+ requestDuration?: number | undefined;
3169
+ /**
3170
+ * Displays the applicable rate limits for the current request.
3171
+ * @public
3172
+ */
3173
+ rateLimit?: string | undefined;
3174
+ /**
3175
+ * Indicates how many requests a user can still make within the current time window.
3176
+ * @public
3177
+ */
3178
+ rateLimitRemaining?: number | undefined;
3179
+ /**
3180
+ * Shows the time in seconds until the rate limit resets.
3181
+ * @public
3182
+ */
3183
+ rateLimitReset?: number | undefined;
2322
3184
  members: ChannelMemberReadStatus[];
2323
3185
  }
2324
3186
  /**
@@ -2329,32 +3191,57 @@ export interface ListChannelsInput {
2329
3191
  * The unique identifier of the tenant when a service token is used.
2330
3192
  * @public
2331
3193
  */
2332
- companyId?: string | undefined;
3194
+ companyId?: string | undefined;
3195
+ /**
3196
+ * The unique identifier of the user when a service or PBX token is used.
3197
+ * @public
3198
+ */
3199
+ userId?: string | undefined;
3200
+ /**
3201
+ * Section to list. Defaults to `all`.
3202
+ * @public
3203
+ */
3204
+ section?: string | undefined;
3205
+ /**
3206
+ * Optional refinement applied on top of the section.
3207
+ * @public
3208
+ */
3209
+ filter?: ChannelsFilter | undefined;
3210
+ /**
3211
+ * Opaque continuation token from the previous response.
3212
+ * @public
3213
+ */
3214
+ cursor?: string | undefined;
3215
+ }
3216
+ /**
3217
+ * @public
3218
+ */
3219
+ export interface ListChannelsOutput {
3220
+ /**
3221
+ * The request ID of the request.
3222
+ * @public
3223
+ */
3224
+ requestId?: string | undefined;
2333
3225
  /**
2334
- * The unique identifier of the user when a service or PBX token is used.
3226
+ * The duration of the request in milliseconds.
2335
3227
  * @public
2336
3228
  */
2337
- userId?: string | undefined;
3229
+ requestDuration?: number | undefined;
2338
3230
  /**
2339
- * Section to list. Defaults to `all`.
3231
+ * Displays the applicable rate limits for the current request.
2340
3232
  * @public
2341
3233
  */
2342
- section?: string | undefined;
3234
+ rateLimit?: string | undefined;
2343
3235
  /**
2344
- * Optional refinement applied on top of the section.
3236
+ * Indicates how many requests a user can still make within the current time window.
2345
3237
  * @public
2346
3238
  */
2347
- filter?: ChannelsFilter | undefined;
3239
+ rateLimitRemaining?: number | undefined;
2348
3240
  /**
2349
- * Opaque continuation token from the previous response.
3241
+ * Shows the time in seconds until the rate limit resets.
2350
3242
  * @public
2351
3243
  */
2352
- cursor?: string | undefined;
2353
- }
2354
- /**
2355
- * @public
2356
- */
2357
- export interface ListChannelsOutput {
3244
+ rateLimitReset?: number | undefined;
2358
3245
  /**
2359
3246
  * Ordered page of channels for the requested section.
2360
3247
  * @public
@@ -2396,6 +3283,10 @@ export interface ListMentionsInput {
2396
3283
  * @public
2397
3284
  */
2398
3285
  export interface MentionChannelPreview {
3286
+ /**
3287
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3288
+ * @public
3289
+ */
2399
3290
  channelId: string;
2400
3291
  /**
2401
3292
  * Type of channel.
@@ -2438,6 +3329,10 @@ export interface MentionChannelPreview {
2438
3329
  * @public
2439
3330
  */
2440
3331
  export interface MentionEntry {
3332
+ /**
3333
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3334
+ * @public
3335
+ */
2441
3336
  channelId: string;
2442
3337
  messageId: string;
2443
3338
  /**
@@ -2480,6 +3375,31 @@ export interface MentionEntry {
2480
3375
  * @public
2481
3376
  */
2482
3377
  export interface ListMentionsOutput {
3378
+ /**
3379
+ * The request ID of the request.
3380
+ * @public
3381
+ */
3382
+ requestId?: string | undefined;
3383
+ /**
3384
+ * The duration of the request in milliseconds.
3385
+ * @public
3386
+ */
3387
+ requestDuration?: number | undefined;
3388
+ /**
3389
+ * Displays the applicable rate limits for the current request.
3390
+ * @public
3391
+ */
3392
+ rateLimit?: string | undefined;
3393
+ /**
3394
+ * Indicates how many requests a user can still make within the current time window.
3395
+ * @public
3396
+ */
3397
+ rateLimitRemaining?: number | undefined;
3398
+ /**
3399
+ * Shows the time in seconds until the rate limit resets.
3400
+ * @public
3401
+ */
3402
+ rateLimitReset?: number | undefined;
2483
3403
  /**
2484
3404
  * Mentions ordered by most recent `mentionAddedAt` first.
2485
3405
  * @public
@@ -2505,6 +3425,10 @@ export interface ListMessagesInput {
2505
3425
  * @public
2506
3426
  */
2507
3427
  userId?: string | undefined;
3428
+ /**
3429
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3430
+ * @public
3431
+ */
2508
3432
  channelId: string;
2509
3433
  /**
2510
3434
  * Optional inclusive lower bound on `timelineSeq`. Combine with `to` for a bounded window, or use alone to scroll forward from a known anchor.
@@ -2526,6 +3450,31 @@ export interface ListMessagesInput {
2526
3450
  * @public
2527
3451
  */
2528
3452
  export interface ListMessagesOutput {
3453
+ /**
3454
+ * The request ID of the request.
3455
+ * @public
3456
+ */
3457
+ requestId?: string | undefined;
3458
+ /**
3459
+ * The duration of the request in milliseconds.
3460
+ * @public
3461
+ */
3462
+ requestDuration?: number | undefined;
3463
+ /**
3464
+ * Displays the applicable rate limits for the current request.
3465
+ * @public
3466
+ */
3467
+ rateLimit?: string | undefined;
3468
+ /**
3469
+ * Indicates how many requests a user can still make within the current time window.
3470
+ * @public
3471
+ */
3472
+ rateLimitRemaining?: number | undefined;
3473
+ /**
3474
+ * Shows the time in seconds until the rate limit resets.
3475
+ * @public
3476
+ */
3477
+ rateLimitReset?: number | undefined;
2529
3478
  /**
2530
3479
  * Messages ordered newest-first by `timelineSeq`.
2531
3480
  * @public
@@ -2551,6 +3500,10 @@ export interface MarkReadInput {
2551
3500
  * @public
2552
3501
  */
2553
3502
  userId?: string | undefined;
3503
+ /**
3504
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3505
+ * @public
3506
+ */
2554
3507
  channelId: string;
2555
3508
  /**
2556
3509
  * Optional explicit read pointer. Defaults to the latest visible message.
@@ -2567,6 +3520,31 @@ export interface MarkReadInput {
2567
3520
  * @public
2568
3521
  */
2569
3522
  export interface MarkReadOutput {
3523
+ /**
3524
+ * The request ID of the request.
3525
+ * @public
3526
+ */
3527
+ requestId?: string | undefined;
3528
+ /**
3529
+ * The duration of the request in milliseconds.
3530
+ * @public
3531
+ */
3532
+ requestDuration?: number | undefined;
3533
+ /**
3534
+ * Displays the applicable rate limits for the current request.
3535
+ * @public
3536
+ */
3537
+ rateLimit?: string | undefined;
3538
+ /**
3539
+ * Indicates how many requests a user can still make within the current time window.
3540
+ * @public
3541
+ */
3542
+ rateLimitRemaining?: number | undefined;
3543
+ /**
3544
+ * Shows the time in seconds until the rate limit resets.
3545
+ * @public
3546
+ */
3547
+ rateLimitReset?: number | undefined;
2570
3548
  /**
2571
3549
  * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
2572
3550
  * @public
@@ -2587,6 +3565,10 @@ export interface MarkUnreadInput {
2587
3565
  * @public
2588
3566
  */
2589
3567
  userId?: string | undefined;
3568
+ /**
3569
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3570
+ * @public
3571
+ */
2590
3572
  channelId: string;
2591
3573
  /**
2592
3574
  * Message id used to resolve the unread mark position.
@@ -2608,6 +3590,31 @@ export interface MarkUnreadInput {
2608
3590
  * @public
2609
3591
  */
2610
3592
  export interface MarkUnreadOutput {
3593
+ /**
3594
+ * The request ID of the request.
3595
+ * @public
3596
+ */
3597
+ requestId?: string | undefined;
3598
+ /**
3599
+ * The duration of the request in milliseconds.
3600
+ * @public
3601
+ */
3602
+ requestDuration?: number | undefined;
3603
+ /**
3604
+ * Displays the applicable rate limits for the current request.
3605
+ * @public
3606
+ */
3607
+ rateLimit?: string | undefined;
3608
+ /**
3609
+ * Indicates how many requests a user can still make within the current time window.
3610
+ * @public
3611
+ */
3612
+ rateLimitRemaining?: number | undefined;
3613
+ /**
3614
+ * Shows the time in seconds until the rate limit resets.
3615
+ * @public
3616
+ */
3617
+ rateLimitReset?: number | undefined;
2611
3618
  /**
2612
3619
  * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
2613
3620
  * @public
@@ -2628,6 +3635,10 @@ export interface MoveChannelToSectionInput {
2628
3635
  * @public
2629
3636
  */
2630
3637
  userId?: string | undefined;
3638
+ /**
3639
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3640
+ * @public
3641
+ */
2631
3642
  channelId: string;
2632
3643
  /**
2633
3644
  * Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
@@ -2639,6 +3650,31 @@ export interface MoveChannelToSectionInput {
2639
3650
  * @public
2640
3651
  */
2641
3652
  export interface MoveChannelToSectionOutput {
3653
+ /**
3654
+ * The request ID of the request.
3655
+ * @public
3656
+ */
3657
+ requestId?: string | undefined;
3658
+ /**
3659
+ * The duration of the request in milliseconds.
3660
+ * @public
3661
+ */
3662
+ requestDuration?: number | undefined;
3663
+ /**
3664
+ * Displays the applicable rate limits for the current request.
3665
+ * @public
3666
+ */
3667
+ rateLimit?: string | undefined;
3668
+ /**
3669
+ * Indicates how many requests a user can still make within the current time window.
3670
+ * @public
3671
+ */
3672
+ rateLimitRemaining?: number | undefined;
3673
+ /**
3674
+ * Shows the time in seconds until the rate limit resets.
3675
+ * @public
3676
+ */
3677
+ rateLimitReset?: number | undefined;
2642
3678
  /**
2643
3679
  * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
2644
3680
  * @public
@@ -2666,6 +3702,10 @@ export interface MuteChannelInput {
2666
3702
  * @public
2667
3703
  */
2668
3704
  userId?: string | undefined;
3705
+ /**
3706
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3707
+ * @public
3708
+ */
2669
3709
  channelId: string;
2670
3710
  /**
2671
3711
  * Temporary mute expiry. Omit for indefinite mute.
@@ -2677,6 +3717,31 @@ export interface MuteChannelInput {
2677
3717
  * @public
2678
3718
  */
2679
3719
  export interface MuteChannelOutput {
3720
+ /**
3721
+ * The request ID of the request.
3722
+ * @public
3723
+ */
3724
+ requestId?: string | undefined;
3725
+ /**
3726
+ * The duration of the request in milliseconds.
3727
+ * @public
3728
+ */
3729
+ requestDuration?: number | undefined;
3730
+ /**
3731
+ * Displays the applicable rate limits for the current request.
3732
+ * @public
3733
+ */
3734
+ rateLimit?: string | undefined;
3735
+ /**
3736
+ * Indicates how many requests a user can still make within the current time window.
3737
+ * @public
3738
+ */
3739
+ rateLimitRemaining?: number | undefined;
3740
+ /**
3741
+ * Shows the time in seconds until the rate limit resets.
3742
+ * @public
3743
+ */
3744
+ rateLimitReset?: number | undefined;
2680
3745
  /**
2681
3746
  * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
2682
3747
  * @public
@@ -2799,6 +3864,10 @@ export interface PartialUpdateChannelInput {
2799
3864
  * @public
2800
3865
  */
2801
3866
  userId?: string | undefined;
3867
+ /**
3868
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3869
+ * @public
3870
+ */
2802
3871
  channelId: string;
2803
3872
  silent?: boolean | undefined;
2804
3873
  set?: PartialUpdateChannelSetOptions | undefined;
@@ -2808,6 +3877,31 @@ export interface PartialUpdateChannelInput {
2808
3877
  * @public
2809
3878
  */
2810
3879
  export interface PartialUpdateChannelOutput {
3880
+ /**
3881
+ * The request ID of the request.
3882
+ * @public
3883
+ */
3884
+ requestId?: string | undefined;
3885
+ /**
3886
+ * The duration of the request in milliseconds.
3887
+ * @public
3888
+ */
3889
+ requestDuration?: number | undefined;
3890
+ /**
3891
+ * Displays the applicable rate limits for the current request.
3892
+ * @public
3893
+ */
3894
+ rateLimit?: string | undefined;
3895
+ /**
3896
+ * Indicates how many requests a user can still make within the current time window.
3897
+ * @public
3898
+ */
3899
+ rateLimitRemaining?: number | undefined;
3900
+ /**
3901
+ * Shows the time in seconds until the rate limit resets.
3902
+ * @public
3903
+ */
3904
+ rateLimitReset?: number | undefined;
2811
3905
  channel: Channel;
2812
3906
  }
2813
3907
  /**
@@ -2876,6 +3970,10 @@ export interface PartialUpdateMessageInput {
2876
3970
  * @public
2877
3971
  */
2878
3972
  userId?: string | undefined;
3973
+ /**
3974
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
3975
+ * @public
3976
+ */
2879
3977
  channelId: string;
2880
3978
  messageId: string;
2881
3979
  /**
@@ -2903,6 +4001,31 @@ export interface PartialUpdateMessageOutput {
2903
4001
  * @public
2904
4002
  */
2905
4003
  message: Message;
4004
+ /**
4005
+ * The request ID of the request.
4006
+ * @public
4007
+ */
4008
+ requestId?: string | undefined;
4009
+ /**
4010
+ * The duration of the request in milliseconds.
4011
+ * @public
4012
+ */
4013
+ requestDuration?: number | undefined;
4014
+ /**
4015
+ * Displays the applicable rate limits for the current request.
4016
+ * @public
4017
+ */
4018
+ rateLimit?: string | undefined;
4019
+ /**
4020
+ * Indicates how many requests a user can still make within the current time window.
4021
+ * @public
4022
+ */
4023
+ rateLimitRemaining?: number | undefined;
4024
+ /**
4025
+ * Shows the time in seconds until the rate limit resets.
4026
+ * @public
4027
+ */
4028
+ rateLimitReset?: number | undefined;
2906
4029
  }
2907
4030
  /**
2908
4031
  * @public
@@ -2918,12 +4041,41 @@ export interface PinChannelInput {
2918
4041
  * @public
2919
4042
  */
2920
4043
  userId?: string | undefined;
4044
+ /**
4045
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4046
+ * @public
4047
+ */
2921
4048
  channelId: string;
2922
4049
  }
2923
4050
  /**
2924
4051
  * @public
2925
4052
  */
2926
4053
  export interface PinChannelOutput {
4054
+ /**
4055
+ * The request ID of the request.
4056
+ * @public
4057
+ */
4058
+ requestId?: string | undefined;
4059
+ /**
4060
+ * The duration of the request in milliseconds.
4061
+ * @public
4062
+ */
4063
+ requestDuration?: number | undefined;
4064
+ /**
4065
+ * Displays the applicable rate limits for the current request.
4066
+ * @public
4067
+ */
4068
+ rateLimit?: string | undefined;
4069
+ /**
4070
+ * Indicates how many requests a user can still make within the current time window.
4071
+ * @public
4072
+ */
4073
+ rateLimitRemaining?: number | undefined;
4074
+ /**
4075
+ * Shows the time in seconds until the rate limit resets.
4076
+ * @public
4077
+ */
4078
+ rateLimitReset?: number | undefined;
2927
4079
  }
2928
4080
  /**
2929
4081
  * @public
@@ -2939,6 +4091,10 @@ export interface PinMessageInput {
2939
4091
  * @public
2940
4092
  */
2941
4093
  userId?: string | undefined;
4094
+ /**
4095
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4096
+ * @public
4097
+ */
2942
4098
  channelId: string;
2943
4099
  messageId: string;
2944
4100
  }
@@ -2951,6 +4107,31 @@ export interface PinMessageOutput {
2951
4107
  * @public
2952
4108
  */
2953
4109
  message: Message;
4110
+ /**
4111
+ * The request ID of the request.
4112
+ * @public
4113
+ */
4114
+ requestId?: string | undefined;
4115
+ /**
4116
+ * The duration of the request in milliseconds.
4117
+ * @public
4118
+ */
4119
+ requestDuration?: number | undefined;
4120
+ /**
4121
+ * Displays the applicable rate limits for the current request.
4122
+ * @public
4123
+ */
4124
+ rateLimit?: string | undefined;
4125
+ /**
4126
+ * Indicates how many requests a user can still make within the current time window.
4127
+ * @public
4128
+ */
4129
+ rateLimitRemaining?: number | undefined;
4130
+ /**
4131
+ * Shows the time in seconds until the rate limit resets.
4132
+ * @public
4133
+ */
4134
+ rateLimitReset?: number | undefined;
2954
4135
  }
2955
4136
  /**
2956
4137
  * @public
@@ -2976,6 +4157,31 @@ export interface QueryChannelsInput {
2976
4157
  * @public
2977
4158
  */
2978
4159
  export interface QueryChannelsOutput {
4160
+ /**
4161
+ * The request ID of the request.
4162
+ * @public
4163
+ */
4164
+ requestId?: string | undefined;
4165
+ /**
4166
+ * The duration of the request in milliseconds.
4167
+ * @public
4168
+ */
4169
+ requestDuration?: number | undefined;
4170
+ /**
4171
+ * Displays the applicable rate limits for the current request.
4172
+ * @public
4173
+ */
4174
+ rateLimit?: string | undefined;
4175
+ /**
4176
+ * Indicates how many requests a user can still make within the current time window.
4177
+ * @public
4178
+ */
4179
+ rateLimitRemaining?: number | undefined;
4180
+ /**
4181
+ * Shows the time in seconds until the rate limit resets.
4182
+ * @public
4183
+ */
4184
+ rateLimitReset?: number | undefined;
2979
4185
  channels: InboxChannel[];
2980
4186
  }
2981
4187
  /**
@@ -2992,6 +4198,10 @@ export interface RemoveChannelFromSectionInput {
2992
4198
  * @public
2993
4199
  */
2994
4200
  userId?: string | undefined;
4201
+ /**
4202
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4203
+ * @public
4204
+ */
2995
4205
  channelId: string;
2996
4206
  /**
2997
4207
  * Identifier of an inbox section. System ids: `all`, `direct`, `group`, `external`, `mentions`. Custom ids are user-defined.
@@ -3003,6 +4213,31 @@ export interface RemoveChannelFromSectionInput {
3003
4213
  * @public
3004
4214
  */
3005
4215
  export interface RemoveChannelFromSectionOutput {
4216
+ /**
4217
+ * The request ID of the request.
4218
+ * @public
4219
+ */
4220
+ requestId?: string | undefined;
4221
+ /**
4222
+ * The duration of the request in milliseconds.
4223
+ * @public
4224
+ */
4225
+ requestDuration?: number | undefined;
4226
+ /**
4227
+ * Displays the applicable rate limits for the current request.
4228
+ * @public
4229
+ */
4230
+ rateLimit?: string | undefined;
4231
+ /**
4232
+ * Indicates how many requests a user can still make within the current time window.
4233
+ * @public
4234
+ */
4235
+ rateLimitRemaining?: number | undefined;
4236
+ /**
4237
+ * Shows the time in seconds until the rate limit resets.
4238
+ * @public
4239
+ */
4240
+ rateLimitReset?: number | undefined;
3006
4241
  /**
3007
4242
  * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
3008
4243
  * @public
@@ -3034,6 +4269,31 @@ export interface RenameSectionInput {
3034
4269
  * @public
3035
4270
  */
3036
4271
  export interface RenameSectionOutput {
4272
+ /**
4273
+ * The request ID of the request.
4274
+ * @public
4275
+ */
4276
+ requestId?: string | undefined;
4277
+ /**
4278
+ * The duration of the request in milliseconds.
4279
+ * @public
4280
+ */
4281
+ requestDuration?: number | undefined;
4282
+ /**
4283
+ * Displays the applicable rate limits for the current request.
4284
+ * @public
4285
+ */
4286
+ rateLimit?: string | undefined;
4287
+ /**
4288
+ * Indicates how many requests a user can still make within the current time window.
4289
+ * @public
4290
+ */
4291
+ rateLimitRemaining?: number | undefined;
4292
+ /**
4293
+ * Shows the time in seconds until the rate limit resets.
4294
+ * @public
4295
+ */
4296
+ rateLimitReset?: number | undefined;
3037
4297
  /**
3038
4298
  * Inbox section with metadata, channel count, and unread counters.
3039
4299
  * @public
@@ -3100,6 +4360,31 @@ export interface SearchChannelsInput {
3100
4360
  * @public
3101
4361
  */
3102
4362
  export interface SearchChannelsOutput {
4363
+ /**
4364
+ * The request ID of the request.
4365
+ * @public
4366
+ */
4367
+ requestId?: string | undefined;
4368
+ /**
4369
+ * The duration of the request in milliseconds.
4370
+ * @public
4371
+ */
4372
+ requestDuration?: number | undefined;
4373
+ /**
4374
+ * Displays the applicable rate limits for the current request.
4375
+ * @public
4376
+ */
4377
+ rateLimit?: string | undefined;
4378
+ /**
4379
+ * Indicates how many requests a user can still make within the current time window.
4380
+ * @public
4381
+ */
4382
+ rateLimitRemaining?: number | undefined;
4383
+ /**
4384
+ * Shows the time in seconds until the rate limit resets.
4385
+ * @public
4386
+ */
4387
+ rateLimitReset?: number | undefined;
3103
4388
  /**
3104
4389
  * Matching channels ordered by relevance.
3105
4390
  * @public
@@ -3115,6 +4400,10 @@ export interface SearchChannelsOutput {
3115
4400
  * @public
3116
4401
  */
3117
4402
  export interface SearchMessageHit {
4403
+ /**
4404
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4405
+ * @public
4406
+ */
3118
4407
  channelId: string;
3119
4408
  /**
3120
4409
  * Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
@@ -3196,6 +4485,31 @@ export interface SearchMessagesInput {
3196
4485
  * @public
3197
4486
  */
3198
4487
  export interface SearchMessagesOutput {
4488
+ /**
4489
+ * The request ID of the request.
4490
+ * @public
4491
+ */
4492
+ requestId?: string | undefined;
4493
+ /**
4494
+ * The duration of the request in milliseconds.
4495
+ * @public
4496
+ */
4497
+ requestDuration?: number | undefined;
4498
+ /**
4499
+ * Displays the applicable rate limits for the current request.
4500
+ * @public
4501
+ */
4502
+ rateLimit?: string | undefined;
4503
+ /**
4504
+ * Indicates how many requests a user can still make within the current time window.
4505
+ * @public
4506
+ */
4507
+ rateLimitRemaining?: number | undefined;
4508
+ /**
4509
+ * Shows the time in seconds until the rate limit resets.
4510
+ * @public
4511
+ */
4512
+ rateLimitReset?: number | undefined;
3199
4513
  /**
3200
4514
  * Matching messages, access-filtered and ordered by the requested sort.
3201
4515
  * @public
@@ -3226,6 +4540,10 @@ export interface SendGiphyInput {
3226
4540
  * @public
3227
4541
  */
3228
4542
  userId?: string | undefined;
4543
+ /**
4544
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4545
+ * @public
4546
+ */
3229
4547
  channelId: string;
3230
4548
  /**
3231
4549
  * Optional client-supplied message id. Auto-generated when omitted.
@@ -3258,6 +4576,31 @@ export interface SendGiphyOutput {
3258
4576
  * @public
3259
4577
  */
3260
4578
  message: Message;
4579
+ /**
4580
+ * The request ID of the request.
4581
+ * @public
4582
+ */
4583
+ requestId?: string | undefined;
4584
+ /**
4585
+ * The duration of the request in milliseconds.
4586
+ * @public
4587
+ */
4588
+ requestDuration?: number | undefined;
4589
+ /**
4590
+ * Displays the applicable rate limits for the current request.
4591
+ * @public
4592
+ */
4593
+ rateLimit?: string | undefined;
4594
+ /**
4595
+ * Indicates how many requests a user can still make within the current time window.
4596
+ * @public
4597
+ */
4598
+ rateLimitRemaining?: number | undefined;
4599
+ /**
4600
+ * Shows the time in seconds until the rate limit resets.
4601
+ * @public
4602
+ */
4603
+ rateLimitReset?: number | undefined;
3261
4604
  }
3262
4605
  /**
3263
4606
  * @public
@@ -3330,6 +4673,10 @@ export interface SendMessageInput {
3330
4673
  * @public
3331
4674
  */
3332
4675
  mentions?: string[] | undefined;
4676
+ /**
4677
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4678
+ * @public
4679
+ */
3333
4680
  channelId: string;
3334
4681
  /**
3335
4682
  * Rendering hint for the message.
@@ -3346,6 +4693,31 @@ export interface SendMessageOutput {
3346
4693
  * @public
3347
4694
  */
3348
4695
  message: Message;
4696
+ /**
4697
+ * The request ID of the request.
4698
+ * @public
4699
+ */
4700
+ requestId?: string | undefined;
4701
+ /**
4702
+ * The duration of the request in milliseconds.
4703
+ * @public
4704
+ */
4705
+ requestDuration?: number | undefined;
4706
+ /**
4707
+ * Displays the applicable rate limits for the current request.
4708
+ * @public
4709
+ */
4710
+ rateLimit?: string | undefined;
4711
+ /**
4712
+ * Indicates how many requests a user can still make within the current time window.
4713
+ * @public
4714
+ */
4715
+ rateLimitRemaining?: number | undefined;
4716
+ /**
4717
+ * Shows the time in seconds until the rate limit resets.
4718
+ * @public
4719
+ */
4720
+ rateLimitReset?: number | undefined;
3349
4721
  }
3350
4722
  /**
3351
4723
  * @public
@@ -3361,6 +4733,10 @@ export interface SendMessageReactionInput {
3361
4733
  * @public
3362
4734
  */
3363
4735
  userId?: string | undefined;
4736
+ /**
4737
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4738
+ * @public
4739
+ */
3364
4740
  channelId: string;
3365
4741
  messageId: string;
3366
4742
  /**
@@ -3378,6 +4754,31 @@ export interface SendMessageReactionOutput {
3378
4754
  * @public
3379
4755
  */
3380
4756
  message: Message;
4757
+ /**
4758
+ * The request ID of the request.
4759
+ * @public
4760
+ */
4761
+ requestId?: string | undefined;
4762
+ /**
4763
+ * The duration of the request in milliseconds.
4764
+ * @public
4765
+ */
4766
+ requestDuration?: number | undefined;
4767
+ /**
4768
+ * Displays the applicable rate limits for the current request.
4769
+ * @public
4770
+ */
4771
+ rateLimit?: string | undefined;
4772
+ /**
4773
+ * Indicates how many requests a user can still make within the current time window.
4774
+ * @public
4775
+ */
4776
+ rateLimitRemaining?: number | undefined;
4777
+ /**
4778
+ * Shows the time in seconds until the rate limit resets.
4779
+ * @public
4780
+ */
4781
+ rateLimitReset?: number | undefined;
3381
4782
  }
3382
4783
  /**
3383
4784
  * Empty payload for the WhatsApp 24-hour window closed system message.
@@ -3444,6 +4845,10 @@ export interface SendSystemMessageInput {
3444
4845
  * @public
3445
4846
  */
3446
4847
  userId?: string | undefined;
4848
+ /**
4849
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4850
+ * @public
4851
+ */
3447
4852
  channelId: string;
3448
4853
  /**
3449
4854
  * Typed system message payload. Each variant maps to a server-generated message template.
@@ -3470,6 +4875,31 @@ export interface SendSystemMessageOutput {
3470
4875
  * @public
3471
4876
  */
3472
4877
  message: Message;
4878
+ /**
4879
+ * The request ID of the request.
4880
+ * @public
4881
+ */
4882
+ requestId?: string | undefined;
4883
+ /**
4884
+ * The duration of the request in milliseconds.
4885
+ * @public
4886
+ */
4887
+ requestDuration?: number | undefined;
4888
+ /**
4889
+ * Displays the applicable rate limits for the current request.
4890
+ * @public
4891
+ */
4892
+ rateLimit?: string | undefined;
4893
+ /**
4894
+ * Indicates how many requests a user can still make within the current time window.
4895
+ * @public
4896
+ */
4897
+ rateLimitRemaining?: number | undefined;
4898
+ /**
4899
+ * Shows the time in seconds until the rate limit resets.
4900
+ * @public
4901
+ */
4902
+ rateLimitReset?: number | undefined;
3473
4903
  }
3474
4904
  /**
3475
4905
  * @public
@@ -3485,12 +4915,41 @@ export interface SendTypingStartInput {
3485
4915
  * @public
3486
4916
  */
3487
4917
  userId?: string | undefined;
4918
+ /**
4919
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4920
+ * @public
4921
+ */
3488
4922
  channelId: string;
3489
4923
  }
3490
4924
  /**
3491
4925
  * @public
3492
4926
  */
3493
4927
  export interface SendTypingStartOutput {
4928
+ /**
4929
+ * The request ID of the request.
4930
+ * @public
4931
+ */
4932
+ requestId?: string | undefined;
4933
+ /**
4934
+ * The duration of the request in milliseconds.
4935
+ * @public
4936
+ */
4937
+ requestDuration?: number | undefined;
4938
+ /**
4939
+ * Displays the applicable rate limits for the current request.
4940
+ * @public
4941
+ */
4942
+ rateLimit?: string | undefined;
4943
+ /**
4944
+ * Indicates how many requests a user can still make within the current time window.
4945
+ * @public
4946
+ */
4947
+ rateLimitRemaining?: number | undefined;
4948
+ /**
4949
+ * Shows the time in seconds until the rate limit resets.
4950
+ * @public
4951
+ */
4952
+ rateLimitReset?: number | undefined;
3494
4953
  }
3495
4954
  /**
3496
4955
  * @public
@@ -3506,12 +4965,41 @@ export interface SendTypingStopInput {
3506
4965
  * @public
3507
4966
  */
3508
4967
  userId?: string | undefined;
4968
+ /**
4969
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
4970
+ * @public
4971
+ */
3509
4972
  channelId: string;
3510
4973
  }
3511
4974
  /**
3512
4975
  * @public
3513
4976
  */
3514
4977
  export interface SendTypingStopOutput {
4978
+ /**
4979
+ * The request ID of the request.
4980
+ * @public
4981
+ */
4982
+ requestId?: string | undefined;
4983
+ /**
4984
+ * The duration of the request in milliseconds.
4985
+ * @public
4986
+ */
4987
+ requestDuration?: number | undefined;
4988
+ /**
4989
+ * Displays the applicable rate limits for the current request.
4990
+ * @public
4991
+ */
4992
+ rateLimit?: string | undefined;
4993
+ /**
4994
+ * Indicates how many requests a user can still make within the current time window.
4995
+ * @public
4996
+ */
4997
+ rateLimitRemaining?: number | undefined;
4998
+ /**
4999
+ * Shows the time in seconds until the rate limit resets.
5000
+ * @public
5001
+ */
5002
+ rateLimitReset?: number | undefined;
3515
5003
  }
3516
5004
  /**
3517
5005
  * @public
@@ -3527,12 +5015,41 @@ export interface ShowChannelInput {
3527
5015
  * @public
3528
5016
  */
3529
5017
  userId?: string | undefined;
5018
+ /**
5019
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
5020
+ * @public
5021
+ */
3530
5022
  channelId: string;
3531
5023
  }
3532
5024
  /**
3533
5025
  * @public
3534
5026
  */
3535
5027
  export interface ShowChannelOutput {
5028
+ /**
5029
+ * The request ID of the request.
5030
+ * @public
5031
+ */
5032
+ requestId?: string | undefined;
5033
+ /**
5034
+ * The duration of the request in milliseconds.
5035
+ * @public
5036
+ */
5037
+ requestDuration?: number | undefined;
5038
+ /**
5039
+ * Displays the applicable rate limits for the current request.
5040
+ * @public
5041
+ */
5042
+ rateLimit?: string | undefined;
5043
+ /**
5044
+ * Indicates how many requests a user can still make within the current time window.
5045
+ * @public
5046
+ */
5047
+ rateLimitRemaining?: number | undefined;
5048
+ /**
5049
+ * Shows the time in seconds until the rate limit resets.
5050
+ * @public
5051
+ */
5052
+ rateLimitReset?: number | undefined;
3536
5053
  }
3537
5054
  /**
3538
5055
  * @public
@@ -3548,12 +5065,41 @@ export interface UnmuteChannelInput {
3548
5065
  * @public
3549
5066
  */
3550
5067
  userId?: string | undefined;
5068
+ /**
5069
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
5070
+ * @public
5071
+ */
3551
5072
  channelId: string;
3552
5073
  }
3553
5074
  /**
3554
5075
  * @public
3555
5076
  */
3556
5077
  export interface UnmuteChannelOutput {
5078
+ /**
5079
+ * The request ID of the request.
5080
+ * @public
5081
+ */
5082
+ requestId?: string | undefined;
5083
+ /**
5084
+ * The duration of the request in milliseconds.
5085
+ * @public
5086
+ */
5087
+ requestDuration?: number | undefined;
5088
+ /**
5089
+ * Displays the applicable rate limits for the current request.
5090
+ * @public
5091
+ */
5092
+ rateLimit?: string | undefined;
5093
+ /**
5094
+ * Indicates how many requests a user can still make within the current time window.
5095
+ * @public
5096
+ */
5097
+ rateLimitRemaining?: number | undefined;
5098
+ /**
5099
+ * Shows the time in seconds until the rate limit resets.
5100
+ * @public
5101
+ */
5102
+ rateLimitReset?: number | undefined;
3557
5103
  /**
3558
5104
  * Per-user inbox state for a channel: mute and hide flags, unread counters, and read pointers.
3559
5105
  * @public
@@ -3574,12 +5120,41 @@ export interface UnpinChannelInput {
3574
5120
  * @public
3575
5121
  */
3576
5122
  userId?: string | undefined;
5123
+ /**
5124
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
5125
+ * @public
5126
+ */
3577
5127
  channelId: string;
3578
5128
  }
3579
5129
  /**
3580
5130
  * @public
3581
5131
  */
3582
5132
  export interface UnpinChannelOutput {
5133
+ /**
5134
+ * The request ID of the request.
5135
+ * @public
5136
+ */
5137
+ requestId?: string | undefined;
5138
+ /**
5139
+ * The duration of the request in milliseconds.
5140
+ * @public
5141
+ */
5142
+ requestDuration?: number | undefined;
5143
+ /**
5144
+ * Displays the applicable rate limits for the current request.
5145
+ * @public
5146
+ */
5147
+ rateLimit?: string | undefined;
5148
+ /**
5149
+ * Indicates how many requests a user can still make within the current time window.
5150
+ * @public
5151
+ */
5152
+ rateLimitRemaining?: number | undefined;
5153
+ /**
5154
+ * Shows the time in seconds until the rate limit resets.
5155
+ * @public
5156
+ */
5157
+ rateLimitReset?: number | undefined;
3583
5158
  }
3584
5159
  /**
3585
5160
  * @public
@@ -3595,6 +5170,10 @@ export interface UnpinMessageInput {
3595
5170
  * @public
3596
5171
  */
3597
5172
  userId?: string | undefined;
5173
+ /**
5174
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
5175
+ * @public
5176
+ */
3598
5177
  channelId: string;
3599
5178
  messageId: string;
3600
5179
  }
@@ -3607,6 +5186,31 @@ export interface UnpinMessageOutput {
3607
5186
  * @public
3608
5187
  */
3609
5188
  message: Message;
5189
+ /**
5190
+ * The request ID of the request.
5191
+ * @public
5192
+ */
5193
+ requestId?: string | undefined;
5194
+ /**
5195
+ * The duration of the request in milliseconds.
5196
+ * @public
5197
+ */
5198
+ requestDuration?: number | undefined;
5199
+ /**
5200
+ * Displays the applicable rate limits for the current request.
5201
+ * @public
5202
+ */
5203
+ rateLimit?: string | undefined;
5204
+ /**
5205
+ * Indicates how many requests a user can still make within the current time window.
5206
+ * @public
5207
+ */
5208
+ rateLimitRemaining?: number | undefined;
5209
+ /**
5210
+ * Shows the time in seconds until the rate limit resets.
5211
+ * @public
5212
+ */
5213
+ rateLimitReset?: number | undefined;
3610
5214
  }
3611
5215
  /**
3612
5216
  * @public
@@ -3719,6 +5323,10 @@ export interface UpdateChannelInput {
3719
5323
  * @public
3720
5324
  */
3721
5325
  messengerReplyUntil?: number | undefined;
5326
+ /**
5327
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
5328
+ * @public
5329
+ */
3722
5330
  channelId: string;
3723
5331
  silent?: boolean | undefined;
3724
5332
  }
@@ -3726,6 +5334,31 @@ export interface UpdateChannelInput {
3726
5334
  * @public
3727
5335
  */
3728
5336
  export interface UpdateChannelOutput {
5337
+ /**
5338
+ * The request ID of the request.
5339
+ * @public
5340
+ */
5341
+ requestId?: string | undefined;
5342
+ /**
5343
+ * The duration of the request in milliseconds.
5344
+ * @public
5345
+ */
5346
+ requestDuration?: number | undefined;
5347
+ /**
5348
+ * Displays the applicable rate limits for the current request.
5349
+ * @public
5350
+ */
5351
+ rateLimit?: string | undefined;
5352
+ /**
5353
+ * Indicates how many requests a user can still make within the current time window.
5354
+ * @public
5355
+ */
5356
+ rateLimitRemaining?: number | undefined;
5357
+ /**
5358
+ * Shows the time in seconds until the rate limit resets.
5359
+ * @public
5360
+ */
5361
+ rateLimitReset?: number | undefined;
3729
5362
  channel: Channel;
3730
5363
  }
3731
5364
  /**
@@ -3789,6 +5422,10 @@ export interface UpdateMessageInput {
3789
5422
  */
3790
5423
  sms?: boolean | undefined;
3791
5424
  smsStatus?: MessageSmsStatus | undefined;
5425
+ /**
5426
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
5427
+ * @public
5428
+ */
3792
5429
  channelId: string;
3793
5430
  messageId: string;
3794
5431
  /**
@@ -3806,6 +5443,31 @@ export interface UpdateMessageOutput {
3806
5443
  * @public
3807
5444
  */
3808
5445
  message: Message;
5446
+ /**
5447
+ * The request ID of the request.
5448
+ * @public
5449
+ */
5450
+ requestId?: string | undefined;
5451
+ /**
5452
+ * The duration of the request in milliseconds.
5453
+ * @public
5454
+ */
5455
+ requestDuration?: number | undefined;
5456
+ /**
5457
+ * Displays the applicable rate limits for the current request.
5458
+ * @public
5459
+ */
5460
+ rateLimit?: string | undefined;
5461
+ /**
5462
+ * Indicates how many requests a user can still make within the current time window.
5463
+ * @public
5464
+ */
5465
+ rateLimitRemaining?: number | undefined;
5466
+ /**
5467
+ * Shows the time in seconds until the rate limit resets.
5468
+ * @public
5469
+ */
5470
+ rateLimitReset?: number | undefined;
3809
5471
  }
3810
5472
  /**
3811
5473
  * Optional parameters for the upload presign flow.
@@ -3837,6 +5499,10 @@ export interface UploadFileInput {
3837
5499
  * @public
3838
5500
  */
3839
5501
  userId?: string | undefined;
5502
+ /**
5503
+ * Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
5504
+ * @public
5505
+ */
3840
5506
  channelId: string;
3841
5507
  /**
3842
5508
  * Original file name. Unreadable characters are replaced with underscores.
@@ -3853,6 +5519,31 @@ export interface UploadFileInput {
3853
5519
  * @public
3854
5520
  */
3855
5521
  export interface UploadFileOutput {
5522
+ /**
5523
+ * The request ID of the request.
5524
+ * @public
5525
+ */
5526
+ requestId?: string | undefined;
5527
+ /**
5528
+ * The duration of the request in milliseconds.
5529
+ * @public
5530
+ */
5531
+ requestDuration?: number | undefined;
5532
+ /**
5533
+ * Displays the applicable rate limits for the current request.
5534
+ * @public
5535
+ */
5536
+ rateLimit?: string | undefined;
5537
+ /**
5538
+ * Indicates how many requests a user can still make within the current time window.
5539
+ * @public
5540
+ */
5541
+ rateLimitRemaining?: number | undefined;
5542
+ /**
5543
+ * Shows the time in seconds until the rate limit resets.
5544
+ * @public
5545
+ */
5546
+ rateLimitReset?: number | undefined;
3856
5547
  /**
3857
5548
  * File service identifier. Pass this value as `attachments[].fsId` on send and edit.
3858
5549
  * @public