trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/verification_profile_response.rb

@@ -33,6 +33,9 @@ module TrinsicApi
     # The providers that are currently enabled for the verification profile.
     attr_accessor :enabled_providers
 
+    # Whether this profile is for production usage. Only applicable for Live environment profiles.
+    attr_accessor :is_production_usage
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,7 +44,8 @@ module TrinsicApi
         :'brand_name' => :'brandName',
         :'logo_url' => :'logoUrl',
         :'primary_color' => :'primaryColor',
-        :'enabled_providers' => :'enabledProviders'
+        :'enabled_providers' => :'enabledProviders',
+        :'is_production_usage' => :'isProductionUsage'
       }
     end
 
@@ -63,7 +67,8 @@ module TrinsicApi
         :'brand_name' => :'String',
         :'logo_url' => :'String',
         :'primary_color' => :'String',
-        :'enabled_providers' => :'Array<String>'
+        :'enabled_providers' => :'Array<String>',
+        :'is_production_usage' => :'Boolean'
       }
     end
 
@@ -126,6 +131,12 @@ module TrinsicApi
       else
         self.enabled_providers = nil
       end
+
+      if attributes.key?(:'is_production_usage')
+        self.is_production_usage = attributes[:'is_production_usage']
+      else
+        self.is_production_usage = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -157,6 +168,10 @@ module TrinsicApi
         invalid_properties.push('invalid value for "enabled_providers", enabled_providers cannot be nil.')
       end
 
+      if @is_production_usage.nil?
+        invalid_properties.push('invalid value for "is_production_usage", is_production_usage cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -170,6 +185,7 @@ module TrinsicApi
       return false if @logo_url.nil?
       return false if @primary_color.nil?
       return false if @enabled_providers.nil?
+      return false if @is_production_usage.nil?
       true
     end
 
@@ -233,6 +249,16 @@ module TrinsicApi
       @enabled_providers = enabled_providers
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] is_production_usage Value to be assigned
+    def is_production_usage=(is_production_usage)
+      if is_production_usage.nil?
+        fail ArgumentError, 'is_production_usage cannot be nil'
+      end
+
+      @is_production_usage = is_production_usage
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -243,7 +269,8 @@ module TrinsicApi
           brand_name == o.brand_name &&
           logo_url == o.logo_url &&
           primary_color == o.primary_color &&
-          enabled_providers == o.enabled_providers
+          enabled_providers == o.enabled_providers &&
+          is_production_usage == o.is_production_usage
     end
 
     # @see the `==` method
@@ -255,7 +282,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, _alias, brand_name, logo_url, primary_color, enabled_providers].hash
+      [id, _alias, brand_name, logo_url, primary_color, enabled_providers, is_production_usage].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/yoti_document_details.rb

@@ -0,0 +1,266 @@
+=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
+  class YotiDocumentDetails
+    # The type of document used to create the Yoti credential.              Possible values: - PASSPORT: A government-issued identity document - DRIVING_LICENCE: A government-issued identity card - NATIONAL_ID: A government-issued identity card - PASS_CARD: A physical or digital identity card that is accredited by the UK's national Proof of Age Standards Scheme (PASS)
+    attr_accessor :type
+
+    # The issuing country's ISO alpha-3 code
+    attr_accessor :issuing_country
+
+    # The arbitrary document number for the provided document type
+    attr_accessor :document_number
+
+    # The document's expiration date in YYYY-MM-DD format
+    attr_accessor :expiration_date
+
+    # The document's issuing authority. This can either be a country code as a specified ISO alpha-3 or the name of the issuing authority.
+    attr_accessor :issuing_authority
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'issuing_country' => :'issuingCountry',
+        :'document_number' => :'documentNumber',
+        :'expiration_date' => :'expirationDate',
+        :'issuing_authority' => :'issuingAuthority'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'issuing_country' => :'String',
+        :'document_number' => :'String',
+        :'expiration_date' => :'Date',
+        :'issuing_authority' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'type',
+        :'issuing_country',
+        :'document_number',
+        :'expiration_date',
+        :'issuing_authority'
+      ])
+    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::YotiDocumentDetails` 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::YotiDocumentDetails`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'issuing_country')
+        self.issuing_country = attributes[:'issuing_country']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      end
+
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
+      end
+
+      if attributes.key?(:'issuing_authority')
+        self.issuing_authority = attributes[:'issuing_authority']
+      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 &&
+          type == o.type &&
+          issuing_country == o.issuing_country &&
+          document_number == o.document_number &&
+          expiration_date == o.expiration_date &&
+          issuing_authority == o.issuing_authority
+    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
+      [type, issuing_country, document_number, expiration_date, issuing_authority].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/yoti_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 `yoti` Provider which do not directly map to the normalized IdentityData model.
+  class YotiProviderOutput
+    # 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::YotiProviderOutput` 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::YotiProviderOutput`. 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