Class: StreamChat::Client

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/stream-chat/client.rb

Constant Summary collapse

DEFAULT_BASE_URL = 
'https://chat.stream-io-api.com'
DEFAULT_TIMEOUT = 
6.0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key, api_secret, timeout = nil, **options) ⇒ Client

Returns a new instance of Client.

Raises:

  • (ArgumentError) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/stream-chat/client.rb', line 54

def initialize(api_key, api_secret, timeout = nil, **options)
  raise ArgumentError, 'api_key and api_secret are required' if api_key.to_s.empty? || api_secret.to_s.empty?

  @api_key = api_key
  @api_secret = api_secret
  @timeout = T.let(timeout&.to_f || DEFAULT_TIMEOUT, Float)
  @auth_token = T.let(JWT.encode({ server: true }, @api_secret, 'HS256'), String)
  @base_url = T.let(options[:base_url] || DEFAULT_BASE_URL, String)
  conn = Faraday.new(@base_url) do |faraday|
    faraday.options[:open_timeout] = @timeout
    faraday.options[:timeout] = @timeout
    faraday.request :multipart
    faraday.adapter :net_http_persistent, pool_size: 5 do |http|
      # AWS load balancer idle timeout is 60 secs, so let's make it 59
      http.idle_timeout = 59
    end
  end
  @conn = T.let(conn, Faraday::Connection)
  @moderation = T.let(Moderation.new(self), Moderation)
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



32
33
34
 
# File 'lib/stream-chat/client.rb', line 32

def api_key
  @api_key
end

#api_secret ⇒ Object (readonly)

Returns the value of attribute api_secret.



35
36
37
 
# File 'lib/stream-chat/client.rb', line 35

def api_secret
  @api_secret
end

#conn ⇒ Object (readonly)

Returns the value of attribute conn.



38
39
40
 
# File 'lib/stream-chat/client.rb', line 38

def conn
  @conn
end

#moderation ⇒ Object (readonly)

Returns the value of attribute moderation.



41
42
43
 
# File 'lib/stream-chat/client.rb', line 41

def moderation
  @moderation
end

Class Method Details

.from_env(**options) ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/stream-chat/client.rb', line 80

def self.from_env(**options)
  Client.new(ENV.fetch('STREAM_KEY'),
             ENV.fetch('STREAM_SECRET'),
             ENV.fetch('STREAM_CHAT_TIMEOUT', DEFAULT_TIMEOUT),
             base_url: ENV.fetch('STREAM_CHAT_URL', DEFAULT_BASE_URL),
             **options)
end

Instance Method Details

#add_device(device_id, push_provider, user_id, push_provider_name = nil) ⇒ Object 



530
531
532
533
534
535
536
537
 
# File 'lib/stream-chat/client.rb', line 530

def add_device(device_id, push_provider, user_id, push_provider_name = nil)
  post('devices', data: {
         id: device_id,
         push_provider: push_provider,
         push_provider_name: push_provider_name,
         user_id: user_id
       })
end

#ban_user(target_id, **options) ⇒ Object 



310
311
312
313
 
# File 'lib/stream-chat/client.rb', line 310

def ban_user(target_id, **options)
  payload = { target_user_id: target_id }.merge(options)
  post('moderation/ban', data: payload)
end

#channel(channel_type, channel_id: nil, data: nil) ⇒ Object 



524
525
526
 
# File 'lib/stream-chat/client.rb', line 524

def channel(channel_type, channel_id: nil, data: nil)
  StreamChat::Channel.new(self, channel_type, channel_id, data)
end

#check_push(push_data) ⇒ Object 



788
789
790
 
# File 'lib/stream-chat/client.rb', line 788

def check_push(push_data)
  post('check_push', data: push_data)
end

#check_sns(sns_key = nil, sns_secret = nil, sns_topic_arn = nil) ⇒ Object 



804
805
806
 
# File 'lib/stream-chat/client.rb', line 804

