passbase 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 926cc7baa85124ec1d95e7ded9a196558c36b764712d36117b58794d0bb736ed
-  data.tar.gz: 6f5917d9a6c53ef9a74014d129e239bd82de5954c57e64c42b0b581f57c799f1
+  metadata.gz: f834f243971596bfa920a226fadfbac9422278c59ad68bdf9f71bc986b0d1a76
+  data.tar.gz: b0fa87855e3e58dce268bd7b9e6a531a6af2794c316dad5759c52cbe9f19b8f3
 SHA512:
-  metadata.gz: 2a7e3725a95375c633d18d0022457a53d1003c874692b4d606bc94f397a4aaf85e0d4172118a5b6dc4799139be577e348e282470ba9e3bb82b3f6c93fc56fda5
-  data.tar.gz: bb1d1b08af4944e43c2847c6db20e4d4418d461618772f1da2c698170de5b2413ad45574cd5993c89109d0fd58a6c794b0006dcf1a9ed0c9b971d4051573bd1f
+  metadata.gz: 0e83583a972455fc9c830bb7fd728694b905c1eb0f40f0da8d489eeaa30aeaf0411db5cd6e37e469d43ba1c903f96e185d2bc0cf7de0c6fd225745b1e6007c20
+  data.tar.gz: d97258d9ab42dbb92eaf778506ae40ae6bdd1acb1c224f8af2735efbf5e6ff5e9a9f4530d5c7d36df78b02ec43c3bb82bb5ea030c954abefa3601686311851d4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    passbase (1.0.0)
+    passbase (1.0.1)
       faraday (>= 0.14.0)
 
 GEM

data/README.md

@@ -9,7 +9,7 @@ Passbase - the Ruby gem for the Verification API
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 1.0.0
+- Package version: 1.0.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -25,16 +25,16 @@ gem build passbase.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./passbase-1.0.0.gem
+gem install ./passbase-1.0.1.gem
 ```
 
-(for development, run `gem install --dev ./passbase-1.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./passbase-1.0.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'passbase', '~> 1.0.0'
+    gem 'passbase', '~> 1.0.1'
 
 ### Install from Git
 
@@ -106,7 +106,6 @@ Class | Method | HTTP request | Description
  - [Passbase::Resource](docs/Resource.md)
  - [Passbase::ResourceFile](docs/ResourceFile.md)
  - [Passbase::ResourceInput](docs/ResourceInput.md)
- - [Passbase::ResourceType](docs/ResourceType.md)
  - [Passbase::User](docs/User.md)
  - [Passbase::WatchlistResponse](docs/WatchlistResponse.md)
 

data/docs/IdentityResource.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **datapoints** | **Object** | Dynamic key/value hashmap of the data extracted from the resource.  | [optional] 
-**type** | [**ResourceType**](ResourceType.md) |  | [optional] 
+**type** | **String** | All resource types that passbase supports | [optional] 
 
 ## Code Sample
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'Passbase'
 
 instance = Passbase::IdentityResource.new(datapoints: {"date_of_birth":"1970-01-01","document_number":"010101010101","first_names":"Jessie","last_name":"Smith"},
-                                 type: null)
+                                 type: NATIONAL_ID_CARD)
 ```
 
 

data/docs/ProjectSettings.md

@@ -21,7 +21,7 @@ instance = Passbase::ProjectSettings.new(id: 00000000-0000-0000-0000-00000000000
                                  environment: sandbox,
                                  organization: Passbase Inc.,
                                  customizations: null,
-                                 verification_steps: [{"type":"email","document_types":["EMAIL"]},{"type":"liveness_check","document_types":["FACE_VIDEO"]},{"type":"country","document_types":["COUNTRY"]},{"type":"identity_document_check","document_types":["PASSPORT","DRIVERS_LICENSE"]},{"type":"insurance_card_scan","document_types":["HEALTH_INSURANCE_CARD"]}])
+                                 verification_steps: [{"step":"email","resource_types":["EMAIL"]},{"step":"liveness_check","resource_types":["FACE_VIDEO"]},{"step":"country","resource_types":["de","us","gb","ca"]},{"step":"identity_document_check","resource_types":["PASSPORT","DRIVERS_LICENSE"]},{"step":"insurance_card_scan","resource_types":["HEALTH_INSURANCE_CARD"]}])
 ```
 
 

data/docs/ProjectSettingsVerificationSteps.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **step** | **String** |  | [optional] 
-**resource_types** | [**Array<ResourceType>**](ResourceType.md) |  | [optional] 
+**resource_types** | **Array<String>** |  | [optional] 
 
 ## Code Sample
 

data/docs/Resource.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **status** | **String** | Current state of the resource in Passbase's systems | [optional] 
 **created** | **Integer** | Unix-timestamp of when the resource was created | [optional] 
 **updated** | **Integer** | Unix-timestamp of when the resource was updated | [optional] 
-**type** | [**ResourceType**](ResourceType.md) |  | [optional] 
+**type** | **String** | All resource types that passbase supports | [optional] 
 **resource_files** | **Array<Object>** |  | [optional] 
 
 ## Code Sample
