trinsic_api 3.1.0.pre.preview1 → 3.2.0

data/lib/trinsic_api/models/czech_bank_id_provider_output.rb

@@ -0,0 +1,504 @@
+=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 `czech-bank-id` Provider which do not directly map to the normalized IdentityData model.
+  class CzechBankIdProviderOutput < ApiModelBase
+    # The subject identifier for the verified individual.
+    attr_accessor :subject_identifier
+
+    # The individual's full name.
+    attr_accessor :full_name
+
+    # The individual's given or first name.
+    attr_accessor :given_name
+
+    # The individual's family or last name.
+    attr_accessor :family_name
+
+    # The individual's middle name.
+    attr_accessor :middle_name
+
+    # Nickname used by a physical person              A casual name, not necessarily the legal given name.
+    attr_accessor :nickname
+
+    # The individual's preferred username.              The user has chosen this as the preferred name for logins.
+    attr_accessor :preferred_username
+
+    # The individual's gender.              Possible values: - Male - Female - Other              Only returned for Identify verifications.
+    attr_accessor :gender
+
+    # The individual's date of birth.              This is a string because the value may have reduced precision, such as only a year.
+    attr_accessor :date_of_birth
+
+    # The individual's Czech birth number.              This value is written without the traditional forward slash. Czech birth numbers are Czech public-authority identifiers administered through the Ministry of Interior's birth-number register. The Ministry can assign one to Czech citizens and to foreign nationals with temporary or permanent residence in the Czech Republic. For foreign nationals, this is still a Czech birth number in the Czech format, not an identity number from another country.              The common current format is YYXXDDSSSC: - YY: Two digit birth year - XX: Encoded birth month, see below for encoding logic - DD: Birth day - SSS: Sequence number - C: Modulo-11 checksum digit. Not present for people born before 1954. The encoded month is MM for men, MM + 50 for women, and can be MM + 20 for men or MM + 70 for women when additional number ranges are needed. Older numbers for people born before 1954 can use YYXXDDSSS and do not use the modulo-11 checksum.              Only returned for Identify verifications.
+    attr_accessor :birth_number
+
+    # The individual's age.
+    attr_accessor :age
+
+    # Whether the individual is an adult.              In the Czech Republic, legal majority (adulthood) is reached at 18 years old. Only returned for Identify Plus verifications.
+    attr_accessor :is_adult
+
+    # The individual's date of death, if available.
+    attr_accessor :date_of_death
+
+    # The individual's place of birth.              Only returned for Identify Plus verifications.
+    attr_accessor :birth_place
+
+    # The individual's country of birth.              Only returned for Identify Plus verifications.
+    attr_accessor :birth_country
+
+    # The individual's primary nationality.              The value is an ISO 3166-1 alpha-2 country code. Only returned for Identify Plus verifications.
+    attr_accessor :primary_nationality
+
+    # The individual's nationalities.
+    attr_accessor :nationalities
+
+    # The individual's marital status.              Possible values: - COHABITATION - MARRIED - DIVORCED - REGISTERED_PARTNERSHIP - REGISTERED_PARTNERSHIP_CANCELED - WIDOWED - SINGLE - PARTNERSHIP - PARTNERSHIP_CANCELED - SEPARATED - REGISTERED_PARTNERSHIP_WIDOWED - LAPSED_MARRIAGE - UNKNOWN              Only returned for Identify Plus verifications.
+    attr_accessor :marital_status
+
+    # The individual's email address.
+    attr_accessor :email
+
+    # Whether the individual's email address has been verified.
+    attr_accessor :email_verified
+
+    # The individual's phone number.              This value is normalized to E.164 format.
+    attr_accessor :phone_number
+
+    # Whether the individual's phone number has been verified.
+    attr_accessor :phone_number_verified
+
+    # Whether the individual is a politically exposed person.              This follows Czech anti-money-laundering rules, indicating a person that is at risk for corruption, bribery or money laundering activities. Mandatory screening of these individuals is required for compliance. Typically set for people such as the Prime Minister, ministers, etc.
+    attr_accessor :is_politically_exposed_person
+
+    # Whether the individual is a person with limited legal capacity.
+    attr_accessor :limited_legal_capacity
+
+    # Metadata about how the identity information was verified for Anti Money Laundering scope.              Only returned for Identify AML verifications.
+    attr_accessor :verification
+
+    # The individual's addresses.              This can include permanent residence and contact addresses. Only returned for Identify verifications.
+    attr_accessor :addresses
+
+    # The individual's identity documents.              This can include document type, country, number, issuer, and validity dates. Only returned for Identify Plus verifications.
+    attr_accessor :id_cards
+
+    # The UTC date and time when the identity data was last updated.
+    attr_accessor :updated_at
+
+    # The individual's time zone.              This is represented as a zoneinfo/IANA Time Zone Database value.
+    attr_accessor :zone_info
+
+    # The individual's locale.              This is represented as a BCP 47/RFC 5646 language tag. Some values may use an underscore separator, such as cs_CZ.
+    attr_accessor :locale
+
+    # The individual's title prefixes and suffixes.              Only returned for Identify verifications.
+    attr_accessor :titles
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'subject_identifier' => :'subjectIdentifier',
+        :'full_name' => :'fullName',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'middle_name' => :'middleName',
+        :'nickname' => :'nickname',
+        :'preferred_username' => :'preferredUsername',
+        :'gender' => :'gender',
+        :'date_of_birth' => :'dateOfBirth',
+        :'birth_number' => :'birthNumber',
+        :'age' => :'age',
+        :'is_adult' => :'isAdult',
+        :'date_of_death' => :'dateOfDeath',
+        :'birth_place' => :'birthPlace',
+        :'birth_country' => :'birthCountry',
+        :'primary_nationality' => :'primaryNationality',
+        :'nationalities' => :'nationalities',
+        :'marital_status' => :'maritalStatus',
+        :'email' => :'email',
+        :'email_verified' => :'emailVerified',
+        :'phone_number' => :'phoneNumber',
+        :'phone_number_verified' => :'phoneNumberVerified',
+        :'is_politically_exposed_person' => :'isPoliticallyExposedPerson',
+        :'limited_legal_capacity' => :'limitedLegalCapacity',
+        :'verification' => :'verification',
+        :'addresses' => :'addresses',
+        :'id_cards' => :'idCards',
+        :'updated_at' => :'updatedAt',
+        :'zone_info' => :'zoneInfo',
+        :'locale' => :'locale',
+        :'titles' => :'titles'
+      }
+    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
+      {
+        :'subject_identifier' => :'String',
+        :'full_name' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'middle_name' => :'String',
+        :'nickname' => :'String',
+        :'preferred_username' => :'String',
+        :'gender' => :'String',
+        :'date_of_birth' => :'String',
+        :'birth_number' => :'String',
+        :'age' => :'Integer',
+        :'is_adult' => :'Boolean',
+        :'date_of_death' => :'Date',
+        :'birth_place' => :'String',
+        :'birth_country' => :'String',
+        :'primary_nationality' => :'String',
+        :'nationalities' => :'Array<String>',
+        :'marital_status' => :'String',
+        :'email' => :'String',
+        :'email_verified' => :'Boolean',
+        :'phone_number' => :'String',
+        :'phone_number_verified' => :'Boolean',
+        :'is_politically_exposed_person' => :'Boolean',
+        :'limited_legal_capacity' => :'Boolean',
+        :'verification' => :'CzechBankIdVerification',
+        :'addresses' => :'Array<CzechBankIdAddress>',
+        :'id_cards' => :'Array<CzechBankIdCard>',
+        :'updated_at' => :'Time',
+        :'zone_info' => :'String',
+        :'locale' => :'String',
+        :'titles' => :'Array<CzechBankIdTitle>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'full_name',
+        :'given_name',
+        :'family_name',
+        :'middle_name',
+        :'nickname',
+        :'preferred_username',
+        :'gender',
+        :'date_of_birth',
+        :'birth_number',
+        :'age',
+        :'is_adult',
+        :'date_of_death',
+        :'birth_place',
+        :'birth_country',
+        :'primary_nationality',
+        :'nationalities',
+        :'marital_status',
+        :'email',
+        :'email_verified',
+        :'phone_number',
+        :'phone_number_verified',
+        :'is_politically_exposed_person',
+        :'limited_legal_capacity',
+        :'verification',
+        :'addresses',
+        :'id_cards',
+        :'updated_at',
+        :'zone_info',
+        :'locale',
+        :'titles'
+      ])
+    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::CzechBankIdProviderOutput` 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::CzechBankIdProviderOutput`. 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?(:'subject_identifier')
+        self.subject_identifier = attributes[:'subject_identifier']
+      else
+        self.subject_identifier = nil
+      end
+
+      if attributes.key?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      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?(:'middle_name')
+        self.middle_name = attributes[:'middle_name']
+      end
+
+      if attributes.key?(:'nickname')
+        self.nickname = attributes[:'nickname']
+      end
+
+      if attributes.key?(:'preferred_username')
+        self.preferred_username = attributes[:'preferred_username']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'birth_number')
+        self.birth_number = attributes[:'birth_number']
+      end
+
+      if attributes.key?(:'age')
+        self.age = attributes[:'age']
+      end
+
+      if attributes.key?(:'is_adult')
+        self.is_adult = attributes[:'is_adult']
+      end
+
+      if attributes.key?(:'date_of_death')
+        self.date_of_death = attributes[:'date_of_death']
+      end
+
+      if attributes.key?(:'birth_place')
+        self.birth_place = attributes[:'birth_place']
+      end
+
+      if attributes.key?(:'birth_country')
+        self.birth_country = attributes[:'birth_country']
+      end
+
+      if attributes.key?(:'primary_nationality')
+        self.primary_nationality = attributes[:'primary_nationality']
+      end
+
+      if attributes.key?(:'nationalities')
+        if (value = attributes[:'nationalities']).is_a?(Array)
+          self.nationalities = value
+        end
+      end
+
+      if attributes.key?(:'marital_status')
+        self.marital_status = attributes[:'marital_status']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'email_verified')
+        self.email_verified = attributes[:'email_verified']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'phone_number_verified')
+        self.phone_number_verified = attributes[:'phone_number_verified']
+      end
+
+      if attributes.key?(:'is_politically_exposed_person')
+        self.is_politically_exposed_person = attributes[:'is_politically_exposed_person']
+      end
+
+      if attributes.key?(:'limited_legal_capacity')
+        self.limited_legal_capacity = attributes[:'limited_legal_capacity']
+      end
+
+      if attributes.key?(:'verification')
+        self.verification = attributes[:'verification']
+      end
+
+      if attributes.key?(:'addresses')
+        if (value = attributes[:'addresses']).is_a?(Array)
+          self.addresses = value
+        end
+      end
+
+      if attributes.key?(:'id_cards')
+        if (value = attributes[:'id_cards']).is_a?(Array)
+          self.id_cards = value
+        end
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'zone_info')
+        self.zone_info = attributes[:'zone_info']
+      end
+
+      if attributes.key?(:'locale')
+        self.locale = attributes[:'locale']
+      end
+
+      if attributes.key?(:'titles')
+        if (value = attributes[:'titles']).is_a?(Array)
+          self.titles = value
+        end
+      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 @subject_identifier.nil?
+        invalid_properties.push('invalid value for "subject_identifier", subject_identifier 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 @subject_identifier.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subject_identifier Value to be assigned
+    def subject_identifier=(subject_identifier)
+      if subject_identifier.nil?
+        fail ArgumentError, 'subject_identifier cannot be nil'
+      end
+
+      @subject_identifier = subject_identifier
+    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 &&
+          subject_identifier == o.subject_identifier &&
+          full_name == o.full_name &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          middle_name == o.middle_name &&
+          nickname == o.nickname &&
+          preferred_username == o.preferred_username &&
+          gender == o.gender &&
+          date_of_birth == o.date_of_birth &&
+          birth_number == o.birth_number &&
+          age == o.age &&
+          is_adult == o.is_adult &&
+          date_of_death == o.date_of_death &&
+          birth_place == o.birth_place &&
+          birth_country == o.birth_country &&
+          primary_nationality == o.primary_nationality &&
+          nationalities == o.nationalities &&
+          marital_status == o.marital_status &&
+          email == o.email &&
+          email_verified == o.email_verified &&
+          phone_number == o.phone_number &&
+          phone_number_verified == o.phone_number_verified &&
+          is_politically_exposed_person == o.is_politically_exposed_person &&
+          limited_legal_capacity == o.limited_legal_capacity &&
+          verification == o.verification &&
+          addresses == o.addresses &&
+          id_cards == o.id_cards &&
+          updated_at == o.updated_at &&
+          zone_info == o.zone_info &&
+          locale == o.locale &&
+          titles == o.titles
+    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
+      [subject_identifier, full_name, given_name, family_name, middle_name, nickname, preferred_username, gender, date_of_birth, birth_number, age, is_adult, date_of_death, birth_place, birth_country, primary_nationality, nationalities, marital_status, email, email_verified, phone_number, phone_number_verified, is_politically_exposed_person, limited_legal_capacity, verification, addresses, id_cards, updated_at, zone_info, locale, titles].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/czech_bank_id_title.rb

@@ -0,0 +1,160 @@
+=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
+  class CzechBankIdTitle < ApiModelBase
+    # The title prefix before the individual's name.
+    attr_accessor :title_prefix
+
+    # The title suffix after the individual's name.
+    attr_accessor :title_suffix
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'title_prefix' => :'titlePrefix',
+        :'title_suffix' => :'titleSuffix'
+      }
+    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
+      {
+        :'title_prefix' => :'String',
+        :'title_suffix' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'title_prefix',
+        :'title_suffix'
+      ])
+    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::CzechBankIdTitle` 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::CzechBankIdTitle`. 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?(:'title_prefix')
+        self.title_prefix = attributes[:'title_prefix']
+      end
+
+      if attributes.key?(:'title_suffix')
+        self.title_suffix = attributes[:'title_suffix']
+      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 &&
+          title_prefix == o.title_prefix &&
+          title_suffix == o.title_suffix
+    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
+      [title_prefix, title_suffix].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