trinsic_api 3.1.0 → 3.2.1

data/lib/trinsic_api/models/moldova_identity_card_credential.rb

@@ -0,0 +1,381 @@
+=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.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # A Moldovan Identity Card credential, with document type `md.gov.wallet.pid.1`, retrieved from the Moldovan EVO wallet.              This credential is derived from the individual's Moldovan National Identity Card.
+  class MoldovaIdentityCardCredential < ApiModelBase
+    # The individual's IDNP (Numărul de Identificare Personal), the Moldovan state personal identification number.              This is a 13-digit number which uniquely identifies all natural persons in the Republic of Moldova. It has the format `2YYYOOOSSSSSX`, where: - `2` is the literal number `2` to indicate that the identifier belongs to a natural person - `YYY` is the last 3 digits of the year in which the identifier was issued - `OOO` is the code of the registrar office which issued the identifier - `SSSSS` is the sequential birth number for that year - `X` is a check digit              Note that the year encoded in the identifier is not necessarily the same as the year of birth of the individual.
+    attr_accessor :idnp
+
+    # The individual's given name(s), as recorded on their Moldovan identity card.
+    attr_accessor :given_name
+
+    # The individual's family name (surname), as recorded on their Moldovan identity card.
+    attr_accessor :family_name
+
+    # The individual's sex, as an ISO/IEC 5218 numeric code.              Possible values: - 0: Not known - 1: Male - 2: Female - 9: Not applicable
+    attr_accessor :sex
+
+    # The individual's nationality, as an ISO 3166-1 alpha-2 country code.              Moldovan nationals are `MD`.
+    attr_accessor :nationality
+
+    # The date of birth of the individual.
+    attr_accessor :date_of_birth
+
+    # Whether the individual is at least 18 years of age at the time of issuance of the digital credential.
+    attr_accessor :age_over18
+
+    # Whether the individual is at least 21 years of age at the time of issuance of the digital credential.
+    attr_accessor :age_over21
+
+    # The individual's full registered residential address as a single formatted string.
+    attr_accessor :resident_address
+
+    # The country of the individual's registered residence, as an ISO 3166-1 alpha-2 country code.
+    attr_accessor :resident_country
+
+    # The region of the individual's registered residence.
+    attr_accessor :resident_region
+
+    # The locality (municipality, city, town, or village) of the individual's registered residence.
+    attr_accessor :resident_city
+
+    # The street name of the individual's registered residence.
+    attr_accessor :resident_street
+
+    # The house or building number of the individual's registered residence.
+    attr_accessor :resident_house_number
+
+    # The building block (bloc) of the individual's registered residence, where applicable.
+    attr_accessor :resident_block
+
+    # The flat (apartment) number of the individual's registered residence, where applicable.
+    attr_accessor :resident_flat
+
+    # The date the physical identity card, used to create this digital credential, was issued.
+    attr_accessor :issue_date
+
+    # The date the physical identity card, used to create this digital credential, expires.
+    attr_accessor :expiry_date
+
+    # The name of the authority that issued the identity card.
+    attr_accessor :issuing_authority
+
+    # The document type              TODO: Get example values
+    attr_accessor :document_type
+
+    # The series of the underlying physical identity card.              This is the prefix to the full Moldovan identity card number, which is in the format `SNNN...`, where:              - `S` is a one-letter document series - `NNN...` is a document number (typically 8 digits)
+    attr_accessor :document_series
+
+    # The number of the underlying physical identity card, excluding the series.              This is the suffix to the full Moldovan identity card number, which is in the format `SNNN...`, where:              - `S` is a one-letter document series - `NNN...` is a document number (typically 8 digits)
+    attr_accessor :document_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'idnp' => :'idnp',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'sex' => :'sex',
+        :'nationality' => :'nationality',
+        :'date_of_birth' => :'dateOfBirth',
+        :'age_over18' => :'ageOver18',
+        :'age_over21' => :'ageOver21',
+        :'resident_address' => :'residentAddress',
+        :'resident_country' => :'residentCountry',
+        :'resident_region' => :'residentRegion',
+        :'resident_city' => :'residentCity',
+        :'resident_street' => :'residentStreet',
+        :'resident_house_number' => :'residentHouseNumber',
+        :'resident_block' => :'residentBlock',
+        :'resident_flat' => :'residentFlat',
+        :'issue_date' => :'issueDate',
+        :'expiry_date' => :'expiryDate',
+        :'issuing_authority' => :'issuingAuthority',
+        :'document_type' => :'documentType',
+        :'document_series' => :'documentSeries',
+        :'document_number' => :'documentNumber'
+      }
+    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
+      {
+        :'idnp' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'sex' => :'Integer',
+        :'nationality' => :'String',
+        :'date_of_birth' => :'Date',
+        :'age_over18' => :'Boolean',
+        :'age_over21' => :'Boolean',
+        :'resident_address' => :'String',
+        :'resident_country' => :'String',
+        :'resident_region' => :'String',
+        :'resident_city' => :'String',
+        :'resident_street' => :'String',
+        :'resident_house_number' => :'String',
+        :'resident_block' => :'String',
+        :'resident_flat' => :'String',
+        :'issue_date' => :'Date',
+        :'expiry_date' => :'Date',
+        :'issuing_authority' => :'String',
+        :'document_type' => :'String',
+        :'document_series' => :'String',
+        :'document_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'idnp',
+        :'given_name',
+        :'family_name',
+        :'sex',
+        :'nationality',
+        :'date_of_birth',
+        :'age_over18',
+        :'age_over21',
+        :'resident_address',
+        :'resident_country',
+        :'resident_region',
+        :'resident_city',
+        :'resident_street',
+        :'resident_house_number',
+        :'resident_block',
+        :'resident_flat',
+        :'issue_date',
+        :'expiry_date',
+        :'issuing_authority',
+        :'document_type',
+        :'document_series',
+        :'document_number'
+      ])
+    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::MoldovaIdentityCardCredential` 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::MoldovaIdentityCardCredential`. 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?(:'idnp')
+        self.idnp = attributes[:'idnp']
+      end
+
+      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?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'age_over18')
+        self.age_over18 = attributes[:'age_over18']
+      end
+
+      if attributes.key?(:'age_over21')
+        self.age_over21 = attributes[:'age_over21']
+      end
+
+      if attributes.key?(:'resident_address')
+        self.resident_address = attributes[:'resident_address']
+      end
+
+      if attributes.key?(:'resident_country')
+        self.resident_country = attributes[:'resident_country']
+      end
+
+      if attributes.key?(:'resident_region')
+        self.resident_region = attributes[:'resident_region']
+      end
+
+      if attributes.key?(:'resident_city')
+        self.resident_city = attributes[:'resident_city']
+      end
+
+      if attributes.key?(:'resident_street')
+        self.resident_street = attributes[:'resident_street']
+      end
+
+      if attributes.key?(:'resident_house_number')
+        self.resident_house_number = attributes[:'resident_house_number']
+      end
+
+      if attributes.key?(:'resident_block')
+        self.resident_block = attributes[:'resident_block']
+      end
+
+      if attributes.key?(:'resident_flat')
+        self.resident_flat = attributes[:'resident_flat']
+      end
+
+      if attributes.key?(:'issue_date')
+        self.issue_date = attributes[:'issue_date']
+      end
+
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
+      if attributes.key?(:'issuing_authority')
+        self.issuing_authority = attributes[:'issuing_authority']
+      end
+
+      if attributes.key?(:'document_type')
+        self.document_type = attributes[:'document_type']
+      end
+
+      if attributes.key?(:'document_series')
+        self.document_series = attributes[:'document_series']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      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 &&
+          idnp == o.idnp &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          sex == o.sex &&
+          nationality == o.nationality &&
+          date_of_birth == o.date_of_birth &&
+          age_over18 == o.age_over18 &&
+          age_over21 == o.age_over21 &&
+          resident_address == o.resident_address &&
+          resident_country == o.resident_country &&
+          resident_region == o.resident_region &&
+          resident_city == o.resident_city &&
+          resident_street == o.resident_street &&
+          resident_house_number == o.resident_house_number &&
+          resident_block == o.resident_block &&
+          resident_flat == o.resident_flat &&
+          issue_date == o.issue_date &&
+          expiry_date == o.expiry_date &&
+          issuing_authority == o.issuing_authority &&
+          document_type == o.document_type &&
+          document_series == o.document_series &&
+          document_number == o.document_number
+    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
+      [idnp, given_name, family_name, sex, nationality, date_of_birth, age_over18, age_over21, resident_address, resident_country, resident_region, resident_city, resident_street, resident_house_number, resident_block, resident_flat, issue_date, expiry_date, issuing_authority, document_type, document_series, document_number].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
+
+    # 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
+
+  end
+
+end