def check_sns(sns_key = nil, sns_secret = nil, sns_topic_arn = nil)
  post('check_sns', data: { sns_key: sns_key, sns_secret: sns_secret, sns_topic_arn: sns_topic_arn })
end

#check_sqs(sqs_key = nil, sqs_secret = nil, sqs_url = nil) ⇒ Object 



796
797
798
 
# File 'lib/stream-chat/client.rb', line 796

def check_sqs(sqs_key = nil, sqs_secret = nil, sqs_url = nil)
  post('check_sqs', data: { sqs_key: sqs_key, sqs_secret: sqs_secret, sqs_url: sqs_url })
end

#commit_message(message_id) ⇒ Object 



405
406
407
 
# File 'lib/stream-chat/client.rb', line 405

def commit_message(message_id)
  post("messages/#{message_id}/commit")
end

#create_blocklist(name, words) ⇒ Object 



635
636
637
 
# File 'lib/stream-chat/client.rb', line 635

def create_blocklist(name, words)
  post('blocklists', data: { name: name, words: words })
end

#create_channel_type(data) ⇒ Object 



486
487
488
489
 
# File 'lib/stream-chat/client.rb', line 486

def create_channel_type(data)
  data['commands'] = ['all'] unless data.key?('commands') || data['commands'].nil? || data['commands'].empty?
  post('channeltypes', data: data)
end

#create_command(command) ⇒ Object 



810
811
812
 
# File 'lib/stream-chat/client.rb', line 810

def create_command(command)
  post('commands', data: command)
end

#create_guest(user) ⇒ Object 



599
600
601
 
# File 'lib/stream-chat/client.rb', line 599

def create_guest(user)
  post('guests', data: user)
end

#create_import(path, mode) ⇒ Object 



936
937
938
 
# File 'lib/stream-chat/client.rb', line 936

def create_import(path, mode)
  post('imports', data: { path: path, mode: mode })
end

#create_import_url(filename) ⇒ Object 



926
927
928
 
# File 'lib/stream-chat/client.rb', line 926

def create_import_url(filename)
  post('import_urls', data: { filename: filename })
end

#create_permission(permission) ⇒ Object 



868
869
870
 
# File 'lib/stream-chat/client.rb', line 868

def create_permission(permission)
  post('permissions', data: permission)
end

#create_reminder(message_id, user_id, remind_at = nil) ⇒ Object 



968
969
970
971
972
 
# File 'lib/stream-chat/client.rb', line 968

def create_reminder(message_id, user_id, remind_at = nil)
  data = { user_id: user_id }
  data[:remind_at] = remind_at.rfc3339 if remind_at.instance_of?(DateTime)
  post("messages/#{message_id}/reminders", data: data)
end

#create_role(name) ⇒ Object 



886
887
888
 
# File 'lib/stream-chat/client.rb', line 886

def create_role(name)
  post('roles', data: { name: name })
end

#create_token(user_id, exp = nil, iat = nil) ⇒ Object 



103
104
105
106
107
108
 
# File 'lib/stream-chat/client.rb', line 103

def create_token(user_id, exp = nil, iat = nil)
  payload = { user_id: user_id }
  payload['exp'] = exp unless exp.nil?
  payload['iat'] = iat unless iat.nil?
  JWT.encode(payload, @api_secret, 'HS256')
end

#deactivate_user(user_id, **options) ⇒ Object 



280
281
282
 
# File 'lib/stream-chat/client.rb', line 280

def deactivate_user(user_id, **options)
  post("users/#{user_id}/deactivate", params: options)
end

#deactivate_users(user_ids, **options) ⇒ Object

Raises:

  • (ArgumentError) 


286
287
288
289
290
 
# File 'lib/stream-chat/client.rb', line 286

def deactivate_users(user_ids, **options)
  raise ArgumentError, 'user_ids should not be empty' if user_ids.empty?

  post('users/deactivate', data: { user_ids: user_ids, **options })
end

#delete(relative_url, params: nil) ⇒ Object 



754
755
756
 
# File 'lib/stream-chat/client.rb', line 754

