Class: GetStream::Generated::CommonClient

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

Overview

Common API client with generated methods

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ CommonClient

Returns a new instance of CommonClient.



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

def initialize(client)
  @client = client
end

Instance Method Details

#add_user_group_members(_id, add_user_group_members_request) ⇒ Models::AddUserGroupMembersResponse

Adds members to a user group. All user IDs must exist. The operation is all-or-nothing.

Parameters:

  • _id (String)
  • add_user_group_members_request (AddUserGroupMembersRequest)

Returns:



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1285

def add_user_group_members(_id, add_user_group_members_request)
  path = '/api/v2/usergroups/{id}/members'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = add_user_group_members_request

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

#block_users(block_users_request) ⇒ Models::BlockUsersResponse

Block users

Parameters:

  • block_users_request (BlockUsersRequest)

Returns:



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

def block_users(block_users_request)
  path = '/api/v2/users/block'
  # Build request body
  body = block_users_request

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

#cancel_import_v2_task(_id) ⇒ Models::CancelImportV2TaskResponse

Requests a controlled stop of an import v2 task. Allowed only for tasks in queued or processing state; a processing import stops cleanly on its next progress tick.

Parameters:

  • _id (String)

Returns:



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

def cancel_import_v2_task(_id)
  path = '/api/v2/imports/v2/{id}/cancel'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)

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

#check_external_storage(name) ⇒ Models::CheckExternalStorageResponse

Parameters:

  • name (String)

Returns:



361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 361

def check_external_storage(name)
  path = '/api/v2/external_storage/{name}/check'
  # Replace path parameters
  path = path.gsub('{name}', name.to_s)

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

#check_push(check_push_request) ⇒ Models::CheckPushResponse

Sends a test message via push, this is a test endpoint to verify your push settings

Parameters:

  • check_push_request (CheckPushRequest)

Returns:



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

def check_push(check_push_request)
  path = '/api/v2/check_push'
  # Build request body
  body = check_push_request

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

#check_sns(check_sns_request) ⇒ Models::CheckSNSResponse

Validates Amazon SNS configuration

Parameters:

  • check_sns_request (CheckSNSRequest)

Returns:



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 189

def check_sns(check_sns_request)
  path = '/api/v2/check_sns'
  # Build request body
  body = check_sns_request

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

#check_sqs(check_sqs_request) ⇒ Models::CheckSQSResponse

Validates Amazon SQS credentials

Parameters:

  • check_sqs_request (CheckSQSRequest)

Returns:



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

def check_sqs(check_sqs_request)
  path = '/api/v2/check_sqs'
  # Build request body
  body = check_sqs_request

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

#create_block_list(create_block_list_request) ⇒ Models::CreateBlockListResponse

Creates a new application blocklist, once created the blocklist can be used by any channel type

Parameters:

  • create_block_list_request (CreateBlockListRequest)

Returns:



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

def create_block_list(create_block_list_request)
  path = '/api/v2/blocklists'
  # Build request body
  body = create_block_list_request

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

#create_device(create_device_request) ⇒ Models::Response

Adds a new device to a user, if the same device already exists the call will have no effect

Parameters:

  • create_device_request (CreateDeviceRequest)

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 261

def create_device(create_device_request)
  path = '/api/v2/devices'
  # Build request body
  body = create_device_request

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

#create_external_storage(create_external_storage_request) ⇒ Models::CreateExternalStorageResponse

Creates new external storage

Parameters:

  • create_external_storage_request (CreateExternalStorageRequest)

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 308

def create_external_storage(create_external_storage_request)
  path = '/api/v2/external_storage'
  # Build request body
  body = create_external_storage_request

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

#create_guest(create_guest_request) ⇒ Models::CreateGuestResponse

Parameters:

  • create_guest_request (CreateGuestRequest)

Returns:



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

def create_guest(create_guest_request)
  path = '/api/v2/guest'
  # Build request body
  body = create_guest_request

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

#create_import(create_import_request) ⇒ Models::CreateImportResponse

Creates a new import

Parameters:

  • create_import_request (CreateImportRequest)

Returns:



424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 424

def create_import(create_import_request)
  path = '/api/v2/imports'
  # Build request body
  body = create_import_request

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

