Class: GetStream::Generated::FeedsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/getstream_ruby/generated/feeds_client.rb

Overview

Feeds API client with generated methods

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ FeedsClient

Returns a new instance of FeedsClient.



12
13
14
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 12

def initialize(client)
  @client = client
end

Instance Method Details

#accept_feed_member_invite(feed_id, feed_group_id, accept_feed_member_invite_request) ⇒ Models::AcceptFeedMemberInviteResponse

Accepts a pending feed member request

Parameters:

  • feed_id (String)
  • feed_group_id (String)
  • accept_feed_member_invite_request (AcceptFeedMemberInviteRequest)

Returns:



1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1020

def accept_feed_member_invite(feed_id, feed_group_id, accept_feed_member_invite_request)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept'
  # Replace path parameters
  path = path.gsub('{feed_id}', feed_id.to_s)
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  # Build request body
  body = accept_feed_member_invite_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#accept_follow(accept_follow_request) ⇒ Models::AcceptFollowResponse

Accepts a pending follow request

Parameters:

  • accept_follow_request (AcceptFollowRequest)

Returns:



1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1506

def accept_follow(accept_follow_request)
  path = '/api/v2/feeds/follows/accept'
  # Build request body
  body = accept_follow_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#activity_feedback(activity_id, activity_feedback_request) ⇒ Models::ActivityFeedbackResponse

Submit feedback for an activity including options to show less, hide, report, or mute the user

Parameters:

  • activity_id (String)
  • activity_feedback_request (ActivityFeedbackRequest)

Returns:



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 185

def activity_feedback(activity_id, activity_feedback_request)
  path = '/api/v2/feeds/activities/{activity_id}/feedback'
  # Replace path parameters
  path = path.gsub('{activity_id}', activity_id.to_s)
  # Build request body
  body = activity_feedback_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#add_activity(add_activity_request) ⇒ Models::AddActivityResponse

Create a new activity or update an existing one

Parameters:

  • add_activity_request (AddActivityRequest)

Returns:



19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 19

def add_activity(add_activity_request)
  path = '/api/v2/feeds/activities'
  # Build request body
  body = add_activity_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#add_activity_reaction(activity_id, add_reaction_request) ⇒ Models::AddReactionResponse

Adds a reaction to an activity

Parameters:

  • activity_id (String)
  • add_reaction_request (AddReactionRequest)

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 252

def add_activity_reaction(activity_id, add_reaction_request)
  path = '/api/v2/feeds/activities/{activity_id}/reactions'
  # Replace path parameters
  path = path.gsub('{activity_id}', activity_id.to_s)
  # Build request body
  body = add_reaction_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#add_bookmark(activity_id, add_bookmark_request) ⇒ Models::AddBookmarkResponse

Adds a bookmark to an activity

Parameters:

  • activity_id (String)
  • add_bookmark_request (AddBookmarkRequest)

Returns:



165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 165

def add_bookmark(activity_id, add_bookmark_request)
  path = '/api/v2/feeds/activities/{activity_id}/bookmarks'
  # Replace path parameters
  path = path.gsub('{activity_id}', activity_id.to_s)
  # Build request body
  body = add_bookmark_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#add_comment(add_comment_request) ⇒ Models::AddCommentResponse

Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events

Parameters:

  • add_comment_request (AddCommentRequest)

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 613

def add_comment(add_comment_request)
  path = '/api/v2/feeds/comments'
  # Build request body
  body = add_comment_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#add_comment_reaction(_id, add_comment_reaction_request) ⇒ Models::AddCommentReactionResponse

Adds a reaction to a comment

Parameters:

  • _id (String)
  • add_comment_reaction_request (AddCommentReactionRequest)

Returns:



724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 724

def add_comment_reaction(_id, add_comment_reaction_request)
  path = '/api/v2/feeds/comments/{id}/reactions'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = add_comment_reaction_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#add_comments_batch(add_comments_batch_request) ⇒ Models::AddCommentsBatchResponse

Adds multiple comments in a single request. Each comment must specify the object type and ID.

Parameters:

  • add_comments_batch_request (AddCommentsBatchRequest)

Returns:



630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 630

def add_comments_batch(add_comments_batch_request)
  path = '/api/v2/feeds/comments/batch'
  # Build request body
  body = add_comments_batch_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#cast_poll_vote(activity_id, poll_id, cast_poll_vote_request) ⇒ Models::PollVoteResponse

Cast a vote on a pollSends events:- feeds.poll.vote_casted- feeds.poll.vote_changed- feeds.poll.vote_removed- poll.vote_casted- poll.vote_changed- poll.vote_removed

Parameters:

  • activity_id (String)
  • poll_id (String)
  • cast_poll_vote_request (CastPollVoteRequest)

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 206

def cast_poll_vote(activity_id, poll_id, cast_poll_vote_request)
  path = '/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote'
  # Replace path parameters
  path = path.gsub('{activity_id}', activity_id.to_s)
  path = path.gsub('{poll_id}', poll_id.to_s)
  # Build request body
  body = cast_poll_vote_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#create_collections(create_collections_request) ⇒ Models::CreateCollectionsResponse

Create new collections in a batch operation. Collections are data objects that can be attached to activities for managing shared data across multiple activities.

Parameters:

  • create_collections_request (CreateCollectionsRequest)

Returns:



545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 545

def create_collections(create_collections_request)
  path = '/api/v2/feeds/collections'
  # Build request body
  body = create_collections_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#create_feed_group(create_feed_group_request) ⇒ Models::CreateFeedGroupResponse

Creates a new feed group with the specified configuration

Parameters:

  • create_feed_group_request (CreateFeedGroupRequest)

Returns:



839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 839

def create_feed_group(create_feed_group_request)
  path = '/api/v2/feeds/feed_groups'
  # Build request body
  body = create_feed_group_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#create_feed_view(create_feed_view_request) ⇒ Models::CreateFeedViewResponse

