Class: Twilio::REST::Api

Inherits:
ApiBase show all
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/balance.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/call/event.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/call/siprec.rb,
lib/twilio-ruby/rest/api/v2010/account/call/stream.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/call/payment.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/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/call/transcription.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/conference/recording.rb,
lib/twilio-ruby/rest/api/v2010/account/usage/record/monthly.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types.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/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/call/user_defined_message.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/incoming_phone_number/mobile.rb,
lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country.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/sip/domain/credential_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/voip.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb,
lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload/data.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/mobile.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_calls.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb,
lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/national.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/toll_free.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/shared_cost.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations.rb,
lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/machine_to_machine.rb,
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on/assigned_add_on_extension.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_calls/auth_calls_credential_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_calls/auth_calls_ip_access_control_list_mapping.rb,
lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_type_registrations/auth_registrations_credential_list_mapping.rb

Defined Under Namespace

Classes: V2010

Instance Attribute Summary

Attributes inherited from Domain

#client

Instance Method Summary collapse

Methods inherited from ApiBase

#initialize, #to_s, #v2010

Methods inherited from Domain

#absolute_url, #initialize, #request

Constructor Details

This class inherits a constructor from Twilio::REST::ApiBase

Instance Method Details

#accountObject

Account provided as the authenticating account



6
7
8
# File 'lib/twilio-ruby/rest/api.rb', line 6

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



15
16
17
# File 'lib/twilio-ruby/rest/api.rb', line 15

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 unique string that that we created to identify the Address resource.

Returns:



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

def addresses(sid=:unset)
  warn "addresses is deprecated. Use account.addresses instead."
  self..addresses(sid)
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:



34
35
36
37
# File 'lib/twilio-ruby/rest/api.rb', line 34

def applications(sid=:unset)
  warn "applications is deprecated. Use account.applications instead."
  self..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:



43
44
45
46
# File 'lib/twilio-ruby/rest/api.rb', line 43

def authorized_connect_apps(connect_app_sid=:unset)
  warn "authorized_connect_apps is deprecated. Use account.authorized_connect_apps instead."
  self..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-3166-1 country code of the country.

Returns:



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

def available_phone_numbers(country_code=:unset)
  warn "available_phone_numbers is deprecated. Use account.available_phone_numbers instead."
  self..available_phone_numbers(country_code)
end

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



61
62
63
64
# File 'lib/twilio-ruby/rest/api.rb', line 61

def balance
  warn "balance is deprecated. Use account.balance instead."
  self..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 we created to identify this Call resource.

Returns:



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

def calls(sid=:unset)
  warn "calls is deprecated. Use account.calls instead."
  self..calls(sid)
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:



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

def conferences(sid=:unset)
  warn "conferences is deprecated. Use account.conferences instead."
  self..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:



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

def connect_apps(sid=:unset)
  warn "connect_apps is deprecated. Use account.connect_apps instead."
  self..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)

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

Returns:



101
102
103
104
# File 'lib/twilio-ruby/rest/api.rb', line 101

def incoming_phone_numbers(sid=:unset)
  warn "incoming_phone_numbers is deprecated. Use account.incoming_phone_numbers instead."
  self..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 unique string that that we created to identify the Key resource.

Returns:



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

def keys(sid=:unset)
  warn "keys is deprecated. Use account.keys instead."
  self..keys(sid)
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:



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

def messages(sid=:unset)
  warn "messages is deprecated. Use account.messages instead."
  self..messages(sid)
end

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



128
129
130
131
# File 'lib/twilio-ruby/rest/api.rb', line 128

def new_keys
  warn "new_keys is deprecated. Use account.new_keys instead."
  self..new_keys()
end

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



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

def new_signing_keys
  warn "new_signing_keys is deprecated. Use account.new_signing_keys instead."
  self..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:



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

def notifications(sid=:unset)
  warn "notifications is deprecated. Use account.notifications instead."
  self..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)

    The unique string that that we created to identify the OutgoingCallerId resource.

Returns:



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

def outgoing_caller_ids(sid=:unset)
  warn "outgoing_caller_ids is deprecated. Use account.outgoing_caller_ids instead."
  self..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)

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

Returns:



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

def queues(sid=:unset)
  warn "queues is deprecated. Use account.queues instead."
  self..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:



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

def recordings(sid=:unset)
  warn "recordings is deprecated. Use account.recordings instead."
  self..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)

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

Returns:



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

def short_codes(sid=:unset)
  warn "short_codes is deprecated. Use account.short_codes instead."
  self..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:



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

def signing_keys(sid=:unset)
  warn "signing_keys is deprecated. Use account.signing_keys instead."
  self..signing_keys(sid)
end

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



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

def sip
  warn "sip is deprecated. Use account.sip instead."
  self..sip()
end

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



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

def tokens
  warn "tokens is deprecated. Use account.tokens instead."
  self..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:



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

def transcriptions(sid=:unset)
  warn "transcriptions is deprecated. Use account.transcriptions instead."
  self..transcriptions(sid)
end

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



225
226
227
228
# File 'lib/twilio-ruby/rest/api.rb', line 225

def usage
  warn "usage is deprecated. Use account.usage instead."
  self..usage()
end

#validation_requestsTwilio::REST::Api::V2010::AccountContext::ValidationRequestInstance



232
233
234
235
# File 'lib/twilio-ruby/rest/api.rb', line 232

def validation_requests
  warn "validation_requests is deprecated. Use account.validation_requests instead."
  self..validation_requests()
end