trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/smart_id_provider_output.rb

@@ -0,0 +1,355 @@
+=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.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # Exposed properties for the `smart-id` Provider which do not directly map to the normalized IdentityData model.
+  class SmartIdProviderOutput
+    # The given name (first name) of the individual, extracted from the Smart ID authentication certificate's Subject Distinguished Name \"G\" (givenName) attribute.
+    attr_accessor :given_name
+
+    # The family name (surname) of the individual, extracted from the Smart ID authentication certificate's Subject Distinguished Name \"SN\" (surname) attribute.
+    attr_accessor :family_name
+
+    # The individual's date of birth, derived from the personal code.              NOTE: Newer Latvian personal codes starting with \"32\" do not contain date of birth information.
+    attr_accessor :date_of_birth
+
+    # The individual's sex, derived from the first digit of the personal code.              NOTE: Not available for Latvian personal codes.              Possible values: - Male - Female
+    attr_accessor :sex
+
+    # The ISO 3166-1 alpha-2 country code extracted from the Smart ID authentication certificate's Subject Distinguished Name \"C\" (country) attribute.              This represents the country of the certificate issuer, not the person's nationality or citizenship. For Smart ID, this will be \"EE\" (Estonia), \"LT\" (Lithuania), or \"LV\" (Latvia).
+    attr_accessor :country
+
+    # The identity document type, extracted from the first 3 characters of the SERIALNUMBER field (before the country code).              Possible values: - PNO: Personal Number (national civic registration number) - PAS: Passport - IDC: National identity card
+    attr_accessor :identity_type
+
+    # The personal code (Estonian: isikukood, Lithuanian: asmens kodas, Latvian: personas kods) of the individual, extracted from the SERIALNUMBER field of the Smart ID authentication certificate. This is the portion after the identity type and country prefix (e.g., \"48501010014\" from \"PNOEE-48501010014\").              Estonian and Lithuanian personal codes are 11 digits in the format GYYMMDDSSSC where: - G = century/gender (3-4 = 1900s, 5-6 = 2000s; odd = male, even = female) - YYMMDD = date of birth - SSS = sequence number - C = checksum digit              Latvian personal codes use the format DDMMYY-NNNNN (6 digits, a dash, and 5 digits).              See: - https://en.wikipedia.org/wiki/National_identification_number#Estonia - https://en.wikipedia.org/wiki/National_identification_number#Lithuania - https://en.wikipedia.org/wiki/National_identification_number#Latvia
+    attr_accessor :personal_code
+
+    # The SERIALNUMBER attribute from the Smart ID authentication certificate's Subject Distinguished Name. Format: \"{identity-type}{country-code}-{identifier}\"              Components: - identity-type (3 chars): PNO (Personal Number), PAS (Passport), IDC (ID Card) - country-code (2 chars): ISO 3166-1 alpha-2 (EE, LT, LV) - identifier: The personal code
+    attr_accessor :serial_number
+
+    # The full Subject Distinguished Name (Subject DN) from the Smart ID authentication certificate. Contains comma-separated RDN (Relative Distinguished Name) components including C (Country), CN (Common Name), SN (Surname), G (Given Name), and SERIALNUMBER (Personal identifier).
+    attr_accessor :certificate_subject
+
+    # The certificate level indicating the authentication assurance level.              Possible values: - QUALIFIED: Highest assurance level (eIDAS QES - Qualified Electronic Signature),   legally equivalent to a handwritten signature. This is the standard production level. - ADVANCED: Lower assurance level (eIDAS AdES), also called \"Smart-ID Basic\".   Only available in test environments for test accounts.
+    attr_accessor :certificate_level
+
+    # A unique identifier for the Smart ID account/document used for this authentication. Format: PNO{CC}-{personal-code}-{device-id}-{qualification}              Components: - PNO = Personal Number (identity type) - CC = Country code (EE, LT, LV) - personal-code = The individual's personal code - device-id = Random 4-character device identifier - qualification = NQ (non-qualified) or Q (qualified certificate)              This is a stable identifier that can be used to recognize returning users across sessions.
+    attr_accessor :document_number
+
+    # Indicates which interaction flow was used during the Smart ID authentication process. This reflects which of the allowedInteractionsOrder options was actually used.              Possible values: - displayTextAndPIN: User saw text and entered PIN - verificationCodeChoice: User selected from multiple verification codes - confirmationMessage: User confirmed a message - confirmationMessageAndVerificationCodeChoice: Combination of both
+    attr_accessor :interaction_flow_used
+
+    # The IP address of the device where the Smart ID app was used for authentication. Can be IPv4 or IPv6 format.
+    attr_accessor :device_ip_address
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'sex' => :'sex',
+        :'country' => :'country',
+        :'identity_type' => :'identityType',
+        :'personal_code' => :'personalCode',
+        :'serial_number' => :'serialNumber',
+        :'certificate_subject' => :'certificateSubject',
+        :'certificate_level' => :'certificateLevel',
+        :'document_number' => :'documentNumber',
+        :'interaction_flow_used' => :'interactionFlowUsed',
+        :'device_ip_address' => :'deviceIpAddress'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'sex' => :'String',
+        :'country' => :'String',
+        :'identity_type' => :'String',
+        :'personal_code' => :'String',
+        :'serial_number' => :'String',
+        :'certificate_subject' => :'String',
+        :'certificate_level' => :'String',
+        :'document_number' => :'String',
+        :'interaction_flow_used' => :'String',
+        :'device_ip_address' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'given_name',
+        :'family_name',
+        :'date_of_birth',
+        :'sex',
+        :'country',
+        :'identity_type',
+        :'personal_code',
+        :'serial_number',
+        :'certificate_subject',
+        :'certificate_level',
+        :'document_number',
+        :'interaction_flow_used',
+        :'device_ip_address'
+      ])
+    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::SmartIdProviderOutput` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::SmartIdProviderOutput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'identity_type')
+        self.identity_type = attributes[:'identity_type']
+      end
+
+      if attributes.key?(:'personal_code')
+        self.personal_code = attributes[:'personal_code']
+      end
+
+      if attributes.key?(:'serial_number')
+        self.serial_number = attributes[:'serial_number']
+      end
+
+      if attributes.key?(:'certificate_subject')
+        self.certificate_subject = attributes[:'certificate_subject']
+      end
+
+      if attributes.key?(:'certificate_level')
+        self.certificate_level = attributes[:'certificate_level']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      end
+
+      if attributes.key?(:'interaction_flow_used')
+        self.interaction_flow_used = attributes[:'interaction_flow_used']
+      end
+
+      if attributes.key?(:'device_ip_address')
+        self.device_ip_address = attributes[:'device_ip_address']
+      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
+      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'
+      true
+    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 &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          date_of_birth == o.date_of_birth &&
+          sex == o.sex &&
+          country == o.country &&
+          identity_type == o.identity_type &&
+          personal_code == o.personal_code &&
+          serial_number == o.serial_number &&
+          certificate_subject == o.certificate_subject &&
+          certificate_level == o.certificate_level &&
+          document_number == o.document_number &&
+          interaction_flow_used == o.interaction_flow_used &&
+          device_ip_address == o.device_ip_address
+    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
+      [given_name, family_name, date_of_birth, sex, country, identity_type, personal_code, serial_number, certificate_subject, certificate_level, document_number, interaction_flow_used, device_ip_address].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/south_africa_nid_biometric2_input.rb

@@ -0,0 +1,246 @@
+=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.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class SouthAfricaNidBiometric2Input
+    # The user's South African National ID number
+    attr_accessor :id_number
+
+    # An array of exactly 8 images required for biometric liveness verification. The first 7 images should be liveness frames captured during the liveness detection process, and the last image (8th) should be a selfie of the user. All images must be in JPEG format and each image must be less than 15MB in size.
+    attr_accessor :liveness_images
+
+    # Test selfie for test environment (optional, maximum 15MB). Must be JPEG format.
+    attr_accessor :test_selfie
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id_number' => :'idNumber',
+        :'liveness_images' => :'livenessImages',
+        :'test_selfie' => :'testSelfie'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id_number' => :'String',
+        :'liveness_images' => :'Array<String>',
+        :'test_selfie' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id_number',
+        :'liveness_images',
+        :'test_selfie'
+      ])
+    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::SouthAfricaNidBiometric2Input` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::SouthAfricaNidBiometric2Input`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id_number')
+        self.id_number = attributes[:'id_number']
+      end
+
+      if attributes.key?(:'liveness_images')
+        if (value = attributes[:'liveness_images']).is_a?(Array)
+          self.liveness_images = value
+        end
+      end
+
+      if attributes.key?(:'test_selfie')
+        self.test_selfie = attributes[:'test_selfie']
+      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
+      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'
+      true
+    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 &&
+          id_number == o.id_number &&
+          liveness_images == o.liveness_images &&
+          test_selfie == o.test_selfie
+    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
+      [id_number, liveness_images, test_selfie].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