Create a custom view for a feed group with specific selectors, ranking, or aggregation options

Parameters:

  • create_feed_view_request (CreateFeedViewRequest)

Returns:



1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1240

def create_feed_view(create_feed_view_request)
  path = '/api/v2/feeds/feed_views'
  # Build request body
  body = create_feed_view_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#create_feeds_batch(create_feeds_batch_request) ⇒ Models::CreateFeedsBatchResponse

Create multiple feeds at once for a given feed group

Parameters:

  • create_feeds_batch_request (CreateFeedsBatchRequest)

Returns:



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1378

def create_feeds_batch(create_feeds_batch_request)
  path = '/api/v2/feeds/feeds/batch'
  # Build request body
  body = create_feeds_batch_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#create_membership_level(create_membership_level_request) ⇒ Models::CreateMembershipLevelResponse

Create a new membership level with tag-based access controls

Parameters:

  • create_membership_level_request (CreateMembershipLevelRequest)

Returns:



1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1616

def create_membership_level(create_membership_level_request)
  path = '/api/v2/feeds/membership_levels'
  # Build request body
  body = create_membership_level_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#delete_activities(delete_activities_request) ⇒ Models::DeleteActivitiesResponse

Delete one or more activities by their IDs

Parameters:

  • delete_activities_request (DeleteActivitiesRequest)

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 70

def delete_activities(delete_activities_request)
  path = '/api/v2/feeds/activities/delete'
  # Build request body
  body = delete_activities_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#delete_activity(_id, hard_delete = nil, delete_notification_activity = nil) ⇒ Models::DeleteActivityResponse

Delete a single activity by its ID

Parameters:

  • _id (String)
  • hard_delete (Boolean) (defaults to: nil)
  • delete_notification_activity (Boolean) (defaults to: nil)

Returns:



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 318

def delete_activity(_id, hard_delete = nil, delete_notification_activity = nil)
  path = '/api/v2/feeds/activities/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build query parameters
  query_params = {}
  query_params['hard_delete'] = hard_delete unless hard_delete.nil?
  query_params['delete_notification_activity'] = delete_notification_activity unless delete_notification_activity.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#delete_activity_reaction(activity_id, _type, delete_notification_activity = nil, user_id = nil) ⇒ Models::DeleteActivityReactionResponse

Removes a reaction from an activity

Parameters:

  • activity_id (String)
  • _type (String)
  • delete_notification_activity (Boolean) (defaults to: nil)
  • user_id (String) (defaults to: nil)

Returns:



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 294

def delete_activity_reaction(activity_id, _type, delete_notification_activity = nil, user_id = nil)
  path = '/api/v2/feeds/activities/{activity_id}/reactions/{type}'
  # Replace path parameters
  path = path.gsub('{activity_id}', activity_id.to_s)
  path = path.gsub('{type}', _type.to_s)
  # Build query parameters
  query_params = {}
  query_params['delete_notification_activity'] = delete_notification_activity unless delete_notification_activity.nil?
  query_params['user_id'] = user_id unless user_id.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#delete_bookmark(activity_id, folder_id = nil, user_id = nil) ⇒ Models::DeleteBookmarkResponse

Deletes a bookmark from an activity

Parameters:

  • activity_id (String)
  • folder_id (String) (defaults to: nil)
  • user_id (String) (defaults to: nil)

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 123

def delete_bookmark(activity_id, folder_id = nil, user_id = nil)
  path = '/api/v2/feeds/activities/{activity_id}/bookmarks'
  # Replace path parameters
  path = path.gsub('{activity_id}', activity_id.to_s)
  # Build query parameters
  query_params = {}
  query_params['folder_id'] = folder_id unless folder_id.nil?
  query_params['user_id'] = user_id unless user_id.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#delete_bookmark_folder(folder_id) ⇒ Models::DeleteBookmarkFolderResponse

Delete a bookmark folder by its ID

Parameters:

  • folder_id (String)

Returns:



437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 437

def delete_bookmark_folder(folder_id)
  path = '/api/v2/feeds/bookmark_folders/{folder_id}'
  # Replace path parameters
  path = path.gsub('{folder_id}', folder_id.to_s)

  # Make the API request
  @client.make_request(
    :delete,
    path
  )
end

#delete_collections(collection_refs) ⇒ Models::DeleteCollectionsResponse

Delete collections in a batch operation. Users can only delete their own collections.

Parameters:

  • collection_refs (Array<String>)

Returns:



490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 490

def delete_collections(collection_refs)
  path = '/api/v2/feeds/collections'
  # Build query parameters
  query_params = {}
  query_params['collection_refs'] = collection_refs unless collection_refs.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#delete_comment(_id, hard_delete = nil, delete_notification_activity = nil) ⇒ Models::DeleteCommentResponse

Deletes a comment from an object (e.g., activity) and broadcasts appropriate events

Parameters:

  • _id (String)
  • hard_delete (Boolean) (defaults to: nil)
  • delete_notification_activity (Boolean) (defaults to: nil)

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 666

def delete_comment(_id, hard_delete = nil, delete_notification_activity = nil)
  path = '/api/v2/feeds/comments/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build query parameters
  query_params = {}
  query_params['hard_delete'] = hard_delete unless hard_delete.nil?
  query_params['delete_notification_activity'] = delete_notification_activity unless delete_notification_activity.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#delete_comment_reaction(_id, _type, delete_notification_activity = nil, user_id = nil) ⇒ Models::DeleteCommentReactionResponse

Deletes a reaction from a comment

Parameters:

  • _id (String)
  • _type (String)
  • delete_notification_activity (Boolean) (defaults to: nil)
  • user_id (String) (defaults to: nil)

Returns:



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 766

def delete_comment_reaction(_id, _type, delete_notification_activity = nil, user_id = nil)
  path = '/api/v2/feeds/comments/{id}/reactions/{type}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  path = path.gsub('{type}', _type.to_s)
  # Build query parameters
  query_params = {}
  query_params['delete_notification_activity'] = delete_notification_activity unless delete_notification_activity.nil?
  query_params['user_id'] = user_id unless user_id.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#delete_feed(feed_group_id, feed_id, hard_delete = nil) ⇒ Models::DeleteFeedResponse

