passbase 1.0.0 → 1.2.0

data/lib/passbase/api_client.rb

@@ -30,7 +30,7 @@ module Passbase
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "passbase/ruby@1.0.0"
+      @user_agent = "passbase/ruby@1.2.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/passbase/models/identity.rb

@@ -20,6 +20,11 @@ module Passbase
     # Current state of the identity in Passbase's systems
     attr_accessor :status
 
+    attr_accessor :owner
+
+    # Float between 0 and 1 representing our confidence that this identity is valid. 0 meaning we couldn't verify any of the information provided with accuracy, and 1 absolute confidence.
+    attr_accessor :score
+
     # Unix-timestamp of when the identity was created
     attr_accessor :created
 
@@ -58,6 +63,8 @@ module Passbase
       {
         :'id' => :'id',
         :'status' => :'status',
+        :'owner' => :'owner',
+        :'score' => :'score',
         :'created' => :'created',
         :'updated' => :'updated',
         :'resources' => :'resources',
@@ -70,6 +77,8 @@ module Passbase
       {
         :'id' => :'String',
         :'status' => :'String',
+        :'owner' => :'IdentityOwner',
+        :'score' => :'Float',
         :'created' => :'Integer',
         :'updated' => :'Integer',
         :'resources' => :'Array<IdentityResource>',
@@ -106,6 +115,14 @@ module Passbase
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'owner')
+        self.owner = attributes[:'owner']
+      end
+
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
+      end
+
       if attributes.key?(:'created')
         self.created = attributes[:'created']
       end
@@ -157,6 +174,8 @@ module Passbase
       self.class == o.class &&
           id == o.id &&
           status == o.status &&
+          owner == o.owner &&
+          score == o.score &&
           created == o.created &&
           updated == o.updated &&
           resources == o.resources &&
@@ -172,7 +191,7 @@ module Passbase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, status, created, updated, resources, watchlist].hash
+      [id, status, owner, score, created, updated, resources, watchlist].hash
     end
 
     # Builds the object from hash

data/lib/passbase/models/identity_owner.rb

@@ -0,0 +1,229 @@
+=begin
+#Verification API
+
+## Introduction  <span class=\"subtext\"> Welcome to the Passbase Verifications API docs. This documentation will help you understand our models and the Verification API with its endpoints. Based on this you can build your own system (i.e. verification) and hook it up to Passbase.  In case of feedback or questions you can reach us under this email address: [developer@passbase.com](mailto:developer@passbase.com). </span>  A User submits a video selfie and valid identifying __Resources__ during a __Verification__ guided by the Passbase client-side integration. Once all the necessary __Resources__ are submitted, __Data points__ are extracted, digitized, and authenticated. These Data points then becomes part of the User's __Identity__. The User then consents to share __Resources__ and/or __Data points__ from their Identity with you. This information is passed to you and can be used to make decisions about a User (e.g. activate account). This table below explains our terminology further.  | Term                                    | Description | |-----------------------------------------|-------------| | [Identity](#tag/identity_model)         | A set of Data points and Resources related to and owned by one single User. This data can be accessed by you through a Verification. | | Data points                             | Any data about a User extracted from a Resource (E.g. Passport Number, or Age). | | [Resource](#tag/resource_model)         | A source document used to generate the Data points for a User (E.g. Passport). | | [User](#tag/user_model)                 | The owner of an email address associated with an Identity. | | Verification                            | A transaction through which a User consents to share Data points with you. If the Data points you request are not already available in the User's Identity, the Passbase client will ask the User to submit the necessary Resource required to extract them. | | Re-authentication (login)               | A transaction through which a User can certify the ownership of Personal data previously shared through an Authentication. |   # Authentication  <span class=\"subtext\"> There are two forms of authentication for the API: <br/>&bull; API Key <br/>&bull; Bearer JWT Token  </span> 
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module Passbase
+  class IdentityOwner
+    # Email of the user the identity belongs to
+    attr_accessor :email
+
+    # First name of the user the identity belongs to
+    attr_accessor :first_name
+
+    # Last name of the user the identity belongs to
+    attr_accessor :last_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'email' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'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 `Passbase::IdentityOwner` 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 `Passbase::IdentityOwner`. 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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      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
+      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?
+      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 &&
+          email == o.email &&
+          first_name == o.first_name &&
+          last_name == o.last_name
+    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
+      [email, first_name, last_name].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        Passbase.const_get(type).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/passbase/models/identity_resource.rb

