trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/peru_dni_provider_output.rb

@@ -0,0 +1,518 @@
+=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 `peru-dni-lookup` Provider which do not directly map to the normalized IdentityData model.
+  class PeruDniProviderOutput
+    # Information about the general area in which the DNI holder resides.              This field is not always available.
+    attr_accessor :address
+
+    # All names that appear on DNI, as an array of strings.              Format: - All uppercase - Ordered by paternal family name, then maternal family name, then given names.
+    attr_accessor :array_name
+
+    # Marital status as it appears on the DNI.              This field is not always available.              Valid values: - \"Single\" - \"Married\" - \"Divorced\" - \"Widowed\"
+    attr_accessor :civil_status
+
+    # Date of birth as it appears on the DNI.              This field is not always available.
+    attr_accessor :date_of_birth
+
+    # The user's National Identity Document number (Documento Nacional de Identidad or DNI).              Format: - 8 digits - Does NOT include verification digit. On the DNI card, a ninth digit appears next to the first eight. It is   0-9 or A-K. This is NOT included in the DNI number when returned from Peru's database. - Does NOT include dots or hyphens
+    attr_accessor :document_number
+
+    # Should always be \"DNI\".
+    attr_accessor :document_type
+
+    # Date that the DNI was issued.              This field is not always available.              Format: - yyyy-MM-dd
+    attr_accessor :expedition_date
+
+    # Date that the DNI will expire. DNI expires every 8 years, unless the citizen is >= 60 years old, in which case it never expires.              This field is not always available.              Format: - yyyy-MM-dd
+    attr_accessor :expiration_date
+
+    # Given names as they appear on DNI.              Format: - All uppercase - Space-separated - Will include all given names
+    attr_accessor :first_name
+
+    # All names as they appear on DNI.              Format: - All uppercase - Space-separated - Will include all names, given and family - Ordered by given names first, then paternal family name, then maternal family name
+    attr_accessor :full_name
+
+    # Family names as they appear on DNI.              Format: - All uppercase - Will include all family names - Ordered by paternal family name first, then maternal family name
+    attr_accessor :last_name
+
+    # Maternal last name as it appears on DNI.              Format: - All uppercase
+    attr_accessor :maternal_last_name
+
+    # Paternal last name as it appears on DNI.              Format: - All uppercase
+    attr_accessor :paternal_last_name
+
+    # Sex as it appears on DNI.              This field is not always available.              Values: - \"Male\" - \"Female\"
+    attr_accessor :sex
+
+    # In Peru, geographical locations have an official geographical code called UBIGEO, from the spanish \"UBIcación GEOgráfica\" (Geographic Location). This is an administrative geocode, is different from a postal code (which Peru also has) and is used to specifically delineate the administrative region, province and district hierarchy.              There are two coding systems for UBIGEO: one from INEI (National Institute of Statistics and Informatics) and another from RENIEC (National Registry of Identification and Civil Status). The two coding systems are similar but are not 100% the same (some numbers will map to different geographic locations). This field follows the coding system from RENIEC.              This field is not always available.              Format: - Always 6 digits - First two digits represent region - Middle two are province - Last two are district              Given the example 081304, that would correspond to: - 08 - Cusco Region - 0813 - Urubamba Province - 081304 - Machupicchu District
+    attr_accessor :ubigeo_reniec
+
+    # The final (ninth) digit of the DNI, which serves as a checksum over the first eight digits.              This field is not always available.              Format: - Single character - Either 0-9 or A-K              Read more here:   https://elcomercio.pe/mag/respuestas/cual-es-el-digito-verificador-de-mi-dni-documento-nacional-de-identidad-reniec-peru-nnda-nnlt-noticia/
+    attr_accessor :verification_digit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address' => :'address',
+        :'array_name' => :'arrayName',
+        :'civil_status' => :'civilStatus',
+        :'date_of_birth' => :'dateOfBirth',
+        :'document_number' => :'documentNumber',
+        :'document_type' => :'documentType',
+        :'expedition_date' => :'expeditionDate',
+        :'expiration_date' => :'expirationDate',
+        :'first_name' => :'firstName',
+        :'full_name' => :'fullName',
+        :'last_name' => :'lastName',
+        :'maternal_last_name' => :'maternalLastName',
+        :'paternal_last_name' => :'paternalLastName',
+        :'sex' => :'sex',
+        :'ubigeo_reniec' => :'ubigeoReniec',
+        :'verification_digit' => :'verificationDigit'
+      }
+    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
+      {
+        :'address' => :'PeruDniAddress',
+        :'array_name' => :'Array<String>',
+        :'civil_status' => :'String',
+        :'date_of_birth' => :'Date',
+        :'document_number' => :'String',
+        :'document_type' => :'String',
+        :'expedition_date' => :'Date',
+        :'expiration_date' => :'Date',
+        :'first_name' => :'String',
+        :'full_name' => :'String',
+        :'last_name' => :'String',
+        :'maternal_last_name' => :'String',
+        :'paternal_last_name' => :'String',
+        :'sex' => :'String',
+        :'ubigeo_reniec' => :'String',
+        :'verification_digit' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'address',
+        :'civil_status',
+        :'date_of_birth',
+        :'expedition_date',
+        :'expiration_date',
+        :'sex',
+        :'ubigeo_reniec',
+        :'verification_digit'
+      ])
+    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::PeruDniProviderOutput` 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::PeruDniProviderOutput`. 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?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'array_name')
+        if (value = attributes[:'array_name']).is_a?(Array)
+          self.array_name = value
+        end
+      else
+        self.array_name = nil
+      end
+
+      if attributes.key?(:'civil_status')
+        self.civil_status = attributes[:'civil_status']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      else
+        self.document_number = nil
+      end
+
+      if attributes.key?(:'document_type')
+        self.document_type = attributes[:'document_type']
+      else
+        self.document_type = nil
+      end
+
+      if attributes.key?(:'expedition_date')
+        self.expedition_date = attributes[:'expedition_date']
+      end
+
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      else
+        self.first_name = nil
+      end
+
+      if attributes.key?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      else
+        self.full_name = nil
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      else
+        self.last_name = nil
+      end
+
+      if attributes.key?(:'maternal_last_name')
+        self.maternal_last_name = attributes[:'maternal_last_name']
+      else
+        self.maternal_last_name = nil
+      end
+
+      if attributes.key?(:'paternal_last_name')
+        self.paternal_last_name = attributes[:'paternal_last_name']
+      else
+        self.paternal_last_name = nil
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'ubigeo_reniec')
+        self.ubigeo_reniec = attributes[:'ubigeo_reniec']
+      end
+
+      if attributes.key?(:'verification_digit')
+        self.verification_digit = attributes[:'verification_digit']
+      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 @array_name.nil?
+        invalid_properties.push('invalid value for "array_name", array_name cannot be nil.')
+      end
+
+      if @document_number.nil?
+        invalid_properties.push('invalid value for "document_number", document_number cannot be nil.')
+      end
+
+      if @document_type.nil?
+        invalid_properties.push('invalid value for "document_type", document_type cannot be nil.')
+      end
+
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @full_name.nil?
+        invalid_properties.push('invalid value for "full_name", full_name cannot be nil.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      end
+
+      if @maternal_last_name.nil?
+        invalid_properties.push('invalid value for "maternal_last_name", maternal_last_name cannot be nil.')
+      end
+
+      if @paternal_last_name.nil?
+        invalid_properties.push('invalid value for "paternal_last_name", paternal_last_name cannot be nil.')
+      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 @array_name.nil?
+      return false if @document_number.nil?
+      return false if @document_type.nil?
+      return false if @first_name.nil?
+      return false if @full_name.nil?
+      return false if @last_name.nil?
+      return false if @maternal_last_name.nil?
+      return false if @paternal_last_name.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] array_name Value to be assigned
+    def array_name=(array_name)
+      if array_name.nil?
+        fail ArgumentError, 'array_name cannot be nil'
+      end
+
+      @array_name = array_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] document_number Value to be assigned
+    def document_number=(document_number)
+      if document_number.nil?
+        fail ArgumentError, 'document_number cannot be nil'
+      end
+
+      @document_number = document_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] document_type Value to be assigned
+    def document_type=(document_type)
+      if document_type.nil?
+        fail ArgumentError, 'document_type cannot be nil'
+      end
+
+      @document_type = document_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      if first_name.nil?
+        fail ArgumentError, 'first_name cannot be nil'
+      end
+
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] full_name Value to be assigned
+    def full_name=(full_name)
+      if full_name.nil?
+        fail ArgumentError, 'full_name cannot be nil'
+      end
+
+      @full_name = full_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if last_name.nil?
+        fail ArgumentError, 'last_name cannot be nil'
+      end
+
+      @last_name = last_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] maternal_last_name Value to be assigned
+    def maternal_last_name=(maternal_last_name)
+      if maternal_last_name.nil?
+        fail ArgumentError, 'maternal_last_name cannot be nil'
+      end
+
+      @maternal_last_name = maternal_last_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] paternal_last_name Value to be assigned
+    def paternal_last_name=(paternal_last_name)
+      if paternal_last_name.nil?
+        fail ArgumentError, 'paternal_last_name cannot be nil'
+      end
+
+      @paternal_last_name = paternal_last_name
+    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 &&
+          address == o.address &&
+          array_name == o.array_name &&
+          civil_status == o.civil_status &&
+          date_of_birth == o.date_of_birth &&
+          document_number == o.document_number &&
+          document_type == o.document_type &&
+          expedition_date == o.expedition_date &&
+          expiration_date == o.expiration_date &&
+          first_name == o.first_name &&
+          full_name == o.full_name &&
+          last_name == o.last_name &&
+          maternal_last_name == o.maternal_last_name &&
+          paternal_last_name == o.paternal_last_name &&
+          sex == o.sex &&
+          ubigeo_reniec == o.ubigeo_reniec &&
+          verification_digit == o.verification_digit
+    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
+      [address, array_name, civil_status, date_of_birth, document_number, document_type, expedition_date, expiration_date, first_name, full_name, last_name, maternal_last_name, paternal_last_name, sex, ubigeo_reniec, verification_digit].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/philippines_digital_nid_provider_output.rb

@@ -14,8 +14,9 @@ require 'date'
 require 'time'
 
 module TrinsicApi
+  # Exposed properties for the `philippines-digital-national-id-qr` Provider which do not directly map to the normalized IdentityData model.
   class PhilippinesDigitalNidProviderOutput
-    # The PhilSys card number.
+    # The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN. The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between.
     attr_accessor :philsys_card_number
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/trinsic_api/models/philippines_physical_nid_provider_output.rb

@@ -14,8 +14,9 @@ require 'date'
 require 'time'
 
 module TrinsicApi
+  # Exposed properties for the `philippines-physical-national-id-qr` Provider which do not directly map to the normalized IdentityData model.
   class PhilippinesPhysicalNidProviderOutput
-    # The PhilSys card number.
+    # The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN. The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between.
     attr_accessor :philsys_card_number
 
     # Attribute mapping from ruby-style variable name to JSON key.