trinsic_api 1.2.0 → 2.0.0

data/lib/trinsic_api/models/result_collection.rb

@@ -0,0 +1,261 @@
+=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.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class ResultCollection
+    # The method by which the results of the Acceptance Session should be collected.
+    attr_accessor :method
+
+    # The `resultsAccessKey` for the Acceptance Session.              This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.              Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.              Trinsic cannot access a Session's Data Vault without this key.
+    attr_accessor :results_access_key
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'method' => :'method',
+        :'results_access_key' => :'resultsAccessKey'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'method' => :'ResultCollectionMethod',
+        :'results_access_key' => :'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::ResultCollection` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::ResultCollection`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
+      else
+        self.method = nil
+      end
+
+      if attributes.key?(:'results_access_key')
+        self.results_access_key = attributes[:'results_access_key']
+      else
+        self.results_access_key = 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 @method.nil?
+        invalid_properties.push('invalid value for "method", method cannot be nil.')
+      end
+
+      if @results_access_key.nil?
+        invalid_properties.push('invalid value for "results_access_key", results_access_key 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 @method.nil?
+      return false if @results_access_key.nil?
+      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 &&
+          method == o.method &&
+          results_access_key == o.results_access_key
+    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
+      [method, results_access_key].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/result_collection_method.rb

@@ -0,0 +1,40 @@
+=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.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class ResultCollectionMethod
+    POLL_RESULT = "PollResult".freeze
+    CAPTURE_REDIRECT = "CaptureRedirect".freeze
+
+    def self.all_vars
+      @all_vars ||= [POLL_RESULT, CAPTURE_REDIRECT].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if ResultCollectionMethod.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ResultCollectionMethod"
+    end
+  end
+end

data/lib/trinsic_api/models/session.rb

@@ -1,5 +1,5 @@
 =begin
-#Connect API
+#Trinsic API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
@@ -17,17 +17,14 @@ module TrinsicApi
   class Session
     attr_accessor :id
 
-    # The state of the session
-    attr_accessor :state
+    # Whether the Session is in a terminal / final state.              If this is `true`, inspect the value of `Success` to determine whether the Session was successful.
+    attr_accessor :done
 
-    # If the session is in state `IdvFailed`, this field contains the reason for failure.
-    attr_accessor :fail_code
+    # Whether the Session has completed successfully.              If this is `false`, the Session is either not yet done, or has failed. Inspect `Done` and `ErrorCode` for more information. If this is `true`, the Session has completed successfully.
+    attr_accessor :success
 
-    # The underlying verification for this Session
-    attr_accessor :verification
-
-    # The fields that were requested to be disclosed when the Session was created
-    attr_accessor :disclosed_fields
+    # The reason for the Session's failure.              Only present if `Success` is `false`.
+    attr_accessor :error_code
 
     # The unix timestamp, in seconds, when this session was created
     attr_accessor :created
@@ -61,10 +58,9 @@ module TrinsicApi
     def self.attribute_map
       {
         :'id' => :'id',
-        :'state' => :'state',
-        :'fail_code' => :'failCode',
-        :'verification' => :'verification',
-        :'disclosed_fields' => :'disclosedFields',
+        :'done' => :'done',
+        :'success' => :'success',
+        :'error_code' => :'errorCode',
         :'created' => :'created',
         :'updated' => :'updated'
       }
@@ -79,10 +75,9 @@ module TrinsicApi
     def self.openapi_types
       {
         :'id' => :'String',
-        :'state' => :'SessionState',
-        :'fail_code' => :'SessionFailCode',
-        :'verification' => :'Verification',
-        :'disclosed_fields' => :'DisclosedFields',
+        :'done' => :'Boolean',
+        :'success' => :'Boolean',
+        :'error_code' => :'SessionErrorCode',
         :'created' => :'Integer',
         :'updated' => :'Integer'
       }
@@ -91,6 +86,7 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'error_code',
       ])
     end
 
@@ -115,26 +111,20 @@ module TrinsicApi
         self.id = nil
       end
 