Delete a single feed by its ID

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • hard_delete (Boolean) (defaults to: nil)

Returns:



858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 858

def delete_feed(feed_group_id, feed_id, hard_delete = nil)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  # Build query parameters
  query_params = {}
  query_params['hard_delete'] = hard_delete unless hard_delete.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#delete_feed_group(_id, hard_delete = nil) ⇒ Models::DeleteFeedGroupResponse

Delete a feed group by its ID. Can perform a soft delete (default) or hard delete.

Parameters:

  • _id (String)
  • hard_delete (Boolean) (defaults to: nil)

Returns:



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1146

def delete_feed_group(_id, hard_delete = nil)
  path = '/api/v2/feeds/feed_groups/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build query parameters
  query_params = {}
  query_params['hard_delete'] = hard_delete unless hard_delete.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#delete_feed_user_data(user_id, delete_feed_user_data_request) ⇒ Models::DeleteFeedUserDataResponse

Delete all feed data for a user including: feeds, activities, follows, comments, feed reactions, bookmark folders, bookmarks, and collections owned by the user

Parameters:

  • user_id (String)
  • delete_feed_user_data_request (DeleteFeedUserDataRequest)

Returns:



1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1738

def delete_feed_user_data(user_id, delete_feed_user_data_request)
  path = '/api/v2/feeds/users/{user_id}/delete'
  # Replace path parameters
  path = path.gsub('{user_id}', user_id.to_s)
  # Build request body
  body = delete_feed_user_data_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#delete_feed_view(_id) ⇒ Models::DeleteFeedViewResponse

Delete an existing custom feed view

Parameters:

  • _id (String)

Returns:



1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1257

def delete_feed_view(_id)
  path = '/api/v2/feeds/feed_views/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)

  # Make the API request
  @client.make_request(
    :delete,
    path
  )
end

#delete_feeds_batch(delete_feeds_batch_request) ⇒ Models::DeleteFeedsBatchResponse

Delete multiple feeds by their IDs. All feeds must exist. This endpoint is server-side only.

Parameters:

  • delete_feeds_batch_request (DeleteFeedsBatchRequest)

Returns:



1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1395

def delete_feeds_batch(delete_feeds_batch_request)
  path = '/api/v2/feeds/feeds/delete'
  # Build request body
  body = delete_feeds_batch_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#delete_membership_level(_id) ⇒ Models::Response

Delete a membership level by its UUID. This operation is irreversible.

Parameters:

  • _id (String)

Returns:



1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1650

def delete_membership_level(_id)
  path = '/api/v2/feeds/membership_levels/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)

  # Make the API request
  @client.make_request(
    :delete,
    path
  )
end

#delete_poll_vote(activity_id, poll_id, vote_id, user_id = nil) ⇒ Models::PollVoteResponse

Delete a vote from a pollSends events:- feeds.poll.vote_removed- poll.vote_removed

Parameters:

  • activity_id (String)
  • poll_id (String)
  • vote_id (String)
  • user_id (String) (defaults to: nil)

Returns:



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 229

def delete_poll_vote(activity_id, poll_id, vote_id, user_id = nil)
  path = '/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}'
  # Replace path parameters
  path = path.gsub('{activity_id}', activity_id.to_s)
  path = path.gsub('{poll_id}', poll_id.to_s)
  path = path.gsub('{vote_id}', vote_id.to_s)
  # Build query parameters
  query_params = {}
  query_params['user_id'] = user_id unless user_id.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#export_feed_user_data(user_id) ⇒ Models::ExportFeedUserDataResponse

Export all feed data for a user including: user profile, feeds, activities, follows, comments, feed reactions, bookmark folders, bookmarks, and collections owned by the user

Parameters:

  • user_id (String)

Returns:



1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1757

def export_feed_user_data(user_id)
  path = '/api/v2/feeds/users/{user_id}/export'
  # Replace path parameters
  path = path.gsub('{user_id}', user_id.to_s)

  # Make the API request
  @client.make_request(
    :post,
    path
  )
end

#follow(follow_request) ⇒ Models::SingleFollowResponse

Creates a follow and broadcasts FollowAddedEvent

Parameters:

  • follow_request (FollowRequest)

Returns:



1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1489

def follow(follow_request)
  path = '/api/v2/feeds/follows'
  # Build request body
  body = follow_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#follow_batch(follow_batch_request) ⇒ Models::FollowBatchResponse

Creates multiple follows at once and broadcasts FollowAddedEvent for each follow

Parameters:

  • follow_batch_request (FollowBatchRequest)

Returns:



1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1523

def follow_batch(follow_batch_request)
  path = '/api/v2/feeds/follows/batch'
  # Build request body
  body = follow_batch_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#get_activity(_id) ⇒ Models::GetActivityResponse

Returns activity by ID

Parameters:

  • _id (String)

Returns:



339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 339

def get_activity(_id)
  path = '/api/v2/feeds/activities/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)

  # Make the API request
  @client.make_request(
    :get,
    path
  )
end

#get_comment(_id) ⇒ Models::GetCommentResponse

Get a comment by ID

Parameters:

  • _id (String)

Returns:



687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 687

def get_comment(_id)
  path = '/api/v2/feeds/comments/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)

  # Make the API request
  @client.make_request(
    :get,
    path
  )
end

#get_comment_replies(_id, depth = nil, sort = nil, replies_limit = nil, user_id = nil, limit = nil, prev = nil, _next = nil) ⇒ Models::GetCommentRepliesResponse

Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination

Parameters:

  • _id (String)
  • depth (Integer) (defaults to: nil)
  • sort (String) (defaults to: nil)
  • replies_limit (Integer) (defaults to: nil)
  • user_id (String) (defaults to: nil)
  • limit (Integer) (defaults to: nil)
  • prev (String) (defaults to: nil)
  • _next (String) (defaults to: nil)

