twilio-ruby 5.46.1 → 5.51.0

data/lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb

@@ -0,0 +1,369 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Trusthub < Domain
+      class V1 < Version
+        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 = "/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.Trusthub.V1.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.Trusthub.V1.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 = "/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.Trusthub.V1.SupportingDocumentContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Trusthub.V1.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.Trusthub.V1.SupportingDocumentInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Trusthub.V1.SupportingDocumentInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/trusthub/v1/supporting_document_type.rb

@@ -0,0 +1,271 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Trusthub < Domain
+      class V1 < Version
+        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 = "/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.Trusthub.V1.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.Trusthub.V1.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 = "/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.Trusthub.V1.SupportingDocumentTypeContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Trusthub.V1.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.Trusthub.V1.SupportingDocumentTypeInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Trusthub.V1.SupportingDocumentTypeInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end