@stream-io/node-sdk 0.8.11 → 0.8.13

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,11 +1,30 @@
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
  export interface AIAudioConfigResponse {
14
+ /**
15
+ * Whether the engine selected by the application's LLM configurability flag has a rule that does something. Derived, not stored
16
+ */
6
17
  enabled: boolean;
18
+ /**
19
+ * Bodyguard credentials profile transcripts are classified with. Applies to the NLP engine only
20
+ */
7
21
  profile: string;
22
+ /**
23
+ * 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
24
+ */
8
25
  rules: Array<BodyguardRule>;
26
+ ai_text_config?: AITextConfig;
27
+ llm_config?: LLMConfig;
9
28
  }
10
29
  export interface AIImageConfig {
11
30
  async?: boolean;
@@ -834,6 +853,10 @@ export interface ActivitySelectorConfig {
834
853
  * 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
835
854
  */
836
855
  ranking_candidate_limit?: number;
856
+ /**
857
+ * 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
858
+ */
859
+ time_budget_ms?: number;
837
860
  /**
838
861
  * Sort parameters for activity selection
839
862
  */
@@ -866,6 +889,10 @@ export interface ActivitySelectorConfigResponse {
866
889
  * Maximum number of candidate activities this selector contributes to a ranked feed
867
890
  */
868
891
  ranking_candidate_limit?: number;
892
+ /**
893
+ * Maximum time in milliseconds this selector may take before it is dropped from the read
894
+ */
895
+ time_budget_ms?: number;
869
896
  /**
870
897
  * Sort parameters for activity selection
871
898
  */
@@ -1363,7 +1390,7 @@ export interface AggregationConfig {
1363
1390
  */
1364
1391
  format?: string;
1365
1392
  /**
1366
- * Maximum number of activities kept in each aggregated group. Omit to use the default of 100. Must be between 1 and 100 when set.
1393
+ * 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.
1367
1394
  */
1368
1395
  group_size?: number;
1369
1396
  /**
@@ -1487,7 +1514,13 @@ export interface AnalyzeTextField {
1487
1514
  }
1488
1515
  export interface AppResponseFields {
1489
1516
  allow_multi_user_devices: boolean;
1517
+ /**
1518
+ * A boolean value determining if async url enrichment is enabled.
1519
+ */
1490
1520
  async_url_enrich_enabled: boolean;
1521
+ /**
1522
+ * A boolean value determining if auto translation is enabled.
1523
+ */
1491
1524
  auto_translation_enabled: boolean;
1492
1525
  before_message_send_hook_system_messages: boolean;
1493
1526
  campaign_enabled: boolean;
@@ -1512,6 +1545,9 @@ export interface AppResponseFields {
1512
1545
  moderation_video_call_moderation_enabled: boolean;
1513
1546
  moderation_webhook_url: string;
1514
1547
  multi_tenant_enabled: boolean;
1548
+ /**
1549
+ * The name of the app.
1550
+ */
1515
1551
  name: string;
1516
1552
  organization: string;
1517
1553
  permission_version: string;
@@ -1731,6 +1767,16 @@ export interface AsyncExportErrorEvent {
1731
1767
  type: string;
1732
1768
  received_at?: Date;
1733
1769
  }
1770
+ export interface AsyncExportLabelResultsEvent {
1771
+ created_at: Date;
1772
+ finished_at: Date;
1773
+ started_at: Date;
1774
+ task_id: string;
1775
+ url: string;
1776
+ custom: Record<string, any>;
1777
+ type: string;
1778
+ received_at?: Date;
1779
+ }
1734
1780
  export interface AsyncExportModerationLogsEvent {
1735
1781
  created_at: Date;
1736
1782
  finished_at: Date;
@@ -1761,6 +1807,29 @@ export interface AsyncExportUsersEvent {
1761
1807
  type: string;
1762
1808
  received_at?: Date;
1763
1809
  }
1810
+ export interface AsyncImportErrorEvent {
1811
+ created_at: Date;
1812
+ error: string;
1813
+ finished_at: Date;
1814
+ product: string;
1815
+ state: string;
1816
+ task_id: string;
1817
+ custom: Record<string, any>;
1818
+ type: string;
1819
+ received_at?: Date;
1820
+ started_at?: Date;
1821
+ }
1822
+ export interface AsyncImportSuccessEvent {
1823
+ created_at: Date;
1824
+ finished_at: Date;
1825
+ product: string;
1826
+ state: string;
1827
+ task_id: string;
1828
+ custom: Record<string, any>;
1829
+ type: string;
1830
+ received_at?: Date;
1831
+ started_at?: Date;
1832
+ }
1764
1833
  export interface AsyncModerationCallbackConfig {
1765
1834
  mode?: 'CALLBACK_MODE_NONE' | 'CALLBACK_MODE_REST' | 'CALLBACK_MODE_TWIRP';
1766
1835
  server_url?: string;
@@ -1982,6 +2051,10 @@ export interface BanRequest {
1982
2051
  * ID of the user to ban
1983
2052
  */
1984
2053
  target_user_id: string;
2054
+ /**
2055
+ * Whether to also ban the user from future channels created by the banner
2056
+ */
2057
+ ban_from_future_channels?: boolean;
1985
2058
  /**
1986
2059
  * ID of the user performing the ban
1987
2060
  */
@@ -1991,6 +2064,10 @@ export interface BanRequest {
1991
2064
  */
1992
2065
  channel_cid?: string;
1993
2066
  delete_messages?: 'soft' | 'pruning' | 'hard';
2067
+ /**
2068
+ * Whether to delete reactions by the banned user on other users' messages
2069
+ */
2070
+ delete_reactions?: boolean;
1994
2071
  /**
1995
2072
  * Whether to ban the user's IP address
1996
2073
  */
@@ -2124,7 +2201,7 @@ export interface BlockListResponse {
2124
2201
  */
2125
2202
  name: string;
2126
2203
  /**
2127
- * Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word
2204
+ * Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word, word_allowlist
2128
2205
  */
2129
2206
  type: string;
2130
2207
  /**
@@ -3213,6 +3290,50 @@ export interface CallRingEvent {
3213
3290
  */
3214
3291
  ring_id?: string;
3215
3292
  }
3293
+ export interface CallRingSettledEvent {
3294
+ call_cid: string;
3295
+ created_at: Date;
3296
+ /**
3297
+ * ID of the user who rang
3298
+ */
3299
+ initiated_by: string;
3300
+ /**
3301
+ * Final outcome of the ring: answered_all, answered_some, rejected_all, missed_all, cancelled or mixed
3302
+ */
3303
+ outcome: string;
3304
+ /**
3305
+ * When the ring was sent
3306
+ */
3307
+ rang_at: Date;
3308
+ /**
3309
+ * Identifies this ring of the call session, as carried on call.ring
3310
+ */
3311
+ ring_id: string;
3312
+ /**
3313
+ * Call session ID
3314
+ */
3315
+ session_id: string;
3316
+ /**
3317
+ * Why the ring closed: answered, rejected, cancel, timeout, ended or auto_end
3318
+ */
3319
+ settle_reason: string;
3320
+ /**
3321
+ * When the outcome left ringing
3322
+ */
3323
+ settled_at: Date;
3324
+ /**
3325
+ * ID of the user whose action closed the ring, or 'server' for the missed-call deadline and automatic ends
3326
+ */
3327
+ settled_by: string;
3328
+ /**
3329
+ * Final state of every rung user, keyed by user ID
3330
+ */
3331
+ targets: Record<string, RingSettledTarget>;
3332
+ /**
3333
+ * The type of event: "call.ring_settled" in this case
3334
+ */
3335
+ type: string;
3336
+ }
3216
3337
  export interface CallRtmpBroadcastFailedEvent {
3217
3338
  /**
3218
3339
  * The unique identifier for a call (<type>:<id>)
@@ -4505,7 +4626,13 @@ export declare const ChannelOwnCapability: {
4505
4626
  };
4506
4627
  export type ChannelOwnCapability = (typeof ChannelOwnCapability)[keyof typeof ChannelOwnCapability];
4507
4628
  export interface ChannelPushPreferencesResponse {
4629
+ /**
4630
+ * The scope level of the push notifications.
4631
+ */
4508
4632
  chat_level?: string;
4633
+ /**
4634
+ * If provided the notifications will be disabled until the set date.
4635
+ */
4509
4636
  disabled_until?: Date;
4510
4637
  chat_preferences?: ChatPreferencesResponse;
4511
4638
  }
@@ -4636,6 +4763,9 @@ export interface ChannelStateResponse {
4636
4763
  channel?: ChannelResponse;
4637
4764
  draft?: DraftResponse;
4638
4765
  membership?: ChannelMemberResponse;
4766
+ /**
4767
+ * The push preference details.
4768
+ */
4639
4769
  push_preferences?: ChannelPushPreferencesResponse;
4640
4770
  }
4641
4771
  export interface ChannelStateResponseFields {
@@ -4686,6 +4816,9 @@ export interface ChannelStateResponseFields {
4686
4816
  channel?: ChannelResponse;
4687
4817
  draft?: DraftResponse;
4688
4818
  membership?: ChannelMemberResponse;
4819
+ /**
4820
+ * The push preference details.
4821
+ */
4689
4822
  push_preferences?: ChannelPushPreferencesResponse;
4690
4823
  }
4691
4824
  export interface ChannelTruncatedEvent {
@@ -5085,6 +5218,35 @@ export interface CheckExternalStorageResponse {
5085
5218
  duration: string;
5086
5219
  file_url: string;
5087
5220
  }
5221
+ export interface CheckGCPPubSubRequest {
5222
+ /**
5223
+ * Publish the test message with an ordering key through the regional endpoint, as a hook with ordering enabled would; requires gcp_pubsub_region
5224
+ */
5225
+ gcp_pubsub_event_based_ordering_key_enabled?: boolean;
5226
+ /**
5227
+ * GCP region used for the regional Pub/Sub endpoint when ordering is enabled
5228
+ */
5229
+ gcp_pubsub_region?: string;
5230
+ /**
5231
+ * Fully qualified GCP Pub/Sub topic name (projects/{project}/topics/{topic})
5232
+ */
5233
+ gcp_pubsub_topic?: string;
5234
+ }
5235
+ export interface CheckGCPPubSubResponse {
5236
+ duration: string;
5237
+ /**
5238
+ * Validation result. One of: ok, error
5239
+ */
5240
+ status: string;
5241
+ /**
5242
+ * Error text
5243
+ */
5244
+ error?: string;
5245
+ /**
5246
+ * Error data
5247
+ */
5248
+ data?: Record<string, any>;
5249
+ }
5088
5250
  export interface CheckPushRequest {
5089
5251
  /**
5090
5252
  * Push message template for APN
@@ -5568,6 +5730,64 @@ export interface CommentDeletedEvent {
5568
5730
  received_at?: Date;
5569
5731
  user?: UserResponseCommonFields;
5570
5732
  }
5733
+ export interface CommentFeedbackEvent {
5734
+ /**
5735
+ * Date/time of creation
5736
+ */
5737
+ created_at: Date;
5738
+ comment_feedback: CommentFeedbackEventPayload;
5739
+ custom: Record<string, any>;
5740
+ /**
5741
+ * The type of event: "feeds.comment.feedback" in this case
5742
+ */
5743
+ type: string;
5744
+ received_at?: Date;
5745
+ user?: UserResponseCommonFields;
5746
+ }
5747
+ export interface CommentFeedbackEventPayload {
5748
+ /**
5749
+ * The comment that received feedback
5750
+ */
5751
+ comment_id: string;
5752
+ /**
5753
+ * When the feedback was created
5754
+ */
5755
+ created_at: Date;
5756
+ /**
5757
+ * Whether the comment is hidden for the user
5758
+ */
5759
+ hide: boolean;
5760
+ /**
5761
+ * When the feedback was last updated
5762
+ */
5763
+ updated_at: Date;
5764
+ /**
5765
+ * User response object
5766
+ */
5767
+ user: UserResponse;
5768
+ }
5769
+ export interface CommentFeedbackRequest {
5770
+ /**
5771
+ * Whether to hide this comment for the user
5772
+ */
5773
+ hide?: boolean;
5774
+ user_id?: string;
5775
+ /**
5776
+ * User request object
5777
+ */
5778
+ user?: UserRequest;
5779
+ }
5780
+ export interface CommentFeedbackResponse {
5781
+ /**
5782
+ * The ID of the comment that received feedback
5783
+ */
5784
+ comment_id: string;
5785
+ duration: string;
5786
+ /**
5787
+ * Whether the comment is hidden for the user
5788
+ */
5789
+ hide: boolean;
5790
+ }
5571
5791
  export interface CommentReactionAddedEvent {
5572
5792
  /**
5573
5793
  * Date/time of creation
@@ -5634,6 +5854,10 @@ export interface CommentResponse {
5634
5854
  * Number of downvotes for this comment
5635
5855
  */
5636
5856
  downvote_count: number;
5857
+ /**
5858
+ * Only true in QueryComments results filtered with hidden: true
5859
+ */
5860
+ hidden: boolean;
5637
5861
  /**
5638
5862
  * Unique identifier for the comment
5639
5863
  */
@@ -5880,6 +6104,10 @@ export interface ContentCountRuleParameters {
5880
6104
  threshold?: number;
5881
6105
  time_window?: string;
5882
6106
  }
6107
+ export interface ContentCountryCodeParameters {
6108
+ operator?: string;
6109
+ country_codes?: Array<string>;
6110
+ }
5883
6111
  export interface ContentCustomPropertyCountParameters {
5884
6112
  operator?: string;
5885
6113
  property_key?: string;
@@ -5924,9 +6152,9 @@ export interface CreateBlockListRequest {
5924
6152
  is_substring_matching_enabled?: boolean;
5925
6153
  team?: string;
5926
6154
  /**
5927
- * Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word
6155
+ * Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word, word_allowlist
5928
6156
  */
5929
- type?: 'regex' | 'domain' | 'domain_allowlist' | 'email' | 'email_allowlist' | 'word';
6157
+ type?: 'regex' | 'domain' | 'domain_allowlist' | 'email' | 'email_allowlist' | 'word' | 'word_allowlist';
5930
6158
  user_id?: string;
5931
6159
  /**
5932
6160
  * User request object
@@ -6584,6 +6812,9 @@ export interface CreatePollRequest {
6584
6812
  max_votes_allowed?: number;
6585
6813
  team?: string;
6586
6814
  user_id?: string;
6815
+ /**
6816
+ * Represents the visibility of votes in a poll.
6817
+ */
6587
6818
  voting_visibility?: 'anonymous' | 'public';
6588
6819
  options?: Array<PollOptionInput>;
6589
6820
  /**
@@ -7202,7 +7433,7 @@ export interface DeleteFeedsBatchResponse {
7202
7433
  task_id: string;
7203
7434
  }
7204
7435
  export interface DeleteFeedsRetentionPolicyRequest {
7205
- policy: 'old-activities';
7436
+ policy: string;
7206
7437
  }
7207
7438
  export interface DeleteFeedsRetentionPolicyResponse {
7208
7439
  /**
@@ -7477,11 +7708,11 @@ export interface DeviceErrorInfo {
7477
7708
  }
7478
7709
  export interface DeviceResponse {
7479
7710
  /**
7480
- * Date/time of creation
7711
+ * The date when the device was created.
7481
7712
  */
7482
7713
  created_at: Date;
7483
7714
  /**
7484
- * Device ID
7715
+ * The device identifier.
7485
7716
  */
7486
7717
  id: string;
7487
7718
  /**
@@ -7840,6 +8071,9 @@ export interface EntityCreatorResponse {
7840
8071
  name?: string;
7841
8072
  revoke_tokens_issued_before?: Date;
7842
8073
  devices?: Array<DeviceResponse>;
8074
+ /**
8075
+ * The privacy settings of the user.
8076
+ */
7843
8077
  privacy_settings?: PrivacySettingsResponse;
7844
8078
  push_notifications?: PushNotificationSettingsResponse;
7845
8079
  teams_role?: Record<string, string>;
@@ -7872,6 +8106,10 @@ export interface EscalationMetadata {
7872
8106
  export interface EventHook {
7873
8107
  created_at?: Date;
7874
8108
  enabled?: boolean;
8109
+ gcp_pubsub_auth_type?: string;
8110
+ gcp_pubsub_event_based_ordering_key_enabled?: boolean;
8111
+ gcp_pubsub_region?: string;
8112
+ gcp_pubsub_topic?: string;
7875
8113
  hook_type?: string;
7876
8114
  id?: string;
7877
8115
  product?: string;
@@ -8683,6 +8921,10 @@ export interface FeedsNotificationTrigger {
8683
8921
  comment?: FeedsNotificationComment;
8684
8922
  custom?: Record<string, any>;
8685
8923
  }
8924
+ export interface FeedsPolicyConfig {
8925
+ max_age_hours: number;
8926
+ feed_groups?: Array<string>;
8927
+ }
8686
8928
  export interface FeedsPreferences {
8687
8929
  /**
8688
8930
  * Push notification preference for comments on user's activities. One of: all, none
@@ -8744,6 +8986,12 @@ export interface FeedsReactionResponse {
8744
8986
  comment_id?: string;
8745
8987
  custom?: Record<string, any>;
8746
8988
  }
8989
+ export interface FeedsRetentionPolicy {
8990
+ app_pk: number;
8991
+ enabled_at: Date;
8992
+ policy: string;
8993
+ config: FeedsPolicyConfig;
8994
+ }
8747
8995
  export interface FeedsRetentionRunResponse {
8748
8996
  app_pk: number;
8749
8997
  date: string;
@@ -8818,6 +9066,7 @@ export interface FeedsV3CommentResponse {
8818
9066
  confidence_score: number;
8819
9067
  created_at: Date;
8820
9068
  downvote_count: number;
9069
+ hidden: boolean;
8821
9070
  id: string;
8822
9071
  object_id: string;
8823
9072
  object_type: string;
@@ -8887,6 +9136,10 @@ export interface FilterConfigResponse {
8887
9136
  * 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.
8888
9137
  */
8889
9138
  ai_image_labels?: Array<string>;
9139
+ /**
9140
+ * 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.
9141
+ */
9142
+ ai_image_ocr_labels?: Array<string>;
8890
9143
  /**
8891
9144
  * AI text moderation labels available as filter values
8892
9145
  */
@@ -9279,6 +9532,9 @@ export interface FullUserResponse {
9279
9532
  name?: string;
9280
9533
  revoke_tokens_issued_before?: Date;
9281
9534
  latest_hidden_channels?: Array<string>;
9535
+ /**
9536
+ * The privacy settings of the user.
9537
+ */
9282
9538
  privacy_settings?: PrivacySettingsResponse;
9283
9539
  teams_role?: Record<string, string>;
9284
9540
  }
@@ -9344,6 +9600,9 @@ export interface GetApplicationResponse {
9344
9600
  * Duration of the request in milliseconds
9345
9601
  */
9346
9602
  duration: string;
9603
+ /**
9604
+ * A type representing the app settings.
9605
+ */
9347
9606
  app: AppResponseFields;
9348
9607
  }
9349
9608
  export interface GetBlockListResponse {
@@ -9656,7 +9915,7 @@ export interface GetFeedsRetentionPolicyResponse {
9656
9915
  */
9657
9916
  duration: string;
9658
9917
  enabled: boolean;
9659
- policies: Array<RetentionPolicy>;
9918
+ policies: Array<FeedsRetentionPolicy>;
9660
9919
  }
9661
9920
  export interface GetFeedsRetentionPolicyRunsRequest {
9662
9921
  limit?: number;
@@ -9879,6 +10138,10 @@ export interface GetOrCreateFeedRequest {
9879
10138
  user_id?: string;
9880
10139
  view?: string;
9881
10140
  watch?: boolean;
10141
+ /**
10142
+ * 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.
10143
+ */
10144
+ discard_actors?: Array<string>;
9882
10145
  data?: FeedInput;
9883
10146
  /**
9884
10147
  * Options to skip specific enrichments to improve performance. Default is false (enrichments are included). Setting a field to true skips that enrichment.
@@ -9898,6 +10161,7 @@ export interface GetOrCreateFeedRequest {
9898
10161
  * User request object
9899
10162
  */
9900
10163
  user?: UserRequest;
10164
+ viewer_location?: Location;
9901
10165
  }
9902
10166
  export interface GetOrCreateFeedResponse {
9903
10167
  created: boolean;
@@ -9914,6 +10178,10 @@ export interface GetOrCreateFeedResponse {
9914
10178
  feed: FeedResponse;
9915
10179
  next?: string;
9916
10180
  prev?: string;
10181
+ /**
10182
+ * 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
10183
+ */
10184
+ degraded_selectors?: Array<string>;
9917
10185
  followers_pagination?: PagerResponse;
9918
10186
  following_pagination?: PagerResponse;
9919
10187
  member_pagination?: PagerResponse;
@@ -11499,6 +11767,9 @@ export interface MemberUserRequest {
11499
11767
  role?: string;
11500
11768
  teams?: Array<string>;
11501
11769
  custom?: Record<string, any>;
11770
+ /**
11771
+ * The privacy settings of the user.
11772
+ */
11502
11773
  privacy_settings?: PrivacySettingsResponse;
11503
11774
  teams_role?: Record<string, string>;
11504
11775
  }
@@ -11762,6 +12033,9 @@ export interface MessageModerationResult {
11762
12033
  * User who moderated the message
11763
12034
  */
11764
12035
  moderated_by?: string;
12036
+ /**
12037
+ * Response from AI moderation
12038
+ */
11765
12039
  ai_moderation_response?: ModerationResponse;
11766
12040
  /**
11767
12041
  * Sets thresholds for AI moderation
@@ -12835,9 +13109,21 @@ export interface ModerationQueueResponse {
12835
13109
  filters: Record<string, any>;
12836
13110
  }
12837
13111
  export interface ModerationResponse {
13112
+ /**
13113
+ * Action taken by automod
13114
+ */
12838
13115
  action: string;
13116
+ /**
13117
+ * Explicit score
13118
+ */
12839
13119
  explicit: number;
13120
+ /**
13121
+ * Spam score
13122
+ */
12840
13123
  spam: number;
13124
+ /**
13125
+ * Toxicity score
13126
+ */
12841
13127
  toxic: number;
12842
13128
  }
12843
13129
  export interface ModerationRuleInfo {
@@ -13414,7 +13700,13 @@ export interface OwnUserResponse {
13414
13700
  revoke_tokens_issued_before?: Date;
13415
13701
  blocked_user_ids?: Array<string>;
13416
13702
  latest_hidden_channels?: Array<string>;
13703
+ /**
13704
+ * The privacy settings of the user.
13705
+ */
13417
13706
  privacy_settings?: PrivacySettingsResponse;
13707
+ /**
13708
+ * The push preference details.
13709
+ */
13418
13710
  push_preferences?: PushPreferencesResponse;
13419
13711
  teams_role?: Record<string, string>;
13420
13712
  total_unread_count_by_team?: Record<string, number>;
@@ -13986,8 +14278,17 @@ export interface PredefinedFilterStatsResponse {
13986
14278
  last_seen?: Date;
13987
14279
  }
13988
14280
  export interface PrivacySettingsResponse {
14281
+ /**
14282
+ * The settings for the delivery receipt events.
14283
+ */
13989
14284
  delivery_receipts?: DeliveryReceiptsResponse;
14285
+ /**
14286
+ * The settings for the read receipt events.
14287
+ */
13990
14288
  read_receipts?: ReadReceiptsResponse;
14289
+ /**
14290
+ * The settings for typing indicator events.
14291
+ */
13991
14292
  typing_indicators?: TypingIndicatorsResponse;
13992
14293
  }
13993
14294
  export interface PublishedTrackFlags {
@@ -14103,7 +14404,13 @@ export interface PushPreferenceInput {
14103
14404
  }
14104
14405
  export interface PushPreferencesResponse {
14105
14406
  call_level?: string;
14407
+ /**
14408
+ * The scope level of the push notifications.
14409
+ */
14106
14410
  chat_level?: string;
14411
+ /**
14412
+ * If provided the notifications will be disabled until the set date.
14413
+ */
14107
14414
  disabled_until?: Date;
14108
14415
  feeds_level?: string;
14109
14416
  chat_preferences?: ChatPreferencesResponse;
@@ -14527,6 +14834,46 @@ export interface QueryCallParticipantsResponse {
14527
14834
  */
14528
14835
  call: CallResponse;
14529
14836
  }
14837
+ export interface QueryCallRingAttemptsRequest {
14838
+ /**
14839
+ * Call ID
14840
+ */
14841
+ id: string;
14842
+ /**
14843
+ * The type of call
14844
+ */
14845
+ type: string;
14846
+ /**
14847
+ * Limit the attempts to one call session; omit to read every session of the call
14848
+ */
14849
+ call_session_id?: string;
14850
+ }
14851
+ export interface QueryCallRingAttemptsResponse {
14852
+ /**
14853
+ * The ID of the call the attempts belong to
14854
+ */
14855
+ call_id: string;
14856
+ /**
14857
+ * The type of the call the attempts belong to
14858
+ */
14859
+ call_type: string;
14860
+ /**
14861
+ * The number of attempts returned
14862
+ */
14863
+ count: number;
14864
+ /**
14865
+ * Duration of the request in milliseconds
14866
+ */
14867
+ duration: string;
14868
+ /**
14869
+ * The attempts, newest first
14870
+ */
14871
+ ring_attempts: Array<RingAttemptResponse>;
14872
+ /**
14873
+ * The call session the attempts were limited to, null when every session was read
14874
+ */
14875
+ call_session_id?: string;
14876
+ }
14530
14877
  export interface QueryCallSessionParticipantStatsResponse {
14531
14878
  call_id: string;
14532
14879
  call_session_id: string;
@@ -14782,7 +15129,7 @@ export interface QueryCommentsRequest {
14782
15129
  */
14783
15130
  id_around?: string;
14784
15131
  /**
14785
- * 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.
15132
+ * 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.
14786
15133
  */
14787
15134
  include_soft_deleted_comments?: boolean;
14788
15135
  /**
@@ -15771,6 +16118,10 @@ export interface RankingConfig {
15771
16118
  * Type of ranking algorithm. Required. One of: expression, interest
15772
16119
  */
15773
16120
  type: 'expression' | 'interest';
16121
+ /**
16122
+ * Activities scoring strictly below this value are dropped from the ranked feed. Not supported on aggregated feeds
16123
+ */
16124
+ exclude_below?: number;
15774
16125
  /**
15775
16126
  * Scoring formula. Required when type is 'expression' or 'interest'
15776
16127
  */
@@ -16604,6 +16955,7 @@ export interface ReviewQueueItemResponse {
16604
16955
  */
16605
16956
  confidence_score?: number;
16606
16957
  config_key?: string;
16958
+ country_code?: string;
16607
16959
  /**
16608
16960
  * ID of who created the entity
16609
16961
  */
@@ -16666,6 +17018,68 @@ export interface RevisionHistoryResponse {
16666
17018
  changed_fields?: Array<string>;
16667
17019
  previous_obj_serialized?: Record<string, any>;
16668
17020
  }
17021
+ export interface RingAttemptResponse {
17022
+ /**
17023
+ * The application this ring belongs to
17024
+ */
17025
+ app_pk: number;
17026
+ /**
17027
+ * The ID of the call that was rung
17028
+ */
17029
+ call_id: string;
17030
+ /**
17031
+ * The type of the call that was rung
17032
+ */
17033
+ call_type: string;
17034
+ /**
17035
+ * When the ring went out
17036
+ */
17037
+ created_at: Date;
17038
+ /**
17039
+ * When the ring expires, i.e. when the missed call deadline fires
17040
+ */
17041
+ expires_at: Date;
17042
+ /**
17043
+ * The user that started the ring
17044
+ */
17045
+ initiated_by: string;
17046
+ /**
17047
+ * The derived outcome: ringing, answered_some, answered_all, rejected_all, missed_all, cancelled or mixed
17048
+ */
17049
+ outcome: string;
17050
+ /**
17051
+ * The ring, as published in the ring_id of the call.ring event
17052
+ */
17053
+ ring_id: string;
17054
+ /**
17055
+ * The call session that was rung
17056
+ */
17057
+ session_id: string;
17058
+ /**
17059
+ * Why the ring settled: answered, rejected, cancel, timeout, ended or auto_end; empty while it is still ringing
17060
+ */
17061
+ settle_reason: string;
17062
+ /**
17063
+ * The user that settled the ring, or 'server'; empty while it is still ringing
17064
+ */
17065
+ settled_by: string;
17066
+ /**
17067
+ * Opaque context stored on the ring by the caller
17068
+ */
17069
+ custom: Record<string, any>;
17070
+ /**
17071
+ * The rung users, keyed by user ID
17072
+ */
17073
+ targets: Record<string, RingTargetResponse>;
17074
+ /**
17075
+ * When the ring was deleted
17076
+ */
17077
+ deleted_at?: Date;
17078
+ /**
17079
+ * When the outcome left ringing
17080
+ */
17081
+ settled_at?: Date;
17082
+ }
16669
17083
  export interface RingCallRequest {
16670
17084
  /**
16671
17085
  * Indicate if call should be video
@@ -16691,6 +17105,36 @@ export interface RingCallResponse {
16691
17105
  */
16692
17106
  ring_id?: string;
16693
17107
  }
17108
+ export interface RingDeliveryResponse {
17109
+ /**
17110
+ * The transport the ring was dispatched over: ws, apns_voip, apns or fcm
17111
+ */
17112
+ channel: string;
17113
+ /**
17114
+ * When the ring was dispatched
17115
+ */
17116
+ sent_at: Date;
17117
+ /**
17118
+ * When the device acknowledged the ring; not populated yet
17119
+ */
17120
+ acked_at?: Date;
17121
+ /**
17122
+ * The device the ring was dispatched to, empty for websocket deliveries which fan out to every connection
17123
+ */
17124
+ device_id?: string;
17125
+ /**
17126
+ * When the device displayed the ring; not populated yet
17127
+ */
17128
+ displayed_at?: Date;
17129
+ /**
17130
+ * When the device fetched the call; not populated yet
17131
+ */
17132
+ fetched_at?: Date;
17133
+ /**
17134
+ * When the push provider accepted the dispatch; not populated yet
17135
+ */
17136
+ provider_accepted_at?: Date;
17137
+ }
16694
17138
  export interface RingSettings {
16695
17139
  auto_cancel_timeout_ms: number;
16696
17140
  incoming_call_timeout_ms: number;
@@ -16715,6 +17159,29 @@ export interface RingSettingsResponse {
16715
17159
  incoming_call_timeout_ms: number;
16716
17160
  missed_call_timeout_ms: number;
16717
17161
  }
17162
+ export interface RingSettledTarget {
17163
+ state: string;
17164
+ state_at: Date;
17165
+ reason?: string;
17166
+ }
17167
+ export interface RingTargetResponse {
17168
+ /**
17169
+ * The reject or cancel reason, empty otherwise
17170
+ */
17171
+ reason: string;
17172
+ /**
17173
+ * The target's state for this ring: pending, accepted, rejected, missed or cancelled
17174
+ */
17175
+ state: string;
17176
+ /**
17177
+ * When the target last changed state
17178
+ */
17179
+ state_at: Date;
17180
+ /**
17181
+ * The dispatches of this ring to the target's devices
17182
+ */
17183
+ deliveries: Array<RingDeliveryResponse>;
17184
+ }
16718
17185
  export interface Role {
16719
17186
  /**
16720
17187
  * Date/time of creation
@@ -16754,6 +17221,7 @@ export interface RuleBuilderCondition {
16754
17221
  channel_message_count_rule_params?: ChannelMessageCountRuleParameters;
16755
17222
  closed_caption_rule_params?: ClosedCaptionRuleParameters;
16756
17223
  content_count_rule_params?: ContentCountRuleParameters;
17224
+ content_country_code_params?: ContentCountryCodeParameters;
16757
17225
  content_custom_property_count_params?: ContentCustomPropertyCountParameters;
16758
17226
  content_custom_property_params?: ContentCustomPropertyParameters;
16759
17227
  content_flag_count_rule_params?: FlagCountRuleParameters;
@@ -17508,8 +17976,9 @@ export interface SessionWarningResponse {
17508
17976
  }
17509
17977
  export interface SetFeedsRetentionPolicyRequest {
17510
17978
  max_age_hours: number;
17511
- policy: 'old-activities';
17979
+ policy: string;
17512
17980
  enabled?: boolean;
17981
+ feed_groups?: Array<string>;
17513
17982
  }
17514
17983
  export interface SetFeedsRetentionPolicyResponse {
17515
17984
  /**
@@ -17517,7 +17986,7 @@ export interface SetFeedsRetentionPolicyResponse {
17517
17986
  */
17518
17987
  duration: string;
17519
17988
  enabled: boolean;
17520
- policy: RetentionPolicy;
17989
+ policy: FeedsRetentionPolicy;
17521
17990
  }
17522
17991
  export interface SetRetentionPolicyRequest {
17523
17992
  max_age_hours: number;
@@ -17612,14 +18081,42 @@ export interface SharedLocationResponse {
17612
18081
  message?: MessageResponse;
17613
18082
  }
17614
18083
  export interface SharedLocationResponseData {
18084
+ /**
18085
+ * The CID (type:id) of the channel that the location is attached to.
18086
+ */
17615
18087
  channel_cid: string;
18088
+ /**
18089
+ * The date when the location was created.
18090
+ */
17616
18091
  created_at: Date;
18092
+ /**
18093
+ * The ID of the device that created the location.
18094
+ */
17617
18095
  created_by_device_id: string;
18096
+ /**
18097
+ * The latitude of the location.
18098
+ */
17618
18099
  latitude: number;
18100
+ /**
18101
+ * The longitude of the location.
18102
+ */
17619
18103
  longitude: number;
18104
+ /**
18105
+ * The ID of the message that the location is attached to.
18106
+ */
17620
18107
  message_id: string;
18108
+ /**
18109
+ * The date when the location was updated.
18110
+ */
17621
18111
  updated_at: Date;
18112
+ /**
18113
+ * The ID of the user that created the location.
18114
+ */
17622
18115
  user_id: string;
18116
+ /**
18117
+ * The date when the location sharing ends.
18118
+ * If it's empty, it means the location sharing is static instead of live.
18119
+ */
17623
18120
  end_at?: Date;
17624
18121
  /**
17625
18122
  * Represents channel in chat
@@ -18360,6 +18857,7 @@ export interface ThreadedCommentResponse {
18360
18857
  confidence_score: number;
18361
18858
  created_at: Date;
18362
18859
  downvote_count: number;
18860
+ hidden: boolean;
18363
18861
  id: string;
18364
18862
  object_id: string;
18365
18863
  object_type: string;
@@ -18825,13 +19323,31 @@ export interface UnreadCountsBatchResponse {
18825
19323
  counts_by_user: Record<string, UnreadCountsResponse>;
18826
19324
  }
18827
19325
  export interface UnreadCountsChannel {
19326
+ /**
19327
+ * The channel CID (type:id).
19328
+ */
18828
19329
  channel_id: string;
19330
+ /**
19331
+ * The date which the current user last read the channel.
19332
+ */
18829
19333
  last_read: Date;
19334
+ /**
19335
+ * The number of unread messages inside the channel.
19336
+ */
18830
19337
  unread_count: number;
18831
19338
  }
18832
19339
  export interface UnreadCountsChannelType {
19340
+ /**
19341
+ * The number of unread channels of this channel type.
19342
+ */
18833
19343
  channel_count: number;
19344
+ /**
19345
+ * The channel type.
19346
+ */
18834
19347
  channel_type: string;
19348
+ /**
19349
+ * The number of unread messages of all the channels with this type.
19350
+ */
18835
19351
  unread_count: number;
18836
19352
  }
18837
19353
  export interface UnreadCountsResponse {
@@ -18843,9 +19359,21 @@ export interface UnreadCountsResponse {
18843
19359
  total_unread_count_by_team?: Record<string, number>;
18844
19360
  }
18845
19361
  export interface UnreadCountsThread {
19362
+ /**
19363
+ * The date which the current user last read the thread.
19364
+ */
18846
19365
  last_read: Date;
19366
+ /**
19367
+ * The id of the last reply which the current user read in the thread.
19368
+ */
18847
19369
  last_read_message_id: string;
19370
+ /**
19371
+ * The message id of the root of the thread.
19372
+ */
18848
19373
  parent_message_id: string;
19374
+ /**
19375
+ * The number of unread replies inside the thread.
19376
+ */
18849
19377
  unread_count: number;
18850
19378
  }
18851
19379
  export interface UpdateActivitiesPartialBatchRequest {
@@ -21034,6 +21562,9 @@ export interface UserRequest {
21034
21562
  * Custom user data
21035
21563
  */
21036
21564
  custom?: Record<string, any>;
21565
+ /**
21566
+ * The privacy settings of the user.
21567
+ */
21037
21568
  privacy_settings?: PrivacySettingsResponse;
21038
21569
  /**
21039
21570
  * Map of team-specific roles for the user
@@ -21114,6 +21645,9 @@ export interface UserResponse {
21114
21645
  * List of devices user is using
21115
21646
  */
21116
21647
  devices?: Array<DeviceResponse>;
21648
+ /**
21649
+ * The privacy settings of the user.
21650
+ */
21117
21651
  privacy_settings?: PrivacySettingsResponse;
21118
21652
  push_notifications?: PushNotificationSettingsResponse;
21119
21653
  teams_role?: Record<string, string>;
@@ -21157,6 +21691,9 @@ export interface UserResponsePrivacyFields {
21157
21691
  last_active?: Date;
21158
21692
  name?: string;
21159
21693
  revoke_tokens_issued_before?: Date;
21694
+ /**
21695
+ * The privacy settings of the user.
21696
+ */
21160
21697
  privacy_settings?: PrivacySettingsResponse;
21161
21698
  teams_role?: Record<string, string>;
21162
21699
  }
@@ -21433,6 +21970,8 @@ export type WHEvent = ({
21433
21970
  } & CallRejectedEvent) | ({
21434
21971
  type: 'call.ring';
21435
21972
  } & CallRingEvent) | ({
21973
+ type: 'call.ring_settled';
21974
+ } & CallRingSettledEvent) | ({
21436
21975
  type: 'call.rtmp_broadcast_failed';
21437
21976
  } & CallRtmpBroadcastFailedEvent) | ({
21438
21977
  type: 'call.rtmp_broadcast_started';
@@ -21507,6 +22046,10 @@ export type WHEvent = ({
21507
22046
  } & AsyncExportErrorEvent) | ({
21508
22047
  type: 'export.channels.success';
21509
22048
  } & AsyncExportChannelsEvent) | ({
22049
+ type: 'export.label_results.error';
22050
+ } & AsyncExportErrorEvent) | ({
22051
+ type: 'export.label_results.success';
22052
+ } & AsyncExportLabelResultsEvent) | ({
21510
22053
  type: 'export.moderation_logs.error';
21511
22054
  } & AsyncExportErrorEvent) | ({
21512
22055
  type: 'export.moderation_logs.success';
@@ -21557,6 +22100,8 @@ export type WHEvent = ({
21557
22100
  } & CommentAddedEvent) | ({
21558
22101
  type: 'feeds.comment.deleted';
21559
22102
  } & CommentDeletedEvent) | ({
22103
+ type: 'feeds.comment.feedback';
22104
+ } & CommentFeedbackEvent) | ({
21560
22105
  type: 'feeds.comment.reaction.added';
21561
22106
  } & CommentReactionAddedEvent) | ({
21562
22107
  type: 'feeds.comment.reaction.deleted';
@@ -21597,6 +22142,10 @@ export type WHEvent = ({
21597
22142
  } & StoriesFeedUpdatedEvent) | ({
21598
22143
  type: 'flag.updated';
21599
22144
  } & FlagUpdatedEvent) | ({
22145
+ type: 'import.error';
22146
+ } & AsyncImportErrorEvent) | ({
22147
+ type: 'import.success';
22148
+ } & AsyncImportSuccessEvent) | ({
21600
22149
  type: 'ingress.error';
21601
22150
  } & IngressErrorEvent) | ({
21602
22151
  type: 'ingress.started';
@@ -21721,6 +22270,9 @@ export interface WSEvent {
21721
22270
  thread_id?: string;
21722
22271
  user_id?: string;
21723
22272
  watcher_count?: number;
22273
+ /**
22274
+ * Response from AI moderation
22275
+ */
21724
22276
  automoderation_scores?: ModerationResponse;
21725
22277
  /**
21726
22278
  * Represents channel in chat
@@ -21763,11 +22315,29 @@ export interface WrappedUnreadCountsResponse {
21763
22315
  * Duration of the request in milliseconds
21764
22316
  */
21765
22317
  duration: string;
22318
+ /**
22319
+ * The total number of unread messages.
22320
+ */
21766
22321
  total_unread_count: number;
22322
+ /**
22323
+ * The total number of unread threads.
22324
+ */
21767
22325
  total_unread_threads_count: number;
22326
+ /**
22327
+ * The unread information per channel type.
22328
+ */
21768
22329
  channel_type: Array<UnreadCountsChannelType>;
22330
+ /**
22331
+ * The unread information per channel.
22332
+ */
21769
22333
  channels: Array<UnreadCountsChannel>;
22334
+ /**
22335
+ * The unread information per thread.
22336
+ */
21770
22337
  threads: Array<UnreadCountsThread>;
22338
+ /**
22339
+ * The total number of unread messages grouped by team.
22340
+ */
21771
22341
  total_unread_count_by_team?: Record<string, number>;
21772
22342
  }
21773
22343
  export interface XiaomiConfig {