Returns:



795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 795

def get_comment_replies(_id, depth = nil, sort = nil, replies_limit = nil, user_id = nil, limit = nil, prev = nil, _next = nil)
  path = '/api/v2/feeds/comments/{id}/replies'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build query parameters
  query_params = {}
  query_params['depth'] = depth unless depth.nil?
  query_params['sort'] = sort unless sort.nil?
  query_params['replies_limit'] = replies_limit unless replies_limit.nil?
  query_params['user_id'] = user_id unless user_id.nil?
  query_params['limit'] = limit unless limit.nil?
  query_params['prev'] = prev unless prev.nil?
  query_params['next'] = _next unless _next.nil?

  # Make the API request
  @client.make_request(
    :get,
    path,
    query_params: query_params
  )
end

#get_comments(object_id, object_type, depth = nil, sort = nil, replies_limit = nil, user_id = nil, limit = nil, prev = nil, _next = nil) ⇒ Models::GetCommentsResponse

Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination

Parameters:

  • object_id (String)
  • object_type (String)
  • depth (Integer) (defaults to: nil)
  • sort (String) (defaults to: nil)
  • replies_limit (Integer) (defaults to: nil)
  • user_id (String) (defaults to: nil)
  • limit (Integer) (defaults to: nil)
  • prev (String) (defaults to: nil)
  • _next (String) (defaults to: nil)

Returns:



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 587

def get_comments(object_id, object_type, depth = nil, sort = nil, replies_limit = nil, user_id = nil, limit = nil, prev = nil, _next = nil)
  path = '/api/v2/feeds/comments'
  # Build query parameters
  query_params = {}
  query_params['object_id'] = object_id unless object_id.nil?
  query_params['object_type'] = object_type unless object_type.nil?
  query_params['depth'] = depth unless depth.nil?
  query_params['sort'] = sort unless sort.nil?
  query_params['replies_limit'] = replies_limit unless replies_limit.nil?
  query_params['user_id'] = user_id unless user_id.nil?
  query_params['limit'] = limit unless limit.nil?
  query_params['prev'] = prev unless prev.nil?
  query_params['next'] = _next unless _next.nil?

  # Make the API request
  @client.make_request(
    :get,
    path,
    query_params: query_params
  )
end

#get_feed_group(_id, include_soft_deleted = nil) ⇒ Models::GetFeedGroupResponse

Get a feed group by ID

Parameters:

  • _id (String)
  • include_soft_deleted (Boolean) (defaults to: nil)

Returns:



1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1167

def get_feed_group(_id, include_soft_deleted = nil)
  path = '/api/v2/feeds/feed_groups/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build query parameters
  query_params = {}
  query_params['include_soft_deleted'] = include_soft_deleted unless include_soft_deleted.nil?

  # Make the API request
  @client.make_request(
    :get,
    path,
    query_params: query_params
  )
end

#get_feed_view(_id) ⇒ Models::GetFeedViewResponse

Get a feed view by its ID

Parameters:

  • _id (String)

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1273

def get_feed_view(_id)
  path = '/api/v2/feeds/feed_views/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)

  # Make the API request
  @client.make_request(
    :get,
    path
  )
end

#get_feed_visibility(name) ⇒ Models::GetFeedVisibilityResponse

Gets feed visibility configuration and permissions

Parameters:

  • name (String)

Returns:



1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1342

def get_feed_visibility(name)
  path = '/api/v2/feeds/feed_visibilities/{name}'
  # Replace path parameters
  path = path.gsub('{name}', name.to_s)

  # Make the API request
  @client.make_request(
    :get,
    path
  )
end

#get_feeds_rate_limits(endpoints = nil, android = nil, ios = nil, web = nil, server_side = nil) ⇒ Models::GetFeedsRateLimitsResponse

Retrieve current rate limit status for feeds operations.Returns information about limits, usage, and remaining quota for various feed operations.

Parameters:

  • endpoints (String) (defaults to: nil)
  • android (Boolean) (defaults to: nil)
  • ios (Boolean) (defaults to: nil)
  • web (Boolean) (defaults to: nil)
  • server_side (Boolean) (defaults to: nil)

Returns:



1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1450

def get_feeds_rate_limits(endpoints = nil, android = nil, ios = nil, web = nil, server_side = nil)
  path = '/api/v2/feeds/feeds/rate_limits'
  # Build query parameters
  query_params = {}
  query_params['endpoints'] = endpoints unless endpoints.nil?
  query_params['android'] = android unless android.nil?
  query_params['ios'] = ios unless ios.nil?
  query_params['web'] = web unless web.nil?
  query_params['server_side'] = server_side unless server_side.nil?

  # Make the API request
  @client.make_request(
    :get,
    path,
    query_params: query_params
  )
end

#get_follow_suggestions(feed_group_id, limit = nil, user_id = nil) ⇒ Models::GetFollowSuggestionsResponse

Get follow suggestions for a feed group

Parameters:

  • feed_group_id (String)
  • limit (Integer) (defaults to: nil)
  • user_id (String) (defaults to: nil)

Returns:



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1108

def get_follow_suggestions(feed_group_id, limit = nil, user_id = nil)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  # Build query parameters
  query_params = {}
  query_params['limit'] = limit unless limit.nil?
  query_params['user_id'] = user_id unless user_id.nil?

  # Make the API request
  @client.make_request(
    :get,
    path,
    query_params: query_params
  )
end

#get_or_create_feed(feed_group_id, feed_id, get_or_create_feed_request) ⇒ Models::GetOrCreateFeedResponse

Create a single feed for a given feed group

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • get_or_create_feed_request (GetOrCreateFeedRequest)

Returns:



881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 881

