trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/french_numerique_provider_output.rb

@@ -0,0 +1,487 @@
+=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.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # Exposed properties for the `france-identite-numerique` Provider which do not directly map to the normalized IdentityData model.
+  class FrenchNumeriqueProviderOutput
+    # Given name information including the full given name and its structured components (first name and middle name(s)).
+    attr_accessor :given_name
+
+    # Birth name (nom de naissance) as recorded on the user's French identity document. In France, this is the family name given at birth and may differ from the usage name.
+    attr_accessor :family_name
+
+    # Usage surname (\"nom d'usage\") - according to French law, this is the surname used in daily life. This is typically a married name or other preferred surname, as opposed to FamilyName which is the birth surname (\"nom de naissance\").
+    attr_accessor :preferred_surname
+
+    # Date of birth in YYYY-MM-DD format, as recorded on the user's French identity document.
+    attr_accessor :birthdate
+
+    # Nationality information with ISO 3166 alpha-3 code and French label. The label is provided in French (e.g., \"Française\" for French nationality).
+    attr_accessor :nationality
+
+    # Sex - \"Male\" or \"Female\".
+    attr_accessor :sex
+
+    # Majority status (majorité) indicating whether the user has reached the French age of legal majority (18 years old). This value is computed by the provider from the user's birthdate.
+    attr_accessor :majority
+
+    # Phone number information including the full phone number and its structured components (country prefix and national number).
+    attr_accessor :phone_number
+
+    # Whether the phone number has been verified by the provider.
+    attr_accessor :phone_number_verified
+
+    # Email address registered in the user's digital identity account.
+    attr_accessor :email
+
+    # Whether the email address has been verified by the provider.
+    attr_accessor :email_verified
+
+    # National Institute of Statistics and Economic Studies (INSEE) official geographic code (COG) of the birthplace. This is a 5-digit French administrative code identifying the commune (municipality) of birth. For births in metropolitan France, the first two digits represent the department.              See: https://www.insee.fr/fr/information/2560452
+    attr_accessor :birthplace
+
+    # Name of the birthplace commune (municipality). If applicable, this includes the full name of the arrondissement (borough).
+    attr_accessor :birthplace_label
+
+    # National Institute of Statistics and Economic Studies (INSEE) official geographic code (COG) for the user's country of birth.              LaPoste returns this as a 5-character numeric string. This is a country/territory COG, so it always starts with \"99\" (99xxx). France is coded as 99100.              See full list here: https://www.insee.fr/fr/information/2560452
+    attr_accessor :birth_country
+
+    # Birth country as an ISO 3166 alpha-3 code.
+    attr_accessor :birth_country_iso
+
+    # Label of the birth country, in English.
+    attr_accessor :birth_country_label
+
+    # Number of the department of birth (e.g., \"75\" for Paris, \"2A\" for Corse-du-Sud).              See full list here: https://en.wikipedia.org/wiki/Departments_of_France
+    attr_accessor :birth_department
+
+    # Date when the user's digital identity was created.
+    attr_accessor :digital_identity_creation_date
+
+    # Date when the digital identity expires. It is valid for 5 years from the date of identity verification. Users are notified ~1 month before and must re-verify identity via the app or in-person at La Poste. After expiration, the identity is deactivated but can be renewed within 1 year; otherwise deleted.
+    attr_accessor :digital_identity_expiration_date
+
+    # Type of identity document used for verification. Can be \"ID_CARD\", \"PASSPORT\", or \"RESIDENCE_PERMIT\".
+    attr_accessor :identity_document_type
+
+    # Identity document number as it appears on the ID Card, Passport or Residence Permit.
+    attr_accessor :identity_document_number
+
+    # Date when the identity document was issued.
+    attr_accessor :identity_document_emitting_date
+
+    # Date when the identity document expires.
+    attr_accessor :identity_document_expiration_date
+
+    # Country that issued the identity document (ISO 3166 alpha-3 code).
+    attr_accessor :identity_document_emitting_country
+
+    # Machine Readable Zone (MRZ) data from the ID Card, Passport or Residence Permit.
+    attr_accessor :identity_document_mrz
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'preferred_surname' => :'preferredSurname',
+        :'birthdate' => :'birthdate',
+        :'nationality' => :'nationality',
+        :'sex' => :'sex',
+        :'majority' => :'majority',
+        :'phone_number' => :'phoneNumber',
+        :'phone_number_verified' => :'phoneNumberVerified',
+        :'email' => :'email',
+        :'email_verified' => :'emailVerified',
+        :'birthplace' => :'birthplace',
+        :'birthplace_label' => :'birthplaceLabel',
+        :'birth_country' => :'birthCountry',
+        :'birth_country_iso' => :'birthCountryIso',
+        :'birth_country_label' => :'birthCountryLabel',
+        :'birth_department' => :'birthDepartment',
+        :'digital_identity_creation_date' => :'digitalIdentityCreationDate',
+        :'digital_identity_expiration_date' => :'digitalIdentityExpirationDate',
+        :'identity_document_type' => :'identityDocumentType',
+        :'identity_document_number' => :'identityDocumentNumber',
+        :'identity_document_emitting_date' => :'identityDocumentEmittingDate',
+        :'identity_document_expiration_date' => :'identityDocumentExpirationDate',
+        :'identity_document_emitting_country' => :'identityDocumentEmittingCountry',
+        :'identity_document_mrz' => :'identityDocumentMrz'
+      }
+    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
+      {
+        :'given_name' => :'FrenchNumeriqueGivenName',
+        :'family_name' => :'String',
+        :'preferred_surname' => :'String',
+        :'birthdate' => :'String',
+        :'nationality' => :'FrenchNumeriqueNationality',
+        :'sex' => :'String',
+        :'majority' => :'Boolean',
+        :'phone_number' => :'FrenchNumeriquePhone',
+        :'phone_number_verified' => :'Boolean',
+        :'email' => :'String',
+        :'email_verified' => :'Boolean',
+        :'birthplace' => :'String',
+        :'birthplace_label' => :'String',
+        :'birth_country' => :'String',
+        :'birth_country_iso' => :'String',
+        :'birth_country_label' => :'String',
+        :'birth_department' => :'String',
+        :'digital_identity_creation_date' => :'Date',
+        :'digital_identity_expiration_date' => :'Date',
+        :'identity_document_type' => :'String',
+        :'identity_document_number' => :'String',
+        :'identity_document_emitting_date' => :'Date',
+        :'identity_document_expiration_date' => :'Date',
+        :'identity_document_emitting_country' => :'String',
+        :'identity_document_mrz' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'given_name',
+        :'family_name',
+        :'preferred_surname',
+        :'birthdate',
+        :'nationality',
+        :'sex',
+        :'majority',
+        :'phone_number',
+        :'phone_number_verified',
+        :'email',
+        :'email_verified',
+        :'birthplace',
+        :'birthplace_label',
+        :'birth_country',
+        :'birth_country_iso',
+        :'birth_country_label',
+        :'birth_department',
+        :'digital_identity_creation_date',
+        :'digital_identity_expiration_date',
+        :'identity_document_type',
+        :'identity_document_number',
+        :'identity_document_emitting_date',
+        :'identity_document_expiration_date',
+        :'identity_document_emitting_country',
+        :'identity_document_mrz'
+      ])
+    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::FrenchNumeriqueProviderOutput` 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::FrenchNumeriqueProviderOutput`. 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?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'preferred_surname')
+        self.preferred_surname = attributes[:'preferred_surname']
+      end
+
+      if attributes.key?(:'birthdate')
+        self.birthdate = attributes[:'birthdate']
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'majority')
+        self.majority = attributes[:'majority']
+      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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'email_verified')
+        self.email_verified = attributes[:'email_verified']
+      end
+
+      if attributes.key?(:'birthplace')
+        self.birthplace = attributes[:'birthplace']
+      end
+
+      if attributes.key?(:'birthplace_label')
+        self.birthplace_label = attributes[:'birthplace_label']
+      end
+
+      if attributes.key?(:'birth_country')
+        self.birth_country = attributes[:'birth_country']
+      end
+
+      if attributes.key?(:'birth_country_iso')
+        self.birth_country_iso = attributes[:'birth_country_iso']
+      end
+
+      if attributes.key?(:'birth_country_label')
+        self.birth_country_label = attributes[:'birth_country_label']
+      end
+
+      if attributes.key?(:'birth_department')
+        self.birth_department = attributes[:'birth_department']
+      end
+
+      if attributes.key?(:'digital_identity_creation_date')
+        self.digital_identity_creation_date = attributes[:'digital_identity_creation_date']
+      end
+
+      if attributes.key?(:'digital_identity_expiration_date')
+        self.digital_identity_expiration_date = attributes[:'digital_identity_expiration_date']
+      end
+
+      if attributes.key?(:'identity_document_type')
+        self.identity_document_type = attributes[:'identity_document_type']
+      end
+
+      if attributes.key?(:'identity_document_number')
+        self.identity_document_number = attributes[:'identity_document_number']
+      end
+
+      if attributes.key?(:'identity_document_emitting_date')
+        self.identity_document_emitting_date = attributes[:'identity_document_emitting_date']
+      end
+
+      if attributes.key?(:'identity_document_expiration_date')
+        self.identity_document_expiration_date = attributes[:'identity_document_expiration_date']
+      end
+
+      if attributes.key?(:'identity_document_emitting_country')
+        self.identity_document_emitting_country = attributes[:'identity_document_emitting_country']
+      end
+
+      if attributes.key?(:'identity_document_mrz')
+        self.identity_document_mrz = attributes[:'identity_document_mrz']
+      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 &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          preferred_surname == o.preferred_surname &&
+          birthdate == o.birthdate &&
+          nationality == o.nationality &&
+          sex == o.sex &&
+          majority == o.majority &&
+          phone_number == o.phone_number &&
+          phone_number_verified == o.phone_number_verified &&
+          email == o.email &&
+          email_verified == o.email_verified &&
+          birthplace == o.birthplace &&
+          birthplace_label == o.birthplace_label &&
+          birth_country == o.birth_country &&
+          birth_country_iso == o.birth_country_iso &&
+          birth_country_label == o.birth_country_label &&
+          birth_department == o.birth_department &&
+          digital_identity_creation_date == o.digital_identity_creation_date &&
+          digital_identity_expiration_date == o.digital_identity_expiration_date &&
+          identity_document_type == o.identity_document_type &&
+          identity_document_number == o.identity_document_number &&
+          identity_document_emitting_date == o.identity_document_emitting_date &&
+          identity_document_expiration_date == o.identity_document_expiration_date &&
+          identity_document_emitting_country == o.identity_document_emitting_country &&
+          identity_document_mrz == o.identity_document_mrz
+    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
+      [given_name, family_name, preferred_surname, birthdate, nationality, sex, majority, phone_number, phone_number_verified, email, email_verified, birthplace, birthplace_label, birth_country, birth_country_iso, birth_country_label, birth_department, digital_identity_creation_date, digital_identity_expiration_date, identity_document_type, identity_document_number, identity_document_emitting_date, identity_document_expiration_date, identity_document_emitting_country, identity_document_mrz].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = TrinsicApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/trinsic_api/models/get_attachment_request.rb

