@stream-io/node-sdk 0.8.10 → 0.8.12

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.
@@ -1,12 +1,31 @@
1
1
  export interface AIAudioConfigRequest {
2
+ /**
3
+ * Bodyguard credentials profile to classify transcripts with. Applies to the NLP engine only; ignored when LLM configurability is enabled. Empty falls back to the app-pinned profile, then the organization's top-level credentials
4
+ */
2
5
  profile?: string;
6
+ /**
7
+ * Deprecated pre-split rule list. Still the live config while no engine config exists; once one does it is kept as a fallback for whichever engine has none of its own
8
+ */
3
9
  rules?: Array<BodyguardRule>;
10
+ ai_text_config?: AITextConfig;
11
+ llm_config?: LLMConfig;
4
12
  }
5
13
 
6
14
  export interface AIAudioConfigResponse {
15
+ /**
16
+ * Whether the engine selected by the application's LLM configurability flag has a rule that does something. Derived, not stored
17
+ */
7
18
  enabled: boolean;
19
+ /**
20
+ * Bodyguard credentials profile transcripts are classified with. Applies to the NLP engine only
21
+ */
8
22
  profile: string;
23
+ /**
24
+ * The active engine's rules, flattened into the pre-split shape for clients that predate the per-engine configs. This is the whole config for a policy that has no per-engine config stored
25
+ */
9
26
  rules: Array<BodyguardRule>;
27
+ ai_text_config?: AITextConfig;
28
+ llm_config?: LLMConfig;
10
29
  }
11
30
 
