trinsic_api 3.1.0.pre.preview1 → 3.1.0

data/lib/trinsic_api/models/iso180132_biometric_template.rb

@@ -0,0 +1,231 @@
+=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 single biometric template per ISO 18013-2 Table C.12.
+  class Iso180132BiometricTemplate < ApiModelBase
+    # Header describing the biometric template.
+    attr_accessor :header
+
+    # The raw data block, in a biometric type- and format-specific encoding.              For `face` and `signature_usual_mark`, this is a raw JPEG or JPEG2000 image.              See ISO 18013-2 and 18013-5.
+    attr_accessor :data_block
+
+    # Whether the data block is encrypted.
+    attr_accessor :data_is_encrypted
+
+    # Optional Biometric Information Record payload, containing arbitrary domestic data.
+    attr_accessor :biometric_information_record_payload
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'header' => :'header',
+        :'data_block' => :'dataBlock',
+        :'data_is_encrypted' => :'dataIsEncrypted',
+        :'biometric_information_record_payload' => :'biometricInformationRecordPayload'
+      }
+    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
+      {
+        :'header' => :'Iso180132BiometricTemplateHeader',
+        :'data_block' => :'String',
+        :'data_is_encrypted' => :'Boolean',
+        :'biometric_information_record_payload' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'biometric_information_record_payload'
+      ])
+    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::Iso180132BiometricTemplate` 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::Iso180132BiometricTemplate`. 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?(:'header')
+        self.header = attributes[:'header']
+      else
+        self.header = nil
+      end
+
+      if attributes.key?(:'data_block')
+        self.data_block = attributes[:'data_block']
+      else
+        self.data_block = nil
+      end
+
+      if attributes.key?(:'data_is_encrypted')
+        self.data_is_encrypted = attributes[:'data_is_encrypted']
+      else
+        self.data_is_encrypted = nil
+      end
+
+      if attributes.key?(:'biometric_information_record_payload')
+        self.biometric_information_record_payload = attributes[:'biometric_information_record_payload']
+      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 @header.nil?
+        invalid_properties.push('invalid value for "header", header cannot be nil.')
+      end
+
+      if @data_block.nil?
+        invalid_properties.push('invalid value for "data_block", data_block cannot be nil.')
+      end
+
+      if @data_is_encrypted.nil?
+        invalid_properties.push('invalid value for "data_is_encrypted", data_is_encrypted 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 @header.nil?
+      return false if @data_block.nil?
+      return false if @data_is_encrypted.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] header Value to be assigned
+    def header=(header)
+      if header.nil?
+        fail ArgumentError, 'header cannot be nil'
+      end
+
+      @header = header
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data_block Value to be assigned
+    def data_block=(data_block)
+      if data_block.nil?
+        fail ArgumentError, 'data_block cannot be nil'
+      end
+
+      @data_block = data_block
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data_is_encrypted Value to be assigned
+    def data_is_encrypted=(data_is_encrypted)
+      if data_is_encrypted.nil?
+        fail ArgumentError, 'data_is_encrypted cannot be nil'
+      end
+
+      @data_is_encrypted = data_is_encrypted
+    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 &&
+          header == o.header &&
+          data_block == o.data_block &&
+          data_is_encrypted == o.data_is_encrypted &&
+          biometric_information_record_payload == o.biometric_information_record_payload
+    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
+      [header, data_block, data_is_encrypted, biometric_information_record_payload].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

data/lib/trinsic_api/models/iso180132_biometric_template_header.rb