def delete(relative_url, params: nil)
  make_http_request(:delete, relative_url, params: params)
end

#delete_blocklist(name) ⇒ Object 



659
660
661
 
# File 'lib/stream-chat/client.rb', line 659

def delete_blocklist(name)
  delete("blocklists/#{name}")
end

#delete_channel_type(channel_type) ⇒ Object 



511
512
513
 
# File 'lib/stream-chat/client.rb', line 511

def delete_channel_type(channel_type)
  delete("channeltypes/#{channel_type}")
end

#delete_channels(cids, hard_delete: false) ⇒ Object 



704
705
706
 
# File 'lib/stream-chat/client.rb', line 704

def delete_channels(cids, hard_delete: false)
  post('channels/delete', data: { cids: cids, hard_delete: hard_delete })
end

#delete_command(name) ⇒ Object 



844
845
846
 
# File 'lib/stream-chat/client.rb', line 844

def delete_command(name)
  delete("commands/#{name}")
end

#delete_device(device_id, user_id) ⇒ Object 



541
542
543
 
# File 'lib/stream-chat/client.rb', line 541

def delete_device(device_id, user_id)
  delete('devices', params: { id: device_id, user_id: user_id })
end

#delete_message(message_id, **options) ⇒ Object 



430
431
432
 
# File 'lib/stream-chat/client.rb', line 430

def delete_message(message_id, **options)
  delete("messages/#{message_id}", params: options)
end

#delete_permission(id) ⇒ Object 



880
881
882
 
# File 'lib/stream-chat/client.rb', line 880

def delete_permission(id)
  delete("permissions/#{id}")
end

#delete_push_provider(type, name) ⇒ Object 



910
911
912
 
# File 'lib/stream-chat/client.rb', line 910

def delete_push_provider(type, name)
  delete("push_providers/#{type}/#{name}")
end

#delete_reminder(message_id, user_id) ⇒ Object 



991
992
993
 
# File 'lib/stream-chat/client.rb', line 991

def delete_reminder(message_id, user_id)
  delete("messages/#{message_id}/reminders", params: { user_id: user_id })
end

#delete_role(name) ⇒ Object 



892
893
894
 
# File 'lib/stream-chat/client.rb', line 892

def delete_role(name)
  delete("roles/#{name}")
end

#delete_user(user_id, **options) ⇒ Object 



260
261
262
 
# File 'lib/stream-chat/client.rb', line 260

def delete_user(user_id, **options)
  delete("users/#{user_id}", params: options)
end

#delete_users(user_ids, user: SOFT_DELETE, messages: nil, conversations: nil) ⇒ Object 



697
698
699
 
# File 'lib/stream-chat/client.rb', line 697

def delete_users(user_ids, user: SOFT_DELETE, messages: nil, conversations: nil)
  post('users/delete', data: { user_ids: user_ids, user: user, messages: messages, conversations: conversations })
end

#export_channels(*channels, **options) ⇒ Object 



669
670
671
 
# File 'lib/stream-chat/client.rb', line 669

def export_channels(*channels, **options)
  post('export_channels', data: { channels: channels, **options })
end

#export_user(user_id, **options) ⇒ Object 



301
302
303
 
# File 'lib/stream-chat/client.rb', line 301

def export_user(user_id, **options)
  get("users/#{user_id}/export", params: options)
end

#export_users(user_ids) ⇒ Object 



685
686
687
 
# File 'lib/stream-chat/client.rb', line 685

def export_users(user_ids)
  post('export/users', data: { user_ids: user_ids })
end

#flag_message(id, **options) ⇒ Object 



128
129
130
131
 
# File 'lib/stream-chat/client.rb', line 128

def flag_message(id, **options)
  payload = { target_message_id: id }.merge(options)
  post('moderation/flag', data: payload)
end

#flag_user(id, **options) ⇒ Object 



155
156
157
158
 
# File 'lib/stream-chat/client.rb', line 155

