trinsic_api 1.1.2 → 2.0.0.pre.alpha3

data/lib/trinsic_api/models/brazil_digital_cnh_input.rb

@@ -0,0 +1,294 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class BrazilDigitalCnhInput
+    # The user's 11-digit, numeric CPF Number
+    attr_accessor :cpf_number
+
+    # The raw bytes of the digital CNH file collected from the user.                TODO: Lucas or JP help me describe these below vvvvvvvv  This can be:  - An image containing a physical or digital QR code  - A PDF file exported from the CNH app  - Some scary third thing?
+    attr_accessor :digital_cnh_file
+
+    # The MIME Type of the file contained in `DigitalCnhFile`.                Must be one of `application/pdf`, `image/jpeg`, or `image/png`.
+    attr_accessor :digital_cnh_file_content_type
+
+    # The raw bytes of the image of the user's face, collected for biometric comparison.
+    attr_accessor :facial_biometry_photo
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cpf_number' => :'cpfNumber',
+        :'digital_cnh_file' => :'digitalCnhFile',
+        :'digital_cnh_file_content_type' => :'digitalCnhFileContentType',
+        :'facial_biometry_photo' => :'facialBiometryPhoto'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'cpf_number' => :'String',
+        :'digital_cnh_file' => :'String',
+        :'digital_cnh_file_content_type' => :'String',
+        :'facial_biometry_photo' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'digital_cnh_file',
+        :'digital_cnh_file_content_type',
+        :'facial_biometry_photo'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::BrazilDigitalCnhInput` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::BrazilDigitalCnhInput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'cpf_number')
+        self.cpf_number = attributes[:'cpf_number']
+      else
+        self.cpf_number = nil
+      end
+
+      if attributes.key?(:'digital_cnh_file')
+        self.digital_cnh_file = attributes[:'digital_cnh_file']
+      end
+
+      if attributes.key?(:'digital_cnh_file_content_type')
+        self.digital_cnh_file_content_type = attributes[:'digital_cnh_file_content_type']
+      end
+
+      if attributes.key?(:'facial_biometry_photo')
+        self.facial_biometry_photo = attributes[:'facial_biometry_photo']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @cpf_number.nil?
+        invalid_properties.push('invalid value for "cpf_number", cpf_number cannot be nil.')
+      end
+
+      if @cpf_number.to_s.length > 11
+        invalid_properties.push('invalid value for "cpf_number", the character length must be smaller than or equal to 11.')
+      end
+
+      if @cpf_number.to_s.length < 11
+        invalid_properties.push('invalid value for "cpf_number", the character length must be great than or equal to 11.')
+      end
+
+      pattern = Regexp.new(/^\d*$/)
+      if @cpf_number !~ pattern
+        invalid_properties.push("invalid value for \"cpf_number\", must conform to the pattern #{pattern}.")
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @cpf_number.nil?
+      return false if @cpf_number.to_s.length > 11
+      return false if @cpf_number.to_s.length < 11
+      return false if @cpf_number !~ Regexp.new(/^\d*$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cpf_number Value to be assigned
+    def cpf_number=(cpf_number)
+      if cpf_number.nil?
+        fail ArgumentError, 'cpf_number cannot be nil'
+      end
+
+      if cpf_number.to_s.length > 11
+        fail ArgumentError, 'invalid value for "cpf_number", the character length must be smaller than or equal to 11.'
+      end
+
+      if cpf_number.to_s.length < 11
+        fail ArgumentError, 'invalid value for "cpf_number", the character length must be great than or equal to 11.'
+      end
+
+      pattern = Regexp.new(/^\d*$/)
+      if cpf_number !~ pattern
+        fail ArgumentError, "invalid value for \"cpf_number\", must conform to the pattern #{pattern}."
+      end
+
+      @cpf_number = cpf_number
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          cpf_number == o.cpf_number &&
+          digital_cnh_file == o.digital_cnh_file &&
+          digital_cnh_file_content_type == o.digital_cnh_file_content_type &&
+          facial_biometry_photo == o.facial_biometry_photo
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [cpf_number, digital_cnh_file, digital_cnh_file_content_type, facial_biometry_photo].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = TrinsicApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/trinsic_api/models/cancel_session_response.rb

@@ -1,5 +1,5 @@
 =begin
-#Connect API
+#Trinsic API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 

data/lib/trinsic_api/models/create_advanced_provider_session_request.rb

@@ -0,0 +1,312 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class CreateAdvancedProviderSessionRequest
+    # The ID of the provider to launch
+    attr_accessor :provider
+
+    # Provider-specific input for those providers which require it.
+    attr_accessor :provider_input
+
+    # The Redirect URL to which the user should be sent after the session is complete.                This field is required for providers which employ a redirect-based flow.
+    attr_accessor :redirect_url
+
+    # The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering.                Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`.  The exception being refresh content to support updating the content of the launch method.                For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities.  To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities.                If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities.  If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation.                Read more on how to integrate at <a href=\"https://docs.trinsic.id/docs/advanced-provider-sessions\">the guide on Advanced Provider Sessions</a>
+    attr_accessor :capabilities
+
+    # Whether the session should fall back to a Trinsic-hosted UI in certain instances.                Specifically, fallback will occur if any of the following are true:  - You attempted to launch a provider which requires a capability you did not express support for      - In this case, Trinsic's hosted UI will perform the necessary capability  - You attempted to launch a provider which requires input, and the input was either not provided or incomplete      - In this case, Trinsic's hosted UI will collect the necessary input from the user                If fallback occurs, the session's NextStep will always be LaunchBrowser,  and the CollectionMethod will always be CaptureRedirect.                If this field is set to `true`, you must also:  1. Set the `RedirectUrl` field to a non-empty value  2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field
+    attr_accessor :fallback_to_hosted_ui
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'provider' => :'provider',
+        :'provider_input' => :'providerInput',
+        :'redirect_url' => :'redirectUrl',
+        :'capabilities' => :'capabilities',
+        :'fallback_to_hosted_ui' => :'fallbackToHostedUI'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'provider' => :'String',
+        :'provider_input' => :'ProviderInput',
+        :'redirect_url' => :'String',
+        :'capabilities' => :'Array<IntegrationCapability>',
+        :'fallback_to_hosted_ui' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'provider_input',
+        :'redirect_url',
+        :'fallback_to_hosted_ui'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::CreateAdvancedProviderSessionRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::CreateAdvancedProviderSessionRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      else
+        self.provider = nil
+      end
+
+      if attributes.key?(:'provider_input')
+        self.provider_input = attributes[:'provider_input']
+      end
+
+      if attributes.key?(:'redirect_url')
+        self.redirect_url = attributes[:'redirect_url']
+      end
+
+      if attributes.key?(:'capabilities')
+        if (value = attributes[:'capabilities']).is_a?(Array)
+          self.capabilities = value
+        end
+      else
+        self.capabilities = nil
+      end
+
+      if attributes.key?(:'fallback_to_hosted_ui')
+        self.fallback_to_hosted_ui = attributes[:'fallback_to_hosted_ui']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @provider.nil?
+        invalid_properties.push('invalid value for "provider", provider cannot be nil.')
+      end
+
+      if @provider.to_s.length < 1
+        invalid_properties.push('invalid value for "provider", the character length must be great than or equal to 1.')
+      end
+
+      if @capabilities.nil?
+        invalid_properties.push('invalid value for "capabilities", capabilities cannot be nil.')
+      end
+
+      if @capabilities.length < 1
+        invalid_properties.push('invalid value for "capabilities", number of items must be greater than or equal to 1.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @provider.nil?
+      return false if @provider.to_s.length < 1
+      return false if @capabilities.nil?
+      return false if @capabilities.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] provider Value to be assigned
+    def provider=(provider)
+      if provider.nil?
+        fail ArgumentError, 'provider cannot be nil'
+      end
+
+      if provider.to_s.length < 1
+        fail ArgumentError, 'invalid value for "provider", the character length must be great than or equal to 1.'
+      end
+
+      @provider = provider
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] capabilities Value to be assigned
+    def capabilities=(capabilities)
+      if capabilities.nil?
+        fail ArgumentError, 'capabilities cannot be nil'
+      end
+
+      if capabilities.length < 1
+        fail ArgumentError, 'invalid value for "capabilities", number of items must be greater than or equal to 1.'
+      end
+
+      @capabilities = capabilities
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          provider == o.provider &&
+          provider_input == o.provider_input &&
+          redirect_url == o.redirect_url &&
+          capabilities == o.capabilities &&
+          fallback_to_hosted_ui == o.fallback_to_hosted_ui
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [provider, provider_input, redirect_url, capabilities, fallback_to_hosted_ui].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = TrinsicApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end