#create_import_url(create_import_url_request) ⇒ Models::CreateImportURLResponse

Creates a new import URL

Parameters:

  • create_import_url_request (CreateImportURLRequest)

Returns:



394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 394

def create_import_url(create_import_url_request)
  path = '/api/v2/import_urls'
  # Build request body
  body = create_import_url_request

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

#create_import_v2_task(create_import_v2_task_request) ⇒ Models::CreateImportV2TaskResponse

Creates a new import v2 task

Parameters:

  • create_import_v2_task_request (CreateImportV2TaskRequest)

Returns:



459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 459

def create_import_v2_task(create_import_v2_task_request)
  path = '/api/v2/imports/v2'
  # Build request body
  body = create_import_v2_task_request

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

#create_poll(create_poll_request) ⇒ Models::PollResponse

Creates a new poll

Parameters:

  • create_poll_request (CreatePollRequest)

Returns:



643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 643

def create_poll(create_poll_request)
  path = '/api/v2/polls'
  # Build request body
  body = create_poll_request

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

#create_poll_option(poll_id, create_poll_option_request) ⇒ Models::PollOptionResponse

Creates a poll optionSends events:- feeds.poll.updated- poll.updated

Parameters:

  • poll_id (String)
  • create_poll_option_request (CreatePollOptionRequest)

Returns:



762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 762

def create_poll_option(poll_id, create_poll_option_request)
  path = '/api/v2/polls/{poll_id}/options'
  # Replace path parameters
  path = path.gsub('{poll_id}', poll_id.to_s)
  # Build request body
  body = create_poll_option_request

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

#create_role(create_role_request) ⇒ Models::CreateRoleResponse

Creates custom role

Parameters:

  • create_role_request (CreateRoleRequest)

Returns:



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1010

def create_role(create_role_request)
  path = '/api/v2/roles'
  # Build request body
  body = create_role_request

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

#create_user_group(create_user_group_request) ⇒ Models::CreateUserGroupResponse

Creates a new user group, optionally with initial members

Parameters:

  • create_user_group_request (CreateUserGroupRequest)

Returns:



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1179

def create_user_group(create_user_group_request)
  path = '/api/v2/usergroups'
  # Build request body
  body = create_user_group_request

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

#deactivate_user(user_id, deactivate_user_request) ⇒ Models::DeactivateUserResponse

Deactivates user with possibility to activate it backSends events:- user.deactivated

Parameters:

  • user_id (String)
  • deactivate_user_request (DeactivateUserRequest)

Returns:



1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1537

def deactivate_user(user_id, deactivate_user_request)
  path = '/api/v2/users/{user_id}/deactivate'
  # Replace path parameters
  path = path.gsub('{user_id}', user_id.to_s)
  # Build request body
  body = deactivate_user_request

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

#deactivate_users(deactivate_users_request) ⇒ Models::DeactivateUsersResponse

Deactivate users in batchesSends events:- user.deactivated

Parameters:

  • deactivate_users_request (DeactivateUsersRequest)

Returns:



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

def deactivate_users(deactivate_users_request)
  path = '/api/v2/users/deactivate'
  # Build request body
  body = deactivate_users_request

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

#delete_block_list(name, team = nil, user_id = nil) ⇒ Models::Response

Deletes previously created application blocklist

Parameters:

  • name (String)
  • team (String) (defaults to: nil)
  • user_id (String) (defaults to: nil)

Returns:



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

def delete_block_list(name, team = nil, user_id = nil)
  path = '/api/v2/blocklists/{name}'
  # Replace path parameters
  path = path.gsub('{name}', name.to_s)
  # Build query parameters
  query_params = {}
  query_params['team'] = team unless team.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_device(_id, user_id = nil) ⇒ Models::Response

Deletes one device

Parameters:

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

Returns:



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 224

def delete_device(_id, user_id = nil)
  path = '/api/v2/devices'
  # Build query parameters
  query_params = {}
  query_params['id'] = _id unless _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_external_storage(name) ⇒ Models::DeleteExternalStorageResponse

Deletes external storage

Parameters:

  • name (String)

Returns:



325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 325