def flag_user(id, **options)
  payload = { target_user_id: id }.merge(options)
  post('moderation/flag', data: payload)
end

#get(relative_url, params: nil) ⇒ Object 



749
750
751
 
# File 'lib/stream-chat/client.rb', line 749

def get(relative_url, params: nil)
  make_http_request(:get, relative_url, params: params)
end

#get_app_settings ⇒ Object 



118
119
120
 
# File 'lib/stream-chat/client.rb', line 118

def get_app_settings
  get('app')
end

#get_blocklist(name) ⇒ Object 



623
624
625
 
# File 'lib/stream-chat/client.rb', line 623

def get_blocklist(name)
  get("blocklists/#{name}")
end

#get_channel_type(channel_type) ⇒ Object 



493
494
495
 
# File 'lib/stream-chat/client.rb', line 493

def get_channel_type(channel_type)
  get("channeltypes/#{channel_type}")
end

#get_command(name) ⇒ Object 



832
833
834
 
# File 'lib/stream-chat/client.rb', line 832

def get_command(name)
  get("commands/#{name}")
end

#get_devices(user_id) ⇒ Object 



547
548
549
 
# File 'lib/stream-chat/client.rb', line 547

def get_devices(user_id)
  get('devices', params: { user_id: user_id })
end

#get_export_channel_status(task_id) ⇒ Object 



675
676
677
 
# File 'lib/stream-chat/client.rb', line 675

def get_export_channel_status(task_id)
  get("export_channels/#{task_id}")
end

#get_import(id) ⇒ Object 



942
943
944
 
# File 'lib/stream-chat/client.rb', line 942

def get_import(id)
  get("imports/#{id}")
end

#get_message(id, **options) ⇒ Object 



187
188
189
 
# File 'lib/stream-chat/client.rb', line 187

def get_message(id, **options)
  get("messages/#{id}", params: options)
end

#get_permission(id) ⇒ Object 



862
863
864
 
# File 'lib/stream-chat/client.rb', line 862

def get_permission(id)
  get("permissions/#{id}")
end

#get_rate_limits(server_side: false, android: false, ios: false, web: false, endpoints: []) ⇒ Object 



554
555
556
557
558
559
560
561
562
563
 
# File 'lib/stream-chat/client.rb', line 554

def get_rate_limits(server_side: false, android: false, ios: false, web: false, endpoints: [])
  params = {}
  params['server_side'] = server_side if server_side
  params['android'] = android if android
  params['ios'] = ios if ios
  params['web'] = web if web
  params['endpoints'] = endpoints.join(',') unless endpoints.empty?

  get('rate_limits', params: params)
end

#get_task(task_id) ⇒ Object 



691
692
693
 
# File 'lib/stream-chat/client.rb', line 691

def get_task(task_id)
  get("tasks/#{task_id}")
end

#list_blocklists ⇒ Object 



611
612
613
 
# File 'lib/stream-chat/client.rb', line 611

def list_blocklists
  get('blocklists')
end

#list_channel_types ⇒ Object 



499
500
501
 
# File 'lib/stream-chat/client.rb', line 499

def list_channel_types
  get('channeltypes')
end

#list_commands ⇒ Object 



850
851
852
 
# File 'lib/stream-chat/client.rb', line 850

def list_commands
  get('commands')
end

#list_imports(options) ⇒ Object 



948
949
950
 
# File 'lib/stream-chat/client.rb', line 948

def list_imports(options)
  get('imports', params: options)
end

#list_permissions ⇒ Object 



856
857
858
 
# File 'lib/stream-chat/client.rb', line 856

def list_permissions
  get('permissions')
end

#list_push_providers ⇒ Object 



916
917
918
 
# File 'lib/stream-chat/client.rb', line 916

def list_push_providers
  get('push_providers')
end

#list_roles ⇒ Object 



898
899
900
 
# File 'lib/stream-chat/client.rb', line 898

def list_roles
  get('roles')
end

#mark_all_read(user_id) ⇒ Object 



358
359
360
361
 
