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.

Constant Summary collapse

@@default_region =
'us1'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(username = nil, password = nil, account_sid = nil, region = nil, http_client = nil) ⇒ Client

Initializes the Twilio Client


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
51
52
53
54
55
56
57
58
59
60
# File 'lib/twilio-ruby/rest/client.rb', line 20

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

  # Domains
  @accounts = nil
  @api = nil
  @autopilot = nil
  @chat = nil
  @conversations = nil
  @events = nil
  @fax = nil
  @flex_api = nil
  @insights = nil
  @ip_messaging = nil
  @lookups = nil
  @messaging = nil
  @monitor = nil
  @notify = nil
  @numbers = nil
  @preview = nil
  @pricing = nil
  @proxy = nil
  @serverless = nil
  @studio = nil
  @sync = nil
  @taskrouter = nil
  @trunking = nil
  @verify = nil
  @video = nil
  @voice = nil
  @wireless = nil
  @supersim = nil
  @bulkexports = nil
end

Instance Attribute Details

#account_sidObject

Returns the value of attribute account_sid


16
17
18
# File 'lib/twilio-ruby/rest/client.rb', line 16

def 
  @account_sid
end

#auth_tokenObject

Returns the value of attribute auth_token


16
17
18
# File 'lib/twilio-ruby/rest/client.rb', line 16

def auth_token
  @auth_token
end

#edgeObject

Returns the value of attribute edge


16
17
18
# File 'lib/twilio-ruby/rest/client.rb', line 16

def edge
  @edge
end

#http_clientObject

Returns the value of attribute http_client


16
17
18
# File 'lib/twilio-ruby/rest/client.rb', line 16

def http_client
  @http_client
end

#passwordObject

Returns the value of attribute password


16
17
18
# File 'lib/twilio-ruby/rest/client.rb', line 16

def password
  @password
end

#regionObject

Returns the value of attribute region


16
17
18
# File 'lib/twilio-ruby/rest/client.rb', line 16

def region
  @region
end

#usernameObject

Returns the value of attribute username


16
17
18
# File 'lib/twilio-ruby/rest/client.rb', line 16

def username
  @username
end

Instance Method Details

#accountsObject

Access the Accounts Twilio Domain


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

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)

    The unique string that that we created to identify the Address resource.

Returns:


313
314
315
# File 'lib/twilio-ruby/rest/client.rb', line 313

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

#apiObject

Access the Api Twilio Domain


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

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)

    The unique string that that we created to identify the Application resource.

Returns:


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

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 SID that we assigned to the Connect App.

Returns:


330
331
332
# File 'lib/twilio-ruby/rest/client.rb', line 330

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

#autopilotObject

Access the Autopilot Twilio Domain


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

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-3166-1 country code of the country.

Returns:


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

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

#balanceTwilio::REST::Api::V2010::AccountContext::BalanceInstance


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

def balance
  self.api.v2010..balance
end

#build_uri(uri) ⇒ Object

Build the final request uri


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/twilio-ruby/rest/client.rb', line 98

def build_uri(uri)
  if @region.nil? and @edge.nil?
    return uri
  end

  parsed_url = URI(uri)
  pieces = parsed_url.host.split('.')
  product = pieces[0]
  domain = pieces[-2, 2]
  new_edge = @edge
  new_region = @region

  if pieces.length == 4
    new_region ||= pieces[1]
  elsif pieces.length == 5
    new_edge ||= pieces[1]
    new_region ||= pieces[2]
  end

  if !new_edge.nil? && new_region.nil?
    new_region = @@default_region
  end

  parsed_url.host = [product, new_edge, new_region, domain].select {|item| !item.nil?}.join('.')
  parsed_url.to_s
end

#bulkexportsObject

Access the Bulkexports Twilio Domain


304
305
306
# File 'lib/twilio-ruby/rest/client.rb', line 304

def bulkexports
  @bulkexports ||= Bulkexports.new self
end

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

Parameters:

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

    The unique string that that we created to identify this Call resource.

Returns:


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

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

#chatObject

Access the Chat Twilio Domain


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

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)

    The unique string that that we created to identify this Conference resource.

Returns:


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

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 string that that we created to identify the ConnectApp resource.

Returns:


373
374
375
# File 'lib/twilio-ruby/rest/client.rb', line 373

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

#conversationsObject

Access the Conversations Twilio Domain


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

def conversations
  @conversations ||= Conversations.new self
end

#eventsObject

Access the Events Twilio Domain


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

def events
  @events ||= Events.new self
end

#faxObject

Access the Fax Twilio Domain


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

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

#flex_apiObject

Access the FlexApi Twilio Domain


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

def flex_api
  @flex_api ||= FlexApi.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)

    The unique string that that we created to identify this IncomingPhoneNumber resource.

Returns:


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

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

#insightsObject

Access the Insights Twilio Domain


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

def insights
  @insights ||= Insights.new self
end

