twilio-ruby 4.6.1 → 6.9.0

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

@@ -0,0 +1,297 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Numbers
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Numbers < NumbersBase
+            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 Instance 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 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 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 SupportingDocumentTypeInstance < InstanceResource
+                    ##
+                    # Initialize the SupportingDocumentTypeInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this SupportingDocumentType
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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] CallContext for this CallInstance
+                    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. The required fields will change as regulatory needs change and will differ for businesses and individuals.
+                    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,185 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Numbers
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Numbers < NumbersBase
+            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 = {  }
+                        @uri = "/RegulatoryCompliance"
+                        # Components
+                        @supporting_documents = nil
+                        @end_users = nil
+                        @bundles = nil
+                        @supporting_document_types = nil
+                        @regulations = nil
+                        @end_user_types = nil
+                    end
+                
+
+                ##
+                # Access the supporting_documents
+                # @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 end_users
+                # @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 bundles
+                # @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 supporting_document_types
+                # @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
+                ##
+                # Access the regulations
+                # @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 end_user_types
+                # @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
+
+                    # 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
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this RegulatoryCompliance
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [RegulatoryComplianceInstance] RegulatoryComplianceInstance
+                    def initialize(version )
+                        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

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

@@ -0,0 +1,85 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Numbers
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+module Twilio
+    module REST
+        class Numbers
+            class V2 < Version
+                ##
+                # Initialize the V2 version of Numbers
+                def initialize(domain)
+                    super
+                    @version = 'v2'
+                    @authorization_documents = nil
+                    @bulk_hosted_number_orders = nil
+                    @hosted_number_orders = nil
+                    @regulatory_compliance = nil
+                end
+
+                ##
+                # @param [String] sid A 34 character string that uniquely identifies this AuthorizationDocument.
+                # @return [Twilio::REST::Numbers::V2::AuthorizationDocumentContext] if sid was passed.
+                # @return [Twilio::REST::Numbers::V2::AuthorizationDocumentList]
+                def authorization_documents(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+                    if sid == :unset
+                        @authorization_documents ||= AuthorizationDocumentList.new self
+                    else
+                        AuthorizationDocumentContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] bulk_hosting_sid A 34 character string that uniquely identifies this BulkHostedNumberOrder.
+                # @return [Twilio::REST::Numbers::V2::BulkHostedNumberOrderContext] if bulkHostingSid was passed.
+                # @return [Twilio::REST::Numbers::V2::BulkHostedNumberOrderList]
+                def bulk_hosted_number_orders(bulk_hosting_sid=:unset)
+                    if bulk_hosting_sid.nil?
+                        raise ArgumentError, 'bulk_hosting_sid cannot be nil'
+                    end
+                    if bulk_hosting_sid == :unset
+                        @bulk_hosted_number_orders ||= BulkHostedNumberOrderList.new self
+                    else
+                        BulkHostedNumberOrderContext.new(self, bulk_hosting_sid)
+                    end
+                end
+                ##
+                # @param [String] sid A 34 character string that uniquely identifies this HostedNumberOrder.
+                # @return [Twilio::REST::Numbers::V2::HostedNumberOrderContext] if sid was passed.
+                # @return [Twilio::REST::Numbers::V2::HostedNumberOrderList]
+                def hosted_number_orders(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+                    if sid == :unset
+                        @hosted_number_orders ||= HostedNumberOrderList.new self
+                    else
+                        HostedNumberOrderContext.new(self, sid)
+                    end
+                end
+                ##
+                # @return [Twilio::REST::Numbers::V2::RegulatoryComplianceList]
+                def regulatory_compliance
+                    @regulatory_compliance ||= RegulatoryComplianceList.new self
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Numbers::V2>';
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,12 @@
+module Twilio
+  module REST
+    class Numbers < NumbersBase
+      ##
+      # @return [Twilio::REST::Numbers::V2::RegulatoryComplianceInstance]
+      def regulatory_compliance
+        warn "regulatory_compliance is deprecated. Use v2.regulatory_compliance instead."
+        self.v2.regulatory_compliance()
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/numbers_base.rb

@@ -0,0 +1,43 @@
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # NOTE: This class is auto generated by OpenAPI Generator.
+ # https://openapi-generator.tech
+ # Do not edit the class manually.
+# frozen_string_literal: true
+module Twilio
+  module REST
+    class NumbersBase < Domain
+      ##
+      # Initialize numbers domain
+      #
+      # @param twilio - The twilio client
+      #
+      def initialize(twilio)
+        super(twilio)
+        @base_url =  "https://numbers.twilio.com"
+        @host = "numbers.twilio.com"
+        @port = 443
+        @v1 = nil
+        @v2 = nil
+      end
+
+      def v1
+        @v1 ||= Numbers::V1.new self
+      end
+
+      def v2
+        @v2 ||= Numbers::V2.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::Numbers>';
+      end
+    end
+  end
+end