# File 'lib/stream-chat/client.rb', line 358

def mark_all_read(user_id)
  payload = { user: { id: user_id } }
  post('channels/read', data: payload)
end

#mute_user(target_id, user_id) ⇒ Object 



344
345
346
347
 
# File 'lib/stream-chat/client.rb', line 344

def mute_user(target_id, user_id)
  payload = { target_id: target_id, user_id: user_id }
  post('moderation/mute', data: payload)
end

#patch(relative_url, params: nil, data: nil) ⇒ Object 



759
760
761
 
# File 'lib/stream-chat/client.rb', line 759

def patch(relative_url, params: nil, data: nil)
  make_http_request(:patch, relative_url, params: params, data: data)
end

#pin_message(message_id, user_id, expiration: nil) ⇒ Object 



382
383
384
385
386
387
388
389
390
 
# File 'lib/stream-chat/client.rb', line 382

def pin_message(message_id, user_id, expiration: nil)
  updates = {
    set: {
      pinned: true,
      pin_expires: expiration
    }
  }
  update_message_partial(message_id, updates, user_id: user_id)
end

#post(relative_url, params: nil, data: nil) ⇒ Object 



744
745
746
 
# File 'lib/stream-chat/client.rb', line 744

def post(relative_url, params: nil, data: nil)
  make_http_request(:post, relative_url, params: params, data: data)
end

#put(relative_url, params: nil, data: nil) ⇒ Object 



739
740
741
 
# File 'lib/stream-chat/client.rb', line 739

def put(relative_url, params: nil, data: nil)
  make_http_request(:put, relative_url, params: params, data: data)
end

#query_banned_users(filter_conditions, sort: nil, **options) ⇒ Object 



449
450
451
452
453
454
455
 
# File 'lib/stream-chat/client.rb', line 449

def query_banned_users(filter_conditions, sort: nil, **options)
  params = options.merge({
                           filter_conditions: filter_conditions,
                           sort: StreamChat.get_sort_fields(sort)
                         })
  get('query_banned_users', params: { payload: params.to_json })
end

#query_channels(filter_conditions, sort: nil, **options) ⇒ Object 



475
476
477
478
479
480
481
482
 
# File 'lib/stream-chat/client.rb', line 475

def query_channels(filter_conditions, sort: nil, **options)
  data = { state: true, watch: false, presence: false }
  data = data.merge(options).merge({
                                     filter_conditions: filter_conditions,
                                     sort: StreamChat.get_sort_fields(sort)
                                   })
  post('channels', data: data)
end

#query_drafts(user_id, filter: nil, sort: nil, **options) ⇒ Object 



822
823
824
825
826
827
828
 
# File 'lib/stream-chat/client.rb', line 822

def query_drafts(user_id, filter: nil, sort: nil, **options)
  data = { user_id: user_id }
  data['filter'] = filter if filter
  data['sort'] = sort if sort
  data.merge!(options) if options
  post('drafts/query', data: data)
end

#query_flag_reports(**options) ⇒ Object 



169
170
171
172
 
# File 'lib/stream-chat/client.rb', line 169

def query_flag_reports(**options)
  data = { filter_conditions: options }
  post('moderation/reports', data: data)
end

#query_message_flags(filter_conditions, **options) ⇒ Object 



146
147
148
149
150
151
 
# File 'lib/stream-chat/client.rb', line 146

def query_message_flags(filter_conditions, **options)
  params = options.merge({
                           filter_conditions: filter_conditions
                         })
  get('moderation/flags/message', params: { payload: params.to_json })
end

#query_reminders(user_id, filter_conditions = {}, sort: nil, **options) ⇒ Object 



1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/stream-chat/client.rb', line 1002

def query_reminders(user_id, filter_conditions = {}, sort: nil, **options)
  params = options.merge({
                           filter_conditions: filter_conditions,
                           sort: sort || [{ field: 'remind_at', direction: 1 }],
                           user_id: user_id
                         })
  post('reminders/query', data: params)
end

