twilio-ruby 5.15.1 → 5.58.1

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

@@ -0,0 +1,273 @@
+##
+# 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 SupportingDocumentTypeList < ListResource
+            ##
+            # Initialize the SupportingDocumentTypeList
+            # @param [Version] version Version that contains the resource
+            # @return [SupportingDocumentTypeList] SupportingDocumentTypeList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/RegulatoryCompliance/SupportingDocumentTypes"
+            end
+
+            ##
+            # Lists SupportingDocumentTypeInstance 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 SupportingDocumentTypeInstance 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 SupportingDocumentTypeInstance 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 SupportingDocumentTypeInstance 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 SupportingDocumentTypeInstance
+            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)
+
+              SupportingDocumentTypePage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of SupportingDocumentTypeInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of SupportingDocumentTypeInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              SupportingDocumentTypePage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Numbers.V2.SupportingDocumentTypeList>'
+            end
+          end
+
+          class SupportingDocumentTypePage < Page
+            ##
+            # Initialize the SupportingDocumentTypePage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SupportingDocumentTypePage] SupportingDocumentTypePage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SupportingDocumentTypeInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SupportingDocumentTypeInstance] SupportingDocumentTypeInstance
+            def get_instance(payload)
+              SupportingDocumentTypeInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Numbers.V2.SupportingDocumentTypePage>'
+            end
+          end
+
+          class SupportingDocumentTypeContext < InstanceContext
+            ##
+            # Initialize the SupportingDocumentTypeContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid The unique string that identifies the Supporting Document
+            #   Type resource.
+            # @return [SupportingDocumentTypeContext] SupportingDocumentTypeContext
+            def initialize(version, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid, }
+              @uri = "/RegulatoryCompliance/SupportingDocumentTypes/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch the SupportingDocumentTypeInstance
+            # @return [SupportingDocumentTypeInstance] Fetched SupportingDocumentTypeInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              SupportingDocumentTypeInstance.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.SupportingDocumentTypeContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Numbers.V2.SupportingDocumentTypeContext #{context}>"
+            end
+          end
+
+          class SupportingDocumentTypeInstance < InstanceResource
+            ##
+            # Initialize the SupportingDocumentTypeInstance
+            # @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 Supporting Document
+            #   Type resource.
+            # @return [SupportingDocumentTypeInstance] SupportingDocumentTypeInstance
+            def initialize(version, payload, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'machine_name' => payload['machine_name'],
+                  'fields' => payload['fields'],
+                  '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 [SupportingDocumentTypeContext] SupportingDocumentTypeContext for this SupportingDocumentTypeInstance
+            def context
+              unless @instance_context
+                @instance_context = SupportingDocumentTypeContext.new(@version, @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies the Supporting Document Type resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] A human-readable description of the Supporting Document Type resource
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [String] The machine-readable description of the Supporting Document Type resource
+            def machine_name
+              @properties['machine_name']
+            end
+
+            ##
+            # @return [Array[Hash]] The required information for creating a Supporting Document
+            def fields
+              @properties['fields']
+            end
+
+            ##
+            # @return [String] The absolute URL of the Supporting Document Type resource
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the SupportingDocumentTypeInstance
+            # @return [SupportingDocumentTypeInstance] Fetched SupportingDocumentTypeInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Numbers.V2.SupportingDocumentTypeInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Numbers.V2.SupportingDocumentTypeInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,189 @@
+##
+# 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
+          ##
+          # Initialize the RegulatoryComplianceList
+          # @param [Version] version Version that contains the resource
+          # @return [RegulatoryComplianceList] RegulatoryComplianceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+
+            # Components
+            @bundles = nil
+            @end_users = nil
+            @end_user_types = nil
+            @regulations = nil
+            @supporting_documents = nil
+            @supporting_document_types = nil
+          end
+
+          ##
+          # Access the bundles
+          # @param [String] sid The unique string that we created to identify the Bundle
+          #   resource.
+          # @return [BundleList]
+          # @return [BundleContext] if sid was passed.
+          def bundles(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return BundleContext.new(@version, sid, )
+            end
+
+              @bundles ||= BundleList.new(@version, )
+          end
+
+          ##
+          # Access the end_users
+          # @param [String] sid The unique string created by Twilio to identify the End User
+          #   resource.
+          # @return [EndUserList]
+          # @return [EndUserContext] if sid was passed.
+          def end_users(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return EndUserContext.new(@version, sid, )
+            end
+
+              @end_users ||= EndUserList.new(@version, )
+          end
+
+          ##
+          # Access the end_user_types
+          # @param [String] sid The unique string that identifies the End-User Type
+          #   resource.
+          # @return [EndUserTypeList]
+          # @return [EndUserTypeContext] if sid was passed.
+          def end_user_types(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return EndUserTypeContext.new(@version, sid, )
+            end
+
+              @end_user_types ||= EndUserTypeList.new(@version, )
+          end
+
+          ##
+          # Access the regulations
+          # @param [String] sid The unique string that identifies the Regulation resource.
+          # @return [RegulationList]
+          # @return [RegulationContext] if sid was passed.
+          def regulations(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return RegulationContext.new(@version, sid, )
+            end
+
+              @regulations ||= RegulationList.new(@version, )
+          end
+
+          ##
+          # Access the supporting_documents
+          # @param [String] sid The unique string created by Twilio to identify the
+          #   Supporting Document resource.
+          # @return [SupportingDocumentList]
+          # @return [SupportingDocumentContext] if sid was passed.
+          def supporting_documents(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return SupportingDocumentContext.new(@version, sid, )
+            end
+
+              @supporting_documents ||= SupportingDocumentList.new(@version, )
+          end
+
+          ##
+          # Access the supporting_document_types
+          # @param [String] sid The unique string that identifies the Supporting Document
+          #   Type resource.
+          # @return [SupportingDocumentTypeList]
+          # @return [SupportingDocumentTypeContext] if sid was passed.
+          def supporting_document_types(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return SupportingDocumentTypeContext.new(@version, sid, )
+            end
+
+              @supporting_document_types ||= SupportingDocumentTypeList.new(@version, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Numbers.V2.RegulatoryComplianceList>'
+          end
+        end
+
+        class RegulatoryCompliancePage < Page
+          ##
+          # Initialize the RegulatoryCompliancePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [RegulatoryCompliancePage] RegulatoryCompliancePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of RegulatoryComplianceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [RegulatoryComplianceInstance] RegulatoryComplianceInstance
+          def get_instance(payload)
+            RegulatoryComplianceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Numbers.V2.RegulatoryCompliancePage>'
+          end
+        end
+
+        class RegulatoryComplianceInstance < InstanceResource
+          ##
+          # Initialize the RegulatoryComplianceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [RegulatoryComplianceInstance] RegulatoryComplianceInstance
+          def initialize(version, payload)
+            super(version)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Numbers.V2.RegulatoryComplianceInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Numbers.V2.RegulatoryComplianceInstance>"
+          end
+        end
+      end
+    end
+  end
+end