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
51
# 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
  @insights = nil
end

Instance Attribute Details

#account_sidObject

Returns the value of attribute account_sid



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

def 
  @account_sid
end

#auth_tokenObject

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_clientObject

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

#passwordObject

Returns the value of attribute password



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

def password
  @password
end

#regionObject

Returns the value of attribute region



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

def region
  @region
end

#usernameObject

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

#accountsObject

Access the Accounts Twilio Domain



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

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:



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

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

#apiObject

Access the Api Twilio Domain



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

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:



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

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:



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

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

#authyObject

Access the Authy Twilio Domain



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

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

#autopilotObject

Access the Autopilot Twilio Domain



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

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:



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

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

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



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

def balance
  self.api.v2010..balance
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:



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

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

#chatObject

Access the Chat Twilio Domain



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

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:



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

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:



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

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

#faxObject

Access the Fax Twilio Domain



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

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:



310
311
312
# File 'lib/twilio-ruby/rest/client.rb', line 310

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

#insightsObject

Access the Insights Twilio Domain



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

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

#ip_messagingObject

Access the IpMessaging Twilio Domain



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

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:



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

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

#lookupsObject

Access the Lookups Twilio Domain



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

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:



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

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

#messagingObject

Access the Messaging Twilio Domain



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

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

#monitorObject

Access the Monitor Twilio Domain



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

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

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



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

def new_keys
  self.api.v2010..new_keys
end

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



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

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:



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

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

#notifyObject

Access the Notify Twilio Domain



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

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:



358
359
360
# File 'lib/twilio-ruby/rest/client.rb', line 358

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

#previewObject

Access the Preview Twilio Domain



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

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

#pricingObject

Access the Pricing Twilio Domain



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

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

#proxyObject

Access the Proxy Twilio Domain



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

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:



367
368
369
# File 'lib/twilio-ruby/rest/client.rb', line 367

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:



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

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



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

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)

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

Returns:



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

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:



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

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

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



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

def sip
  self.api.v2010..sip
end

#studioObject

Access the Studio Twilio Domain



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

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

#syncObject

Access the Sync Twilio Domain



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

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

#taskrouterObject

Access the Taskrouter Twilio Domain



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

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

#to_sObject

Provide a user friendly representation



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

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

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



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

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:



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

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

#trunkingObject

Access the Trunking Twilio Domain



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

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

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



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

def usage
  self.api.v2010..usage
end

#validate_ssl_certificateObject

Validate the new SSL certificate for the Twilio API



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

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



425
426
427
# File 'lib/twilio-ruby/rest/client.rb', line 425

def validation_requests
  self.api.v2010..validation_requests
end

#verifyObject

Access the Verify Twilio Domain



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

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

#videoObject

Access the Video Twilio Domain



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

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

#voiceObject

Access the Voice Twilio Domain



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

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

#wirelessObject

Access the Wireless Twilio Domain



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

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