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
47
48
49
50
 
# 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
  @authy = nil
  @autopilot = 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
  @verify = nil
  @voice = 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



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

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:



236
237
238
 
# File 'lib/twilio-ruby/rest/client.rb', line 236

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

#api ⇒ Object

Access the Api Twilio Domain



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

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:



245
246
247
 
# File 'lib/twilio-ruby/rest/client.rb', line 245

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:



254
255
256
 
# File 'lib/twilio-ruby/rest/client.rb', line 254

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

#authy ⇒ Object

Access the Authy Twilio Domain



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

def authy
  @authy ||= Authy.new self
end

#autopilot ⇒ Object

Access the Autopilot Twilio Domain



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

def autopilot
  @autopilot ||= Autopilot.new self
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:



262
263
264
 
# File 'lib/twilio-ruby/rest/client.rb', line 262

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 the Call resource.

Returns:



271
272
273
 
# File 'lib/twilio-ruby/rest/client.rb', line 271

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

#chat ⇒ Object

Access the Chat Twilio Domain



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

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:



280
281
282
 
# File 'lib/twilio-ruby/rest/client.rb', line 280

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:



288
289
290
 
# File 'lib/twilio-ruby/rest/client.rb', line 288

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

#fax ⇒ Object

Access the Fax Twilio Domain



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

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:



297
298
299
 
# File 'lib/twilio-ruby/rest/client.rb', line 297

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

#ip_messaging ⇒ Object

Access the IpMessaging Twilio Domain



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

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:



306
307
308
 
# File 'lib/twilio-ruby/rest/client.rb', line 306

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

#lookups ⇒ Object

Access the Lookups Twilio Domain



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

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:



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

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

#messaging ⇒ Object

Access the Messaging Twilio Domain



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

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

#monitor ⇒ Object

Access the Monitor Twilio Domain



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

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

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

Returns:



321
322
323
 
# File 'lib/twilio-ruby/rest/client.rb', line 321

def new_keys
  self.api.v2010..new_keys
end

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

Returns:



327
328
329
 
# File 'lib/twilio-ruby/rest/client.rb', line 327

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:



336
337
338
 
# File 'lib/twilio-ruby/rest/client.rb', line 336

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

#notify ⇒ Object

Access the Notify Twilio Domain



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

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:



345
346
347
 
# File 'lib/twilio-ruby/rest/client.rb', line 345

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

#preview ⇒ Object

Access the Preview Twilio Domain



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

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

#pricing ⇒ Object

Access the Pricing Twilio Domain



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

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

#proxy ⇒ Object

Access the Proxy Twilio Domain



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

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:



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

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:



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

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



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
86
87
88
89
 
# File 'lib/twilio-ruby/rest/client.rb', line 55

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:



385
386
387
 
# File 'lib/twilio-ruby/rest/client.rb', line 385

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:



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

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

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

Returns:



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

def sip
  self.api.v2010..sip
end

#studio ⇒ Object

Access the Studio Twilio Domain



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

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

#sync ⇒ Object

Access the Sync Twilio Domain



210
211
212
 
# File 'lib/twilio-ruby/rest/client.rb', line 210

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

#taskrouter ⇒ Object

Access the Taskrouter Twilio Domain



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

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

#to_s ⇒ Object

Provide a user friendly representation



417
418
419
 
# File 'lib/twilio-ruby/rest/client.rb', line 417

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

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

Returns:



391
392
393
 
# File 'lib/twilio-ruby/rest/client.rb', line 391

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 unique 34-character string that identifies this resource.

Returns:



399
400
401
 
# File 'lib/twilio-ruby/rest/client.rb', line 399

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

#trunking ⇒ Object

Access the Trunking Twilio Domain



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

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

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

Returns:



405
406
407
 
# File 'lib/twilio-ruby/rest/client.rb', line 405

def usage
  self.api.v2010..usage
end

#validate_ssl_certificate ⇒ Object

Validate the new SSL certificate for the Twilio API



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

def validate_ssl_certificate
  response = request('api.twilio.com', '8443', 'GET', 'https://api.twilio.com:8443/.json')
  if response.status_code < 200 || response.status_code >= 300
    raise RestError.new 'Unexpected response from certificate endpoint', response
  end
end

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

Returns:



411
412
413
 
# File 'lib/twilio-ruby/rest/client.rb', line 411

def validation_requests
  self.api.v2010..validation_requests
end

#verify ⇒ Object

Access the Verify Twilio Domain



222
223
224
 
# File 'lib/twilio-ruby/rest/client.rb', line 222

def verify
  @verify ||= Verify.new self
end

#video ⇒ Object

Access the Video Twilio Domain



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

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

#voice ⇒ Object

Access the Voice Twilio Domain



228
229
230
 
# File 'lib/twilio-ruby/rest/client.rb', line 228

def voice
  @voice ||= Voice.new self
end

#wireless ⇒ Object

Access the Wireless Twilio Domain



204
205
206
 
# File 'lib/twilio-ruby/rest/client.rb', line 204

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