@@ -17,6 +17,7 @@ module Passbase
     # Dynamic key/value hashmap of the data extracted from the resource. 
     attr_accessor :datapoints
 
+    # All resource types that passbase supports
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -31,7 +32,7 @@ module Passbase
     def self.openapi_types
       {
         :'datapoints' => :'Object',
-        :'type' => :'ResourceType'
+        :'type' => :'String'
       }
     end
 

data/lib/passbase/models/project_settings.rb

@@ -17,7 +17,7 @@ module Passbase
     # Unique ID of the project
     attr_accessor :id
 
-    # slugs are meant to be a way to verify people just with the link
+    # Slugs are meant to be a way to verify people just with the link
     attr_accessor :slug
 
     attr_accessor :environment

data/lib/passbase/models/project_settings_customizations.rb

@@ -24,28 +24,6 @@ module Passbase
     # Font used in the verification flow
     attr_accessor :font_family
 
-    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
       {
@@ -108,21 +86,9 @@ module Passbase
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      font_family_validator = EnumAttributeValidator.new('String', ["Arial", "Exo", "Open Sans", "Lato", "Baskerville"])
-      return false unless font_family_validator.valid?(@font_family)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] font_family Object to be assigned
-    def font_family=(font_family)
-      validator = EnumAttributeValidator.new('String', ["Arial", "Exo", "Open Sans", "Lato", "Baskerville"])
-      unless validator.valid?(font_family)
-        fail ArgumentError, "invalid value for \"font_family\", must be one of #{validator.allowable_values}."
-      end
-      @font_family = font_family
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/passbase/models/project_settings_verification_steps.rb

@@ -30,7 +30,7 @@ module Passbase
     def self.openapi_types
       {
         :'step' => :'String',
-        :'resource_types' => :'Array<ResourceType>'
+        :'resource_types' => :'Array<String>'
       }
     end
 

data/lib/passbase/models/resource.rb

@@ -26,6 +26,7 @@ module Passbase
     # Unix-timestamp of when the resource was updated
     attr_accessor :updated
 
+    # All resource types that passbase supports
     attr_accessor :type
 
     attr_accessor :resource_files
@@ -71,7 +72,7 @@ module Passbase
         :'status' => :'String',
         :'created' => :'Integer',
         :'updated' => :'Integer',
-        :'type' => :'ResourceType',
+        :'type' => :'String',
         :'resource_files' => :'Array<Object>'
       }
     end

data/lib/passbase/models/resource_input.rb

@@ -14,6 +14,7 @@ require 'date'
 
 module Passbase
   class ResourceInput
+    # All resource types that passbase supports
     attr_accessor :type
 
     # 2-letter code of the country
@@ -39,7 +40,7 @@ module Passbase
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'type' => :'ResourceType',
+        :'type' => :'String',
         :'country' => :'String',
         :'resource_files' => :'Array<Array>',
         :'resource_data' => :'Object',

data/lib/passbase/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.0.0-SNAPSHOT
 =end
 
 module Passbase
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/spec/api/identity_api_spec.rb

@@ -32,6 +32,18 @@ describe 'IdentityApi' do
     end
   end
 
+  # unit tests for get_identity_by_id
+  # Get identity
+  # Retrieve an identity by providing the identity ID.
+  # @param id Unique ID of the identity to return
+  # @param [Hash] opts the optional parameters
+  # @return [Identity]
+  describe 'get_identity_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_identity_resource_by_id
   # Get resource
   # Get a resource attached to an identity by providing the resource ID. 
@@ -45,13 +57,15 @@ describe 'IdentityApi' do
     end
   end
 
-  # unit tests for get_identy_by_id
-  # Get identity
-  # Retrieve an identity by providing the identity ID.
-  # @param id Unique ID of the identity to return
+  # unit tests for get_identity_resource_file_by_id
+  # Get resource file
+  # Get a raw resource file attached to an identity by providing the resource ID and the resource file ID. This is a protected route and you'll need a specific government authorization to access it. 
+  # @param id Identity id
+  # @param resource_id Resource id
+  # @param resource_file_id Resource file id
   # @param [Hash] opts the optional parameters
-  # @return [Array<Identity>]
-  describe 'get_identy_by_id test' do
+  # @return [ResourceFile]
+  describe 'get_identity_resource_file_by_id test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end