Class: Twilio::REST::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/twilio-ruby/rest/client.rb

Overview

A client for accessing the Twilio API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(username = nil, password = nil, account_sid = nil, region = nil, http_client = Twilio::HTTP::Client.new) ⇒ Client

Initializes the Twilio Client



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/twilio-ruby/rest/client.rb', line 18

def initialize(username=nil, password=nil, =nil, region=nil, http_client=Twilio::HTTP::Client.new)
  @username = username || Twilio.
  @password = password || Twilio.auth_token
  @region = region
  @account_sid =  || @username
  @auth_token = @password
  @auth = [@username, @password]
  @http_client = http_client

  # Domains
  @accounts = nil
  @api = nil
  @chat = nil
  @fax = nil
  @ip_messaging = nil
  @lookups = nil
  @monitor = nil
  @notify = nil
  @preview = nil
  @pricing = nil
  @proxy = nil
  @taskrouter = nil
  @trunking = nil
  @video = nil
  @messaging = nil
  @wireless = nil
  @sync = nil
  @studio = nil
end

Instance Attribute Details

#account_sid ⇒ Object

Returns the value of attribute account_sid.



14
15
16
 
# File 'lib/twilio-ruby/rest/client.rb', line 14

def 
  @account_sid
end

#auth_token ⇒ Object

Returns the value of attribute auth_token.



14
15
16
 
# File 'lib/twilio-ruby/rest/client.rb', line 14

def auth_token
  @auth_token
end

#http_client ⇒ Object

Returns the value of attribute http_client.



14
15
16
 
# File 'lib/twilio-ruby/rest/client.rb', line 14

def http_client
  @http_client
end

#password ⇒ Object

Returns the value of attribute password.



14
15
16
 
# File 'lib/twilio-ruby/rest/client.rb', line 14

def password
  @password
end

#region ⇒ Object

Returns the value of attribute region.



14
15
16
 
# File 'lib/twilio-ruby/rest/client.rb', line 14

def region
  @region
end

#username ⇒ Object

Returns the value of attribute username.



14
15
16
 
# File 'lib/twilio-ruby/rest/client.rb', line 14

def username
  @username
end

Instance Method Details

#accounts ⇒ Object

Access the Accounts Twilio Domain



89
90
91
 
# File 'lib/twilio-ruby/rest/client.rb', line 89

def accounts
  @accounts ||= Accounts.new self
end

#addresses(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::AddressInstance, Twilio::REST::Api::V2010::AccountContext::AddressList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this address.

Returns:



199
200
201
 
# File 'lib/twilio-ruby/rest/client.rb', line 199

def addresses(sid=:unset)
  self.api.v2010..addresses(sid)
end

#api ⇒ Object

Access the Api Twilio Domain



95
96
97
 
# File 'lib/twilio-ruby/rest/client.rb', line 95

def api
  @api ||= Api.new self
end

#applications(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::ApplicationInstance, Twilio::REST::Api::V2010::AccountContext::ApplicationList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this resource.

Returns:



208
209
210
 
# File 'lib/twilio-ruby/rest/client.rb', line 208

def applications(sid=:unset)
  self.api.v2010..applications(sid)
end

#authorized_connect_apps(connect_app_sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppInstance, Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppList

Parameters:

  • connect_app_sid (String) (defaults to: :unset) —

    The unique id of the Connect App that was authorized.

Returns:



217
218
219
 
# File 'lib/twilio-ruby/rest/client.rb', line 217

def authorized_connect_apps(connect_app_sid=:unset)
  self.api.v2010..authorized_connect_apps(connect_app_sid)
end

#available_phone_numbers(country_code = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance, Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList

Parameters:

  • country_code (String) (defaults to: :unset) —

    The ISO Country code to lookup phone numbers for.

Returns:



225
226
227
 
# File 'lib/twilio-ruby/rest/client.rb', line 225

def available_phone_numbers(country_code=:unset)
  self.api.v2010..available_phone_numbers(country_code)
end

#calls(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::CallInstance, Twilio::REST::Api::V2010::AccountContext::CallList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this resource.

Returns:



234
235
236
 
# File 'lib/twilio-ruby/rest/client.rb', line 234

def calls(sid=:unset)
  self.api.v2010..calls(sid)
end

#chat ⇒ Object

Access the Chat Twilio Domain



101
102
103
 
# File 'lib/twilio-ruby/rest/client.rb', line 101

def chat
  @chat ||= Chat.new self
end

#conferences(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::ConferenceInstance, Twilio::REST::Api::V2010::AccountContext::ConferenceList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this conference.

Returns:



243
244
245
 
# File 'lib/twilio-ruby/rest/client.rb', line 243

def conferences(sid=:unset)
  self.api.v2010..conferences(sid)
end