def get_or_create_feed(feed_group_id, feed_id, get_or_create_feed_request)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  # Build request body
  body = get_or_create_feed_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#get_or_create_feed_group(_id, get_or_create_feed_group_request) ⇒ Models::GetOrCreateFeedGroupResponse

Get an existing feed group or create a new one if it doesn’t exist

Parameters:

  • _id (String)
  • get_or_create_feed_group_request (GetOrCreateFeedGroupRequest)

Returns:



1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1188

def get_or_create_feed_group(_id, get_or_create_feed_group_request)
  path = '/api/v2/feeds/feed_groups/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = get_or_create_feed_group_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#get_or_create_feed_view(_id, get_or_create_feed_view_request) ⇒ Models::GetOrCreateFeedViewResponse

Get an existing feed view or create a new one if it doesn’t exist

Parameters:

  • _id (String)
  • get_or_create_feed_view_request (GetOrCreateFeedViewRequest)

Returns:



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1290

def get_or_create_feed_view(_id, get_or_create_feed_view_request)
  path = '/api/v2/feeds/feed_views/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = get_or_create_feed_view_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#get_or_create_follows(follow_batch_request) ⇒ Models::FollowBatchResponse

Creates or updates multiple follows at once. Does not return an error if follows already exist. Broadcasts FollowAddedEvent only for newly created follows.

Parameters:

  • follow_batch_request (FollowBatchRequest)

Returns:



1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1540

def get_or_create_follows(follow_batch_request)
  path = '/api/v2/feeds/follows/batch/upsert'
  # Build request body
  body = follow_batch_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#get_or_create_unfollows(unfollow_batch_request) ⇒ Models::UnfollowBatchResponse

Removes multiple follows and broadcasts FollowRemovedEvent for each. Does not return an error if follows don’t exist.

Parameters:

  • unfollow_batch_request (UnfollowBatchRequest)

Returns:



1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1720

def get_or_create_unfollows(unfollow_batch_request)
  path = '/api/v2/feeds/unfollow/batch/upsert'
  # Build request body
  body = unfollow_batch_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#list_feed_groups(include_soft_deleted = nil) ⇒ Models::ListFeedGroupsResponse

List all feed groups for the application

Parameters:

  • include_soft_deleted (Boolean) (defaults to: nil)

Returns:



821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 821

def list_feed_groups(include_soft_deleted = nil)
  path = '/api/v2/feeds/feed_groups'
  # Build query parameters
  query_params = {}
  query_params['include_soft_deleted'] = include_soft_deleted unless include_soft_deleted.nil?

  # Make the API request
  @client.make_request(
    :get,
    path,
    query_params: query_params
  )
end

#list_feed_views ⇒ Models::ListFeedViewsResponse

List all feed views for a feed group

Returns:



1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1226

def list_feed_views()
  path = '/api/v2/feeds/feed_views'

  # Make the API request
  @client.make_request(
    :get,
    path
  )
end

#list_feed_visibilities ⇒ Models::ListFeedVisibilitiesResponse

Gets all available feed visibility configurations and their permissions

Returns:



1328
1329
1330
1331
1332
1333
1334
1335
1336
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1328

def list_feed_visibilities()
  path = '/api/v2/feeds/feed_visibilities'

  # Make the API request
  @client.make_request(
    :get,
    path
  )
end

#mark_activity(feed_group_id, feed_id, mark_activity_request) ⇒ Models::Response

Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • mark_activity_request (MarkActivityRequest)

Returns:



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 925

def mark_activity(feed_group_id, feed_id, mark_activity_request)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  # Build request body
  body = mark_activity_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#own_batch(own_batch_request) ⇒ Models::OwnBatchResponse

Retrieves own_follows, own_capabilities, and/or own_membership for multiple feeds in a single request. If fields are not specified, all three fields are returned.

Parameters:

  • own_batch_request (OwnBatchRequest)

Returns:



1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1412

def own_batch(own_batch_request)
  path = '/api/v2/feeds/feeds/own/batch'
  # Build request body
  body = own_batch_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#pin_activity(feed_group_id, feed_id, activity_id, pin_activity_request) ⇒ Models::PinActivityResponse

Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • activity_id (String)
  • pin_activity_request (PinActivityRequest)

Returns:



975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 975

def pin_activity(feed_group_id, feed_id, activity_id, pin_activity_request)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  path = path.gsub('{activity_id}', activity_id.to_s)
  # Build request body
  body = pin_activity_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_activities(query_activities_request) ⇒ Models::QueryActivitiesResponse

Query activities based on filters with pagination and sorting options

Parameters:

  • query_activities_request (QueryActivitiesRequest)

Returns:



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 104

def query_activities(query_activities_request)
  path = '/api/v2/feeds/activities/query'
  # Build request body
  body = query_activities_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_activity_reactions(activity_id, query_activity_reactions_request) ⇒ Models::QueryActivityReactionsResponse

Query activity reactions

Parameters:

  • activity_id (String)
  • query_activity_reactions_request (QueryActivityReactionsRequest)

Returns:



272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 272

def query_activity_reactions(activity_id, query_activity_reactions_request)
  path = '/api/v2/feeds/activities/{activity_id}/reactions/query'
  # Replace path parameters
  path = path.gsub('{activity_id}', activity_id.to_s)
  # Build request body
  body = query_activity_reactions_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_bookmark_folders(query_bookmark_folders_request) ⇒ Models::QueryBookmarkFoldersResponse

Query bookmark folders with filter query

Parameters:

  • query_bookmark_folders_request (QueryBookmarkFoldersRequest)

Returns:



420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 420

def query_bookmark_folders(query_bookmark_folders_request)
  path = '/api/v2/feeds/bookmark_folders/query'
  # Build request body
  body = query_bookmark_folders_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_bookmarks(query_bookmarks_request) ⇒ Models::QueryBookmarksResponse

Query bookmarks with filter query

Parameters:

  • query_bookmarks_request (QueryBookmarksRequest)

Returns:



473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 473

