trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/{finalize_mdl_exchange_request.rb → portugal_id_card_provider_output.rb}

@@ -14,26 +14,27 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class FinalizeMdlExchangeRequest
-    # The ID of the VerificationProfile which was used to create the mDL exchange.
-    attr_accessor :verification_profile_id
+  # Exposed properties for the `a-pt-id-login` Provider which do not directly map to the normalized IdentityData model.
+  class PortugalIdCardProviderOutput
+    # The first name of the verified individual
+    attr_accessor :first_name
 
-    # The ID of the mDL exchange to finalize.
-    attr_accessor :exchange_id
+    # The last name of the verified individual
+    attr_accessor :last_name
 
-    # The encrypted exchange context which was returned when the mDL exchange was created.
-    attr_accessor :exchange_context
+    # The date of birth of the verified individual
+    attr_accessor :date_of_birth
 
-    # The response token returned by Trinsic's SDK after a successful mDL exchange.
-    attr_accessor :response_token
+    # The 8-digit Portuguese Civil Identification Number (número de identificação civil) of the verified individual.
+    attr_accessor :civil_identification_number
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'verification_profile_id' => :'verificationProfileId',
-        :'exchange_id' => :'exchangeId',
-        :'exchange_context' => :'exchangeContext',
-        :'response_token' => :'responseToken'
+        :'first_name' => :'firstName',
+        :'last_name' => :'lastName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'civil_identification_number' => :'civilIdentificationNumber'
       }
     end
 
@@ -50,10 +51,10 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'verification_profile_id' => :'String',
-        :'exchange_id' => :'String',
-        :'exchange_context' => :'String',
-        :'response_token' => :'String'
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'civil_identification_number' => :'String'
       }
     end
 