#query_threads(filter, sort: nil, **options) ⇒ Object 



953
954
955
956
957
958
959
960
 
# File 'lib/stream-chat/client.rb', line 953

def query_threads(filter, sort: nil, **options)
  params = {}.merge(options).merge({
                                     filter: filter,
                                     sort: StreamChat.get_sort_fields(sort)
                                   })

  post('threads', data: params)
end

#query_users(filter_conditions, sort: nil, **options) ⇒ Object 



460
461
462
463
464
465
466
 
# File 'lib/stream-chat/client.rb', line 460

def query_users(filter_conditions, sort: nil, **options)
  params = options.merge({
                           filter_conditions: filter_conditions,
                           sort: StreamChat.get_sort_fields(sort)
                         })
  get('users', params: { payload: params.to_json })
end

#reactivate_user(user_id, **options) ⇒ Object 



294
295
296
 
# File 'lib/stream-chat/client.rb', line 294

def reactivate_user(user_id, **options)
  post("users/#{user_id}/reactivate", params: options)
end

#remove_shadow_ban(target_id, **options) ⇒ Object 



337
338
339
340
 
# File 'lib/stream-chat/client.rb', line 337

def remove_shadow_ban(target_id, **options)
  params = { target_user_id: target_id, shadow: true }.merge(options)
  delete('moderation/ban', params: params)
end

#restore_user(user_id) ⇒ Object 



266
267
268
 
# File 'lib/stream-chat/client.rb', line 266

def restore_user(user_id)
  post('users/restore', data: { user_ids: [user_id] })
end

#restore_users(user_ids) ⇒ Object 



272
273
274
 
# File 'lib/stream-chat/client.rb', line 272

def restore_users(user_ids)
  post('users/restore', data: { user_ids: user_ids })
end

#review_flag_report(report_id, review_result, user_id, **details) ⇒ Object 



176
177
178
179
180
181
182
183
 
# File 'lib/stream-chat/client.rb', line 176

def review_flag_report(report_id, review_result, user_id, **details)
  data = {
    review_result: review_result,
    user_id: user_id,
    review_details: details
  }
  patch("moderation/reports/#{report_id}", data: data)
end

#revoke_tokens(before) ⇒ Object 



710
711
712
713
 
# File 'lib/stream-chat/client.rb', line 710

def revoke_tokens(before)
  before = before.rfc3339 if before.instance_of?(DateTime)
  update_app_settings({ 'revoke_tokens_issued_before' => before })
end

#revoke_user_token(user_id, before) ⇒ Object 



717
718
719
 
# File 'lib/stream-chat/client.rb', line 717

def revoke_user_token(user_id, before)
  revoke_users_token([user_id], before)
end

#revoke_users_token(user_ids, before) ⇒ Object 



723
724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/stream-chat/client.rb', line 723

def revoke_users_token(user_ids, before)
  before = before.rfc3339 if before.instance_of?(DateTime)

  updates = []
  user_ids.map do |user_id|
    {
      'id' => user_id,
      'set' => {
        'revoke_tokens_issued_before' => before
      }
    }
  end
  update_users_partial(updates)
end

#run_message_action(message_id, data) ⇒ Object 



588
589
590
 
# File 'lib/stream-chat/client.rb', line 588

def run_message_action(message_id, data)
  post("messages/#{message_id}/action", data: data)
end

#search(filter_conditions, query, sort: nil, **options) ⇒ Object

Raises:

  • (ArgumentError) 


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/stream-chat/client.rb', line 196

def search(filter_conditions, query, sort: nil, **options)
  offset = T.cast(options[:offset], T.nilable(Integer))
  next_value = options[:next]
  raise ArgumentError, 'cannot use offset with next or sort parameters' if offset&.positive? && (next_value || (!sort.nil? && !sort.empty?))

  to_merge = {
    filter_conditions: filter_conditions,
    sort: StreamChat.get_sort_fields(sort)
  }
  if query.is_a? String
    to_merge[:query] = query
  else
    to_merge[:message_filter_conditions] = query
  end
  get('search', params: { payload: options.merge(to_merge).to_json })
