Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList::TollFreeList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ TollFreeList

Initialize the TollFreeList

Parameters:



23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 23

def initialize(version, account_sid: nil)
  super(version)

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/TollFree.json"
end

Instance Method Details

#create(phone_number: nil, 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, identity_sid: :unset, address_sid: :unset) ⇒ TollFreeInstance

Retrieve a single page of TollFreeInstance records from the API. Request is executed immediately.

Parameters:

  • phone_number (String) (defaults to: nil) —

    The phone number you want to purchase. The number should be formatted starting with a ‘+’ followed by the country code and the number in [E.164](en.wikipedia.org/wiki/E.164) format e.g., ‘+15105555555’. **You must include either this or an ‘AreaCode` parameter to have your POST succeed.**

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

    The Twilio REST API version to use for incoming calls made to this number. If omitted, uses ‘2010-04-01`.

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

    A human readable description of the new incoming phone number. Maximum 64 characters. Defaults to a formatted version of the number.

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

    The 34 character sid of the application Twilio should use to handle SMSs sent to the new number. If a ‘SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.

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

    The HTTP method that should be used to request the ‘SmsFallbackUrl`. Must be either `GET` or `POST`. Defaults to `POST`.

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

    A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by ‘SmsUrl`.

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

    The HTTP method that should be used to request the ‘SmsUrl`. Must be either `GET` or `POST`. Defaults to `POST`.

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

    The URL that Twilio should request when somebody sends an SMS to the phone number.

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

    The URL that Twilio will request to pass status parameters (such as call ended) to your application.

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

    The HTTP method Twilio will use to make requests to the ‘StatusCallback` URL. Either `GET` or `POST`. Defaults to `POST`.

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

    The 34 character sid of the application Twilio should use to handle phone calls to the new number. If a ‘VoiceApplicationSid` is present, Twilio will ignore all of the voice urls above and use those set on the application. Setting a `VoiceApplicationSid` will automatically delete your `TrunkSid` and vice versa.

  • voice_caller_id_lookup (Boolean) (defaults to: :unset) —

    Do a lookup of a caller’s name from the CNAM database and post it to your app. Either ‘true` or `false`. Defaults to `false`.

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

    The HTTP method that should be used to request the ‘VoiceFallbackUrl`. Either `GET` or `POST`. Defaults to `POST`.

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

    A URL that Twilio will request if an error occurs requesting or executing the TwiML at ‘Url`.

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

    The HTTP method that should be used to request the ‘VoiceUrl`. Must be either `GET` or `POST`. Defaults to `POST`.

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

    The URL that Twilio should request when somebody dials the new phone number. The VoiceURL will no longer be used if a ‘VoiceApplicationSid` or a `TrunkSid` is set.

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

    The identity_sid

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

    The 34 character sid of the address Twilio should associate with the number.

Returns:



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 212

def create(phone_number: nil, 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, identity_sid: :unset, address_sid: :unset)
  data = Twilio::Values.of({
      'PhoneNumber' => phone_number,
      '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,
      'IdentitySid' => identity_sid,
      'AddressSid' => address_sid,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  TollFreeInstance.new(@version, payload, account_sid: @solution[:account_sid], )
end

#each ⇒ Object

When passed a block, yields TollFreeInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



102
103
104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 102

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 TollFreeInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of TollFreeInstance



152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 152

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  TollFreePage.new(@version, response, @solution)
end

#list(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) ⇒ Array

Lists TollFreeInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • beta (Boolean) (defaults to: :unset) —

    Include phone numbers new to the Twilio platform. Possible values are either ‘true` or `false`. Default is `true`.

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

    Only show the incoming phone number resources with friendly names that exactly match this name.

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

    Only show the incoming phone number resources that match this pattern. You can specify partial numbers and use ‘*’ as a wildcard for any digit.

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

    Include phone numbers based on the origin, by default, phone numbers of all origin are included. Possible values are either ‘twilio` or `hosted`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 52

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

#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 TollFreeInstance records from the API. Request is executed immediately.

Parameters:

  • beta (Boolean) (defaults to: :unset) —

    Include phone numbers new to the Twilio platform. Possible values are either ‘true` or `false`. Default is `true`.

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

    Only show the incoming phone number resources with friendly names that exactly match this name.

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

    Only show the incoming phone number resources that match this pattern. You can specify partial numbers and use ‘*’ as a wildcard for any digit.

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

    Include phone numbers based on the origin, by default, phone numbers of all origin are included. Possible values are either ‘twilio` or `hosted`.

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of TollFreeInstance



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 129

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
  )
  TollFreePage.new(@version, response, @solution)
end

#stream(beta: :unset, friendly_name: :unset, phone_number: :unset, origin: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams TollFreeInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • beta (Boolean) (defaults to: :unset) —

    Include phone numbers new to the Twilio platform. Possible values are either ‘true` or `false`. Default is `true`.

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

    Only show the incoming phone number resources with friendly names that exactly match this name.

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

    Only show the incoming phone number resources that match this pattern. You can specify partial numbers and use ‘*’ as a wildcard for any digit.

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

    Include phone numbers based on the origin, by default, phone numbers of all origin are included. Possible values are either ‘twilio` or `hosted`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 84

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



245
246
247
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 245

def to_s
  '#<Twilio.Api.V2010.TollFreeList>'
end