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:



1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1220

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:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1329

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

#check_external_storage(name) ⇒ Models::CheckExternalStorageResponse

Parameters:

  • name (String)

Returns:



335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 335

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:



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

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:



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 163

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:



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 180

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:



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 67

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:



235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 235

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:



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

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:



351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 351

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:



398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 398

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:



368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 368

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:



433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 433

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:



601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 601

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:



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

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:



971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 971

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:



1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1114

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:



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

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:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1346

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

Deletes previously created application blocklist

Parameters:

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

Returns:



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

def delete_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(
    :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:



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

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:



299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 299

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:



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

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:



1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1055

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:



506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 506

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:



449
450
451
452
453
454
455
456
457
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 449

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:



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

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:



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

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:



878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 878

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:



988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 988

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:



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

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:



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1363

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:



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

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:



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

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:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 106

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:



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

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:



538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 538

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:



522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 522

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:



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

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:



554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 554

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:



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

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:



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

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, user_id = nil) ⇒ Models::PollOptionResponse

Retrieves a poll option

Parameters:

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

Returns:



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

def get_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(
    :get,
    path,
    query_params: query_params
  )
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:



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

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

Returns:



936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 936

def get_rate_limits(server_side = nil, android = nil, ios = nil, web = 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['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:



1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1004

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:



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

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:



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

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

#list_block_lists(team = nil) ⇒ Models::ListBlockListResponse

Returns all available block lists

Parameters:

  • team (String) (defaults to: nil)

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 49

def list_block_lists(team = nil)
  path = '/api/v2/blocklists'
  # 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

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

Returns all available devices

Parameters:

  • user_id (String) (defaults to: nil)

Returns:



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

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:



268
269
270
271
272
273
274
275
276
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 268

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:



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 415

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:



384
385
386
387
388
389
390
391
392
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 384

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:



571
572
573
574
575
576
577
578
579
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 571

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:



846
847
848
849
850
851
852
853
854
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 846

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:



957
958
959
960
961
962
963
964
965
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 957

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:



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1093

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:



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 807

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:



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

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:



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1259

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:



1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1508

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:



1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1420

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:



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

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:



1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1437

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



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

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:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1454

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:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 127

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:



316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 316

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:



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1399

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:



618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 618

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:



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

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:



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

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:



830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 830

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:



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

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:



1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1294

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:



1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1277

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:



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1038

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:



1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1073

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. Currently only AWS S3 (via cross-account IAM role assumption) is supported.

Parameters:

  • upsert_external_storage_request (UpsertExternalStorageRequest)

Returns:



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

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:



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

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:



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

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 S3 storage by performing a live STS AssumeRole and S3 ListObjectsV2 check.

Returns:



492
493
494
495
496
497
498
499
500
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 492

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

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