end

#send_file(relative_url, file_url, user, content_type = nil) ⇒ Object 



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/stream-chat/client.rb', line 768

def send_file(relative_url, file_url, user, content_type = nil)
  url = [@base_url, relative_url].join('/')

  body = { user: user.to_json }

  body[:file] = Faraday::UploadIO.new(file_url, content_type || 'application/octet-stream')

  response = @conn.post url do |req|
    req.headers['X-Stream-Client'] = get_user_agent
    req.headers['Authorization'] = @auth_token
    req.headers['stream-auth-type'] = 'jwt'
    req.params = get_default_params
    req.body = body
  end

  parse_response(response)
end

#send_user_event(user_id, event) ⇒ Object 



574
575
576
 
# File 'lib/stream-chat/client.rb', line 574

def send_user_event(user_id, event)
  post("users/#{user_id}/event", data: event)
end

#set_http_client(client) ⇒ Object 



92
93
94
 
# File 'lib/stream-chat/client.rb', line 92

def set_http_client(client)
  @conn = client
end

#shadow_ban(target_id, **options) ⇒ Object 



329
330
331
332
 
# File 'lib/stream-chat/client.rb', line 329

def shadow_ban(target_id, **options)
  payload = { target_user_id: target_id, shadow: true }.merge(options)
  post('moderation/ban', data: payload)
end

#translate_message(message_id, language) ⇒ Object 



582
583
584
 
# File 'lib/stream-chat/client.rb', line 582

def translate_message(message_id, language)
  post("messages/#{message_id}/translate", data: { language: language })
end

#unban_user(target_id, **options) ⇒ Object 



318
319
320
321
 
# File 'lib/stream-chat/client.rb', line 318

def unban_user(target_id, **options)
  params = { target_user_id: target_id }.merge(options)
  delete('moderation/ban', params: params)
end

#undelete_message(message_id, undeleted_by, **options) ⇒ Object 



436
437
438
439
 
# File 'lib/stream-chat/client.rb', line 436

def undelete_message(message_id, undeleted_by, **options)
  payload = { undeleted_by: undeleted_by }.merge(options)
  post("messages/#{message_id}/undelete", data: payload)
end

#unflag_message(id, **options) ⇒ Object 



135
136
137
138
 
# File 'lib/stream-chat/client.rb', line 135

def unflag_message(id, **options)
  payload = { target_message_id: id }.merge(options)
  post('moderation/unflag', data: payload)
end

#unflag_user(id, **options) ⇒ Object 



162
163
164
165
 
# File 'lib/stream-chat/client.rb', line 162

def unflag_user(id, **options)
  payload = { target_user_id: id }.merge(options)
  post('moderation/unflag', data: payload)
end

#unmute_user(target_id, user_id) ⇒ Object 



351
352
353
354
 
# File 'lib/stream-chat/client.rb', line 351

def unmute_user(target_id, user_id)
  payload = { target_id: target_id, user_id: user_id }
  post('moderation/unmute', data: payload)
end

#unpin_message(message_id, user_id) ⇒ Object 



394
395
396
397
398
399
400
401
 
# File 'lib/stream-chat/client.rb', line 394

def unpin_message(message_id, user_id)
  updates = {
    set: {
      pinned: false
    }
  }
  update_message_partial(message_id, updates, user_id: user_id)
end

#unread_counts(user_id) ⇒ Object 



365
366
367
 
# File 'lib/stream-chat/client.rb', line 365

def unread_counts(user_id)
  get('/unread', params: { user_id: user_id })
end

#unread_counts_batch(user_ids) ⇒ Object 



371
372
373
 
# File 'lib/stream-chat/client.rb', line 371

def unread_counts_batch(user_ids)
  post('/unread_batch', data: { user_ids: user_ids })
end

#update_app_settings(**settings) ⇒ Object 



112
113
114
 
# File 'lib/stream-chat/client.rb', line 112

