Class: SmsTraffic::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/sms_traffic/client.rb,
lib/sms_traffic/client/reply.rb,
lib/sms_traffic/client/response.rb,
lib/sms_traffic/client/status_reply.rb,
lib/sms_traffic/client/deliver_reply.rb

Defined Under Namespace

Classes: DeliverReply, Reply, Response, StatusReply

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.uri ⇒ Object (readonly)

Returns the value of attribute uri.



6
7
8
 
# File 'lib/sms_traffic/client.rb', line 6

def uri
  @uri
end

Class Method Details

.deliver(phone, message, originator = nil, **options) ⇒ Object

Parameters:

  • phone (String) —

    phone number

  • message (String) —

    message

  • originator (String) (defaults to: nil) —

    originator (subject)

  • options (Hash) —

    additional options



12
13
14
15
16
17
 
# File 'lib/sms_traffic/client.rb', line 12

def deliver(phone, message, originator = nil, **options)
  originator ||= SmsTraffic.configuration.originator
  form_data = deliver_params(phone, message, originator, **options)
  response = perform_request(form_data)
  Response.new(response, type: :deliver)
end

.status(*message_ids) ⇒ Object

Parameters:

  • message_id (String) —

    message id



20
21
22
23
24
 
# File 'lib/sms_traffic/client.rb', line 20

def status(*message_ids)
  form_data = status_params(message_ids)
  response = perform_request(form_data)
  Response.new(response, type: :status)
end