Class: Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ AvailablePhoneNumberCountryList

Initialize the AvailablePhoneNumberCountryList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    A 34 character string that uniquely identifies this resource.



19
20
21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 19

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

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

Instance Method Details

#each ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 72

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of AvailablePhoneNumberCountryInstance



110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 110

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

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

Lists AvailablePhoneNumberCountryInstance 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



40
41
42
43
44
45
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 40

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 AvailablePhoneNumberCountryInstance 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 AvailablePhoneNumberCountryInstance



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 91

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

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

Streams AvailablePhoneNumberCountryInstance 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



58
59
60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 58

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



120
121
122
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number.rb', line 120

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