def query_bookmarks(query_bookmarks_request)
  path = '/api/v2/feeds/bookmarks/query'
  # Build request body
  body = query_bookmarks_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_comment_reactions(_id, query_comment_reactions_request) ⇒ Models::QueryCommentReactionsResponse

Query comment reactions

Parameters:

  • _id (String)
  • query_comment_reactions_request (QueryCommentReactionsRequest)

Returns:



744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 744

def query_comment_reactions(_id, query_comment_reactions_request)
  path = '/api/v2/feeds/comments/{id}/reactions/query'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = query_comment_reactions_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_comments(query_comments_request) ⇒ Models::QueryCommentsResponse

Query comments using MongoDB-style filters with pagination and sorting options

Parameters:

  • query_comments_request (QueryCommentsRequest)

Returns:



647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 647

def query_comments(query_comments_request)
  path = '/api/v2/feeds/comments/query'
  # Build request body
  body = query_comments_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_feed_members(feed_group_id, feed_id, query_feed_members_request) ⇒ Models::QueryFeedMembersResponse

Query feed members based on filters with pagination and sorting options

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • query_feed_members_request (QueryFeedMembersRequest)

Returns:



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1042

def query_feed_members(feed_group_id, feed_id, query_feed_members_request)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  # Build request body
  body = query_feed_members_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_feeds(query_feeds_request) ⇒ Models::QueryFeedsResponse

Query feeds with filter query

Parameters:

  • query_feeds_request (QueryFeedsRequest)

Returns:



1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1429

def query_feeds(query_feeds_request)
  path = '/api/v2/feeds/feeds/query'
  # Build request body
  body = query_feeds_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_feeds_usage_stats(query_feeds_usage_stats_request) ⇒ Models::QueryFeedsUsageStatsResponse

Retrieve usage statistics for feeds including activity count, follow count, and API request count.Returns data aggregated by day with pagination support via from/to date parameters.This endpoint is server-side only.

Parameters:

  • query_feeds_usage_stats_request (QueryFeedsUsageStatsRequest)

Returns:



1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1686

def query_feeds_usage_stats(query_feeds_usage_stats_request)
  path = '/api/v2/feeds/stats/usage'
  # Build request body
  body = query_feeds_usage_stats_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_follows(query_follows_request) ⇒ Models::QueryFollowsResponse

Query follows based on filters with pagination and sorting options

Parameters:

  • query_follows_request (QueryFollowsRequest)

Returns:



1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1557

def query_follows(query_follows_request)
  path = '/api/v2/feeds/follows/query'
  # Build request body
  body = query_follows_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_membership_levels(query_membership_levels_request) ⇒ Models::QueryMembershipLevelsResponse

Query membership levels with filter query

Parameters:

  • query_membership_levels_request (QueryMembershipLevelsRequest)

Returns:



1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1633

def query_membership_levels(query_membership_levels_request)
  path = '/api/v2/feeds/membership_levels/query'
  # Build request body
  body = query_membership_levels_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#query_pinned_activities(feed_group_id, feed_id, query_pinned_activities_request) ⇒ Models::QueryPinnedActivitiesResponse

Query pinned activities for a feed with filter query

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • query_pinned_activities_request (QueryPinnedActivitiesRequest)

Returns:



1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1086

def query_pinned_activities(feed_group_id, feed_id, query_pinned_activities_request)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/pinned_activities/query'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  # Build request body
  body = query_pinned_activities_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#read_collections(user_id = nil, collection_refs = nil) ⇒ Models::ReadCollectionsResponse

Read collections with optional filtering by user ID and collection name. By default, users can only read their own collections.

Parameters:

  • user_id (String) (defaults to: nil)
  • collection_refs (Array<String>) (defaults to: nil)

Returns:



509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 509

def read_collections(user_id = nil, collection_refs = nil)
  path = '/api/v2/feeds/collections'
  # Build query parameters
  query_params = {}
  query_params['user_id'] = user_id unless user_id.nil?
  query_params['collection_refs'] = collection_refs unless collection_refs.nil?

  # Make the API request
  @client.make_request(
    :get,
    path,
    query_params: query_params
  )
end

#reject_feed_member_invite(feed_group_id, feed_id, reject_feed_member_invite_request) ⇒ Models::RejectFeedMemberInviteResponse

Rejects a pending feed member request

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • reject_feed_member_invite_request (RejectFeedMemberInviteRequest)

Returns:



1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1064

def reject_feed_member_invite(feed_group_id, feed_id, reject_feed_member_invite_request)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  # Build request body
  body = reject_feed_member_invite_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#reject_follow(reject_follow_request) ⇒ Models::RejectFollowResponse

Rejects a pending follow request

Parameters:

  • reject_follow_request (RejectFollowRequest)

Returns:



1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1574

def reject_follow(reject_follow_request)
  path = '/api/v2/feeds/follows/reject'
  # Build request body
  body = reject_follow_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#restore_activity(_id, restore_activity_request, enrich_own_fields = nil) ⇒ Models::RestoreActivityResponse

Restores a soft-deleted activity by its ID. Only the activity owner can restore their own activities.

Parameters:

  • _id (String)
  • restore_activity_request (RestoreActivityRequest)
  • enrich_own_fields (Boolean) (defaults to: nil)

Returns:



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 397

def restore_activity(_id, restore_activity_request, enrich_own_fields = nil)
  path = '/api/v2/feeds/activities/{id}/restore'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build query parameters
  query_params = {}
  query_params['enrich_own_fields'] = enrich_own_fields unless enrich_own_fields.nil?
  # Build request body
  body = restore_activity_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    query_params: query_params,
    body: body
  )
end

#restore_feed_group(feed_group_id) ⇒ Models::RestoreFeedGroupResponse

Restores a soft-deleted feed group by its ID. Only clears DeletedAt in the database; no other fields are updated.

Parameters:

  • feed_group_id (String)

Returns:



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1129

def restore_feed_group(feed_group_id)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/restore'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)

  # Make the API request
  @client.make_request(
    :post,
    path
  )
