Class: Twilio::REST::Preview::Permissions::VoicePermissionList::CountryList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/permissions/voice_permission/country.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CountryList

Initialize the CountryList

Parameters:

  • version (Version) —

    Version that contains the resource



21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/preview/permissions/voice_permission/country.rb', line 21

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/VoicePermissions/Countries"
end

Instance Method Details

#each ⇒ Object

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



106
107
108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/preview/permissions/voice_permission/country.rb', line 106

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CountryInstance



159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/preview/permissions/voice_permission/country.rb', line 159

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

#list(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    The [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

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

    Filter the results by specified continent

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

    Filter the results by specified [country codes](countrycode.org/)

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

    Filter the results by specified low risk special status

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

    Filter the results by specified the status of high risk special

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

    Filter the results by specified the status of high risk tollfraud special

  • 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



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/preview/permissions/voice_permission/country.rb', line 51

def list(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, limit: nil, page_size: nil)
  self.stream(
      iso_code: iso_code,
      continent: continent,
      country_code: country_code,
      low_risk_numbers_enabled: low_risk_numbers_enabled,
      high_risk_special_numbers_enabled: high_risk_special_numbers_enabled,
      high_risk_tollfraud_numbers_enabled: high_risk_tollfraud_numbers_enabled,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    The [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

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

    Filter the results by specified continent

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

    Filter the results by specified [country codes](countrycode.org/)

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

    Filter the results by specified low risk special status

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

    Filter the results by specified the status of high risk special

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

    Filter the results by specified the status of high risk tollfraud special

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/preview/permissions/voice_permission/country.rb', line 134

def page(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'IsoCode' => iso_code,
      'Continent' => continent,
      'CountryCode' => country_code,
      'LowRiskNumbersEnabled' => low_risk_numbers_enabled,
      'HighRiskSpecialNumbersEnabled' => high_risk_special_numbers_enabled,
      'HighRiskTollfraudNumbersEnabled' => high_risk_tollfraud_numbers_enabled,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  CountryPage.new(@version, response, @solution)
end

#stream(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    The [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

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

    Filter the results by specified continent

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

    Filter the results by specified [country codes](countrycode.org/)

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

    Filter the results by specified low risk special status

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

    Filter the results by specified the status of high risk special

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

    Filter the results by specified the status of high risk tollfraud special

  • 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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/preview/permissions/voice_permission/country.rb', line 86

def stream(iso_code: :unset, continent: :unset, country_code: :unset, low_risk_numbers_enabled: :unset, high_risk_special_numbers_enabled: :unset, high_risk_tollfraud_numbers_enabled: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      iso_code: iso_code,
      continent: continent,
      country_code: country_code,
      low_risk_numbers_enabled: low_risk_numbers_enabled,
      high_risk_special_numbers_enabled: high_risk_special_numbers_enabled,
      high_risk_tollfraud_numbers_enabled: high_risk_tollfraud_numbers_enabled,
      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



169
170
171
 
# File 'lib/twilio-ruby/rest/preview/permissions/voice_permission/country.rb', line 169

def to_s
  '#<Twilio.Preview.Permissions.CountryList>'
end