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

#block_users(block_users_request) ⇒ Models::BlockUsersResponse

Block users

Parameters:

  • block_users_request (BlockUsersRequest)

Returns:



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

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:



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

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:



664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 664

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:



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

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

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



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

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:



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

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:



964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 964

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:



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

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:



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

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



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

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:



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

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:



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

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:



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

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



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

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:



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

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:



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

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:



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

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:



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

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_og(url) ⇒ Models::GetOGResponse

Get an OpenGraph attachment for a link

Parameters:

  • url (String)

Returns:



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

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:



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

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:



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

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:



728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 728

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:



840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 840

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:



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

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:



948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 948

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_live_locations(user_id = nil) ⇒ Models::SharedLocationsResponse

Retrieves all active live locations for a user

Parameters:

  • user_id (String) (defaults to: nil)

Returns:



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1155

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:



515
516
517
518
519
520
521
522
523
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 515

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:



790
791
792
793
794
795
796
797
798
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 790

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:



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

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

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



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 751

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:



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

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:



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

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:



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

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- user.reactivated

Parameters:

  • reactivate_users_request (ReactivateUsersRequest)

Returns:



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1195

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

#restore_users(restore_users_request) ⇒ Models::Response

Restore soft deleted users

Parameters:

  • restore_users_request (RestoreUsersRequest)

Returns:



1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1212

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

#unblock_users(unblock_users_request) ⇒ Models::UnblockUsersResponse

Unblock users

Parameters:

  • unblock_users_request (UnblockUsersRequest)

Returns:



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1229

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:



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1174

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:



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

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:



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

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:



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

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:



774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 774

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_users(update_users_request) ⇒ Models::UpdateUsersResponse

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

Parameters:

  • update_users_request (UpdateUsersRequest)

Returns:



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

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- user.presence.changed

Parameters:

  • update_users_partial_request (UpdateUsersPartialRequest)

Returns:



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

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:



982
983
984
985
986
987
988
989
990
991
992
993
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 982

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:



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/getstream_ruby/generated/common_client.rb', line 1017

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



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

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:



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

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