#connect_apps(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::ConnectAppInstance, Twilio::REST::Api::V2010::AccountContext::ConnectAppList

Parameters:

  • sid (String) (defaults to: :unset) —

    The unique id of this Connect App.

Returns:



251
252
253
 
# File 'lib/twilio-ruby/rest/client.rb', line 251

def connect_apps(sid=:unset)
  self.api.v2010..connect_apps(sid)
end

#fax ⇒ Object

Access the Fax Twilio Domain



107
108
109
 
# File 'lib/twilio-ruby/rest/client.rb', line 107

def fax
  @fax ||= Fax.new self
end

#incoming_phone_numbers(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance, Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this resource.

Returns:



260
261
262
 
# File 'lib/twilio-ruby/rest/client.rb', line 260

def incoming_phone_numbers(sid=:unset)
  self.api.v2010..incoming_phone_numbers(sid)
end

#ip_messaging ⇒ Object

Access the IpMessaging Twilio Domain



113
114
115
 
# File 'lib/twilio-ruby/rest/client.rb', line 113

def ip_messaging
  @ip_messaging ||= IpMessaging.new self
end

#keys(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::KeyInstance, Twilio::REST::Api::V2010::AccountContext::KeyList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this API Key. You will use this as the basic-auth ‘user` when authenticating to the API.

Returns:



269
270
271
 
# File 'lib/twilio-ruby/rest/client.rb', line 269

def keys(sid=:unset)
  self.api.v2010..keys(sid)
end

#lookups ⇒ Object

Access the Lookups Twilio Domain



119
120
121
 
# File 'lib/twilio-ruby/rest/client.rb', line 119

def lookups
  @lookups ||= Lookups.new self
end

#messages(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::MessageInstance, Twilio::REST::Api::V2010::AccountContext::MessageList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this resource.

Returns:



278
279
280
 
# File 'lib/twilio-ruby/rest/client.rb', line 278

def messages(sid=:unset)
  self.api.v2010..messages(sid)
end

#messaging ⇒ Object

Access the Messaging Twilio Domain



173
174
175
 
# File 'lib/twilio-ruby/rest/client.rb', line 173

def messaging
  @messaging ||= Messaging.new self
end

#monitor ⇒ Object

Access the Monitor Twilio Domain



125
126
127
 
# File 'lib/twilio-ruby/rest/client.rb', line 125

def monitor
  @monitor ||= Monitor.new self
end

#new_keys ⇒ Twilio::REST::Api::V2010::AccountContext::NewKeyInstance

Returns:



284
285
286
 
# File 'lib/twilio-ruby/rest/client.rb', line 284

def new_keys
  self.api.v2010..new_keys
end

#new_signing_keys ⇒ Twilio::REST::Api::V2010::AccountContext::NewSigningKeyInstance

Returns:



290
291
292
 
# File 'lib/twilio-ruby/rest/client.rb', line 290

def new_signing_keys
  self.api.v2010..new_signing_keys
end

#notifications(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::NotificationInstance, Twilio::REST::Api::V2010::AccountContext::NotificationList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this resource.

Returns:



299
300
301
 
# File 'lib/twilio-ruby/rest/client.rb', line 299

def notifications(sid=:unset)
  self.api.v2010..notifications(sid)
end

#notify ⇒ Object

Access the Notify Twilio Domain



131
132
133
 
# File 'lib/twilio-ruby/rest/client.rb', line 131

def notify
  @notify ||= Notify.new self
end

#outgoing_caller_ids(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdInstance, Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this resource.

Returns:



308
309
310
 
# File 'lib/twilio-ruby/rest/client.rb', line 308

def outgoing_caller_ids(sid=:unset)
  self.api.v2010..outgoing_caller_ids(sid)
end

#preview ⇒ Object

Access the Preview Twilio Domain



137
138
139
 
# File 'lib/twilio-ruby/rest/client.rb', line 137

def preview
  @preview ||= Preview.new self
end

#pricing ⇒ Object

Access the Pricing Twilio Domain



143
144
145
 
# File 'lib/twilio-ruby/rest/client.rb', line 143

def pricing
  @pricing ||= Pricing.new self
end

#proxy ⇒ Object

Access the Proxy Twilio Domain



149
150
151
 
# File 'lib/twilio-ruby/rest/client.rb', line 149

def proxy
  @proxy ||= Proxy.new self
end

#queues(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::QueueInstance, Twilio::REST::Api::V2010::AccountContext::QueueList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this queue.

Returns:



316
317
318
 
# File 'lib/twilio-ruby/rest/client.rb', line 316

def queues(sid=:unset)
  self.api.v2010..queues(sid)
end

#recordings(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::RecordingInstance, Twilio::REST::Api::V2010::AccountContext::RecordingList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this resource.

Returns:



325
326
327
 
