trinsic_api 3.1.0 → 3.2.1

data/lib/trinsic_api/models/brazil_cnh_provider_output.rb

@@ -0,0 +1,315 @@
+=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
+  # Exposed properties for the `brazil-digital-cnh` Provider which do not directly map to the normalized IdentityData model.
+  class BrazilCnhProviderOutput < ApiModelBase
+    # Full name decoded from the CNH QR Code and whether it matched the government database.
+    attr_accessor :full_name
+
+    # Similarity score for the decoded full name from the CNH QR Code.              Ranges from 0.0 to 1.0, where 1.0 is an exact match.
+    attr_accessor :full_name_similarity
+
+    # Source identity document number/reference for the CNH record, decoded from the CNH QR Code.
+    attr_accessor :origin_document
+
+    # Date of birth decoded from the CNH QR Code and whether it matched the government database.
+    attr_accessor :date_of_birth
+
+    # Mother's full name decoded from the CNH QR Code.
+    attr_accessor :mother_full_name
+
+    # Father's full name decoded from the CNH QR Code.
+    attr_accessor :father_full_name
+
+    # Driver license category decoded from the CNH QR Code.              Known values: - A: Two- or three-wheeled motor vehicles, with or without a sidecar. - B: Motor vehicles outside category A up to 3,500 kg, with capacity for up to eight passengers besides the driver, and without articulation or trailer. - C: Category B vehicles and rigid cargo vehicles above 3,500 kg. - D: Category C vehicles and passenger vehicles with capacity above eight passengers besides the driver. - E: Category D vehicles, trailers, semi-trailers, and articulated buses.
+    attr_accessor :category
+
+    # National Registry (Registro Nacional de Habilitacao) number decoded from the CNH QR Code and whether it matched the government database.              Is an 11-character ID with the format XXXXXXXXX@@: - XXXXXXXXX: Base characters. The value is unique to the driver for their lifetime. - @@: Security check digits
+    attr_accessor :registration_number
+
+    # Whether the National Registry number satisfies the CNH modulo-11 check digit routine.
+    attr_accessor :registration_number_check_digits_valid
+
+    # Date when the driver was first licensed, decoded from the CNH QR Code.
+    attr_accessor :first_issue_date
+
+    # CNH observations decoded from the QR Code.              May include EAR for paid driving activity and one or more restriction codes: - A: Corrective lenses required. - B: Hearing prosthesis required. - C: Left-side accelerator required. - D: Automatic transmission vehicle required. - E: Steering-wheel grip, handle, or knob required. - F: Power steering vehicle required. - G: Manual clutch, automated clutch, or automatic transmission vehicle required. - H: Hand accelerator and brake required. - I: Dashboard control adaptations to the steering wheel required. - J: Dashboard control adaptations for lower limbs or other body parts required. - K: Gear-shift lever extension and/or fixed height/depth compensation cushions required. - L: Pedal extensions and floor elevation and/or fixed height/depth compensation cushions required. - M: Motorcycle with adapted gear-shift pedal required. - N: Motorcycle with adapted rear-brake pedal required. - O: Motorcycle with adapted front-brake handle required. - P: Motorcycle with adapted clutch handle required. - Q: Motorcycle with sidecar or tricycle required. - R: Scooter with sidecar or tricycle required. - S: Motorcycle with automated gear shifting required. - T: Driving on highways and high-speed roads prohibited. - U: Driving after sunset prohibited. - V: Helmet with visor and unrestricted field of vision required. - X: Other restrictions.
+    attr_accessor :observations
+
+    # City where the CNH was issued, decoded from the QR Code.
+    attr_accessor :issue_city
+
+    # Brazilian state where the CNH was issued, decoded from the QR Code.              Format is a two-letter Brazilian state abbreviation when present.
+    attr_accessor :issue_state
+
+    # Numeric security validation code decoded from the CNH QR Code.              This is an 11-digit code generated from Departamento Estadual de Trânsito (State Traffic Department or DETRAN) owned data for each CNH and used to validate the document. The algorithm is proprietary, so no further information is available on this number.
+    attr_accessor :validation_number
+
+    # Registro Nacional de Condutores Habilitados (RENACH) form number decoded from the CNH QR Code.              Is an 11-character ID with the format FFXXXXXXXX@: - FF: The issuing federation unit abbreviation. It identifies the state where the driver was licensed or last had record changes. - XXXXXXXXX: Serial number - @: Modulo-11 security check digit
+    attr_accessor :renach_number
+
+    # Facial biometric comparison result if submitted and available.
+    attr_accessor :facial_biometry
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'full_name' => :'fullName',
+        :'full_name_similarity' => :'fullNameSimilarity',
+        :'origin_document' => :'originDocument',
+        :'date_of_birth' => :'dateOfBirth',
+        :'mother_full_name' => :'motherFullName',
+        :'father_full_name' => :'fatherFullName',
+        :'category' => :'category',
+        :'registration_number' => :'registrationNumber',
+        :'registration_number_check_digits_valid' => :'registrationNumberCheckDigitsValid',
+        :'first_issue_date' => :'firstIssueDate',
+        :'observations' => :'observations',
+        :'issue_city' => :'issueCity',
+        :'issue_state' => :'issueState',
+        :'validation_number' => :'validationNumber',
+        :'renach_number' => :'renachNumber',
+        :'facial_biometry' => :'facialBiometry'
+      }
+    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
+      {
+        :'full_name' => :'BrazilCnhMatchFieldString',
+        :'full_name_similarity' => :'Float',
+        :'origin_document' => :'String',
+        :'date_of_birth' => :'BrazilCnhMatchFieldDateOnly',
+        :'mother_full_name' => :'String',
+        :'father_full_name' => :'String',
+        :'category' => :'String',
+        :'registration_number' => :'BrazilCnhMatchFieldString',
+        :'registration_number_check_digits_valid' => :'Boolean',
+        :'first_issue_date' => :'Date',
+        :'observations' => :'String',
+        :'issue_city' => :'String',
+        :'issue_state' => :'String',
+        :'validation_number' => :'String',
+        :'renach_number' => :'String',
+        :'facial_biometry' => :'BrazilCnhFacialBiometryOutput'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'full_name',
+        :'full_name_similarity',
+        :'origin_document',
+        :'date_of_birth',
+        :'mother_full_name',
+        :'father_full_name',
+        :'category',
+        :'registration_number',
+        :'registration_number_check_digits_valid',
+        :'first_issue_date',
+        :'observations',
+        :'issue_city',
+        :'issue_state',
+        :'validation_number',
+        :'renach_number',
+        :'facial_biometry'
+      ])
+    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::BrazilCnhProviderOutput` 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::BrazilCnhProviderOutput`. 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?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      end
+
+      if attributes.key?(:'full_name_similarity')
+        self.full_name_similarity = attributes[:'full_name_similarity']
+      end
+
+      if attributes.key?(:'origin_document')
+        self.origin_document = attributes[:'origin_document']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'mother_full_name')
+        self.mother_full_name = attributes[:'mother_full_name']
+      end
+
+      if attributes.key?(:'father_full_name')
+        self.father_full_name = attributes[:'father_full_name']
+      end
+
+      if attributes.key?(:'category')
+        self.category = attributes[:'category']
+      end
+
+      if attributes.key?(:'registration_number')
+        self.registration_number = attributes[:'registration_number']
+      end
+
+      if attributes.key?(:'registration_number_check_digits_valid')
+        self.registration_number_check_digits_valid = attributes[:'registration_number_check_digits_valid']
+      end
+
+      if attributes.key?(:'first_issue_date')
+        self.first_issue_date = attributes[:'first_issue_date']
+      end
+
+      if attributes.key?(:'observations')
+        self.observations = attributes[:'observations']
+      end
+
+      if attributes.key?(:'issue_city')
+        self.issue_city = attributes[:'issue_city']
+      end
+
+      if attributes.key?(:'issue_state')
+        self.issue_state = attributes[:'issue_state']
+      end
+
+      if attributes.key?(:'validation_number')
+        self.validation_number = attributes[:'validation_number']
+      end
+
+      if attributes.key?(:'renach_number')
+        self.renach_number = attributes[:'renach_number']
+      end
+
+      if attributes.key?(:'facial_biometry')
+        self.facial_biometry = attributes[:'facial_biometry']
+      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 &&
+          full_name == o.full_name &&
+          full_name_similarity == o.full_name_similarity &&
+          origin_document == o.origin_document &&
+          date_of_birth == o.date_of_birth &&
+          mother_full_name == o.mother_full_name &&
+          father_full_name == o.father_full_name &&
+          category == o.category &&
+          registration_number == o.registration_number &&
+          registration_number_check_digits_valid == o.registration_number_check_digits_valid &&
+          first_issue_date == o.first_issue_date &&
+          observations == o.observations &&
+          issue_city == o.issue_city &&
+          issue_state == o.issue_state &&
+          validation_number == o.validation_number &&
+          renach_number == o.renach_number &&
+          facial_biometry == o.facial_biometry
+    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
+      [full_name, full_name_similarity, origin_document, date_of_birth, mother_full_name, father_full_name, category, registration_number, registration_number_check_digits_valid, first_issue_date, observations, issue_city, issue_state, validation_number, renach_number, facial_biometry].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/brazil_cpf_check_input.rb