@@ -67,40 +68,40 @@ 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::FinalizeMdlExchangeRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::PortugalIdCardProviderOutput` 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::FinalizeMdlExchangeRequest`. 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::PortugalIdCardProviderOutput`. 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?(:'verification_profile_id')
-        self.verification_profile_id = attributes[:'verification_profile_id']
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
       else
-        self.verification_profile_id = nil
+        self.first_name = nil
       end
 
-      if attributes.key?(:'exchange_id')
-        self.exchange_id = attributes[:'exchange_id']
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
       else
-        self.exchange_id = nil
+        self.last_name = nil
       end
 
-      if attributes.key?(:'exchange_context')
-        self.exchange_context = attributes[:'exchange_context']
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
       else
-        self.exchange_context = nil
+        self.date_of_birth = nil
       end
 
-      if attributes.key?(:'response_token')
-        self.response_token = attributes[:'response_token']
+      if attributes.key?(:'civil_identification_number')
+        self.civil_identification_number = attributes[:'civil_identification_number']
       else
-        self.response_token = nil
+        self.civil_identification_number = nil
       end
     end
 
@@ -109,20 +110,20 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @verification_profile_id.nil?
-        invalid_properties.push('invalid value for "verification_profile_id", verification_profile_id cannot be nil.')
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
       end
 
-      if @exchange_id.nil?
-        invalid_properties.push('invalid value for "exchange_id", exchange_id cannot be nil.')
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
       end
 
-      if @exchange_context.nil?
-        invalid_properties.push('invalid value for "exchange_context", exchange_context cannot be nil.')
+      if @date_of_birth.nil?
+        invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
       end
 
-      if @response_token.nil?
-        invalid_properties.push('invalid value for "response_token", response_token cannot be nil.')
+      if @civil_identification_number.nil?
+        invalid_properties.push('invalid value for "civil_identification_number", civil_identification_number cannot be nil.')
       end
 
       invalid_properties
@@ -132,51 +133,51 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @verification_profile_id.nil?
-      return false if @exchange_id.nil?
-      return false if @exchange_context.nil?
-      return false if @response_token.nil?
+      return false if @first_name.nil?
+      return false if @last_name.nil?
+      return false if @date_of_birth.nil?
+      return false if @civil_identification_number.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] verification_profile_id Value to be assigned
-    def verification_profile_id=(verification_profile_id)
-      if verification_profile_id.nil?
-        fail ArgumentError, 'verification_profile_id cannot be nil'
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      if first_name.nil?
+        fail ArgumentError, 'first_name cannot be nil'
       end
 
-      @verification_profile_id = verification_profile_id
+      @first_name = first_name
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] exchange_id Value to be assigned
-    def exchange_id=(exchange_id)
-      if exchange_id.nil?
-        fail ArgumentError, 'exchange_id cannot be nil'
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if last_name.nil?
+        fail ArgumentError, 'last_name cannot be nil'
       end
 
-      @exchange_id = exchange_id
+      @last_name = last_name
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] exchange_context Value to be assigned
-    def exchange_context=(exchange_context)
-      if exchange_context.nil?
-        fail ArgumentError, 'exchange_context cannot be nil'
+    # @param [Object] date_of_birth Value to be assigned
+    def date_of_birth=(date_of_birth)
+      if date_of_birth.nil?
+        fail ArgumentError, 'date_of_birth cannot be nil'
       end
 
-      @exchange_context = exchange_context
+      @date_of_birth = date_of_birth
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] response_token Value to be assigned
-    def response_token=(response_token)
-      if response_token.nil?
-        fail ArgumentError, 'response_token cannot be nil'
+    # @param [Object] civil_identification_number Value to be assigned
+    def civil_identification_number=(civil_identification_number)
+      if civil_identification_number.nil?
+        fail ArgumentError, 'civil_identification_number cannot be nil'
       end
 
-      @response_token = response_token
+      @civil_identification_number = civil_identification_number
     end
 
     # Checks equality by comparing each attribute.
@@ -184,10 +185,10 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          verification_profile_id == o.verification_profile_id &&
-          exchange_id == o.exchange_id &&
-          exchange_context == o.exchange_context &&
-          response_token == o.response_token
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          date_of_birth == o.date_of_birth &&
+          civil_identification_number == o.civil_identification_number
     end
 
     # @see the `==` method
@@ -199,7 +200,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [verification_profile_id, exchange_id, exchange_context, response_token].hash
+      [first_name, last_name, date_of_birth, civil_identification_number].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/post_office_easy_id_provider_output.rb

@@ -0,0 +1,344 @@
+=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 `post-office-easyid` Provider which do not directly map to the normalized IdentityData model.
+  class PostOfficeEasyIdProviderOutput
+    # The unique id for your service of the individual. This is not shared between different services so if the user logs into a different service, the user will have a new id for the other service.
+    attr_accessor :remember_me_id
+
+    # The email address of the individual
+    attr_accessor :email
+
+    # The given name of the individual. This can correspond to first and middle names in English.
+    attr_accessor :given_name
+
+    # The family name of the individual
+    attr_accessor :family_name
+
+    # Full name of the individual which is composed of the given and family name. Unverified full name may be safe to use. For example, Aadhaar card provides full name, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\".
+    attr_accessor :full_name
+
+    # The date of birth of the individual. Unverified date of birth may be safe to use. For example, Aadhaar card provides date of birth, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\".
+    attr_accessor :date_of_birth
+
+    # The gender of the individual. Depending on the source or country, gender may not be verified. This is a setting that can be configured while setting up scopes.              Unverified gender may be safe to use. For example, Aadhaar card provides gender, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". In some countries Possible values: - \"MALE\" - \"FEMALE\" - \"TRANSGENDER\" - \"OTHER\"
+    attr_accessor :gender
+
+    # The nationality of the individual as a ISO alpha-3 code
+    attr_accessor :nationality
+
+    # The mobile phone number of the individual. This number was verified with a one time password (OTP) during the user's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the user's identity.
+    attr_accessor :mobile_number
+
+    # A structured postal address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \"unverified\". Unverified addresses may be safe to use. For example, Aadhaar card provides an address, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\".
+    attr_accessor :structured_postal_address
+
+    # The whole address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \"unverified\". The format of this will be different for each country. Refer to `StructuredPostalAddress` for a detailed version of the address.
+    attr_accessor :postal_address
+
+    # The details of the underlying document used to help create the Yoti credential
+    attr_accessor :document_details
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'remember_me_id' => :'rememberMeId',
+        :'email' => :'email',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'full_name' => :'fullName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'gender' => :'gender',
+        :'nationality' => :'nationality',
+        :'mobile_number' => :'mobileNumber',
+        :'structured_postal_address' => :'structuredPostalAddress',
+        :'postal_address' => :'postalAddress',
+        :'document_details' => :'documentDetails'
+      }
+    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
+      {
+        :'remember_me_id' => :'String',
+        :'email' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'full_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'gender' => :'String',
+        :'nationality' => :'String',
+        :'mobile_number' => :'String',
+        :'structured_postal_address' => :'YotiStructuredPostalAddress',
+        :'postal_address' => :'String',
+        :'document_details' => :'YotiDocumentDetails'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'remember_me_id',
+        :'email',
+        :'given_name',
+        :'family_name',
+        :'full_name',
+        :'date_of_birth',
+        :'gender',
+        :'nationality',
+        :'mobile_number',
+        :'structured_postal_address',
+        :'postal_address',
+        :'document_details'
+      ])
+    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::PostOfficeEasyIdProviderOutput` 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::PostOfficeEasyIdProviderOutput`. 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?(:'remember_me_id')
+        self.remember_me_id = attributes[:'remember_me_id']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      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?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      end
+
+      if attributes.key?(:'mobile_number')
+        self.mobile_number = attributes[:'mobile_number']
+      end
+
+      if attributes.key?(:'structured_postal_address')
+        self.structured_postal_address = attributes[:'structured_postal_address']
+      end
+
+      if attributes.key?(:'postal_address')
+        self.postal_address = attributes[:'postal_address']
+      end
+
+      if attributes.key?(:'document_details')
+        self.document_details = attributes[:'document_details']
+      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 &&
+          remember_me_id == o.remember_me_id &&
+          email == o.email &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          full_name == o.full_name &&
+          date_of_birth == o.date_of_birth &&
+          gender == o.gender &&
+          nationality == o.nationality &&
+          mobile_number == o.mobile_number &&
+          structured_postal_address == o.structured_postal_address &&
+          postal_address == o.postal_address &&
+          document_details == o.document_details
+    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
+      [remember_me_id, email, given_name, family_name, full_name, date_of_birth, gender, nationality, mobile_number, structured_postal_address, postal_address, document_details].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