Class: Twilio::REST::Api

Inherits:

Domain

• Object
• Domain
• Twilio::REST::Api

Defined in:

lib/twilio-ruby/rest/api.rb,
lib/twilio-ruby/rest/api/v2010.rb,
lib/twilio-ruby/rest/api/v2010/account.rb,
lib/twilio-ruby/rest/api/v2010/account/key.rb,
lib/twilio-ruby/rest/api/v2010/account/sip.rb,
lib/twilio-ruby/rest/api/v2010/account/call.rb,
lib/twilio-ruby/rest/api/v2010/account/queue.rb,
lib/twilio-ruby/rest/api/v2010/account/token.rb,
lib/twilio-ruby/rest/api/v2010/account/usage.rb,
lib/twilio-ruby/rest/api/v2010/account/address.rb,
lib/twilio-ruby/rest/api/v2010/account/message.rb,
lib/twilio-ruby/rest/api/v2010/account/new_key.rb,
lib/twilio-ruby/rest/api/v2010/account/recording.rb,
lib/twilio-ruby/rest/api/v2010/account/conference.rb,
lib/twilio-ruby/rest/api/v2010/account/short_code.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb,
lib/twilio-ruby/rest/api/v2010/account/application.rb,
lib/twilio-ruby/rest/api/v2010/account/connect_app.rb,
lib/twilio-ruby/rest/api/v2010/account/signing_key.rb,
lib/twilio-ruby/rest/api/v2010/account/notification.rb,
lib/twilio-ruby/rest/api/v2010/account/queue/member.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record.rb,
lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb,
lib/twilio-ruby/rest/api/v2010/account/message/media.rb,
lib/twilio-ruby/rest/api/v2010/account/transcription.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb,
lib/twilio-ruby/rest/api/v2010/account/call/recording.rb,
lib/twilio-ruby/rest/api/v2010/account/new_signing_key.rb,
lib/twilio-ruby/rest/api/v2010/account/message/feedback.rb,
lib/twilio-ruby/rest/api/v2010/account/call/notification.rb,
lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/daily.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/today.rb,
lib/twilio-ruby/rest/api/v2010/account/validation_request.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/yearly.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb,
lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/all_time.rb,
lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/yesterday.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/last_month.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/this_month.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/local.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/mobile.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/mobile.rb,
lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number/toll_free.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb

Defined Under Namespace

Classes: V2010

Instance Attribute Summary

Attributes inherited from Domain

#client

Instance Method Summary

• #account ⇒ Object

  Account provided as the authenticating account.

• #accounts(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountInstance, Twilio::REST::Api::V2010::AccountList
• #addresses(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::AddressInstance, Twilio::REST::Api::V2010::AccountContext::AddressList
• #applications(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::ApplicationInstance, Twilio::REST::Api::V2010::AccountContext::ApplicationList
• #authorized_connect_apps(connect_app_sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppInstance, Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppList
• #available_phone_numbers(country_code = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance, Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList
• #calls(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::CallInstance, Twilio::REST::Api::V2010::AccountContext::CallList
• #conferences(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::ConferenceInstance, Twilio::REST::Api::V2010::AccountContext::ConferenceList
• #connect_apps(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::ConnectAppInstance, Twilio::REST::Api::V2010::AccountContext::ConnectAppList
• #incoming_phone_numbers(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance, Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList
• #initialize(twilio) ⇒ Api constructor

  Initialize the Api Domain.

