passbase 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f834f243971596bfa920a226fadfbac9422278c59ad68bdf9f71bc986b0d1a76
-  data.tar.gz: b0fa87855e3e58dce268bd7b9e6a531a6af2794c316dad5759c52cbe9f19b8f3
+  metadata.gz: 453a4d11dba3d1be37a2ad9cfa9b27d3348338ba47180aa88d7bf0190a6228ef
+  data.tar.gz: 30590bcf512beda9c446474ee0dc3f8b259c90b4b289db539d6837562395da68
 SHA512:
-  metadata.gz: 0e83583a972455fc9c830bb7fd728694b905c1eb0f40f0da8d489eeaa30aeaf0411db5cd6e37e469d43ba1c903f96e185d2bc0cf7de0c6fd225745b1e6007c20
-  data.tar.gz: d97258d9ab42dbb92eaf778506ae40ae6bdd1acb1c224f8af2735efbf5e6ff5e9a9f4530d5c7d36df78b02ec43c3bb82bb5ea030c954abefa3601686311851d4
+  metadata.gz: c45b286b31fc9145d00e7e9ac231ecf75d11ab6881a5459985432d6d1de1c40a9031b128395cadb349e25ae15030ec08fe9cf46e016d85f997d33545015929ef
+  data.tar.gz: 1b6dc6b6a0e3a770958787f92ed2425a8eeb5e9a216381b43fbdd334178218830bea439197c946c3af1da76661e6404190f25905fde7a8344b9318badb189b04

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    passbase (1.0.1)
-      faraday (>= 0.14.0)
+    passbase (1.3.0)
+      faraday (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -11,8 +11,19 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    faraday (1.0.1)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
     jaro_winkler (1.5.4)
     method_source (1.0.0)
     multipart-post (2.1.1)
@@ -50,6 +61,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.4)
     unicode-display_width (1.5.0)
 
 PLATFORMS

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.1
+- Package version: 1.3.0
 - 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.1.gem
+gem install ./passbase-1.3.0.gem
 ```
 
-(for development, run `gem install --dev ./passbase-1.0.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./passbase-1.3.0.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.1'
+    gem 'passbase', '~> 1.3.0'
 
 ### Install from Git
 
@@ -61,35 +61,35 @@ require 'passbase'
 # Setup authorization
 Passbase.configure do |config|
   # Configure API key authorization: SecretApiKey
