trinsic_api 3.1.0.pre.preview1 → 3.2.0

data/lib/trinsic_api/models/south_africa_nid_match2_sex_field.rb

@@ -0,0 +1,192 @@
+=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 SouthAfricaNidMatch2SexField < ApiModelBase
+    # The sex value submitted for this check.              Possible input values: - Male - Female
+    attr_accessor :input_value
+
+    # The outcome of comparing the submitted sex to the issuer record.              Possible values: - Exact Match - No Match - Not Provided - Not Returned
+    attr_accessor :outcome
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input_value' => :'inputValue',
+        :'outcome' => :'outcome'
+      }
+    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
+      {
+        :'input_value' => :'String',
+        :'outcome' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::SouthAfricaNidMatch2SexField` 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::SouthAfricaNidMatch2SexField`. 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?(:'input_value')
+        self.input_value = attributes[:'input_value']
+      else
+        self.input_value = nil
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      else
+        self.outcome = nil
+      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 @input_value.nil?
+        invalid_properties.push('invalid value for "input_value", input_value cannot be nil.')
+      end
+
+      if @outcome.nil?
+        invalid_properties.push('invalid value for "outcome", outcome 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 @input_value.nil?
+      return false if @outcome.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] input_value Value to be assigned
+    def input_value=(input_value)
+      if input_value.nil?
+        fail ArgumentError, 'input_value cannot be nil'
+      end
+
+      @input_value = input_value
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] outcome Value to be assigned
+    def outcome=(outcome)
+      if outcome.nil?
+        fail ArgumentError, 'outcome cannot be nil'
+      end
+
+      @outcome = outcome
+    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 &&
+          input_value == o.input_value &&
+          outcome == o.outcome
+    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
+      [input_value, outcome].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/uae_pass_provider_output.rb

