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) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/stream-chat/client.rb', line 49

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)
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



30
31
32
 
# File 'lib/stream-chat/client.rb', line 30

def api_key
  @api_key
end

#api_secret ⇒ Object (readonly)

Returns the value of attribute api_secret.



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

def api_secret
  @api_secret
end

#conn ⇒ Object (readonly)

Returns the value of attribute conn.



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

def conn
  @conn
end

Class Method Details

.from_env(**options) ⇒ Object 



74
75
76
77
78
79
 
# File 'lib/stream-chat/client.rb', line 74

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) }.merge(options))
end

Instance Method Details

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



478
479
480
481
482
483
484
485
 
# File 'lib/stream-chat/client.rb', line 478

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 



283
284
285
286
 
# File 'lib/stream-chat/client.rb', line 283

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 



472
473
474
 
# File 'lib/stream-chat/client.rb', line 472

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

#check_push(push_data) ⇒ Object 



726
727
728
 
# File 'lib/stream-chat/client.rb', line 726

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

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



734
735
736
 
# File 'lib/stream-chat/client.rb', line 734

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

#create_blocklist(name, words) ⇒ Object 



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

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

#create_campaign(campaign) ⇒ Object 



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

def create_campaign(campaign)
  post('campaigns', data: { campaign: campaign })
end

#create_channel_type(data) ⇒ Object 



434
435
436
437
 
# File 'lib/stream-chat/client.rb', line 434

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 



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

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

#create_guest(user) ⇒ Object 



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

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

#create_import(path, mode) ⇒ Object 



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

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

#create_import_url(filename) ⇒ Object 



840
841
842
 
# File 'lib/stream-chat/client.rb', line 840

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

#create_permission(permission) ⇒ Object 



782
783
784
 
# File 'lib/stream-chat/client.rb', line 782

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

#create_role(name) ⇒ Object 



800
801
802
 
# File 'lib/stream-chat/client.rb', line 800

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

#create_segment(segment) ⇒ Object 



922
923
924
 
# File 'lib/stream-chat/client.rb', line 922

def create_segment(segment)
  post('segments', data: { segment: segment })
end

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



96
97
98
99
100
101
 
# File 'lib/stream-chat/client.rb', line 96

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 



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

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

#delete(relative_url, params: nil) ⇒ Object 



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

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

#delete_blocklist(name) ⇒ Object 



607
608
609
 
# File 'lib/stream-chat/client.rb', line 607

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

#delete_campaign(campaign_id) ⇒ Object 



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

def delete_campaign(campaign_id)
  delete("campaigns/#{campaign_id}")
end

#delete_channel_type(channel_type) ⇒ Object 



459
460
461
 
# File 'lib/stream-chat/client.rb', line 459

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

#delete_channels(cids, hard_delete: false) ⇒ Object 



642
643
644
 
# File 'lib/stream-chat/client.rb', line 642

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

#delete_command(name) ⇒ Object 



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

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

#delete_device(device_id, user_id) ⇒ Object 



489
490
491
 
# File 'lib/stream-chat/client.rb', line 489

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

#delete_message(message_id, **options) ⇒ Object 



385
386
387
 
# File 'lib/stream-chat/client.rb', line 385

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

#delete_permission(id) ⇒ Object 



794
795
796
 
# File 'lib/stream-chat/client.rb', line 794

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

#delete_push_provider(type, name) ⇒ Object 



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

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

#delete_role(name) ⇒ Object 



806
807
808
 
# File 'lib/stream-chat/client.rb', line 806

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

#delete_segment(segment_id) ⇒ Object 



946
947
948
 
# File 'lib/stream-chat/client.rb', line 946

def delete_segment(segment_id)
  delete("segments/#{segment_id}")
end

#delete_user(user_id, **options) ⇒ Object 



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

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 



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

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 



617
618
619
 
# File 'lib/stream-chat/client.rb', line 617

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

#export_user(user_id, **options) ⇒ Object 



274
275
276
 
# File 'lib/stream-chat/client.rb', line 274

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

#flag_message(id, **options) ⇒ Object 



121
122
123
124
 
# File 'lib/stream-chat/client.rb', line 121

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

