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:



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

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:



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1399

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:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 151

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:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 218

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:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 131

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:



550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 550

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:



659
660
661
662
663
664
665
666
667
668
669
670
671
672
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 659

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:



567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 567

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:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 172

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:



482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 482

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:



772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 772

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:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1133

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:



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

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:



1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1502

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:



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

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) ⇒ Models::DeleteActivityResponse

Delete a single activity by its ID

Parameters:

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

Returns:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 281

def delete_activity(_id, hard_delete = 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?

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

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

Removes a reaction from an activity

Parameters:

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

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 259

def delete_activity_reaction(activity_id, _type, 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['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:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 89

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:



374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 374

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:



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 427

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) ⇒ Models::DeleteCommentResponse

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

Parameters:

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

Returns:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 602

def delete_comment(_id, hard_delete = 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?

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

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

Deletes a reaction from a comment

Parameters:

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

Returns:



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

def delete_comment_reaction(_id, _type, 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['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:



791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 791

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:



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

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:



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1624

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:



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

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:



1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1288

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:



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1536

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:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 195

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:



1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1643

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:



1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1382

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:



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1416

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:



301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 301

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:



622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 622

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:



728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 728

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:



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 524

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:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1060

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:



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1166

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:



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1235

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:



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1343

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:



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

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:



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 814

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:



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1081

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:



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1183

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:



1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1433

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:



1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1606

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:



754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 754

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:



1119
1120
1121
1122
1123
1124
1125
1126
1127
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1119

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:



1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1221

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:



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

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:



1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1305

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:



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 906

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:



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

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:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 238

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:



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

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:



410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 410

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:



679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 679

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:



584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 584

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:



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

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:



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1322

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:



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

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:



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

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:



1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1519

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

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

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

Parameters:

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

Returns:



446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 446

def read_collections(collection_refs, user_id = nil)
  path = '/api/v2/feeds/collections'
  # Build query parameters
  query_params = {}
  query_params['collection_refs'] = collection_refs unless collection_refs.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

#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:



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

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:



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1467

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

#unfollow(source, target) ⇒ Models::UnfollowResponse

Removes a follow and broadcasts FollowRemovedEvent

Parameters:

  • source (String)
  • target (String)

Returns:



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1485

def unfollow(source, target)
  path = '/api/v2/feeds/follows/{source}/{target}'
  # Replace path parameters
  path = path.gsub('{source}', source.to_s)
  path = path.gsub('{target}', target.to_s)

  # Make the API request
  @client.make_request(
    :delete,
    path
  )
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:



1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1589

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, 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)
  • user_id (String) (defaults to: nil)

Returns:



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

def unpin_activity(feed_group_id, feed_id, activity_id, 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['user_id'] = user_id unless user_id.nil?

  # Make the API request
  @client.make_request(
    :delete,
    path,
    query_params: query_params
  )
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:



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

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:



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

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:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 111

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:



391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 391

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:



465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 465

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:



639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 639

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:



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

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:



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1101

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:



929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 929

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:



1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1203

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:



1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1252

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:



1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1365

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:



1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 1553

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:



499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/getstream_ruby/generated/feeds_client.rb', line 499

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