@@ -0,0 +1,297 @@
+=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
+  # Header fields of a biometric template per ISO 18013-2 Table C.12.
+  class Iso180132BiometricTemplateHeader < ApiModelBase
+    # Patron header version (defaults to 0x0101).
+    attr_accessor :patron_header_version
+
+    # Biometric type code per ISO 18013-2.
+    attr_accessor :biometric_type
+
+    # Biometric sub-type code per ISO 18013-2.
+    attr_accessor :biometric_sub_type
+
+    # Date and time the biometric template was created.
+    attr_accessor :creation_date
+
+    # Name of the Biometric Information Record (BIR) creator.
+    attr_accessor :biometric_information_record_creator
+
+    # Validity period of the biometric data block.
+    attr_accessor :validity_period
+
+    # Owner and type identifying the product that produced the biometric data block.
+    attr_accessor :biometric_data_block_product
+
+    # Format owner of the biometric data block.
+    attr_accessor :biometric_data_block_format_owner
+
+    # Format type of the biometric data block.
+    attr_accessor :biometric_data_block_format_type
+
+    # Index identifier of the Biometric Information Record, when present.
+    attr_accessor :biometric_information_record_index
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'patron_header_version' => :'patronHeaderVersion',
+        :'biometric_type' => :'biometricType',
+        :'biometric_sub_type' => :'biometricSubType',
+        :'creation_date' => :'creationDate',
+        :'biometric_information_record_creator' => :'biometricInformationRecordCreator',
+        :'validity_period' => :'validityPeriod',
+        :'biometric_data_block_product' => :'biometricDataBlockProduct',
+        :'biometric_data_block_format_owner' => :'biometricDataBlockFormatOwner',
+        :'biometric_data_block_format_type' => :'biometricDataBlockFormatType',
+        :'biometric_information_record_index' => :'biometricInformationRecordIndex'
+      }
+    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
+      {
+        :'patron_header_version' => :'Integer',
+        :'biometric_type' => :'Integer',
+        :'biometric_sub_type' => :'Integer',
+        :'creation_date' => :'Time',
+        :'biometric_information_record_creator' => :'String',
+        :'validity_period' => :'Iso180132BiometricValidityPeriod',
+        :'biometric_data_block_product' => :'Iso180132BiometricDataBlockProduct',
+        :'biometric_data_block_format_owner' => :'Integer',
+        :'biometric_data_block_format_type' => :'Integer',
+        :'biometric_information_record_index' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'biometric_type',
+        :'biometric_sub_type',
+        :'creation_date',
+        :'biometric_information_record_creator',
+        :'validity_period',
+        :'biometric_data_block_product',
+        :'biometric_information_record_index'
+      ])
+    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::Iso180132BiometricTemplateHeader` 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::Iso180132BiometricTemplateHeader`. 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?(:'patron_header_version')
+        self.patron_header_version = attributes[:'patron_header_version']
+      else
+        self.patron_header_version = nil
+      end
+
+      if attributes.key?(:'biometric_type')
+        self.biometric_type = attributes[:'biometric_type']
+      end
+
+      if attributes.key?(:'biometric_sub_type')
+        self.biometric_sub_type = attributes[:'biometric_sub_type']
+      end
+
+      if attributes.key?(:'creation_date')
+        self.creation_date = attributes[:'creation_date']
+      end
+
+      if attributes.key?(:'biometric_information_record_creator')
+        self.biometric_information_record_creator = attributes[:'biometric_information_record_creator']
+      end
+
+      if attributes.key?(:'validity_period')
+        self.validity_period = attributes[:'validity_period']
+      end
+
+      if attributes.key?(:'biometric_data_block_product')
+        self.biometric_data_block_product = attributes[:'biometric_data_block_product']
+      end
+
+      if attributes.key?(:'biometric_data_block_format_owner')
+        self.biometric_data_block_format_owner = attributes[:'biometric_data_block_format_owner']
+      else
+        self.biometric_data_block_format_owner = nil
+      end
+
+      if attributes.key?(:'biometric_data_block_format_type')
+        self.biometric_data_block_format_type = attributes[:'biometric_data_block_format_type']
+      else
+        self.biometric_data_block_format_type = nil
+      end
+
+      if attributes.key?(:'biometric_information_record_index')
+        self.biometric_information_record_index = attributes[:'biometric_information_record_index']
+      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 @patron_header_version.nil?
+        invalid_properties.push('invalid value for "patron_header_version", patron_header_version cannot be nil.')
+      end
+
+      if @biometric_data_block_format_owner.nil?
+        invalid_properties.push('invalid value for "biometric_data_block_format_owner", biometric_data_block_format_owner cannot be nil.')
+      end
+
+      if @biometric_data_block_format_type.nil?
+        invalid_properties.push('invalid value for "biometric_data_block_format_type", biometric_data_block_format_type 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 @patron_header_version.nil?
+      return false if @biometric_data_block_format_owner.nil?
+      return false if @biometric_data_block_format_type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] patron_header_version Value to be assigned
+    def patron_header_version=(patron_header_version)
+      if patron_header_version.nil?
+        fail ArgumentError, 'patron_header_version cannot be nil'
+      end
+
+      @patron_header_version = patron_header_version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] biometric_data_block_format_owner Value to be assigned
+    def biometric_data_block_format_owner=(biometric_data_block_format_owner)
+      if biometric_data_block_format_owner.nil?
+        fail ArgumentError, 'biometric_data_block_format_owner cannot be nil'
+      end
+
+      @biometric_data_block_format_owner = biometric_data_block_format_owner
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] biometric_data_block_format_type Value to be assigned
+    def biometric_data_block_format_type=(biometric_data_block_format_type)
+      if biometric_data_block_format_type.nil?
+        fail ArgumentError, 'biometric_data_block_format_type cannot be nil'
+      end
+
+      @biometric_data_block_format_type = biometric_data_block_format_type
+    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 &&
+          patron_header_version == o.patron_header_version &&
+          biometric_type == o.biometric_type &&
+          biometric_sub_type == o.biometric_sub_type &&
+          creation_date == o.creation_date &&
+          biometric_information_record_creator == o.biometric_information_record_creator &&
+          validity_period == o.validity_period &&
+          biometric_data_block_product == o.biometric_data_block_product &&
+          biometric_data_block_format_owner == o.biometric_data_block_format_owner &&
+          biometric_data_block_format_type == o.biometric_data_block_format_type &&
+          biometric_information_record_index == o.biometric_information_record_index
+    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
+      [patron_header_version, biometric_type, biometric_sub_type, creation_date, biometric_information_record_creator, validity_period, biometric_data_block_product, biometric_data_block_format_owner, biometric_data_block_format_type, biometric_information_record_index].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