end

#track_activity_metrics(track_activity_metrics_request) ⇒ Models::TrackActivityMetricsResponse

Track metric events (views, clicks, impressions) for activities. Supports batching up to 100 events per request. Each event is independently rate-limited per user per activity per metric. Server-side calls must include user_id.

Parameters:

  • track_activity_metrics_request (TrackActivityMetricsRequest)

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 87

def track_activity_metrics(track_activity_metrics_request)
  path = '/api/v2/feeds/activities/metrics/track'
  # Build request body
  body = track_activity_metrics_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#unfollow(source, target, delete_notification_activity = nil, enrich_own_fields = nil) ⇒ Models::UnfollowResponse

Removes a follow and broadcasts FollowRemovedEvent

Parameters:

  • source (String)
  • target (String)
  • delete_notification_activity (Boolean) (defaults to: nil)
  • enrich_own_fields (Boolean) (defaults to: nil)

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1594

def unfollow(source, target, delete_notification_activity = nil, enrich_own_fields = nil)
  path = '/api/v2/feeds/follows/{source}/{target}'
  # Replace path parameters
  path = path.gsub('{source}', source.to_s)
  path = path.gsub('{target}', target.to_s)
  # Build query parameters
  query_params = {}
  query_params['delete_notification_activity'] = delete_notification_activity unless delete_notification_activity.nil?
  query_params['enrich_own_fields'] = enrich_own_fields unless enrich_own_fields.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#unfollow_batch(unfollow_batch_request) ⇒ Models::UnfollowBatchResponse

Removes multiple follows at once and broadcasts FollowRemovedEvent for each one

Parameters:

  • unfollow_batch_request (UnfollowBatchRequest)

Returns:



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1703

def unfollow_batch(unfollow_batch_request)
  path = '/api/v2/feeds/unfollow/batch'
  # Build request body
  body = unfollow_batch_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#unpin_activity(feed_group_id, feed_id, activity_id, enrich_own_fields = nil, user_id = nil) ⇒ Models::UnpinActivityResponse

Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed.

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • activity_id (String)
  • enrich_own_fields (Boolean) (defaults to: nil)
  • user_id (String) (defaults to: nil)

Returns:



949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 949

def unpin_activity(feed_group_id, feed_id, activity_id, enrich_own_fields = nil, user_id = nil)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  path = path.gsub('{activity_id}', activity_id.to_s)
  # Build query parameters
  query_params = {}
  query_params['enrich_own_fields'] = enrich_own_fields unless enrich_own_fields.nil?
  query_params['user_id'] = user_id unless user_id.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
end

#update_activities_partial_batch(update_activities_partial_batch_request) ⇒ Models::UpdateActivitiesPartialBatchResponse

Updates certain fields of multiple activities in a batch. Use ‘set’ to update specific fields and ‘unset’ to remove fields. Activities that fail due to not found, permission denied, or no changes detected are silently skipped and not included in the response. However, validation errors (e.g., updating reserved fields, invalid field values) will fail the entire batch request.Sends events:- feeds.activity.updated

Parameters:

  • update_activities_partial_batch_request (UpdateActivitiesPartialBatchRequest)

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 53

def update_activities_partial_batch(update_activities_partial_batch_request)
  path = '/api/v2/feeds/activities/batch/partial'
  # Build request body
  body = update_activities_partial_batch_request

  # Make the API request
  @client.make_request(
    :patch,
    path,
    body: body
  )
end

#update_activity(_id, update_activity_request) ⇒ Models::UpdateActivityResponse

Replaces an activity with the provided data. Use this to update text, attachments, reply restrictions (‘restrict_replies’), mentioned users, and other activity fields. Note: This is a full update - any fields not provided will be cleared.Sends events:- feeds.activity.updated

Parameters:

  • _id (String)
  • update_activity_request (UpdateActivityRequest)

Returns:



376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 376

def update_activity(_id, update_activity_request)
  path = '/api/v2/feeds/activities/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = update_activity_request

  # Make the API request
  @client.make_request(
    :put,
    path,
    body: body
  )
end

#update_activity_partial(_id, update_activity_partial_request) ⇒ Models::UpdateActivityPartialResponse

Updates certain fields of the activity. Use ‘set’ to update specific fields and ‘unset’ to remove fields. This allows you to update only the fields you need without replacing the entire activity. Useful for updating reply restrictions (‘restrict_replies’), mentioned users, or custom data.Sends events:- feeds.activity.updated

Parameters:

  • _id (String)
  • update_activity_partial_request (UpdateActivityPartialRequest)

Returns:



356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 356

def update_activity_partial(_id, update_activity_partial_request)
  path = '/api/v2/feeds/activities/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = update_activity_partial_request

  # Make the API request
  @client.make_request(
    :patch,
    path,
    body: body
  )
end

#update_bookmark(activity_id, update_bookmark_request) ⇒ Models::UpdateBookmarkResponse

Updates a bookmark for an activity

Parameters:

  • activity_id (String)
  • update_bookmark_request (UpdateBookmarkRequest)

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 145

def update_bookmark(activity_id, update_bookmark_request)
  path = '/api/v2/feeds/activities/{activity_id}/bookmarks'
  # Replace path parameters
  path = path.gsub('{activity_id}', activity_id.to_s)
  # Build request body
  body = update_bookmark_request

  # Make the API request
  @client.make_request(
    :patch,
    path,
    body: body
  )
end

#update_bookmark_folder(folder_id, update_bookmark_folder_request) ⇒ Models::UpdateBookmarkFolderResponse

Update a bookmark folder by its ID

Parameters:

  • folder_id (String)
  • update_bookmark_folder_request (UpdateBookmarkFolderRequest)

Returns:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 454