• #keys(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::KeyInstance, Twilio::REST::Api::V2010::AccountContext::KeyList
• #messages(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::MessageInstance, Twilio::REST::Api::V2010::AccountContext::MessageList
• #new_keys ⇒ Twilio::REST::Api::V2010::AccountContext::NewKeyInstance
• #new_signing_keys ⇒ Twilio::REST::Api::V2010::AccountContext::NewSigningKeyInstance
• #notifications(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::NotificationInstance, Twilio::REST::Api::V2010::AccountContext::NotificationList
• #outgoing_caller_ids(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdInstance, Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdList
• #queues(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::QueueInstance, Twilio::REST::Api::V2010::AccountContext::QueueList
• #recordings(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::RecordingInstance, Twilio::REST::Api::V2010::AccountContext::RecordingList
• #short_codes(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::ShortCodeInstance, Twilio::REST::Api::V2010::AccountContext::ShortCodeList
• #signing_keys(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::SigningKeyInstance, Twilio::REST::Api::V2010::AccountContext::SigningKeyList
• #sip ⇒ Twilio::REST::Api::V2010::AccountContext::SipInstance
• #to_s ⇒ Object

  Provide a user friendly representation.

• #tokens ⇒ Twilio::REST::Api::V2010::AccountContext::TokenInstance
• #transcriptions(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance, Twilio::REST::Api::V2010::AccountContext::TranscriptionList
• #usage ⇒ Twilio::REST::Api::V2010::AccountContext::UsageInstance
• #v2010 ⇒ Object

  Version v2010 of api.

• #validation_requests ⇒ Twilio::REST::Api::V2010::AccountContext::ValidationRequestInstance

Methods inherited from Domain

#absolute_url, #request

Constructor Details

#initialize(twilio) ⇒ Api

Initialize the Api Domain

# File 'lib/twilio-ruby/rest/api.rb', line 12

def initialize(twilio)
  super

  @base_url = 'https://api.twilio.com'
  @host = 'api.twilio.com'
  @port = 443

  # Versions
  @v2010 = nil
end

Instance Method Details

#account ⇒ Object

Account provided as the authenticating account

# File 'lib/twilio-ruby/rest/api.rb', line 31

def account
  self.v2010.account
end

#accounts(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountInstance, Twilio::REST::Api::V2010::AccountList

Parameters:

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

  A 34 character string that uniquely identifies this resource.

Returns:

• (Twilio::REST::Api::V2010::AccountInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountList)

# File 'lib/twilio-ruby/rest/api.rb', line 40

def accounts(sid=:unset)
  self.v2010.accounts(sid)
end

#addresses(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::AddressInstance, Twilio::REST::Api::V2010::AccountContext::AddressList

Parameters:

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

  The sid

Returns:

• (Twilio::REST::Api::V2010::AccountContext::AddressInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::AddressList)

# File 'lib/twilio-ruby/rest/api.rb', line 48

def addresses(sid=:unset)
  self.account.addresses(sid)
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:

• (Twilio::REST::Api::V2010::AccountContext::ApplicationInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::ApplicationList)

# File 'lib/twilio-ruby/rest/api.rb', line 57

def applications(sid=:unset)
  self.account.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:

• (Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppInstance) —

  if connect_app_sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppList)

# File 'lib/twilio-ruby/rest/api.rb', line 66

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

• (Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance) —

  if country_code was passed.

• (Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList)

# File 'lib/twilio-ruby/rest/api.rb', line 74

def available_phone_numbers(country_code=:unset)
  self.account.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 this resource.

Returns:

• (Twilio::REST::Api::V2010::AccountContext::CallInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::CallList)

# File 'lib/twilio-ruby/rest/api.rb', line 83

def calls(sid=:unset)
  self.account.calls(sid)
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:

• (Twilio::REST::Api::V2010::AccountContext::ConferenceInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::ConferenceList)

# File 'lib/twilio-ruby/rest/api.rb', line 92

def conferences(sid=:unset)
  self.account.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:

• (Twilio::REST::Api::V2010::AccountContext::ConnectAppInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::ConnectAppList)

# File 'lib/twilio-ruby/rest/api.rb', line 100

def connect_apps(sid=:unset)
  self.account.connect_apps(sid)
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:

• (Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList)

# File 'lib/twilio-ruby/rest/api.rb', line 109

def incoming_phone_numbers(sid=:unset)
  self.account.incoming_phone_numbers(sid)
end

#keys(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::KeyInstance, Twilio::REST::Api::V2010::AccountContext::KeyList