-  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  config.api_key['SecretApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+  # config.api_key_prefix['SecretApiKey'] = 'Bearer'
 end
 
 api_instance = Passbase::IdentityApi.new
-id = 'id_example' # String | Identity id
-resource_id = 'resource_id_example' # String | Resource id
+id = TODO # String | Unique ID of the identity to return
 
 begin
-  #Get resource
-  result = api_instance.get_identity_resource_by_id(id, resource_id)
+  #Get identity
+  result = api_instance.get_identity_by_id(id)
   p result
 rescue Passbase::ApiError => e
-  puts "Exception when calling IdentityApi->get_identity_resource_by_id: #{e}"
+  puts "Exception when calling IdentityApi->get_identity_by_id: #{e}"
 end
 
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://api.passbase.com/verification/v1*
+All URIs are relative to *https://api.passbase.com/verification/v2*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*Passbase::IdentityApi* | [**get_identity_resource_by_id**](docs/IdentityApi.md#get_identity_resource_by_id) | **GET** /identities/{id}/resource/{resource_id} | Get resource
-*Passbase::IdentityApi* | [**get_identy_by_id**](docs/IdentityApi.md#get_identy_by_id) | **GET** /identities/{id} | Get identity
+*Passbase::IdentityApi* | [**get_identity_by_id**](docs/IdentityApi.md#get_identity_by_id) | **GET** /identities/{id} | Get identity
+*Passbase::IdentityApi* | [**get_identity_resource_by_id**](docs/IdentityApi.md#get_identity_resource_by_id) | **GET** /identity/{id}/resources/{resource_id} | Get resource
+*Passbase::IdentityApi* | [**get_identity_resource_file_by_id**](docs/IdentityApi.md#get_identity_resource_file_by_id) | **GET** /identity/{id}/resources/{resource_id}/resource_files/{resource_file_id} | Get resource file
 *Passbase::IdentityApi* | [**list_identities**](docs/IdentityApi.md#list_identities) | **GET** /identities | List identities
-*Passbase::IdentityApi* | [**list_identity_resources**](docs/IdentityApi.md#list_identity_resources) | **GET** /identities/{id}/resources | List resources
+*Passbase::IdentityApi* | [**list_identity_resources**](docs/IdentityApi.md#list_identity_resources) | **GET** /identity/{id}/resources | List resources
 *Passbase::ProjectApi* | [**get_settings**](docs/ProjectApi.md#get_settings) | **GET** /settings | Get project settings
 
 
@@ -97,6 +97,7 @@ Class | Method | HTTP request | Description
 
  - [Passbase::Cursor](docs/Cursor.md)
  - [Passbase::Identity](docs/Identity.md)
+ - [Passbase::IdentityOwner](docs/IdentityOwner.md)
  - [Passbase::IdentityResource](docs/IdentityResource.md)
  - [Passbase::PaginatedIdentities](docs/PaginatedIdentities.md)
  - [Passbase::PaginatedResources](docs/PaginatedResources.md)

data/docs/Cursor.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_next** | **String** | opaque token to pass back to the API to get the next batch of data | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** | opaque token to pass back to the API to get the next batch of data | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::Cursor.new(_next: aWQ6NDA3MQ==)
+instance = Passbase::Cursor.new(
+  _next: aWQ6NDA3MQ==
+)
 ```
 
-

data/docs/Identity.md

@@ -2,26 +2,33 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Unique ID of the identity | [optional] 
-**status** | **String** | Current state of the identity in Passbase's systems | [optional] 
-**created** | **Integer** | Unix-timestamp of when the identity was created | [optional] 
-**updated** | **Integer** | Unix-timestamp of when the identity was updated | [optional] 
-**resources** | [**Array<IdentityResource>**](IdentityResource.md) | resources attached to a verification | [optional] 
-**watchlist** | [**WatchlistResponse**](.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID of the identity | [optional] |
+| **status** | **String** | Current state of the identity in Passbase's systems | [optional] |
+| **owner** | [**IdentityOwner**](.md) |  | [optional] |
+| **score** | **Float** | 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. | [optional] |
+| **created** | **Integer** | Unix-timestamp of when the identity was created | [optional] |
+| **updated** | **Integer** | Unix-timestamp of when the identity was updated | [optional] |
+| **resources** | [**Array<IdentityResource>**](IdentityResource.md) | resources attached to a verification | [optional] |
+| **metadata** | **Object** | Customer defined arbitrary payload initially passed through the client-sdk | [optional] |
+| **watchlist** | [**WatchlistResponse**](.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::Identity.new(id: 00000000-0000-0000-0000-000000000000,
-                                 status: null,
-                                 created: 1600250430,
-                                 updated: 1600250430,
-                                 resources: null,
-                                 watchlist: null)
+instance = Passbase::Identity.new(
+  id: 00000000-0000-0000-0000-000000000000,
+  status: null,
+  owner: null,
+  score: 0.01000000000000012,
+  created: 1600250430,
+  updated: 1600250430,
+  resources: null,
+  metadata: {"foo":"bar"},
+  watchlist: null
+)
 ```
 
-

data/docs/IdentityApi.md

@@ -1,35 +1,106 @@
 # Passbase::IdentityApi
 
-All URIs are relative to *https://api.passbase.com/verification/v1*
+All URIs are relative to *https://api.passbase.com/verification/v2*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_identity_resource_by_id**](IdentityApi.md#get_identity_resource_by_id) | **GET** /identities/{id}/resource/{resource_id} | Get resource
-[**get_identy_by_id**](IdentityApi.md#get_identy_by_id) | **GET** /identities/{id} | Get identity
-[**list_identities**](IdentityApi.md#list_identities) | **GET** /identities | List identities
-[**list_identity_resources**](IdentityApi.md#list_identity_resources) | **GET** /identities/{id}/resources | List resources
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_identity_by_id**](IdentityApi.md#get_identity_by_id) | **GET** /identities/{id} | Get identity |
+| [**get_identity_resource_by_id**](IdentityApi.md#get_identity_resource_by_id) | **GET** /identity/{id}/resources/{resource_id} | Get resource |
+| [**get_identity_resource_file_by_id**](IdentityApi.md#get_identity_resource_file_by_id) | **GET** /identity/{id}/resources/{resource_id}/resource_files/{resource_file_id} | Get resource file |
+| [**list_identities**](IdentityApi.md#list_identities) | **GET** /identities | List identities |
+| [**list_identity_resources**](IdentityApi.md#list_identity_resources) | **GET** /identity/{id}/resources | List resources |
 
 
+## get_identity_by_id
+
+> <Identity> get_identity_by_id(id)
+
+Get identity
+
+Retrieve an identity by providing the identity ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'passbase'
+# setup authorization
+Passbase.configure do |config|
+  # Configure API key authorization: SecretApiKey
+  config.api_key['SecretApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['SecretApiKey'] = 'Bearer'
+end
+
+api_instance = Passbase::IdentityApi.new
+id = TODO # String | Unique ID of the identity to return
+
+begin
+  # Get identity
+  result = api_instance.get_identity_by_id(id)
+  p result
+rescue Passbase::ApiError => e
+  puts "Error when calling IdentityApi->get_identity_by_id: #{e}"
+end
+```
+
+#### Using the get_identity_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Identity>, Integer, Hash)> get_identity_by_id_with_http_info(id)
+
+```ruby
+begin
+  # Get identity
+  data, status_code, headers = api_instance.get_identity_by_id_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Identity>
+rescue Passbase::ApiError => e
+  puts "Error when calling IdentityApi->get_identity_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**String**](.md) | Unique ID of the identity to return |  |
+
+### Return type
+
+[**Identity**](Identity.md)
+
+### Authorization
+
+[SecretApiKey](../README.md#SecretApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
 
 ## get_identity_resource_by_id
 
-> Resource get_identity_resource_by_id(id, resource_id)
+> <Resource> get_identity_resource_by_id(id, resource_id)
 
 Get resource
 
 Get a resource attached to an identity by providing the resource ID. 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'passbase'
 # setup authorization
 Passbase.configure do |config|
   # Configure API key authorization: SecretApiKey
-  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  config.api_key['SecretApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+  # config.api_key_prefix['SecretApiKey'] = 'Bearer'
 end
 
 api_instance = Passbase::IdentityApi.new
@@ -37,21 +108,38 @@ id = 'id_example' # String | Identity id
 resource_id = 'resource_id_example' # String | Resource id
 
 begin
-  #Get resource
+  # Get resource
   result = api_instance.get_identity_resource_by_id(id, resource_id)
   p result
 rescue Passbase::ApiError => e
-  puts "Exception when calling IdentityApi->get_identity_resource_by_id: #{e}"
+  puts "Error when calling IdentityApi->get_identity_resource_by_id: #{e}"
 end
 ```
 
-### Parameters
+#### Using the get_identity_resource_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Resource>, Integer, Hash)> get_identity_resource_by_id_with_http_info(id, resource_id)
+
+```ruby
+begin
+  # Get resource
+  data, status_code, headers = api_instance.get_identity_resource_by_id_with_http_info(id, resource_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Resource>
+rescue Passbase::ApiError => e
+  puts "Error when calling IdentityApi->get_identity_resource_by_id_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| Identity id | 
- **resource_id** | **String**| Resource id | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identity id |  |
+| **resource_id** | **String** | Resource id |  |
 
 ### Return type
 
@@ -67,49 +155,70 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## get_identy_by_id
+## get_identity_resource_file_by_id
 
-> Array&lt;Identity&gt; get_identy_by_id(id)
+> <ResourceFile> get_identity_resource_file_by_id(id, resource_id, resource_file_id)
 
-Get identity
+Get resource file
 
-Retrieve an identity by providing the identity ID.
+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. 
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'passbase'
 # setup authorization
 Passbase.configure do |config|
   # Configure API key authorization: SecretApiKey
-  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  config.api_key['SecretApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+  # config.api_key_prefix['SecretApiKey'] = 'Bearer'
 end
 
 api_instance = Passbase::IdentityApi.new
-id = 'id_example' # String | Unique ID of the identity to return
+id = 'id_example' # String | Identity id
+resource_id = 'resource_id_example' # String | Resource id
+resource_file_id = 'resource_file_id_example' # String | Resource file id
 
 begin
-  #Get identity
-  result = api_instance.get_identy_by_id(id)
+  # Get resource file
+  result = api_instance.get_identity_resource_file_by_id(id, resource_id, resource_file_id)
   p result
 rescue Passbase::ApiError => e
-  puts "Exception when calling IdentityApi->get_identy_by_id: #{e}"
+  puts "Error when calling IdentityApi->get_identity_resource_file_by_id: #{e}"
 end
 ```
 
-### Parameters
+#### Using the get_identity_resource_file_by_id_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | [**String**](.md)| Unique ID of the identity to return | 
+> <Array(<ResourceFile>, Integer, Hash)> get_identity_resource_file_by_id_with_http_info(id, resource_id, resource_file_id)
+
+```ruby
+begin
+  # Get resource file
+  data, status_code, headers = api_instance.get_identity_resource_file_by_id_with_http_info(id, resource_id, resource_file_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResourceFile>
+rescue Passbase::ApiError => e
+  puts "Error when calling IdentityApi->get_identity_resource_file_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identity id |  |
+| **resource_id** | **String** | Resource id |  |
+| **resource_file_id** | **String** | Resource file id |  |
 
 ### Return type
 
-[**Array&lt;Identity&gt;**](Identity.md)
+[**ResourceFile**](ResourceFile.md)
 
 ### Authorization
 
@@ -123,23 +232,23 @@ Name | Type | Description  | Notes
 
 ## list_identities
 
-> PaginatedIdentities list_identities(opts)
+> <PaginatedIdentities> list_identities(opts)
 
 List identities
 
 List all the identities retrievable by the provided API Secret Key.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'passbase'
 # setup authorization
 Passbase.configure do |config|
   # Configure API key authorization: SecretApiKey
-  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  config.api_key['SecretApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+  # config.api_key_prefix['SecretApiKey'] = 'Bearer'
 end
 
 api_instance = Passbase::IdentityApi.new
@@ -149,21 +258,38 @@ opts = {
 }
 
 begin
-  #List identities
+  # List identities
   result = api_instance.list_identities(opts)
   p result
 rescue Passbase::ApiError => e
-  puts "Exception when calling IdentityApi->list_identities: #{e}"
+  puts "Error when calling IdentityApi->list_identities: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_identities_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedIdentities>, Integer, Hash)> list_identities_with_http_info(opts)
+
+```ruby
+begin
+  # List identities
+  data, status_code, headers = api_instance.list_identities_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedIdentities>
+rescue Passbase::ApiError => e
+  puts "Error when calling IdentityApi->list_identities_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**|  | [optional] 
- **cursor** | **String**|  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **cursor** | **String** |  | [optional] |
 
 ### Return type
 
@@ -181,23 +307,23 @@ Name | Type | Description  | Notes
 
 ## list_identity_resources
 
-> PaginatedResources list_identity_resources(id, opts)
+> <PaginatedResources> list_identity_resources(id, opts)
 
 List resources
 
 List resources attached to an identity by providing the identity ID.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'passbase'
 # setup authorization
 Passbase.configure do |config|
   # Configure API key authorization: SecretApiKey
-  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  config.api_key['SecretApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+  # config.api_key_prefix['SecretApiKey'] = 'Bearer'
 end
 
 api_instance = Passbase::IdentityApi.new
@@ -208,22 +334,39 @@ opts = {
 }
 
 begin
-  #List resources
+  # List resources
   result = api_instance.list_identity_resources(id, opts)
   p result
 rescue Passbase::ApiError => e
-  puts "Exception when calling IdentityApi->list_identity_resources: #{e}"
+  puts "Error when calling IdentityApi->list_identity_resources: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_identity_resources_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<PaginatedResources>, Integer, Hash)> list_identity_resources_with_http_info(id, opts)
+
+```ruby
+begin
+  # List resources
+  data, status_code, headers = api_instance.list_identity_resources_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedResources>
+rescue Passbase::ApiError => e
+  puts "Error when calling IdentityApi->list_identity_resources_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| Identity id | 
- **limit** | **Integer**|  | [optional] 
- **cursor** | **String**|  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identity id |  |
+| **limit** | **Integer** |  | [optional] |
+| **cursor** | **String** |  | [optional] |
 
 ### Return type