trinsic_api 3.0.1 → 3.1.0.pre.preview1

data/lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb

@@ -0,0 +1,305 @@
+=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 `india-digilocker-aadhaar-fetch` Provider which do not directly map to the normalized IdentityData model.
+  class SignzyIndiaAadhaarFetchProviderOutput < ApiModelBase
+    # The document type from which the identity data was retrieved.
+    attr_accessor :document_type
+
+    # The timestamp when the signed document was generated and verified.
+    attr_accessor :timestamp
+
+    # The validity expiration timestamp for the verification document.
+    attr_accessor :time_to_live
+
+    # The Aadhaar number (UID) value for the individual.              This is only the last four digits of the Aadhaar number.
+    attr_accessor :aadhaar_number_last_four
+
+    # The claims extracted from the Aadhaar document.
+    attr_accessor :claims
+
+    # The localized claims extracted from the Aadhaar document.
+    attr_accessor :localized_claims
+
+    # Whether our own validation of the Aadhaar document signature and certificate chain succeeded.              When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain. When the document is not returned, the signature cannot be validated and this is false. Some providers (e.g. Signzy) also supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation.
+    attr_accessor :document_signature_validated
+
+    # DigiLocker's 36-character stable account identifier.              This identifier is deemed safe to use to reference the individual. *Note, the format is not guaranteed to be a UUID.
+    attr_accessor :digilocker_id
+
+    # The identifier for the issuer of the DigiLocker document.
+    attr_accessor :issuer_id
+
+    # Issuer name for the DigiLocker document.
+    attr_accessor :issuer
+
+    # The individual's mobile phone number from DigiLocker's account details.
+    attr_accessor :mobile_phone
+
+    # DigiLocker consent scopes that the individual actually consented to for this session. Included in provider output so customers can verify what was granted: the customer does not control these—the individual chooses scopes in the DigiLocker consent UI, and there is no way to pre-select or enforce them. This is a common source of error (e.g. the individual skips a scope), so surfacing the granted scopes lets customers confirm the session had the expected consent.
+    attr_accessor :scope
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'document_type' => :'documentType',
+        :'timestamp' => :'timestamp',
+        :'time_to_live' => :'timeToLive',
+        :'aadhaar_number_last_four' => :'aadhaarNumberLastFour',
+        :'claims' => :'claims',
+        :'localized_claims' => :'localizedClaims',
+        :'document_signature_validated' => :'documentSignatureValidated',
+        :'digilocker_id' => :'digilockerId',
+        :'issuer_id' => :'issuerId',
+        :'issuer' => :'issuer',
+        :'mobile_phone' => :'mobilePhone',
+        :'scope' => :'scope'
+      }
+    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
+      {
+        :'document_type' => :'String',
+        :'timestamp' => :'Time',
+        :'time_to_live' => :'Time',
+        :'aadhaar_number_last_four' => :'String',
+        :'claims' => :'AadhaarClaims',
+        :'localized_claims' => :'AadhaarLocalizedClaims',
+        :'document_signature_validated' => :'Boolean',
+        :'digilocker_id' => :'String',
+        :'issuer_id' => :'String',
+        :'issuer' => :'String',
+        :'mobile_phone' => :'String',
+        :'scope' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'document_type',
+        :'timestamp',
+        :'time_to_live',
+        :'aadhaar_number_last_four',
+        :'claims',
+        :'localized_claims',
+        :'digilocker_id',
+        :'issuer_id',
+        :'issuer',
+        :'mobile_phone',
+      ])
+    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::SignzyIndiaAadhaarFetchProviderOutput` 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::SignzyIndiaAadhaarFetchProviderOutput`. 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?(:'document_type')
+        self.document_type = attributes[:'document_type']
+      end
+
+      if attributes.key?(:'timestamp')
+        self.timestamp = attributes[:'timestamp']
+      end
+
+      if attributes.key?(:'time_to_live')
+        self.time_to_live = attributes[:'time_to_live']
+      end
+
+      if attributes.key?(:'aadhaar_number_last_four')
+        self.aadhaar_number_last_four = attributes[:'aadhaar_number_last_four']
+      end
+
+      if attributes.key?(:'claims')
+        self.claims = attributes[:'claims']
+      end
+
+      if attributes.key?(:'localized_claims')
+        self.localized_claims = attributes[:'localized_claims']
+      end
+
+      if attributes.key?(:'document_signature_validated')
+        self.document_signature_validated = attributes[:'document_signature_validated']
+      else
+        self.document_signature_validated = nil
+      end
+
+      if attributes.key?(:'digilocker_id')
+        self.digilocker_id = attributes[:'digilocker_id']
+      end
+
+      if attributes.key?(:'issuer_id')
+        self.issuer_id = attributes[:'issuer_id']
+      end
+
+      if attributes.key?(:'issuer')
+        self.issuer = attributes[:'issuer']
+      end
+
+      if attributes.key?(:'mobile_phone')
+        self.mobile_phone = attributes[:'mobile_phone']
+      end
+
+      if attributes.key?(:'scope')
+        if (value = attributes[:'scope']).is_a?(Array)
+          self.scope = value
+        end
+      else
+        self.scope = 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 @document_signature_validated.nil?
+        invalid_properties.push('invalid value for "document_signature_validated", document_signature_validated cannot be nil.')
+      end
+
+      if @scope.nil?
+        invalid_properties.push('invalid value for "scope", scope 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 @document_signature_validated.nil?
+      return false if @scope.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] document_signature_validated Value to be assigned
+    def document_signature_validated=(document_signature_validated)
+      if document_signature_validated.nil?
+        fail ArgumentError, 'document_signature_validated cannot be nil'
+      end
+
+      @document_signature_validated = document_signature_validated
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scope Value to be assigned
+    def scope=(scope)
+      if scope.nil?
+        fail ArgumentError, 'scope cannot be nil'
+      end
+
+      @scope = scope
+    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 &&
+          document_type == o.document_type &&
+          timestamp == o.timestamp &&
+          time_to_live == o.time_to_live &&
+          aadhaar_number_last_four == o.aadhaar_number_last_four &&
+          claims == o.claims &&
+          localized_claims == o.localized_claims &&
+          document_signature_validated == o.document_signature_validated &&
+          digilocker_id == o.digilocker_id &&
+          issuer_id == o.issuer_id &&
+          issuer == o.issuer &&
+          mobile_phone == o.mobile_phone &&
+          scope == o.scope
+    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
+      [document_type, timestamp, time_to_live, aadhaar_number_last_four, claims, localized_claims, document_signature_validated, digilocker_id, issuer_id, issuer, mobile_phone, scope].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/singpass_login_provider_output.rb

