trinsic_api 3.0.2.pre.preview → 3.1.0.pre.preview1

data/lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb

@@ -0,0 +1,334 @@
+=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 `cote-divoire-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model.
+  class CoteDIvoireNidLookup2ProviderOutput < ApiModelBase
+    # Full name as returned by ONECI (National Civil Registry and Identification Office).
+    attr_accessor :full_name
+
+    # Given name of the ID holder as returned by ONECI (National Civil Registry and Identification Office).
+    attr_accessor :given_name
+
+    # Family name of the ID holder as returned by ONECI (National Civil Registry and Identification Office).
+    attr_accessor :family_name
+
+    # Date of birth as returned by ONECI (National Civil Registry and Identification Office).
+    attr_accessor :date_of_birth
+
+    # Sex of the ID holder as returned by ONECI (National Civil Registry and Identification Office). Possible values: - Male - Female
+    attr_accessor :sex
+
+    # Nationality as ISO 3166-1 alpha-2 country code (e.g. \"CI\" for Côte d'Ivoire).
+    attr_accessor :nationality
+
+    # Address as returned from ONECI (National Civil Registry and Identification Office). Format is LOCALITY,COMMUNE: the locality (village, neighborhood, or sous-quartier) followed by the commune. Not a full street address.
+    attr_accessor :address
+
+    # The document's own identifier (printed on the card; often labeled \"Immatriculation\" on older cards or \"Numéro CNI\" in post-2020 cards). On older cards this is usually one letter followed by 10 digits. On new cards it appears as 1 or 2 leading letters plus 9 digits.
+    attr_accessor :document_number
+
+    # The NNI (Numéro National d'Identification): the person's 11-digit national ID, printed on the back of the new national id card and assigned by ONECI. It is always exactly 11 digits with no letters, and is semi-random, non-repetitive, and does not encode any extra data, such as date of birth, gender, or other readable attributes.
+    attr_accessor :national_id_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'full_name' => :'fullName',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'sex' => :'sex',
+        :'nationality' => :'nationality',
+        :'address' => :'address',
+        :'document_number' => :'documentNumber',
+        :'national_id_number' => :'nationalIdNumber'
+      }
+    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
+      {
+        :'full_name' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'sex' => :'String',
+        :'nationality' => :'String',
+        :'address' => :'String',
+        :'document_number' => :'String',
+        :'national_id_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'address',
+        :'document_number',
+        :'national_id_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::CoteDIvoireNidLookup2ProviderOutput` 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::CoteDIvoireNidLookup2ProviderOutput`. 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?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      else
+        self.full_name = nil
+      end
+
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      else
+        self.given_name = nil
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      else
+        self.family_name = nil
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      else
+        self.date_of_birth = nil
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      else
+        self.sex = nil
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      else
+        self.nationality = nil
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      end
+
+      if attributes.key?(:'national_id_number')
+        self.national_id_number = attributes[:'national_id_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
+      if @full_name.nil?
+        invalid_properties.push('invalid value for "full_name", full_name cannot be nil.')
+      end
+
+      if @given_name.nil?
+        invalid_properties.push('invalid value for "given_name", given_name cannot be nil.')
+      end
+
+      if @family_name.nil?
+        invalid_properties.push('invalid value for "family_name", family_name cannot be nil.')
+      end
+
+      if @date_of_birth.nil?
+        invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
+      end
+
+      if @sex.nil?
+        invalid_properties.push('invalid value for "sex", sex cannot be nil.')
+      end
+
+      if @nationality.nil?
+        invalid_properties.push('invalid value for "nationality", nationality 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 @full_name.nil?
+      return false if @given_name.nil?
+      return false if @family_name.nil?
+      return false if @date_of_birth.nil?
+      return false if @sex.nil?
+      return false if @nationality.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] full_name Value to be assigned
+    def full_name=(full_name)
+      if full_name.nil?
+        fail ArgumentError, 'full_name cannot be nil'
+      end
+
+      @full_name = full_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] given_name Value to be assigned
+    def given_name=(given_name)
+      if given_name.nil?
+        fail ArgumentError, 'given_name cannot be nil'
+      end
+
+      @given_name = given_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] family_name Value to be assigned
+    def family_name=(family_name)
+      if family_name.nil?
+        fail ArgumentError, 'family_name cannot be nil'
+      end
+
+      @family_name = family_name
+    end
+
+    # Custom attribute writer method with validation
+    # @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
+
+      @date_of_birth = date_of_birth
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sex Value to be assigned
+    def sex=(sex)
+      if sex.nil?
+        fail ArgumentError, 'sex cannot be nil'
+      end
+
+      @sex = sex
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] nationality Value to be assigned
+    def nationality=(nationality)
+      if nationality.nil?
+        fail ArgumentError, 'nationality cannot be nil'
+      end
+
+      @nationality = nationality
+    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 &&
+          full_name == o.full_name &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          date_of_birth == o.date_of_birth &&
+          sex == o.sex &&
+          nationality == o.nationality &&
+          address == o.address &&
+          document_number == o.document_number &&
+          national_id_number == o.national_id_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
+      [full_name, given_name, family_name, date_of_birth, sex, nationality, address, document_number, national_id_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/create_direct_provider_session_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.13.0
+Generator version: 7.21.0
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class CreateDirectProviderSessionRequest
+  class CreateDirectProviderSessionRequest < ApiModelBase
     # The ID of the provider to launch
     attr_accessor :provider
 
@@ -30,6 +30,9 @@ module TrinsicApi
     # Whether the session should fall back to a Trinsic-hosted UI in certain instances.              Specifically, fallback will occur if any of the following are true: - You attempted to launch a provider which requires a capability you did not express support for     - In this case, Trinsic's hosted UI will perform the necessary capability - You attempted to launch a provider which requires input, and the input was either not provided or incomplete     - In this case, Trinsic's hosted UI will collect the necessary input from the user              If fallback occurs, the session's NextStep will always be LaunchBrowser, and the CollectionMethod will always be CaptureRedirect.              If this field is set to `true`, you must also: 1. Set the `RedirectUrl` field to a non-empty value 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field
     attr_accessor :fallback_to_hosted_ui
 
+    # Preferences for languages to show first if the session falls back to the Trinsic-hosted UI. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English. This only will be used if the session falls back to the Trinsic-hosted UI.
+    attr_accessor :browser_languages
+
     # Provider-specific input for those providers which require it.
     attr_accessor :provider_input
 
@@ -41,6 +44,7 @@ module TrinsicApi
         :'redirect_url' => :'redirectUrl',
         :'capabilities' => :'capabilities',
         :'fallback_to_hosted_ui' => :'fallbackToHostedUI',
+        :'browser_languages' => :'browserLanguages',
         :'provider_input' => :'providerInput'
       }
     end
@@ -63,6 +67,7 @@ module TrinsicApi
         :'redirect_url' => :'String',
         :'capabilities' => :'Array<IntegrationCapability>',
         :'fallback_to_hosted_ui' => :'Boolean',
+        :'browser_languages' => :'Array<String>',
         :'provider_input' => :'ProviderInput'
       }
     end
@@ -72,6 +77,7 @@ module TrinsicApi
       Set.new([
         :'redirect_url',
         :'fallback_to_hosted_ui',
+        :'browser_languages',
         :'provider_input'
       ])
     end
@@ -120,6 +126,12 @@ module TrinsicApi
         self.fallback_to_hosted_ui = attributes[:'fallback_to_hosted_ui']
       end
 
+      if attributes.key?(:'browser_languages')
+        if (value = attributes[:'browser_languages']).is_a?(Array)
+          self.browser_languages = value
+        end
+      end
+
       if attributes.key?(:'provider_input')
         self.provider_input = attributes[:'provider_input']
       end
@@ -135,7 +147,7 @@ module TrinsicApi
       end
 
       if @provider.to_s.length < 1
-        invalid_properties.push('invalid value for "provider", the character length must be great than or equal to 1.')
+        invalid_properties.push('invalid value for "provider", the character length must be greater than or equal to 1.')
       end
 
       if @verification_profile_id.nil?
@@ -173,7 +185,7 @@ module TrinsicApi
       end
 
       if provider.to_s.length < 1
-        fail ArgumentError, 'invalid value for "provider", the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "provider", the character length must be greater than or equal to 1.'
       end
 
       @provider = provider
@@ -213,6 +225,7 @@ module TrinsicApi
           redirect_url == o.redirect_url &&
           capabilities == o.capabilities &&
           fallback_to_hosted_ui == o.fallback_to_hosted_ui &&
+          browser_languages == o.browser_languages &&
           provider_input == o.provider_input
     end
 
@@ -225,7 +238,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [provider, verification_profile_id, redirect_url, capabilities, fallback_to_hosted_ui, provider_input].hash
+      [provider, verification_profile_id, redirect_url, capabilities, fallback_to_hosted_ui, browser_languages, provider_input].hash
     end
 
     # Builds the object from hash
@@ -251,61 +264,6 @@ module TrinsicApi
       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
@@ -322,24 +280,6 @@ module TrinsicApi
       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/create_direct_provider_session_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.13.0
+Generator version: 7.21.0
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class CreateDirectProviderSessionResponse
+  class CreateDirectProviderSessionResponse < ApiModelBase
     # The ID of the newly-created Acceptance Session
     attr_accessor :session_id
 
@@ -198,61 +198,6 @@ module TrinsicApi
       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
@@ -269,24 +214,6 @@ module TrinsicApi
       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