-      if attributes.key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'done')
+        self.done = attributes[:'done']
       else
-        self.state = nil
-      end
-
-      if attributes.key?(:'fail_code')
-        self.fail_code = attributes[:'fail_code']
+        self.done = nil
       end
 
-      if attributes.key?(:'verification')
-        self.verification = attributes[:'verification']
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
       else
-        self.verification = nil
+        self.success = nil
       end
 
-      if attributes.key?(:'disclosed_fields')
-        self.disclosed_fields = attributes[:'disclosed_fields']
-      else
-        self.disclosed_fields = nil
+      if attributes.key?(:'error_code')
+        self.error_code = attributes[:'error_code']
       end
 
       if attributes.key?(:'created')
@@ -159,16 +149,12 @@ module TrinsicApi
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @state.nil?
-        invalid_properties.push('invalid value for "state", state cannot be nil.')
-      end
-
-      if @verification.nil?
-        invalid_properties.push('invalid value for "verification", verification cannot be nil.')
+      if @done.nil?
+        invalid_properties.push('invalid value for "done", done cannot be nil.')
       end
 
-      if @disclosed_fields.nil?
-        invalid_properties.push('invalid value for "disclosed_fields", disclosed_fields cannot be nil.')
+      if @success.nil?
+        invalid_properties.push('invalid value for "success", success cannot be nil.')
       end
 
       if @created.nil?
@@ -187,9 +173,8 @@ module TrinsicApi
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
-      return false if @state.nil?
-      return false if @verification.nil?
-      return false if @disclosed_fields.nil?
+      return false if @done.nil?
+      return false if @success.nil?
       return false if @created.nil?
       return false if @updated.nil?
       true
@@ -201,10 +186,9 @@ module TrinsicApi
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          state == o.state &&
-          fail_code == o.fail_code &&
-          verification == o.verification &&
-          disclosed_fields == o.disclosed_fields &&
+          done == o.done &&
+          success == o.success &&
+          error_code == o.error_code &&
           created == o.created &&
           updated == o.updated
     end
@@ -218,7 +202,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, state, fail_code, verification, disclosed_fields, created, updated].hash
+      [id, done, success, error_code, created, updated].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/session_error_code.rb

@@ -0,0 +1,48 @@
+=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.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class SessionErrorCode
+    INTERNAL = "Internal".freeze
+    OTHER = "Other".freeze
+    CANCELED = "Canceled".freeze
+    USER_ABANDONED = "UserAbandoned".freeze
+    USER_TIMED_OUT = "UserTimedOut".freeze
+    EXPIRED = "Expired".freeze
+    INVALID_IMAGE = "InvalidImage".freeze
+    INAUTHENTIC = "Inauthentic".freeze
+    UNSUPPORTED_DOCUMENT = "UnsupportedDocument".freeze
+    ASSURANCE_LEVEL_NOT_MET = "AssuranceLevelNotMet".freeze
+
+    def self.all_vars
+      @all_vars ||= [INTERNAL, OTHER, CANCELED, USER_ABANDONED, USER_TIMED_OUT, EXPIRED, INVALID_IMAGE, INAUTHENTIC, UNSUPPORTED_DOCUMENT, ASSURANCE_LEVEL_NOT_MET].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if SessionErrorCode.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #SessionErrorCode"
+    end
+  end
+end

data/lib/trinsic_api/models/session_ordering.rb

@@ -1,5 +1,5 @@
 =begin
-#Connect API
+#Trinsic API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 

data/lib/trinsic_api/models/sex.rb

@@ -0,0 +1,42 @@
+=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.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class Sex
+    UNKNOWN = "Unknown".freeze
+    NOT_APPLICABLE = "NotApplicable".freeze
+    MALE = "Male".freeze
+    FEMALE = "Female".freeze
+
+    def self.all_vars
+      @all_vars ||= [UNKNOWN, NOT_APPLICABLE, MALE, FEMALE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if Sex.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #Sex"
+    end
+  end
+end