@stream-io/node-sdk 0.8.3 → 0.8.4

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.
@@ -210,7 +210,7 @@ export interface AcceptFollowRequest {
210
210
  target: string;
211
211
 
212
212
  /**
213
- * Optional role for the follower in the follow relationship
213
+ * Optional role for the follower in the follow relationship. Server-side only, and one of 'feed_follower' (the default) or 'feed_member_viewer'.
214
214
  */
215
215
  follower_role?: string;
216
216
  }
@@ -602,7 +602,7 @@ export interface ActivityProcessorConfig {
602
602
  min_text_length?: number;
603
603
 
604
604
  /**
605
- * Minimum number of words the activity text must have before this processor runs. 0 (the default) disables the check. Only applies to text_interest_tags.
605
+ * Minimum number of words the activity text must have before this processor runs. 0 (the default) disables the check. Only applies to text_interest_tags. Words are whitespace-separated, so scripts written without word spacing (Chinese, Japanese, Thai) always count as 1 word regardless of length — use min_text_length for those.
606
606
  */
607
607
  min_word_count?: number;
608
608
  }
@@ -1936,6 +1936,8 @@ export interface AppResponseFields {
1936
1936
 
1937
1937
  max_aggregated_activities_length: number;
1938
1938
 
1939
+ member_custom_on_mentioned_users_enabled: boolean;
1940
+
1939
1941
  member_custom_on_messages_enabled: boolean;
1940
1942
 
1941
1943
  moderation_audio_call_moderation_enabled: boolean;
@@ -6020,19 +6022,16 @@ export interface ChannelMemberPartialResponse {
6020
6022
  }
6021
6023
 
6022
6024
  export interface ChannelMemberRequest {
6023
- user_id: string;
6024
-
6025
6025
  /**
6026
6026
  * Role of the member in the channel
6027
6027
  */
6028
6028
  channel_role?: string;
6029
6029
 
6030
+ user_id?: string;
6031
+
6030
6032
  custom?: Record<string, any>;
6031
6033
 
6032
- /**
6033
- * User response object
6034
- */
6035
- user?: UserResponse;
6034
+ user?: MemberUserRequest;
6036
6035
  }
6037
6036
 
6038
6037
  export interface ChannelMemberResponse {
@@ -8765,6 +8764,8 @@ export interface CreateFeedGroupRequest {
8765
8764
  */
8766
8765
  id: string;
8767
8766
 
8767
+ default_follower_role?: string;
8768
+
8768
8769
  /**
8769
8770
  * Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided.
8770
8771
  */
@@ -8834,6 +8835,11 @@ export interface CreateFeedsBatchRequest {
8834
8835
  */
8835
8836
  feeds: Array<FeedRequest>;
8836
8837
 
8838
+ /**
8839
+ * Server-side only. If true, auto-creates users referenced by feeds[].created_by_id that don't already exist. Default: false.
8840
+ */
8841
+ create_users?: boolean;
8842
+
8837
8843
  /**
8838
8844
  * If true, enriches the created feeds with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance.
8839
8845
  */
@@ -9178,6 +9184,15 @@ export interface CreateReminderRequest {
9178
9184
  user?: UserRequest;
9179
9185
  }
9180
9186
 
9187
+ export interface CreateReminderResponse {
9188
+ /**
9189
+ * Duration of the request in milliseconds
9190
+ */
9191
+ duration: string;
9192
+
9193
+ reminder: ReminderResponseData;
9194
+ }
9195
+
9181
9196
  export interface CreateRoleRequest {
9182
9197
  /**
9183
9198
  * Role name
@@ -11054,6 +11069,8 @@ export interface FeedGroup {
11054
11069
 
11055
11070
  created_at: Date;
11056
11071
 
11072
+ default_follower_role: string;
11073
+
11057
11074
  default_visibility: string;
11058
11075
 
11059
11076
  group_id: string;
@@ -11148,6 +11165,11 @@ export interface FeedGroupResponse {
11148
11165
  */
11149
11166
  updated_at: Date;
11150
11167
 
11168
+ /**
11169
+ * Role new followers of feeds in this group are given. One of: feed_follower, feed_member_viewer. Empty means feed_follower. Applied when the follow is accepted, so a follow that starts pending picks it up on approval
11170
+ */
11171
+ default_follower_role?: string;
11172
+
11151
11173
  /**
11152
11174
  * Default visibility for activities. One of: public, visible, followers, members, private
11153
11175
  */
@@ -12613,7 +12635,7 @@ export interface FollowResponse {
12613
12635
  created_at: Date;
12614
12636
 
12615
12637
  /**
12616
- * Role of the follower (source user) in the follow relationship
12638
+ * Role of the follower (source user) in the follow relationship, as stored. A value outside the allowed set is reported as stored but evaluated as 'feed_follower'.
12617
12639
  */
12618
12640
  follower_role: string;
12619
12641
 
@@ -13524,6 +13546,8 @@ export interface GetOrCreateCallResponse {
13524
13546
  }
13525
13547
 
13526
13548
  export interface GetOrCreateFeedGroupRequest {
13549
+ default_follower_role?: string;
13550
+
13527
13551
  /**
13528
13552
  * Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided.
13529
13553
  */
@@ -15620,6 +15644,28 @@ export interface MemberUpdatedEvent {
15620
15644
  user?: UserResponseCommonFields;
15621
15645
  }
15622
15646
 
15647
+ export interface MemberUserRequest {
15648
+ id: string;
15649
+
15650
+ image?: string;
15651
+
15652
+ invisible?: boolean;
15653
+
15654
+ language?: string;
15655
+
15656
+ name?: string;
15657
+
15658
+ role?: string;
15659
+
15660
+ teams?: Array<string>;
15661
+
15662
+ custom?: Record<string, any>;
15663
+
15664
+ privacy_settings?: PrivacySettingsResponse;
15665
+
15666
+ teams_role?: Record<string, string>;
15667
+ }
15668
+
15623
15669
  export interface MembersResponse {
15624
15670
  /**
15625
15671
  * Duration of the request in milliseconds
@@ -16481,6 +16527,11 @@ export interface MessageResponse {
16481
16527
 
16482
16528
  member?: ChannelMemberPartialResponse;
16483
16529
 
16530
+ /**
16531
+ * Channel member data for the users mentioned in the message, keyed by user id. Only present when the app has member custom on mentioned users enabled, and only for the first two mentioned users of each message
16532
+ */
16533
+ mentioned_channel_members?: Record<string, ChannelMemberPartialResponse>;
16534
+
16484
16535
  moderation?: ModerationV2Response;
16485
16536
 
16486
16537
  /**
@@ -16851,6 +16902,11 @@ export interface MessageWithChannelResponse {
16851
16902
 
16852
16903
  member?: ChannelMemberPartialResponse;
16853
16904
 
16905
+ /**
16906
+ * Channel member data for the users mentioned in the message, keyed by user id. Only present when the app has member custom on mentioned users enabled, and only for the first two mentioned users of each message
16907
+ */
16908
+ mentioned_channel_members?: Record<string, ChannelMemberPartialResponse>;
16909
+
16854
16910
  moderation?: ModerationV2Response;
16855
16911
 
16856
16912
  /**
@@ -18938,7 +18994,11 @@ export interface PollResponseData {
18938
18994
 
18939
18995
  vote_count: number;
18940
18996
 
18941
- voting_visibility: string;
18997
+ /**
18998
+ * Voting visibility of the poll
18999
+ */
19000
+
19001
+ voting_visibility: 'anonymous' | 'public';
18942
19002
 
18943
19003
  latest_answers: Array<PollVoteResponseData>;
18944
19004
 
@@ -20610,11 +20670,6 @@ export interface QueryLabelResultsResponse {
20610
20670
  export interface QueryMembersPayload {
20611
20671
  type: string;
20612
20672
 
20613
- /**
20614
- * Filter conditions to apply to the query
20615
- */
20616
- filter_conditions: Record<string, any>;
20617
-
20618
20673
  id?: string;
20619
20674
 
20620
20675
  limit?: number;
@@ -20630,6 +20685,11 @@ export interface QueryMembersPayload {
20630
20685
  */
20631
20686
  sort?: Array<SortParamRequest>;
20632
20687
 
20688
+ /**
20689
+ * Filter conditions to apply to the query
20690
+ */
20691
+ filter_conditions?: Record<string, any>;
20692
+
20633
20693
  /**
20634
20694
  * User request object
20635
20695
  */
@@ -22170,6 +22230,8 @@ export interface ReminderCreatedEvent {
22170
22230
 
22171
22231
  custom: Record<string, any>;
22172
22232
 
22233
+ reminder: ReminderResponseData;
22234
+
22173
22235
  /**
22174
22236
  * The type of event: "reminder.created" in this case
22175
22237
  */
@@ -22181,8 +22243,6 @@ export interface ReminderCreatedEvent {
22181
22243
  parent_id?: string;
22182
22244
 
22183
22245
  received_at?: Date;
22184
-
22185
- reminder?: ReminderResponseData;
22186
22246
  }
22187
22247
 
22188
22248
  export interface ReminderDeletedEvent {
@@ -22208,6 +22268,8 @@ export interface ReminderDeletedEvent {
22208
22268
 
22209
22269
  custom: Record<string, any>;
22210
22270
 
22271
+ reminder: ReminderResponseData;
22272
+
22211
22273
  /**
22212
22274
  * The type of event: "reminder.deleted" in this case
22213
22275
  */
@@ -22219,8 +22281,6 @@ export interface ReminderDeletedEvent {
22219
22281
  parent_id?: string;
22220
22282
 
22221
22283
  received_at?: Date;
22222
-
22223
- reminder?: ReminderResponseData;
22224
22284
  }
22225
22285
 
22226
22286
  export interface ReminderNotificationEvent {
@@ -22246,6 +22306,8 @@ export interface ReminderNotificationEvent {
22246
22306
 
22247
22307
  custom: Record<string, any>;
22248
22308
 
22309
+ reminder: ReminderResponseData;
22310
+
22249
22311
  /**
22250
22312
  * The type of event: "notification.reminder_due" in this case
22251
22313
  */
@@ -22254,8 +22316,6 @@ export interface ReminderNotificationEvent {
22254
22316
  parent_id?: string;
22255
22317
 
22256
22318
  received_at?: Date;
22257
-
22258
- reminder?: ReminderResponseData;
22259
22319
  }
22260
22320
 
22261
22321
  export interface ReminderResponseData {
@@ -22310,6 +22370,8 @@ export interface ReminderUpdatedEvent {
22310
22370
 
22311
22371
  custom: Record<string, any>;
22312
22372
 
22373
+ reminder: ReminderResponseData;
22374
+
22313
22375
  /**
22314
22376
  * The type of event: "reminder.updated" in this case
22315
22377
  */
@@ -22321,8 +22383,6 @@ export interface ReminderUpdatedEvent {
22321
22383
  parent_id?: string;
22322
22384
 
22323
22385
  received_at?: Date;
22324
-
22325
- reminder?: ReminderResponseData;
22326
22386
  }
22327
22387
 
22328
22388
  export interface RemoveUserGroupMembersRequest {
@@ -23636,6 +23696,8 @@ export interface SearchResultMessage {
23636
23696
 
23637
23697
  member?: ChannelMemberPartialResponse;
23638
23698
 
23699
+ mentioned_channel_members?: Record<string, ChannelMemberPartialResponse>;
23700
+
23639
23701
  moderation?: ModerationV2Response;
23640
23702
 
23641
23703
  /**
@@ -25692,7 +25754,8 @@ export interface UnbanActionRequestPayload {
25692
25754
 
25693
25755
  export interface UnbanRequest {
25694
25756
  /**
25695
- * ID of the user performing the unban
25757
+ * @deprecated
25758
+ * ID of the user performing the unban Deprecated: not used by the unban flow
25696
25759
  */
25697
25760
  unbanned_by_id?: string;
25698
25761
 
@@ -26229,6 +26292,8 @@ export interface UpdateAppRequest {
26229
26292
 
26230
26293
  max_aggregated_activities_length?: number;
26231
26294
 
26295
+ member_custom_on_mentioned_users_enabled?: boolean;
26296
+
26232
26297
  member_custom_on_messages_enabled?: boolean;
26233
26298
 
26234
26299
  migrate_permissions_to_v2?: boolean;
@@ -27087,6 +27152,8 @@ export interface UpdateExternalStorageResponse {
27087
27152
  }
27088
27153
 
27089
27154
  export interface UpdateFeedGroupRequest {
27155
+ default_follower_role?: string;
27156
+
27090
27157
  default_visibility?:
27091
27158
  'public' | 'visible' | 'followers' | 'members' | 'private';
27092
27159
 
@@ -27268,6 +27335,9 @@ export interface UpdateFollowRequest {
27268
27335
  */
27269
27336
  enrich_own_fields?: boolean;
27270
27337
 
27338
+ /**
27339
+ * Optional role for the follower in the follow relationship. Server-side only, and one of 'feed_follower' (the default) or 'feed_member_viewer'.
27340
+ */
27271
27341
  follower_role?: string;
27272
27342
 
27273
27343
  /**
@@ -1955,11 +1955,11 @@ export class VideoApi {
1955
1955
 
1956
1956
  async getDailyDigest(request?: {
1957
1957
  date?: string;
1958
- app_id?: string;
1958
+ target_app_id?: string;
1959
1959
  }): Promise<StreamResponse<GetDailyDigestResponse>> {
1960
1960
  const queryParams = {
1961
1961
  date: request?.date,
1962
- app_id: request?.app_id,
1962
+ target_app_id: request?.target_app_id,
1963
1963
  };
1964
1964
 
1965
1965
  const response = await this.apiClient.sendRequest<