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, logger = nil, user_agent_extensions = 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
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/client.rb', line 20

def initialize(username=nil, password=nil, =nil, region=nil, http_client=nil, logger=nil, user_agent_extensions=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
  @logger = logger || Twilio.logger
  @user_agent_extensions = user_agent_extensions || []

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

Instance Attribute Details

#account_sid ⇒ Object

Returns the value of attribute account_sid.



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

def 
  @account_sid
end

#auth_token ⇒ Object

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

#edge ⇒ Object

Returns the value of attribute edge.



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

def edge
  @edge
end

#http_client ⇒ Object

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

#logger ⇒ Object

Returns the value of attribute logger.



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

def logger
  @logger
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#region ⇒ Object

Returns the value of attribute region.



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

def region
  @region
end

#user_agent_extensions ⇒ Object

Returns the value of attribute user_agent_extensions.



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

def user_agent_extensions
  @user_agent_extensions
end

#username ⇒ Object

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

#accounts ⇒ Object

Access the Accounts Twilio Domain



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

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:



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

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

#api ⇒ Object

Access the Api Twilio Domain



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

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:



378
379
380
 
# File 'lib/twilio-ruby/rest/client.rb', line 378

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:



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

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

#autopilot ⇒ Object

Access the Autopilot Twilio Domain



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

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:



396
397
398
 
# File 'lib/twilio-ruby/rest/client.rb', line 396

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

#balance ⇒ Twilio::REST::Api::V2010::AccountContext::BalanceInstance

Returns:



402
403
404
 
# File 'lib/twilio-ruby/rest/client.rb', line 402

def balance
  self.api.v2010..balance
end

#build_uri(uri) ⇒ Object

Build the final request uri



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/client.rb', line 130

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

#bulkexports ⇒ Object

Access the Bulkexports Twilio Domain



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

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 we created to identify this Call resource.

Returns:



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

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

#chat ⇒ Object

Access the Chat Twilio Domain



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

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:



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

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:



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

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

#conversations ⇒ Object

Access the Conversations Twilio Domain



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

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

#events ⇒ Object

Access the Events Twilio Domain



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

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

#flex_api ⇒ Object

Access the FlexApi Twilio Domain



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

def flex_api
  @flex_api ||= FlexApi.new self
end

#frontline_api ⇒ Object

Access the FrontlineApi Twilio Domain



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

def frontline_api
  @frontline_api ||= FrontlineApi.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:



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

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

#insights ⇒ Object

Access the Insights Twilio Domain



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

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

#ip_messaging ⇒ Object

Access the IpMessaging Twilio Domain



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

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:



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

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

#lookups ⇒ Object

Access the Lookups Twilio Domain



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

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

#media ⇒ Object

Access the Media Twilio Domain



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

def media
  @media ||= Media.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:



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

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

#messaging ⇒ Object

Access the Messaging Twilio Domain



240
241
242
 
# File 'lib/twilio-ruby/rest/client.rb', line 240

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

#microvisor ⇒ Object

Access the Microvisor Twilio Domain



360
361
362
 
# File 'lib/twilio-ruby/rest/client.rb', line 360

def microvisor
  @microvisor ||= Microvisor.new self
end

#monitor ⇒ Object

Access the Monitor Twilio Domain



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

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

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

Returns:



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

def new_keys
  self.api.v2010..new_keys
end

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

Returns:



468
469
470
 
# File 'lib/twilio-ruby/rest/client.rb', line 468

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:



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

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

#notify ⇒ Object

Access the Notify Twilio Domain



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

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

#numbers ⇒ Object

Access the Numbers Twilio Domain



258
259
260
 
# File 'lib/twilio-ruby/rest/client.rb', line 258

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:



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

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

#preview ⇒ Object

Access the Preview Twilio Domain



264
265
266
 
# File 'lib/twilio-ruby/rest/client.rb', line 264

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

#pricing ⇒ Object

Access the Pricing Twilio Domain



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

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

#proxy ⇒ Object

Access the Proxy Twilio Domain



276
277
278
 
# File 'lib/twilio-ruby/rest/client.rb', line 276

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:



495
496
497
 
# File 'lib/twilio-ruby/rest/client.rb', line 495

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:



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

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
124
125
126
 
# File 'lib/twilio-ruby/rest/client.rb', line 71

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

  ruby_config = RbConfig::CONFIG
  headers['User-Agent'] = "twilio-ruby/#{Twilio::VERSION} (#{ruby_config["host_os"]} #{ruby_config["host_cpu"]}) Ruby/#{RUBY_VERSION}"
  headers['Accept-Charset'] = 'utf-8'

  user_agent_extensions.each { |extension| headers['User-Agent'] += " #{extension}" }

  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)

  if @logger
    @logger.debug("--BEGIN Twilio API Request--")
    @logger.debug("Request Method: <#{method}>")

    headers.each do |key, value|
      unless key.downcase == 'authorization'
        @logger.debug("#{key}:#{value}")
      end
    end

    url = URI(uri)
    @logger.debug("Host:#{url.host}")
    @logger.debug("Path:#{url.path}")
    @logger.debug("Query:#{url.query}")
    @logger.debug("Request Params:#{params}")
  end

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

  if @logger
    @logger.debug("Response Status Code:#{response.status_code}")
    @logger.debug("Response Headers:#{response.headers}")
    @logger.debug("--END TWILIO API REQUEST--")
  end

  response
