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
 
# 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
  @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



100
101
102
 
# File 'lib/twilio-ruby/rest/client.rb', line 100

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:



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

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

#api ⇒ Object

Access the Api Twilio Domain



106
107
108
 
# File 'lib/twilio-ruby/rest/client.rb', line 106

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:



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

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:



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

def authorized_connect_apps(connect_app_sid=:unset)
  self.api.v2010..authorized_connect_apps(connect_app_sid)
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:



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

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:



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

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

#chat ⇒ Object

Access the Chat Twilio Domain



112
113
114
 
# File 'lib/twilio-ruby/rest/client.rb', line 112

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:



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

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:



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

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

#fax ⇒ Object

Access the Fax Twilio Domain



118
119
120
 
# File 'lib/twilio-ruby/rest/client.rb', line 118

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:



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

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

#ip_messaging ⇒ Object

Access the IpMessaging Twilio Domain



124
125
126
 
# File 'lib/twilio-ruby/rest/client.rb', line 124

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:



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

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

#lookups ⇒ Object

Access the Lookups Twilio Domain



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

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:



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

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

#messaging ⇒ Object

Access the Messaging Twilio Domain



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

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

#monitor ⇒ Object

Access the Monitor Twilio Domain



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

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

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

Returns:



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

def new_keys
  self.api.v2010..new_keys
end

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

Returns:



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

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:



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

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

#notify ⇒ Object

Access the Notify Twilio Domain



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

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:



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

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

#preview ⇒ Object

Access the Preview Twilio Domain



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

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

#pricing ⇒ Object

Access the Pricing Twilio Domain



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

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

#proxy ⇒ Object

Access the Proxy Twilio Domain



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

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:



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

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:



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

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



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

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:



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

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:



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

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

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

Returns:



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

def sip
  self.api.v2010..sip
end

#studio ⇒ Object

Access the Studio Twilio Domain



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

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

#sync ⇒ Object

Access the Sync Twilio Domain



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

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

#taskrouter ⇒ Object

Access the Taskrouter Twilio Domain



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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

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

Returns:



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

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:



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

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

#trunking ⇒ Object

Access the Trunking Twilio Domain



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

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

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

Returns:



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

def usage
  self.api.v2010..usage
end

#validate_ssl_certificate ⇒ Object

Validate the new SSL certificate for the Twilio API



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

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:



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

def validation_requests
  self.api.v2010..validation_requests
end

#verify ⇒ Object

Access the Verify Twilio Domain



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

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

#video ⇒ Object

Access the Video Twilio Domain



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

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

#voice ⇒ Object

Access the Voice Twilio Domain



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

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

#wireless ⇒ Object

Access the Wireless Twilio Domain



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

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