def update_app_settings(**settings)
  patch('app', data: settings)
end

#update_blocklist(name, words) ⇒ Object 



647
648
649
 
# File 'lib/stream-chat/client.rb', line 647

def update_blocklist(name, words)
  put("blocklists/#{name}", data: { words: words })
end

#update_channel_type(channel_type, **options) ⇒ Object 



505
506
507
 
# File 'lib/stream-chat/client.rb', line 505

def update_channel_type(channel_type, **options)
  put("channeltypes/#{channel_type}", data: options)
end

#update_command(name, command) ⇒ Object 



838
839
840
 
# File 'lib/stream-chat/client.rb', line 838

def update_command(name, command)
  put("commands/#{name}", data: command)
end

#update_message(message) ⇒ Object

Raises:

  • (ArgumentError) 


412
413
414
415
416
 
# File 'lib/stream-chat/client.rb', line 412

def update_message(message)
  raise ArgumentError, 'message must have an id' unless message.key? 'id'

  post("messages/#{message['id']}", data: { message: message })
end

#update_message_partial(message_id, updates, user_id: nil, **options) ⇒ Object 



422
423
424
425
426
 
# File 'lib/stream-chat/client.rb', line 422

def update_message_partial(message_id, updates, user_id: nil, **options)
  params = updates.merge(options)
  params['user'] = { id: user_id } if user_id
  put("messages/#{message_id}", data: params)
end

#update_permission(id, permission) ⇒ Object 



874
875
876
 
# File 'lib/stream-chat/client.rb', line 874

def update_permission(id, permission)
  put("permissions/#{id}", data: permission)
end

#update_reminder(message_id, user_id, remind_at = nil) ⇒ Object 



980
981
982
983
984
 
# File 'lib/stream-chat/client.rb', line 980

def update_reminder(message_id, user_id, remind_at = nil)
  data = { user_id: user_id }
  data[:remind_at] = remind_at.rfc3339 if remind_at
  patch("messages/#{message_id}/reminders", data: data)
end

#update_user(user) ⇒ Object 



222
223
224
225
 
# File 'lib/stream-chat/client.rb', line 222

def update_user(user)
  warn '[DEPRECATION] `update_user` is deprecated.  Please use `upsert_user` instead.'
  upsert_user(user)
end

#update_user_partial(update) ⇒ Object 



254
255
256
 
# File 'lib/stream-chat/client.rb', line 254

def update_user_partial(update)
  update_users_partial([update])
end

#update_users(users) ⇒ Object 



215
216
217
218
 
# File 'lib/stream-chat/client.rb', line 215

def update_users(users)
  warn '[DEPRECATION] `update_users` is deprecated.  Please use `upsert_users` instead.'
  upsert_users(users)
end

#update_users_partial(updates) ⇒ Object 



248
249
250
 
# File 'lib/stream-chat/client.rb', line 248

def update_users_partial(updates)
  patch('users', data: { users: updates })
end

#upsert_push_provider(push_provider) ⇒ Object 



904
905
906
 
# File 'lib/stream-chat/client.rb', line 904

def upsert_push_provider(push_provider)
  post('push_providers', data: { push_provider: push_provider })
end

#upsert_user(user) ⇒ Object 



242
243
244
 
# File 'lib/stream-chat/client.rb', line 242

def upsert_user(user)
  upsert_users([user])
end

#upsert_users(users) ⇒ Object 



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/stream-chat/client.rb', line 229

def upsert_users(users)
  payload = {}
  users.each do |user|
    id = user[:id] || user['id']
    raise ArgumentError, 'user must have an id' unless id

    payload[id] = user
  end
  post('users', data: { users: payload })
end

#verify_webhook(request_body, x_signature) ⇒ Object 



567
568
569
570
 
# File 'lib/stream-chat/client.rb', line 567

def verify_webhook(request_body, x_signature)
  signature = OpenSSL::HMAC.hexdigest('SHA256', @api_secret, request_body)
  signature == x_signature
end