# File 'lib/twilio-ruby/rest/client.rb', line 325

def recordings(sid=:unset)
  self.api.v2010..recordings(sid)
end

#request(host, port, method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil) ⇒ Object

Makes a request to the Twilio API using the configured http client Authentication information is automatically added if none is provided



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/twilio-ruby/rest/client.rb', line 51

def request(host, port, method, uri, params={}, data={}, headers={}, auth=nil, timeout=nil)
  auth ||= @auth

  headers['User-Agent'] = "twilio-ruby/#{Twilio::VERSION}" +
                          " (#{RUBY_ENGINE}/#{RUBY_PLATFORM}" +
                          " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
  headers['Accept-Charset'] = 'utf-8'

  if method == 'POST' && !headers['Content-Type']
    headers['Content-Type'] = 'application/x-www-form-urlencoded'
  end

  unless headers['Accept']
    headers['Accept'] = 'application/json'
  end

  if !region.nil?
      head, tail  = uri.split('.', 2)
      if !tail.start_with?(region)
          uri = [head, region, tail].join('.')
      end
  end

  @http_client.request(
    host,
    port,
    method,
    uri,
    params,
    data,
    headers,
    auth,
    timeout
  )
end

#short_codes(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::ShortCodeInstance, Twilio::REST::Api::V2010::AccountContext::ShortCodeList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this resource.

Returns:



348
349
350
 
# File 'lib/twilio-ruby/rest/client.rb', line 348

def short_codes(sid=:unset)
  self.api.v2010..short_codes(sid)
end

#signing_keys(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::SigningKeyInstance, Twilio::REST::Api::V2010::AccountContext::SigningKeyList

Parameters:

  • sid (String) (defaults to: :unset) —

    The sid

Returns:



333
334
335
 
# File 'lib/twilio-ruby/rest/client.rb', line 333

def signing_keys(sid=:unset)
  self.api.v2010..signing_keys(sid)
end

#sip ⇒ Twilio::REST::Api::V2010::AccountContext::SipInstance

Returns:



339
340
341
 
# File 'lib/twilio-ruby/rest/client.rb', line 339

def sip
  self.api.v2010..sip
end

#studio ⇒ Object

Access the Studio Twilio Domain



191
192
193
 
# File 'lib/twilio-ruby/rest/client.rb', line 191

def studio
  @studio ||= Studio.new self
end

#sync ⇒ Object

Access the Sync Twilio Domain



185
186
187
 
# File 'lib/twilio-ruby/rest/client.rb', line 185

def sync
  @sync ||= Sync.new self
end

#taskrouter ⇒ Object

Access the Taskrouter Twilio Domain



155
156
157
 
# File 'lib/twilio-ruby/rest/client.rb', line 155

def taskrouter
  @taskrouter ||= Taskrouter.new self
end

#to_s ⇒ Object

Provide a user friendly representation



381
382
383
 
# File 'lib/twilio-ruby/rest/client.rb', line 381

def to_s
  "#<Twilio::REST::Client #{@account_sid}>"
end

#tokens ⇒ Twilio::REST::Api::V2010::AccountContext::TokenInstance

Returns:



354
355
356
 
# File 'lib/twilio-ruby/rest/client.rb', line 354

def tokens
  self.api.v2010..tokens
end

#transcriptions(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance, Twilio::REST::Api::V2010::AccountContext::TranscriptionList

Parameters:

  • sid (String) (defaults to: :unset) —

    A 34 character string that uniquely identifies this resource.

Returns:



363
364
365
 
# File 'lib/twilio-ruby/rest/client.rb', line 363

def transcriptions(sid=:unset)
  self.api.v2010..transcriptions(sid)
end

#trunking ⇒ Object

Access the Trunking Twilio Domain



161
162
163
 
# File 'lib/twilio-ruby/rest/client.rb', line 161

def trunking
  @trunking ||= Trunking.new self
end

#usage ⇒ Twilio::REST::Api::V2010::AccountContext::UsageInstance

Returns:



369
370
371
 
# File 'lib/twilio-ruby/rest/client.rb', line 369

def usage
  self.api.v2010..usage
end

#validation_requests ⇒ Twilio::REST::Api::V2010::AccountContext::ValidationRequestInstance

Returns:



375
376
377
 
# File 'lib/twilio-ruby/rest/client.rb', line 375

def validation_requests
  self.api.v2010..validation_requests
end

#video ⇒ Object

Access the Video Twilio Domain



167
168
169
 
# File 'lib/twilio-ruby/rest/client.rb', line 167

def video
  @video ||= Video.new self
end

#wireless ⇒ Object

Access the Wireless Twilio Domain



179
180
181
 
# File 'lib/twilio-ruby/rest/client.rb', line 179

def wireless
  @wireless ||= Wireless.new self
end