Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.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/incoming_phone_number/toll_free.rb
Defined Under Namespace
Classes: LocalInstance, LocalList, LocalPage, MobileInstance, MobileList, MobilePage, TollFreeInstance, TollFreeList, TollFreePage
Instance Method Summary collapse
-
#create(api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, identity_sid: :unset, address_sid: :unset, voice_receive_mode: :unset, bundle_sid: :unset, phone_number: :unset, area_code: :unset) ⇒ IncomingPhoneNumberInstance
Create the IncomingPhoneNumberInstance.
-
#each ⇒ Object
When passed a block, yields IncomingPhoneNumberInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of IncomingPhoneNumberInstance records from the API.
-
#initialize(version, account_sid: nil) ⇒ IncomingPhoneNumberList
constructor
Initialize the IncomingPhoneNumberList.
-
#list(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) ⇒ Array
Lists IncomingPhoneNumberInstance records from the API as a list.
-
#local ⇒ LocalList, LocalContext
Access the local.
-
#mobile ⇒ MobileList, MobileContext
Access the mobile.
-
#page(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of IncomingPhoneNumberInstance records from the API.
-
#stream(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#toll_free ⇒ TollFreeList, TollFreeContext
Access the toll_free.
Constructor Details
#initialize(version, account_sid: nil) ⇒ IncomingPhoneNumberList
Initialize the IncomingPhoneNumberList
27 28 29 30 31 32 33 34 35 36 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 27 def initialize(version, account_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid } @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers.json" # Components @toll_free = nil @local = nil @mobile = nil end |
Instance Method Details
#create(api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, identity_sid: :unset, address_sid: :unset, voice_receive_mode: :unset, bundle_sid: :unset, phone_number: :unset, area_code: :unset) ⇒ IncomingPhoneNumberInstance
Create the IncomingPhoneNumberInstance
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 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 123 124 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 64 def create( api_version: :unset, friendly_name: :unset, sms_application_sid: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, status_callback: :unset, status_callback_method: :unset, voice_application_sid: :unset, voice_caller_id_lookup: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, emergency_status: :unset, emergency_address_sid: :unset, trunk_sid: :unset, identity_sid: :unset, address_sid: :unset, voice_receive_mode: :unset, bundle_sid: :unset, phone_number: :unset, area_code: :unset ) data = Twilio::Values.of({ 'ApiVersion' => api_version, 'FriendlyName' => friendly_name, 'SmsApplicationSid' => sms_application_sid, 'SmsFallbackMethod' => sms_fallback_method, 'SmsFallbackUrl' => sms_fallback_url, 'SmsMethod' => sms_method, 'SmsUrl' => sms_url, 'StatusCallback' => status_callback, 'StatusCallbackMethod' => status_callback_method, 'VoiceApplicationSid' => voice_application_sid, 'VoiceCallerIdLookup' => voice_caller_id_lookup, 'VoiceFallbackMethod' => voice_fallback_method, 'VoiceFallbackUrl' => voice_fallback_url, 'VoiceMethod' => voice_method, 'VoiceUrl' => voice_url, 'EmergencyStatus' => emergency_status, 'EmergencyAddressSid' => emergency_address_sid, 'TrunkSid' => trunk_sid, 'IdentitySid' => identity_sid, 'AddressSid' => address_sid, 'VoiceReceiveMode' => voice_receive_mode, 'BundleSid' => bundle_sid, 'PhoneNumber' => phone_number, 'AreaCode' => area_code, }) payload = @version.create('POST', @uri, data: data) IncomingPhoneNumberInstance.new( @version, payload, account_sid: @solution[:account_sid], ) end |
#each ⇒ Object
When passed a block, yields IncomingPhoneNumberInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
185 186 187 188 189 190 191 192 193 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 185 def each limits = @version.read_limits page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]).each {|x| yield x} end |
#get_page(target_url) ⇒ Page
Retrieve a single page of IncomingPhoneNumberInstance records from the API. Request is executed immediately.
227 228 229 230 231 232 233 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 227 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) IncomingPhoneNumberPage.new(@version, response, @solution) end |
#list(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) ⇒ Array
Lists IncomingPhoneNumberInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
142 143 144 145 146 147 148 149 150 151 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 142 def list(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) self.stream( beta: beta, friendly_name: friendly_name, phone_number: phone_number, origin: origin, limit: limit, page_size: page_size ).entries end |
#local ⇒ LocalList, LocalContext
Access the local
247 248 249 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 247 def local @local ||= LocalList.new(@version, account_sid: @solution[:account_sid] ) end |
#mobile ⇒ MobileList, MobileContext
Access the mobile
254 255 256 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 254 def mobile @mobile ||= MobileList.new(@version, account_sid: @solution[:account_sid] ) end |
#page(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of IncomingPhoneNumberInstance records from the API. Request is executed immediately.
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 206 def page(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Beta' => beta, 'FriendlyName' => friendly_name, 'PhoneNumber' => phone_number, 'Origin' => origin, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) IncomingPhoneNumberPage.new(@version, response, @solution) end |
#stream(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 168 def stream(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( beta: beta, friendly_name: friendly_name, phone_number: phone_number, origin: origin, page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end |
#to_s ⇒ Object
Provide a user friendly representation
259 260 261 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 259 def to_s '#<Twilio.Api.V2010.IncomingPhoneNumberList>' end |
#toll_free ⇒ TollFreeList, TollFreeContext
Access the toll_free
240 241 242 |
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb', line 240 def toll_free @toll_free ||= TollFreeList.new(@version, account_sid: @solution[:account_sid] ) end |