@@ -0,0 +1,216 @@
+=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 `singpass-login` Provider which do not directly map to the normalized IdentityData model.
+  class SingpassLoginProviderOutput < ApiModelBase
+    # The Singpass subject identifier.              This is a public identifier which is globally unique across the Singpass system.
+    attr_accessor :sub
+
+    # The Singpass account type for this user.              Possible values: - foreign (Singpass Foreign Account (SFA) holders) - standard (Singapore Citizens, Permanent Residents, or FIN holders)
+    attr_accessor :account_type
+
+    # The Unique Identifier Number (UINFIN) for the user.              The number can be either the National Registration Identity Card or Foreign Identification Number (NRIC/FIN). Follows the format @xxxxxxx#: - @ is the status of the holder.     - Singapore citizens and permanent residents born before 1 January 2000 are assigned the letter \"S\".     - Singapore citizens and permanent residents born on or after 1 January 2000 are assigned the letter \"T\".     - Foreigners issued with long-term passes before 1 January 2000 are assigned the letter \"F\".     - Foreigners issued with long-term passes from 1 January 2000 to 31 December 2021 are assigned the letter \"G\".     - Foreigners issued with long-term passes on or after 1 January 2022 are assigned the letter \"M\". - xxxxxxx is seven digit serial number. - # is the checksum letter.
+    attr_accessor :identity_number
+
+    # The individual's identity country of issuance.
+    attr_accessor :country_of_issuance
+
+    # The individual's principal name.
+    attr_accessor :name
+
+    # The individual's email address.
+    attr_accessor :email
+
+    # The individual's mobile number.              For Singpass Foreign Account (SFA) users, this will always be null.
+    attr_accessor :mobile_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sub' => :'sub',
+        :'account_type' => :'accountType',
+        :'identity_number' => :'identityNumber',
+        :'country_of_issuance' => :'countryOfIssuance',
+        :'name' => :'name',
+        :'email' => :'email',
+        :'mobile_number' => :'mobileNumber'
+      }
+    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',
+        :'account_type' => :'String',
+        :'identity_number' => :'String',
+        :'country_of_issuance' => :'String',
+        :'name' => :'String',
+        :'email' => :'String',
+        :'mobile_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sub',
+        :'account_type',
+        :'identity_number',
+        :'country_of_issuance',
+        :'name',
+        :'email',
+        :'mobile_number'
+      ])
+    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::SingpassLoginProviderOutput` 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::SingpassLoginProviderOutput`. 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?(:'account_type')
+        self.account_type = attributes[:'account_type']
+      end
+
+      if attributes.key?(:'identity_number')
+        self.identity_number = attributes[:'identity_number']
+      end
+
+      if attributes.key?(:'country_of_issuance')
+        self.country_of_issuance = attributes[:'country_of_issuance']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'mobile_number')
+        self.mobile_number = attributes[:'mobile_number']
+      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 &&
+          account_type == o.account_type &&
+          identity_number == o.identity_number &&
+          country_of_issuance == o.country_of_issuance &&
+          name == o.name &&
+          email == o.email &&
+          mobile_number == o.mobile_number
+    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, account_type, identity_number, country_of_issuance, name, email, mobile_number].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/singpass_my_info_description.rb

@@ -0,0 +1,160 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class SingpassMyInfoDescription < ApiModelBase
+    # The code for the following description.
+    attr_accessor :code
+
+    # The full description of the field.
+    attr_accessor :description
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'description' => :'description'
+      }
+    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
+      {
+        :'code' => :'String',
+        :'description' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'code',
+        :'description'
+      ])
+    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::SingpassMyInfoDescription` 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::SingpassMyInfoDescription`. 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?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      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 &&
+          code == o.code &&
+          description == o.description
+    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
+      [code, description].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