@@ -15,17 +15,13 @@ require 'time'
 
 module TrinsicApi
   class GetAttachmentRequest
-    # The Attachment Access Key to exchange for the raw file contents of the related Attachment
-    attr_accessor :attachment_access_key
-
-    # The ID of the Acceptance Session for which the Attachment is being requested.
-    attr_accessor :session_id
+    # The Results Access Key for the Session associated with the Attachment being retrieved.              This is returned during Session creation.
+    attr_accessor :results_access_key
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'attachment_access_key' => :'attachmentAccessKey',
-        :'session_id' => :'sessionId'
+        :'results_access_key' => :'resultsAccessKey'
       }
     end
 
@@ -42,8 +38,7 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'attachment_access_key' => :'String',
-        :'session_id' => :'String'
+        :'results_access_key' => :'String'
       }
     end
 
@@ -69,16 +64,10 @@ module TrinsicApi
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'attachment_access_key')
-        self.attachment_access_key = attributes[:'attachment_access_key']
-      else
-        self.attachment_access_key = nil
-      end
-
-      if attributes.key?(:'session_id')
-        self.session_id = attributes[:'session_id']
+      if attributes.key?(:'results_access_key')
+        self.results_access_key = attributes[:'results_access_key']
       else
-        self.session_id = nil
+        self.results_access_key = nil
       end
     end
 