Parameters:

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

  The sid

Returns:

• (Twilio::REST::Api::V2010::AccountContext::KeyInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::KeyList)

# File 'lib/twilio-ruby/rest/api.rb', line 117

def keys(sid=:unset)
  self.account.keys(sid)
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:

• (Twilio::REST::Api::V2010::AccountContext::MessageInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::MessageList)

# File 'lib/twilio-ruby/rest/api.rb', line 126

def messages(sid=:unset)
  self.account.messages(sid)
end

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

Returns:

• (Twilio::REST::Api::V2010::AccountContext::NewKeyInstance)

# File 'lib/twilio-ruby/rest/api.rb', line 132

def new_keys
  self.account.new_keys()
end

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

Returns:

• (Twilio::REST::Api::V2010::AccountContext::NewSigningKeyInstance)

# File 'lib/twilio-ruby/rest/api.rb', line 138

def new_signing_keys
  self.account.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:

• (Twilio::REST::Api::V2010::AccountContext::NotificationInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::NotificationList)

# File 'lib/twilio-ruby/rest/api.rb', line 147

def notifications(sid=:unset)
  self.account.notifications(sid)
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:

• (Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdList)

# File 'lib/twilio-ruby/rest/api.rb', line 156

def outgoing_caller_ids(sid=:unset)
  self.account.outgoing_caller_ids(sid)
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:

• (Twilio::REST::Api::V2010::AccountContext::QueueInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::QueueList)

# File 'lib/twilio-ruby/rest/api.rb', line 164

def queues(sid=:unset)
  self.account.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:

• (Twilio::REST::Api::V2010::AccountContext::RecordingInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::RecordingList)

# File 'lib/twilio-ruby/rest/api.rb', line 173

def recordings(sid=:unset)
  self.account.recordings(sid)
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:

• (Twilio::REST::Api::V2010::AccountContext::ShortCodeInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::ShortCodeList)

# File 'lib/twilio-ruby/rest/api.rb', line 196

def short_codes(sid=:unset)
  self.account.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:

• (Twilio::REST::Api::V2010::AccountContext::SigningKeyInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::SigningKeyList)

# File 'lib/twilio-ruby/rest/api.rb', line 181

def signing_keys(sid=:unset)
  self.account.signing_keys(sid)
end

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

Returns:

• (Twilio::REST::Api::V2010::AccountContext::SipInstance)

# File 'lib/twilio-ruby/rest/api.rb', line 187

def sip
  self.account.sip()
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/api.rb', line 229

def to_s
  '#<Twilio::REST::Api>'
end

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

Returns:

• (Twilio::REST::Api::V2010::AccountContext::TokenInstance)

# File 'lib/twilio-ruby/rest/api.rb', line 202

def tokens
  self.account.tokens()
end

#transcriptions(sid = :unset) ⇒ Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance, Twilio::REST::Api::V2010::AccountContext::TranscriptionList

Parameters:

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

  A 34 character string that uniquely identifies this resource.

Returns:

• (Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance) —

  if sid was passed.

• (Twilio::REST::Api::V2010::AccountContext::TranscriptionList)

# File 'lib/twilio-ruby/rest/api.rb', line 211

def transcriptions(sid=:unset)
  self.account.transcriptions(sid)
end

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

Returns:

• (Twilio::REST::Api::V2010::AccountContext::UsageInstance)

# File 'lib/twilio-ruby/rest/api.rb', line 217

def usage
  self.account.usage()
end

#v2010 ⇒ Object

Version v2010 of api

# File 'lib/twilio-ruby/rest/api.rb', line 25

def v2010
  @v2010 ||= V2010.new self
end

#validation_requests ⇒ Twilio::REST::Api::V2010::AccountContext::ValidationRequestInstance

Returns:

• (Twilio::REST::Api::V2010::AccountContext::ValidationRequestInstance)

# File 'lib/twilio-ruby/rest/api.rb', line 223

def validation_requests
  self.account.validation_requests()
end