def update_bookmark_folder(folder_id, update_bookmark_folder_request)
  path = '/api/v2/feeds/bookmark_folders/{folder_id}'
  # Replace path parameters
  path = path.gsub('{folder_id}', folder_id.to_s)
  # Build request body
  body = update_bookmark_folder_request

  # Make the API request
  @client.make_request(
    :patch,
    path,
    body: body
  )
end

#update_collections(update_collections_request) ⇒ Models::UpdateCollectionsResponse

Update existing collections in a batch operation. Only the custom data field is updatable. Users can only update their own collections.

Parameters:

  • update_collections_request (UpdateCollectionsRequest)

Returns:



528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 528

def update_collections(update_collections_request)
  path = '/api/v2/feeds/collections'
  # Build request body
  body = update_collections_request

  # Make the API request
  @client.make_request(
    :patch,
    path,
    body: body
  )
end

#update_comment(_id, update_comment_request) ⇒ Models::UpdateCommentResponse

Updates a comment on an object (e.g., activity) and broadcasts appropriate events

Parameters:

  • _id (String)
  • update_comment_request (UpdateCommentRequest)

Returns:



704
705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 704

def update_comment(_id, update_comment_request)
  path = '/api/v2/feeds/comments/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = update_comment_request

  # Make the API request
  @client.make_request(
    :patch,
    path,
    body: body
  )
end

#update_feed(feed_group_id, feed_id, update_feed_request) ⇒ Models::UpdateFeedResponse

Update an existing feed

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • update_feed_request (UpdateFeedRequest)

Returns:



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 903

def update_feed(feed_group_id, feed_id, update_feed_request)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  # Build request body
  body = update_feed_request

  # Make the API request
  @client.make_request(
    :put,
    path,
    body: body
  )
end

#update_feed_group(_id, update_feed_group_request) ⇒ Models::UpdateFeedGroupResponse

Update a feed group by ID

Parameters:

  • _id (String)
  • update_feed_group_request (UpdateFeedGroupRequest)

Returns:



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1208

def update_feed_group(_id, update_feed_group_request)
  path = '/api/v2/feeds/feed_groups/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = update_feed_group_request

  # Make the API request
  @client.make_request(
    :put,
    path,
    body: body
  )
end

#update_feed_members(feed_group_id, feed_id, update_feed_members_request) ⇒ Models::UpdateFeedMembersResponse

Add, remove, or set members for a feed

Parameters:

  • feed_group_id (String)
  • feed_id (String)
  • update_feed_members_request (UpdateFeedMembersRequest)

Returns:



998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 998

def update_feed_members(feed_group_id, feed_id, update_feed_members_request)
  path = '/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members'
  # Replace path parameters
  path = path.gsub('{feed_group_id}', feed_group_id.to_s)
  path = path.gsub('{feed_id}', feed_id.to_s)
  # Build request body
  body = update_feed_members_request

  # Make the API request
  @client.make_request(
    :patch,
    path,
    body: body
  )
end

#update_feed_view(_id, update_feed_view_request) ⇒ Models::UpdateFeedViewResponse

Update an existing custom feed view with new selectors, ranking, or aggregation options

Parameters:

  • _id (String)
  • update_feed_view_request (UpdateFeedViewRequest)

Returns:



1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1310

def update_feed_view(_id, update_feed_view_request)
  path = '/api/v2/feeds/feed_views/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = update_feed_view_request

  # Make the API request
  @client.make_request(
    :put,
    path,
    body: body
  )
end

#update_feed_visibility(name, update_feed_visibility_request) ⇒ Models::UpdateFeedVisibilityResponse

Updates an existing predefined feed visibility configuration

Parameters:

  • name (String)
  • update_feed_visibility_request (UpdateFeedVisibilityRequest)

Returns:



1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1359

def update_feed_visibility(name, update_feed_visibility_request)
  path = '/api/v2/feeds/feed_visibilities/{name}'
  # Replace path parameters
  path = path.gsub('{name}', name.to_s)
  # Build request body
  body = update_feed_visibility_request

  # Make the API request
  @client.make_request(
    :put,
    path,
    body: body
  )
end

#update_follow(update_follow_request) ⇒ Models::UpdateFollowResponse

Updates a follow’s custom data, push preference, and follower role. Source owner can update custom data and push preference. Follower role can only be updated via server-side requests.

Parameters:

  • update_follow_request (UpdateFollowRequest)

Returns:



1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1472

def update_follow(update_follow_request)
  path = '/api/v2/feeds/follows'
  # Build request body
  body = update_follow_request

  # Make the API request
  @client.make_request(
    :patch,
    path,
    body: body
  )
end

#update_membership_level(_id, update_membership_level_request) ⇒ Models::UpdateMembershipLevelResponse

Update a membership level with partial updates. Only specified fields will be updated.

Parameters:

  • _id (String)
  • update_membership_level_request (UpdateMembershipLevelRequest)

Returns:



1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1667

def update_membership_level(_id, update_membership_level_request)
  path = '/api/v2/feeds/membership_levels/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = update_membership_level_request

  # Make the API request
  @client.make_request(
    :patch,
    path,
    body: body
  )
end

#upsert_activities(upsert_activities_request) ⇒ Models::UpsertActivitiesResponse

Create new activities or update existing ones in a batch operation

Parameters:

  • upsert_activities_request (UpsertActivitiesRequest)

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 36

def upsert_activities(upsert_activities_request)
  path = '/api/v2/feeds/activities/batch'
  # Build request body
  body = upsert_activities_request

  # Make the API request
  @client.make_request(
    :post,
    path,
    body: body
  )
end

#upsert_collections(upsert_collections_request) ⇒ Models::UpsertCollectionsResponse

Insert new collections or update existing ones in a batch operation. Only the custom data field is updatable for existing collections.

Parameters:

  • upsert_collections_request (UpsertCollectionsRequest)

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 562

def upsert_collections(upsert_collections_request)
  path = '/api/v2/feeds/collections'
  # Build request body
  body = upsert_collections_request

  # Make the API request
  @client.make_request(
    :put,
    path,
    body: body
  )
end