@@ -20,7 +20,7 @@ instance = Passbase::Resource.new(id: null,
                                  status: null,
                                  created: 1600250430,
                                  updated: 1600250430,
-                                 type: null,
+                                 type: NATIONAL_ID_CARD,
                                  resource_files: null)
 ```
 

data/docs/ResourceInput.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | [**ResourceType**](ResourceType.md) |  | [optional] 
+**type** | **String** | All resource types that passbase supports | [optional] 
 **country** | **String** | 2-letter code of the country | [optional] 
 **resource_files** | **Array<Array>** |  | [optional] 
 **resource_data** | **Object** |  | [optional] 
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'Passbase'
 
-instance = Passbase::ResourceInput.new(type: null,
+instance = Passbase::ResourceInput.new(type: NATIONAL_ID_CARD,
                                  country: DE,
                                  resource_files: null,
                                  resource_data: null,

data/docs/User.md

@@ -15,7 +15,7 @@ require 'Passbase'
 
 instance = Passbase::User.new(email: jessie@example.com,
                                  identity_access_token: eyJhbGciOiJIUzI1NiIsI...,
-                                 required_steps: [{"type":"email","document_types":["EMAIL"]},{"type":"liveness_check","document_types":["FACE_VIDEO"]},{"type":"country","document_types":["COUNTRY"]},{"type":"identity_document_check","document_types":["PASSPORT","DRIVERS_LICENSE"]},{"type":"insurance_card_scan","document_types":["HEALTH_INSURANCE_CARD"]}])
+                                 required_steps: [{"step":"email","resource_types":["EMAIL"]},{"step":"liveness_check","resource_types":["FACE_VIDEO"]},{"step":"country","resource_types":["de","us","vn","zn"]},{"step":"identity_document_check","resource_types":["PASSPORT","DRIVERS_LICENSE"]},{"step":"insurance_card_scan","resource_types":["HEALTH_INSURANCE_CARD"]}])
 ```
 
 

data/lib/passbase.rb

@@ -28,7 +28,6 @@ require 'passbase/models/project_settings_verification_steps'
 require 'passbase/models/resource'
 require 'passbase/models/resource_file'
 require 'passbase/models/resource_input'
-require 'passbase/models/resource_type'
 require 'passbase/models/user'
 require 'passbase/models/watchlist_response'
 

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.0.1"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

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_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.0.1'
 end

data/walkthrough.md

@@ -1,7 +1,7 @@
 1. Add Passbase's SDK gem to your Gemfile.
 
 ```rb
-gem 'passbase', '~> 0.0.1'
+gem 'passbase', '~> 1.0.0'
 ```
 
 2. Require the necessary modules in your app
@@ -10,7 +10,7 @@ gem 'passbase', '~> 0.0.1'
 require 'passbase'
 
 Passbase.configure do |config|
-    config.api_key['X-API-KEY'] = '{{YOUR_SECRET_API_KEY}}'
+  config.api_key['X-API-KEY'] = '{{YOUR_SECRET_API_KEY}}'
 end
 
 api_instance = Passbase::ProjectApi.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passbase
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Passbase
@@ -67,7 +67,6 @@ files:
 - docs/Resource.md
 - docs/ResourceFile.md
 - docs/ResourceInput.md
-- docs/ResourceType.md
 - docs/User.md
 - docs/WatchlistResponse.md
 - lib/passbase.rb
@@ -87,7 +86,6 @@ files:
 - lib/passbase/models/resource.rb
 - lib/passbase/models/resource_file.rb
 - lib/passbase/models/resource_input.rb
-- lib/passbase/models/resource_type.rb
 - lib/passbase/models/user.rb
 - lib/passbase/models/watchlist_response.rb
 - lib/passbase/version.rb
@@ -107,7 +105,6 @@ files:
 - spec/models/resource_file_spec.rb
 - spec/models/resource_input_spec.rb
 - spec/models/resource_spec.rb
-- spec/models/resource_type_spec.rb
 - spec/models/user_spec.rb
 - spec/models/watchlist_response_spec.rb
 - spec/spec_helper.rb
@@ -2038,7 +2035,6 @@ test_files:
 - spec/models/resource_spec.rb
 - spec/models/project_settings_spec.rb
 - spec/models/paginated_identities_spec.rb
-- spec/models/resource_type_spec.rb
 - spec/models/paginated_resources_spec.rb
 - spec/models/identity_spec.rb
 - spec/models/project_settings_verification_steps_spec.rb

data/docs/ResourceType.md

@@ -1,16 +0,0 @@
-# Passbase::ResourceType
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Code Sample
-
-```ruby
-require 'Passbase'
-
-instance = Passbase::ResourceType.new()
-```
-
-

data/lib/passbase/models/resource_type.rb

@@ -1,41 +0,0 @@
-=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 ResourceType
-    PASSPORT = "PASSPORT".freeze
-    DRIVERS_LICENSE = "DRIVERS_LICENSE".freeze
-    NATIONAL_ID_CARD = "NATIONAL_ID_CARD".freeze
-    HEALTH_INSURANCE_CARD = "HEALTH_INSURANCE_CARD".freeze
-    SELFIE_VIDEO = "SELFIE_VIDEO".freeze
-    PROOF_OF_ADDRESS = "PROOF_OF_ADDRESS".freeze
-    EMAIL = "EMAIL".freeze
-
-    # 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)
-      constantValues = ResourceType.constants.select { |c| ResourceType::const_get(c) == value }
-      raise "Invalid ENUM value #{value} for class #ResourceType" if constantValues.empty?
-      value
-    end
-  end
-end

data/spec/models/resource_type_spec.rb

@@ -1,35 +0,0 @@
-=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 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for Passbase::ResourceType
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'ResourceType' do
-  before do
-    # run before each test
-    @instance = Passbase::ResourceType.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of ResourceType' do
-    it 'should create an instance of ResourceType' do
-      expect(@instance).to be_instance_of(Passbase::ResourceType)
-    end
-  end
-end