Class: Twilio::REST::Proxy::V1::ServiceContext::PhoneNumberList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ PhoneNumberList

Initialize the PhoneNumberList

Parameters:



23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 23

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

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers"
end

Instance Method Details

#create(sid: :unset, phone_number: :unset, is_reserved: :unset) ⇒ PhoneNumberInstance

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

Parameters:

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

    A Twilio [IncomingPhoneNumber](www.twilio.com/docs/phone-numbers/api/incoming-phone-numbers) Sid that represents the Twilio Number you would like to assign to your Proxy Service (e.g. ‘PN1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d`).

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

    A string that represents the Twilio Number you would like to assign to your Proxy Service. Provide number in [E.164](en.wikipedia.org/wiki/E.164) format (e.g. ‘+16175551212`).

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

    Whether or not the number should be excluded from being assigned to a participant using proxy pool logic

Returns:



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 42

def create(sid: :unset, phone_number: :unset, is_reserved: :unset)
  data = Twilio::Values.of({'Sid' => sid, 'PhoneNumber' => phone_number, 'IsReserved' => is_reserved, })

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

  PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#each ⇒ Object

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



92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 92

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of PhoneNumberInstance



128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 128

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

#list(limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • 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



65
66
67
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 65

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • 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 PhoneNumberInstance



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 109

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  PhoneNumberPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • 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



80
81
82
83
84
85
86
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 80

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(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



138
139
140
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 138

def to_s
  '#<Twilio.Proxy.V1.PhoneNumberList>'
end