#flag_user(id, **options) ⇒ Object 



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

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

#get(relative_url, params: nil) ⇒ Object 



687
688
689
 
# File 'lib/stream-chat/client.rb', line 687

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

#get_app_settings ⇒ Object 



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

def get_app_settings
  get('app')
end

#get_blocklist(name) ⇒ Object 



571
572
573
 
# File 'lib/stream-chat/client.rb', line 571

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

#get_campaign(campaign_id) ⇒ Object 



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

def get_campaign(campaign_id)
  get("campaigns/#{campaign_id}")
end

#get_channel_type(channel_type) ⇒ Object 



441
442
443
 
# File 'lib/stream-chat/client.rb', line 441

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

#get_command(name) ⇒ Object 



746
747
748
 
# File 'lib/stream-chat/client.rb', line 746

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

#get_devices(user_id) ⇒ Object 



495
496
497
 
# File 'lib/stream-chat/client.rb', line 495

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

#get_export_channel_status(task_id) ⇒ Object 



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

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

#get_import(id) ⇒ Object 



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

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

#get_message(id) ⇒ Object 



180
181
182
 
# File 'lib/stream-chat/client.rb', line 180

def get_message(id)
  get("messages/#{id}")
end

#get_permission(id) ⇒ Object 



776
777
778
 
# File 'lib/stream-chat/client.rb', line 776

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

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



502
503
504
505
506
507
508
509
510
511
 
# File 'lib/stream-chat/client.rb', line 502

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_segment(segment_id) ⇒ Object 



928
929
930
 
# File 'lib/stream-chat/client.rb', line 928

def get_segment(segment_id)
  get("segments/#{segment_id}")
end

#get_task(task_id) ⇒ Object 



629
630
631
 
# File 'lib/stream-chat/client.rb', line 629

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

#list_blocklists ⇒ Object 



559
560
561
 
# File 'lib/stream-chat/client.rb', line 559

def list_blocklists
  get('blocklists')
end

#list_campaigns(options) ⇒ Object 



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

def list_campaigns(options)
  get('campaigns', params: options)
end

#list_channel_types ⇒ Object 



447
448
449
 
# File 'lib/stream-chat/client.rb', line 447

def list_channel_types
  get('channeltypes')
end

#list_commands ⇒ Object 



764
765
766
 
# File 'lib/stream-chat/client.rb', line 764

def list_commands
  get('commands')
end

#list_imports(options) ⇒ Object 



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

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

#list_permissions ⇒ Object 



770
771
772
 
# File 'lib/stream-chat/client.rb', line 770

def list_permissions
  get('permissions')
end

#list_push_providers ⇒ Object 



830
831
832
 
# File 'lib/stream-chat/client.rb', line 830

def list_push_providers
  get('push_providers')
end

#list_roles ⇒ Object 



812
813
814
 
# File 'lib/stream-chat/client.rb', line 812

def list_roles
  get('roles')
end

#list_segments(options) ⇒ Object 



934
935
936
 
# File 'lib/stream-chat/client.rb', line 934

def list_segments(options)
  get('segments', params: options)
end

#mark_all_read(user_id) ⇒ Object 



331
332
333
334
 
# File 'lib/stream-chat/client.rb', line 331

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

#mute_user(target_id, user_id) ⇒ Object 



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

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 



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

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 



343
344
345
346
347
348
349
350
351
 
# File 'lib/stream-chat/client.rb', line 343

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 



682
683
684
 
# File 'lib/stream-chat/client.rb', line 682

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 



677
678
679
 
# File 'lib/stream-chat/client.rb', line 677

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 



397
398
399
400
401
402
403
 
# File 'lib/stream-chat/client.rb', line 397

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 



423
424
425
426
427
428
429
430
 
# File 'lib/stream-chat/client.rb', line 423

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_flag_reports(**options) ⇒ Object 



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

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

#query_message_flags(filter_conditions, **options) ⇒ Object 



139
140
141
142
143
144
 
# File 'lib/stream-chat/client.rb', line 139

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_users(filter_conditions, sort: nil, **options) ⇒ Object 