@@ -18,6 +18,9 @@ module TrinsicApi
     # The user's 11-digit, numeric CPF Number
     attr_accessor :cpf_number
 
+    # The user's date of birth. Optional, but date of birth will become required for lookups starting September 1, 2026.
+    attr_accessor :date_of_birth
+
     # The raw bytes of the selfie image collected from the user.
     attr_accessor :selfie_image
 
@@ -28,6 +31,7 @@ module TrinsicApi
     def self.attribute_map
       {
         :'cpf_number' => :'cpfNumber',
+        :'date_of_birth' => :'dateOfBirth',
         :'selfie_image' => :'selfieImage',
         :'selfie_image_content_type' => :'selfieImageContentType'
       }
@@ -47,6 +51,7 @@ module TrinsicApi
     def self.openapi_types
       {
         :'cpf_number' => :'String',
+        :'date_of_birth' => :'Date',
         :'selfie_image' => :'String',
         :'selfie_image_content_type' => :'String'
       }
@@ -55,6 +60,7 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'date_of_birth',
         :'selfie_image',
         :'selfie_image_content_type'
       ])
@@ -82,6 +88,10 @@ module TrinsicApi
         self.cpf_number = nil
       end
 
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
       if attributes.key?(:'selfie_image')
         self.selfie_image = attributes[:'selfie_image']
       end
