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) ⇒ 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
# File 'lib/twilio-ruby/rest/client.rb', line 20

def initialize(username=nil, password=nil, =nil, region=nil, http_client=nil, logger=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

  # Domains
  @accounts = nil
  @api = nil
  @autopilot = nil
  @chat = nil
  @conversations = nil
  @events = nil
  @fax = nil
  @flex_api = nil
  @frontline_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
  @trusthub = 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

#loggerObject

Returns the value of attribute logger


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

def logger
  @logger
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


164
165
166
# File 'lib/twilio-ruby/rest/client.rb', line 164

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:


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

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

#apiObject

Access the Api Twilio Domain


170
171
172
# File 'lib/twilio-ruby/rest/client.rb', line 170

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:


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

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:


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

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

#autopilotObject

Access the Autopilot Twilio Domain


176
177
178
# File 'lib/twilio-ruby/rest/client.rb', line 176

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:


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

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

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


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

def balance
  self.api.v2010..balance
end

#build_uri(uri) ⇒ Object

Build the final request uri


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

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


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

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:


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

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

#chatObject

Access the Chat Twilio Domain


182
183
184
# File 'lib/twilio-ruby/rest/client.rb', line 182

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:


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

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:


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

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

#conversationsObject

Access the Conversations Twilio Domain


188
189
190
# File 'lib/twilio-ruby/rest/client.rb', line 188

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

#eventsObject

Access the Events Twilio Domain


194
195
196
# File 'lib/twilio-ruby/rest/client.rb', line 194

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

#faxObject

Access the Fax Twilio Domain


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

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

#flex_apiObject

Access the FlexApi Twilio Domain


206
207
208
# File 'lib/twilio-ruby/rest/client.rb', line 206

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

#frontline_apiObject

Access the FrontlineApi Twilio Domain


212
213
214
# File 'lib/twilio-ruby/rest/client.rb', line 212

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:


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

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

#insightsObject

Access the Insights Twilio Domain


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

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

#ip_messagingObject

Access the IpMessaging Twilio Domain


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

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:


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

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

#lookupsObject

Access the Lookups Twilio Domain


230
231
232
# File 'lib/twilio-ruby/rest/client.rb', line 230

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:


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

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

#messagingObject

Access the Messaging Twilio Domain


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

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

#monitorObject

Access the Monitor Twilio Domain


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

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

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


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

def new_keys
  self.api.v2010..new_keys
end

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


452
453
454
# File 'lib/twilio-ruby/rest/client.rb', line 452

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:


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

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

#notifyObject

Access the Notify Twilio Domain


248
249
250
# File 'lib/twilio-ruby/rest/client.rb', line 248

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

#numbersObject

Access the Numbers Twilio Domain


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

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:


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

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

#previewObject

Access the Preview Twilio Domain


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

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

#pricingObject

Access the Pricing Twilio Domain


266
267
268
# File 'lib/twilio-ruby/rest/client.rb', line 266

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

#proxyObject

Access the Proxy Twilio Domain


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

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:


479
480
481
# File 'lib/twilio-ruby/rest/client.rb', line 479

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:


488
489
490
# File 'lib/twilio-ruby/rest/client.rb', line 488

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


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
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
# File 'lib/twilio-ruby/rest/client.rb', line 68

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)

  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

#serverlessObject

Access the Serverless Twilio Domain


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

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:


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

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:


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

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

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


502
503
504
# File 'lib/twilio-ruby/rest/client.rb', line 502

def sip
  self.api.v2010..sip
end

#studioObject

Access the Studio Twilio Domain


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

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

#supersimObject

Access the Supersim Twilio Domain


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

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

#syncObject

Access the Sync Twilio Domain


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

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

#taskrouterObject

Access the Taskrouter Twilio Domain


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

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

#to_sObject

Provide a user friendly representation


544
545
546
# File 'lib/twilio-ruby/rest/client.rb', line 544

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

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


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

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:


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

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

#trunkingObject

Access the Trunking Twilio Domain


302
303
304
# File 'lib/twilio-ruby/rest/client.rb', line 302

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

#trusthubObject

Access the Trusthub Twilio Domain


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

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

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


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

def usage
  self.api.v2010..usage
end

#validate_ssl_certificateObject

Validate the new SSL certificate for the Twilio API


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

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


538
539
540
# File 'lib/twilio-ruby/rest/client.rb', line 538

def validation_requests
  self.api.v2010..validation_requests
end

#verifyObject

Access the Verify Twilio Domain


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

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

#videoObject

Access the Video Twilio Domain


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

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

#voiceObject

Access the Voice Twilio Domain


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

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

#wirelessObject

Access the Wireless Twilio Domain


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

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