12
31
  export interface AIImageConfig {
@@ -890,6 +909,10 @@ export interface ActivitySelectorConfig {
890
909
  * Maximum number of candidate activities this selector contributes to a ranked feed (1-1000). Omit to use the default ranking buffer. Only supported on the popular, proximity, interest and query selectors, and ignored on feeds without ranking
891
910
  */
892
911
  ranking_candidate_limit?: number;
912
+ /**
913
+ * Maximum time in milliseconds this selector may take (25-5000). A selector that runs over its budget is dropped from that read instead of failing it, and stays out for the rest of that pagination session. The budget can only tighten the default, never extend it. Omit to use the default. Only supported on the popular, proximity, interest, query and follow_suggestion selectors
914
+ */
915
+ time_budget_ms?: number;
893
916
  /**
894
917
  * Sort parameters for activity selection
895
918
  */
@@ -930,6 +953,10 @@ export interface ActivitySelectorConfigResponse {
930
953
  * Maximum number of candidate activities this selector contributes to a ranked feed
931
954
  */
932
955
  ranking_candidate_limit?: number;
956
+ /**
957
+ * Maximum time in milliseconds this selector may take before it is dropped from the read
958
+ */
959
+ time_budget_ms?: number;
933
960
  /**
934
961
  * Sort parameters for activity selection
935
962
  */
@@ -1449,7 +1476,7 @@ export interface AggregationConfig {
1449
1476
  */
1450
1477
  format?: string;
1451
1478
  /**
1452
- * Maximum number of activities kept in each aggregated group. Omit to use the default of 100. Must be between 1 and 100 when set.
1479
+ * Maximum number of activities kept in each aggregated group. Omit to use the default: 15 for apps migrated from Feeds v2 or created on or after 2026-10-11, 100 otherwise. Must be between 1 and 100 when set.
1453
1480
  */
1454
1481
  group_size?: number;
1455
1482
  /**
@@ -1578,7 +1605,13 @@ export interface AnalyzeTextField {
1578
1605
 
1579
1606
  export interface AppResponseFields {
1580
1607
  allow_multi_user_devices: boolean;
1608
+ /**
1609
+ * A boolean value determining if async url enrichment is enabled.
1610
+ */
1581
1611
  async_url_enrich_enabled: boolean;
1612
+ /**
1613
+ * A boolean value determining if auto translation is enabled.
1614
+ */
1582
1615
  auto_translation_enabled: boolean;
1583
1616
  before_message_send_hook_system_messages: boolean;
1584
1617
  campaign_enabled: boolean;
@@ -1603,6 +1636,9 @@ export interface AppResponseFields {
1603
1636
  moderation_video_call_moderation_enabled: boolean;
1604
1637
  moderation_webhook_url: string;
1605
1638
  multi_tenant_enabled: boolean;
1639
+ /**
1640
+ * The name of the app.
1641
+ */
1606
1642
  name: string;
1607
1643
  organization: string;
1608
1644
  permission_version: string;
@@ -1832,6 +1868,17 @@ export interface AsyncExportErrorEvent {
1832
1868
  received_at?: Date;
1833
1869
  }
1834
1870
 
1871
+ export interface AsyncExportLabelResultsEvent {
1872
+ created_at: Date;
1873
+ finished_at: Date;
1874
+ started_at: Date;
1875
+ task_id: string;
1876
+ url: string;
1877
+ custom: Record<string, any>;
1878
+ type: string;
1879
+ received_at?: Date;
1880
+ }
1881
+
1835
1882
  export interface AsyncExportModerationLogsEvent {
1836
1883
  created_at: Date;
1837
1884
  finished_at: Date;
@@ -1865,6 +1912,31 @@ export interface AsyncExportUsersEvent {
1865
1912
  received_at?: Date;
1866
1913
  }
1867
1914
 
1915
+ export interface AsyncImportErrorEvent {
1916
+ created_at: Date;
1917
+ error: string;
1918
+ finished_at: Date;
1919
+ product: string;
1920
+ state: string;
1921
+ task_id: string;
1922
+ custom: Record<string, any>;
1923
+ type: string;
1924
+ received_at?: Date;
1925
+ started_at?: Date;
1926
+ }
1927
+
1928
+ export interface AsyncImportSuccessEvent {
1929
+ created_at: Date;
1930
+ finished_at: Date;
1931
+ product: string;
1932
+ state: string;
1933
+ task_id: string;
1934
+ custom: Record<string, any>;
1935
+ type: string;
1936
+ received_at?: Date;
1937
+ started_at?: Date;
1938
+ }
1939
+
1868
1940
  export interface AsyncModerationCallbackConfig {
1869
1941
  mode?: 'CALLBACK_MODE_NONE' | 'CALLBACK_MODE_REST' | 'CALLBACK_MODE_TWIRP';
1870
1942
  server_url?: string;
@@ -2108,6 +2180,10 @@ export interface BanRequest {
2108
2180
  * ID of the user to ban
2109
2181
  */
2110
2182
  target_user_id: string;
2183
+ /**
2184
+ * Whether to also ban the user from future channels created by the banner
2185
+ */
2186
+ ban_from_future_channels?: boolean;
2111
2187
  /**
2112
2188
  * ID of the user performing the ban
2113
2189
  */
@@ -2117,6 +2193,10 @@ export interface BanRequest {
2117
2193
  */
2118
2194
  channel_cid?: string;
2119
2195
  delete_messages?: 'soft' | 'pruning' | 'hard';
2196
+ /**
2197
+ * Whether to delete reactions by the banned user on other users' messages
2198
+ */
2199
+ delete_reactions?: boolean;
2120
2200
  /**
2121
2201
  * Whether to ban the user's IP address
2122
2202
  */
@@ -2259,7 +2339,7 @@ export interface BlockListResponse {
2259
2339
  */
2260
2340
  name: string;
2261
2341
  /**
2262
- * Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word
2342
+ * Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word, word_allowlist
2263
2343
  */
2264
2344
  type: string;
2265
2345
  /**
@@ -3461,6 +3541,51 @@ export interface CallRingEvent {
3461
3541
  ring_id?: string;
3462
3542
  }
3463
3543
 
3544
+ export interface CallRingSettledEvent {
3545
+ call_cid: string;
3546
+ created_at: Date;
3547
+ /**
3548
+ * ID of the user who rang
3549
+ */
3550
+ initiated_by: string;
3551
+ /**
3552
+ * Final outcome of the ring: answered_all, answered_some, rejected_all, missed_all, cancelled or mixed
3553
+ */
3554
+ outcome: string;
3555
+ /**
3556
+ * When the ring was sent
3557
+ */
3558
+ rang_at: Date;
3559
+ /**
3560
+ * Identifies this ring of the call session, as carried on call.ring
3561
+ */
3562
+ ring_id: string;
3563
+ /**
3564
+ * Call session ID
3565
+ */
3566
+ session_id: string;
3567
+ /**
3568
+ * Why the ring closed: answered, rejected, cancel, timeout, ended or auto_end
3569
+ */
3570
+ settle_reason: string;
3571
+ /**
3572
+ * When the outcome left ringing
3573
+ */
3574
+ settled_at: Date;
3575
+ /**
3576
+ * ID of the user whose action closed the ring, or 'server' for the missed-call deadline and automatic ends
3577
+ */
3578
+ settled_by: string;
3579
+ /**
3580
+ * Final state of every rung user, keyed by user ID
3581
+ */
3582
+ targets: Record<string, RingSettledTarget>;
3583
+ /**
3584
+ * The type of event: "call.ring_settled" in this case
3585
+ */
3586
+ type: string;
3587
+ }
3588
+
3464
3589
  export interface CallRtmpBroadcastFailedEvent {
3465
3590
  /**
3466
3591
  * The unique identifier for a call (<type>:<id>)
@@ -4847,7 +4972,13 @@ export type ChannelOwnCapability =
4847
4972
  (typeof ChannelOwnCapability)[keyof typeof ChannelOwnCapability];
4848
4973
 
4849
4974
  export interface ChannelPushPreferencesResponse {
4975
+ /**
4976
+ * The scope level of the push notifications.
4977
+ */
4850
4978
  chat_level?: string;
4979
+ /**
4980
+ * If provided the notifications will be disabled until the set date.
4981
+ */
4851
4982
  disabled_until?: Date;
4852
4983
  chat_preferences?: ChatPreferencesResponse;
4853
4984
  }
@@ -4980,6 +5111,9 @@ export interface ChannelStateResponse {
4980
5111
  channel?: ChannelResponse;
4981
5112
  draft?: DraftResponse;
4982
5113
  membership?: ChannelMemberResponse;
5114
+ /**
5115
+ * The push preference details.
5116
+ */
4983
5117
  push_preferences?: ChannelPushPreferencesResponse;
4984
5118
  }
4985
5119
 
@@ -5031,6 +5165,9 @@ export interface ChannelStateResponseFields {
5031
5165
  channel?: ChannelResponse;
5032
5166
  draft?: DraftResponse;
5033
5167
  membership?: ChannelMemberResponse;
5168
+ /**
5169
+ * The push preference details.
5170
+ */
5034
5171
  push_preferences?: ChannelPushPreferencesResponse;
5035
5172
  }
5036
5173
 
@@ -5451,6 +5588,37 @@ export interface CheckExternalStorageResponse {
5451
5588
  file_url: string;
5452
5589
  }
5453
5590
 
5591
+ export interface CheckGCPPubSubRequest {
5592
+ /**
5593
+ * Publish the test message with an ordering key through the regional endpoint, as a hook with ordering enabled would; requires gcp_pubsub_region
5594
+ */
5595
+ gcp_pubsub_event_based_ordering_key_enabled?: boolean;
5596
+ /**
5597
+ * GCP region used for the regional Pub/Sub endpoint when ordering is enabled
5598
+ */
5599
+ gcp_pubsub_region?: string;
5600
+ /**
5601
+ * Fully qualified GCP Pub/Sub topic name (projects/{project}/topics/{topic})
5602
+ */
5603
+ gcp_pubsub_topic?: string;
5604
+ }
5605
+
5606
+ export interface CheckGCPPubSubResponse {
5607
+ duration: string;
5608
+ /**
5609
+ * Validation result. One of: ok, error
5610
+ */
5611
+ status: string;
5612
+ /**
5613
+ * Error text
5614
+ */
5615
+ error?: string;
5616
+ /**
5617
+ * Error data
5618
+ */
5619
+ data?: Record<string, any>;
5620
+ }
5621
+
5454
5622
  export interface CheckPushRequest {
5455
5623
  /**
5456
5624
  * Push message template for APN
@@ -5961,6 +6129,68 @@ export interface CommentDeletedEvent {
5961
6129
  user?: UserResponseCommonFields;
5962
6130
  }
5963
6131
 
6132
+ export interface CommentFeedbackEvent {
6133
+ /**
6134
+ * Date/time of creation
6135
+ */
6136
+ created_at: Date;
6137
+ comment_feedback: CommentFeedbackEventPayload;
6138
+ custom: Record<string, any>;
6139
+ /**
6140
+ * The type of event: "feeds.comment.feedback" in this case
6141
+ */
6142
+ type: string;
6143
+ received_at?: Date;
6144
+ user?: UserResponseCommonFields;
6145
+ }
6146
+
6147
+ export interface CommentFeedbackEventPayload {
6148
+ /**
6149
+ * The comment that received feedback
6150
+ */
6151
+ comment_id: string;
6152
+ /**
6153
+ * When the feedback was created
6154
+ */
6155
+ created_at: Date;
6156
+ /**
6157
+ * Whether the comment is hidden for the user
6158
+ */
6159
+ hide: boolean;
6160
+ /**
6161
+ * When the feedback was last updated
6162
+ */
6163
+ updated_at: Date;
6164
+ /**
6165
+ * User response object
6166
+ */
6167
+ user: UserResponse;
6168
+ }
6169
+
6170
+ export interface CommentFeedbackRequest {
6171
+ /**
6172
+ * Whether to hide this comment for the user
6173
+ */
6174
+ hide?: boolean;
6175
+ user_id?: string;
6176
+ /**
6177
+ * User request object
6178
+ */
6179
+ user?: UserRequest;
6180
+ }
6181
+
6182
+ export interface CommentFeedbackResponse {
6183
+ /**
6184
+ * The ID of the comment that received feedback
6185
+ */
6186
+ comment_id: string;
6187
+ duration: string;
6188
+ /**
6189
+ * Whether the comment is hidden for the user
6190
+ */
6191
+ hide: boolean;
6192
+ }
6193
+
5964
6194
  export interface CommentReactionAddedEvent {
5965
6195
  /**
5966
6196
  * Date/time of creation
@@ -6030,6 +6260,10 @@ export interface CommentResponse {
6030
6260
  * Number of downvotes for this comment
6031
6261
  */
6032
6262
  downvote_count: number;
6263
+ /**
6264
+ * Only true in QueryComments results filtered with hidden: true
6265
+ */
6266
+ hidden: boolean;
6033
6267
  /**
6034
6268
  * Unique identifier for the comment
6035
6269
  */
@@ -6284,6 +6518,11 @@ export interface ContentCountRuleParameters {
6284
6518
  time_window?: string;
6285
6519
  }
6286
6520
 
6521
+ export interface ContentCountryCodeParameters {
6522
+ operator?: string;
6523
+ country_codes?: Array<string>;
6524
+ }
6525
+
6287
6526
  export interface ContentCustomPropertyCountParameters {
6288
6527
  operator?: string;
6289
6528
  property_key?: string;
@@ -6333,7 +6572,7 @@ export interface CreateBlockListRequest {
6333
6572
  is_substring_matching_enabled?: boolean;
6334
6573
  team?: string;
6335
6574
  /**
6336
- * Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word
6575
+ * Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word, word_allowlist
6337
6576
  */
6338
6577
  type?:
6339
6578
  | 'regex'
@@ -6341,7 +6580,8 @@ export interface CreateBlockListRequest {
6341
6580
  | 'domain_allowlist'
6342
6581
  | 'email'
6343
6582
  | 'email_allowlist'
6344
- | 'word';
6583
+ | 'word'
6584
+ | 'word_allowlist';
6345
6585
  user_id?: string;
6346
6586
  /**
6347
6587
  * User request object
@@ -7034,6 +7274,9 @@ export interface CreatePollRequest {
7034
7274
  max_votes_allowed?: number;
7035
7275
  team?: string;
7036
7276
  user_id?: string;
7277
+ /**
7278
+ * Represents the visibility of votes in a poll.
7279
+ */
7037
7280
  voting_visibility?: 'anonymous' | 'public';
7038
7281
  options?: Array<PollOptionInput>;
7039
7282
  /**
@@ -7718,7 +7961,7 @@ export interface DeleteFeedsBatchResponse {
7718
7961
  }
7719
7962
 
7720
7963
  export interface DeleteFeedsRetentionPolicyRequest {
7721
- policy: 'old-activities';
7964
+ policy: string;
7722
7965
  }
7723
7966
 
7724
7967
  export interface DeleteFeedsRetentionPolicyResponse {
@@ -8022,11 +8265,11 @@ export interface DeviceErrorInfo {
8022
8265
 
8023
8266
  export interface DeviceResponse {
8024
8267
  /**
8025
- * Date/time of creation
8268
+ * The date when the device was created.
8026
8269
  */
8027
8270
  created_at: Date;
8028
8271
  /**
8029
- * Device ID
8272
+ * The device identifier.
8030
8273
  */
8031
8274
  id: string;
8032
8275
  /**
@@ -8401,6 +8644,9 @@ export interface EntityCreatorResponse {
8401
8644
  name?: string;
8402
8645
  revoke_tokens_issued_before?: Date;
8403
8646
  devices?: Array<DeviceResponse>;
8647
+ /**
8648
+ * The privacy settings of the user.
8649
+ */
8404
8650
  privacy_settings?: PrivacySettingsResponse;
8405
8651
  push_notifications?: PushNotificationSettingsResponse;
8406
8652
  teams_role?: Record<string, string>;
@@ -8437,6 +8683,10 @@ export interface EscalationMetadata {
8437
8683
  export interface EventHook {
8438
8684
  created_at?: Date;
8439
8685
  enabled?: boolean;
8686
+ gcp_pubsub_auth_type?: string;
8687
+ gcp_pubsub_event_based_ordering_key_enabled?: boolean;
8688
+ gcp_pubsub_region?: string;
8689
+ gcp_pubsub_topic?: string;
8440
8690
  hook_type?: string;
8441
8691
  id?: string;
8442
8692
  product?: string;
@@ -9299,6 +9549,11 @@ export interface FeedsNotificationTrigger {
9299
9549
  custom?: Record<string, any>;
9300
9550
  }
9301
9551
 
9552
+ export interface FeedsPolicyConfig {
9553
+ max_age_hours: number;
9554
+ feed_groups?: Array<string>;
9555
+ }
9556
+
9302
9557
  export interface FeedsPreferences {
9303
9558
  /**
9304
9559
  * Push notification preference for comments on user's activities. One of: all, none
@@ -9364,6 +9619,13 @@ export interface FeedsReactionResponse {
9364
9619
  custom?: Record<string, any>;
9365
9620
  }
9366
9621
 
9622
+ export interface FeedsRetentionPolicy {
9623
+ app_pk: number;
9624
+ enabled_at: Date;
9625
+ policy: string;
9626
+ config: FeedsPolicyConfig;
9627
+ }
9628
+
9367
9629
  export interface FeedsRetentionRunResponse {
9368
9630
  app_pk: number;
9369
9631
  date: string;
@@ -9441,6 +9703,7 @@ export interface FeedsV3CommentResponse {
9441
9703
  confidence_score: number;
9442
9704
  created_at: Date;
9443
9705
  downvote_count: number;
9706
+ hidden: boolean;
9444
9707
  id: string;
9445
9708
  object_id: string;
9446
9709
  object_type: string;
@@ -9515,6 +9778,10 @@ export interface FilterConfigResponse {
9515
9778
  * AI image moderation labels available as filter values. Reflects the app's effective image taxonomy: custom Bodyguard taxonomy when enabled, otherwise the standard L1 label set.
9516
9779
  */
9517
9780
  ai_image_labels?: Array<string>;
9781
+ /**
9782
+ * Labels the image OCR pipeline can flag, available as filter values on the `label` field under the ai_image category. The app's LLM labels when LLM configurability is enabled, otherwise the AI text labels. OCR and image-classification labels share the `label` field, so a name present in both matches either.
9783
+ */
9784
+ ai_image_ocr_labels?: Array<string>;
9518
9785
  /**
9519
9786
  * AI text moderation labels available as filter values
9520
9787
  */
@@ -9937,6 +10204,9 @@ export interface FullUserResponse {
9937
10204
  name?: string;
9938
10205
  revoke_tokens_issued_before?: Date;
9939
10206
  latest_hidden_channels?: Array<string>;
10207
+ /**
10208
+ * The privacy settings of the user.
10209
+ */
9940
10210
  privacy_settings?: PrivacySettingsResponse;
9941
10211
  teams_role?: Record<string, string>;
9942
10212
  }
@@ -10012,6 +10282,9 @@ export interface GetApplicationResponse {
10012
10282
  * Duration of the request in milliseconds
10013
10283
  */
10014
10284
  duration: string;
10285
+ /**
10286
+ * A type representing the app settings.
10287
+ */
10015
10288
  app: AppResponseFields;
10016
10289
  }
10017
10290
 
@@ -10351,7 +10624,7 @@ export interface GetFeedsRetentionPolicyResponse {
10351
10624
  */
10352
10625
  duration: string;
10353
10626
  enabled: boolean;
10354
- policies: Array<RetentionPolicy>;
10627
+ policies: Array<FeedsRetentionPolicy>;
10355
10628
  }
10356
10629
 
10357
10630
  export interface GetFeedsRetentionPolicyRunsRequest {
@@ -10591,6 +10864,10 @@ export interface GetOrCreateFeedRequest {
10591
10864
  user_id?: string;
10592
10865
  view?: string;
10593
10866
  watch?: boolean;
10867
+ /**
10868
+ * Feature-gated; not available for all apps. Request-scoped list of actor/user IDs whose activities are filtered from this GetOrCreateFeed response only. Merged (union) into the viewing user's in-memory blocked authors for this request; never persisted to blocked_users. Max: 1000.
10869
+ */
10870
+ discard_actors?: Array<string>;
10594
10871
  data?: FeedInput;
10595
10872
  /**
10596
10873
  * Options to skip specific enrichments to improve performance. Default is false (enrichments are included). Setting a field to true skips that enrichment.
@@ -10627,6 +10904,10 @@ export interface GetOrCreateFeedResponse {
10627
10904
  feed: FeedResponse;
10628
10905
  next?: string;
10629
10906
  prev?: string;
10907
+ /**
10908
+ * Activity selectors dropped from this read because they exceeded their time budget (see the time_budget_ms selector setting). Their activities are missing from this page, and they stay out for the rest of this pagination session. Omitted when every selector completed
10909
+ */
10910
+ degraded_selectors?: Array<string>;
10630
10911
  followers_pagination?: PagerResponse;
10631
10912
  following_pagination?: PagerResponse;
10632
10913
  member_pagination?: PagerResponse;
@@ -12364,6 +12645,9 @@ export interface MemberUserRequest {
12364
12645
  role?: string;
12365
12646
  teams?: Array<string>;
12366
12647
  custom?: Record<string, any>;
12648
+ /**
12649
+ * The privacy settings of the user.
12650
+ */
12367
12651
  privacy_settings?: PrivacySettingsResponse;
12368
12652
  teams_role?: Record<string, string>;
12369
12653
  }
@@ -12637,6 +12921,9 @@ export interface MessageModerationResult {
12637
12921
  * User who moderated the message
12638
12922
  */
12639
12923
  moderated_by?: string;
12924
+ /**
12925
+ * Response from AI moderation
12926
+ */
12640
12927
  ai_moderation_response?: ModerationResponse;
12641
12928
  /**
12642
12929
  * Sets thresholds for AI moderation
@@ -13744,9 +14031,21 @@ export interface ModerationQueueResponse {
13744
14031
  }
13745
14032
 
13746
14033
  export interface ModerationResponse {
14034
+ /**
14035
+ * Action taken by automod
14036
+ */
13747
14037
  action: string;
14038
+ /**
14039
+ * Explicit score
14040
+ */
13748
14041
  explicit: number;
14042
+ /**
14043
+ * Spam score
14044
+ */
13749
14045
  spam: number;
14046
+ /**
14047
+ * Toxicity score
14048
+ */
13750
14049
  toxic: number;
13751
14050
  }
13752
14051
 
@@ -14359,7 +14658,13 @@ export interface OwnUserResponse {
14359
14658
  revoke_tokens_issued_before?: Date;
14360
14659
  blocked_user_ids?: Array<string>;
14361
14660
  latest_hidden_channels?: Array<string>;
14661
+ /**
14662
+ * The privacy settings of the user.
14663
+ */
14362
14664
  privacy_settings?: PrivacySettingsResponse;
14665
+ /**
14666
+ * The push preference details.
14667
+ */
14363
14668
  push_preferences?: PushPreferencesResponse;
14364
14669
  teams_role?: Record<string, string>;
14365
14670
  total_unread_count_by_team?: Record<string, number>;
@@ -14986,8 +15291,17 @@ export interface PredefinedFilterStatsResponse {
14986
15291
  }
14987
15292
 
14988
15293
  export interface PrivacySettingsResponse {
15294
+ /**
15295
+ * The settings for the delivery receipt events.
15296
+ */
14989
15297
  delivery_receipts?: DeliveryReceiptsResponse;
15298
+ /**
15299
+ * The settings for the read receipt events.
15300
+ */
14990
15301
  read_receipts?: ReadReceiptsResponse;
15302
+ /**
15303
+ * The settings for typing indicator events.
15304
+ */
14991
15305
  typing_indicators?: TypingIndicatorsResponse;
14992
15306
  }
14993
15307
 
@@ -15123,7 +15437,13 @@ export interface PushPreferenceInput {
15123
15437
 
15124
15438
  export interface PushPreferencesResponse {
15125
15439
  call_level?: string;
15440
+ /**
15441
+ * The scope level of the push notifications.
15442
+ */
15126
15443
  chat_level?: string;
15444
+ /**
15445
+ * If provided the notifications will be disabled until the set date.
15446
+ */
15127
15447
  disabled_until?: Date;
15128
15448
  feeds_level?: string;
15129
15449
  chat_preferences?: ChatPreferencesResponse;
@@ -15290,9 +15610,13 @@ export interface QueryActivitiesRequest {
15290
15610
  * When true, include both expired and non-expired activities in the result.
15291
15611
  */
15292
15612
  include_expired_activities?: boolean;
15613
+ /**
15614
+ * When true, include activities hidden by moderation (shadowed or removed). Server-side only; not allowed when a user is set.
15615
+ */
15616
+ include_moderated_activities?: boolean;
15293
15617
  include_private_activities?: boolean;
15294
15618
  /**
15295
- * When true, include soft-deleted activities in the result.
15619
+ * When true, include soft-deleted activities in the result. Server-side only; not allowed when a user is set.
15296
15620
  */
15297
15621
  include_soft_deleted_activities?: boolean;
15298
15622
  limit?: number;
@@ -15582,6 +15906,48 @@ export interface QueryCallParticipantsResponse {
15582
15906
  call: CallResponse;
15583
15907
  }
15584
15908
 
15909
+ export interface QueryCallRingAttemptsRequest {
15910
+ /**
15911
+ * Call ID
15912
+ */
15913
+ id: string;
15914
+ /**
15915
+ * The type of call
15916
+ */
15917
+ type: string;
15918
+ /**
15919
+ * Limit the attempts to one call session; omit to read every session of the call
15920
+ */
15921
+ call_session_id?: string;
15922
+ }
15923
+
15924
+ export interface QueryCallRingAttemptsResponse {
15925
+ /**
15926
+ * The ID of the call the attempts belong to
15927
+ */
15928
+ call_id: string;
15929
+ /**
15930
+ * The type of the call the attempts belong to
15931
+ */
15932
+ call_type: string;
15933
+ /**
15934
+ * The number of attempts returned
15935
+ */
15936
+ count: number;
15937
+ /**
15938
+ * Duration of the request in milliseconds
15939
+ */
15940
+ duration: string;
15941
+ /**
15942
+ * The attempts, newest first
15943
+ */
15944
+ ring_attempts: Array<RingAttemptResponse>;
15945
+ /**
15946
+ * The call session the attempts were limited to, null when every session was read
15947
+ */
15948
+ call_session_id?: string;
15949
+ }
15950
+
15585
15951
  export interface QueryCallSessionParticipantStatsResponse {
15586
15952
  call_id: string;
15587
15953
  call_session_id: string;
@@ -15854,7 +16220,7 @@ export interface QueryCommentsRequest {
15854
16220
  */
15855
16221
  id_around?: string;
15856
16222
  /**
15857
- * When true, include soft-deleted comments in the result. Server-side only, and requires an object_id filter. Returns comments deleted by any path, including user-data deletion. Moderation-actioned comments (removed, hidden) remain excluded, and comments whose parent activity is itself deleted are not returned.
16223
+ * When true, include soft-deleted comments in the result. Server-side only, and requires an object_id filter. Covers comments removed via deleteComment and via soft user-data deletion. Moderation-actioned comments (removed, hidden, shadow_blocked) remain excluded, as are comments whose parent activity is itself deleted.
15858
16224
  */
15859
16225
  include_soft_deleted_comments?: boolean;
15860
16226
  /**
@@ -16398,9 +16764,22 @@ export interface QueryModerationRulesResponse {
16398
16764
 
16399
16765
  export interface QueryPinnedActivitiesRequest {
16400
16766
  enrich_own_fields?: boolean;
16767
+ /**
16768
+ * When true, return pinned activities even if they have expired. Server-side only; not allowed when a user is set.
16769
+ */
16770
+ include_expired_activities?: boolean;
16771
+ /**
16772
+ * When true, return pinned activities even if moderation hides them (shadowed or removed). Server-side only; not allowed when a user is set.
16773
+ */
16774
+ include_moderated_activities?: boolean;
16775
+ /**
16776
+ * When true, return pinned activities even if they are soft-deleted. Server-side only; not allowed when a user is set.
16777
+ */
16778
+ include_soft_deleted_activities?: boolean;
16401
16779
  limit?: number;
16402
16780
  next?: string;
16403
16781
  prev?: string;
16782
+ user_id?: string;
16404
16783
  /**
16405
16784
  * Sorting parameters for the query
16406
16785
  */
@@ -16409,6 +16788,10 @@ export interface QueryPinnedActivitiesRequest {
16409
16788
  * Filters to apply to the query
16410
16789
  */
16411
16790
  filter?: Record<string, any>;
16791
+ /**
16792
+ * User request object
16793
+ */
16794
+ user?: UserRequest;
16412
16795
  }
16413
16796
 
16414
16797
  export interface QueryPinnedActivitiesResponse {
@@ -16912,6 +17295,10 @@ export interface RankingConfig {
16912
17295
  * Type of ranking algorithm. Required. One of: expression, interest
16913
17296
  */
16914
17297
  type: 'expression' | 'interest';
17298
+ /**
17299
+ * Activities scoring strictly below this value are dropped from the ranked feed. Not supported on aggregated feeds
17300
+ */
17301
+ exclude_below?: number;
16915
17302
  /**
16916
17303
  * Scoring formula. Required when type is 'expression' or 'interest'
16917
17304
  */
@@ -17811,6 +18198,7 @@ export interface ReviewQueueItemResponse {
17811
18198
  */
17812
18199
  confidence_score?: number;
17813
18200
  config_key?: string;
18201
+ country_code?: string;
17814
18202
  /**
17815
18203
  * ID of who created the entity
17816
18204
  */
@@ -17876,6 +18264,69 @@ export interface RevisionHistoryResponse {
17876
18264
  previous_obj_serialized?: Record<string, any>;
17877
18265
  }
17878
18266
 
18267
+ export interface RingAttemptResponse {
18268
+ /**
18269
+ * The application this ring belongs to
18270
+ */
18271
+ app_pk: number;
18272
+ /**
18273
+ * The ID of the call that was rung
18274
+ */
18275
+ call_id: string;
18276
+ /**
18277
+ * The type of the call that was rung
18278
+ */
18279
+ call_type: string;
18280
+ /**
18281
+ * When the ring went out
18282
+ */
18283
+ created_at: Date;
18284
+ /**
18285
+ * When the ring expires, i.e. when the missed call deadline fires
18286
+ */
18287
+ expires_at: Date;
18288
+ /**
18289
+ * The user that started the ring
18290
+ */
18291
+ initiated_by: string;
18292
+ /**
18293
+ * The derived outcome: ringing, answered_some, answered_all, rejected_all, missed_all, cancelled or mixed
18294
+ */
18295
+ outcome: string;
18296
+ /**
18297
+ * The ring, as published in the ring_id of the call.ring event
18298
+ */
18299
+ ring_id: string;
18300
+ /**
18301
+ * The call session that was rung
18302
+ */
18303
+ session_id: string;
18304
+ /**
18305
+ * Why the ring settled: answered, rejected, cancel, timeout, ended or auto_end; empty while it is still ringing
18306
+ */
18307
+ settle_reason: string;
18308
+ /**
18309
+ * The user that settled the ring, or 'server'; empty while it is still ringing
18310
+ */
18311
+ settled_by: string;
18312
+ /**
18313
+ * Opaque context stored on the ring by the caller
18314
+ */
18315
+ custom: Record<string, any>;
18316
+ /**
18317
+ * The rung users, keyed by user ID
18318
+ */
18319
+ targets: Record<string, RingTargetResponse>;
18320
+ /**
18321
+ * When the ring was deleted
18322
+ */
18323
+ deleted_at?: Date;
18324
+ /**
18325
+ * When the outcome left ringing
18326
+ */
18327
+ settled_at?: Date;
18328
+ }
18329
+
17879
18330
  export interface RingCallRequest {
17880
18331
  /**
17881
18332
  * Indicate if call should be video
@@ -17903,6 +18354,37 @@ export interface RingCallResponse {
17903
18354
  ring_id?: string;
17904
18355
  }
17905
18356
 
18357
+ export interface RingDeliveryResponse {
18358
+ /**
18359
+ * The transport the ring was dispatched over: ws, apns_voip, apns or fcm
18360
+ */
18361
+ channel: string;
18362
+ /**
18363
+ * When the ring was dispatched
18364
+ */
18365
+ sent_at: Date;
18366
+ /**
18367
+ * When the device acknowledged the ring; not populated yet
18368
+ */
18369
+ acked_at?: Date;
18370
+ /**
18371
+ * The device the ring was dispatched to, empty for websocket deliveries which fan out to every connection
18372
+ */
18373
+ device_id?: string;
18374
+ /**
18375
+ * When the device displayed the ring; not populated yet
18376
+ */
18377
+ displayed_at?: Date;
18378
+ /**
18379
+ * When the device fetched the call; not populated yet
18380
+ */
18381
+ fetched_at?: Date;
18382
+ /**
18383
+ * When the push provider accepted the dispatch; not populated yet
18384
+ */
18385
+ provider_accepted_at?: Date;
18386
+ }
18387
+
17906
18388
  export interface RingSettings {
17907
18389
  auto_cancel_timeout_ms: number;
17908
18390
  incoming_call_timeout_ms: number;
@@ -17930,6 +18412,31 @@ export interface RingSettingsResponse {
17930
18412
  missed_call_timeout_ms: number;
17931
18413
  }
17932
18414
 
18415
+ export interface RingSettledTarget {
18416
+ state: string;
18417
+ state_at: Date;
18418
+ reason?: string;
18419
+ }
18420
+
18421
+ export interface RingTargetResponse {
18422
+ /**
18423
+ * The reject or cancel reason, empty otherwise
18424
+ */
18425
+ reason: string;
18426
+ /**
18427
+ * The target's state for this ring: pending, accepted, rejected, missed or cancelled
18428
+ */
18429
+ state: string;
18430
+ /**
18431
+ * When the target last changed state
18432
+ */
18433
+ state_at: Date;
18434
+ /**
18435
+ * The dispatches of this ring to the target's devices
18436
+ */
18437
+ deliveries: Array<RingDeliveryResponse>;
18438
+ }
18439
+
17933
18440
  export interface Role {
17934
18441
  /**
17935
18442
  * Date/time of creation
@@ -17988,6 +18495,7 @@ export interface RuleBuilderCondition {
17988
18495
  channel_message_count_rule_params?: ChannelMessageCountRuleParameters;
17989
18496
  closed_caption_rule_params?: ClosedCaptionRuleParameters;
17990
18497
  content_count_rule_params?: ContentCountRuleParameters;
18498
+ content_country_code_params?: ContentCountryCodeParameters;
17991
18499
  content_custom_property_count_params?: ContentCustomPropertyCountParameters;
17992
18500
  content_custom_property_params?: ContentCustomPropertyParameters;
17993
18501
  content_flag_count_rule_params?: FlagCountRuleParameters;
@@ -18796,8 +19304,9 @@ export interface SessionWarningResponse {
18796
19304
 
18797
19305
  export interface SetFeedsRetentionPolicyRequest {
18798
19306
  max_age_hours: number;
18799
- policy: 'old-activities';
19307
+ policy: string;
18800
19308
  enabled?: boolean;
19309
+ feed_groups?: Array<string>;
18801
19310
  }
18802
19311
 
18803
19312
  export interface SetFeedsRetentionPolicyResponse {
@@ -18806,7 +19315,7 @@ export interface SetFeedsRetentionPolicyResponse {
18806
19315
  */
18807
19316
  duration: string;
18808
19317
  enabled: boolean;
18809
- policy: RetentionPolicy;
19318
+ policy: FeedsRetentionPolicy;
18810
19319
  }
18811
19320
 
18812
19321
  export interface SetRetentionPolicyRequest {
@@ -18909,14 +19418,42 @@ export interface SharedLocationResponse {
18909
19418
  }
18910
19419
 
18911
19420
  export interface SharedLocationResponseData {
19421
+ /**
19422
+ * The CID (type:id) of the channel that the location is attached to.
19423
+ */
18912
19424
  channel_cid: string;
19425
+ /**
19426
+ * The date when the location was created.
19427
+ */
18913
19428
  created_at: Date;
19429
+ /**
19430
+ * The ID of the device that created the location.
19431
+ */
18914
19432
  created_by_device_id: string;
19433
+ /**
19434
+ * The latitude of the location.
19435
+ */
18915
19436
  latitude: number;
19437
+ /**
19438
+ * The longitude of the location.
19439
+ */
18916
19440
  longitude: number;
19441
+ /**
19442
+ * The ID of the message that the location is attached to.
19443
+ */
18917
19444
  message_id: string;
19445
+ /**
19446
+ * The date when the location was updated.
19447
+ */
18918
19448
  updated_at: Date;
19449
+ /**
19450
+ * The ID of the user that created the location.
19451
+ */
18919
19452
  user_id: string;
19453
+ /**
19454
+ * The date when the location sharing ends.
19455
+ * If it's empty, it means the location sharing is static instead of live.
19456
+ */
18920
19457
  end_at?: Date;
18921
19458
  /**
18922
19459
  * Represents channel in chat
@@ -19808,6 +20345,7 @@ export interface ThreadedCommentResponse {
19808
20345
  confidence_score: number;
19809
20346
  created_at: Date;
19810
20347
  downvote_count: number;
20348
+ hidden: boolean;
19811
20349
  id: string;
19812
20350
  object_id: string;
19813
20351
  object_type: string;
@@ -20491,14 +21029,32 @@ export interface UnreadCountsBatchResponse {
20491
21029
  }
20492
21030
 
20493
21031
  export interface UnreadCountsChannel {
21032
+ /**
21033
+ * The channel CID (type:id).
21034
+ */
20494
21035
  channel_id: string;
21036
+ /**
21037
+ * The date which the current user last read the channel.
21038
+ */
20495
21039
  last_read: Date;
21040
+ /**
21041
+ * The number of unread messages inside the channel.
21042
+ */
20496
21043
  unread_count: number;
20497
21044
  }
20498
21045
 
20499
21046
  export interface UnreadCountsChannelType {
21047
+ /**
21048
+ * The number of unread channels of this channel type.
21049
+ */
20500
21050
  channel_count: number;
21051
+ /**
21052
+ * The channel type.
21053
+ */
20501
21054
  channel_type: string;
21055
+ /**
21056
+ * The number of unread messages of all the channels with this type.
21057
+ */
20502
21058
  unread_count: number;
20503
21059
  }
20504
21060
 
@@ -20512,9 +21068,21 @@ export interface UnreadCountsResponse {
20512
21068
  }
20513
21069
 
20514
21070
  export interface UnreadCountsThread {
21071
+ /**
21072
+ * The date which the current user last read the thread.
21073
+ */
20515
21074
  last_read: Date;
21075
+ /**
21076
+ * The id of the last reply which the current user read in the thread.
21077
+ */
20516
21078
  last_read_message_id: string;
21079
+ /**
21080
+ * The message id of the root of the thread.
21081
+ */
20517
21082
  parent_message_id: string;
21083
+ /**
21084
+ * The number of unread replies inside the thread.
21085
+ */
20518
21086
  unread_count: number;
20519
21087
  }
20520
21088
 
@@ -22884,6 +23452,9 @@ export interface UserRequest {
22884
23452
  * Custom user data
22885
23453
  */
22886
23454
  custom?: Record<string, any>;
23455
+ /**
23456
+ * The privacy settings of the user.
23457
+ */
22887
23458
  privacy_settings?: PrivacySettingsResponse;
22888
23459
  /**
22889
23460
  * Map of team-specific roles for the user
@@ -22965,6 +23536,9 @@ export interface UserResponse {
22965
23536
  * List of devices user is using
22966
23537
  */
22967
23538
  devices?: Array<DeviceResponse>;
23539
+ /**
23540
+ * The privacy settings of the user.
23541
+ */
22968
23542
  privacy_settings?: PrivacySettingsResponse;
22969
23543
  push_notifications?: PushNotificationSettingsResponse;
22970
23544
  teams_role?: Record<string, string>;
@@ -23010,6 +23584,9 @@ export interface UserResponsePrivacyFields {
23010
23584
  last_active?: Date;
23011
23585
  name?: string;
23012
23586
  revoke_tokens_issued_before?: Date;
23587
+ /**
23588
+ * The privacy settings of the user.
23589
+ */
23013
23590
  privacy_settings?: PrivacySettingsResponse;
23014
23591
  teams_role?: Record<string, string>;
23015
23592
  }
@@ -23273,6 +23850,7 @@ export type WHEvent =
23273
23850
  | ({ type: 'call.recording_stopped' } & CallRecordingStoppedEvent)
23274
23851
  | ({ type: 'call.rejected' } & CallRejectedEvent)
23275
23852
  | ({ type: 'call.ring' } & CallRingEvent)
23853
+ | ({ type: 'call.ring_settled' } & CallRingSettledEvent)
23276
23854
  | ({ type: 'call.rtmp_broadcast_failed' } & CallRtmpBroadcastFailedEvent)
23277
23855
  | ({ type: 'call.rtmp_broadcast_started' } & CallRtmpBroadcastStartedEvent)
23278
23856
  | ({ type: 'call.rtmp_broadcast_stopped' } & CallRtmpBroadcastStoppedEvent)
@@ -23318,6 +23896,8 @@ export type WHEvent =
23318
23896
  } & AsyncBulkImageModerationEvent)
23319
23897
  | ({ type: 'export.channels.error' } & AsyncExportErrorEvent)
23320
23898
  | ({ type: 'export.channels.success' } & AsyncExportChannelsEvent)
23899
+ | ({ type: 'export.label_results.error' } & AsyncExportErrorEvent)
23900
+ | ({ type: 'export.label_results.success' } & AsyncExportLabelResultsEvent)
23321
23901
  | ({ type: 'export.moderation_logs.error' } & AsyncExportErrorEvent)
23322
23902
  | ({
23323
23903
  type: 'export.moderation_logs.success';
@@ -23347,6 +23927,7 @@ export type WHEvent =
23347
23927
  | ({ type: 'feeds.bookmark_folder.updated' } & BookmarkFolderUpdatedEvent)
23348
23928
  | ({ type: 'feeds.comment.added' } & CommentAddedEvent)
23349
23929
  | ({ type: 'feeds.comment.deleted' } & CommentDeletedEvent)
23930
+ | ({ type: 'feeds.comment.feedback' } & CommentFeedbackEvent)
23350
23931
  | ({ type: 'feeds.comment.reaction.added' } & CommentReactionAddedEvent)
23351
23932
  | ({ type: 'feeds.comment.reaction.deleted' } & CommentReactionDeletedEvent)
23352
23933
  | ({ type: 'feeds.comment.reaction.updated' } & CommentReactionUpdatedEvent)
@@ -23367,6 +23948,8 @@ export type WHEvent =
23367
23948
  | ({ type: 'feeds.notification_feed.updated' } & NotificationFeedUpdatedEvent)
23368
23949
  | ({ type: 'feeds.stories_feed.updated' } & StoriesFeedUpdatedEvent)
23369
23950
  | ({ type: 'flag.updated' } & FlagUpdatedEvent)
23951
+ | ({ type: 'import.error' } & AsyncImportErrorEvent)
23952
+ | ({ type: 'import.success' } & AsyncImportSuccessEvent)
23370
23953
  | ({ type: 'ingress.error' } & IngressErrorEvent)
23371
23954
  | ({ type: 'ingress.started' } & IngressStartedEvent)
23372
23955
  | ({ type: 'ingress.stopped' } & IngressStoppedEvent)
@@ -23448,6 +24031,9 @@ export interface WSEvent {
23448
24031
  thread_id?: string;
23449
24032
  user_id?: string;
23450
24033
  watcher_count?: number;
24034
+ /**
24035
+ * Response from AI moderation
24036
+ */
23451
24037
  automoderation_scores?: ModerationResponse;
23452
24038
  /**
23453
24039
  * Represents channel in chat
@@ -23492,11 +24078,29 @@ export interface WrappedUnreadCountsResponse {
23492
24078
  * Duration of the request in milliseconds
23493
24079
  */
23494
24080
  duration: string;
24081
+ /**
24082
+ * The total number of unread messages.
24083
+ */
23495
24084
  total_unread_count: number;
24085
+ /**
24086
+ * The total number of unread threads.
24087
+ */
23496
24088
  total_unread_threads_count: number;
24089
+ /**
24090
+ * The unread information per channel type.
24091
+ */
23497
24092
  channel_type: Array<UnreadCountsChannelType>;
24093
+ /**
24094
+ * The unread information per channel.
24095
+ */
23498
24096
  channels: Array<UnreadCountsChannel>;
24097
+ /**
24098
+ * The unread information per thread.
24099
+ */
23499
24100
  threads: Array<UnreadCountsThread>;
24101
+ /**
24102
+ * The total number of unread messages grouped by team.
24103
+ */
23500
24104
  total_unread_count_by_team?: Record<string, number>;
23501
24105
  }
23502
24106