@@ -156,6 +166,7 @@ module TrinsicApi
       return true if self.equal?(o)
       self.class == o.class &&
           cpf_number == o.cpf_number &&
+          date_of_birth == o.date_of_birth &&
           selfie_image == o.selfie_image &&
           selfie_image_content_type == o.selfie_image_content_type
     end
@@ -169,7 +180,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [cpf_number, selfie_image, selfie_image_content_type].hash
+      [cpf_number, date_of_birth, selfie_image, selfie_image_content_type].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/brazil_cpf_provider_output.rb

@@ -0,0 +1,262 @@
+=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
+  # Exposed properties for the `brazil-cpf-lookup` Provider which do not directly map to the normalized IdentityData model.
+  class BrazilCpfProviderOutput < ApiModelBase
+    # The raw error code for the verification, returned by Serpro.              This is a temporary preview to support detailed error handling. When building against this please let the Trinsic team know. Preview features can be turned off without an obsoletion notice.
+    attr_accessor :preview_raw_error_code
+
+    # The individual's CPF number.              A CPF (Cadastro de Pessoas Físicas) is the Brazilian individual taxpayer identification number for residents and foreigners. It is an 11-digit number managed by the Federal Revenue Service, the last 2 digits are check digits, calculated based on the first 9 digits. The 9th digit indicates the fiscal region responsible for the registration,
+    attr_accessor :cpf_number
+
+    # List of Brazilian fiscal regions that could have issued this number.              This is calculated based off of the CPF number. A CPF number encodes information about what region it is issued from, but some regions share the identifier.              Possible values: Formatted as two characters. The digit represents the region code this applies to. - AC (Acre) - 2 - AL (Alagoas) - 4 - AP (Amapá) - 2 - AM (Amazonas) - 2 - BA (Bahia) - 5 - CE (Ceará) - 3 - DF (Distrito Federal) - 1 - ES (Espírito Santo) - 7 - GO (Goiás) - 1 - MA (Maranhão) - 3 - MT (Mato Grosso) - 1 - MS (Mato Grosso do Sul) - 1 - MG (Minas Gerais) - 6 - PA (Pará) - 2 - PB (Paraíba) - 4 - PR (Paraná) - 9 - PE (Pernambuco) - 4 - PI (Piauí) - 3 - RJ (Rio de Janeiro) - 7 - RN (Rio Grande do Norte) - 4 - RO (Rondônia) - 2 - RS (Rio Grande do Sul) - 0 - RR (Roraima) - 2 - SC (Santa Catarina) - 9 - SP (São Paulo) - 8 - SE (Sergipe) - 5 - TO (Tocantins) - 1
+    attr_accessor :fiscal_regions
+
+    # The CPF Status. Possible values: 0 - Regular. The CPF is valid and in good standing. There are no pending issues, registration inconsistencies, or missing mandatory Individual Income Tax Returns (DIRPF). 2 - Suspended. The CPF record contains incorrect or incomplete registration data (e.g., name, date of birth, or voter registration number). This status is typically caused by discrepancies with the Superior Electoral Court (TSE) database or failure to update personal information. 3 - Deceased Holder. The CPF has been registered as belonging to a deceased individual. This status is recorded to prevent post-mortem misuse. 4 - Pending Regularization. The taxpayer has failed to submit one or more mandatory Individual Income Tax Returns (DIRPF) within the last five years. This can occur for various reasons, such as failure to file a mandatory declaration, changes of address, name, marital status, or other important information that does not conform to the records. Regularization requires submission of the overdue returns. 5 - Canceled by Multiplicity. The CPF has been cancelled due to duplicate registration (multiple CPFs assigned to the same individual or a single CPF linked to multiple individuals). 8 - Null. The CPF registration was cancelled due to confirmed fraud or a serious issuance error. Regularization requires in-person verification at a Federal Revenue Service office and may not be guaranteed. 9 - Cancelled Ex Officio. The CPF was cancelled due to administrative or judicial decision, or other registration inconsistencies.
+    attr_accessor :status_code
+
+    # Description of the CPF Status.
+    attr_accessor :status_description
+
+    # The full legal name of the individual.
+    attr_accessor :name
+
+    # The social name of the individual in case the individual would like to use a different name than their full legal name.
+    attr_accessor :social_name
+
+    # The date of birth of the individual.
+    attr_accessor :date_of_birth
+
+    # Deprecated as of September 1, 2026.              The year of death of the individual, if applicable.
+    attr_accessor :year_of_death
+
+    # The date of registration of the individual with the Federal Revenue Service.
+    attr_accessor :date_of_registration
+
+    # The biometric verification results.              This is an optional configurable check.
+    attr_accessor :biometric_verification
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'preview_raw_error_code' => :'preview_raw_error_code',
+        :'cpf_number' => :'cpfNumber',
+        :'fiscal_regions' => :'fiscalRegions',
+        :'status_code' => :'statusCode',
+        :'status_description' => :'statusDescription',
+        :'name' => :'name',
+        :'social_name' => :'socialName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'year_of_death' => :'yearOfDeath',
+        :'date_of_registration' => :'dateOfRegistration',
+        :'biometric_verification' => :'biometricVerification'
+      }
+    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
+      {
+        :'preview_raw_error_code' => :'String',
+        :'cpf_number' => :'String',
+        :'fiscal_regions' => :'Array<String>',
+        :'status_code' => :'Integer',
+        :'status_description' => :'String',
+        :'name' => :'String',
+        :'social_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'year_of_death' => :'String',
+        :'date_of_registration' => :'Date',
+        :'biometric_verification' => :'BrazilBiometricVerificationOutput'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'preview_raw_error_code',
+        :'cpf_number',
+        :'fiscal_regions',
+        :'status_code',
+        :'status_description',
+        :'name',
+        :'social_name',
+        :'date_of_birth',
+        :'year_of_death',
+        :'date_of_registration',
+        :'biometric_verification'
+      ])
+    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::BrazilCpfProviderOutput` 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::BrazilCpfProviderOutput`. 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?(:'preview_raw_error_code')
+        self.preview_raw_error_code = attributes[:'preview_raw_error_code']
+      end
+
+      if attributes.key?(:'cpf_number')
+        self.cpf_number = attributes[:'cpf_number']
+      end
+
+      if attributes.key?(:'fiscal_regions')
+        if (value = attributes[:'fiscal_regions']).is_a?(Array)
+          self.fiscal_regions = value
+        end
+      end
+
+      if attributes.key?(:'status_code')
+        self.status_code = attributes[:'status_code']
+      end
+
+      if attributes.key?(:'status_description')
+        self.status_description = attributes[:'status_description']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'social_name')
+        self.social_name = attributes[:'social_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'year_of_death')
+        self.year_of_death = attributes[:'year_of_death']
+      end
+
+      if attributes.key?(:'date_of_registration')
+        self.date_of_registration = attributes[:'date_of_registration']
+      end
+
+      if attributes.key?(:'biometric_verification')
+        self.biometric_verification = attributes[:'biometric_verification']
+      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 &&
+          preview_raw_error_code == o.preview_raw_error_code &&
+          cpf_number == o.cpf_number &&
+          fiscal_regions == o.fiscal_regions &&
+          status_code == o.status_code &&
+          status_description == o.status_description &&
+          name == o.name &&
+          social_name == o.social_name &&
+          date_of_birth == o.date_of_birth &&
+          year_of_death == o.year_of_death &&
+          date_of_registration == o.date_of_registration &&
+          biometric_verification == o.biometric_verification
+    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
+      [preview_raw_error_code, cpf_number, fiscal_regions, status_code, status_description, name, social_name, date_of_birth, year_of_death, date_of_registration, biometric_verification].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