end

#routes ⇒ Object

Access the Routes Twilio Domain



282
283
284
 
# File 'lib/twilio-ruby/rest/client.rb', line 282

def routes
  @routes ||= Routes.new self
end

#serverless ⇒ Object

Access the Serverless Twilio Domain



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

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:



527
528
529
 
# File 'lib/twilio-ruby/rest/client.rb', line 527

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:



512
513
514
 
# File 'lib/twilio-ruby/rest/client.rb', line 512

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

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

Returns:



518
519
520
 
# File 'lib/twilio-ruby/rest/client.rb', line 518

def sip
  self.api.v2010..sip
end

#studio ⇒ Object

Access the Studio Twilio Domain



294
295
296
 
# File 'lib/twilio-ruby/rest/client.rb', line 294

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

#supersim ⇒ Object

Access the Supersim Twilio Domain



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

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

#sync ⇒ Object

Access the Sync Twilio Domain



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

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

#taskrouter ⇒ Object

Access the Taskrouter Twilio Domain



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

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

#to_s ⇒ Object

Provide a user friendly representation



560
561
562
 
# File 'lib/twilio-ruby/rest/client.rb', line 560

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

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

Returns:



533
534
535
 
# File 'lib/twilio-ruby/rest/client.rb', line 533

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:



542
543
544
 
# File 'lib/twilio-ruby/rest/client.rb', line 542

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

#trunking ⇒ Object

Access the Trunking Twilio Domain



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

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

#trusthub ⇒ Object

Access the Trusthub Twilio Domain



318
319
320
 
# File 'lib/twilio-ruby/rest/client.rb', line 318

def trusthub
  @trusthub ||= Trusthub.new self
end

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

Returns:



548
549
550
 
# File 'lib/twilio-ruby/rest/client.rb', line 548

def usage
  self.api.v2010..usage
end

#validate_ssl_certificate ⇒ Object

Validate the new SSL certificate for the Twilio API



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

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:



554
555
556
 
# File 'lib/twilio-ruby/rest/client.rb', line 554

def validation_requests
  self.api.v2010..validation_requests
end

#verify ⇒ Object

Access the Verify Twilio Domain



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

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

#video ⇒ Object

Access the Video Twilio Domain



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

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

#voice ⇒ Object

Access the Voice Twilio Domain



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

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

#wireless ⇒ Object

Access the Wireless Twilio Domain



342
343
344
 
# File 'lib/twilio-ruby/rest/client.rb', line 342

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