@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,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.
@@ -9914,6 +10177,10 @@ export interface GetOrCreateFeedResponse {
9914
10177
  feed: FeedResponse;
9915
10178
  next?: string;
9916
10179
  prev?: string;
10180
+ /**
10181
+ * 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
10182
+ */
10183
+ degraded_selectors?: Array<string>;
9917
10184
  followers_pagination?: PagerResponse;
9918
10185
  following_pagination?: PagerResponse;
9919
10186
  member_pagination?: PagerResponse;
@@ -11499,6 +11766,9 @@ export interface MemberUserRequest {
11499
11766
  role?: string;
11500
11767
  teams?: Array<string>;
11501
11768
  custom?: Record<string, any>;
11769
+ /**
11770
+ * The privacy settings of the user.
11771
+ */
11502
11772
  privacy_settings?: PrivacySettingsResponse;
11503
11773
  teams_role?: Record<string, string>;
11504
11774
  }
@@ -11762,6 +12032,9 @@ export interface MessageModerationResult {
11762
12032
  * User who moderated the message
11763
12033
  */
11764
12034
  moderated_by?: string;
12035
+ /**
12036
+ * Response from AI moderation
12037
+ */
11765
12038
  ai_moderation_response?: ModerationResponse;
11766
12039
  /**
11767
12040
  * Sets thresholds for AI moderation
@@ -12835,9 +13108,21 @@ export interface ModerationQueueResponse {
12835
13108
  filters: Record<string, any>;
12836
13109
  }
12837
13110
  export interface ModerationResponse {
13111
+ /**
13112
+ * Action taken by automod
13113
+ */
12838
13114
  action: string;
13115
+ /**
13116
+ * Explicit score
13117
+ */
12839
13118
  explicit: number;
13119
+ /**
13120
+ * Spam score
13121
+ */
12840
13122
  spam: number;
13123
+ /**
13124
+ * Toxicity score
13125
+ */
12841
13126
  toxic: number;
12842
13127
  }
12843
13128
  export interface ModerationRuleInfo {
@@ -13414,7 +13699,13 @@ export interface OwnUserResponse {
13414
13699
  revoke_tokens_issued_before?: Date;
13415
13700
  blocked_user_ids?: Array<string>;
13416
13701
  latest_hidden_channels?: Array<string>;
13702
+ /**
13703
+ * The privacy settings of the user.
13704
+ */
13417
13705
  privacy_settings?: PrivacySettingsResponse;
13706
+ /**
13707
+ * The push preference details.
13708
+ */
13418
13709
  push_preferences?: PushPreferencesResponse;
13419
13710
  teams_role?: Record<string, string>;
13420
13711
  total_unread_count_by_team?: Record<string, number>;
@@ -13986,8 +14277,17 @@ export interface PredefinedFilterStatsResponse {
13986
14277
  last_seen?: Date;
13987
14278
  }
13988
14279
  export interface PrivacySettingsResponse {
14280
+ /**
14281
+ * The settings for the delivery receipt events.
14282
+ */
13989
14283
  delivery_receipts?: DeliveryReceiptsResponse;
14284
+ /**
14285
+ * The settings for the read receipt events.
14286
+ */
13990
14287
  read_receipts?: ReadReceiptsResponse;
14288
+ /**
14289
+ * The settings for typing indicator events.
14290
+ */
13991
14291
  typing_indicators?: TypingIndicatorsResponse;
13992
14292
  }
13993
14293
  export interface PublishedTrackFlags {
@@ -14103,7 +14403,13 @@ export interface PushPreferenceInput {
14103
14403
  }
14104
14404
  export interface PushPreferencesResponse {
14105
14405
  call_level?: string;
14406
+ /**
14407
+ * The scope level of the push notifications.
14408
+ */
14106
14409
  chat_level?: string;
14410
+ /**
14411
+ * If provided the notifications will be disabled until the set date.
14412
+ */
14107
14413
  disabled_until?: Date;
14108
14414
  feeds_level?: string;
14109
14415
  chat_preferences?: ChatPreferencesResponse;
@@ -14251,9 +14557,13 @@ export interface QueryActivitiesRequest {
14251
14557
  * When true, include both expired and non-expired activities in the result.
14252
14558
  */
14253
14559
  include_expired_activities?: boolean;
14560
+ /**
14561
+ * When true, include activities hidden by moderation (shadowed or removed). Server-side only; not allowed when a user is set.
14562
+ */
14563
+ include_moderated_activities?: boolean;
14254
14564
  include_private_activities?: boolean;
14255
14565
  /**
14256
- * When true, include soft-deleted activities in the result.
14566
+ * When true, include soft-deleted activities in the result. Server-side only; not allowed when a user is set.
14257
14567
  */
14258
14568
  include_soft_deleted_activities?: boolean;
14259
14569
  limit?: number;
@@ -14523,6 +14833,46 @@ export interface QueryCallParticipantsResponse {
14523
14833
  */
14524
14834
  call: CallResponse;
14525
14835
  }
14836
+ export interface QueryCallRingAttemptsRequest {
14837
+ /**
14838
+ * Call ID
14839
+ */
14840
+ id: string;
14841
+ /**
14842
+ * The type of call
14843
+ */
14844
+ type: string;
14845
+ /**
14846
+ * Limit the attempts to one call session; omit to read every session of the call
14847
+ */
14848
+ call_session_id?: string;
14849
+ }
14850
+ export interface QueryCallRingAttemptsResponse {
14851
+ /**
14852
+ * The ID of the call the attempts belong to
14853
+ */
14854
+ call_id: string;
14855
+ /**
14856
+ * The type of the call the attempts belong to
14857
+ */
14858
+ call_type: string;
14859
+ /**
14860
+ * The number of attempts returned
14861
+ */
14862
+ count: number;
14863
+ /**
14864
+ * Duration of the request in milliseconds
14865
+ */
14866
+ duration: string;
14867
+ /**
14868
+ * The attempts, newest first
14869
+ */
14870
+ ring_attempts: Array<RingAttemptResponse>;
14871
+ /**
14872
+ * The call session the attempts were limited to, null when every session was read
14873
+ */
14874
+ call_session_id?: string;
14875
+ }
14526
14876
  export interface QueryCallSessionParticipantStatsResponse {
14527
14877
  call_id: string;
14528
14878
  call_session_id: string;
@@ -14778,7 +15128,7 @@ export interface QueryCommentsRequest {
14778
15128
  */
14779
15129
  id_around?: string;
14780
15130
  /**
14781
- * 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.
15131
+ * 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.
14782
15132
  */
14783
15133
  include_soft_deleted_comments?: boolean;
14784
15134
  /**
@@ -15289,9 +15639,22 @@ export interface QueryModerationRulesResponse {
15289
15639
  }
15290
15640
  export interface QueryPinnedActivitiesRequest {
15291
15641
  enrich_own_fields?: boolean;
15642
+ /**
15643
+ * When true, return pinned activities even if they have expired. Server-side only; not allowed when a user is set.
15644
+ */
15645
+ include_expired_activities?: boolean;
15646
+ /**
15647
+ * When true, return pinned activities even if moderation hides them (shadowed or removed). Server-side only; not allowed when a user is set.
15648
+ */
15649
+ include_moderated_activities?: boolean;
15650
+ /**
15651
+ * When true, return pinned activities even if they are soft-deleted. Server-side only; not allowed when a user is set.
15652
+ */
15653
+ include_soft_deleted_activities?: boolean;
15292
15654
  limit?: number;
15293
15655
  next?: string;
15294
15656
  prev?: string;
15657
+ user_id?: string;
15295
15658
  /**
15296
15659
  * Sorting parameters for the query
15297
15660
  */
@@ -15300,6 +15663,10 @@ export interface QueryPinnedActivitiesRequest {
15300
15663
  * Filters to apply to the query
15301
15664
  */
15302
15665
  filter?: Record<string, any>;
15666
+ /**
15667
+ * User request object
15668
+ */
15669
+ user?: UserRequest;
15303
15670
  }
15304
15671
  export interface QueryPinnedActivitiesResponse {
15305
15672
  duration: string;
@@ -15750,6 +16117,10 @@ export interface RankingConfig {
15750
16117
  * Type of ranking algorithm. Required. One of: expression, interest
15751
16118
  */
15752
16119
  type: 'expression' | 'interest';
16120
+ /**
16121
+ * Activities scoring strictly below this value are dropped from the ranked feed. Not supported on aggregated feeds
16122
+ */
16123
+ exclude_below?: number;
15753
16124
  /**
15754
16125
  * Scoring formula. Required when type is 'expression' or 'interest'
15755
16126
  */
@@ -16583,6 +16954,7 @@ export interface ReviewQueueItemResponse {
16583
16954
  */
16584
16955
  confidence_score?: number;
16585
16956
  config_key?: string;
16957
+ country_code?: string;
16586
16958
  /**
16587
16959
  * ID of who created the entity
16588
16960
  */
@@ -16645,6 +17017,68 @@ export interface RevisionHistoryResponse {
16645
17017
  changed_fields?: Array<string>;
16646
17018
  previous_obj_serialized?: Record<string, any>;
16647
17019
  }
17020
+ export interface RingAttemptResponse {
17021
+ /**
17022
+ * The application this ring belongs to
17023
+ */
17024
+ app_pk: number;
17025
+ /**
17026
+ * The ID of the call that was rung
17027
+ */
17028
+ call_id: string;
17029
+ /**
17030
+ * The type of the call that was rung
17031
+ */
17032
+ call_type: string;
17033
+ /**
17034
+ * When the ring went out
17035
+ */
17036
+ created_at: Date;
17037
+ /**
17038
+ * When the ring expires, i.e. when the missed call deadline fires
17039
+ */
17040
+ expires_at: Date;
17041
+ /**
17042
+ * The user that started the ring
17043
+ */
17044
+ initiated_by: string;
17045
+ /**
17046
+ * The derived outcome: ringing, answered_some, answered_all, rejected_all, missed_all, cancelled or mixed
17047
+ */
17048
+ outcome: string;
17049
+ /**
17050
+ * The ring, as published in the ring_id of the call.ring event
17051
+ */
17052
+ ring_id: string;
17053
+ /**
17054
+ * The call session that was rung
17055
+ */
17056
+ session_id: string;
17057
+ /**
17058
+ * Why the ring settled: answered, rejected, cancel, timeout, ended or auto_end; empty while it is still ringing
17059
+ */
17060
+ settle_reason: string;
17061
+ /**
17062
+ * The user that settled the ring, or 'server'; empty while it is still ringing
17063
+ */
17064
+ settled_by: string;
17065
+ /**
17066
+ * Opaque context stored on the ring by the caller
17067
+ */
17068
+ custom: Record<string, any>;
17069
+ /**
17070
+ * The rung users, keyed by user ID
17071
+ */
17072
+ targets: Record<string, RingTargetResponse>;
17073
+ /**
17074
+ * When the ring was deleted
17075
+ */
17076
+ deleted_at?: Date;
17077
+ /**
17078
+ * When the outcome left ringing
17079
+ */
17080
+ settled_at?: Date;
17081
+ }
16648
17082
  export interface RingCallRequest {
16649
17083
  /**
16650
17084
  * Indicate if call should be video
@@ -16670,6 +17104,36 @@ export interface RingCallResponse {
16670
17104
  */
16671
17105
  ring_id?: string;
16672
17106
  }
17107
+ export interface RingDeliveryResponse {
17108
+ /**
17109
+ * The transport the ring was dispatched over: ws, apns_voip, apns or fcm
17110
+ */
17111
+ channel: string;
17112
+ /**
17113
+ * When the ring was dispatched
17114
+ */
17115
+ sent_at: Date;
17116
+ /**
17117
+ * When the device acknowledged the ring; not populated yet
17118
+ */
17119
+ acked_at?: Date;
17120
+ /**
17121
+ * The device the ring was dispatched to, empty for websocket deliveries which fan out to every connection
17122
+ */
17123
+ device_id?: string;
17124
+ /**
17125
+ * When the device displayed the ring; not populated yet
17126
+ */
17127
+ displayed_at?: Date;
17128
+ /**
17129
+ * When the device fetched the call; not populated yet
17130
+ */
17131
+ fetched_at?: Date;
17132
+ /**
17133
+ * When the push provider accepted the dispatch; not populated yet
17134
+ */
17135
+ provider_accepted_at?: Date;
17136
+ }
16673
17137
  export interface RingSettings {
16674
17138
  auto_cancel_timeout_ms: number;
16675
17139
  incoming_call_timeout_ms: number;
@@ -16694,6 +17158,29 @@ export interface RingSettingsResponse {
16694
17158
  incoming_call_timeout_ms: number;
16695
17159
  missed_call_timeout_ms: number;
16696
17160
  }
17161
+ export interface RingSettledTarget {
17162
+ state: string;
17163
+ state_at: Date;
17164
+ reason?: string;
17165
+ }
17166
+ export interface RingTargetResponse {
17167
+ /**
17168
+ * The reject or cancel reason, empty otherwise
17169
+ */
17170
+ reason: string;
17171
+ /**
17172
+ * The target's state for this ring: pending, accepted, rejected, missed or cancelled
17173
+ */
17174
+ state: string;
17175
+ /**
17176
+ * When the target last changed state
17177
+ */
17178
+ state_at: Date;
17179
+ /**
17180
+ * The dispatches of this ring to the target's devices
17181
+ */
17182
+ deliveries: Array<RingDeliveryResponse>;
17183
+ }
16697
17184
  export interface Role {
16698
17185
  /**
16699
17186
  * Date/time of creation
@@ -16733,6 +17220,7 @@ export interface RuleBuilderCondition {
16733
17220
  channel_message_count_rule_params?: ChannelMessageCountRuleParameters;
16734
17221
  closed_caption_rule_params?: ClosedCaptionRuleParameters;
16735
17222
  content_count_rule_params?: ContentCountRuleParameters;
17223
+ content_country_code_params?: ContentCountryCodeParameters;
16736
17224
  content_custom_property_count_params?: ContentCustomPropertyCountParameters;
16737
17225
  content_custom_property_params?: ContentCustomPropertyParameters;
16738
17226
  content_flag_count_rule_params?: FlagCountRuleParameters;
@@ -17487,8 +17975,9 @@ export interface SessionWarningResponse {
17487
17975
  }
17488
17976
  export interface SetFeedsRetentionPolicyRequest {
17489
17977
  max_age_hours: number;
17490
- policy: 'old-activities';
17978
+ policy: string;
17491
17979
  enabled?: boolean;
17980
+ feed_groups?: Array<string>;
17492
17981
  }
17493
17982
  export interface SetFeedsRetentionPolicyResponse {
17494
17983
  /**
@@ -17496,7 +17985,7 @@ export interface SetFeedsRetentionPolicyResponse {
17496
17985
  */
17497
17986
  duration: string;
17498
17987
  enabled: boolean;
17499
- policy: RetentionPolicy;
17988
+ policy: FeedsRetentionPolicy;
17500
17989
  }
17501
17990
  export interface SetRetentionPolicyRequest {
17502
17991
  max_age_hours: number;
@@ -17591,14 +18080,42 @@ export interface SharedLocationResponse {
17591
18080
  message?: MessageResponse;
17592
18081
  }
17593
18082
  export interface SharedLocationResponseData {
18083
+ /**
18084
+ * The CID (type:id) of the channel that the location is attached to.
18085
+ */
17594
18086
  channel_cid: string;
18087
+ /**
18088
+ * The date when the location was created.
18089
+ */
17595
18090
  created_at: Date;
18091
+ /**
18092
+ * The ID of the device that created the location.
18093
+ */
17596
18094
  created_by_device_id: string;
18095
+ /**
18096
+ * The latitude of the location.
18097
+ */
17597
18098
  latitude: number;
18099
+ /**
18100
+ * The longitude of the location.
18101
+ */
17598
18102
  longitude: number;
18103
+ /**
18104
+ * The ID of the message that the location is attached to.
18105
+ */
17599
18106
  message_id: string;
18107
+ /**
18108
+ * The date when the location was updated.
18109
+ */
17600
18110
  updated_at: Date;
18111
+ /**
18112
+ * The ID of the user that created the location.
18113
+ */
17601
18114
  user_id: string;
18115
+ /**
18116
+ * The date when the location sharing ends.
18117
+ * If it's empty, it means the location sharing is static instead of live.
18118
+ */
17602
18119
  end_at?: Date;
17603
18120
  /**
17604
18121
  * Represents channel in chat
@@ -18339,6 +18856,7 @@ export interface ThreadedCommentResponse {
18339
18856
  confidence_score: number;
18340
18857
  created_at: Date;
18341
18858
  downvote_count: number;
18859
+ hidden: boolean;
18342
18860
  id: string;
18343
18861
  object_id: string;
18344
18862
  object_type: string;
@@ -18804,13 +19322,31 @@ export interface UnreadCountsBatchResponse {
18804
19322
  counts_by_user: Record<string, UnreadCountsResponse>;
18805
19323
  }
18806
19324
  export interface UnreadCountsChannel {
19325
+ /**
19326
+ * The channel CID (type:id).
19327
+ */
18807
19328
  channel_id: string;
19329
+ /**
19330
+ * The date which the current user last read the channel.
19331
+ */
18808
19332
  last_read: Date;
19333
+ /**
19334
+ * The number of unread messages inside the channel.
19335
+ */
18809
19336
  unread_count: number;
18810
19337
  }
18811
19338
  export interface UnreadCountsChannelType {
19339
+ /**
19340
+ * The number of unread channels of this channel type.
19341
+ */
18812
19342
  channel_count: number;
19343
+ /**
19344
+ * The channel type.
19345
+ */
18813
19346
  channel_type: string;
19347
+ /**
19348
+ * The number of unread messages of all the channels with this type.
19349
+ */
18814
19350
  unread_count: number;
18815
19351
  }
18816
19352
  export interface UnreadCountsResponse {
@@ -18822,9 +19358,21 @@ export interface UnreadCountsResponse {
18822
19358
  total_unread_count_by_team?: Record<string, number>;
18823
19359
  }
18824
19360
  export interface UnreadCountsThread {
19361
+ /**
19362
+ * The date which the current user last read the thread.
19363
+ */
18825
19364
  last_read: Date;
19365
+ /**
19366
+ * The id of the last reply which the current user read in the thread.
19367
+ */
18826
19368
  last_read_message_id: string;
19369
+ /**
19370
+ * The message id of the root of the thread.
19371
+ */
18827
19372
  parent_message_id: string;
19373
+ /**
19374
+ * The number of unread replies inside the thread.
19375
+ */
18828
19376
  unread_count: number;
18829
19377
  }
18830
19378
  export interface UpdateActivitiesPartialBatchRequest {
@@ -21013,6 +21561,9 @@ export interface UserRequest {
21013
21561
  * Custom user data
21014
21562
  */
21015
21563
  custom?: Record<string, any>;
21564
+ /**
21565
+ * The privacy settings of the user.
21566
+ */
21016
21567
  privacy_settings?: PrivacySettingsResponse;
21017
21568
  /**
21018
21569
  * Map of team-specific roles for the user
@@ -21093,6 +21644,9 @@ export interface UserResponse {
21093
21644
  * List of devices user is using
21094
21645
  */
21095
21646
  devices?: Array<DeviceResponse>;
21647
+ /**
21648
+ * The privacy settings of the user.
21649
+ */
21096
21650
  privacy_settings?: PrivacySettingsResponse;
21097
21651
  push_notifications?: PushNotificationSettingsResponse;
21098
21652
  teams_role?: Record<string, string>;
@@ -21136,6 +21690,9 @@ export interface UserResponsePrivacyFields {
21136
21690
  last_active?: Date;
21137
21691
  name?: string;
21138
21692
  revoke_tokens_issued_before?: Date;
21693
+ /**
21694
+ * The privacy settings of the user.
21695
+ */
21139
21696
  privacy_settings?: PrivacySettingsResponse;
21140
21697
  teams_role?: Record<string, string>;
21141
21698
  }
@@ -21412,6 +21969,8 @@ export type WHEvent = ({
21412
21969
  } & CallRejectedEvent) | ({
21413
21970
  type: 'call.ring';
21414
21971
  } & CallRingEvent) | ({
21972
+ type: 'call.ring_settled';
21973
+ } & CallRingSettledEvent) | ({
21415
21974
  type: 'call.rtmp_broadcast_failed';
21416
21975
  } & CallRtmpBroadcastFailedEvent) | ({
21417
21976
  type: 'call.rtmp_broadcast_started';
@@ -21486,6 +22045,10 @@ export type WHEvent = ({
21486
22045
  } & AsyncExportErrorEvent) | ({
21487
22046
  type: 'export.channels.success';
21488
22047
  } & AsyncExportChannelsEvent) | ({
22048
+ type: 'export.label_results.error';
22049
+ } & AsyncExportErrorEvent) | ({
22050
+ type: 'export.label_results.success';
22051
+ } & AsyncExportLabelResultsEvent) | ({
21489
22052
  type: 'export.moderation_logs.error';
21490
22053
  } & AsyncExportErrorEvent) | ({
21491
22054
  type: 'export.moderation_logs.success';
@@ -21536,6 +22099,8 @@ export type WHEvent = ({
21536
22099
  } & CommentAddedEvent) | ({
21537
22100
  type: 'feeds.comment.deleted';
21538
22101
  } & CommentDeletedEvent) | ({
22102
+ type: 'feeds.comment.feedback';
22103
+ } & CommentFeedbackEvent) | ({
21539
22104
  type: 'feeds.comment.reaction.added';
21540
22105
  } & CommentReactionAddedEvent) | ({
21541
22106
  type: 'feeds.comment.reaction.deleted';
@@ -21576,6 +22141,10 @@ export type WHEvent = ({
21576
22141
  } & StoriesFeedUpdatedEvent) | ({
21577
22142
  type: 'flag.updated';
21578
22143
  } & FlagUpdatedEvent) | ({
22144
+ type: 'import.error';
22145
+ } & AsyncImportErrorEvent) | ({
22146
+ type: 'import.success';
22147
+ } & AsyncImportSuccessEvent) | ({
21579
22148
  type: 'ingress.error';
21580
22149
  } & IngressErrorEvent) | ({
21581
22150
  type: 'ingress.started';
@@ -21700,6 +22269,9 @@ export interface WSEvent {
21700
22269
  thread_id?: string;
21701
22270
  user_id?: string;
21702
22271
  watcher_count?: number;
22272
+ /**
22273
+ * Response from AI moderation
22274
+ */
21703
22275
  automoderation_scores?: ModerationResponse;
21704
22276
  /**
21705
22277
  * Represents channel in chat
@@ -21742,11 +22314,29 @@ export interface WrappedUnreadCountsResponse {
21742
22314
  * Duration of the request in milliseconds
21743
22315
  */
21744
22316
  duration: string;
22317
+ /**
22318
+ * The total number of unread messages.
22319
+ */
21745
22320
  total_unread_count: number;
22321
+ /**
22322
+ * The total number of unread threads.
22323
+ */
21746
22324
  total_unread_threads_count: number;
22325
+ /**
22326
+ * The unread information per channel type.
22327
+ */
21747
22328
  channel_type: Array<UnreadCountsChannelType>;
22329
+ /**
22330
+ * The unread information per channel.
22331
+ */
21748
22332
  channels: Array<UnreadCountsChannel>;
22333
+ /**
22334
+ * The unread information per thread.
22335
+ */
21749
22336
  threads: Array<UnreadCountsThread>;
22337
+ /**
22338
+ * The total number of unread messages grouped by team.
22339
+ */
21750
22340
  total_unread_count_by_team?: Record<string, number>;
21751
22341
  }
21752
22342
  export interface XiaomiConfig {