trinsic_api 3.1.0.pre.preview1 → 3.2.0

data/lib/trinsic_api/models/iso180135_aamva_namespace_output.rb

@@ -0,0 +1,438 @@
+=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
+  # Fields from the AAMVA mDL namespace.
+  class Iso180135AamvaNamespaceOutput < ApiModelBase
+    # Domestic categories of vehicles, restrictions, and conditions, parsed per AAMVA Section 7.2.4.
+    attr_accessor :domestic_driving_privileges
+
+    # Name suffix of the individual that has been issued the credential.
+    attr_accessor :name_suffix
+
+    # Whether the individual is an organ donor.
+    attr_accessor :organ_donor
+
+    # Whether the individual is a veteran.
+    attr_accessor :veteran
+
+    # Indicates whether the family name has been truncated.              Possible values: - 'T': Truncated - 'N': Not truncated - 'U': Unknown whether truncated
+    attr_accessor :family_name_truncation
+
+    # Indicates whether the given name has been truncated.              Possible values: - 'T': Truncated - 'N': Not truncated - 'U': Unknown whether truncated
+    attr_accessor :given_name_truncation
+
+    # Other family name by which the individual is known.
+    attr_accessor :aka_family_name_v2
+
+    # Other given name by which the individual is known.
+    attr_accessor :aka_given_name_v2
+
+    # Other suffix by which the individual is known.
+    attr_accessor :aka_suffix
+
+    # Approximate weight range of the individual, in kilograms.
+    attr_accessor :weight_range
+
+    # AAMVA D20 race or ethnicity code of the individual.
+    attr_accessor :race_ethnicity
+
+    # The sex of the individual as an AAMVA-defined sex code.              This is distinct from an ISO/IEC 5218 sex code in two ways: there is no \"Unknown\" value, and \"Not Applicable\" is replaced with \"Not Specified\".              Possible values: - 1: Male - 2: Female - 9: Not Specified
+    attr_accessor :sex
+
+    # First name of the individual.
+    attr_accessor :first_name
+
+    # Middle name or names of the individual.
+    attr_accessor :middle_names
+
+    # Whether the first name has been truncated.
+    attr_accessor :first_name_truncation
+
+    # Whether the middle name has been truncated.
+    attr_accessor :middle_names_truncation
+
+    # Deprecated AAMVA EDL (Enhanced Driver's License) credential indicator.              If present, indicates the type of the EDL credential.              Possible values: 1: Driver's License 2: Identification Card
+    attr_accessor :edl_credential
+
+    # Whether the credential is an Enhanced Driver's License (EDL).
+    attr_accessor :edl_credential_v2
+
+    # Whether the credential is REAL ID compliant. `true` for fully compliant (\"F\"), `false` for non-compliant (\"N\"), `null` when not present.
+    attr_accessor :dhs_compliance
+
+    # Deprecated county code for the county where the individual lives.
+    attr_accessor :resident_county
+
+    # County code for the county where the individual lives.
+    attr_accessor :resident_county_v2
+
+    # Date on which the hazardous material endorsement expires.
+    attr_accessor :hazmat_endorsement_expiration_date
+
+    # Whether the credential is a Commercial Driver's License (CDL) per FMCSA.
+    attr_accessor :cdl_indicator
+
+    # Deprecated. Whether the CDL holder is non-domiciled in the issuing jurisdiction.
+    attr_accessor :cdl_non_domiciled
+
+    # Whether the CDL holder is non-domiciled in the issuing jurisdiction.
+    attr_accessor :cdl_non_domiciled_v2
+
+    # Text agreed on between the issuing authority and DHS for non-compliant credentials.
+    attr_accessor :dhs_compliance_text
+
+    # Whether the individual has DHS temporary lawful status.
+    attr_accessor :dhs_temporary_lawful_status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'domestic_driving_privileges' => :'domesticDrivingPrivileges',
+        :'name_suffix' => :'nameSuffix',
+        :'organ_donor' => :'organDonor',
+        :'veteran' => :'veteran',
+        :'family_name_truncation' => :'familyNameTruncation',
+        :'given_name_truncation' => :'givenNameTruncation',
+        :'aka_family_name_v2' => :'akaFamilyNameV2',
+        :'aka_given_name_v2' => :'akaGivenNameV2',
+        :'aka_suffix' => :'akaSuffix',
+        :'weight_range' => :'weightRange',
+        :'race_ethnicity' => :'raceEthnicity',
+        :'sex' => :'sex',
+        :'first_name' => :'firstName',
+        :'middle_names' => :'middleNames',
+        :'first_name_truncation' => :'firstNameTruncation',
+        :'middle_names_truncation' => :'middleNamesTruncation',
+        :'edl_credential' => :'edlCredential',
+        :'edl_credential_v2' => :'edlCredentialV2',
+        :'dhs_compliance' => :'dhsCompliance',
+        :'resident_county' => :'residentCounty',
+        :'resident_county_v2' => :'residentCountyV2',
+        :'hazmat_endorsement_expiration_date' => :'hazmatEndorsementExpirationDate',
+        :'cdl_indicator' => :'cdlIndicator',
+        :'cdl_non_domiciled' => :'cdlNonDomiciled',
+        :'cdl_non_domiciled_v2' => :'cdlNonDomiciledV2',
+        :'dhs_compliance_text' => :'dhsComplianceText',
+        :'dhs_temporary_lawful_status' => :'dhsTemporaryLawfulStatus'
+      }
+    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
+      {
+        :'domestic_driving_privileges' => :'Array<Iso180135AamvaDomesticDrivingPrivilege>',
+        :'name_suffix' => :'String',
+        :'organ_donor' => :'Boolean',
+        :'veteran' => :'Boolean',
+        :'family_name_truncation' => :'String',
+        :'given_name_truncation' => :'String',
+        :'aka_family_name_v2' => :'String',
+        :'aka_given_name_v2' => :'String',
+        :'aka_suffix' => :'String',
+        :'weight_range' => :'Iso180135AamvaWeightRange',
+        :'race_ethnicity' => :'String',
+        :'sex' => :'Integer',
+        :'first_name' => :'String',
+        :'middle_names' => :'String',
+        :'first_name_truncation' => :'String',
+        :'middle_names_truncation' => :'String',
+        :'edl_credential' => :'Integer',
+        :'edl_credential_v2' => :'Boolean',
+        :'dhs_compliance' => :'Boolean',
+        :'resident_county' => :'String',
+        :'resident_county_v2' => :'String',
+        :'hazmat_endorsement_expiration_date' => :'Date',
+        :'cdl_indicator' => :'Boolean',
+        :'cdl_non_domiciled' => :'Boolean',
+        :'cdl_non_domiciled_v2' => :'Boolean',
+        :'dhs_compliance_text' => :'String',
+        :'dhs_temporary_lawful_status' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'domestic_driving_privileges',
+        :'name_suffix',
+        :'organ_donor',
+        :'veteran',
+        :'family_name_truncation',
+        :'given_name_truncation',
+        :'aka_family_name_v2',
+        :'aka_given_name_v2',
+        :'aka_suffix',
+        :'weight_range',
+        :'race_ethnicity',
+        :'sex',
+        :'first_name',
+        :'middle_names',
+        :'first_name_truncation',
+        :'middle_names_truncation',
+        :'edl_credential',
+        :'edl_credential_v2',
+        :'dhs_compliance',
+        :'resident_county',
+        :'resident_county_v2',
+        :'hazmat_endorsement_expiration_date',
+        :'cdl_indicator',
+        :'cdl_non_domiciled',
+        :'cdl_non_domiciled_v2',
+        :'dhs_compliance_text',
+        :'dhs_temporary_lawful_status'
+      ])
+    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::Iso180135AamvaNamespaceOutput` 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::Iso180135AamvaNamespaceOutput`. 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?(:'domestic_driving_privileges')
+        if (value = attributes[:'domestic_driving_privileges']).is_a?(Array)
+          self.domestic_driving_privileges = value
+        end
+      end
+
+      if attributes.key?(:'name_suffix')
+        self.name_suffix = attributes[:'name_suffix']
+      end
+
+      if attributes.key?(:'organ_donor')
+        self.organ_donor = attributes[:'organ_donor']
+      end
+
+      if attributes.key?(:'veteran')
+        self.veteran = attributes[:'veteran']
+      end
+
+      if attributes.key?(:'family_name_truncation')
+        self.family_name_truncation = attributes[:'family_name_truncation']
+      end
+
+      if attributes.key?(:'given_name_truncation')
+        self.given_name_truncation = attributes[:'given_name_truncation']
+      end
+
+      if attributes.key?(:'aka_family_name_v2')
+        self.aka_family_name_v2 = attributes[:'aka_family_name_v2']
+      end
+
+      if attributes.key?(:'aka_given_name_v2')
+        self.aka_given_name_v2 = attributes[:'aka_given_name_v2']
+      end
+
+      if attributes.key?(:'aka_suffix')
+        self.aka_suffix = attributes[:'aka_suffix']
+      end
+
+      if attributes.key?(:'weight_range')
+        self.weight_range = attributes[:'weight_range']
+      end
+
+      if attributes.key?(:'race_ethnicity')
+        self.race_ethnicity = attributes[:'race_ethnicity']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'middle_names')
+        self.middle_names = attributes[:'middle_names']
+      end
+
+      if attributes.key?(:'first_name_truncation')
+        self.first_name_truncation = attributes[:'first_name_truncation']
+      end
+
+      if attributes.key?(:'middle_names_truncation')
+        self.middle_names_truncation = attributes[:'middle_names_truncation']
+      end
+
+      if attributes.key?(:'edl_credential')
+        self.edl_credential = attributes[:'edl_credential']
+      end
+
+      if attributes.key?(:'edl_credential_v2')
+        self.edl_credential_v2 = attributes[:'edl_credential_v2']
+      end
+
+      if attributes.key?(:'dhs_compliance')
+        self.dhs_compliance = attributes[:'dhs_compliance']
+      end
+
+      if attributes.key?(:'resident_county')
+        self.resident_county = attributes[:'resident_county']
+      end
+
+      if attributes.key?(:'resident_county_v2')
+        self.resident_county_v2 = attributes[:'resident_county_v2']
+      end
+
+      if attributes.key?(:'hazmat_endorsement_expiration_date')
+        self.hazmat_endorsement_expiration_date = attributes[:'hazmat_endorsement_expiration_date']
+      end
+
+      if attributes.key?(:'cdl_indicator')
+        self.cdl_indicator = attributes[:'cdl_indicator']
+      end
+
+      if attributes.key?(:'cdl_non_domiciled')
+        self.cdl_non_domiciled = attributes[:'cdl_non_domiciled']
+      end
+
+      if attributes.key?(:'cdl_non_domiciled_v2')
+        self.cdl_non_domiciled_v2 = attributes[:'cdl_non_domiciled_v2']
+      end
+
+      if attributes.key?(:'dhs_compliance_text')
+        self.dhs_compliance_text = attributes[:'dhs_compliance_text']
+      end
+
+      if attributes.key?(:'dhs_temporary_lawful_status')
+        self.dhs_temporary_lawful_status = attributes[:'dhs_temporary_lawful_status']
+      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 &&
+          domestic_driving_privileges == o.domestic_driving_privileges &&
+          name_suffix == o.name_suffix &&
+          organ_donor == o.organ_donor &&
+          veteran == o.veteran &&
+          family_name_truncation == o.family_name_truncation &&
+          given_name_truncation == o.given_name_truncation &&
+          aka_family_name_v2 == o.aka_family_name_v2 &&
+          aka_given_name_v2 == o.aka_given_name_v2 &&
+          aka_suffix == o.aka_suffix &&
+          weight_range == o.weight_range &&
+          race_ethnicity == o.race_ethnicity &&
+          sex == o.sex &&
+          first_name == o.first_name &&
+          middle_names == o.middle_names &&
+          first_name_truncation == o.first_name_truncation &&
+          middle_names_truncation == o.middle_names_truncation &&
+          edl_credential == o.edl_credential &&
+          edl_credential_v2 == o.edl_credential_v2 &&
+          dhs_compliance == o.dhs_compliance &&
+          resident_county == o.resident_county &&
+          resident_county_v2 == o.resident_county_v2 &&
+          hazmat_endorsement_expiration_date == o.hazmat_endorsement_expiration_date &&
+          cdl_indicator == o.cdl_indicator &&
+          cdl_non_domiciled == o.cdl_non_domiciled &&
+          cdl_non_domiciled_v2 == o.cdl_non_domiciled_v2 &&
+          dhs_compliance_text == o.dhs_compliance_text &&
+          dhs_temporary_lawful_status == o.dhs_temporary_lawful_status
+    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
+      [domestic_driving_privileges, name_suffix, organ_donor, veteran, family_name_truncation, given_name_truncation, aka_family_name_v2, aka_given_name_v2, aka_suffix, weight_range, race_ethnicity, sex, first_name, middle_names, first_name_truncation, middle_names_truncation, edl_credential, edl_credential_v2, dhs_compliance, resident_county, resident_county_v2, hazmat_endorsement_expiration_date, cdl_indicator, cdl_non_domiciled, cdl_non_domiciled_v2, dhs_compliance_text, dhs_temporary_lawful_status].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/{nigeria_nin_biometric2_input.rb → iso180135_aamva_weight_range.rb}