#ip_messagingObject

Access the IpMessaging Twilio Domain


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

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)

    The unique string that that we created to identify the Key resource.

Returns:


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

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

#lookupsObject

Access the Lookups Twilio Domain


196
197
198
# File 'lib/twilio-ruby/rest/client.rb', line 196

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)

    The unique string that that we created to identify the Message resource.

Returns:


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

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

#messagingObject

Access the Messaging Twilio Domain


202
203
204
# File 'lib/twilio-ruby/rest/client.rb', line 202

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

#monitorObject

Access the Monitor Twilio Domain


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

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

#new_keysTwilio::REST::Api::V2010::AccountContext::NewKeyInstance


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

def new_keys
  self.api.v2010..new_keys
end

#new_signing_keysTwilio::REST::Api::V2010::AccountContext::NewSigningKeyInstance


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

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)

    The unique string that that we created to identify the Notification resource.

Returns:


421
422
423
# File 'lib/twilio-ruby/rest/client.rb', line 421

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

#notifyObject

Access the Notify Twilio Domain


214
215
216
# File 'lib/twilio-ruby/rest/client.rb', line 214

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

#numbersObject

Access the Numbers Twilio Domain


220
221
222
# File 'lib/twilio-ruby/rest/client.rb', line 220

def numbers
  @numbers ||= Numbers.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)

    The unique string that that we created to identify the OutgoingCallerId resource.

Returns:


430
431
432
# File 'lib/twilio-ruby/rest/client.rb', line 430

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

#previewObject

Access the Preview Twilio Domain


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

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

#pricingObject

Access the Pricing Twilio Domain


232
233
234
# File 'lib/twilio-ruby/rest/client.rb', line 232

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

#proxyObject

Access the Proxy Twilio Domain


238
239
240
# File 'lib/twilio-ruby/rest/client.rb', line 238

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)

    The unique string that that we created to identify this Queue resource.

Returns:


439
440
441
# File 'lib/twilio-ruby/rest/client.rb', line 439

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)

    The unique string that that we created to identify the Recording resource.

Returns:


448
449
450
# File 'lib/twilio-ruby/rest/client.rb', line 448

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


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
90
91
92
93
94
# File 'lib/twilio-ruby/rest/client.rb', line 65

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

  uri = build_uri(uri)

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

#serverlessObject

Access the Serverless Twilio Domain


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

def serverless
  @serverless ||= Serverless.new self
end

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

Parameters:

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

    The unique string that that we created to identify this ShortCode resource.

Returns:


471
472
473
# File 'lib/twilio-ruby/rest/client.rb', line 471

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:


456
457
458
# File 'lib/twilio-ruby/rest/client.rb', line 456

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

#sipTwilio::REST::Api::V2010::AccountContext::SipInstance


462
463
464
# File 'lib/twilio-ruby/rest/client.rb', line 462

def sip
  self.api.v2010..sip
end

#studioObject

Access the Studio Twilio Domain


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

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

#supersimObject

Access the Supersim Twilio Domain


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

def supersim
  @supersim ||= Supersim.new self
end

#syncObject

Access the Sync Twilio Domain


256
257
258
# File 'lib/twilio-ruby/rest/client.rb', line 256

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

#taskrouterObject

Access the Taskrouter Twilio Domain


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

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

#to_sObject

Provide a user friendly representation


504
505
506
# File 'lib/twilio-ruby/rest/client.rb', line 504

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

#tokensTwilio::REST::Api::V2010::AccountContext::TokenInstance


477
478
479
# File 'lib/twilio-ruby/rest/client.rb', line 477

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)

    The unique string that that we created to identify the Transcription resource.

Returns:


486
487
488
# File 'lib/twilio-ruby/rest/client.rb', line 486

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

#trunkingObject

Access the Trunking Twilio Domain


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

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

#usageTwilio::REST::Api::V2010::AccountContext::UsageInstance


492
493
494
# File 'lib/twilio-ruby/rest/client.rb', line 492

def usage
  self.api.v2010..usage
end

#validate_ssl_certificateObject

Validate the new SSL certificate for the Twilio API


127
128
129
130
131
132
# File 'lib/twilio-ruby/rest/client.rb', line 127

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_requestsTwilio::REST::Api::V2010::AccountContext::ValidationRequestInstance


498
499
500
# File 'lib/twilio-ruby/rest/client.rb', line 498

def validation_requests
  self.api.v2010..validation_requests
end

#verifyObject

Access the Verify Twilio Domain


274
275
276
# File 'lib/twilio-ruby/rest/client.rb', line 274

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

#videoObject

Access the Video Twilio Domain


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

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

#voiceObject

Access the Voice Twilio Domain


286
287
288
# File 'lib/twilio-ruby/rest/client.rb', line 286

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

#wirelessObject

Access the Wireless Twilio Domain


292
293
294
# File 'lib/twilio-ruby/rest/client.rb', line 292

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