def delete_external_storage(name)
  path = '/api/v2/external_storage/{name}'
  # Replace path parameters
  path = path.gsub('{name}', name.to_s)

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

#delete_file(url = nil) ⇒ Models::Response

Deletes previously uploaded file

Parameters:

  • url (String) (defaults to: nil)

Returns:



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1085

def delete_file(url = nil)
  path = '/api/v2/uploads/file'
  # Build query parameters
  query_params = {}
  query_params['url'] = url unless url.nil?

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

#delete_image(url = nil) ⇒ Models::Response

Deletes previously uploaded image

Parameters:

  • url (String) (defaults to: nil)

Returns:



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1120

def delete_image(url = nil)
  path = '/api/v2/uploads/image'
  # Build query parameters
  query_params = {}
  query_params['url'] = url unless url.nil?

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

#delete_import_v2_task(_id) ⇒ Models::DeleteImportV2TaskResponse

Deletes an import v2 task. Can only delete tasks in queued state.

Parameters:

  • _id (String)

Returns:



532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 532

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

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

#delete_importer_external_storage ⇒ Models::DeleteExternalStorageResponse

Removes the external storage configuration for the app. Idempotent: succeeds even if no configuration exists.

Returns:



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

def delete_importer_external_storage()
  path = '/api/v2/imports/v2/external-storage'

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

#delete_poll(poll_id, user_id = nil) ⇒ Models::Response

Deletes a pollSends events:- feeds.poll.deleted- poll.deleted

Parameters:

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

Returns:



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