408
409
410
411
412
413
414
 
# File 'lib/stream-chat/client.rb', line 408

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 



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

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

#remove_shadow_ban(target_id, **options) ⇒ Object 



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

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

#resume_campaign(campaign_id) ⇒ Object 



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

def resume_campaign(campaign_id)
  patch("campaigns/#{campaign_id}/resume")
end

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



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

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 



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

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

#revoke_user_token(user_id, before) ⇒ Object 



655
656
657
 
# File 'lib/stream-chat/client.rb', line 655

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

#revoke_users_token(user_ids, before) ⇒ Object 



661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/stream-chat/client.rb', line 661

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

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

#run_message_action(message_id, data) ⇒ Object 



536
537
538
 
# File 'lib/stream-chat/client.rb', line 536

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

#schedule_campaign(campaign_id, send_at) ⇒ Object 



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

def schedule_campaign(campaign_id, send_at)
  patch("campaigns/#{campaign_id}/schedule", data: { send_at: send_at })
end

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

Raises:

  • (ArgumentError) 


189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/stream-chat/client.rb', line 189

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 



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/stream-chat/client.rb', line 706

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 



522
523
524
 
# File 'lib/stream-chat/client.rb', line 522

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

#set_http_client(client) ⇒ Object 



85
86
87
 
# File 'lib/stream-chat/client.rb', line 85

def set_http_client(client)
  @conn = client
end

#shadow_ban(target_id, **options) ⇒ Object 



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

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

#stop_campaign(campaign_id) ⇒ Object 



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

def stop_campaign(campaign_id)
  patch("campaigns/#{campaign_id}/stop")
end

#test_campaign(campaign_id, users) ⇒ Object 



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

def test_campaign(campaign_id, users)
  post("campaigns/#{campaign_id}/test", data: { users: users })
end

#translate_message(message_id, language) ⇒ Object 



530
531
532
 
# File 'lib/stream-chat/client.rb', line 530

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

#unban_user(target_id, **options) ⇒ Object 



291
292
293
294
 
# File 'lib/stream-chat/client.rb', line 291

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

#unflag_message(id, **options) ⇒ Object 



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

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

#unflag_user(id, **options) ⇒ Object 



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

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 



324
325
326
327
 
# File 'lib/stream-chat/client.rb', line 324

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 



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

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

#update_app_settings(**settings) ⇒ Object 



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

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

#update_blocklist(name, words) ⇒ Object 



595
596
597
 
# File 'lib/stream-chat/client.rb', line 595

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

#update_campaign(campaign_id, campaign) ⇒ Object 



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

def update_campaign(campaign_id, campaign)
  put("campaigns/#{campaign_id}", data: { campaign: campaign })
end

#update_channel_type(channel_type, **options) ⇒ Object 



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

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

#update_command(name, command) ⇒ Object 



752
753
754
 
# File 'lib/stream-chat/client.rb', line 752

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

#update_message(message) ⇒ Object

Raises:

  • (ArgumentError) 


367
368
369
370
371
 
# File 'lib/stream-chat/client.rb', line 367

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 



377
378
379
380
381
 
# File 'lib/stream-chat/client.rb', line 377

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 



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

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

#update_segment(segment_id, segment) ⇒ Object 



940
941
942
 
# File 'lib/stream-chat/client.rb', line 940

def update_segment(segment_id, segment)
  put("segments/#{segment_id}", data: { segment: segment })
end

#update_user(user) ⇒ Object 



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

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

#update_user_partial(update) ⇒ Object 



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

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

#update_users(users) ⇒ Object 



208
209
210
211
 
# File 'lib/stream-chat/client.rb', line 208

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

#update_users_partial(updates) ⇒ Object 



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

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

#upsert_push_provider(push_provider) ⇒ Object 



818
819
820
 
# File 'lib/stream-chat/client.rb', line 818

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

#upsert_user(user) ⇒ Object 



235
236
237
 
# File 'lib/stream-chat/client.rb', line 235

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

#upsert_users(users) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
 
# File 'lib/stream-chat/client.rb', line 222

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 



515
516
517
518
 
# File 'lib/stream-chat/client.rb', line 515

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