@@ -87,16 +76,12 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @attachment_access_key.nil?
-        invalid_properties.push('invalid value for "attachment_access_key", attachment_access_key cannot be nil.')
-      end
-
-      if @attachment_access_key.to_s.length < 1
-        invalid_properties.push('invalid value for "attachment_access_key", the character length must be great than or equal to 1.')
+      if @results_access_key.nil?
+        invalid_properties.push('invalid value for "results_access_key", results_access_key cannot be nil.')
       end
 
-      if @session_id.nil?
-        invalid_properties.push('invalid value for "session_id", session_id cannot be nil.')
+      if @results_access_key.to_s.length < 1
+        invalid_properties.push('invalid value for "results_access_key", the character length must be great than or equal to 1.')
       end
 
       invalid_properties
@@ -106,34 +91,23 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @attachment_access_key.nil?
-      return false if @attachment_access_key.to_s.length < 1
-      return false if @session_id.nil?
+      return false if @results_access_key.nil?
+      return false if @results_access_key.to_s.length < 1
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] attachment_access_key Value to be assigned
-    def attachment_access_key=(attachment_access_key)
-      if attachment_access_key.nil?
-        fail ArgumentError, 'attachment_access_key cannot be nil'
+    # @param [Object] results_access_key Value to be assigned
+    def results_access_key=(results_access_key)
+      if results_access_key.nil?
+        fail ArgumentError, 'results_access_key cannot be nil'
       end
 
-      if attachment_access_key.to_s.length < 1
-        fail ArgumentError, 'invalid value for "attachment_access_key", the character length must be great than or equal to 1.'
-      end
-
-      @attachment_access_key = attachment_access_key
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] session_id Value to be assigned
-    def session_id=(session_id)
-      if session_id.nil?
-        fail ArgumentError, 'session_id cannot be nil'
+      if results_access_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "results_access_key", the character length must be great than or equal to 1.'
       end
 
-      @session_id = session_id
+      @results_access_key = results_access_key
     end
 
     # Checks equality by comparing each attribute.
@@ -141,8 +115,7 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          attachment_access_key == o.attachment_access_key &&
-          session_id == o.session_id
+          results_access_key == o.results_access_key
     end
 
     # @see the `==` method
@@ -154,7 +127,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attachment_access_key, session_id].hash
+      [results_access_key].hash
     end
 
     # Builds the object from hash