@@ -14,22 +14,19 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class NigeriaNinBiometric2Input < ApiModelBase
-    # The user's Nigerian National ID number (NIN)
-    attr_accessor :id_number
+  # AAMVA approximate weight range, expressed in kilograms.
+  class Iso180135AamvaWeightRange < ApiModelBase
+    # Minimum weight in the range, in kilograms.
+    attr_accessor :min_kilograms
 
-    # 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
+    # Maximum weight in the range, in kilograms.              If null, the maximum weight has no limit.
+    attr_accessor :max_kilograms
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id_number' => :'idNumber',
-        :'liveness_images' => :'livenessImages',
-        :'test_selfie' => :'testSelfie'
+        :'min_kilograms' => :'minKilograms',
+        :'max_kilograms' => :'maxKilograms'
       }
     end
 
@@ -46,18 +43,15 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id_number' => :'String',
-        :'liveness_images' => :'Array<String>',
-        :'test_selfie' => :'String'
+        :'min_kilograms' => :'Integer',
+        :'max_kilograms' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'id_number',
-        :'liveness_images',
-        :'test_selfie'
+        :'max_kilograms'
       ])
     end
 
@@ -65,30 +59,26 @@ module TrinsicApi
     # @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::NigeriaNinBiometric2Input` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::Iso180135AamvaWeightRange` 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::NigeriaNinBiometric2Input`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::Iso180135AamvaWeightRange`. 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']
+      if attributes.key?(:'min_kilograms')
+        self.min_kilograms = attributes[:'min_kilograms']
+      else
+        self.min_kilograms = nil
       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']
+      if attributes.key?(:'max_kilograms')
+        self.max_kilograms = attributes[:'max_kilograms']
       end
     end
 
@@ -97,6 +87,10 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @min_kilograms.nil?
+        invalid_properties.push('invalid value for "min_kilograms", min_kilograms cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -104,17 +98,27 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @min_kilograms.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] min_kilograms Value to be assigned
+    def min_kilograms=(min_kilograms)
+      if min_kilograms.nil?
+        fail ArgumentError, 'min_kilograms cannot be nil'
+      end
+
+      @min_kilograms = min_kilograms
+    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
+          min_kilograms == o.min_kilograms &&
+          max_kilograms == o.max_kilograms
     end
 
     # @see the `==` method
@@ -126,7 +130,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id_number, liveness_images, test_selfie].hash
+      [min_kilograms, max_kilograms].hash
     end
 
     # Builds the object from hash