@@ -0,0 +1,394 @@
+=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 `uae-pass` Provider which do not directly map to the normalized IdentityData model.
+  class UAEPassProviderOutput < ApiModelBase
+    # OIDC subject (`sub`) returned by UAE Pass.              This is an opaque identifier for the authenticated user in the UAE Pass OIDC transaction. It can be prefixed or unprefixed; do not parse this value or assume it matches the Emirates ID number, UAE Pass UUID, or UAE unified ID.
+    attr_accessor :sub
+
+    # Full name in Arabic.
+    attr_accessor :full_name_arabic
+
+    # Normalized sex parsed from the UAE Pass gender value.              Possible values: - Male - Female - Unknown - NotApplicable              This is null when the UAE Pass value cannot be parsed.
+    attr_accessor :gender
+
+    # Mobile number.
+    attr_accessor :mobile
+
+    # Last name in the Latin-script value returned by UAE Pass.
+    attr_accessor :last_name_english
+
+    # Full name in the Latin-script value returned by UAE Pass.
+    attr_accessor :full_name_english
+
+    # UAE Pass UUID.              The unique UAE Pass user identifier. It is separate from the OIDC subject identifier, Emirates ID number, and UAE unified ID.
+    attr_accessor :uae_pass_uuid
+
+    # SmartPass unique user identifier, if returned.              SmartPass was a previous UAE government single-sign-on identity system. UAE Pass can return this legacy identifier for SOP2 and SOP3 accounts that were verified through SmartPass.
+    attr_accessor :smart_pass_uuid
+
+    # Last name in Arabic.
+    attr_accessor :last_name_arabic
+
+    #  Verified Emirates ID number, if returned for the user profile type and scope.   The Emirates ID is issued by the Federal Authority for Identity, Citizenship, Customs and Port  Security (ICP). The number is a 15-digit identifier following the format 784-YYYY-NNNNNNN-C:  The number is a 15-digit identifier following the format 784-YYYY-NNNNNNN-C:  - 784: UAE ISO 3166-1 numeric country code.  - YYYY: A year value, which could be birth year, registration year, or another year value. This should      not be relied upon to infer birth or registration details.  - NNNNNNN: 7-digit random serial number for the individual.  - C: Check digit.   This field may not be returned for visitor profiles.
+    attr_accessor :emirates_id_number
+
+    # ID type.              Known values: - ID: Emirates ID or national identity document.              Returned for SOP2 and SOP3 citizen or resident profiles and SOP3 visitor profiles.
+    attr_accessor :id_type
+
+    # Nationality in the Latin-script value returned by UAE Pass.
+    attr_accessor :nationality_english
+
+    # First name in the Latin-script value returned by UAE Pass.
+    attr_accessor :first_name_english
+
+    # UAE Pass user type.              Possible values: - SOP1: Basic account. Unverified account with verified email and mobile number. - SOP2: Advanced account. Verified account with Emirates ID verification through SmartPass,     Dubai ID, or Emirates ID PIN registration. - SOP3: Qualified account. Verified account with Emirates ID verification through finger     biometrics or face biometrics.
+    attr_accessor :user_type
+
+    # Nationality in Arabic.
+    attr_accessor :nationality_arabic
+
+    # First name in Arabic.
+    attr_accessor :first_name_arabic
+
+    # Email address.
+    attr_accessor :email
+
+    # Title in the Latin-script value returned by UAE Pass.              Returned for SOP2 and SOP3 citizen or resident profiles and SOP3 visitor profiles.
+    attr_accessor :title_english
+
+    # Title in Arabic.              Returned for SOP2 and SOP3 citizen or resident profiles and SOP3 visitor profiles.
+    attr_accessor :title_arabic
+
+    # UAE Pass profile type, if returned for the requested scope.              Possible values: - 1: Citizen or resident profile. - 2: Visitor profile.
+    attr_accessor :profile_type
+
+    # UAE unified ID, if returned for the requested scope.              A unique ID for the user. It is separate from the Emirates ID number, UAE Pass UUID, and OIDC subject identifier.
+    attr_accessor :unified_id
+
+    # UAE Pass authentication assurance level, if present.              This classifies the authentication policy that was satisfied for the session. Known values include: - urn:safelayer:tws:policies:authentication:level:low - urn:safelayer:tws:policies:authentication:level:high
+    attr_accessor :authentication_assurance_level
+
+    # UAE Pass authentication methods, if present.              This classifies the concrete methods used during authentication. Known values include: - urn:safelayer:tws:policies:authentication:adaptive:methods:mobileid - urn:uae:authentication:method:verified - urn:oasis:names:tc:SAML:1:0:am:password
+    attr_accessor :authentication_methods
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sub' => :'sub',
+        :'full_name_arabic' => :'fullNameArabic',
+        :'gender' => :'gender',
+        :'mobile' => :'mobile',
+        :'last_name_english' => :'lastNameEnglish',
+        :'full_name_english' => :'fullNameEnglish',
+        :'uae_pass_uuid' => :'uaePassUuid',
+        :'smart_pass_uuid' => :'smartPassUuid',
+        :'last_name_arabic' => :'lastNameArabic',
+        :'emirates_id_number' => :'emiratesIdNumber',
+        :'id_type' => :'idType',
+        :'nationality_english' => :'nationalityEnglish',
+        :'first_name_english' => :'firstNameEnglish',
+        :'user_type' => :'userType',
+        :'nationality_arabic' => :'nationalityArabic',
+        :'first_name_arabic' => :'firstNameArabic',
+        :'email' => :'email',
+        :'title_english' => :'titleEnglish',
+        :'title_arabic' => :'titleArabic',
+        :'profile_type' => :'profileType',
+        :'unified_id' => :'unifiedId',
+        :'authentication_assurance_level' => :'authenticationAssuranceLevel',
+        :'authentication_methods' => :'authenticationMethods'
+      }
+    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
+      {
+        :'sub' => :'String',
+        :'full_name_arabic' => :'String',
+        :'gender' => :'String',
+        :'mobile' => :'String',
+        :'last_name_english' => :'String',
+        :'full_name_english' => :'String',
+        :'uae_pass_uuid' => :'String',
+        :'smart_pass_uuid' => :'String',
+        :'last_name_arabic' => :'String',
+        :'emirates_id_number' => :'String',
+        :'id_type' => :'String',
+        :'nationality_english' => :'String',
+        :'first_name_english' => :'String',
+        :'user_type' => :'String',
+        :'nationality_arabic' => :'String',
+        :'first_name_arabic' => :'String',
+        :'email' => :'String',
+        :'title_english' => :'String',
+        :'title_arabic' => :'String',
+        :'profile_type' => :'Integer',
+        :'unified_id' => :'String',
+        :'authentication_assurance_level' => :'String',
+        :'authentication_methods' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sub',
+        :'full_name_arabic',
+        :'gender',
+        :'mobile',
+        :'last_name_english',
+        :'full_name_english',
+        :'uae_pass_uuid',
+        :'smart_pass_uuid',
+        :'last_name_arabic',
+        :'emirates_id_number',
+        :'id_type',
+        :'nationality_english',
+        :'first_name_english',
+        :'user_type',
+        :'nationality_arabic',
+        :'first_name_arabic',
+        :'email',
+        :'title_english',
+        :'title_arabic',
+        :'profile_type',
+        :'unified_id',
+        :'authentication_assurance_level',
+        :'authentication_methods'
+      ])
+    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::UAEPassProviderOutput` 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::UAEPassProviderOutput`. 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?(:'sub')
+        self.sub = attributes[:'sub']
+      end
+
+      if attributes.key?(:'full_name_arabic')
+        self.full_name_arabic = attributes[:'full_name_arabic']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'mobile')
+        self.mobile = attributes[:'mobile']
+      end
+
+      if attributes.key?(:'last_name_english')
+        self.last_name_english = attributes[:'last_name_english']
+      end
+
+      if attributes.key?(:'full_name_english')
+        self.full_name_english = attributes[:'full_name_english']
+      end
+
+      if attributes.key?(:'uae_pass_uuid')
+        self.uae_pass_uuid = attributes[:'uae_pass_uuid']
+      end
+
+      if attributes.key?(:'smart_pass_uuid')
+        self.smart_pass_uuid = attributes[:'smart_pass_uuid']
+      end
+
+      if attributes.key?(:'last_name_arabic')
+        self.last_name_arabic = attributes[:'last_name_arabic']
+      end
+
+      if attributes.key?(:'emirates_id_number')
+        self.emirates_id_number = attributes[:'emirates_id_number']
+      end
+
+      if attributes.key?(:'id_type')
+        self.id_type = attributes[:'id_type']
+      end
+
+      if attributes.key?(:'nationality_english')
+        self.nationality_english = attributes[:'nationality_english']
+      end
+
+      if attributes.key?(:'first_name_english')
+        self.first_name_english = attributes[:'first_name_english']
+      end
+
+      if attributes.key?(:'user_type')
+        self.user_type = attributes[:'user_type']
+      end
+
+      if attributes.key?(:'nationality_arabic')
+        self.nationality_arabic = attributes[:'nationality_arabic']
+      end
+
+      if attributes.key?(:'first_name_arabic')
+        self.first_name_arabic = attributes[:'first_name_arabic']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'title_english')
+        self.title_english = attributes[:'title_english']
+      end
+
+      if attributes.key?(:'title_arabic')
+        self.title_arabic = attributes[:'title_arabic']
+      end
+
+      if attributes.key?(:'profile_type')
+        self.profile_type = attributes[:'profile_type']
+      end
+
+      if attributes.key?(:'unified_id')
+        self.unified_id = attributes[:'unified_id']
+      end
+
+      if attributes.key?(:'authentication_assurance_level')
+        self.authentication_assurance_level = attributes[:'authentication_assurance_level']
+      end
+
+      if attributes.key?(:'authentication_methods')
+        if (value = attributes[:'authentication_methods']).is_a?(Array)
+          self.authentication_methods = 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
+      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 &&
+          sub == o.sub &&
+          full_name_arabic == o.full_name_arabic &&
+          gender == o.gender &&
+          mobile == o.mobile &&
+          last_name_english == o.last_name_english &&
+          full_name_english == o.full_name_english &&
+          uae_pass_uuid == o.uae_pass_uuid &&
+          smart_pass_uuid == o.smart_pass_uuid &&
+          last_name_arabic == o.last_name_arabic &&
+          emirates_id_number == o.emirates_id_number &&
+          id_type == o.id_type &&
+          nationality_english == o.nationality_english &&
+          first_name_english == o.first_name_english &&
+          user_type == o.user_type &&
+          nationality_arabic == o.nationality_arabic &&
+          first_name_arabic == o.first_name_arabic &&
+          email == o.email &&
+          title_english == o.title_english &&
+          title_arabic == o.title_arabic &&
+          profile_type == o.profile_type &&
+          unified_id == o.unified_id &&
+          authentication_assurance_level == o.authentication_assurance_level &&
+          authentication_methods == o.authentication_methods
+    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
+      [sub, full_name_arabic, gender, mobile, last_name_english, full_name_english, uae_pass_uuid, smart_pass_uuid, last_name_arabic, emirates_id_number, id_type, nationality_english, first_name_english, user_type, nationality_arabic, first_name_arabic, email, title_english, title_arabic, profile_type, unified_id, authentication_assurance_level, authentication_methods].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