Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::RegulationList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ RegulationList

Initialize the RegulationList

Parameters:

  • version (Version)

    Version that contains the resource


19
20
21
22
23
24
25
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 19

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/RegulatoryCompliance/Regulations"
end

Instance Method Details

#eachObject

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


86
87
88
89
90
91
92
93
94
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 86

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

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of RegulationInstance


128
129
130
131
132
133
134
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 128

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

#list(end_user_type: :unset, iso_country: :unset, number_type: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • end_user_type (regulation.EndUserType) (defaults to: :unset)

    The type of End User the regulation requires - can be `individual` or `business`.

  • iso_country (String) (defaults to: :unset)

    The ISO country code of the phone number's country.

  • number_type (String) (defaults to: :unset)

    The type of phone number that the regulatory requiremnt is restricting.

  • 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


43
44
45
46
47
48
49
50
51
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 43

def list(end_user_type: :unset, iso_country: :unset, number_type: :unset, limit: nil, page_size: nil)
  self.stream(
      end_user_type: end_user_type,
      iso_country: iso_country,
      number_type: number_type,
      limit: limit,
      page_size: page_size
  ).entries
end

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

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

Parameters:

  • end_user_type (regulation.EndUserType) (defaults to: :unset)

    The type of End User the regulation requires - can be `individual` or `business`.

  • iso_country (String) (defaults to: :unset)

    The ISO country code of the phone number's country.

  • number_type (String) (defaults to: :unset)

    The type of phone number that the regulatory requiremnt is restricting.

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


108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 108

def page(end_user_type: :unset, iso_country: :unset, number_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'EndUserType' => end_user_type,
      'IsoCountry' => iso_country,
      'NumberType' => number_type,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  RegulationPage.new(@version, response, @solution)
end

#stream(end_user_type: :unset, iso_country: :unset, number_type: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • end_user_type (regulation.EndUserType) (defaults to: :unset)

    The type of End User the regulation requires - can be `individual` or `business`.

  • iso_country (String) (defaults to: :unset)

    The ISO country code of the phone number's country.

  • number_type (String) (defaults to: :unset)

    The type of phone number that the regulatory requiremnt is restricting.

  • 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


69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 69

def stream(end_user_type: :unset, iso_country: :unset, number_type: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      end_user_type: end_user_type,
      iso_country: iso_country,
      number_type: number_type,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


138
139
140
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb', line 138

def to_s
  '#<Twilio.Numbers.V2.RegulationList>'
end