@stream-io/node-sdk 0.7.63 → 0.7.64

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.
@@ -111,8 +111,15 @@ export interface AWSRekognitionRule {
111
111
  min_confidence: number;
112
112
  subclassifications?: Record<string, any>;
113
113
  }
114
+ export interface AbsentMetric {
115
+ metric: string;
116
+ reason: string;
117
+ }
114
118
  export interface AcceptFeedMemberInviteRequest {
115
119
  user_id?: string;
120
+ /**
121
+ * User request object
122
+ */
116
123
  user?: UserRequest;
117
124
  }
118
125
  export interface AcceptFeedMemberInviteResponse {
@@ -179,7 +186,13 @@ export interface ActionLogResponse {
179
186
  */
180
187
  custom: Record<string, any>;
181
188
  review_queue_item?: ReviewQueueItemResponse;
189
+ /**
190
+ * User response object
191
+ */
182
192
  target_user?: UserResponse;
193
+ /**
194
+ * User response object
195
+ */
183
196
  user?: UserResponse;
184
197
  }
185
198
  export interface ActionSequence {
@@ -287,6 +300,9 @@ export interface ActivityFeedbackEventPayload {
287
300
  * The feedback value (true/false)
288
301
  */
289
302
  value: string;
303
+ /**
304
+ * User response object
305
+ */
290
306
  user: UserResponse;
291
307
  }
292
308
  export interface ActivityFeedbackRequest {
@@ -303,6 +319,9 @@ export interface ActivityFeedbackRequest {
303
319
  */
304
320
  show_more?: boolean;
305
321
  user_id?: string;
322
+ /**
323
+ * User request object
324
+ */
306
325
  user?: UserRequest;
307
326
  }
308
327
  export interface ActivityFeedbackResponse {
@@ -367,6 +386,9 @@ export interface ActivityPinResponse {
367
386
  */
368
387
  updated_at: Date;
369
388
  activity: ActivityResponse;
389
+ /**
390
+ * User response object
391
+ */
370
392
  user: UserResponse;
371
393
  }
372
394
  export interface ActivityPinnedEvent {
@@ -531,6 +553,10 @@ export interface ActivityRequest {
531
553
  * Collections that this activity references
532
554
  */
533
555
  collection_refs?: string[];
556
+ /**
557
+ * Collections to create or update as part of this request, so an activity and the collections it references can be written in one call. Their refs (name:id) are added to collection_refs automatically; you do not need to restate them, and they count toward the same per-activity collection-reference limit, which is the effective cap here. A collection that already exists has its custom data updated. Use collection_refs instead when the collection already exists and you are only referencing it, which requires no collection permissions.
558
+ */
559
+ collections?: CollectionRequest[];
534
560
  /**
535
561
  * Tags for filtering activities
536
562
  */
@@ -662,6 +688,9 @@ export interface ActivityResponse {
662
688
  * Data for search indexing
663
689
  */
664
690
  search_data: Record<string, any>;
691
+ /**
692
+ * User response object
693
+ */
665
694
  user: UserResponse;
666
695
  /**
667
696
  * When the activity was deleted
@@ -903,6 +932,10 @@ export interface AddActivityRequest {
903
932
  * Collections that this activity references
904
933
  */
905
934
  collection_refs?: string[];
935
+ /**
936
+ * Collections to create or update as part of this request, so an activity and the collections it references can be written in one call. Their refs (name:id) are added to collection_refs automatically; you do not need to restate them, and they count toward the same per-activity collection-reference limit, which is the effective cap here. A collection that already exists has its custom data updated. Use collection_refs instead when the collection already exists and you are only referencing it, which requires no collection permissions.
937
+ */
938
+ collections?: CollectionRequest[];
906
939
  /**
907
940
  * Tags for filtering activities
908
941
  */
@@ -944,6 +977,9 @@ export interface AddBookmarkRequest {
944
977
  */
945
978
  custom?: Record<string, any>;
946
979
  new_folder?: AddFolderRequest;
980
+ /**
981
+ * User request object
982
+ */
947
983
  user?: UserRequest;
948
984
  }
949
985
  export interface AddBookmarkResponse {
@@ -961,6 +997,9 @@ export interface AddCommentBookmarkRequest {
961
997
  */
962
998
  custom?: Record<string, any>;
963
999
  new_folder?: AddFolderRequest;
1000
+ /**
1001
+ * User request object
1002
+ */
964
1003
  user?: UserRequest;
965
1004
  }
966
1005
  export interface AddCommentBookmarkResponse {
@@ -995,6 +1034,9 @@ export interface AddCommentReactionRequest {
995
1034
  * Optional custom data to add to the reaction
996
1035
  */
997
1036
  custom?: Record<string, any>;
1037
+ /**
1038
+ * User request object
1039
+ */
998
1040
  user?: UserRequest;
999
1041
  }
1000
1042
  export interface AddCommentReactionResponse {
@@ -1071,6 +1113,9 @@ export interface AddCommentRequest {
1071
1113
  * Custom data for the comment
1072
1114
  */
1073
1115
  custom?: Record<string, any>;
1116
+ /**
1117
+ * User request object
1118
+ */
1074
1119
  user?: UserRequest;
1075
1120
  }
1076
1121
  export interface AddCommentResponse {
@@ -1140,6 +1185,9 @@ export interface AddReactionRequest {
1140
1185
  * Custom data for the reaction
1141
1186
  */
1142
1187
  custom?: Record<string, any>;
1188
+ /**
1189
+ * User request object
1190
+ */
1143
1191
  user?: UserRequest;
1144
1192
  }
1145
1193
  export interface AddReactionResponse {
@@ -1303,6 +1351,9 @@ export interface AnalyzeRequest {
1303
1351
  * Named text fields to moderate, keyed by caller label (e.g. title, description).
1304
1352
  */
1305
1353
  texts?: Record<string, string>;
1354
+ /**
1355
+ * User request object
1356
+ */
1306
1357
  user?: UserRequest;
1307
1358
  }
1308
1359
  export interface AnalyzeResponse {
@@ -1361,9 +1412,9 @@ export interface AppResponseFields {
1361
1412
  id: number;
1362
1413
  image_moderation_enabled: boolean;
1363
1414
  max_aggregated_activities_length: number;
1415
+ member_custom_on_messages_enabled: boolean;
1364
1416
  moderation_audio_call_moderation_enabled: boolean;
1365
1417
  moderation_enabled: boolean;
1366
- moderation_flood_rules_enabled: boolean;
1367
1418
  moderation_llm_configurability_enabled: boolean;
1368
1419
  moderation_multitenant_blocklist_enabled: boolean;
1369
1420
  moderation_video_call_moderation_enabled: boolean;
@@ -1500,6 +1551,9 @@ export interface AppealItemResponse {
1500
1551
  entity_content?: ModerationPayload;
1501
1552
  moderation_action?: ActionLogResponse;
1502
1553
  original_moderation_action?: ActionLogResponse;
1554
+ /**
1555
+ * User response object
1556
+ */
1503
1557
  user?: UserResponse;
1504
1558
  }
1505
1559
  export interface AppealRejectedEvent {
@@ -1531,6 +1585,9 @@ export interface AppealRequest {
1531
1585
  * Array of Attachment URLs(e.g., images)
1532
1586
  */
1533
1587
  attachments?: string[];
1588
+ /**
1589
+ * User request object
1590
+ */
1534
1591
  user?: UserRequest;
1535
1592
  }
1536
1593
  export interface AppealResponse {
@@ -1635,6 +1692,19 @@ export interface Attachment {
1635
1692
  fields?: Field[];
1636
1693
  giphy?: Images;
1637
1694
  }
1695
+ export interface Audience {
1696
+ avg_concurrent_viewers: number;
1697
+ hours_watched: number;
1698
+ peak_concurrent_viewers: number;
1699
+ unique_viewers: number;
1700
+ viewer_connections: number;
1701
+ concurrency_by_minute: ConcurrencyMinute[];
1702
+ peak_at?: string;
1703
+ ramp_up_min_to_90pct_peak?: number;
1704
+ retention_at_90pct_mark?: number;
1705
+ retention_at_midpoint?: number;
1706
+ shape?: string;
1707
+ }
1638
1708
  export interface AudioSettings {
1639
1709
  access_request_enabled: boolean;
1640
1710
  default_device: 'speaker' | 'earpiece';
@@ -1670,6 +1740,9 @@ export interface AutomodDetailsResponse {
1670
1740
  original_message_type?: string;
1671
1741
  image_labels?: string[];
1672
1742
  message_details?: FlagMessageDetailsResponse;
1743
+ /**
1744
+ * Result of the message moderation
1745
+ */
1673
1746
  result?: MessageModerationResult;
1674
1747
  }
1675
1748
  export interface AutomodPlatformCircumventionConfig {
@@ -1784,7 +1857,13 @@ export interface BanInfoResponse {
1784
1857
  */
1785
1858
  shadow?: boolean;
1786
1859
  channel?: ChannelMetadata;
1860
+ /**
1861
+ * User response object
1862
+ */
1787
1863
  created_by?: UserResponse;
1864
+ /**
1865
+ * User response object
1866
+ */
1788
1867
  user?: UserResponse;
1789
1868
  }
1790
1869
  export interface BanOptions {
@@ -1824,6 +1903,9 @@ export interface BanRequest {
1824
1903
  * Duration of the ban in minutes
1825
1904
  */
1826
1905
  timeout?: number;
1906
+ /**
1907
+ * User request object
1908
+ */
1827
1909
  banned_by?: UserRequest;
1828
1910
  }
1829
1911
  export interface BanResponse {
@@ -1831,8 +1913,17 @@ export interface BanResponse {
1831
1913
  expires?: Date;
1832
1914
  reason?: string;
1833
1915
  shadow?: boolean;
1916
+ /**
1917
+ * User response object
1918
+ */
1834
1919
  banned_by?: UserResponse;
1920
+ /**
1921
+ * Represents channel in chat
1922
+ */
1835
1923
  channel?: ChannelResponse;
1924
+ /**
1925
+ * User response object
1926
+ */
1836
1927
  user?: UserResponse;
1837
1928
  }
1838
1929
  export interface BatchQueryActivityReactionsRequest {
@@ -1852,6 +1943,9 @@ export interface BatchQueryActivityReactionsRequest {
1852
1943
  * Optional filter on reaction_type or created_at
1853
1944
  */
1854
1945
  filter?: Record<string, any>;
1946
+ /**
1947
+ * User request object
1948
+ */
1855
1949
  user?: UserRequest;
1856
1950
  }
1857
1951
  export interface BatchQueryActivityReactionsResponse {
@@ -1880,6 +1974,9 @@ export interface BatchQueryCommentReactionsRequest {
1880
1974
  * Optional filter on reaction_type or created_at
1881
1975
  */
1882
1976
  filter?: Record<string, any>;
1977
+ /**
1978
+ * User request object
1979
+ */
1883
1980
  user?: UserRequest;
1884
1981
  }
1885
1982
  export interface BatchQueryCommentReactionsResponse {
@@ -1965,6 +2062,9 @@ export interface BlockUsersRequest {
1965
2062
  */
1966
2063
  blocked_user_id: string;
1967
2064
  user_id?: string;
2065
+ /**
2066
+ * User request object
2067
+ */
1968
2068
  user?: UserRequest;
1969
2069
  }
1970
2070
  export interface BlockUsersResponse {
@@ -1988,11 +2088,17 @@ export interface BlockUsersResponse {
1988
2088
  export interface BlockedUserEvent {
1989
2089
  call_cid: string;
1990
2090
  created_at: Date;
2091
+ /**
2092
+ * User response object
2093
+ */
1991
2094
  user: UserResponse;
1992
2095
  /**
1993
2096
  * The type of event: "call.blocked_user" in this case
1994
2097
  */
1995
2098
  type: string;
2099
+ /**
2100
+ * User response object
2101
+ */
1996
2102
  blocked_by_user?: UserResponse;
1997
2103
  }
1998
2104
  export interface BlockedUserResponse {
@@ -2005,7 +2111,13 @@ export interface BlockedUserResponse {
2005
2111
  * ID of the user who blocked another user
2006
2112
  */
2007
2113
  user_id: string;
2114
+ /**
2115
+ * User response object
2116
+ */
2008
2117
  blocked_user: UserResponse;
2118
+ /**
2119
+ * User response object
2120
+ */
2009
2121
  user: UserResponse;
2010
2122
  }
2011
2123
  export interface BodyguardImageAnalysisConfig {
@@ -2084,6 +2196,9 @@ export interface BookmarkFolderResponse {
2084
2196
  * When the folder was last updated
2085
2197
  */
2086
2198
  updated_at: Date;
2199
+ /**
2200
+ * User response object
2201
+ */
2087
2202
  user: UserResponse;
2088
2203
  /**
2089
2204
  * Custom data for the folder
@@ -2122,6 +2237,9 @@ export interface BookmarkResponse {
2122
2237
  */
2123
2238
  updated_at: Date;
2124
2239
  activity: ActivityResponse;
2240
+ /**
2241
+ * User response object
2242
+ */
2125
2243
  user: UserResponse;
2126
2244
  activity_id?: string;
2127
2245
  comment?: CommentResponse;
@@ -2149,6 +2267,52 @@ export interface Bound {
2149
2267
  inclusive: boolean;
2150
2268
  value: number;
2151
2269
  }
2270
+ export interface BroadcastDailyRollup {
2271
+ broadcasts: number;
2272
+ day: string;
2273
+ dead_air_s: number;
2274
+ hours_watched: number;
2275
+ incident_windows: number;
2276
+ max_peak_concurrent_viewers: number;
2277
+ note: string;
2278
+ schema_version: string;
2279
+ source_drops: number;
2280
+ unique_viewers_sum: number;
2281
+ top_broadcasts: TopBroadcast[];
2282
+ poor_viewers_by_cause: PoorByCause;
2283
+ }
2284
+ export interface BroadcastDigest {
2285
+ schema_version: string;
2286
+ audience: Audience;
2287
+ broadcast: BroadcastInfo;
2288
+ coverage: Coverage;
2289
+ joins: Joins;
2290
+ poor_tail: PoorTail;
2291
+ quality: Quality;
2292
+ segments: Segments;
2293
+ source: SourceHealth;
2294
+ viewers: ViewerBehavior;
2295
+ }
2296
+ export interface BroadcastInfo {
2297
+ app_id: number;
2298
+ call_cid: string;
2299
+ call_session_id: string;
2300
+ call_type: string;
2301
+ duration_min: number;
2302
+ ended_at: string;
2303
+ started_at: string;
2304
+ creators: string[];
2305
+ source_mode?: string;
2306
+ }
2307
+ export interface BroadcastSegment {
2308
+ key: string;
2309
+ sessions: number;
2310
+ avg_quality_score?: number;
2311
+ p5_quality_score?: number;
2312
+ poor_pct?: number;
2313
+ share_pct?: number;
2314
+ watch_share_pct?: number;
2315
+ }
2152
2316
  export interface BroadcastSettings {
2153
2317
  enabled: boolean;
2154
2318
  hls?: HLSSettings;
@@ -2161,7 +2325,13 @@ export interface BroadcastSettingsRequest {
2161
2325
  }
2162
2326
  export interface BroadcastSettingsResponse {
2163
2327
  enabled: boolean;
2328
+ /**
2329
+ * HLSSettings is the payload for HLS settings
2330
+ */
2164
2331
  hls: HLSSettingsResponse;
2332
+ /**
2333
+ * RTMPSettingsResponse is the payload for RTMP settings
2334
+ */
2165
2335
  rtmp: RTMPSettingsResponse;
2166
2336
  }
2167
2337
  export interface BrowserDataResponse {
@@ -2178,11 +2348,29 @@ export interface BulkActionAppealsRequest {
2178
2348
  */
2179
2349
  appeal_ids: string[];
2180
2350
  user_id?: string;
2351
+ /**
2352
+ * Configuration for mark reviewed action
2353
+ */
2181
2354
  mark_reviewed?: MarkReviewedRequestPayload;
2355
+ /**
2356
+ * Configuration for rejecting an appeal
2357
+ */
2182
2358
  reject_appeal?: RejectAppealRequestPayload;
2359
+ /**
2360
+ * Configuration for restore action
2361
+ */
2183
2362
  restore?: RestoreActionRequestPayload;
2363
+ /**
2364
+ * Configuration for unban moderation action
2365
+ */
2184
2366
  unban?: UnbanActionRequestPayload;
2367
+ /**
2368
+ * Configuration for unblock action
2369
+ */
2185
2370
  unblock?: UnblockActionRequestPayload;
2371
+ /**
2372
+ * User request object
2373
+ */
2186
2374
  user?: UserRequest;
2187
2375
  }
2188
2376
  export interface BulkActionAppealsResponse {
@@ -2210,6 +2398,9 @@ export interface BulkDeleteActionConfigRequest {
2210
2398
  */
2211
2399
  ids: string[];
2212
2400
  user_id?: string;
2401
+ /**
2402
+ * User request object
2403
+ */
2213
2404
  user?: UserRequest;
2214
2405
  }
2215
2406
  export interface BulkDeleteActionConfigResponse {
@@ -2238,6 +2429,9 @@ export interface BulkUpsertActionConfigRequest {
2238
2429
  */
2239
2430
  action_configs: UpsertActionConfigItem[];
2240
2431
  user_id?: string;
2432
+ /**
2433
+ * User request object
2434
+ */
2241
2435
  user?: UserRequest;
2242
2436
  }
2243
2437
  export interface BulkUpsertActionConfigResponse {
@@ -2266,7 +2460,13 @@ export interface BypassResponse {
2266
2460
  export interface CallAcceptedEvent {
2267
2461
  call_cid: string;
2268
2462
  created_at: Date;
2463
+ /**
2464
+ * Represents a call
2465
+ */
2269
2466
  call: CallResponse;
2467
+ /**
2468
+ * User response object
2469
+ */
2270
2470
  user: UserResponse;
2271
2471
  /**
2272
2472
  * The type of event: "call.accepted" in this case
@@ -2290,6 +2490,9 @@ export interface CallClosedCaption {
2290
2490
  start_time: Date;
2291
2491
  text: string;
2292
2492
  translated: boolean;
2493
+ /**
2494
+ * User response object
2495
+ */
2293
2496
  user: UserResponse;
2294
2497
  service?: string;
2295
2498
  }
@@ -2324,6 +2527,9 @@ export interface CallCreatedEvent {
2324
2527
  * the members added to this call
2325
2528
  */
2326
2529
  members: MemberResponse[];
2530
+ /**
2531
+ * Represents a call
2532
+ */
2327
2533
  call: CallResponse;
2328
2534
  /**
2329
2535
  * The type of event: "call.created" in this case
@@ -2353,6 +2559,9 @@ export interface CallDTMFEvent {
2353
2559
  * When the digit press ended and was detected
2354
2560
  */
2355
2561
  timestamp: Date;
2562
+ /**
2563
+ * User response object
2564
+ */
2356
2565
  user: UserResponse;
2357
2566
  /**
2358
2567
  * The type of event: "call.dtmf" in this case
@@ -2362,6 +2571,9 @@ export interface CallDTMFEvent {
2362
2571
  export interface CallDeletedEvent {
2363
2572
  call_cid: string;
2364
2573
  created_at: Date;
2574
+ /**
2575
+ * Represents a call
2576
+ */
2365
2577
  call: CallResponse;
2366
2578
  /**
2367
2579
  * The type of event: "call.deleted" in this case
@@ -2377,6 +2589,9 @@ export interface CallDurationReportResponse {
2377
2589
  export interface CallEndedEvent {
2378
2590
  call_cid: string;
2379
2591
  created_at: Date;
2592
+ /**
2593
+ * Represents a call
2594
+ */
2380
2595
  call: CallResponse;
2381
2596
  /**
2382
2597
  * The type of event: "call.ended" in this case
@@ -2390,12 +2605,18 @@ export interface CallEndedEvent {
2390
2605
  * The list of members in the call
2391
2606
  */
2392
2607
  members?: MemberResponse[];
2608
+ /**
2609
+ * User response object
2610
+ */
2393
2611
  user?: UserResponse;
2394
2612
  }
2395
2613
  export interface CallFrameRecordingFailedEvent {
2396
2614
  call_cid: string;
2397
2615
  created_at: Date;
2398
2616
  egress_id: string;
2617
+ /**
2618
+ * Represents a call
2619
+ */
2399
2620
  call: CallResponse;
2400
2621
  /**
2401
2622
  * The type of event: "call.frame_recording_failed" in this case
@@ -2435,6 +2656,9 @@ export interface CallFrameRecordingStartedEvent {
2435
2656
  call_cid: string;
2436
2657
  created_at: Date;
2437
2658
  egress_id: string;
2659
+ /**
2660
+ * Represents a call
2661
+ */
2438
2662
  call: CallResponse;
2439
2663
  /**
2440
2664
  * The type of event: "call.frame_recording_started" in this case
@@ -2445,6 +2669,9 @@ export interface CallFrameRecordingStoppedEvent {
2445
2669
  call_cid: string;
2446
2670
  created_at: Date;
2447
2671
  egress_id: string;
2672
+ /**
2673
+ * Represents a call
2674
+ */
2448
2675
  call: CallResponse;
2449
2676
  /**
2450
2677
  * The type of event: "call.frame_recording_stopped" in this case
@@ -2463,6 +2690,9 @@ export interface CallHLSBroadcastingStartedEvent {
2463
2690
  call_cid: string;
2464
2691
  created_at: Date;
2465
2692
  hls_playlist_url: string;
2693
+ /**
2694
+ * Represents a call
2695
+ */
2466
2696
  call: CallResponse;
2467
2697
  /**
2468
2698
  * The type of event: "call.hls_broadcasting_started" in this case
@@ -2478,6 +2708,9 @@ export interface CallHLSBroadcastingStoppedEvent {
2478
2708
  type: string;
2479
2709
  }
2480
2710
  export interface CallIngressResponse {
2711
+ /**
2712
+ * RTMP input settings
2713
+ */
2481
2714
  rtmp: RTMPIngress;
2482
2715
  srt: SRTIngress;
2483
2716
  whip: WHIPIngress;
@@ -2491,6 +2724,9 @@ export interface CallLevelEventPayload {
2491
2724
  export interface CallLiveStartedEvent {
2492
2725
  call_cid: string;
2493
2726
  created_at: Date;
2727
+ /**
2728
+ * Represents a call
2729
+ */
2494
2730
  call: CallResponse;
2495
2731
  /**
2496
2732
  * The type of event: "call.live_started" in this case
@@ -2504,6 +2740,9 @@ export interface CallMemberAddedEvent {
2504
2740
  * the members added to this call
2505
2741
  */
2506
2742
  members: MemberResponse[];
2743
+ /**
2744
+ * Represents a call
2745
+ */
2507
2746
  call: CallResponse;
2508
2747
  /**
2509
2748
  * The type of event: "call.member_added" in this case
@@ -2517,6 +2756,9 @@ export interface CallMemberRemovedEvent {
2517
2756
  * the list of member IDs removed from the call
2518
2757
  */
2519
2758
  members: string[];
2759
+ /**
2760
+ * Represents a call
2761
+ */
2520
2762
  call: CallResponse;
2521
2763
  /**
2522
2764
  * The type of event: "call.member_removed" in this case
@@ -2530,6 +2772,9 @@ export interface CallMemberUpdatedEvent {
2530
2772
  * The list of members that were updated
2531
2773
  */
2532
2774
  members: MemberResponse[];
2775
+ /**
2776
+ * Represents a call
2777
+ */
2533
2778
  call: CallResponse;
2534
2779
  /**
2535
2780
  * The type of event: "call.member_updated" in this case
@@ -2543,6 +2788,9 @@ export interface CallMemberUpdatedPermissionEvent {
2543
2788
  * The list of members that were updated
2544
2789
  */
2545
2790
  members: MemberResponse[];
2791
+ /**
2792
+ * Represents a call
2793
+ */
2546
2794
  call: CallResponse;
2547
2795
  /**
2548
2796
  * The capabilities by role for this call
@@ -2565,7 +2813,13 @@ export interface CallMissedEvent {
2565
2813
  * List of members who missed the call
2566
2814
  */
2567
2815
  members: MemberResponse[];
2816
+ /**
2817
+ * Represents a call
2818
+ */
2568
2819
  call: CallResponse;
2820
+ /**
2821
+ * User response object
2822
+ */
2569
2823
  user: UserResponse;
2570
2824
  /**
2571
2825
  * The type of event: "call.notification" in this case
@@ -2619,7 +2873,13 @@ export interface CallNotificationEvent {
2619
2873
  * Call members
2620
2874
  */
2621
2875
  members: MemberResponse[];
2876
+ /**
2877
+ * Represents a call
2878
+ */
2622
2879
  call: CallResponse;
2880
+ /**
2881
+ * User response object
2882
+ */
2623
2883
  user: UserResponse;
2624
2884
  /**
2625
2885
  * The type of event: "call.notification" in this case
@@ -2636,6 +2896,9 @@ export interface CallParticipantResponse {
2636
2896
  joined_at: Date;
2637
2897
  role: string;
2638
2898
  user_session_id: string;
2899
+ /**
2900
+ * User response object
2901
+ */
2639
2902
  user: UserResponse;
2640
2903
  }
2641
2904
  export interface CallParticipantTimeline {
@@ -2682,6 +2945,9 @@ export interface CallRecordingReadyEvent {
2682
2945
  * The type of recording
2683
2946
  */
2684
2947
  recording_type: 'composite' | 'individual' | 'raw';
2948
+ /**
2949
+ * CallRecording represents a recording of a call.
2950
+ */
2685
2951
  call_recording: CallRecording;
2686
2952
  /**
2687
2953
  * The type of event: "call.recording_ready" in this case
@@ -2717,7 +2983,13 @@ export interface CallRecordingStoppedEvent {
2717
2983
  export interface CallRejectedEvent {
2718
2984
  call_cid: string;
2719
2985
  created_at: Date;
2986
+ /**
2987
+ * Represents a call
2988
+ */
2720
2989
  call: CallResponse;
2990
+ /**
2991
+ * User response object
2992
+ */
2721
2993
  user: UserResponse;
2722
2994
  /**
2723
2995
  * The type of event: "call.rejected" in this case
@@ -2740,6 +3012,9 @@ export interface CallRequest {
2740
3012
  team?: string;
2741
3013
  video?: boolean;
2742
3014
  members?: MemberRequest[];
3015
+ /**
3016
+ * User request object
3017
+ */
2743
3018
  created_by?: UserRequest;
2744
3019
  custom?: Record<string, any>;
2745
3020
  settings_override?: CallSettingsRequest;
@@ -2772,12 +3047,18 @@ export interface CallResponse {
2772
3047
  */
2773
3048
  updated_at: Date;
2774
3049
  blocked_user_ids: string[];
3050
+ /**
3051
+ * User response object
3052
+ */
2775
3053
  created_by: UserResponse;
2776
3054
  /**
2777
3055
  * Custom data for this object
2778
3056
  */
2779
3057
  custom: Record<string, any>;
2780
3058
  egress: EgressResponse;
3059
+ /**
3060
+ * CallIngressResponse is the payload for ingress settings
3061
+ */
2781
3062
  ingress: CallIngressResponse;
2782
3063
  settings: CallSettingsResponse;
2783
3064
  channel_cid?: string;
@@ -2810,7 +3091,13 @@ export interface CallRingEvent {
2810
3091
  * Call members
2811
3092
  */
2812
3093
  members: MemberResponse[];
3094
+ /**
3095
+ * Represents a call
3096
+ */
2813
3097
  call: CallResponse;
3098
+ /**
3099
+ * User response object
3100
+ */
2814
3101
  user: UserResponse;
2815
3102
  /**
2816
3103
  * The type of event: "call.notification" in this case
@@ -2883,6 +3170,9 @@ export interface CallSessionEndedEvent {
2883
3170
  * Call session ID
2884
3171
  */
2885
3172
  session_id: string;
3173
+ /**
3174
+ * Represents a call
3175
+ */
2886
3176
  call: CallResponse;
2887
3177
  /**
2888
3178
  * The type of event: "call.session_ended" in this case
@@ -2958,6 +3248,9 @@ export interface CallSessionStartedEvent {
2958
3248
  * Call session ID
2959
3249
  */
2960
3250
  session_id: string;
3251
+ /**
3252
+ * Represents a call
3253
+ */
2961
3254
  call: CallResponse;
2962
3255
  /**
2963
3256
  * The type of event: "call.session_started" in this case
@@ -3004,13 +3297,22 @@ export interface CallSettingsRequest {
3004
3297
  export interface CallSettingsResponse {
3005
3298
  audio: AudioSettingsResponse;
3006
3299
  backstage: BackstageSettingsResponse;
3300
+ /**
3301
+ * BroadcastSettingsResponse is the payload for broadcasting settings
3302
+ */
3007
3303
  broadcasting: BroadcastSettingsResponse;
3304
+ /**
3305
+ * EncryptionSettings is the payload for end-to-end encryption settings
3306
+ */
3008
3307
  encryption: EncryptionSettingsResponse;
3009
3308
  frame_recording: FrameRecordingSettingsResponse;
3010
3309
  geofencing: GeofenceSettingsResponse;
3011
3310
  individual_recording: IndividualRecordingSettingsResponse;
3012
3311
  limits: LimitsSettingsResponse;
3013
3312
  raw_recording: RawRecordingSettingsResponse;
3313
+ /**
3314
+ * RecordSettings is the payload for recording settings
3315
+ */
3014
3316
  recording: RecordSettingsResponse;
3015
3317
  ring: RingSettingsResponse;
3016
3318
  screensharing: ScreensharingSettingsResponse;
@@ -3026,6 +3328,9 @@ export interface CallStateResponseFields {
3026
3328
  */
3027
3329
  members: MemberResponse[];
3028
3330
  own_capabilities: OwnCapability[];
3331
+ /**
3332
+ * Represents a call
3333
+ */
3029
3334
  call: CallResponse;
3030
3335
  }
3031
3336
  export interface CallStatsLocation {
@@ -3181,6 +3486,9 @@ export interface CallTranscriptionReadyEvent {
3181
3486
  call_cid: string;
3182
3487
  created_at: Date;
3183
3488
  egress_id: string;
3489
+ /**
3490
+ * CallTranscription represents a transcription of a call.
3491
+ */
3184
3492
  call_transcription: CallTranscription;
3185
3493
  /**
3186
3494
  * The type of event: "call.transcription_ready" in this case
@@ -3245,6 +3553,9 @@ export interface CallTypeRuleParameters {
3245
3553
  export interface CallUpdatedEvent {
3246
3554
  call_cid: string;
3247
3555
  created_at: Date;
3556
+ /**
3557
+ * Represents a call
3558
+ */
3248
3559
  call: CallResponse;
3249
3560
  /**
3250
3561
  * The capabilities by role for this call
@@ -3266,6 +3577,9 @@ export interface CallUserFeedbackSubmittedEvent {
3266
3577
  * Call session ID
3267
3578
  */
3268
3579
  session_id: string;
3580
+ /**
3581
+ * User response object
3582
+ */
3269
3583
  user: UserResponse;
3270
3584
  /**
3271
3585
  * The type of event, "call.user_feedback" in this case
@@ -3353,6 +3667,9 @@ export interface CampaignResponse {
3353
3667
  stop_at?: Date;
3354
3668
  channel_template?: CampaignChannelTemplate;
3355
3669
  message_template?: CampaignMessageTemplate;
3670
+ /**
3671
+ * User response object
3672
+ */
3356
3673
  sender?: UserResponse;
3357
3674
  }
3358
3675
  export interface CampaignStartedEvent {
@@ -3381,6 +3698,9 @@ export interface CancelImportV2TaskResponse {
3381
3698
  }
3382
3699
  export interface CastPollVoteRequest {
3383
3700
  user_id?: string;
3701
+ /**
3702
+ * User request object
3703
+ */
3384
3704
  user?: UserRequest;
3385
3705
  vote?: VoteData;
3386
3706
  }
@@ -3430,6 +3750,9 @@ export interface ChannelBatchStartedEvent {
3430
3750
  }
3431
3751
  export interface ChannelBatchUpdateRequest {
3432
3752
  operation: 'addMembers' | 'removeMembers' | 'inviteMembers' | 'invites' | 'assignRoles' | 'addModerators' | 'demoteModerators' | 'hide' | 'show' | 'archive' | 'unarchive' | 'updateData';
3753
+ /**
3754
+ * Filter to apply to the query
3755
+ */
3433
3756
  filter: Record<string, any>;
3434
3757
  members?: ChannelBatchMemberRequest[];
3435
3758
  data?: ChannelDataUpdate;
@@ -3479,6 +3802,9 @@ export interface ChannelConfig {
3479
3802
  push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
3480
3803
  allowed_flag_reasons?: string[];
3481
3804
  blocklists?: BlockListOptions[];
3805
+ /**
3806
+ * Sets thresholds for AI moderation
3807
+ */
3482
3808
  automod_thresholds?: Thresholds;
3483
3809
  chat_preferences?: ChatPreferences;
3484
3810
  }
@@ -3571,15 +3897,39 @@ export interface ChannelConfigWithInfo {
3571
3897
  push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
3572
3898
  allowed_flag_reasons?: string[];
3573
3899
  blocklists?: BlockListOptions[];
3900
+ /**
3901
+ * Sets thresholds for AI moderation
3902
+ */
3574
3903
  automod_thresholds?: Thresholds;
3575
3904
  chat_preferences?: ChatPreferences;
3576
3905
  grants?: Record<string, string[]>;
3577
3906
  }
3907
+ export interface ChannelContextResponse {
3908
+ /**
3909
+ * Channel CID (<type>:<id>)
3910
+ */
3911
+ cid: string;
3912
+ /**
3913
+ * Channel ID
3914
+ */
3915
+ id: string;
3916
+ /**
3917
+ * Channel type
3918
+ */
3919
+ type: string;
3920
+ /**
3921
+ * User response object
3922
+ */
3923
+ created_by?: UserResponse;
3924
+ }
3578
3925
  export interface ChannelCreatedEvent {
3579
3926
  /**
3580
3927
  * Date/time of creation
3581
3928
  */
3582
3929
  created_at: Date;
3930
+ /**
3931
+ * Represents channel in chat
3932
+ */
3583
3933
  channel: ChannelResponse;
3584
3934
  custom: Record<string, any>;
3585
3935
  /**
@@ -3617,6 +3967,9 @@ export interface ChannelDataUpdate {
3617
3967
  disabled?: boolean;
3618
3968
  frozen?: boolean;
3619
3969
  team?: string;
3970
+ /**
3971
+ * Channel configuration overrides
3972
+ */
3620
3973
  config_overrides?: ChannelConfigOverrides;
3621
3974
  custom?: Record<string, any>;
3622
3975
  }
@@ -3625,6 +3978,9 @@ export interface ChannelDeletedEvent {
3625
3978
  * Date/time of creation
3626
3979
  */
3627
3980
  created_at: Date;
3981
+ /**
3982
+ * Represents channel in chat
3983
+ */
3628
3984
  channel: ChannelResponse;
3629
3985
  custom: Record<string, any>;
3630
3986
  /**
@@ -3709,6 +4065,10 @@ export interface ChannelGetOrCreateRequest {
3709
4065
  */
3710
4066
  state?: boolean;
3711
4067
  thread_unread_counts?: boolean;
4068
+ /**
4069
+ * Top-level keys of the message sender's channel-member custom data to include under member.custom (max 8 keys, 64 chars each)
4070
+ */
4071
+ member_custom_include?: string[];
3712
4072
  data?: ChannelInput;
3713
4073
  members?: PaginationParams;
3714
4074
  messages?: MessagePaginationParams;
@@ -3723,6 +4083,9 @@ export interface ChannelHiddenEvent {
3723
4083
  * Date/time of creation
3724
4084
  */
3725
4085
  created_at: Date;
4086
+ /**
4087
+ * Represents channel in chat
4088
+ */
3726
4089
  channel: ChannelResponse;
3727
4090
  custom: Record<string, any>;
3728
4091
  /**
@@ -3760,7 +4123,7 @@ export interface ChannelInput {
3760
4123
  */
3761
4124
  auto_translation_enabled?: boolean;
3762
4125
  /**
3763
- * Switch auto translation language
4126
+ * Language (or comma-separated list of languages) to translate to when auto translation is active
3764
4127
  */
3765
4128
  auto_translation_language?: string;
3766
4129
  created_by_id?: string;
@@ -3777,7 +4140,13 @@ export interface ChannelInput {
3777
4140
  filter_tags?: string[];
3778
4141
  invites?: ChannelMemberRequest[];
3779
4142
  members?: ChannelMemberRequest[];
4143
+ /**
4144
+ * Channel configuration overrides
4145
+ */
3780
4146
  config_overrides?: ChannelConfigOverrides;
4147
+ /**
4148
+ * User request object
4149
+ */
3781
4150
  created_by?: UserRequest;
3782
4151
  custom?: Record<string, any>;
3783
4152
  }
@@ -3789,7 +4158,13 @@ export interface ChannelInputRequest {
3789
4158
  team?: string;
3790
4159
  invites?: ChannelMemberRequest[];
3791
4160
  members?: ChannelMemberRequest[];
4161
+ /**
4162
+ * Channel configuration overrides
4163
+ */
3792
4164
  config_overrides?: ConfigOverridesRequest;
4165
+ /**
4166
+ * User request object
4167
+ */
3793
4168
  created_by?: UserRequest;
3794
4169
  custom?: Record<string, any>;
3795
4170
  }
@@ -3802,6 +4177,10 @@ export interface ChannelMemberPartialResponse {
3802
4177
  * Whether the user muted notifications for this channel
3803
4178
  */
3804
4179
  notifications_muted: boolean;
4180
+ /**
4181
+ * Channel-member custom fields projected via `member_custom_include`
4182
+ */
4183
+ custom?: Record<string, any>;
3805
4184
  }
3806
4185
  export interface ChannelMemberRequest {
3807
4186
  user_id: string;
@@ -3810,6 +4189,9 @@ export interface ChannelMemberRequest {
3810
4189
  */
3811
4190
  channel_role?: string;
3812
4191
  custom?: Record<string, any>;
4192
+ /**
4193
+ * User response object
4194
+ */
3813
4195
  user?: UserResponse;
3814
4196
  }
3815
4197
  export interface ChannelMemberResponse {
@@ -3840,7 +4222,15 @@ export interface ChannelMemberResponse {
3840
4222
  * Expiration date of the ban
3841
4223
  */
3842
4224
  ban_expires?: Date;
4225
+ /**
4226
+ * Whether the member's ban also applies to channels the channel's creator will create in the future (an active future channel ban by the creator targets this member)
4227
+ */
4228
+ ban_from_future_channels?: boolean;
3843
4229
  deleted_at?: Date;
4230
+ /**
4231
+ * Expiration date of the future channel ban; absent when the future channel ban is permanent
4232
+ */
4233
+ future_channel_ban_expires?: Date;
3844
4234
  /**
3845
4235
  * Date when invite was accepted
3846
4236
  */
@@ -3865,6 +4255,9 @@ export interface ChannelMemberResponse {
3865
4255
  status?: string;
3866
4256
  user_id?: string;
3867
4257
  deleted_messages?: string[];
4258
+ /**
4259
+ * User response object
4260
+ */
3868
4261
  user?: UserResponse;
3869
4262
  }
3870
4263
  export interface ChannelMessageCountRuleParameters {
@@ -3876,6 +4269,9 @@ export interface ChannelMessagesResponse {
3876
4269
  * List of messages
3877
4270
  */
3878
4271
  messages: MessageResponse[];
4272
+ /**
4273
+ * Represents channel in chat
4274
+ */
3879
4275
  channel: ChannelResponse;
3880
4276
  }
3881
4277
  export interface ChannelMetadata {
@@ -3902,7 +4298,13 @@ export interface ChannelMute {
3902
4298
  * Date/time of mute expiration
3903
4299
  */
3904
4300
  expires?: Date;
4301
+ /**
4302
+ * Represents channel in chat
4303
+ */
3905
4304
  channel?: ChannelResponse;
4305
+ /**
4306
+ * User response object
4307
+ */
3906
4308
  user?: UserResponse;
3907
4309
  }
3908
4310
  export interface ChannelMutedEvent {
@@ -4008,7 +4410,7 @@ export interface ChannelResponse {
4008
4410
  */
4009
4411
  auto_translation_enabled?: boolean;
4010
4412
  /**
4011
- * Language to translate to when auto translation is active
4413
+ * Language (or comma-separated list of languages) to translate to when auto translation is active
4012
4414
  */
4013
4415
  auto_translation_language?: string;
4014
4416
  /**
@@ -4072,7 +4474,13 @@ export interface ChannelResponse {
4072
4474
  */
4073
4475
  own_capabilities?: ChannelOwnCapability[];
4074
4476
  config?: ChannelConfigWithInfo;
4477
+ /**
4478
+ * User response object
4479
+ */
4075
4480
  created_by?: UserResponse;
4481
+ /**
4482
+ * User response object
4483
+ */
4076
4484
  truncated_by?: UserResponse;
4077
4485
  }
4078
4486
  export interface ChannelStateResponse {
@@ -4088,6 +4496,9 @@ export interface ChannelStateResponse {
4088
4496
  pending_messages?: PendingMessageResponse[];
4089
4497
  read?: ReadStateResponse[];
4090
4498
  watchers?: UserResponse[];
4499
+ /**
4500
+ * Represents channel in chat
4501
+ */
4091
4502
  channel?: ChannelResponse;
4092
4503
  draft?: DraftResponse;
4093
4504
  membership?: ChannelMemberResponse;
@@ -4135,6 +4546,9 @@ export interface ChannelStateResponseFields {
4135
4546
  * List of user who is watching the channel
4136
4547
  */
4137
4548
  watchers?: UserResponse[];
4549
+ /**
4550
+ * Represents channel in chat
4551
+ */
4138
4552
  channel?: ChannelResponse;
4139
4553
  draft?: DraftResponse;
4140
4554
  membership?: ChannelMemberResponse;
@@ -4145,6 +4559,9 @@ export interface ChannelTruncatedEvent {
4145
4559
  * Date/time of creation
4146
4560
  */
4147
4561
  created_at: Date;
4562
+ /**
4563
+ * Represents channel in chat
4564
+ */
4148
4565
  channel: ChannelResponse;
4149
4566
  custom: Record<string, any>;
4150
4567
  /**
@@ -4175,6 +4592,9 @@ export interface ChannelTruncatedEvent {
4175
4592
  */
4176
4593
  team?: string;
4177
4594
  channel_custom?: Record<string, any>;
4595
+ /**
4596
+ * Represents any chat message
4597
+ */
4178
4598
  message?: MessageResponse;
4179
4599
  user?: UserResponseCommonFields;
4180
4600
  }
@@ -4215,6 +4635,9 @@ export interface ChannelTypeConfig {
4215
4635
  push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
4216
4636
  allowed_flag_reasons?: string[];
4217
4637
  blocklists?: BlockListOptions[];
4638
+ /**
4639
+ * Sets thresholds for AI moderation
4640
+ */
4218
4641
  automod_thresholds?: Thresholds;
4219
4642
  chat_preferences?: ChatPreferences;
4220
4643
  }
@@ -4265,6 +4688,9 @@ export interface ChannelUpdatedEvent {
4265
4688
  * Date/time of creation
4266
4689
  */
4267
4690
  created_at: Date;
4691
+ /**
4692
+ * Represents channel in chat
4693
+ */
4268
4694
  channel: ChannelResponse;
4269
4695
  custom: Record<string, any>;
4270
4696
  /**
@@ -4295,6 +4721,9 @@ export interface ChannelUpdatedEvent {
4295
4721
  */
4296
4722
  team?: string;
4297
4723
  channel_custom?: Record<string, any>;
4724
+ /**
4725
+ * Represents any chat message
4726
+ */
4298
4727
  message?: MessageResponse;
4299
4728
  user?: UserResponseCommonFields;
4300
4729
  }
@@ -4303,6 +4732,9 @@ export interface ChannelVisibleEvent {
4303
4732
  * Date/time of creation
4304
4733
  */
4305
4734
  created_at: Date;
4735
+ /**
4736
+ * Represents channel in chat
4737
+ */
4306
4738
  channel: ChannelResponse;
4307
4739
  custom: Record<string, any>;
4308
4740
  /**
@@ -4383,6 +4815,9 @@ export interface ChatMessageResponse {
4383
4815
  custom: Record<string, any>;
4384
4816
  reaction_counts: Record<string, number>;
4385
4817
  reaction_scores: Record<string, number>;
4818
+ /**
4819
+ * User response object
4820
+ */
4386
4821
  user: UserResponse;
4387
4822
  command?: string;
4388
4823
  deleted_at?: Date;
@@ -4404,6 +4839,9 @@ export interface ChatMessageResponse {
4404
4839
  image_labels?: Record<string, string[]>;
4405
4840
  member?: ChannelMemberPartialResponse;
4406
4841
  moderation?: ChatModerationV2Response;
4842
+ /**
4843
+ * User response object
4844
+ */
4407
4845
  pinned_by?: UserResponse;
4408
4846
  poll?: PollResponseData;
4409
4847
  quoted_message?: ChatMessageResponse;
@@ -4459,6 +4897,9 @@ export interface ChatReactionGroupResponse {
4459
4897
  export interface ChatReactionGroupUserResponse {
4460
4898
  created_at: Date;
4461
4899
  user_id: string;
4900
+ /**
4901
+ * User response object
4902
+ */
4462
4903
  user?: UserResponse;
4463
4904
  }
4464
4905
  export interface ChatReactionResponse {
@@ -4469,6 +4910,9 @@ export interface ChatReactionResponse {
4469
4910
  updated_at: Date;
4470
4911
  user_id: string;
4471
4912
  custom: Record<string, any>;
4913
+ /**
4914
+ * User response object
4915
+ */
4472
4916
  user: UserResponse;
4473
4917
  }
4474
4918
  export interface ChatReminderResponseData {
@@ -4479,6 +4923,9 @@ export interface ChatReminderResponseData {
4479
4923
  user_id: string;
4480
4924
  remind_at?: Date;
4481
4925
  message?: ChatMessageResponse;
4926
+ /**
4927
+ * User response object
4928
+ */
4482
4929
  user?: UserResponse;
4483
4930
  }
4484
4931
  export interface ChatSharedLocationResponseData {
@@ -4534,6 +4981,9 @@ export interface CheckPushRequest {
4534
4981
  */
4535
4982
  skip_devices?: boolean;
4536
4983
  user_id?: string;
4984
+ /**
4985
+ * User request object
4986
+ */
4537
4987
  user?: UserRequest;
4538
4988
  }
4539
4989
  export interface CheckPushResponse {
@@ -4594,6 +5044,9 @@ export interface CheckRequest {
4594
5044
  * Additional moderation configuration options
4595
5045
  */
4596
5046
  options?: Record<string, any>;
5047
+ /**
5048
+ * User request object
5049
+ */
4597
5050
  user?: UserRequest;
4598
5051
  }
4599
5052
  export interface CheckResponse {
@@ -4816,6 +5269,9 @@ export interface ClientOSDataResponse {
4816
5269
  export interface ClosedCaptionEvent {
4817
5270
  call_cid: string;
4818
5271
  created_at: Date;
5272
+ /**
5273
+ * CallClosedCaption represents a closed caption of a call.
5274
+ */
4819
5275
  closed_caption: CallClosedCaption;
4820
5276
  /**
4821
5277
  * The type of event: "call.closed_caption" in this case
@@ -5056,6 +5512,9 @@ export interface CommentResponse {
5056
5512
  * Current user's reactions to this activity
5057
5513
  */
5058
5514
  own_reactions: FeedsReactionResponse[];
5515
+ /**
5516
+ * User response object
5517
+ */
5059
5518
  user: UserResponse;
5060
5519
  /**
5061
5520
  * Controversy score of the comment
@@ -5133,6 +5592,13 @@ export interface CommitMessageRequest {
5133
5592
  export interface CompositeRecordingResponse {
5134
5593
  status: string;
5135
5594
  }
5595
+ export interface ConcurrencyMinute {
5596
+ joins: number;
5597
+ leaves: number;
5598
+ max: number;
5599
+ min: number;
5600
+ minute: string;
5601
+ }
5136
5602
  export interface ConfigOverridesRequest {
5137
5603
  /**
5138
5604
  * Blocklist name
@@ -5268,6 +5734,11 @@ export interface CountByMinuteResponse {
5268
5734
  count: number;
5269
5735
  start_ts: Date;
5270
5736
  }
5737
+ export interface Coverage {
5738
+ publisher_encoding_profiles: number;
5739
+ absent: AbsentMetric[];
5740
+ metrics_pct: MetricsPct;
5741
+ }
5271
5742
  export interface CreateBlockListRequest {
5272
5743
  /**
5273
5744
  * Block list name
@@ -5286,12 +5757,20 @@ export interface CreateBlockListRequest {
5286
5757
  * Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word
5287
5758
  */
5288
5759
  type?: 'regex' | 'domain' | 'domain_allowlist' | 'email' | 'email_allowlist' | 'word';
5760
+ user_id?: string;
5761
+ /**
5762
+ * User request object
5763
+ */
5764
+ user?: UserRequest;
5289
5765
  }
5290
5766
  export interface CreateBlockListResponse {
5291
5767
  /**
5292
5768
  * Duration of the request in milliseconds
5293
5769
  */
5294
5770
  duration: string;
5771
+ /**
5772
+ * Block list contains restricted words
5773
+ */
5295
5774
  blocklist?: BlockListResponse;
5296
5775
  }
5297
5776
  export interface CreateCallTypeRequest {
@@ -5549,6 +6028,9 @@ export interface CreateChannelTypeResponse {
5549
6028
  push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
5550
6029
  allowed_flag_reasons?: string[];
5551
6030
  blocklists?: BlockListOptions[];
6031
+ /**
6032
+ * Sets thresholds for AI moderation
6033
+ */
5552
6034
  automod_thresholds?: Thresholds;
5553
6035
  chat_preferences?: ChatPreferences;
5554
6036
  }
@@ -5558,6 +6040,9 @@ export interface CreateCollectionsRequest {
5558
6040
  */
5559
6041
  collections: CollectionRequest[];
5560
6042
  user_id?: string;
6043
+ /**
6044
+ * User request object
6045
+ */
5561
6046
  user?: UserRequest;
5562
6047
  }
5563
6048
  export interface CreateCollectionsResponse {
@@ -5587,6 +6072,9 @@ export interface CreateCommandRequest {
5587
6072
  }
5588
6073
  export interface CreateCommandResponse {
5589
6074
  duration: string;
6075
+ /**
6076
+ * Represents custom chat command
6077
+ */
5590
6078
  command?: Command;
5591
6079
  }
5592
6080
  export interface CreateDeviceRequest {
@@ -5614,6 +6102,9 @@ export interface CreateDeviceRequest {
5614
6102
  * When true the token is for Apple VoIP push notifications
5615
6103
  */
5616
6104
  voip_token?: boolean;
6105
+ /**
6106
+ * User request object
6107
+ */
5617
6108
  user?: UserRequest;
5618
6109
  }
5619
6110
  export interface CreateExternalStorageRequest {
@@ -5634,7 +6125,13 @@ export interface CreateExternalStorageRequest {
5634
6125
  * The path prefix to use for storing files
5635
6126
  */
5636
6127
  path?: string;
6128
+ /**
6129
+ * Config for creating Amazon S3 storage.
6130
+ */
5637
6131
  aws_s3?: S3Request;
6132
+ /**
6133
+ * Config for creating Azure Blob Storage storage
6134
+ */
5638
6135
  azure_blob?: AzureRequest;
5639
6136
  }
5640
6137
  export interface CreateExternalStorageResponse {
@@ -5709,6 +6206,9 @@ export interface CreateFeedsBatchResponse {
5709
6206
  feeds: FeedResponse[];
5710
6207
  }
5711
6208
  export interface CreateGuestRequest {
6209
+ /**
6210
+ * User request object
6211
+ */
5712
6212
  user: UserRequest;
5713
6213
  }
5714
6214
  export interface CreateGuestResponse {
@@ -5720,6 +6220,9 @@ export interface CreateGuestResponse {
5720
6220
  * Duration of the request in milliseconds
5721
6221
  */
5722
6222
  duration: string;
6223
+ /**
6224
+ * User response object
6225
+ */
5723
6226
  user: UserResponse;
5724
6227
  }
5725
6228
  export interface CreateImportRequest {
@@ -5749,6 +6252,9 @@ export interface CreateImportV2TaskRequest {
5749
6252
  product: 'chat' | 'feeds';
5750
6253
  settings: ImportV2TaskSettings;
5751
6254
  user_id?: string;
6255
+ /**
6256
+ * User request object
6257
+ */
5752
6258
  user?: UserRequest;
5753
6259
  }
5754
6260
  export interface CreateImportV2TaskResponse {
@@ -5794,13 +6300,42 @@ export interface CreateMembershipLevelResponse {
5794
6300
  duration: string;
5795
6301
  membership_level: MembershipLevelResponse;
5796
6302
  }
6303
+ export interface CreatePolicyTestSetRequest {
6304
+ /**
6305
+ * Display name; unique within an app
6306
+ */
6307
+ name: string;
6308
+ /**
6309
+ * Moderation config key (default: app default)
6310
+ */
6311
+ config_key?: string;
6312
+ /**
6313
+ * Execution target: 'check' or 'labels'. Optional — defaults to 'labels' when the org has the labels API enabled, 'check' otherwise
6314
+ */
6315
+ mode?: string;
6316
+ /**
6317
+ * Team scope for the config (optional)
6318
+ */
6319
+ team?: string;
6320
+ /**
6321
+ * Messages to test; capped at 1000. Mutually exclusive with seed
6322
+ */
6323
+ rows?: PolicyTestRow[];
6324
+ seed?: PolicyTestSeedSpec;
6325
+ }
5797
6326
  export interface CreatePollOptionRequest {
5798
6327
  /**
5799
6328
  * Option text
5800
6329
  */
5801
6330
  text: string;
5802
6331
  user_id?: string;
6332
+ /**
6333
+ * Custom data for this object
6334
+ */
5803
6335
  custom?: Record<string, any>;
6336
+ /**
6337
+ * User request object
6338
+ */
5804
6339
  user?: UserRequest;
5805
6340
  }
5806
6341
  export interface CreatePollRequest {
@@ -5833,7 +6368,13 @@ export interface CreatePollRequest {
5833
6368
  user_id?: string;
5834
6369
  voting_visibility?: 'anonymous' | 'public';
5835
6370
  options?: PollOptionInput[];
6371
+ /**
6372
+ * Custom data for this object
6373
+ */
5836
6374
  custom?: Record<string, any>;
6375
+ /**
6376
+ * User request object
6377
+ */
5837
6378
  user?: UserRequest;
5838
6379
  }
5839
6380
  export interface CreateQueueRequest {
@@ -5843,11 +6384,17 @@ export interface CreateQueueRequest {
5843
6384
  user_id?: string;
5844
6385
  sort?: Array<Record<string, any>>;
5845
6386
  filters?: Record<string, any>;
6387
+ /**
6388
+ * User request object
6389
+ */
5846
6390
  user?: UserRequest;
5847
6391
  }
5848
6392
  export interface CreateReminderRequest {
5849
6393
  remind_at?: Date;
5850
6394
  user_id?: string;
6395
+ /**
6396
+ * User request object
6397
+ */
5851
6398
  user?: UserRequest;
5852
6399
  }
5853
6400
  export interface CreateRoleRequest {
@@ -5883,6 +6430,9 @@ export interface CreateSIPTrunkRequest {
5883
6430
  }
5884
6431
  export interface CreateSIPTrunkResponse {
5885
6432
  duration: string;
6433
+ /**
6434
+ * SIP trunk information
6435
+ */
5886
6436
  sip_trunk?: SIPTrunkResponse;
5887
6437
  }
5888
6438
  export interface CreateSegmentRequest {
@@ -5994,7 +6544,13 @@ export interface CustomCheckRequest {
5994
6544
  */
5995
6545
  entity_creator_id?: string;
5996
6546
  user_id?: string;
6547
+ /**
6548
+ * Content payload for moderation
6549
+ */
5997
6550
  moderation_payload?: ModerationPayloadRequest;
6551
+ /**
6552
+ * User request object
6553
+ */
5998
6554
  user?: UserRequest;
5999
6555
  }
6000
6556
  export interface CustomCheckResponse {
@@ -6022,6 +6578,9 @@ export interface CustomVideoEvent {
6022
6578
  * Custom data for this object
6023
6579
  */
6024
6580
  custom: Record<string, any>;
6581
+ /**
6582
+ * User response object
6583
+ */
6025
6584
  user: UserResponse;
6026
6585
  /**
6027
6586
  * The type of event, "custom" in this case
@@ -6052,6 +6611,15 @@ export interface DailyAggregateUserFeedbackReportResponse {
6052
6611
  date: string;
6053
6612
  report: UserFeedbackReport;
6054
6613
  }
6614
+ export interface DailyDigestCallSessionSummary {
6615
+ call_cid: string;
6616
+ call_session_id: string;
6617
+ has_digest: boolean;
6618
+ counts: CallStatsParticipantCounts;
6619
+ digest_error?: string;
6620
+ session_ended_at?: string;
6621
+ session_started_at?: string;
6622
+ }
6055
6623
  export interface DailyMetricResponse {
6056
6624
  /**
6057
6625
  * Date in YYYY-MM-DD format
@@ -6105,6 +6673,9 @@ export interface DeactivateUserResponse {
6105
6673
  * Duration of the request in milliseconds
6106
6674
  */
6107
6675
  duration: string;
6676
+ /**
6677
+ * User response object
6678
+ */
6108
6679
  user?: UserResponse;
6109
6680
  }
6110
6681
  export interface DeactivateUsersRequest {
@@ -6176,6 +6747,9 @@ export interface DeleteActivitiesRequest {
6176
6747
  */
6177
6748
  hard_delete?: boolean;
6178
6749
  user_id?: string;
6750
+ /**
6751
+ * User request object
6752
+ */
6179
6753
  user?: UserRequest;
6180
6754
  }
6181
6755
  export interface DeleteActivitiesResponse {
@@ -6226,6 +6800,9 @@ export interface DeleteCallRequest {
6226
6800
  }
6227
6801
  export interface DeleteCallResponse {
6228
6802
  duration: string;
6803
+ /**
6804
+ * Represents a call
6805
+ */
6229
6806
  call: CallResponse;
6230
6807
  task_id?: string;
6231
6808
  }
@@ -6240,6 +6817,9 @@ export interface DeleteChannelResponse {
6240
6817
  * Duration of the request in milliseconds
6241
6818
  */
6242
6819
  duration: string;
6820
+ /**
6821
+ * Represents channel in chat
6822
+ */
6243
6823
  channel?: ChannelResponse;
6244
6824
  }
6245
6825
  export interface DeleteChannelsRequest {
@@ -6394,6 +6974,9 @@ export interface DeleteMessageResponse {
6394
6974
  * Duration of the request in milliseconds
6395
6975
  */
6396
6976
  duration: string;
6977
+ /**
6978
+ * Represents any chat message
6979
+ */
6397
6980
  message: MessageResponse;
6398
6981
  }
6399
6982
  export interface DeleteModerationConfigResponse {
@@ -6410,6 +6993,9 @@ export interface DeleteModerationTemplateResponse {
6410
6993
  }
6411
6994
  export interface DeleteQueueRequest {
6412
6995
  user_id?: string;
6996
+ /**
6997
+ * User request object
6998
+ */
6413
6999
  user?: UserRequest;
6414
7000
  }
6415
7001
  export interface DeleteReactionRequestPayload {
@@ -6435,6 +7021,9 @@ export interface DeleteReactionResponse {
6435
7021
  * Duration of the request in milliseconds
6436
7022
  */
6437
7023
  duration: string;
7024
+ /**
7025
+ * Represents any chat message
7026
+ */
6438
7027
  message: MessageResponse;
6439
7028
  reaction: ReactionResponse;
6440
7029
  }
@@ -6477,6 +7066,32 @@ export interface DeleteTranscriptionResponse {
6477
7066
  */
6478
7067
  duration: string;
6479
7068
  }
7069
+ export interface DeleteUserMessagesRequestPayload {
7070
+ /**
7071
+ * Message deletion mode: soft, pruning, or hard
7072
+ */
7073
+ delete_messages: 'soft' | 'pruning' | 'hard';
7074
+ /**
7075
+ * Optional: scope deletion to a single channel (alternative to app-wide deletion)
7076
+ */
7077
+ channel_cid?: string;
7078
+ /**
7079
+ * Whether to also delete the user's reactions on other users' messages
7080
+ */
7081
+ delete_reactions?: boolean;
7082
+ /**
7083
+ * ID of the user whose messages should be deleted (alternative to item_id)
7084
+ */
7085
+ entity_id?: string;
7086
+ /**
7087
+ * Type of the entity
7088
+ */
7089
+ entity_type?: string;
7090
+ /**
7091
+ * Reason for the deletion
7092
+ */
7093
+ reason?: string;
7094
+ }
6480
7095
  export interface DeleteUserRequestPayload {
6481
7096
  /**
6482
7097
  * Also delete all user conversations
@@ -6569,6 +7184,16 @@ export interface DeliveredMessagePayload {
6569
7184
  export interface DeliveryReceiptsResponse {
6570
7185
  enabled: boolean;
6571
7186
  }
7187
+ export interface DeliveryZoneSegment {
7188
+ key: string;
7189
+ outlier: boolean;
7190
+ sessions: number;
7191
+ avg_quality_score?: number;
7192
+ p5_quality_score?: number;
7193
+ poor_pct?: number;
7194
+ share_pct?: number;
7195
+ watch_share_pct?: number;
7196
+ }
6572
7197
  export interface DeviceDataResponse {
6573
7198
  name?: string;
6574
7199
  version?: string;
@@ -6667,10 +7292,22 @@ export interface DraftPayloadResponse {
6667
7292
  export interface DraftResponse {
6668
7293
  channel_cid: string;
6669
7294
  created_at: Date;
7295
+ /**
7296
+ * Contains the draft message content
7297
+ */
6670
7298
  message: DraftPayloadResponse;
6671
7299
  parent_id?: string;
7300
+ /**
7301
+ * Represents channel in chat
7302
+ */
6672
7303
  channel?: ChannelResponse;
7304
+ /**
7305
+ * Represents any chat message
7306
+ */
6673
7307
  parent_message?: MessageResponse;
7308
+ /**
7309
+ * Represents any chat message
7310
+ */
6674
7311
  quoted_message?: MessageResponse;
6675
7312
  }
6676
7313
  export interface EMAUStatsResponse {
@@ -6718,17 +7355,34 @@ export interface EgressResponse {
6718
7355
  individual_recording?: IndividualRecordingResponse;
6719
7356
  raw_recording?: RawRecordingResponse;
6720
7357
  }
7358
+ export interface EncodingProfile {
7359
+ getstats_snapshots: number;
7360
+ source_file: string;
7361
+ svc_modes: string[];
7362
+ quality_limitation_durations_s: Record<string, number>;
7363
+ quality_limitation_samples: Record<string, number>;
7364
+ avg_send_kbps?: number;
7365
+ codec?: string;
7366
+ encoder_impl?: string;
7367
+ fps_p10?: number;
7368
+ fps_p50?: number;
7369
+ hardware_encode?: boolean;
7370
+ ladder_type?: string;
7371
+ power_efficient?: boolean;
7372
+ resolution?: string;
7373
+ simulcast_layers?: number;
7374
+ }
6721
7375
  export interface EncryptionSettingsRequest {
6722
7376
  /**
6723
- * if true, the call is created end-to-end encrypted
7377
+ * Encryption mode. One of: available, disabled, auto-on
6724
7378
  */
6725
- enabled?: boolean;
7379
+ mode?: 'available' | 'disabled' | 'auto-on';
6726
7380
  }
6727
7381
  export interface EncryptionSettingsResponse {
6728
7382
  /**
6729
- * whether the call is end-to-end encrypted
7383
+ * the resolved encryption mode for the call
6730
7384
  */
6731
- enabled: boolean;
7385
+ mode: 'available' | 'disabled' | 'auto-on';
6732
7386
  }
6733
7387
  export interface EndCallRequest {
6734
7388
  }
@@ -6990,6 +7644,9 @@ export interface EventRequest {
6990
7644
  parent_id?: string;
6991
7645
  user_id?: string;
6992
7646
  custom?: Record<string, any>;
7647
+ /**
7648
+ * User request object
7649
+ */
6993
7650
  user?: UserRequest;
6994
7651
  }
6995
7652
  export interface EventResponse {
@@ -6997,6 +7654,9 @@ export interface EventResponse {
6997
7654
  * Duration of the request in milliseconds
6998
7655
  */
6999
7656
  duration: string;
7657
+ /**
7658
+ * Represents an BaseEvent that happened in Stream Chat
7659
+ */
7000
7660
  event: WSEvent;
7001
7661
  }
7002
7662
  export interface ExportChannelsRequest {
@@ -7009,6 +7669,10 @@ export interface ExportChannelsRequest {
7009
7669
  */
7010
7670
  clear_deleted_message_text?: boolean;
7011
7671
  export_users?: boolean;
7672
+ /**
7673
+ * Output format: 'json' (default) or 'csv'. csv requires version=v2 and is incompatible with export_users
7674
+ */
7675
+ format?: 'json' | 'csv';
7012
7676
  /**
7013
7677
  * Set if you want to include deleted channels
7014
7678
  */
@@ -7021,6 +7685,10 @@ export interface ExportChannelsRequest {
7021
7685
  * Export version
7022
7686
  */
7023
7687
  version?: string;
7688
+ /**
7689
+ * For csv format: subset of message columns to include (defaults to a standard set)
7690
+ */
7691
+ include_fields?: string[];
7024
7692
  }
7025
7693
  export interface ExportChannelsResponse {
7026
7694
  /**
@@ -7054,6 +7722,9 @@ export interface ExportUserResponse {
7054
7722
  * List of exported reactions
7055
7723
  */
7056
7724
  reactions?: ReactionResponse[];
7725
+ /**
7726
+ * User response object
7727
+ */
7057
7728
  user?: UserResponse;
7058
7729
  }
7059
7730
  export interface ExportUsersRequest {
@@ -7302,6 +7973,9 @@ export interface FeedMemberResponse {
7302
7973
  * When the membership was last updated
7303
7974
  */
7304
7975
  updated_at: Date;
7976
+ /**
7977
+ * User response object
7978
+ */
7305
7979
  user: UserResponse;
7306
7980
  /**
7307
7981
  * When the invite was accepted
@@ -7465,6 +8139,9 @@ export interface FeedResponse {
7465
8139
  * When the feed was last updated
7466
8140
  */
7467
8141
  updated_at: Date;
8142
+ /**
8143
+ * User response object
8144
+ */
7468
8145
  created_by: UserResponse;
7469
8146
  /**
7470
8147
  * When the feed was deleted
@@ -7543,6 +8220,9 @@ export interface FeedSuggestionResponse {
7543
8220
  * When the feed was last updated
7544
8221
  */
7545
8222
  updated_at: Date;
8223
+ /**
8224
+ * User response object
8225
+ */
7546
8226
  created_by: UserResponse;
7547
8227
  /**
7548
8228
  * When the feed was deleted
@@ -7630,6 +8310,9 @@ export interface FeedsBookmarkResponse {
7630
8310
  object_id: string;
7631
8311
  object_type: string;
7632
8312
  updated_at: Date;
8313
+ /**
8314
+ * User response object
8315
+ */
7633
8316
  user: UserResponse;
7634
8317
  activity_id?: string;
7635
8318
  custom?: Record<string, any>;
@@ -7656,6 +8339,9 @@ export interface FeedsFeedResponse {
7656
8339
  name: string;
7657
8340
  pin_count: number;
7658
8341
  updated_at: Date;
8342
+ /**
8343
+ * User response object
8344
+ */
7659
8345
  created_by: UserResponse;
7660
8346
  deleted_at?: Date;
7661
8347
  visibility?: string;
@@ -7761,6 +8447,9 @@ export interface FeedsReactionResponse {
7761
8447
  created_at: Date;
7762
8448
  type: string;
7763
8449
  updated_at: Date;
8450
+ /**
8451
+ * User response object
8452
+ */
7764
8453
  user: UserResponse;
7765
8454
  comment_id?: string;
7766
8455
  custom?: Record<string, any>;
@@ -7768,6 +8457,9 @@ export interface FeedsReactionResponse {
7768
8457
  export interface FeedsShareResponse {
7769
8458
  activity_id: string;
7770
8459
  created_at: Date;
8460
+ /**
8461
+ * User response object
8462
+ */
7771
8463
  user: UserResponse;
7772
8464
  }
7773
8465
  export interface FeedsV3ActivityResponse {
@@ -7798,6 +8490,9 @@ export interface FeedsV3ActivityResponse {
7798
8490
  custom: Record<string, any>;
7799
8491
  reaction_groups: Record<string, FeedsReactionGroupResponse>;
7800
8492
  search_data: Record<string, any>;
8493
+ /**
8494
+ * User response object
8495
+ */
7801
8496
  user: UserResponse;
7802
8497
  deleted_at?: Date;
7803
8498
  edited_at?: Date;
@@ -7838,6 +8533,9 @@ export interface FeedsV3CommentResponse {
7838
8533
  upvote_count: number;
7839
8534
  mentioned_users: UserResponse[];
7840
8535
  own_reactions: FeedsReactionResponse[];
8536
+ /**
8537
+ * User response object
8538
+ */
7841
8539
  user: UserResponse;
7842
8540
  controversy_score?: number;
7843
8541
  deleted_at?: Date;
@@ -7905,6 +8603,10 @@ export interface FilterConfigResponse {
7905
8603
  * The moderation_payload.custom keys the app has configured as review-queue filter chips (via moderation_dashboard_preferences.filterable_custom_keys). Discovery hint for the dashboard only — the filter accepts any custom key regardless of this list.
7906
8604
  */
7907
8605
  filterable_custom_keys?: string[];
8606
+ /**
8607
+ * AI image moderation labels available as filter values, as a map of L1 label to its L2 sub-labels. Reflects the app's effective image taxonomy: custom Bodyguard taxonomy when enabled, otherwise the standard catalogue of the org's enabled image providers.
8608
+ */
8609
+ ai_image_taxonomy?: Record<string, string[]>;
7908
8610
  }
7909
8611
  export interface FirebaseConfig {
7910
8612
  apn_template?: string;
@@ -7975,6 +8677,9 @@ export interface FlagRequest {
7975
8677
  */
7976
8678
  custom?: Record<string, any>;
7977
8679
  moderation_payload?: ModerationPayload;
8680
+ /**
8681
+ * User request object
8682
+ */
7978
8683
  user?: UserRequest;
7979
8684
  }
7980
8685
  export interface FlagResponse {
@@ -7989,8 +8694,17 @@ export interface FlagResponse {
7989
8694
  target_message_id?: string;
7990
8695
  custom?: Record<string, any>;
7991
8696
  details?: FlagDetails;
8697
+ /**
8698
+ * Represents any chat message
8699
+ */
7992
8700
  target_message?: MessageResponse;
8701
+ /**
8702
+ * User response object
8703
+ */
7993
8704
  target_user?: UserResponse;
8705
+ /**
8706
+ * User response object
8707
+ */
7994
8708
  user?: UserResponse;
7995
8709
  }
7996
8710
  export interface FlagUpdatedEvent {
@@ -7998,14 +8712,24 @@ export interface FlagUpdatedEvent {
7998
8712
  custom: Record<string, any>;
7999
8713
  type: string;
8000
8714
  received_at?: Date;
8715
+ /**
8716
+ * User response object
8717
+ */
8001
8718
  created_by?: UserResponse;
8719
+ /**
8720
+ * Represents any chat message
8721
+ */
8002
8722
  message?: MessageResponse;
8723
+ /**
8724
+ * User response object
8725
+ */
8003
8726
  user?: UserResponse;
8004
8727
  }
8005
8728
  export interface FlagUserOptions {
8006
8729
  reason?: string;
8007
8730
  }
8008
8731
  export interface FloodConfig {
8732
+ allowlist?: string[];
8009
8733
  identical?: FloodIdenticalConfig;
8010
8734
  similar?: FloodSimilarConfig;
8011
8735
  }
@@ -8018,6 +8742,7 @@ export interface FloodIdenticalConfig {
8018
8742
  export interface FloodIdenticalRuleParameters {
8019
8743
  threshold?: number;
8020
8744
  time_window?: string;
8745
+ allowlist?: string[];
8021
8746
  }
8022
8747
  export interface FloodSimilarConfig {
8023
8748
  action?: string;
@@ -8030,6 +8755,7 @@ export interface FloodSimilarRuleParameters {
8030
8755
  similarity_distance?: number;
8031
8756
  threshold?: number;
8032
8757
  time_window?: string;
8758
+ allowlist?: string[];
8033
8759
  }
8034
8760
  export interface FollowBatchRequest {
8035
8761
  /**
@@ -8254,7 +8980,13 @@ export interface FutureChannelBanResponse {
8254
8980
  expires?: Date;
8255
8981
  reason?: string;
8256
8982
  shadow?: boolean;
8983
+ /**
8984
+ * User response object
8985
+ */
8257
8986
  banned_by?: UserResponse;
8987
+ /**
8988
+ * User response object
8989
+ */
8258
8990
  user?: UserResponse;
8259
8991
  }
8260
8992
  export interface GeofenceResponse {
@@ -8309,6 +9041,9 @@ export interface GetApplicationResponse {
8309
9041
  }
8310
9042
  export interface GetBlockListResponse {
8311
9043
  duration: string;
9044
+ /**
9045
+ * Block list contains restricted words
9046
+ */
8312
9047
  blocklist?: BlockListResponse;
8313
9048
  }
8314
9049
  export interface GetBlockedUsersResponse {
@@ -8344,12 +9079,16 @@ export interface GetCallReportResponse {
8344
9079
  report: ReportResponse;
8345
9080
  video_reactions?: VideoReactionsResponse[];
8346
9081
  chat_activity?: ChatActivityStatsResponse;
9082
+ digest?: BroadcastDigest;
8347
9083
  session?: CallSessionResponse;
8348
9084
  }
8349
9085
  export interface GetCallResponse {
8350
9086
  duration: string;
8351
9087
  members: MemberResponse[];
8352
9088
  own_capabilities: OwnCapability[];
9089
+ /**
9090
+ * Represents a call
9091
+ */
8353
9092
  call: CallResponse;
8354
9093
  }
8355
9094
  export interface GetCallSessionParticipantStatsDetailsResponse {
@@ -8426,6 +9165,9 @@ export interface GetChannelTypeResponse {
8426
9165
  push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
8427
9166
  allowed_flag_reasons?: string[];
8428
9167
  blocklists?: BlockListOptions[];
9168
+ /**
9169
+ * Sets thresholds for AI moderation
9170
+ */
8429
9171
  automod_thresholds?: Thresholds;
8430
9172
  chat_preferences?: ChatPreferences;
8431
9173
  }
@@ -8479,6 +9221,22 @@ export interface GetCustomPermissionResponse {
8479
9221
  duration: string;
8480
9222
  permission: Permission;
8481
9223
  }
9224
+ export interface GetDailyDigestResponse {
9225
+ date: string;
9226
+ /**
9227
+ * Duration of the request in milliseconds
9228
+ */
9229
+ duration: string;
9230
+ status: string;
9231
+ generated_at?: string;
9232
+ retry_after?: number;
9233
+ revision?: number;
9234
+ schema_version?: string;
9235
+ broadcasts?: BroadcastDigest[];
9236
+ call_sessions?: DailyDigestCallSessionSummary[];
9237
+ digest_kinds?: string[];
9238
+ broadcast_rollup?: BroadcastDailyRollup;
9239
+ }
8482
9240
  export interface GetDraftResponse {
8483
9241
  /**
8484
9242
  * Duration of the request in milliseconds
@@ -8493,6 +9251,28 @@ export interface GetEdgesResponse {
8493
9251
  duration: string;
8494
9252
  edges: EdgeResponse[];
8495
9253
  }
9254
+ export interface GetExternalStorageAWSS3Response {
9255
+ bucket: string;
9256
+ region: string;
9257
+ role_arn: string;
9258
+ path_prefix?: string;
9259
+ }
9260
+ export interface GetExternalStorageGCSResponse {
9261
+ bucket: string;
9262
+ credentials_set: boolean;
9263
+ path_prefix?: string;
9264
+ }
9265
+ export interface GetExternalStorageResponse {
9266
+ created_at: Date;
9267
+ /**
9268
+ * Duration of the request in milliseconds
9269
+ */
9270
+ duration: string;
9271
+ type: string;
9272
+ updated_at: Date;
9273
+ aws_s3?: GetExternalStorageAWSS3Response;
9274
+ gcs?: GetExternalStorageGCSResponse;
9275
+ }
8496
9276
  export interface GetFeedGroupResponse {
8497
9277
  duration: string;
8498
9278
  feed_group: FeedGroupResponse;
@@ -8519,6 +9299,10 @@ export interface GetFeedsRateLimitsResponse {
8519
9299
  * Rate limits for server-side platform (endpoint name -> limit info)
8520
9300
  */
8521
9301
  server_side?: Record<string, LimitInfoResponse>;
9302
+ /**
9303
+ * Rate limits for Unity platform (endpoint name -> limit info)
9304
+ */
9305
+ unity?: Record<string, LimitInfoResponse>;
8522
9306
  /**
8523
9307
  * Rate limits for Web platform (endpoint name -> limit info)
8524
9308
  */
@@ -8582,6 +9366,9 @@ export interface GetMessageResponse {
8582
9366
  * Duration of the request in milliseconds
8583
9367
  */
8584
9368
  duration: string;
9369
+ /**
9370
+ * Represents any chat message
9371
+ */
8585
9372
  message: MessageWithChannelResponse;
8586
9373
  pending_message_metadata?: Record<string, string>;
8587
9374
  }
@@ -8658,6 +9445,9 @@ export interface GetOrCreateCallRequest {
8658
9445
  */
8659
9446
  ring?: boolean;
8660
9447
  video?: boolean;
9448
+ /**
9449
+ * CallRequest is the payload for creating a call.
9450
+ */
8661
9451
  data?: CallRequest;
8662
9452
  }
8663
9453
  export interface GetOrCreateCallResponse {
@@ -8665,6 +9455,9 @@ export interface GetOrCreateCallResponse {
8665
9455
  duration: string;
8666
9456
  members: MemberResponse[];
8667
9457
  own_capabilities: OwnCapability[];
9458
+ /**
9459
+ * Represents a call
9460
+ */
8668
9461
  call: CallResponse;
8669
9462
  }
8670
9463
  export interface GetOrCreateFeedGroupRequest {
@@ -8709,14 +9502,23 @@ export interface GetOrCreateFeedRequest {
8709
9502
  view?: string;
8710
9503
  watch?: boolean;
8711
9504
  data?: FeedInput;
9505
+ /**
9506
+ * Options to skip specific enrichments to improve performance. Default is false (enrichments are included). Setting a field to true skips that enrichment.
9507
+ */
8712
9508
  enrichment_options?: EnrichmentOptions;
8713
9509
  external_ranking?: Record<string, any>;
8714
9510
  filter?: Record<string, any>;
8715
9511
  followers_pagination?: PagerRequest;
8716
9512
  following_pagination?: PagerRequest;
9513
+ /**
9514
+ * Options to control fetching reactions from friends (users you follow or have mutual follows with).
9515
+ */
8717
9516
  friend_reactions_options?: FriendReactionsOptions;
8718
9517
  interest_weights?: Record<string, number>;
8719
9518
  member_pagination?: PagerRequest;
9519
+ /**
9520
+ * User request object
9521
+ */
8720
9522
  user?: UserRequest;
8721
9523
  }
8722
9524
  export interface GetOrCreateFeedResponse {
@@ -8818,6 +9620,10 @@ export interface GetRateLimitsResponse {
8818
9620
  * Map of endpoint rate limits for the server-side platform
8819
9621
  */
8820
9622
  server_side?: Record<string, LimitInfoResponse>;
9623
+ /**
9624
+ * Map of endpoint rate limits for the Unity platform
9625
+ */
9626
+ unity?: Record<string, LimitInfoResponse>;
8821
9627
  /**
8822
9628
  * Map of endpoint rate limits for the web platform
8823
9629
  */
@@ -8930,6 +9736,9 @@ export interface GoLiveResponse {
8930
9736
  * Duration of the request in milliseconds
8931
9737
  */
8932
9738
  duration: string;
9739
+ /**
9740
+ * Represents a call
9741
+ */
8933
9742
  call: CallResponse;
8934
9743
  }
8935
9744
  export interface GoogleVisionConfig {
@@ -8968,6 +9777,9 @@ export interface GroupedQueryChannelsRequest {
8968
9777
  * Groups to return, keyed by group name. Each group can define limit, next, or prev. 'next' and 'prev' cursors are only allowed when the request contains exactly one group; multi-group pagination is rejected.
8969
9778
  */
8970
9779
  groups?: Record<string, GroupedChannelsGroupRequest>;
9780
+ /**
9781
+ * User request object
9782
+ */
8971
9783
  user?: UserRequest;
8972
9784
  }
8973
9785
  export interface GroupedQueryChannelsResponse {
@@ -9024,6 +9836,9 @@ export interface HideChannelRequest {
9024
9836
  */
9025
9837
  clear_history?: boolean;
9026
9838
  user_id?: string;
9839
+ /**
9840
+ * User request object
9841
+ */
9027
9842
  user?: UserRequest;
9028
9843
  }
9029
9844
  export interface HideChannelResponse {
@@ -9166,6 +9981,12 @@ export interface ImportV2TaskSettingsS3 {
9166
9981
  dir?: string;
9167
9982
  region?: string;
9168
9983
  }
9984
+ export interface Incident {
9985
+ from: string;
9986
+ peak_concurrency: number;
9987
+ to: string;
9988
+ viewers_interrupted: number;
9989
+ }
9169
9990
  export interface IndividualRecordSettings {
9170
9991
  mode: 'available' | 'disabled' | 'auto-on';
9171
9992
  output_types?: string[];
@@ -9389,6 +10210,13 @@ export interface JoinCallAPIMetrics {
9389
10210
  total: number;
9390
10211
  latency?: ActiveCallsLatencyStats;
9391
10212
  }
10213
+ export interface Joins {
10214
+ reason: string;
10215
+ disconnect_reasons: Record<string, number>;
10216
+ failure_stages: Record<string, number>;
10217
+ join_attempts?: number;
10218
+ join_success_rate?: number;
10219
+ }
9392
10220
  export interface KeyframeOCRRuleParameters {
9393
10221
  threshold?: number;
9394
10222
  time_window?: string;
@@ -9413,6 +10241,9 @@ export interface KickUserRequest {
9413
10241
  * Server-side: ID of the user performing the action
9414
10242
  */
9415
10243
  kicked_by_id?: string;
10244
+ /**
10245
+ * User request object
10246
+ */
9416
10247
  kicked_by?: UserRequest;
9417
10248
  }
9418
10249
  export interface KickUserResponse {
@@ -9424,11 +10255,17 @@ export interface KickUserResponse {
9424
10255
  export interface KickedUserEvent {
9425
10256
  call_cid: string;
9426
10257
  created_at: Date;
10258
+ /**
10259
+ * User response object
10260
+ */
9427
10261
  user: UserResponse;
9428
10262
  /**
9429
10263
  * The type of event: "call.kicked_user" in this case
9430
10264
  */
9431
10265
  type: string;
10266
+ /**
10267
+ * User response object
10268
+ */
9432
10269
  kicked_by_user?: UserResponse;
9433
10270
  }
9434
10271
  export interface LLMConfig {
@@ -9824,6 +10661,9 @@ export interface MarkActivityRequest {
9824
10661
  * List of activity IDs to mark as watched (for stories)
9825
10662
  */
9826
10663
  mark_watched?: string[];
10664
+ /**
10665
+ * User request object
10666
+ */
9827
10667
  user?: UserRequest;
9828
10668
  }
9829
10669
  export interface MarkChannelsReadRequest {
@@ -9832,6 +10672,9 @@ export interface MarkChannelsReadRequest {
9832
10672
  * Map of channel ID to last read message ID
9833
10673
  */
9834
10674
  read_by_channel?: Record<string, string>;
10675
+ /**
10676
+ * User request object
10677
+ */
9835
10678
  user?: UserRequest;
9836
10679
  }
9837
10680
  export interface MarkDeliveredRequest {
@@ -9853,6 +10696,9 @@ export interface MarkReadRequest {
9853
10696
  */
9854
10697
  thread_id?: string;
9855
10698
  user_id?: string;
10699
+ /**
10700
+ * User request object
10701
+ */
9856
10702
  user?: UserRequest;
9857
10703
  }
9858
10704
  export interface MarkReadResponse {
@@ -9871,6 +10717,9 @@ export interface MarkReadResponseEvent {
9871
10717
  channel_last_message_at?: Date;
9872
10718
  last_read_message_id?: string;
9873
10719
  team?: string;
10720
+ /**
10721
+ * Represents channel in chat
10722
+ */
9874
10723
  channel?: ChannelResponse;
9875
10724
  thread?: ThreadResponse;
9876
10725
  user?: UserResponseCommonFields;
@@ -9903,6 +10752,9 @@ export interface MarkUnreadRequest {
9903
10752
  */
9904
10753
  thread_id?: string;
9905
10754
  user_id?: string;
10755
+ /**
10756
+ * User request object
10757
+ */
9906
10758
  user?: UserRequest;
9907
10759
  }
9908
10760
  export interface MatchedContent {
@@ -9926,6 +10778,7 @@ export interface MatchedContent {
9926
10778
  * Text and OCR entries. Aggregate (max) Bodyguard severity level (`LOW` / `MEDIUM` / `HIGH` / `CRITICAL`). Absent on image-classification entries.
9927
10779
  */
9928
10780
  severity?: string;
10781
+ text?: string;
9929
10782
  /**
9930
10783
  * Image-classification entries (keyframe rule, Type=image) carry nested L1 → L2 classifications. Text entries (closed_caption rule, Type=text) carry flat label + severity. Resolved against the app's effective taxonomy on the image side.
9931
10784
  */
@@ -9946,6 +10799,9 @@ export interface MemberAddedEvent {
9946
10799
  * Date/time of creation
9947
10800
  */
9948
10801
  created_at: Date;
10802
+ /**
10803
+ * Represents channel in chat
10804
+ */
9949
10805
  channel: ChannelResponse;
9950
10806
  custom: Record<string, any>;
9951
10807
  member: ChannelMemberResponse;
@@ -9986,6 +10842,9 @@ export interface MemberRemovedEvent {
9986
10842
  * Date/time of creation
9987
10843
  */
9988
10844
  created_at: Date;
10845
+ /**
10846
+ * Represents channel in chat
10847
+ */
9989
10848
  channel: ChannelResponse;
9990
10849
  custom: Record<string, any>;
9991
10850
  member: ChannelMemberResponse;
@@ -10043,6 +10902,9 @@ export interface MemberResponse {
10043
10902
  * Custom member response data
10044
10903
  */
10045
10904
  custom: Record<string, any>;
10905
+ /**
10906
+ * User response object
10907
+ */
10046
10908
  user: UserResponse;
10047
10909
  /**
10048
10910
  * Date/time of deletion
@@ -10055,6 +10917,9 @@ export interface MemberUpdatedEvent {
10055
10917
  * Date/time of creation
10056
10918
  */
10057
10919
  created_at: Date;
10920
+ /**
10921
+ * Represents channel in chat
10922
+ */
10058
10923
  channel: ChannelResponse;
10059
10924
  custom: Record<string, any>;
10060
10925
  member: ChannelMemberResponse;
@@ -10140,6 +11005,9 @@ export interface MessageActionRequest {
10140
11005
  */
10141
11006
  form_data: Record<string, string>;
10142
11007
  user_id?: string;
11008
+ /**
11009
+ * User request object
11010
+ */
10143
11011
  user?: UserRequest;
10144
11012
  }
10145
11013
  export interface MessageActionResponse {
@@ -10147,6 +11015,9 @@ export interface MessageActionResponse {
10147
11015
  * Duration of the request in milliseconds
10148
11016
  */
10149
11017
  duration: string;
11018
+ /**
11019
+ * Represents any chat message
11020
+ */
10150
11021
  message?: MessageResponse;
10151
11022
  }
10152
11023
  export interface MessageChangeSet {
@@ -10171,6 +11042,9 @@ export interface MessageDeletedEvent {
10171
11042
  hard_delete: boolean;
10172
11043
  message_id: string;
10173
11044
  custom: Record<string, any>;
11045
+ /**
11046
+ * Represents any chat message
11047
+ */
10174
11048
  message: MessageResponse;
10175
11049
  /**
10176
11050
  * The type of event: "message.deleted" in this case
@@ -10218,10 +11092,22 @@ export interface MessageFlagResponse {
10218
11092
  reviewed_at?: Date;
10219
11093
  custom?: Record<string, any>;
10220
11094
  details?: FlagDetailsResponse;
11095
+ /**
11096
+ * Represents any chat message
11097
+ */
10221
11098
  message?: MessageResponse;
10222
11099
  moderation_feedback?: FlagFeedbackResponse;
11100
+ /**
11101
+ * Result of the message moderation
11102
+ */
10223
11103
  moderation_result?: MessageModerationResult;
11104
+ /**
11105
+ * User response object
11106
+ */
10224
11107
  reviewed_by?: UserResponse;
11108
+ /**
11109
+ * User response object
11110
+ */
10225
11111
  user?: UserResponse;
10226
11112
  }
10227
11113
  export interface MessageFlaggedEvent {
@@ -10230,6 +11116,9 @@ export interface MessageFlaggedEvent {
10230
11116
  */
10231
11117
  created_at: Date;
10232
11118
  message_id: string;
11119
+ /**
11120
+ * Represents any chat message
11121
+ */
10233
11122
  message: MessageResponse;
10234
11123
  /**
10235
11124
  * The type of event: "message.flagged" in this case
@@ -10273,6 +11162,9 @@ export interface MessageFlaggedEvent {
10273
11162
  * Custom data
10274
11163
  */
10275
11164
  custom?: Record<string, any>;
11165
+ /**
11166
+ * Result of the message moderation
11167
+ */
10276
11168
  details?: MessageModerationResult;
10277
11169
  flag?: FlagResponse;
10278
11170
  user?: UserResponseCommonFields;
@@ -10324,6 +11216,9 @@ export interface MessageModerationResult {
10324
11216
  */
10325
11217
  moderated_by?: string;
10326
11218
  ai_moderation_response?: ModerationResponse;
11219
+ /**
11220
+ * Sets thresholds for AI moderation
11221
+ */
10327
11222
  moderation_thresholds?: Thresholds;
10328
11223
  }
10329
11224
  export interface MessageNewEvent {
@@ -10337,6 +11232,9 @@ export interface MessageNewEvent {
10337
11232
  */
10338
11233
  watcher_count: number;
10339
11234
  custom: Record<string, any>;
11235
+ /**
11236
+ * Represents any chat message
11237
+ */
10340
11238
  message: MessageResponse;
10341
11239
  /**
10342
11240
  * The type of event: "message.new" in this case
@@ -10381,6 +11279,9 @@ export interface MessageNewEvent {
10381
11279
  * The participants of the thread
10382
11280
  */
10383
11281
  thread_participants?: UserResponseCommonFields[];
11282
+ /**
11283
+ * Represents channel in chat
11284
+ */
10384
11285
  channel?: ChannelResponse;
10385
11286
  channel_custom?: Record<string, any>;
10386
11287
  grouped_unread_channels?: Record<string, number>;
@@ -10388,6 +11289,7 @@ export interface MessageNewEvent {
10388
11289
  }
10389
11290
  export interface MessageOptions {
10390
11291
  include_thread_participants?: boolean;
11292
+ member_custom_include?: string[];
10391
11293
  }
10392
11294
  export interface MessagePaginationParams {
10393
11295
  /**
@@ -10474,6 +11376,9 @@ export interface MessageReadEvent {
10474
11376
  * The team ID
10475
11377
  */
10476
11378
  team?: string;
11379
+ /**
11380
+ * Represents channel in chat
11381
+ */
10477
11382
  channel?: ChannelResponse;
10478
11383
  channel_custom?: Record<string, any>;
10479
11384
  thread?: ThreadResponse;
@@ -10530,7 +11435,7 @@ export interface MessageRequest {
10530
11435
  /**
10531
11436
  * Contains type of the message. One of: regular, system
10532
11437
  */
10533
- type?: "''" | 'regular' | 'system';
11438
+ type?: 'regular' | 'system';
10534
11439
  user_id?: string;
10535
11440
  /**
10536
11441
  * Array of message attachments
@@ -10551,6 +11456,9 @@ export interface MessageRequest {
10551
11456
  restricted_visibility?: string[];
10552
11457
  custom?: Record<string, any>;
10553
11458
  shared_location?: SharedLocation;
11459
+ /**
11460
+ * User request object
11461
+ */
10554
11462
  user?: UserRequest;
10555
11463
  }
10556
11464
  export interface MessageResponse {
@@ -10636,6 +11544,9 @@ export interface MessageResponse {
10636
11544
  * An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)
10637
11545
  */
10638
11546
  reaction_scores: Record<string, number>;
11547
+ /**
11548
+ * User response object
11549
+ */
10639
11550
  user: UserResponse;
10640
11551
  /**
10641
11552
  * Contains provided slash command
@@ -10699,8 +11610,14 @@ export interface MessageResponse {
10699
11610
  image_labels?: Record<string, string[]>;
10700
11611
  member?: ChannelMemberPartialResponse;
10701
11612
  moderation?: ModerationV2Response;
11613
+ /**
11614
+ * User response object
11615
+ */
10702
11616
  pinned_by?: UserResponse;
10703
11617
  poll?: PollResponseData;
11618
+ /**
11619
+ * Represents any chat message
11620
+ */
10704
11621
  quoted_message?: MessageResponse;
10705
11622
  reaction_groups?: Record<string, ReactionGroupResponse>;
10706
11623
  reminder?: ReminderResponseData;
@@ -10716,6 +11633,9 @@ export interface MessageUnblockedEvent {
10716
11633
  created_at: Date;
10717
11634
  message_id: string;
10718
11635
  custom: Record<string, any>;
11636
+ /**
11637
+ * Represents any chat message
11638
+ */
10719
11639
  message: MessageResponse;
10720
11640
  /**
10721
11641
  * The type of event: "message.unblocked" in this case
@@ -10735,6 +11655,9 @@ export interface MessageUndeletedEvent {
10735
11655
  created_at: Date;
10736
11656
  message_id: string;
10737
11657
  custom: Record<string, any>;
11658
+ /**
11659
+ * Represents any chat message
11660
+ */
10738
11661
  message: MessageResponse;
10739
11662
  /**
10740
11663
  * The type of event: "message.undeleted" in this case
@@ -10778,6 +11701,9 @@ export interface MessageUpdatedEvent {
10778
11701
  created_at: Date;
10779
11702
  message_id: string;
10780
11703
  custom: Record<string, any>;
11704
+ /**
11705
+ * Represents any chat message
11706
+ */
10781
11707
  message: MessageResponse;
10782
11708
  /**
10783
11709
  * The type of event: "message.updated" in this case
@@ -10886,6 +11812,9 @@ export interface MessageWithChannelResponse {
10886
11812
  * A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list
10887
11813
  */
10888
11814
  restricted_visibility: string[];
11815
+ /**
11816
+ * Represents channel in chat
11817
+ */
10889
11818
  channel: ChannelResponse;
10890
11819
  custom: Record<string, any>;
10891
11820
  /**
@@ -10896,6 +11825,9 @@ export interface MessageWithChannelResponse {
10896
11825
  * An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)
10897
11826
  */
10898
11827
  reaction_scores: Record<string, number>;
11828
+ /**
11829
+ * User response object
11830
+ */
10899
11831
  user: UserResponse;
10900
11832
  /**
10901
11833
  * Contains provided slash command
@@ -10959,8 +11891,14 @@ export interface MessageWithChannelResponse {
10959
11891
  image_labels?: Record<string, string[]>;
10960
11892
  member?: ChannelMemberPartialResponse;
10961
11893
  moderation?: ModerationV2Response;
11894
+ /**
11895
+ * User response object
11896
+ */
10962
11897
  pinned_by?: UserResponse;
10963
11898
  poll?: PollResponseData;
11899
+ /**
11900
+ * Represents any chat message
11901
+ */
10964
11902
  quoted_message?: MessageResponse;
10965
11903
  reaction_groups?: Record<string, ReactionGroupResponse>;
10966
11904
  reminder?: ReminderResponseData;
@@ -10991,6 +11929,13 @@ export interface MetricThreshold {
10991
11929
  export interface MetricTimeSeries {
10992
11930
  data_points?: number[][];
10993
11931
  }
11932
+ export interface MetricsPct {
11933
+ freezes?: number;
11934
+ geo?: number;
11935
+ jitter?: number;
11936
+ latency?: number;
11937
+ quality_score?: number;
11938
+ }
10994
11939
  export interface ModerationActionConfigResponse {
10995
11940
  /**
10996
11941
  * The action to take
@@ -11022,6 +11967,35 @@ export interface ModerationActionConfigResponse {
11022
11967
  */
11023
11968
  custom?: Record<string, any>;
11024
11969
  }
11970
+ export interface ModerationAnalysisFailedEvent {
11971
+ created_at: Date;
11972
+ type: string;
11973
+ /**
11974
+ * The moderation policy key the request targeted.
11975
+ */
11976
+ config_key?: string;
11977
+ /**
11978
+ * Echo of the `entity_creator_id` on the /analyze request.
11979
+ */
11980
+ entity_creator_id?: string;
11981
+ /**
11982
+ * Echo of the `entity_id` on the /analyze request.
11983
+ */
11984
+ entity_id?: string;
11985
+ /**
11986
+ * Echo of the `entity_type` on the /analyze request.
11987
+ */
11988
+ entity_type?: string;
11989
+ received_at?: Date;
11990
+ /**
11991
+ * Echo of the request's `content_ids`, keyed by text/image label. On keyframe and caption streams every request repeats the same entity_type/entity_id/entity_creator_id, so this is what identifies the specific submission that went unscreened.
11992
+ */
11993
+ content_ids?: Record<string, string>;
11994
+ /**
11995
+ * Echo of the `custom` metadata on the /analyze request.
11996
+ */
11997
+ custom?: Record<string, any>;
11998
+ }
11025
11999
  export interface ModerationBanResponse {
11026
12000
  duration: string;
11027
12001
  }
@@ -11045,6 +12019,9 @@ export interface ModerationCallResponse {
11045
12019
  routing_number?: string;
11046
12020
  starts_at?: Date;
11047
12021
  team?: string;
12022
+ /**
12023
+ * User response object
12024
+ */
11048
12025
  created_by?: UserResponse;
11049
12026
  }
11050
12027
  export interface ModerationCheckCompletedEvent {
@@ -11104,6 +12081,9 @@ export interface ModerationCustomActionEvent {
11104
12081
  * Additional options passed to the custom action
11105
12082
  */
11106
12083
  action_options?: Record<string, any>;
12084
+ /**
12085
+ * Represents any chat message
12086
+ */
11107
12087
  message?: MessageResponse;
11108
12088
  }
11109
12089
  export interface ModerationDashboardPreferences {
@@ -11135,8 +12115,14 @@ export interface ModerationFlagResponse {
11135
12115
  review_queue_item_id?: string;
11136
12116
  labels?: string[];
11137
12117
  custom?: Record<string, any>;
12118
+ /**
12119
+ * Content payload for moderation
12120
+ */
11138
12121
  moderation_payload?: ModerationPayloadResponse;
11139
12122
  review_queue_item?: ReviewQueueItemResponse;
12123
+ /**
12124
+ * User response object
12125
+ */
11140
12126
  user?: UserResponse;
11141
12127
  }
11142
12128
  export interface ModerationFlaggedEvent {
@@ -11196,6 +12182,9 @@ export interface ModerationMarkReviewedEvent {
11196
12182
  item: ReviewQueueItemResponse;
11197
12183
  type: string;
11198
12184
  received_at?: Date;
12185
+ /**
12186
+ * Represents any chat message
12187
+ */
11199
12188
  message?: MessageResponse;
11200
12189
  }
11201
12190
  export interface ModerationPayload {
@@ -11398,6 +12387,9 @@ export interface MuteChannelRequest {
11398
12387
  * Channel CIDs to mute (if multiple channels)
11399
12388
  */
11400
12389
  channel_cids?: string[];
12390
+ /**
12391
+ * User request object
12392
+ */
11401
12393
  user?: UserRequest;
11402
12394
  }
11403
12395
  export interface MuteChannelResponse {
@@ -11419,6 +12411,9 @@ export interface MuteRequest {
11419
12411
  */
11420
12412
  timeout?: number;
11421
12413
  user_id?: string;
12414
+ /**
12415
+ * User request object
12416
+ */
11422
12417
  user?: UserRequest;
11423
12418
  }
11424
12419
  export interface MuteResponse {
@@ -11441,6 +12436,9 @@ export interface MuteUsersRequest {
11441
12436
  screenshare_audio?: boolean;
11442
12437
  video?: boolean;
11443
12438
  user_ids?: string[];
12439
+ /**
12440
+ * User request object
12441
+ */
11444
12442
  muted_by?: UserRequest;
11445
12443
  }
11446
12444
  export interface MuteUsersResponse {
@@ -11577,6 +12575,9 @@ export interface NotificationMarkUnreadEvent {
11577
12575
  * The number of unread threads
11578
12576
  */
11579
12577
  unread_threads?: number;
12578
+ /**
12579
+ * Represents channel in chat
12580
+ */
11580
12581
  channel?: ChannelResponse;
11581
12582
  channel_custom?: Record<string, any>;
11582
12583
  grouped_unread_channels?: Record<string, number>;
@@ -11685,8 +12686,14 @@ export interface NotificationThreadMessageNewEvent {
11685
12686
  * The number of watchers
11686
12687
  */
11687
12688
  watcher_count: number;
12689
+ /**
12690
+ * Represents channel in chat
12691
+ */
11688
12692
  channel: ChannelResponse;
11689
12693
  custom: Record<string, any>;
12694
+ /**
12695
+ * Represents any chat message
12696
+ */
11690
12697
  message: MessageResponse;
11691
12698
  /**
11692
12699
  * The type of event: "notification.message_new" in this case
@@ -11761,6 +12768,9 @@ export interface OwnBatchRequest {
11761
12768
  * Optional list of specific fields to return. If not specified, all fields (own_follows, own_followings, own_capabilities, own_membership) are returned
11762
12769
  */
11763
12770
  fields?: string[];
12771
+ /**
12772
+ * User request object
12773
+ */
11764
12774
  user?: UserRequest;
11765
12775
  }
11766
12776
  export interface OwnBatchResponse {
@@ -11948,24 +12958,46 @@ export interface PendingMessageEvent {
11948
12958
  */
11949
12959
  type: string;
11950
12960
  received_at?: Date;
12961
+ /**
12962
+ * Represents channel in chat
12963
+ */
11951
12964
  channel?: ChannelResponse;
12965
+ /**
12966
+ * Represents any chat message
12967
+ */
11952
12968
  message?: MessageResponse;
11953
12969
  /**
11954
12970
  * Metadata attached to the pending message
11955
12971
  */
11956
12972
  metadata?: Record<string, string>;
12973
+ /**
12974
+ * User response object
12975
+ */
11957
12976
  user?: UserResponse;
11958
12977
  }
11959
12978
  export interface PendingMessageResponse {
12979
+ /**
12980
+ * Represents channel in chat
12981
+ */
11960
12982
  channel?: ChannelResponse;
12983
+ /**
12984
+ * Represents any chat message
12985
+ */
11961
12986
  message?: MessageResponse;
11962
12987
  metadata?: Record<string, string>;
12988
+ /**
12989
+ * User response object
12990
+ */
11963
12991
  user?: UserResponse;
11964
12992
  }
11965
12993
  export interface PerSDKUsageReport {
11966
12994
  total: number;
11967
12995
  by_version: Record<string, number>;
11968
12996
  }
12997
+ export interface Percentiles {
12998
+ p50?: number;
12999
+ p95?: number;
13000
+ }
11969
13001
  export interface Permission {
11970
13002
  /**
11971
13003
  * Action name this permission is for (e.g. SendMessage)
@@ -12019,6 +13051,9 @@ export interface PermissionRequestEvent {
12019
13051
  * The list of permissions requested by the user
12020
13052
  */
12021
13053
  permissions: string[];
13054
+ /**
13055
+ * User response object
13056
+ */
12022
13057
  user: UserResponse;
12023
13058
  /**
12024
13059
  * The type of event: "call.permission_request" in this case
@@ -12031,6 +13066,9 @@ export interface PinActivityRequest {
12031
13066
  */
12032
13067
  enrich_own_fields?: boolean;
12033
13068
  user_id?: string;
13069
+ /**
13070
+ * User request object
13071
+ */
12034
13072
  user?: UserRequest;
12035
13073
  }
12036
13074
  export interface PinActivityResponse {
@@ -12106,6 +13144,111 @@ export interface PolicyRequest {
12106
13144
  */
12107
13145
  roles: string[];
12108
13146
  }
13147
+ export interface PolicyTestLabelDrift {
13148
+ changed: number;
13149
+ same: number;
13150
+ }
13151
+ export interface PolicyTestResult {
13152
+ created_at: Date;
13153
+ id: number;
13154
+ message_text: string;
13155
+ row_index: number;
13156
+ run_id: string;
13157
+ scored: boolean;
13158
+ actual_action?: string;
13159
+ expected_action?: string;
13160
+ failure_reason?: string;
13161
+ passed?: boolean;
13162
+ severity?: string;
13163
+ actual_labels?: string[];
13164
+ expected_labels?: string[];
13165
+ raw_response?: Record<string, any>;
13166
+ }
13167
+ export interface PolicyTestRow {
13168
+ content_type?: string;
13169
+ policy?: string;
13170
+ recommended_action?: string;
13171
+ text?: string;
13172
+ labels?: string[];
13173
+ }
13174
+ export interface PolicyTestRun {
13175
+ config_key: string;
13176
+ created_at: Date;
13177
+ id: string;
13178
+ rows_completed: number;
13179
+ rows_total: number;
13180
+ set_id: string;
13181
+ status: string;
13182
+ task_id: string;
13183
+ triggered_by: string;
13184
+ completed_at?: Date;
13185
+ config_updated_at?: Date;
13186
+ error_message?: string;
13187
+ started_at?: Date;
13188
+ metrics?: PolicyTestRunMetrics;
13189
+ }
13190
+ export interface PolicyTestRunMetrics {
13191
+ mode: string;
13192
+ totals: PolicyTestTotals;
13193
+ by_label?: Record<string, PolicyTestLabelDrift>;
13194
+ }
13195
+ export interface PolicyTestRunResponse {
13196
+ duration: string;
13197
+ /**
13198
+ * Per-row results (only present once the run has finished)
13199
+ */
13200
+ results?: PolicyTestResult[];
13201
+ run?: PolicyTestRun;
13202
+ }
13203
+ export interface PolicyTestSeedSpec {
13204
+ /**
13205
+ * How many rows to sample, newest first; capped at 1000
13206
+ */
13207
+ limit: number;
13208
+ /**
13209
+ * Sample only records carrying any of these labels; empty samples everything
13210
+ */
13211
+ labels?: string[];
13212
+ }
13213
+ export interface PolicyTestSet {
13214
+ config_key: string;
13215
+ created_at: Date;
13216
+ created_by: string;
13217
+ id: string;
13218
+ mode: string;
13219
+ name: string;
13220
+ row_count: number;
13221
+ updated_at: Date;
13222
+ team?: string;
13223
+ rows?: PolicyTestRow[];
13224
+ last_run?: PolicyTestRun;
13225
+ }
13226
+ export interface PolicyTestSetListResponse {
13227
+ duration: string;
13228
+ /**
13229
+ * List of policy test sets for the app
13230
+ */
13231
+ sets: PolicyTestSet[];
13232
+ }
13233
+ export interface PolicyTestSetResponse {
13234
+ duration: string;
13235
+ /**
13236
+ * The set's baseline run (earliest completed run); later runs are scored against it. Absent until the first run completes
13237
+ */
13238
+ baseline_run_id?: string;
13239
+ /**
13240
+ * Retained run history for this set, newest first
13241
+ */
13242
+ recent_runs?: PolicyTestRun[];
13243
+ set?: PolicyTestSet;
13244
+ }
13245
+ export interface PolicyTestTotals {
13246
+ failed: number;
13247
+ passed: number;
13248
+ rows: number;
13249
+ scored: number;
13250
+ unscored: number;
13251
+ }
12109
13252
  export interface PollOptionInput {
12110
13253
  text?: string;
12111
13254
  custom?: Record<string, any>;
@@ -12155,6 +13298,9 @@ export interface PollResponseData {
12155
13298
  vote_counts_by_option: Record<string, number>;
12156
13299
  is_closed?: boolean;
12157
13300
  max_votes_allowed?: number;
13301
+ /**
13302
+ * User response object
13303
+ */
12158
13304
  created_by?: UserResponse;
12159
13305
  }
12160
13306
  export interface PollVoteResponse {
@@ -12174,6 +13320,9 @@ export interface PollVoteResponseData {
12174
13320
  answer_text?: string;
12175
13321
  is_answer?: boolean;
12176
13322
  user_id?: string;
13323
+ /**
13324
+ * User response object
13325
+ */
12177
13326
  user?: UserResponse;
12178
13327
  }
12179
13328
  export interface PollVotesResponse {
@@ -12188,6 +13337,21 @@ export interface PollVotesResponse {
12188
13337
  next?: string;
12189
13338
  prev?: string;
12190
13339
  }
13340
+ export interface PoorByCause {
13341
+ delivery: number;
13342
+ edge: number;
13343
+ isolated_local: number;
13344
+ source: number;
13345
+ unattributed: number;
13346
+ }
13347
+ export interface PoorTail {
13348
+ healthy_viewers: number;
13349
+ note: string;
13350
+ poor_total: number;
13351
+ poor_by_cause: PoorByCause;
13352
+ supporting: Supporting;
13353
+ healthy_pct?: number;
13354
+ }
12191
13355
  export interface PrivacySettingsResponse {
12192
13356
  delivery_receipts?: DeliveryReceiptsResponse;
12193
13357
  read_receipts?: ReadReceiptsResponse;
@@ -12216,6 +13380,20 @@ export interface PublisherAllMetrics {
12216
13380
  export interface PublisherAudioMetrics {
12217
13381
  jitter_ms?: ActiveCallsLatencyStats;
12218
13382
  }
13383
+ export interface PublisherSession {
13384
+ duration_min: number;
13385
+ started_offset_min: number;
13386
+ user_id: string;
13387
+ user_session_id: string;
13388
+ avg_jitter_ms?: number;
13389
+ browser?: string;
13390
+ delivery_zone?: string;
13391
+ ingest?: string;
13392
+ os?: string;
13393
+ send_quality_score?: number;
13394
+ tool?: string;
13395
+ encoding?: EncodingProfile;
13396
+ }
12219
13397
  export interface PublisherStatsResponse {
12220
13398
  total: number;
12221
13399
  unique: number;
@@ -12417,6 +13595,17 @@ export interface PushTemplateResponse {
12417
13595
  */
12418
13596
  template?: string;
12419
13597
  }
13598
+ export interface Quality {
13599
+ viewer_interruption_note: string;
13600
+ interruption_incidents: Incident[];
13601
+ connection_avg_jitter_ms: Percentiles;
13602
+ connection_avg_latency_ms: Percentiles;
13603
+ score_bands_by_connection_pct: ScoreBands;
13604
+ score_bands_by_watch_time_pct: ScoreBands;
13605
+ p50_quality_score?: number;
13606
+ p5_quality_score?: number;
13607
+ viewer_interruption_rate_pct?: number;
13608
+ }
12420
13609
  export interface QualityScoreReport {
12421
13610
  histogram: ReportByHistogramBucket[];
12422
13611
  }
@@ -12446,6 +13635,9 @@ export interface QueryActivitiesRequest {
12446
13635
  * Filters to apply to the query. Supports location-based queries with 'near' and 'within_bounds' operators.
12447
13636
  */
12448
13637
  filter?: Record<string, any>;
13638
+ /**
13639
+ * User request object
13640
+ */
12449
13641
  user?: UserRequest;
12450
13642
  }
12451
13643
  export interface QueryActivitiesResponse {
@@ -12468,6 +13660,9 @@ export interface QueryActivityReactionsRequest {
12468
13660
  next?: string;
12469
13661
  prev?: string;
12470
13662
  sort?: SortParamRequest[];
13663
+ /**
13664
+ * Filters to apply to the query
13665
+ */
12471
13666
  filter?: Record<string, any>;
12472
13667
  }
12473
13668
  export interface QueryActivityReactionsResponse {
@@ -12519,6 +13714,9 @@ export interface QueryAppealsRequest {
12519
13714
  * Filter conditions for appeals
12520
13715
  */
12521
13716
  filter?: Record<string, any>;
13717
+ /**
13718
+ * User request object
13719
+ */
12522
13720
  user?: UserRequest;
12523
13721
  }
12524
13722
  export interface QueryAppealsResponse {
@@ -12552,6 +13750,9 @@ export interface QueryBannedUsersPayload {
12552
13750
  * Array of sort parameters
12553
13751
  */
12554
13752
  sort?: SortParamRequest[];
13753
+ /**
13754
+ * User request object
13755
+ */
12555
13756
  user?: UserRequest;
12556
13757
  }
12557
13758
  export interface QueryBannedUsersResponse {
@@ -12606,6 +13807,9 @@ export interface QueryBookmarksRequest {
12606
13807
  * Filters to apply to the query
12607
13808
  */
12608
13809
  filter?: Record<string, any>;
13810
+ /**
13811
+ * User request object
13812
+ */
12609
13813
  user?: UserRequest;
12610
13814
  }
12611
13815
  export interface QueryBookmarksResponse {
@@ -12677,6 +13881,9 @@ export interface QueryCallParticipantsResponse {
12677
13881
  * List of call participants
12678
13882
  */
12679
13883
  participants: CallParticipantResponse[];
13884
+ /**
13885
+ * Represents a call
13886
+ */
12680
13887
  call: CallResponse;
12681
13888
  }
12682
13889
  export interface QueryCallSessionParticipantStatsResponse {
@@ -12799,6 +14006,9 @@ export interface QueryCampaignsRequest {
12799
14006
  prev?: string;
12800
14007
  user_limit?: number;
12801
14008
  sort?: SortParamRequest[];
14009
+ /**
14010
+ * Filter to apply to the query
14011
+ */
12802
14012
  filter?: Record<string, any>;
12803
14013
  }
12804
14014
  export interface QueryCampaignsResponse {
@@ -12836,6 +14046,10 @@ export interface QueryChannelsRequest {
12836
14046
  */
12837
14047
  state?: boolean;
12838
14048
  user_id?: string;
14049
+ /**
14050
+ * Top-level keys of the message sender's channel-member custom data to include under member.custom (max 8 keys, 64 chars each)
14051
+ */
14052
+ member_custom_include?: string[];
12839
14053
  /**
12840
14054
  * List of sort parameters
12841
14055
  */
@@ -12849,6 +14063,9 @@ export interface QueryChannelsRequest {
12849
14063
  */
12850
14064
  filter_values?: Record<string, any>;
12851
14065
  sort_values?: Record<string, any>;
14066
+ /**
14067
+ * User request object
14068
+ */
12852
14069
  user?: UserRequest;
12853
14070
  }
12854
14071
  export interface QueryChannelsResponse {
@@ -12875,6 +14092,9 @@ export interface QueryCollectionsRequest {
12875
14092
  * Filters to apply to the query
12876
14093
  */
12877
14094
  filter?: Record<string, any>;
14095
+ /**
14096
+ * User request object
14097
+ */
12878
14098
  user?: UserRequest;
12879
14099
  }
12880
14100
  export interface QueryCollectionsResponse {
@@ -12897,6 +14117,9 @@ export interface QueryCommentReactionsRequest {
12897
14117
  next?: string;
12898
14118
  prev?: string;
12899
14119
  sort?: SortParamRequest[];
14120
+ /**
14121
+ * Filters to apply to the query
14122
+ */
12900
14123
  filter?: Record<string, any>;
12901
14124
  }
12902
14125
  export interface QueryCommentReactionsResponse {
@@ -12928,6 +14151,9 @@ export interface QueryCommentsRequest {
12928
14151
  */
12929
14152
  sort?: 'first' | 'last' | 'top' | 'best' | 'controversial';
12930
14153
  user_id?: string;
14154
+ /**
14155
+ * User request object
14156
+ */
12931
14157
  user?: UserRequest;
12932
14158
  }
12933
14159
  export interface QueryCommentsResponse {
@@ -12958,6 +14184,9 @@ export interface QueryDraftsRequest {
12958
14184
  * Filter to apply to the query
12959
14185
  */
12960
14186
  filter?: Record<string, any>;
14187
+ /**
14188
+ * User request object
14189
+ */
12961
14190
  user?: UserRequest;
12962
14191
  }
12963
14192
  export interface QueryDraftsResponse {
@@ -13013,6 +14242,9 @@ export interface QueryFeedModerationTemplate {
13013
14242
  * When the template was last updated
13014
14243
  */
13015
14244
  updated_at: Date;
14245
+ /**
14246
+ * Configuration for a feeds moderation template
14247
+ */
13016
14248
  config?: FeedsModerationTemplateConfigPayload;
13017
14249
  }
13018
14250
  export interface QueryFeedModerationTemplatesResponse {
@@ -13106,6 +14338,10 @@ export interface QueryFutureChannelBansPayload {
13106
14338
  * Whether to exclude expired bans or not
13107
14339
  */
13108
14340
  exclude_expired_bans?: boolean;
14341
+ /**
14342
+ * When true, the response includes the total number of bans matching the query filter (independent of limit and offset, capped at 100000)
14343
+ */
14344
+ include_total?: boolean;
13109
14345
  /**
13110
14346
  * Number of records to return
13111
14347
  */
@@ -13115,10 +14351,13 @@ export interface QueryFutureChannelBansPayload {
13115
14351
  */
13116
14352
  offset?: number;
13117
14353
  /**
13118
- * Filter by the target user ID. For server-side requests only.
14354
+ * Filter by the target user ID. Server-side: returns all bans against this user. Client-side: narrows the authenticated user's own bans to this target.
13119
14355
  */
13120
14356
  target_user_id?: string;
13121
14357
  user_id?: string;
14358
+ /**
14359
+ * User request object
14360
+ */
13122
14361
  user?: UserRequest;
13123
14362
  }
13124
14363
  export interface QueryFutureChannelBansResponse {
@@ -13130,6 +14369,10 @@ export interface QueryFutureChannelBansResponse {
13130
14369
  * List of found future channel bans
13131
14370
  */
13132
14371
  bans: FutureChannelBanResponse[];
14372
+ /**
14373
+ * Total number of bans matching the query filter, computed at query time and capped at 100000. Only present when include_total is set on the request; omitted when computing the total timed out
14374
+ */
14375
+ total?: number;
13133
14376
  }
13134
14377
  export interface QueryLabelResultsRequest {
13135
14378
  limit?: number;
@@ -13144,6 +14387,9 @@ export interface QueryLabelResultsRequest {
13144
14387
  * Filter conditions
13145
14388
  */
13146
14389
  filter?: Record<string, any>;
14390
+ /**
14391
+ * User request object
14392
+ */
13147
14393
  user?: UserRequest;
13148
14394
  }
13149
14395
  export interface QueryLabelResultsResponse {
@@ -13170,6 +14416,9 @@ export interface QueryMembersPayload {
13170
14416
  * Array of sort parameters
13171
14417
  */
13172
14418
  sort?: SortParamRequest[];
14419
+ /**
14420
+ * User request object
14421
+ */
13173
14422
  user?: UserRequest;
13174
14423
  }
13175
14424
  export interface QueryMembershipLevelsRequest {
@@ -13213,6 +14462,9 @@ export interface QueryMessageFlagsPayload {
13213
14462
  * Filter conditions to apply to the query
13214
14463
  */
13215
14464
  filter_conditions?: Record<string, any>;
14465
+ /**
14466
+ * User request object
14467
+ */
13216
14468
  user?: UserRequest;
13217
14469
  }
13218
14470
  export interface QueryMessageFlagsResponse {
@@ -13263,6 +14515,9 @@ export interface QueryModerationConfigsRequest {
13263
14515
  * Filter conditions for moderation configs
13264
14516
  */
13265
14517
  filter?: Record<string, any>;
14518
+ /**
14519
+ * User request object
14520
+ */
13266
14521
  user?: UserRequest;
13267
14522
  }
13268
14523
  export interface QueryModerationConfigsResponse {
@@ -13279,6 +14534,9 @@ export interface QueryModerationFlagsRequest {
13279
14534
  next?: string;
13280
14535
  prev?: string;
13281
14536
  sort?: SortParamRequest[];
14537
+ /**
14538
+ * Filter conditions for moderation flags
14539
+ */
13282
14540
  filter?: Record<string, any>;
13283
14541
  }
13284
14542
  export interface QueryModerationFlagsResponse {
@@ -13303,6 +14561,9 @@ export interface QueryModerationLogsRequest {
13303
14561
  * Filter conditions for moderation logs
13304
14562
  */
13305
14563
  filter?: Record<string, any>;
14564
+ /**
14565
+ * User request object
14566
+ */
13306
14567
  user?: UserRequest;
13307
14568
  }
13308
14569
  export interface QueryModerationLogsResponse {
@@ -13327,6 +14588,9 @@ export interface QueryModerationRulesRequest {
13327
14588
  * Filter conditions for moderation rules
13328
14589
  */
13329
14590
  filter?: Record<string, any>;
14591
+ /**
14592
+ * User request object
14593
+ */
13330
14594
  user?: UserRequest;
13331
14595
  }
13332
14596
  export interface QueryModerationRulesResponse {
@@ -13450,6 +14714,9 @@ export interface QueryReactionsRequest {
13450
14714
  * Filter to apply to the query
13451
14715
  */
13452
14716
  filter?: Record<string, any>;
14717
+ /**
14718
+ * User request object
14719
+ */
13453
14720
  user?: UserRequest;
13454
14721
  }
13455
14722
  export interface QueryReactionsResponse {
@@ -13474,6 +14741,9 @@ export interface QueryRemindersRequest {
13474
14741
  * Filter to apply to the query
13475
14742
  */
13476
14743
  filter?: Record<string, any>;
14744
+ /**
14745
+ * User request object
14746
+ */
13477
14747
  user?: UserRequest;
13478
14748
  }
13479
14749
  export interface QueryRemindersResponse {
@@ -13518,6 +14788,9 @@ export interface QueryReviewQueueRequest {
13518
14788
  * Filter conditions for review queue items. Accepts built-in fields (e.g. status, channel_cid, severity, recommended_action) and customer-supplied moderation_payload.custom keys: any key that is not a built-in field is matched against the item's custom moderation data (e.g. {"location_id": "loc-42"}). Use filter_config.filterable_custom_keys to discover which custom keys the app exposes as chips.
13519
14789
  */
13520
14790
  filter?: Record<string, any>;
14791
+ /**
14792
+ * User request object
14793
+ */
13521
14794
  user?: UserRequest;
13522
14795
  }
13523
14796
  export interface QueryReviewQueueResponse {
@@ -13675,6 +14948,9 @@ export interface QueryThreadsRequest {
13675
14948
  * Filter to apply to the query
13676
14949
  */
13677
14950
  filter?: Record<string, any>;
14951
+ /**
14952
+ * User request object
14953
+ */
13678
14954
  user?: UserRequest;
13679
14955
  }
13680
14956
  export interface QueryThreadsResponse {
@@ -13725,6 +15001,9 @@ export interface QueryUsersPayload {
13725
15001
  * Array of sort parameters
13726
15002
  */
13727
15003
  sort?: SortParamRequest[];
15004
+ /**
15005
+ * User request object
15006
+ */
13728
15007
  user?: UserRequest;
13729
15008
  }
13730
15009
  export interface QueryUsersResponse {
@@ -13856,6 +15135,9 @@ export interface ReactionDeletedEvent {
13856
15135
  * Date/time of creation
13857
15136
  */
13858
15137
  created_at: Date;
15138
+ /**
15139
+ * Represents channel in chat
15140
+ */
13859
15141
  channel: ChannelResponse;
13860
15142
  custom: Record<string, any>;
13861
15143
  /**
@@ -13893,6 +15175,9 @@ export interface ReactionDeletedEvent {
13893
15175
  */
13894
15176
  thread_participants?: UserResponseCommonFields[];
13895
15177
  channel_custom?: Record<string, any>;
15178
+ /**
15179
+ * Represents any chat message
15180
+ */
13896
15181
  message?: MessageResponse;
13897
15182
  reaction?: ReactionResponse;
13898
15183
  user?: UserResponseCommonFields;
@@ -13928,6 +15213,9 @@ export interface ReactionGroupUserResponse {
13928
15213
  * The ID of the user who reacted.
13929
15214
  */
13930
15215
  user_id: string;
15216
+ /**
15217
+ * User response object
15218
+ */
13931
15219
  user?: UserResponse;
13932
15220
  }
13933
15221
  export interface ReactionNewEvent {
@@ -13935,6 +15223,9 @@ export interface ReactionNewEvent {
13935
15223
  * Date/time of creation
13936
15224
  */
13937
15225
  created_at: Date;
15226
+ /**
15227
+ * Represents channel in chat
15228
+ */
13938
15229
  channel: ChannelResponse;
13939
15230
  custom: Record<string, any>;
13940
15231
  /**
@@ -13972,7 +15263,10 @@ export interface ReactionNewEvent {
13972
15263
  */
13973
15264
  thread_participants?: UserResponseCommonFields[];
13974
15265
  channel_custom?: Record<string, any>;
13975
- message?: MessageResponse;
15266
+ /**
15267
+ * Represents any chat message
15268
+ */
15269
+ message?: MessageResponse;
13976
15270
  reaction?: ReactionResponse;
13977
15271
  user?: UserResponseCommonFields;
13978
15272
  }
@@ -13995,6 +15289,9 @@ export interface ReactionRequest {
13995
15289
  updated_at?: Date;
13996
15290
  user_id?: string;
13997
15291
  custom?: Record<string, any>;
15292
+ /**
15293
+ * User request object
15294
+ */
13998
15295
  user?: UserRequest;
13999
15296
  }
14000
15297
  export interface ReactionResponse {
@@ -14026,6 +15323,9 @@ export interface ReactionResponse {
14026
15323
  * Custom data for this object
14027
15324
  */
14028
15325
  custom: Record<string, any>;
15326
+ /**
15327
+ * User response object
15328
+ */
14029
15329
  user: UserResponse;
14030
15330
  }
14031
15331
  export interface ReactionUpdatedEvent {
@@ -14034,8 +15334,14 @@ export interface ReactionUpdatedEvent {
14034
15334
  */
14035
15335
  created_at: Date;
14036
15336
  message_id: string;
15337
+ /**
15338
+ * Represents channel in chat
15339
+ */
14037
15340
  channel: ChannelResponse;
14038
15341
  custom: Record<string, any>;
15342
+ /**
15343
+ * Represents any chat message
15344
+ */
14039
15345
  message: MessageResponse;
14040
15346
  /**
14041
15347
  * The type of event: "reaction.updated" in this case
@@ -14089,6 +15395,9 @@ export interface ReactivateUserResponse {
14089
15395
  * Duration of the request in milliseconds
14090
15396
  */
14091
15397
  duration: string;
15398
+ /**
15399
+ * User response object
15400
+ */
14092
15401
  user?: UserResponse;
14093
15402
  }
14094
15403
  export interface ReactivateUsersRequest {
@@ -14126,6 +15435,9 @@ export interface ReadReceiptsResponse {
14126
15435
  export interface ReadStateResponse {
14127
15436
  last_read: Date;
14128
15437
  unread_messages: number;
15438
+ /**
15439
+ * User response object
15440
+ */
14129
15441
  user: UserResponse;
14130
15442
  last_delivered_at?: Date;
14131
15443
  last_delivered_message_id?: string;
@@ -14166,6 +15478,9 @@ export interface RejectAppealRequestPayload {
14166
15478
  }
14167
15479
  export interface RejectFeedMemberInviteRequest {
14168
15480
  user_id?: string;
15481
+ /**
15482
+ * User request object
15483
+ */
14169
15484
  user?: UserRequest;
14170
15485
  }
14171
15486
  export interface RejectFeedMemberInviteResponse {
@@ -14277,8 +15592,17 @@ export interface ReminderResponseData {
14277
15592
  updated_at: Date;
14278
15593
  user_id: string;
14279
15594
  remind_at?: Date;
15595
+ /**
15596
+ * Represents channel in chat
15597
+ */
14280
15598
  channel?: ChannelResponse;
15599
+ /**
15600
+ * Represents any chat message
15601
+ */
14281
15602
  message?: MessageResponse;
15603
+ /**
15604
+ * User response object
15605
+ */
14282
15606
  user?: UserResponse;
14283
15607
  }
14284
15608
  export interface ReminderUpdatedEvent {
@@ -14421,6 +15745,9 @@ export interface ResolveSipInboundRequest {
14421
15745
  * Optional pre-authenticated trunk ID (from PreAuth no-auth flow)
14422
15746
  */
14423
15747
  trunk_id?: string;
15748
+ /**
15749
+ * SIP digest challenge authentication data
15750
+ */
14424
15751
  challenge?: SIPChallengeRequest;
14425
15752
  /**
14426
15753
  * Optional SIP headers as key-value pairs
@@ -14429,8 +15756,17 @@ export interface ResolveSipInboundRequest {
14429
15756
  }
14430
15757
  export interface ResolveSipInboundResponse {
14431
15758
  duration: string;
15759
+ /**
15760
+ * Credentials for SIP inbound call authentication
15761
+ */
14432
15762
  credentials: SipInboundCredentials;
15763
+ /**
15764
+ * SIP Inbound Routing Rule response
15765
+ */
14433
15766
  sip_routing_rule?: SIPInboundRoutingRuleResponse;
15767
+ /**
15768
+ * SIP trunk information
15769
+ */
14434
15770
  sip_trunk?: SIPTrunkResponse;
14435
15771
  }
14436
15772
  export interface Response {
@@ -14447,6 +15783,9 @@ export interface RestoreActionRequestPayload {
14447
15783
  }
14448
15784
  export interface RestoreActivityRequest {
14449
15785
  user_id?: string;
15786
+ /**
15787
+ * User request object
15788
+ */
14450
15789
  user?: UserRequest;
14451
15790
  }
14452
15791
  export interface RestoreActivityResponse {
@@ -14455,6 +15794,9 @@ export interface RestoreActivityResponse {
14455
15794
  }
14456
15795
  export interface RestoreCommentRequest {
14457
15796
  user_id?: string;
15797
+ /**
15798
+ * User request object
15799
+ */
14458
15800
  user?: UserRequest;
14459
15801
  }
14460
15802
  export interface RestoreCommentResponse {
@@ -14585,6 +15927,9 @@ export interface ReviewQueueItemResponse {
14585
15927
  teams?: string[];
14586
15928
  activity?: EnrichedActivity;
14587
15929
  appeal?: AppealItemResponse;
15930
+ /**
15931
+ * User response object
15932
+ */
14588
15933
  assigned_to?: UserResponse;
14589
15934
  call?: ModerationCallResponse;
14590
15935
  entity_creator?: EntityCreatorResponse;
@@ -14594,6 +15939,9 @@ export interface ReviewQueueItemResponse {
14594
15939
  feeds_v3_activity?: FeedsV3ActivityResponse;
14595
15940
  feeds_v3_comment?: FeedsV3CommentResponse;
14596
15941
  message?: ChatMessageResponse;
15942
+ /**
15943
+ * Content payload for moderation
15944
+ */
14597
15945
  moderation_payload?: ModerationPayloadResponse;
14598
15946
  reaction?: Reaction;
14599
15947
  }
@@ -14771,7 +16119,13 @@ export interface SDKUsageReportResponse {
14771
16119
  export interface SFULocationResponse {
14772
16120
  datacenter: string;
14773
16121
  id: string;
16122
+ /**
16123
+ * Geographic coordinates
16124
+ */
14774
16125
  coordinates: CoordinatesResponse;
16126
+ /**
16127
+ * Geographic location metadata
16128
+ */
14775
16129
  location: LocationResponse;
14776
16130
  count?: number;
14777
16131
  }
@@ -14946,6 +16300,9 @@ export interface SIPInboundRoutingRuleRequest {
14946
16300
  * List of SIP trunk IDs
14947
16301
  */
14948
16302
  trunk_ids: string[];
16303
+ /**
16304
+ * Configuration for SIP caller settings
16305
+ */
14949
16306
  caller_configs: SIPCallerConfigsRequest;
14950
16307
  /**
14951
16308
  * List of called numbers
@@ -14955,9 +16312,21 @@ export interface SIPInboundRoutingRuleRequest {
14955
16312
  * List of caller numbers (optional)
14956
16313
  */
14957
16314
  caller_numbers?: string[];
16315
+ /**
16316
+ * Configuration for SIP call settings
16317
+ */
14958
16318
  call_configs?: SIPCallConfigsRequest;
16319
+ /**
16320
+ * Configuration for direct routing rule calls
16321
+ */
14959
16322
  direct_routing_configs?: SIPDirectRoutingRuleCallConfigsRequest;
16323
+ /**
16324
+ * Configuration for PIN protection settings
16325
+ */
14960
16326
  pin_protection_configs?: SIPPinProtectionConfigsRequest;
16327
+ /**
16328
+ * Configuration for PIN routing rule calls
16329
+ */
14961
16330
  pin_routing_configs?: SIPInboundRoutingRulePinConfigsRequest;
14962
16331
  }
14963
16332
  export interface SIPInboundRoutingRuleResponse {
@@ -14990,10 +16359,25 @@ export interface SIPInboundRoutingRuleResponse {
14990
16359
  * List of caller numbers
14991
16360
  */
14992
16361
  caller_numbers?: string[];
16362
+ /**
16363
+ * SIP call configuration response
16364
+ */
14993
16365
  call_configs?: SIPCallConfigsResponse;
16366
+ /**
16367
+ * SIP caller configuration response
16368
+ */
14994
16369
  caller_configs?: SIPCallerConfigsResponse;
16370
+ /**
16371
+ * Direct routing rule call configuration response
16372
+ */
14995
16373
  direct_routing_configs?: SIPDirectRoutingRuleCallConfigsResponse;
16374
+ /**
16375
+ * PIN protection configuration response
16376
+ */
14996
16377
  pin_protection_configs?: SIPPinProtectionConfigsResponse;
16378
+ /**
16379
+ * PIN routing rule call configuration response
16380
+ */
14997
16381
  pin_routing_configs?: SIPInboundRoutingRulePinConfigsResponse;
14998
16382
  }
14999
16383
  export interface SIPPinProtectionConfigsRequest {
@@ -15073,6 +16457,11 @@ export interface SIPTrunkResponse {
15073
16457
  export interface SRTIngress {
15074
16458
  address: string;
15075
16459
  }
16460
+ export interface ScoreBands {
16461
+ good?: number;
16462
+ ok?: number;
16463
+ poor?: number;
16464
+ }
15076
16465
  export interface ScreensharingSettings {
15077
16466
  access_request_enabled: boolean;
15078
16467
  enabled: boolean;
@@ -15166,6 +16555,9 @@ export interface SearchResultMessage {
15166
16555
  custom: Record<string, any>;
15167
16556
  reaction_counts: Record<string, number>;
15168
16557
  reaction_scores: Record<string, number>;
16558
+ /**
16559
+ * User response object
16560
+ */
15169
16561
  user: UserResponse;
15170
16562
  command?: string;
15171
16563
  deleted_at?: Date;
@@ -15182,14 +16574,23 @@ export interface SearchResultMessage {
15182
16574
  mentioned_groups?: UserGroupResponse[];
15183
16575
  mentioned_roles?: string[];
15184
16576
  thread_participants?: UserResponse[];
16577
+ /**
16578
+ * Represents channel in chat
16579
+ */
15185
16580
  channel?: ChannelResponse;
15186
16581
  draft?: DraftResponse;
15187
16582
  i18n?: Record<string, string>;
15188
16583
  image_labels?: Record<string, string[]>;
15189
16584
  member?: ChannelMemberPartialResponse;
15190
16585
  moderation?: ModerationV2Response;
16586
+ /**
16587
+ * User response object
16588
+ */
15191
16589
  pinned_by?: UserResponse;
15192
16590
  poll?: PollResponseData;
16591
+ /**
16592
+ * Represents any chat message
16593
+ */
15193
16594
  quoted_message?: MessageResponse;
15194
16595
  reaction_groups?: Record<string, ReactionGroupResponse>;
15195
16596
  reminder?: ReminderResponseData;
@@ -15260,9 +16661,20 @@ export interface SegmentTargetResponse {
15260
16661
  segment_id: string;
15261
16662
  target_id: string;
15262
16663
  }
16664
+ export interface Segments {
16665
+ by_country_reason: string;
16666
+ by_browser: BroadcastSegment[];
16667
+ by_country: BroadcastSegment[];
16668
+ by_delivery_zone: DeliveryZoneSegment[];
16669
+ by_os: BroadcastSegment[];
16670
+ by_sdk: BroadcastSegment[];
16671
+ }
15263
16672
  export interface SendCallEventRequest {
15264
16673
  user_id?: string;
15265
16674
  custom?: Record<string, any>;
16675
+ /**
16676
+ * User request object
16677
+ */
15266
16678
  user?: UserRequest;
15267
16679
  }
15268
16680
  export interface SendCallEventResponse {
@@ -15280,6 +16692,9 @@ export interface SendClosedCaptionRequest {
15280
16692
  start_time?: Date;
15281
16693
  translated?: boolean;
15282
16694
  user_id?: string;
16695
+ /**
16696
+ * User request object
16697
+ */
15283
16698
  user?: UserRequest;
15284
16699
  }
15285
16700
  export interface SendClosedCaptionResponse {
@@ -15289,8 +16704,19 @@ export interface SendEventRequest {
15289
16704
  event: EventRequest;
15290
16705
  }
15291
16706
  export interface SendMessageRequest {
16707
+ /**
16708
+ * Message data for creating or updating a message
16709
+ */
15292
16710
  message: MessageRequest;
15293
16711
  force_moderation?: boolean;
16712
+ /**
16713
+ * When true, the response includes channel_context: a slim channel object with cid, type, id and created_by
16714
+ */
16715
+ include_channel_context?: boolean;
16716
+ /**
16717
+ * When true, the response includes mentioned_members: for each mentioned user, whether that user is currently a channel member. Requires the ReadChannelMembers permission
16718
+ */
16719
+ include_mentioned_members?: boolean;
15294
16720
  keep_channel_hidden?: boolean;
15295
16721
  pending?: boolean;
15296
16722
  skip_enrich_url?: boolean;
@@ -15302,13 +16728,27 @@ export interface SendMessageResponse {
15302
16728
  * Duration of the request in milliseconds
15303
16729
  */
15304
16730
  duration: string;
16731
+ /**
16732
+ * Represents any chat message
16733
+ */
15305
16734
  message: MessageResponse;
16735
+ /**
16736
+ * Slim channel object: identity plus creator
16737
+ */
16738
+ channel_context?: ChannelContextResponse;
16739
+ /**
16740
+ * Map of mentioned user ID to whether that user is currently an active channel member. Only set when include_mentioned_members was requested; omitted when the message has no mentions or the membership lookup failed
16741
+ */
16742
+ mentioned_members?: Record<string, boolean>;
15306
16743
  /**
15307
16744
  * Pending message metadata
15308
16745
  */
15309
16746
  pending_message_metadata?: Record<string, string>;
15310
16747
  }
15311
16748
  export interface SendReactionRequest {
16749
+ /**
16750
+ * Represents user reaction to a message
16751
+ */
15312
16752
  reaction: ReactionRequest;
15313
16753
  /**
15314
16754
  * Whether to replace all existing user reactions
@@ -15324,6 +16764,9 @@ export interface SendReactionResponse {
15324
16764
  * Duration of the request in milliseconds
15325
16765
  */
15326
16766
  duration: string;
16767
+ /**
16768
+ * Represents any chat message
16769
+ */
15327
16770
  message: MessageResponse;
15328
16771
  reaction: ReactionResponse;
15329
16772
  }
@@ -15385,6 +16828,9 @@ export interface ShareResponse {
15385
16828
  * When the share occurred
15386
16829
  */
15387
16830
  created_at: Date;
16831
+ /**
16832
+ * User response object
16833
+ */
15388
16834
  user: UserResponse;
15389
16835
  }
15390
16836
  export interface SharedLocation {
@@ -15431,7 +16877,13 @@ export interface SharedLocationResponse {
15431
16877
  * Time when the live location expires
15432
16878
  */
15433
16879
  end_at?: Date;
16880
+ /**
16881
+ * Represents channel in chat
16882
+ */
15434
16883
  channel?: ChannelResponse;
16884
+ /**
16885
+ * Represents any chat message
16886
+ */
15435
16887
  message?: MessageResponse;
15436
16888
  }
15437
16889
  export interface SharedLocationResponseData {
@@ -15444,7 +16896,13 @@ export interface SharedLocationResponseData {
15444
16896
  updated_at: Date;
15445
16897
  user_id: string;
15446
16898
  end_at?: Date;
16899
+ /**
16900
+ * Represents channel in chat
16901
+ */
15447
16902
  channel?: ChannelResponse;
16903
+ /**
16904
+ * Represents any chat message
16905
+ */
15448
16906
  message?: MessageResponse;
15449
16907
  }
15450
16908
  export interface SharedLocationsResponse {
@@ -15453,6 +16911,9 @@ export interface SharedLocationsResponse {
15453
16911
  }
15454
16912
  export interface ShowChannelRequest {
15455
16913
  user_id?: string;
16914
+ /**
16915
+ * User request object
16916
+ */
15456
16917
  user?: UserRequest;
15457
16918
  }
15458
16919
  export interface ShowChannelResponse {
@@ -15513,6 +16974,18 @@ export interface SortParamRequest {
15513
16974
  */
15514
16975
  type?: string;
15515
16976
  }
16977
+ export interface SourceHealth {
16978
+ co_host_peak: number;
16979
+ dead_air_s: number;
16980
+ interruptions: SourceInterruption[];
16981
+ publisher_sessions: PublisherSession[];
16982
+ }
16983
+ export interface SourceInterruption {
16984
+ at_offset_min: number;
16985
+ dead_air_s: number;
16986
+ kind: string;
16987
+ seamless?: boolean;
16988
+ }
15516
16989
  export interface SpeechSegmentConfig {
15517
16990
  max_speech_caption_ms?: number;
15518
16991
  silence_duration_ms?: number;
@@ -15565,6 +17038,8 @@ export interface StartHLSBroadcastingResponse {
15565
17038
  */
15566
17039
  playlist_url: string;
15567
17040
  }
17041
+ export interface StartPolicyTestRunRequest {
17042
+ }
15568
17043
  export interface StartRTMPBroadcastsRequest {
15569
17044
  /**
15570
17045
  * List of broadcasts to start
@@ -15653,6 +17128,9 @@ export interface StopLiveRequest {
15653
17128
  }
15654
17129
  export interface StopLiveResponse {
15655
17130
  duration: string;
17131
+ /**
17132
+ * Represents a call
17133
+ */
15656
17134
  call: CallResponse;
15657
17135
  }
15658
17136
  export interface StopRTMPBroadcastsRequest {
@@ -15718,9 +17196,9 @@ export interface StoriesFeedUpdatedEvent {
15718
17196
  }
15719
17197
  export interface SubmitActionRequest {
15720
17198
  /**
15721
- * Type of moderation action to perform. One of: mark_reviewed, delete_message, delete_activity, delete_comment, delete_reaction, ban, custom, unban, restore, delete_user, unblock, block, shadow_block, unmask, kick_user, end_call, escalate, de_escalate
17199
+ * Type of moderation action to perform. One of: mark_reviewed, delete_message, delete_activity, delete_comment, delete_reaction, ban, custom, unban, restore, delete_user, delete_user_messages, unblock, block, shadow_block, unmask, kick_user, end_call, escalate, de_escalate
15722
17200
  */
15723
- action_type: 'flag' | 'mark_reviewed' | 'delete_message' | 'delete_activity' | 'delete_comment' | 'delete_reaction' | 'ban' | 'custom' | 'unban' | 'restore' | 'delete_user' | 'unblock' | 'block' | 'shadow_block' | 'unmask' | 'kick_user' | 'end_call' | 'reject_appeal' | 'escalate' | 'de_escalate' | 'bypass';
17201
+ action_type: 'flag' | 'mark_reviewed' | 'delete_message' | 'delete_activity' | 'delete_comment' | 'delete_reaction' | 'ban' | 'custom' | 'unban' | 'restore' | 'delete_user' | 'delete_user_messages' | 'unblock' | 'block' | 'shadow_block' | 'unmask' | 'kick_user' | 'end_call' | 'reject_appeal' | 'escalate' | 'de_escalate' | 'bypass';
15724
17202
  /**
15725
17203
  * UUID of the appeal to act on (required for reject_appeal, optional for other actions)
15726
17204
  */
@@ -15730,23 +17208,75 @@ export interface SubmitActionRequest {
15730
17208
  */
15731
17209
  item_id?: string;
15732
17210
  user_id?: string;
17211
+ /**
17212
+ * Configuration for ban moderation action
17213
+ */
15733
17214
  ban?: BanActionRequestPayload;
17215
+ /**
17216
+ * Configuration for block action
17217
+ */
15734
17218
  block?: BlockActionRequestPayload;
15735
17219
  bypass?: BypassActionRequest;
17220
+ /**
17221
+ * Configuration for custom moderation action
17222
+ */
15736
17223
  custom?: CustomActionRequestPayload;
17224
+ /**
17225
+ * Configuration for activity deletion action
17226
+ */
15737
17227
  delete_activity?: DeleteActivityRequestPayload;
17228
+ /**
17229
+ * Configuration for comment deletion action
17230
+ */
15738
17231
  delete_comment?: DeleteCommentRequestPayload;
17232
+ /**
17233
+ * Configuration for message deletion action
17234
+ */
15739
17235
  delete_message?: DeleteMessageRequestPayload;
17236
+ /**
17237
+ * Configuration for reaction deletion action
17238
+ */
15740
17239
  delete_reaction?: DeleteReactionRequestPayload;
17240
+ /**
17241
+ * Configuration for user deletion action
17242
+ */
15741
17243
  delete_user?: DeleteUserRequestPayload;
17244
+ /**
17245
+ * Configuration for deleting all of a user's chat messages without banning them or deleting their account
17246
+ */
17247
+ delete_user_messages?: DeleteUserMessagesRequestPayload;
17248
+ /**
17249
+ * Configuration for escalation action
17250
+ */
15742
17251
  escalate?: EscalatePayload;
15743
17252
  flag?: FlagRequest;
17253
+ /**
17254
+ * Configuration for mark reviewed action
17255
+ */
15744
17256
  mark_reviewed?: MarkReviewedRequestPayload;
17257
+ /**
17258
+ * Configuration for rejecting an appeal
17259
+ */
15745
17260
  reject_appeal?: RejectAppealRequestPayload;
17261
+ /**
17262
+ * Configuration for restore action
17263
+ */
15746
17264
  restore?: RestoreActionRequestPayload;
17265
+ /**
17266
+ * Configuration for shadow block action
17267
+ */
15747
17268
  shadow_block?: ShadowBlockActionRequestPayload;
17269
+ /**
17270
+ * Configuration for unban moderation action
17271
+ */
15748
17272
  unban?: UnbanActionRequestPayload;
17273
+ /**
17274
+ * Configuration for unblock action
17275
+ */
15749
17276
  unblock?: UnblockActionRequestPayload;
17277
+ /**
17278
+ * User request object
17279
+ */
15750
17280
  user?: UserRequest;
15751
17281
  }
15752
17282
  export interface SubmitActionResponse {
@@ -15822,6 +17352,11 @@ export interface SubscriberVideoMetrics {
15822
17352
  export interface SubscribersMetrics {
15823
17353
  all?: SubscriberAllMetrics;
15824
17354
  }
17355
+ export interface Supporting {
17356
+ delivery_incident_windows: Incident[];
17357
+ edge_outlier_zones: string[];
17358
+ source_drop_windows: TimeWindow[];
17359
+ }
15825
17360
  export interface TargetResolution {
15826
17361
  height: number;
15827
17362
  width: number;
@@ -15832,21 +17367,69 @@ export interface TeamUsageStats {
15832
17367
  * Team identifier (empty string for users not assigned to any team)
15833
17368
  */
15834
17369
  team: string;
17370
+ /**
17371
+ * Statistics for a single metric with optional daily breakdown
17372
+ */
15835
17373
  concurrent_connections: MetricStats;
17374
+ /**
17375
+ * Statistics for a single metric with optional daily breakdown
17376
+ */
15836
17377
  concurrent_users: MetricStats;
17378
+ /**
17379
+ * Statistics for a single metric with optional daily breakdown
17380
+ */
15837
17381
  image_moderations_daily: MetricStats;
17382
+ /**
17383
+ * Statistics for a single metric with optional daily breakdown
17384
+ */
15838
17385
  messages_daily: MetricStats;
17386
+ /**
17387
+ * Statistics for a single metric with optional daily breakdown
17388
+ */
15839
17389
  messages_last_24_hours: MetricStats;
17390
+ /**
17391
+ * Statistics for a single metric with optional daily breakdown
17392
+ */
15840
17393
  messages_last_30_days: MetricStats;
17394
+ /**
17395
+ * Statistics for a single metric with optional daily breakdown
17396
+ */
15841
17397
  messages_month_to_date: MetricStats;
17398
+ /**
17399
+ * Statistics for a single metric with optional daily breakdown
17400
+ */
15842
17401
  messages_total: MetricStats;
17402
+ /**
17403
+ * Statistics for a single metric with optional daily breakdown
17404
+ */
15843
17405
  translations_daily: MetricStats;
17406
+ /**
17407
+ * Statistics for a single metric with optional daily breakdown
17408
+ */
15844
17409
  users_daily: MetricStats;
17410
+ /**
17411
+ * Statistics for a single metric with optional daily breakdown
17412
+ */
15845
17413
  users_engaged_last_30_days: MetricStats;
17414
+ /**
17415
+ * Statistics for a single metric with optional daily breakdown
17416
+ */
15846
17417
  users_engaged_month_to_date: MetricStats;
17418
+ /**
17419
+ * Statistics for a single metric with optional daily breakdown
17420
+ */
15847
17421
  users_last_24_hours: MetricStats;
17422
+ /**
17423
+ * Statistics for a single metric with optional daily breakdown
17424
+ */
15848
17425
  users_last_30_days: MetricStats;
17426
+ /**
17427
+ * Statistics for a single metric with optional daily breakdown
17428
+ */
15849
17429
  users_month_to_date: MetricStats;
17430
+ /**
17431
+ * Statistics for a single metric with optional daily breakdown
17432
+ */
15850
17433
  users_total: MetricStats;
15851
17434
  }
15852
17435
  export interface TextContentParameters {
@@ -15871,7 +17454,6 @@ export interface TextRuleParameters {
15871
17454
  llm_harm_labels?: Record<string, string>;
15872
17455
  }
15873
17456
  export interface ThreadParticipant {
15874
- app_pk: number;
15875
17457
  channel_cid: string;
15876
17458
  /**
15877
17459
  * Date/time of creation
@@ -15892,6 +17474,9 @@ export interface ThreadParticipant {
15892
17474
  * User ID is unique string identifier of the user
15893
17475
  */
15894
17476
  user_id?: string;
17477
+ /**
17478
+ * User response object
17479
+ */
15895
17480
  user?: UserResponse;
15896
17481
  }
15897
17482
  export interface ThreadResponse {
@@ -15919,6 +17504,10 @@ export interface ThreadResponse {
15919
17504
  * Participant Count
15920
17505
  */
15921
17506
  participant_count: number;
17507
+ /**
17508
+ * Reply Count
17509
+ */
17510
+ reply_count: number;
15922
17511
  /**
15923
17512
  * Title
15924
17513
  */
@@ -15939,16 +17528,21 @@ export interface ThreadResponse {
15939
17528
  * Last Message At
15940
17529
  */
15941
17530
  last_message_at?: Date;
15942
- /**
15943
- * Reply Count
15944
- */
15945
- reply_count?: number;
15946
17531
  /**
15947
17532
  * Thread Participants
15948
17533
  */
15949
17534
  thread_participants?: ThreadParticipant[];
17535
+ /**
17536
+ * Represents channel in chat
17537
+ */
15950
17538
  channel?: ChannelResponse;
17539
+ /**
17540
+ * User response object
17541
+ */
15951
17542
  created_by?: UserResponse;
17543
+ /**
17544
+ * Represents any chat message
17545
+ */
15952
17546
  parent_message?: MessageResponse;
15953
17547
  }
15954
17548
  export interface ThreadStateResponse {
@@ -15976,6 +17570,10 @@ export interface ThreadStateResponse {
15976
17570
  * Participant Count
15977
17571
  */
15978
17572
  participant_count: number;
17573
+ /**
17574
+ * Reply Count
17575
+ */
17576
+ reply_count: number;
15979
17577
  /**
15980
17578
  * Title
15981
17579
  */
@@ -15997,18 +17595,23 @@ export interface ThreadStateResponse {
15997
17595
  * Last Message At
15998
17596
  */
15999
17597
  last_message_at?: Date;
16000
- /**
16001
- * Reply Count
16002
- */
16003
- reply_count?: number;
16004
17598
  read?: ReadStateResponse[];
16005
17599
  /**
16006
17600
  * Thread Participants
16007
17601
  */
16008
17602
  thread_participants?: ThreadParticipant[];
17603
+ /**
17604
+ * Represents channel in chat
17605
+ */
16009
17606
  channel?: ChannelResponse;
17607
+ /**
17608
+ * User response object
17609
+ */
16010
17610
  created_by?: UserResponse;
16011
17611
  draft?: DraftResponse;
17612
+ /**
17613
+ * Represents any chat message
17614
+ */
16012
17615
  parent_message?: MessageResponse;
16013
17616
  }
16014
17617
  export interface ThreadUpdatedEvent {
@@ -16040,6 +17643,9 @@ export interface ThreadedCommentResponse {
16040
17643
  upvote_count: number;
16041
17644
  mentioned_users: UserResponse[];
16042
17645
  own_reactions: FeedsReactionResponse[];
17646
+ /**
17647
+ * User response object
17648
+ */
16043
17649
  user: UserResponse;
16044
17650
  controversy_score?: number;
16045
17651
  deleted_at?: Date;
@@ -16054,6 +17660,9 @@ export interface ThreadedCommentResponse {
16054
17660
  replies?: ThreadedCommentResponse[];
16055
17661
  custom?: Record<string, any>;
16056
17662
  i18n?: Record<string, string>;
17663
+ /**
17664
+ * Cursor & depth information for a comment's direct replies. Mirrors Reddit's 'load more replies' semantics.
17665
+ */
16057
17666
  meta?: RepliesMeta;
16058
17667
  moderation?: ModerationV2Response;
16059
17668
  reaction_groups?: Record<string, FeedsReactionGroupResponse>;
@@ -16077,6 +17686,16 @@ export interface ThumbnailsSettingsResponse {
16077
17686
  }
16078
17687
  export interface Time {
16079
17688
  }
17689
+ export interface TimeWindow {
17690
+ from: string;
17691
+ to: string;
17692
+ }
17693
+ export interface TopBroadcast {
17694
+ call_cid: string;
17695
+ hours_watched: number;
17696
+ peak_concurrent_viewers: number;
17697
+ poor_pct?: number;
17698
+ }
16080
17699
  export interface TrackActivityMetricsEvent {
16081
17700
  /**
16082
17701
  * The ID of the activity to track the metric for
@@ -16115,6 +17734,9 @@ export interface TrackActivityMetricsRequest {
16115
17734
  */
16116
17735
  events: TrackActivityMetricsEvent[];
16117
17736
  user_id?: string;
17737
+ /**
17738
+ * User request object
17739
+ */
16118
17740
  user?: UserRequest;
16119
17741
  }
16120
17742
  export interface TrackActivityMetricsResponse {
@@ -16232,7 +17854,13 @@ export interface TruncateChannelRequest {
16232
17854
  * List of member IDs to hide message history for. If empty, truncates the channel for all members
16233
17855
  */
16234
17856
  member_ids?: string[];
17857
+ /**
17858
+ * Message data for creating or updating a message
17859
+ */
16235
17860
  message?: MessageRequest;
17861
+ /**
17862
+ * User request object
17863
+ */
16236
17864
  user?: UserRequest;
16237
17865
  }
16238
17866
  export interface TruncateChannelResponse {
@@ -16240,7 +17868,13 @@ export interface TruncateChannelResponse {
16240
17868
  * Duration of the request in milliseconds
16241
17869
  */
16242
17870
  duration: string;
17871
+ /**
17872
+ * Represents channel in chat
17873
+ */
16243
17874
  channel?: ChannelResponse;
17875
+ /**
17876
+ * Represents any chat message
17877
+ */
16244
17878
  message?: MessageResponse;
16245
17879
  }
16246
17880
  export interface TypingIndicatorsResponse {
@@ -16259,12 +17893,19 @@ export interface UnbanActionRequestPayload {
16259
17893
  * Also remove the future channels ban for this user
16260
17894
  */
16261
17895
  remove_future_channels_ban?: boolean;
17896
+ /**
17897
+ * Optional: unban user directly without review item
17898
+ */
17899
+ target_user_id?: string;
16262
17900
  }
16263
17901
  export interface UnbanRequest {
16264
17902
  /**
16265
17903
  * ID of the user performing the unban
16266
17904
  */
16267
17905
  unbanned_by_id?: string;
17906
+ /**
17907
+ * User request object
17908
+ */
16268
17909
  unbanned_by?: UserRequest;
16269
17910
  }
16270
17911
  export interface UnbanResponse {
@@ -16291,6 +17932,9 @@ export interface UnblockUserResponse {
16291
17932
  export interface UnblockUsersRequest {
16292
17933
  blocked_user_id: string;
16293
17934
  user_id?: string;
17935
+ /**
17936
+ * User request object
17937
+ */
16294
17938
  user?: UserRequest;
16295
17939
  }
16296
17940
  export interface UnblockUsersResponse {
@@ -16302,6 +17946,9 @@ export interface UnblockUsersResponse {
16302
17946
  export interface UnblockedUserEvent {
16303
17947
  call_cid: string;
16304
17948
  created_at: Date;
17949
+ /**
17950
+ * User response object
17951
+ */
16305
17952
  user: UserResponse;
16306
17953
  /**
16307
17954
  * The type of event: "call.unblocked_user" in this case
@@ -16319,6 +17966,9 @@ export interface UndeleteMessageResponse {
16319
17966
  * Duration of the request in milliseconds
16320
17967
  */
16321
17968
  duration: string;
17969
+ /**
17970
+ * Represents any chat message
17971
+ */
16322
17972
  message: MessageResponse;
16323
17973
  }
16324
17974
  export interface UnfollowBatchRequest {
@@ -16370,6 +18020,9 @@ export interface UnmuteChannelRequest {
16370
18020
  * Channel CIDs to mute (if multiple channels)
16371
18021
  */
16372
18022
  channel_cids?: string[];
18023
+ /**
18024
+ * User request object
18025
+ */
16373
18026
  user?: UserRequest;
16374
18027
  }
16375
18028
  export interface UnmuteRequest {
@@ -16378,6 +18031,9 @@ export interface UnmuteRequest {
16378
18031
  */
16379
18032
  target_ids: string[];
16380
18033
  user_id?: string;
18034
+ /**
18035
+ * User request object
18036
+ */
16381
18037
  user?: UserRequest;
16382
18038
  }
16383
18039
  export interface UnmuteResponse {
@@ -16520,6 +18176,9 @@ export interface UpdateActivityPartialRequest {
16520
18176
  * Map of field names to new values. Supported fields: 'text', 'attachments', 'custom', 'visibility', 'visibility_tag', 'restrict_replies' (values: 'everyone', 'people_i_follow', 'nobody'), 'location', 'expires_at', 'filter_tags', 'interest_tags', 'poll_id', 'feeds', 'mentioned_user_ids', 'search_data'. For custom fields, use dot-notation (e.g., 'custom.field_name')
16521
18177
  */
16522
18178
  set?: Record<string, any>;
18179
+ /**
18180
+ * User request object
18181
+ */
16523
18182
  user?: UserRequest;
16524
18183
  }
16525
18184
  export interface UpdateActivityPartialResponse {
@@ -16610,6 +18269,9 @@ export interface UpdateActivityRequest {
16610
18269
  * Additional data for search indexing
16611
18270
  */
16612
18271
  search_data?: Record<string, any>;
18272
+ /**
18273
+ * User request object
18274
+ */
16613
18275
  user?: UserRequest;
16614
18276
  }
16615
18277
  export interface UpdateActivityResponse {
@@ -16635,6 +18297,7 @@ export interface UpdateAppRequest {
16635
18297
  guest_user_creation_disabled?: boolean;
16636
18298
  image_moderation_enabled?: boolean;
16637
18299
  max_aggregated_activities_length?: number;
18300
+ member_custom_on_messages_enabled?: boolean;
16638
18301
  migrate_permissions_to_v2?: boolean;
16639
18302
  moderation_analytics_enabled?: boolean;
16640
18303
  moderation_enabled?: boolean;
@@ -16681,16 +18344,24 @@ export interface UpdateBlockListRequest {
16681
18344
  is_plural_check_enabled?: boolean;
16682
18345
  is_substring_matching_enabled?: boolean;
16683
18346
  team?: string;
18347
+ user_id?: string;
16684
18348
  /**
16685
18349
  * List of words to block
16686
18350
  */
16687
18351
  words?: string[];
18352
+ /**
18353
+ * User request object
18354
+ */
18355
+ user?: UserRequest;
16688
18356
  }
16689
18357
  export interface UpdateBlockListResponse {
16690
18358
  /**
16691
18359
  * Duration of the request in milliseconds
16692
18360
  */
16693
18361
  duration: string;
18362
+ /**
18363
+ * Block list contains restricted words
18364
+ */
16694
18365
  blocklist?: BlockListResponse;
16695
18366
  }
16696
18367
  export interface UpdateBookmarkFolderRequest {
@@ -16703,6 +18374,9 @@ export interface UpdateBookmarkFolderRequest {
16703
18374
  * Custom data for the folder
16704
18375
  */
16705
18376
  custom?: Record<string, any>;
18377
+ /**
18378
+ * User request object
18379
+ */
16706
18380
  user?: UserRequest;
16707
18381
  }
16708
18382
  export interface UpdateBookmarkFolderResponse {
@@ -16724,6 +18398,9 @@ export interface UpdateBookmarkRequest {
16724
18398
  */
16725
18399
  custom?: Record<string, any>;
16726
18400
  new_folder?: AddFolderRequest;
18401
+ /**
18402
+ * User request object
18403
+ */
16727
18404
  user?: UserRequest;
16728
18405
  }
16729
18406
  export interface UpdateBookmarkResponse {
@@ -16762,6 +18439,9 @@ export interface UpdateCallResponse {
16762
18439
  duration: string;
16763
18440
  members: MemberResponse[];
16764
18441
  own_capabilities: OwnCapability[];
18442
+ /**
18443
+ * Represents a call
18444
+ */
16765
18445
  call: CallResponse;
16766
18446
  }
16767
18447
  export interface UpdateCallTypeRequest {
@@ -16815,6 +18495,9 @@ export interface UpdateChannelPartialRequest {
16815
18495
  user_id?: string;
16816
18496
  unset?: string[];
16817
18497
  set?: Record<string, any>;
18498
+ /**
18499
+ * User request object
18500
+ */
16818
18501
  user?: UserRequest;
16819
18502
  }
16820
18503
  export interface UpdateChannelPartialResponse {
@@ -16826,6 +18509,9 @@ export interface UpdateChannelPartialResponse {
16826
18509
  * List of updated members
16827
18510
  */
16828
18511
  members: ChannelMemberResponse[];
18512
+ /**
18513
+ * Represents channel in chat
18514
+ */
16829
18515
  channel?: ChannelResponse;
16830
18516
  }
16831
18517
  export interface UpdateChannelRequest {
@@ -16887,7 +18573,13 @@ export interface UpdateChannelRequest {
16887
18573
  */
16888
18574
  remove_members?: string[];
16889
18575
  data?: ChannelInputRequest;
18576
+ /**
18577
+ * Message data for creating or updating a message
18578
+ */
16890
18579
  message?: MessageRequest;
18580
+ /**
18581
+ * User request object
18582
+ */
16891
18583
  user?: UserRequest;
16892
18584
  }
16893
18585
  export interface UpdateChannelResponse {
@@ -16899,7 +18591,13 @@ export interface UpdateChannelResponse {
16899
18591
  * List of channel members
16900
18592
  */
16901
18593
  members: ChannelMemberResponse[];
18594
+ /**
18595
+ * Represents channel in chat
18596
+ */
16902
18597
  channel?: ChannelResponse;
18598
+ /**
18599
+ * Represents any chat message
18600
+ */
16903
18601
  message?: MessageResponse;
16904
18602
  }
16905
18603
  export interface UpdateChannelTypeRequest {
@@ -16938,6 +18636,9 @@ export interface UpdateChannelTypeRequest {
16938
18636
  */
16939
18637
  commands?: string[];
16940
18638
  permissions?: PolicyRequest[];
18639
+ /**
18640
+ * Sets thresholds for AI moderation
18641
+ */
16941
18642
  automod_thresholds?: Thresholds;
16942
18643
  chat_preferences?: ChatPreferences;
16943
18644
  grants?: Record<string, string[]>;
@@ -16980,6 +18681,9 @@ export interface UpdateChannelTypeResponse {
16980
18681
  push_level?: 'all' | 'all_mentions' | 'mentions' | 'direct_mentions' | 'none';
16981
18682
  allowed_flag_reasons?: string[];
16982
18683
  blocklists?: BlockListOptions[];
18684
+ /**
18685
+ * Sets thresholds for AI moderation
18686
+ */
16983
18687
  automod_thresholds?: Thresholds;
16984
18688
  chat_preferences?: ChatPreferences;
16985
18689
  }
@@ -17003,6 +18707,9 @@ export interface UpdateCollectionsRequest {
17003
18707
  */
17004
18708
  collections: UpdateCollectionRequest[];
17005
18709
  user_id?: string;
18710
+ /**
18711
+ * User request object
18712
+ */
17006
18713
  user?: UserRequest;
17007
18714
  }
17008
18715
  export interface UpdateCollectionsResponse {
@@ -17028,6 +18735,9 @@ export interface UpdateCommandRequest {
17028
18735
  }
17029
18736
  export interface UpdateCommandResponse {
17030
18737
  duration: string;
18738
+ /**
18739
+ * Represents custom chat command
18740
+ */
17031
18741
  command?: Command;
17032
18742
  }
17033
18743
  export interface UpdateCommentBookmarkRequest {
@@ -17045,6 +18755,9 @@ export interface UpdateCommentBookmarkRequest {
17045
18755
  */
17046
18756
  custom?: Record<string, any>;
17047
18757
  new_folder?: AddFolderRequest;
18758
+ /**
18759
+ * User request object
18760
+ */
17048
18761
  user?: UserRequest;
17049
18762
  }
17050
18763
  export interface UpdateCommentBookmarkResponse {
@@ -17082,6 +18795,9 @@ export interface UpdateCommentPartialRequest {
17082
18795
  * Map of field names to new values. Supported fields: 'text', 'attachments', 'custom', 'mentioned_user_ids', 'status'. Use dot-notation for nested custom fields (e.g., 'custom.field_name')
17083
18796
  */
17084
18797
  set?: Record<string, any>;
18798
+ /**
18799
+ * User request object
18800
+ */
17085
18801
  user?: UserRequest;
17086
18802
  }
17087
18803
  export interface UpdateCommentPartialResponse {
@@ -17124,6 +18840,9 @@ export interface UpdateCommentRequest {
17124
18840
  * Updated custom data for the comment
17125
18841
  */
17126
18842
  custom?: Record<string, any>;
18843
+ /**
18844
+ * User request object
18845
+ */
17127
18846
  user?: UserRequest;
17128
18847
  }
17129
18848
  export interface UpdateCommentResponse {
@@ -17144,7 +18863,13 @@ export interface UpdateExternalStorageRequest {
17144
18863
  * The path prefix to use for storing files
17145
18864
  */
17146
18865
  path?: string;
18866
+ /**
18867
+ * Config for creating Amazon S3 storage.
18868
+ */
17147
18869
  aws_s3?: S3Request;
18870
+ /**
18871
+ * Config for creating Azure Blob Storage storage
18872
+ */
17148
18873
  azure_blob?: AzureRequest;
17149
18874
  }
17150
18875
  export interface UpdateExternalStorageResponse {
@@ -17383,6 +19108,9 @@ export interface UpdateMessagePartialRequest {
17383
19108
  * Sets new field values
17384
19109
  */
17385
19110
  set?: Record<string, any>;
19111
+ /**
19112
+ * User request object
19113
+ */
17386
19114
  user?: UserRequest;
17387
19115
  }
17388
19116
  export interface UpdateMessagePartialResponse {
@@ -17390,6 +19118,9 @@ export interface UpdateMessagePartialResponse {
17390
19118
  * Duration of the request in milliseconds
17391
19119
  */
17392
19120
  duration: string;
19121
+ /**
19122
+ * Represents any chat message
19123
+ */
17393
19124
  message?: MessageResponse;
17394
19125
  /**
17395
19126
  * Pending message metadata
@@ -17397,6 +19128,9 @@ export interface UpdateMessagePartialResponse {
17397
19128
  pending_message_metadata?: Record<string, string>;
17398
19129
  }
17399
19130
  export interface UpdateMessageRequest {
19131
+ /**
19132
+ * Message data for creating or updating a message
19133
+ */
17400
19134
  message: MessageRequest;
17401
19135
  /**
17402
19136
  * Skip enrich URL
@@ -17409,6 +19143,9 @@ export interface UpdateMessageResponse {
17409
19143
  * Duration of the request in milliseconds
17410
19144
  */
17411
19145
  duration: string;
19146
+ /**
19147
+ * Represents any chat message
19148
+ */
17412
19149
  message: MessageResponse;
17413
19150
  pending_message_metadata?: Record<string, string>;
17414
19151
  }
@@ -17422,7 +19159,13 @@ export interface UpdatePollOptionRequest {
17422
19159
  */
17423
19160
  text: string;
17424
19161
  user_id?: string;
19162
+ /**
19163
+ * Custom data for this object
19164
+ */
17425
19165
  custom?: Record<string, any>;
19166
+ /**
19167
+ * User request object
19168
+ */
17426
19169
  user?: UserRequest;
17427
19170
  }
17428
19171
  export interface UpdatePollPartialRequest {
@@ -17435,6 +19178,9 @@ export interface UpdatePollPartialRequest {
17435
19178
  * Sets new field values
17436
19179
  */
17437
19180
  set?: Record<string, any>;
19181
+ /**
19182
+ * User request object
19183
+ */
17438
19184
  user?: UserRequest;
17439
19185
  }
17440
19186
  export interface UpdatePollRequest {
@@ -17479,7 +19225,13 @@ export interface UpdatePollRequest {
17479
19225
  * Poll options
17480
19226
  */
17481
19227
  options?: PollOptionRequest[];
19228
+ /**
19229
+ * Custom data for this object
19230
+ */
17482
19231
  custom?: Record<string, any>;
19232
+ /**
19233
+ * User request object
19234
+ */
17483
19235
  user?: UserRequest;
17484
19236
  }
17485
19237
  export interface UpdateQueueRequest {
@@ -17488,11 +19240,17 @@ export interface UpdateQueueRequest {
17488
19240
  user_id?: string;
17489
19241
  sort?: Array<Record<string, any>>;
17490
19242
  filters?: Record<string, any>;
19243
+ /**
19244
+ * User request object
19245
+ */
17491
19246
  user?: UserRequest;
17492
19247
  }
17493
19248
  export interface UpdateReminderRequest {
17494
19249
  remind_at?: Date;
17495
19250
  user_id?: string;
19251
+ /**
19252
+ * User request object
19253
+ */
17496
19254
  user?: UserRequest;
17497
19255
  }
17498
19256
  export interface UpdateReminderResponse {
@@ -17511,6 +19269,9 @@ export interface UpdateSIPInboundRoutingRuleRequest {
17511
19269
  * List of SIP trunk IDs
17512
19270
  */
17513
19271
  trunk_ids: string[];
19272
+ /**
19273
+ * Configuration for SIP caller settings
19274
+ */
17514
19275
  caller_configs: SIPCallerConfigsRequest;
17515
19276
  /**
17516
19277
  * List of called numbers
@@ -17520,13 +19281,28 @@ export interface UpdateSIPInboundRoutingRuleRequest {
17520
19281
  * List of caller numbers (optional)
17521
19282
  */
17522
19283
  caller_numbers?: string[];
19284
+ /**
19285
+ * Configuration for SIP call settings
19286
+ */
17523
19287
  call_configs?: SIPCallConfigsRequest;
19288
+ /**
19289
+ * Configuration for direct routing rule calls
19290
+ */
17524
19291
  direct_routing_configs?: SIPDirectRoutingRuleCallConfigsRequest;
19292
+ /**
19293
+ * Configuration for PIN protection settings
19294
+ */
17525
19295
  pin_protection_configs?: SIPPinProtectionConfigsRequest;
19296
+ /**
19297
+ * Configuration for PIN routing rule calls
19298
+ */
17526
19299
  pin_routing_configs?: SIPInboundRoutingRulePinConfigsRequest;
17527
19300
  }
17528
19301
  export interface UpdateSIPInboundRoutingRuleResponse {
17529
19302
  duration: string;
19303
+ /**
19304
+ * SIP Inbound Routing Rule response
19305
+ */
17530
19306
  sip_inbound_routing_rule?: SIPInboundRoutingRuleResponse;
17531
19307
  }
17532
19308
  export interface UpdateSIPTrunkRequest {
@@ -17549,6 +19325,9 @@ export interface UpdateSIPTrunkRequest {
17549
19325
  }
17550
19326
  export interface UpdateSIPTrunkResponse {
17551
19327
  duration: string;
19328
+ /**
19329
+ * SIP trunk information
19330
+ */
17552
19331
  sip_trunk?: SIPTrunkResponse;
17553
19332
  }
17554
19333
  export interface UpdateSegmentRequest {
@@ -17582,6 +19361,9 @@ export interface UpdateThreadPartialRequest {
17582
19361
  * Sets new field values
17583
19362
  */
17584
19363
  set?: Record<string, any>;
19364
+ /**
19365
+ * User request object
19366
+ */
17585
19367
  user?: UserRequest;
17586
19368
  }
17587
19369
  export interface UpdateThreadPartialResponse {
@@ -17652,6 +19434,9 @@ export interface UpdatedCallPermissionsEvent {
17652
19434
  * The capabilities of the current user
17653
19435
  */
17654
19436
  own_capabilities: OwnCapability[];
19437
+ /**
19438
+ * User response object
19439
+ */
17655
19440
  user: UserResponse;
17656
19441
  /**
17657
19442
  * The type of event: "call.permissions_updated" in this case
@@ -17748,10 +19533,16 @@ export interface UpsertActionConfigRequest {
17748
19533
  * Action-specific parameters passed to the action handler
17749
19534
  */
17750
19535
  custom?: Record<string, any>;
19536
+ /**
19537
+ * User request object
19538
+ */
17751
19539
  user?: UserRequest;
17752
19540
  }
17753
19541
  export interface UpsertActionConfigResponse {
17754
19542
  duration: string;
19543
+ /**
19544
+ * Configuration for a moderation action
19545
+ */
17755
19546
  action_config?: ModerationActionConfigResponse;
17756
19547
  }
17757
19548
  export interface UpsertActivitiesRequest {
@@ -17827,6 +19618,9 @@ export interface UpsertConfigRequest {
17827
19618
  google_vision_config?: GoogleVisionConfig;
17828
19619
  llm_config?: LLMConfig;
17829
19620
  rule_builder_config?: RuleBuilderConfig;
19621
+ /**
19622
+ * User request object
19623
+ */
17830
19624
  user?: UserRequest;
17831
19625
  velocity_filter_config?: VelocityFilterConfig;
17832
19626
  video_call_rule_config?: VideoCallRuleConfig;
@@ -17835,6 +19629,28 @@ export interface UpsertConfigResponse {
17835
19629
  duration: string;
17836
19630
  config?: ConfigResponse;
17837
19631
  }
19632
+ export interface UpsertExternalStorageAWSS3Request {
19633
+ bucket: string;
19634
+ region: string;
19635
+ role_arn: string;
19636
+ path_prefix?: string;
19637
+ }
19638
+ export interface UpsertExternalStorageGCSRequest {
19639
+ bucket: string;
19640
+ credentials: string;
19641
+ path_prefix?: string;
19642
+ }
19643
+ export interface UpsertExternalStorageRequest {
19644
+ type: 'aws_s3' | 'gcs';
19645
+ aws_s3?: UpsertExternalStorageAWSS3Request;
19646
+ gcs?: UpsertExternalStorageGCSRequest;
19647
+ }
19648
+ export interface UpsertExternalStorageResponse {
19649
+ /**
19650
+ * Duration of the request in milliseconds
19651
+ */
19652
+ duration: string;
19653
+ }
17838
19654
  export interface UpsertModerationRuleRequest {
17839
19655
  /**
17840
19656
  * Unique rule name
@@ -17885,6 +19701,9 @@ export interface UpsertModerationRuleRequest {
17885
19701
  */
17886
19702
  groups?: RuleBuilderConditionGroup[];
17887
19703
  action?: RuleBuilderAction;
19704
+ /**
19705
+ * User request object
19706
+ */
17888
19707
  user?: UserRequest;
17889
19708
  }
17890
19709
  export interface UpsertModerationRuleResponse {
@@ -17899,6 +19718,9 @@ export interface UpsertModerationTemplateRequest {
17899
19718
  * Name of the moderation template
17900
19719
  */
17901
19720
  name: string;
19721
+ /**
19722
+ * Configuration for a feeds moderation template
19723
+ */
17902
19724
  config: FeedsModerationTemplateConfigPayload;
17903
19725
  }
17904
19726
  export interface UpsertModerationTemplateResponse {
@@ -17915,6 +19737,9 @@ export interface UpsertModerationTemplateResponse {
17915
19737
  * When the template was last updated
17916
19738
  */
17917
19739
  updated_at: Date;
19740
+ /**
19741
+ * Configuration for a feeds moderation template
19742
+ */
17918
19743
  config?: FeedsModerationTemplateConfigPayload;
17919
19744
  }
17920
19745
  export interface UpsertPushPreferencesRequest {
@@ -18303,7 +20128,13 @@ export interface UserMuteResponse {
18303
20128
  created_at: Date;
18304
20129
  updated_at: Date;
18305
20130
  expires?: Date;
20131
+ /**
20132
+ * User response object
20133
+ */
18306
20134
  target?: UserResponse;
20135
+ /**
20136
+ * User response object
20137
+ */
18307
20138
  user?: UserResponse;
18308
20139
  }
18309
20140
  export interface UserMutedEvent {
@@ -18587,6 +20418,12 @@ export interface UserUpdatedEvent {
18587
20418
  type: string;
18588
20419
  received_at?: Date;
18589
20420
  }
20421
+ export interface ValidateExternalStorageResponse {
20422
+ /**
20423
+ * Duration of the request in milliseconds
20424
+ */
20425
+ duration: string;
20426
+ }
18590
20427
  export interface VelocityFilterConfig {
18591
20428
  advanced_filters?: boolean;
18592
20429
  async?: boolean;
@@ -18630,6 +20467,9 @@ export interface VideoReactionOverTimeResponse {
18630
20467
  }
18631
20468
  export interface VideoReactionResponse {
18632
20469
  type: string;
20470
+ /**
20471
+ * User response object
20472
+ */
18633
20473
  user: UserResponse;
18634
20474
  emoji_code?: string;
18635
20475
  custom?: Record<string, any>;
@@ -18664,6 +20504,16 @@ export interface VideoSettingsResponse {
18664
20504
  enabled: boolean;
18665
20505
  target_resolution: TargetResolution;
18666
20506
  }
20507
+ export interface ViewerBehavior {
20508
+ connection_duration_p50_s: number;
20509
+ connections_per_viewer_mean: number;
20510
+ median_watch_min: number;
20511
+ note: string;
20512
+ p90_watch_min: number;
20513
+ bounce_rate_pct?: number;
20514
+ connections_under_30s_pct?: number;
20515
+ return_visit_rate_pct?: number;
20516
+ }
18667
20517
  export interface VoteData {
18668
20518
  answer_text?: string;
18669
20519
  option_id?: string;
@@ -18941,6 +20791,8 @@ export type WHEvent = ({
18941
20791
  } & MessageUndeletedEvent) | ({
18942
20792
  type: 'message.updated';
18943
20793
  } & MessageUpdatedEvent) | ({
20794
+ type: 'moderation.analysis.failed';
20795
+ } & ModerationAnalysisFailedEvent) | ({
18944
20796
  type: 'moderation.custom_action';
18945
20797
  } & ModerationCustomActionEvent) | ({
18946
20798
  type: 'moderation.flagged';
@@ -19034,16 +20886,28 @@ export interface WSEvent {
19034
20886
  user_id?: string;
19035
20887
  watcher_count?: number;
19036
20888
  automoderation_scores?: ModerationResponse;
20889
+ /**
20890
+ * Represents channel in chat
20891
+ */
19037
20892
  channel?: ChannelResponse;
20893
+ /**
20894
+ * User response object
20895
+ */
19038
20896
  created_by?: UserResponse;
19039
20897
  me?: OwnUserResponse;
19040
20898
  member?: ChannelMemberResponse;
20899
+ /**
20900
+ * Represents any chat message
20901
+ */
19041
20902
  message?: MessageResponse;
19042
20903
  message_update?: MessageUpdate;
19043
20904
  poll?: PollResponseData;
19044
20905
  poll_vote?: PollVoteResponseData;
19045
20906
  reaction?: ReactionResponse;
19046
20907
  thread?: ThreadResponse;
20908
+ /**
20909
+ * User response object
20910
+ */
19047
20911
  user?: UserResponse;
19048
20912
  }
19049
20913
  export interface WebhookFailoverConfig {