passbase 1.0.1 → 1.3.0

data/docs/IdentityOwner.md

@@ -0,0 +1,22 @@
+# Passbase::IdentityOwner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email of the user the identity belongs to | [optional] |
+| **first_name** | **String** | First name of the user the identity belongs to | [optional] |
+| **last_name** | **String** | Last name of the user the identity belongs to | [optional] |
+
+## Example
+
+```ruby
+require 'passbase'
+
+instance = Passbase::IdentityOwner.new(
+  email: john.doe@example.com,
+  first_name: John,
+  last_name: Doe
+)
+```
+

data/docs/IdentityResource.md

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

data/docs/PaginatedIdentities.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cursor** | [**Cursor**](Cursor.md) |  | [optional] 
-**data** | [**Array<Identity>**](Identity.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | [**Cursor**](Cursor.md) |  | [optional] |
+| **data** | [**Array<Identity>**](Identity.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::PaginatedIdentities.new(cursor: null,
-                                 data: null)
+instance = Passbase::PaginatedIdentities.new(
+  cursor: null,
+  data: null
+)
 ```
 
-

data/docs/PaginatedResources.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**cursor** | [**Cursor**](Cursor.md) |  | [optional] 
-**data** | [**Array<Resource>**](Resource.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | [**Cursor**](Cursor.md) |  | [optional] |
+| **data** | [**Array<Resource>**](Resource.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::PaginatedResources.new(cursor: null,
-                                 data: null)
+instance = Passbase::PaginatedResources.new(
+  cursor: null,
+  data: null
+)
 ```
 
-

data/docs/ProjectApi.md

@@ -1,42 +1,59 @@
 # Passbase::ProjectApi
 
-All URIs are relative to *https://api.passbase.com/verification/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_settings**](ProjectApi.md#get_settings) | **GET** /settings | Get project settings
+All URIs are relative to *https://api.passbase.com/verification/v2*
 
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_settings**](ProjectApi.md#get_settings) | **GET** /settings | Get project settings |
 
 
 ## get_settings
 
-> ProjectSettings get_settings
+> <ProjectSettings> get_settings
 
 Get project settings
 
 Get project settings 
 
-### 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::ProjectApi.new
 
 begin
-  #Get project settings
+  # Get project settings
   result = api_instance.get_settings
   p result
 rescue Passbase::ApiError => e
-  puts "Exception when calling ProjectApi->get_settings: #{e}"
+  puts "Error when calling ProjectApi->get_settings: #{e}"
+end
+```
+
+#### Using the get_settings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProjectSettings>, Integer, Hash)> get_settings_with_http_info
+
+```ruby
+begin
+  # Get project settings
+  data, status_code, headers = api_instance.get_settings_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProjectSettings>
+rescue Passbase::ApiError => e
+  puts "Error when calling ProjectApi->get_settings_with_http_info: #{e}"
 end
 ```
 

data/docs/ProjectSettings.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Unique ID of the project | [optional] 
-**slug** | **String** | slugs are meant to be a way to verify people just with the link | [optional] 
-**environment** | **String** |  | [optional] 
-**organization** | **String** | Name of the organization that owns this project | [optional] 
-**customizations** | [**ProjectSettingsCustomizations**](ProjectSettingsCustomizations.md) |  | [optional] 
-**verification_steps** | [**Array<ProjectSettingsVerificationSteps>**](ProjectSettingsVerificationSteps.md) | List of the steps through which the user must go through to complete their verification  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID of the project | [optional] |
+| **slug** | **String** | Slugs are meant to be a way to verify people just with the link | [optional] |
+| **environment** | **String** |  | [optional] |
+| **organization** | **String** | Name of the organization that owns this project | [optional] |
+| **customizations** | [**ProjectSettingsCustomizations**](ProjectSettingsCustomizations.md) |  | [optional] |
+| **verification_steps** | [**Array<ProjectSettingsVerificationSteps>**](ProjectSettingsVerificationSteps.md) | List of the steps through which the user must go through to complete their verification  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::ProjectSettings.new(id: 00000000-0000-0000-0000-000000000000,
-                                 slug: passbase-demo,
-                                 environment: sandbox,
-                                 organization: Passbase Inc.,
-                                 customizations: null,
-                                 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"]}])
+instance = Passbase::ProjectSettings.new(
+  id: 00000000-0000-0000-0000-000000000000,
+  slug: passbase-demo,
+  environment: sandbox,
+  organization: Passbase Inc.,
+  customizations: null,
+  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/ProjectSettingsCustomizations.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**button_color** | **String** | \\\"Verify Me\\\" button background color | [optional] 
-**accent_color** | **String** | Accent color during the verification flow (button, breadcrumb, etc…) | [optional] 
-**font_family** | **String** | Font used in the verification flow | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **button_color** | **String** | \\\"Verify Me\\\" button background color | [optional] |
+| **accent_color** | **String** | Accent color during the verification flow (button, breadcrumb, etc…) | [optional] |
+| **font_family** | **String** | Font used in the verification flow | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::ProjectSettingsCustomizations.new(button_color: #1E1E1E,
-                                 accent_color: #FAFAFA,
-                                 font_family: Arial)
+instance = Passbase::ProjectSettingsCustomizations.new(
+  button_color: #1E1E1E,
+  accent_color: #FAFAFA,
+  font_family: Arial
+)
 ```
 
-

data/docs/ProjectSettingsVerificationSteps.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**step** | **String** |  | [optional] 
-**resource_types** | **Array<String>** |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **step** | **String** |  | [optional] |
+| **resource_types** | **Array<String>** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::ProjectSettingsVerificationSteps.new(step: liveness_check,
-                                 resource_types: ["DRIVERS_LICENSE","NATIONAL_ID_CARD"])
+instance = Passbase::ProjectSettingsVerificationSteps.new(
+  step: liveness_check,
+  resource_types: ["DRIVERS_LICENSE","NATIONAL_ID_CARD"]
+)
 ```
 
-

data/docs/Resource.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Unique ID representing a resource | [optional] 
-**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** | **String** | All resource types that passbase supports | [optional] 
-**resource_files** | **Array<Object>** |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID representing a resource | [optional] |
+| **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** | **String** | All resource types that passbase supports | [optional] |
+| **resource_files** | **Array<Object>** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::Resource.new(id: null,
-                                 status: null,
-                                 created: 1600250430,
-                                 updated: 1600250430,
-                                 type: NATIONAL_ID_CARD,
-                                 resource_files: null)
+instance = Passbase::Resource.new(
+  id: null,
+  status: null,
+  created: 1600250430,
+  updated: 1600250430,
+  type: NATIONAL_ID_CARD,
+  resource_files: null
+)
 ```
 
-

data/docs/ResourceFile.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Unique ID representing a resource file | [optional] 
-**created** | **Integer** | Unix-timestamp of when the resource was created | [optional] 
-**updated** | **Integer** | Unix-timestamp of when the resource was updated | [optional] 
-**file** | **File** | Raw bytes: the actual file | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID representing a resource file | [optional] |
+| **created** | **Integer** | Unix-timestamp of when the resource was created | [optional] |
+| **updated** | **Integer** | Unix-timestamp of when the resource was updated | [optional] |
+| **file** | **File** | Raw bytes: the actual file | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::ResourceFile.new(id: null,
-                                 created: 1600250430,
-                                 updated: 1600250430,
-                                 file: null)
+instance = Passbase::ResourceFile.new(
+  id: null,
+  created: 1600250430,
+  updated: 1600250430,
+  file: null
+)
 ```
 
-

data/docs/ResourceInput.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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] 
-**resource_raw_data** | **Object** |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **resource_raw_data** | **Object** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::ResourceInput.new(type: NATIONAL_ID_CARD,
-                                 country: DE,
-                                 resource_files: null,
-                                 resource_data: null,
-                                 resource_raw_data: null)
+instance = Passbase::ResourceInput.new(
+  type: NATIONAL_ID_CARD,
+  country: DE,
+  resource_files: null,
+  resource_data: null,
+  resource_raw_data: null
+)
 ```
 
-

data/docs/User.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**email** | **String** | Email with which the user was created | [optional] 
-**identity_access_token** | **String** | Access token in the shape of a JsonWebToken used as a Bearer token when submitting identity data  | [optional] 
-**required_steps** | [**Array<ProjectSettingsVerificationSteps>**](ProjectSettingsVerificationSteps.md) | List of the steps through which the user must go through to complete their verification  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email with which the user was created | [optional] |
+| **identity_access_token** | **String** | Access token in the shape of a JsonWebToken used as a Bearer token when submitting identity data  | [optional] |
+| **required_steps** | [**Array<ProjectSettingsVerificationSteps>**](ProjectSettingsVerificationSteps.md) | List of the steps through which the user must go through to complete their verification  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::User.new(email: jessie@example.com,
-                                 identity_access_token: eyJhbGciOiJIUzI1NiIsI...,
-                                 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"]}])
+instance = Passbase::User.new(
+  email: jessie@example.com,
+  identity_access_token: eyJhbGciOiJIUzI1NiIsI...,
+  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"]}]
+)
 ```
 
-