def delete_poll(poll_id, user_id = nil)
  path = '/api/v2/polls/{poll_id}'
  # Replace path parameters
  path = path.gsub('{poll_id}', poll_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

#delete_poll_option(poll_id, option_id, user_id = nil) ⇒ Models::Response

Deletes a poll optionSends events:- feeds.poll.updated- poll.updated

Parameters:

  • poll_id (String)
  • option_id (String)
  • user_id (String) (defaults to: nil)

Returns:



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 803

def delete_poll_option(poll_id, option_id, user_id = nil)
  path = '/api/v2/polls/{poll_id}/options/{option_id}'
  # Replace path parameters
  path = path.gsub('{poll_id}', poll_id.to_s)
  path = path.gsub('{option_id}', option_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

#delete_push_provider(_type, name) ⇒ Models::Response

Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint

Parameters:

  • _type (String)
  • name (String)

Returns:



915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 915

def delete_push_provider(_type, name)
  path = '/api/v2/push_providers/{type}/{name}'
  # Replace path parameters
  path = path.gsub('{type}', _type.to_s)
  path = path.gsub('{name}', name.to_s)

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

#delete_role(name) ⇒ Models::Response

Deletes custom role

Parameters:

  • name (String)

Returns:



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1053

def delete_role(name)
  path = '/api/v2/roles/{name}'
  # Replace path parameters
  path = path.gsub('{name}', name.to_s)

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

#delete_user_group(_id, team_id = nil) ⇒ Models::Response

Deletes a user group and all its members

Parameters:

  • _id (String)
  • team_id (String) (defaults to: nil)

Returns:



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1223

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

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

#delete_users(delete_users_request) ⇒ Models::DeleteUsersResponse

Deletes users and optionally all their belongings asynchronously.Sends events:- channel.deleted- user.deleted

Parameters:

  • delete_users_request (DeleteUsersRequest)

Returns:



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

def delete_users(delete_users_request)
  path = '/api/v2/users/delete'
  # Build request body
  body = delete_users_request

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

#export_user(user_id) ⇒ Models::ExportUserResponse

Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions

Parameters:

  • user_id (String)

Returns:



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

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

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

#export_users(export_users_request) ⇒ Models::ExportUsersResponse

Exports user profile, reactions and messages for list of given users

Parameters:

  • export_users_request (ExportUsersRequest)

Returns:



278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 278

def export_users(export_users_request)
  path = '/api/v2/export/users'
  # Build request body
  body = export_users_request

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

#get_app ⇒ Models::GetApplicationResponse

This Method returns the application settings

Returns:



18
19
20
21
22
23
24
25
26
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 18

def get_app()
  path = '/api/v2/app'

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

#get_block_list(name, team = nil) ⇒ Models::GetBlockListResponse

Returns block list by given name

Parameters:

  • name (String)
  • team (String) (defaults to: nil)

Returns:



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

def get_block_list(name, team = nil)
  path = '/api/v2/blocklists/{name}'
  # Replace path parameters
  path = path.gsub('{name}', name.to_s)
  # Build query parameters
  query_params = {}
  query_params['team'] = team unless team.nil?

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

#get_blocked_users(user_id = nil) ⇒ Models::GetBlockedUsersResponse

Get list of blocked Users

Parameters:

  • user_id (String) (defaults to: nil)

Returns:



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

def get_blocked_users(user_id = nil)
  path = '/api/v2/users/block'
  # Build query parameters
  query_params = {}
  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_import(_id) ⇒ Models::GetImportResponse

Gets an import

Parameters:

  • _id (String)

Returns:



580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 580

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

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

#get_import_v2_task(_id) ⇒ Models::GetImportV2TaskResponse

Gets a single import v2 task by ID

Parameters:

  • _id (String)

Returns:



548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 548

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

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

#get_importer_external_storage ⇒ Models::GetExternalStorageResponse

Returns the current external storage configuration for the app. Returns 404 if no configuration exists.

Returns:



488
489
490
491
492
493
494
495
496
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 488

def get_importer_external_storage()
  path = '/api/v2/imports/v2/external-storage'

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

#get_og(url) ⇒ Models::GetOGResponse

Get an OpenGraph attachment for a link

Parameters:

  • url (String)

Returns:



596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 596

def get_og(url)
  path = '/api/v2/og'
  # Build query parameters
  query_params = {}
  query_params['url'] = url unless url.nil?

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

#get_permission(_id) ⇒ Models::GetCustomPermissionResponse

Gets custom permission

Parameters:

  • _id (String)

Returns:



627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 627

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

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

#get_poll(poll_id, user_id = nil) ⇒ Models::PollResponse

Retrieves a poll

Parameters:

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

Returns:



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 721

def get_poll(poll_id, user_id = nil)
  path = '/api/v2/polls/{poll_id}'
  # Replace path parameters
  path = path.gsub('{poll_id}', poll_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(
    :get,
    path,
    query_params: query_params
  )
end

#get_poll_option(poll_id, option_id) ⇒ Models::PollOptionResponse

Retrieves a poll option

Parameters:

  • poll_id (String)
  • option_id (String)

Returns:



825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 825

def get_poll_option(poll_id, option_id)
  path = '/api/v2/polls/{poll_id}/options/{option_id}'
  # Replace path parameters
  path = path.gsub('{poll_id}', poll_id.to_s)
  path = path.gsub('{option_id}', option_id.to_s)

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

#get_push_templates(push_provider_type, push_provider_name = nil) ⇒ Models::GetPushTemplatesResponse

Retrieve push notification templates for Chat.

Parameters:

  • push_provider_type (String)
  • push_provider_name (String) (defaults to: nil)

Returns:



933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 933

def get_push_templates(push_provider_type, push_provider_name = nil)
  path = '/api/v2/push_templates'
  # Build query parameters
  query_params = {}
  query_params['push_provider_type'] = push_provider_type unless push_provider_type.nil?
  query_params['push_provider_name'] = push_provider_name unless push_provider_name.nil?

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

#get_rate_limits(server_side = nil, android = nil, ios = nil, web = nil, unity = nil, endpoints = nil) ⇒ Models::GetRateLimitsResponse

Get rate limits usage and quotas

Parameters:

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

Returns:



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

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

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

#get_task(_id) ⇒ Models::GetTaskResponse

Gets status of a task

Parameters:

  • _id (String)

Returns:



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1069

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

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

#get_user_group(_id, team_id = nil) ⇒ Models::GetUserGroupResponse

Gets a user group by ID, including its members

Parameters:

  • _id (String)
  • team_id (String) (defaults to: nil)

Returns:



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1244

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

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

#get_user_live_locations(user_id = nil) ⇒ Models::SharedLocationsResponse

Retrieves all active live locations for a user

Parameters:

  • user_id (String) (defaults to: nil)

Returns:



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1445

def get_user_live_locations(user_id = nil)
  path = '/api/v2/users/live_locations'
  # Build query parameters
  query_params = {}
  query_params['user_id'] = user_id unless user_id.nil?

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

#import_block_list(_id, import_block_list_request) ⇒ Models::ImportBlockListResponse

Enqueues an asynchronous bulk import of items into an existing blocklist.Returns a task ID that can be polled via GET /tasks/id to observe progress.AddItems is idempotent: items already present are skipped without error.For lists exceeding the HTTP request-body cap, issue repeated import calls eachcarrying a bounded slice of items — the task result accumulates correctly.

Parameters:

  • _id (String)
  • import_block_list_request (ImportBlockListRequest)

Returns:



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

def import_block_list(_id, import_block_list_request)
  path = '/api/v2/blocklists/{id}/import'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = import_block_list_request

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

#list_block_lists(team = nil, cursor = nil, limit = nil) ⇒ Models::ListBlockListResponse

Returns all available block lists

Parameters:

  • team (String) (defaults to: nil)
  • cursor (String) (defaults to: nil)
  • limit (Integer) (defaults to: nil)

Returns:



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

def list_block_lists(team = nil, cursor = nil, limit = nil)
  path = '/api/v2/blocklists'
  # Build query parameters
  query_params = {}
  query_params['team'] = team unless team.nil?
  query_params['cursor'] = cursor unless cursor.nil?
  query_params['limit'] = limit unless limit.nil?

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

#list_devices(user_id = nil) ⇒ Models::ListDevicesResponse

Returns all available devices

Parameters:

  • user_id (String) (defaults to: nil)

Returns:



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 243

def list_devices(user_id = nil)
  path = '/api/v2/devices'
  # Build query parameters
  query_params = {}
  query_params['user_id'] = user_id unless user_id.nil?

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

#list_external_storage ⇒ Models::ListExternalStorageResponse

Lists external storage

Returns:



294
295
296
297
298
299
300
301
302
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 294

def list_external_storage()
  path = '/api/v2/external_storage'

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

#list_import_v2_tasks(state = nil) ⇒ Models::ListImportV2TasksResponse

Lists all import v2 tasks for the app

Parameters:

  • state (Integer) (defaults to: nil)

Returns:



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 441

def list_import_v2_tasks(state = nil)
  path = '/api/v2/imports/v2'
  # Build query parameters
  query_params = {}
  query_params['state'] = state unless state.nil?

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

#list_imports ⇒ Models::ListImportsResponse

Gets an import

Returns:



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

def list_imports()
  path = '/api/v2/imports'

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

#list_permissions ⇒ Models::ListPermissionsResponse

Lists all available permissions

Returns:



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

def list_permissions()
  path = '/api/v2/permissions'

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

#list_push_providers ⇒ Models::ListPushProvidersResponse

List details of all push providers.

Returns:



883
884
885
886
887
888
889
890
891
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 883

def list_push_providers()
  path = '/api/v2/push_providers'

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

#list_roles ⇒ Models::ListRolesResponse

Lists all available roles

Returns:



996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 996

def list_roles()
  path = '/api/v2/roles'

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

#list_user_groups(limit = nil, id_gt = nil, created_at_gt = nil, team_id = nil) ⇒ Models::ListUserGroupsResponse

Lists user groups with cursor-based pagination

Parameters:

  • limit (Integer) (defaults to: nil)
  • id_gt (String) (defaults to: nil)
  • created_at_gt (String) (defaults to: nil)
  • team_id (String) (defaults to: nil)

Returns:



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1158

def list_user_groups(limit = nil, id_gt = nil, created_at_gt = nil, team_id = nil)
  path = '/api/v2/usergroups'
  # Build query parameters
  query_params = {}
  query_params['limit'] = limit unless limit.nil?
  query_params['id_gt'] = id_gt unless id_gt.nil?
  query_params['created_at_gt'] = created_at_gt unless created_at_gt.nil?
  query_params['team_id'] = team_id unless team_id.nil?

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

#query_poll_votes(poll_id, query_poll_votes_request, user_id = nil) ⇒ Models::PollVotesResponse

Queries votes

Parameters:

  • poll_id (String)
  • query_poll_votes_request (QueryPollVotesRequest)
  • user_id (String) (defaults to: nil)

Returns:



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 844

def query_poll_votes(poll_id, query_poll_votes_request, user_id = nil)
  path = '/api/v2/polls/{poll_id}/votes'
  # Replace path parameters
  path = path.gsub('{poll_id}', poll_id.to_s)
  # Build query parameters
  query_params = {}
  query_params['user_id'] = user_id unless user_id.nil?
  # Build request body
  body = query_poll_votes_request

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

#query_polls(query_polls_request, user_id = nil) ⇒ Models::QueryPollsResponse

Queries polls

Parameters:

  • query_polls_request (QueryPollsRequest)
  • user_id (String) (defaults to: nil)

Returns:



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

def query_polls(query_polls_request, user_id = nil)
  path = '/api/v2/polls/query'
  # Build query parameters
  query_params = {}
  query_params['user_id'] = user_id unless user_id.nil?
  # Build request body
  body = query_polls_request

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

#query_users(payload = nil) ⇒ Models::QueryUsersResponse

Find and filter users

Parameters:

  • payload (QueryUsersPayload) (defaults to: nil)

Returns:



1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1324

def query_users(payload = nil)
  path = '/api/v2/users'
  # Build query parameters
  query_params = {}
  query_params['payload'] = payload unless payload.nil?

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

#reactivate_user(user_id, reactivate_user_request) ⇒ Models::ReactivateUserResponse

Activates user who's been deactivated previouslySends events:- user.reactivated

Parameters:

  • user_id (String)
  • reactivate_user_request (ReactivateUserRequest)

Returns:



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

def reactivate_user(user_id, reactivate_user_request)
  path = '/api/v2/users/{user_id}/reactivate'
  # Replace path parameters
  path = path.gsub('{user_id}', user_id.to_s)
  # Build request body
  body = reactivate_user_request

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

#reactivate_users(reactivate_users_request) ⇒ Models::ReactivateUsersResponse

Reactivate users in batchesSends events:- user.reactivated

Parameters:

  • reactivate_users_request (ReactivateUsersRequest)

Returns:



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

def reactivate_users(reactivate_users_request)
  path = '/api/v2/users/reactivate'
  # Build request body
  body = reactivate_users_request

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

#remove_user_group_members(_id, remove_user_group_members_request) ⇒ Models::RemoveUserGroupMembersResponse

Removes members from a user group. Users already not in the group are silently ignored.

Parameters:

  • _id (String)
  • remove_user_group_members_request (RemoveUserGroupMembersRequest)

Returns:



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

def remove_user_group_members(_id, remove_user_group_members_request)
  path = '/api/v2/usergroups/{id}/members/delete'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = remove_user_group_members_request

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

#restore_users(restore_users_request) ⇒ Models::Response

Restore soft deleted users

Parameters:

  • restore_users_request (RestoreUsersRequest)

Returns:



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

def restore_users(restore_users_request)
  path = '/api/v2/users/restore'
  # Build request body
  body = restore_users_request

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

#search_roles(query, limit = nil, name_gt = nil, role_type = nil, include_global_roles = nil) ⇒ Models::SearchRolesResponse

Searches mentionable roles (user-assignable + channel-assignable, built-in and custom) by name prefix for autocomplete

Parameters:

  • query (String)
  • limit (Integer) (defaults to: nil)
  • name_gt (String) (defaults to: nil)
  • role_type (String) (defaults to: nil)
  • include_global_roles (Boolean) (defaults to: nil)

Returns:



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1031

def search_roles(query, limit = nil, name_gt = nil, role_type = nil, include_global_roles = nil)
  path = '/api/v2/roles/search'
  # Build query parameters
  query_params = {}
  query_params['query'] = query unless query.nil?
  query_params['limit'] = limit unless limit.nil?
  query_params['name_gt'] = name_gt unless name_gt.nil?
  query_params['role_type'] = role_type unless role_type.nil?
  query_params['include_global_roles'] = include_global_roles unless include_global_roles.nil?

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

#search_user_groups(query, limit = nil, name_gt = nil, id_gt = nil, team_id = nil) ⇒ Models::SearchUserGroupsResponse

Searches user groups by name prefix for autocomplete

Parameters:

  • query (String)
  • limit (Integer) (defaults to: nil)
  • name_gt (String) (defaults to: nil)
  • id_gt (String) (defaults to: nil)
  • team_id (String) (defaults to: nil)

Returns:



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

def search_user_groups(query, limit = nil, name_gt = nil, id_gt = nil, team_id = nil)
  path = '/api/v2/usergroups/search'
  # Build query parameters
  query_params = {}
  query_params['query'] = query unless query.nil?
  query_params['limit'] = limit unless limit.nil?
  query_params['name_gt'] = name_gt unless name_gt.nil?
  query_params['id_gt'] = id_gt unless id_gt.nil?
  query_params['team_id'] = team_id unless team_id.nil?

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

#unblock_users(unblock_users_request) ⇒ Models::UnblockUsersResponse

Unblock users

Parameters:

  • unblock_users_request (UnblockUsersRequest)

Returns:



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

def unblock_users(unblock_users_request)
  path = '/api/v2/users/unblock'
  # Build request body
  body = unblock_users_request

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

#update_app(update_app_request) ⇒ Models::Response

This Method updates one or more application settings

Parameters:

  • update_app_request (UpdateAppRequest)

Returns:



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 32

def update_app(update_app_request)
  path = '/api/v2/app'
  # Build request body
  body = update_app_request

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

#update_block_list(name, update_block_list_request) ⇒ Models::UpdateBlockListResponse

Updates contents of the block list

Parameters:

  • name (String)
  • update_block_list_request (UpdateBlockListRequest)

Returns:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 153

def update_block_list(name, update_block_list_request)
  path = '/api/v2/blocklists/{name}'
  # Replace path parameters
  path = path.gsub('{name}', name.to_s)
  # Build request body
  body = update_block_list_request

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

#update_external_storage(name, update_external_storage_request) ⇒ Models::UpdateExternalStorageResponse

Parameters:

  • name (String)
  • update_external_storage_request (UpdateExternalStorageRequest)

Returns:



342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 342

def update_external_storage(name, update_external_storage_request)
  path = '/api/v2/external_storage/{name}'
  # Replace path parameters
  path = path.gsub('{name}', name.to_s)
  # Build request body
  body = update_external_storage_request

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

#update_live_location(update_live_location_request, user_id = nil) ⇒ Models::SharedLocationResponse

Updates an existing live location with new coordinates or expiration time

Parameters:

  • update_live_location_request (UpdateLiveLocationRequest)
  • user_id (String) (defaults to: nil)

Returns:



1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1464

def update_live_location(update_live_location_request, user_id = nil)
  path = '/api/v2/users/live_locations'
  # Build query parameters
  query_params = {}
  query_params['user_id'] = user_id unless user_id.nil?
  # Build request body
  body = update_live_location_request

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

#update_poll(update_poll_request) ⇒ Models::PollResponse

Updates a pollSends events:- feeds.poll.closed- feeds.poll.updated- poll.closed- poll.updated

Parameters:

  • update_poll_request (UpdatePollRequest)

Returns:



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

def update_poll(update_poll_request)
  path = '/api/v2/polls'
  # Build request body
  body = update_poll_request

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

#update_poll_option(poll_id, update_poll_option_request) ⇒ Models::PollOptionResponse

Updates a poll optionSends events:- feeds.poll.updated- poll.updated

Parameters:

  • poll_id (String)
  • update_poll_option_request (UpdatePollOptionRequest)

Returns:



782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 782

def update_poll_option(poll_id, update_poll_option_request)
  path = '/api/v2/polls/{poll_id}/options'
  # Replace path parameters
  path = path.gsub('{poll_id}', poll_id.to_s)
  # Build request body
  body = update_poll_option_request

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

#update_poll_partial(poll_id, update_poll_partial_request) ⇒ Models::PollResponse

Updates a poll partiallySends events:- feeds.poll.closed- feeds.poll.updated- poll.closed- poll.updated

Parameters:

  • poll_id (String)
  • update_poll_partial_request (UpdatePollPartialRequest)

Returns:



742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 742

def update_poll_partial(poll_id, update_poll_partial_request)
  path = '/api/v2/polls/{poll_id}'
  # Replace path parameters
  path = path.gsub('{poll_id}', poll_id.to_s)
  # Build request body
  body = update_poll_partial_request

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

#update_push_notification_preferences(upsert_push_preferences_request) ⇒ Models::UpsertPushPreferencesResponse

Upserts the push preferences for a user and or channel member. Set to all, mentions or none

Parameters:

  • upsert_push_preferences_request (UpsertPushPreferencesRequest)

Returns:



867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 867

def update_push_notification_preferences(upsert_push_preferences_request)
  path = '/api/v2/push_preferences'
  # Build request body
  body = upsert_push_preferences_request

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

#update_user_group(_id, update_user_group_request) ⇒ Models::UpdateUserGroupResponse

Updates a user group's name and/or description. team_id is immutable.

Parameters:

  • _id (String)
  • update_user_group_request (UpdateUserGroupRequest)

Returns:



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1265

def update_user_group(_id, update_user_group_request)
  path = '/api/v2/usergroups/{id}'
  # Replace path parameters
  path = path.gsub('{id}', _id.to_s)
  # Build request body
  body = update_user_group_request

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

#update_users(update_users_request) ⇒ Models::UpdateUsersResponse

Update or create users in bulkSends events:- user.updated

Parameters:

  • update_users_request (UpdateUsersRequest)

Returns:



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

def update_users(update_users_request)
  path = '/api/v2/users'
  # Build request body
  body = update_users_request

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

#update_users_partial(update_users_partial_request) ⇒ Models::UpdateUsersResponse

Updates certain fields of the userSends events:- user.presence.changed- user.updated

Parameters:

  • update_users_partial_request (UpdateUsersPartialRequest)

Returns:



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

def update_users_partial(update_users_partial_request)
  path = '/api/v2/users'
  # Build request body
  body = update_users_partial_request

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

#upload_file(file_upload_request) ⇒ Models::FileUploadResponse

Uploads file

Parameters:

  • file_upload_request (FileUploadRequest)

Returns:



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

def upload_file(file_upload_request)
  path = '/api/v2/uploads/file'
  # Build request body
  body = file_upload_request

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

#upload_image(image_upload_request) ⇒ Models::ImageUploadResponse

Uploads image

Parameters:

  • image_upload_request (ImageUploadRequest)

Returns:



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1138

def upload_image(image_upload_request)
  path = '/api/v2/uploads/image'
  # Build request body
  body = image_upload_request

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

#upsert_importer_external_storage(upsert_external_storage_request) ⇒ Models::UpsertExternalStorageResponse

Creates or updates the external storage configuration for the app. Supports AWS S3 (via cross-account IAM role assumption) and GCS (via service-account JSON credentials).

Parameters:

  • upsert_external_storage_request (UpsertExternalStorageRequest)

Returns:



502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 502

def upsert_importer_external_storage(upsert_external_storage_request)
  path = '/api/v2/imports/v2/external-storage'
  # Build request body
  body = upsert_external_storage_request

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

#upsert_push_provider(upsert_push_provider_request) ⇒ Models::UpsertPushProviderResponse

Upsert a push provider for v2 with multi bundle/package support

Parameters:

  • upsert_push_provider_request (UpsertPushProviderRequest)

Returns:



897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 897

def upsert_push_provider(upsert_push_provider_request)
  path = '/api/v2/push_providers'
  # Build request body
  body = upsert_push_provider_request

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

#upsert_push_template(upsert_push_template_request) ⇒ Models::UpsertPushTemplateResponse

Create or update a push notification template for a specific event type and push provider

Parameters:

  • upsert_push_template_request (UpsertPushTemplateRequest)

Returns:



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

def upsert_push_template(upsert_push_template_request)
  path = '/api/v2/push_templates'
  # Build request body
  body = upsert_push_template_request

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

#validate_importer_external_storage ⇒ Models::ValidateExternalStorageResponse

Validates the configured external storage. For AWS S3, performs a live STS AssumeRole and S3 ListObjectsV2 check. For GCS, performs a live bucket listing check using the configured service-account credentials.

Returns:



518
519
520
521
522
523
524
525
526
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 518

def validate_importer_external_storage()
  path = '/api/v2/imports/v2/external-storage/validate'

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