twilio-ruby 5.31.0 → 5.46.0

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/regulation.rb

@@ -0,0 +1,314 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Numbers < Domain
+      class V2 < Version
+        class RegulatoryComplianceList < ListResource
+          class RegulationList < ListResource
+            ##
+            # Initialize the RegulationList
+            # @param [Version] version Version that contains the resource
+            # @return [RegulationList] RegulationList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/RegulatoryCompliance/Regulations"
+            end
+
+            ##
+            # Lists RegulationInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [regulation.EndUserType] end_user_type The type of End User the
+            #   regulation requires - can be `individual` or `business`.
+            # @param [String] iso_country The ISO country code of the phone number's country.
+            # @param [String] number_type The type of phone number that the regulatory
+            #   requiremnt is restricting.
+            # @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
+            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
+
+            ##
+            # Streams RegulationInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [regulation.EndUserType] end_user_type The type of End User the
+            #   regulation requires - can be `individual` or `business`.
+            # @param [String] iso_country The ISO country code of the phone number's country.
+            # @param [String] number_type The type of phone number that the regulatory
+            #   requiremnt is restricting.
+            # @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
+            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
+
+            ##
+            # When passed a block, yields RegulationInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            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
+
+            ##
+            # Retrieve a single page of RegulationInstance records from the API.
+            # Request is executed immediately.
+            # @param [regulation.EndUserType] end_user_type The type of End User the
+            #   regulation requires - can be `individual` or `business`.
+            # @param [String] iso_country The ISO country code of the phone number's country.
+            # @param [String] number_type The type of phone number that the regulatory
+            #   requiremnt is restricting.
+            # @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 RegulationInstance
+            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
+
+            ##
+            # Retrieve a single page of RegulationInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of RegulationInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              RegulationPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Numbers.V2.RegulationList>'
+            end
+          end
+
+          class RegulationPage < Page
+            ##
+            # Initialize the RegulationPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [RegulationPage] RegulationPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of RegulationInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [RegulationInstance] RegulationInstance
+            def get_instance(payload)
+              RegulationInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Numbers.V2.RegulationPage>'
+            end
+          end
+
+          class RegulationContext < InstanceContext
+            ##
+            # Initialize the RegulationContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid The unique string that identifies the Regulation resource.
+            # @return [RegulationContext] RegulationContext
+            def initialize(version, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid, }
+              @uri = "/RegulatoryCompliance/Regulations/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch the RegulationInstance
+            # @return [RegulationInstance] Fetched RegulationInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              RegulationInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Numbers.V2.RegulationContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Numbers.V2.RegulationContext #{context}>"
+            end
+          end
+
+          class RegulationInstance < InstanceResource
+            ##
+            # Initialize the RegulationInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sid The unique string that identifies the Regulation resource.
+            # @return [RegulationInstance] RegulationInstance
+            def initialize(version, payload, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'iso_country' => payload['iso_country'],
+                  'number_type' => payload['number_type'],
+                  'end_user_type' => payload['end_user_type'],
+                  'requirements' => payload['requirements'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'sid' => sid || @properties['sid'], }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [RegulationContext] RegulationContext for this RegulationInstance
+            def context
+              unless @instance_context
+                @instance_context = RegulationContext.new(@version, @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies the Regulation resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] A human-readable description of the Regulation resource
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [String] The ISO country code of the phone number's country
+            def iso_country
+              @properties['iso_country']
+            end
+
+            ##
+            # @return [String] The type of phone number restricted by the regulatory requirement
+            def number_type
+              @properties['number_type']
+            end
+
+            ##
+            # @return [regulation.EndUserType] The type of End User of the Regulation resource
+            def end_user_type
+              @properties['end_user_type']
+            end
+
+            ##
+            # @return [Hash] The sid of a regulation object that dictates requirements
+            def requirements
+              @properties['requirements']
+            end
+
+            ##
+            # @return [String] The absolute URL of the Regulation resource
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the RegulationInstance
+            # @return [RegulationInstance] Fetched RegulationInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Numbers.V2.RegulationInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Numbers.V2.RegulationInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb

@@ -0,0 +1,371 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Numbers < Domain
+      class V2 < Version
+        class RegulatoryComplianceList < ListResource
+          class SupportingDocumentList < ListResource
+            ##
+            # Initialize the SupportingDocumentList
+            # @param [Version] version Version that contains the resource
+            # @return [SupportingDocumentList] SupportingDocumentList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/RegulatoryCompliance/SupportingDocuments"
+            end
+
+            ##
+            # Create the SupportingDocumentInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   resource.
+            # @param [String] type The type of the Supporting Document.
+            # @param [Hash] attributes The set of parameters that are the attributes of the
+            #   Supporting Documents resource which are derived Supporting Document Types.
+            # @return [SupportingDocumentInstance] Created SupportingDocumentInstance
+            def create(friendly_name: nil, type: nil, attributes: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'Type' => type,
+                  'Attributes' => Twilio.serialize_object(attributes),
+              })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              SupportingDocumentInstance.new(@version, payload, )
+            end
+
+            ##
+            # Lists SupportingDocumentInstance 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
+            def list(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams SupportingDocumentInstance 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
+            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
+
+            ##
+            # When passed a block, yields SupportingDocumentInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            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
+
+            ##
+            # Retrieve a single page of SupportingDocumentInstance 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 SupportingDocumentInstance
+            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: params)
+
+              SupportingDocumentPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of SupportingDocumentInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of SupportingDocumentInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              SupportingDocumentPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Numbers.V2.SupportingDocumentList>'
+            end
+          end
+
+          class SupportingDocumentPage < Page
+            ##
+            # Initialize the SupportingDocumentPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SupportingDocumentPage] SupportingDocumentPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SupportingDocumentInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SupportingDocumentInstance] SupportingDocumentInstance
+            def get_instance(payload)
+              SupportingDocumentInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Numbers.V2.SupportingDocumentPage>'
+            end
+          end
+
+          class SupportingDocumentContext < InstanceContext
+            ##
+            # Initialize the SupportingDocumentContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid The unique string created by Twilio to identify the
+            #   Supporting Document resource.
+            # @return [SupportingDocumentContext] SupportingDocumentContext
+            def initialize(version, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid, }
+              @uri = "/RegulatoryCompliance/SupportingDocuments/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch the SupportingDocumentInstance
+            # @return [SupportingDocumentInstance] Fetched SupportingDocumentInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              SupportingDocumentInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Update the SupportingDocumentInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   resource.
+            # @param [Hash] attributes The set of parameters that are the attributes of the
+            #   Supporting Document resource which are derived Supporting Document Types.
+            # @return [SupportingDocumentInstance] Updated SupportingDocumentInstance
+            def update(friendly_name: :unset, attributes: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'Attributes' => Twilio.serialize_object(attributes),
+              })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              SupportingDocumentInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Delete the SupportingDocumentInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Numbers.V2.SupportingDocumentContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Numbers.V2.SupportingDocumentContext #{context}>"
+            end
+          end
+
+          class SupportingDocumentInstance < InstanceResource
+            ##
+            # Initialize the SupportingDocumentInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sid The unique string created by Twilio to identify the
+            #   Supporting Document resource.
+            # @return [SupportingDocumentInstance] SupportingDocumentInstance
+            def initialize(version, payload, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'mime_type' => payload['mime_type'],
+                  'status' => payload['status'],
+                  'type' => payload['type'],
+                  'attributes' => payload['attributes'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'sid' => sid || @properties['sid'], }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [SupportingDocumentContext] SupportingDocumentContext for this SupportingDocumentInstance
+            def context
+              unless @instance_context
+                @instance_context = SupportingDocumentContext.new(@version, @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies the resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The SID of the Account that created the resource
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The string that you assigned to describe the resource
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [String] The image type of the file
+            def mime_type
+              @properties['mime_type']
+            end
+
+            ##
+            # @return [supporting_document.Status] The verification status of the Supporting Document resource
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [String] The type of the Supporting Document
+            def type
+              @properties['type']
+            end
+
+            ##
+            # @return [Hash] The set of parameters that compose the Supporting Documents resource
+            def attributes
+              @properties['attributes']
+            end
+
+            ##
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [String] The absolute URL of the Supporting Document resource
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the SupportingDocumentInstance
+            # @return [SupportingDocumentInstance] Fetched SupportingDocumentInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the SupportingDocumentInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   resource.
+            # @param [Hash] attributes The set of parameters that are the attributes of the
+            #   Supporting Document resource which are derived Supporting Document Types.
+            # @return [SupportingDocumentInstance] Updated SupportingDocumentInstance
+            def update(friendly_name: :unset, attributes: :unset)
+              context.update(friendly_name: friendly_name, attributes: attributes, )
+            end
+
+            ##
+            # Delete the SupportingDocumentInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Numbers.V2.SupportingDocumentInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Numbers.V2.SupportingDocumentInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end