class Twilio::REST::Proxy::V1::ServiceContext::PhoneNumberList

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Public Class Methods

new(version, service_sid: nil) click to toggle source

Initialize the PhoneNumberList @param [Version] version Version that contains the resource @param [String] service_sid The SID of the PhoneNumber resource's parent

{Service}[https://www.twilio.com/docs/proxy/api/service] resource.

@return [PhoneNumberList] PhoneNumberList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb
23 def initialize(version, service_sid: nil)
24   super(version)
25 
26   # Path Solution
27   @solution = {service_sid: service_sid}
28   @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers"
29 end

Public Instance Methods

create(sid: :unset, phone_number: :unset, is_reserved: :unset) click to toggle source

Create the PhoneNumberInstance @param [String] sid The SID of a Twilio

{IncomingPhoneNumber}[https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource]
resource that represents the Twilio Number you would like to assign to your
Proxy Service.

@param [String] phone_number The phone number in

{E.164}[https://www.twilio.com/docs/glossary/what-e164] format.  E.164 phone
numbers consist of a + followed by the country code and subscriber number
without punctuation characters. For example, +14155551234.

@param [Boolean] is_reserved Whether the new phone number should be reserved and

not be assigned to a participant using proxy pool logic. See {Reserved Phone
Numbers}[https://www.twilio.com/docs/proxy/reserved-phone-numbers] for more
information.

@return [PhoneNumberInstance] Created PhoneNumberInstance

   # File lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb
46 def create(sid: :unset, phone_number: :unset, is_reserved: :unset)
47   data = Twilio::Values.of({'Sid' => sid, 'PhoneNumber' => phone_number, 'IsReserved' => is_reserved, })
48 
49   payload = @version.create('POST', @uri, data: data)
50 
51   PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
52 end
each() { |x| ... } click to toggle source

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

    # File lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb
 92 def each
 93   limits = @version.read_limits
 94 
 95   page = self.page(page_size: limits[:page_size], )
 96 
 97   @version.stream(page,
 98                   limit: limits[:limit],
 99                   page_limit: limits[:page_limit]).each {|x| yield x}
100 end
get_page(target_url) click to toggle source

Retrieve a single page of PhoneNumberInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of PhoneNumberInstance

    # File lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb
126 def get_page(target_url)
127   response = @version.domain.request(
128       'GET',
129       target_url
130   )
131   PhoneNumberPage.new(@version, response, @solution)
132 end
list(limit: nil, page_size: nil) click to toggle source

Lists PhoneNumberInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size 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)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb
65 def list(limit: nil, page_size: nil)
66   self.stream(limit: limit, page_size: page_size).entries
67 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of PhoneNumberInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of PhoneNumberInstance

    # File lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb
109 def page(page_token: :unset, page_number: :unset, page_size: :unset)
110   params = Twilio::Values.of({
111       'PageToken' => page_token,
112       'Page' => page_number,
113       'PageSize' => page_size,
114   })
115 
116   response = @version.page('GET', @uri, params: params)
117 
118   PhoneNumberPage.new(@version, response, @solution)
119 end
stream(limit: nil, page_size: nil) click to toggle source

Streams PhoneNumberInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size 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)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb
80 def stream(limit: nil, page_size: nil)
81   limits = @version.read_limits(limit, page_size)
82 
83   page = self.page(page_size: limits[:page_size], )
84 
85   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
86 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb
136 def to_s
137   '#<Twilio.Proxy.V1.PhoneNumberList>'
138 end