trulioo_sdk 1.0.3

data/docs/ConnectionApi.md

@@ -0,0 +1,213 @@
+# Trulioo::ConnectionApi
+
+All URIs are relative to *https://gateway.trulioo.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**connection_async_callback_url**](ConnectionApi.md#connection_async_callback_url) | **POST** /{mode}/connection/v1/async-callback | Connection Async Callback Url |
+| [**say_hello**](ConnectionApi.md#say_hello) | **GET** /{mode}/connection/v1/sayhello/{name} | Say Hello |
+| [**test_authentication**](ConnectionApi.md#test_authentication) | **GET** /{mode}/connection/v1/testauthentication | Test Authentication |
+
+
+## connection_async_callback_url
+
+> Object connection_async_callback_url(mode, transaction_status)
+
+Connection Async Callback Url
+
+If set, the transaction will run asynchronously and Trulioo will try to update the client with transaction state updates until completed. If callback is not desired but the client wants to initiate an asynchronous transaction, provide https://api.globaldatacompany.com/connection/v1/async-callback as the Callback URL.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trulioo_sdk'
+
+api_instance = Trulioo::ConnectionApi.new
+mode = 'mode_example' # String | trial or live
+transaction_status = Trulioo::TransactionStatus.new # TransactionStatus | transactionStatus
+
+begin
+  # Connection Async Callback Url
+  result = api_instance.connection_async_callback_url(mode, transaction_status)
+  p result
+rescue Trulioo::ApiError => e
+  puts "Error when calling ConnectionApi->connection_async_callback_url: #{e}"
+end
+```
+
+#### Using the connection_async_callback_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> connection_async_callback_url_with_http_info(mode, transaction_status)
+
+```ruby
+begin
+  # Connection Async Callback Url
+  data, status_code, headers = api_instance.connection_async_callback_url_with_http_info(mode, transaction_status)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Trulioo::ApiError => e
+  puts "Error when calling ConnectionApi->connection_async_callback_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | trial or live | [default to &#39;trial&#39;] |
+| **transaction_status** | [**TransactionStatus**](TransactionStatus.md) | transactionStatus |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json
+- **Accept**: application/json, text/json
+
+
+## say_hello
+
+> String say_hello(mode, name)
+
+Say Hello
+
+This method enables you to check if your system can connect to our system. You can even use a web browser to verify a connection to our system.  Applied a maximum length for the name parameter of 100 via a route constraint
+
+### Examples
+
+```ruby
+require 'time'
+require 'trulioo_sdk'
+
+api_instance = Trulioo::ConnectionApi.new
+mode = 'mode_example' # String | trial or live
+name = 'name_example' # String | Name to be returned in the response
+
+begin
+  # Say Hello
+  result = api_instance.say_hello(mode, name)
+  p result
+rescue Trulioo::ApiError => e
+  puts "Error when calling ConnectionApi->say_hello: #{e}"
+end
+```
+
+#### Using the say_hello_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> say_hello_with_http_info(mode, name)
+
+```ruby
+begin
+  # Say Hello
+  data, status_code, headers = api_instance.say_hello_with_http_info(mode, name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue Trulioo::ApiError => e
+  puts "Error when calling ConnectionApi->say_hello_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | trial or live | [default to &#39;trial&#39;] |
+| **name** | **String** | Name to be returned in the response |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/json
+
+
+## test_authentication
+
+> String test_authentication(mode)
+
+Test Authentication
+
+This method enables you to check if your credentials are valid. You will need to use basic authentication to ensure a successful response.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trulioo_sdk'
+# setup authorization
+Trulioo.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Trulioo::ConnectionApi.new
+mode = 'mode_example' # String | trial or live
+
+begin
+  # Test Authentication
+  result = api_instance.test_authentication(mode)
+  p result
+rescue Trulioo::ApiError => e
+  puts "Error when calling ConnectionApi->test_authentication: #{e}"
+end
+```
+
+#### Using the test_authentication_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> test_authentication_with_http_info(mode)
+
+```ruby
+begin
+  # Test Authentication
+  data, status_code, headers = api_instance.test_authentication_with_http_info(mode)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue Trulioo::ApiError => e
+  puts "Error when calling ConnectionApi->test_authentication_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | trial or live | [default to &#39;trial&#39;] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/json
+

data/docs/Consent.md

@@ -0,0 +1,22 @@
+# Trulioo::Consent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the datasource requiring consent | [optional] |
+| **text** | **String** | Text outlining how the user is consenting for their data to be used | [optional] |
+| **url** | **String** | URL where the user can find more information about how the datasource will use their data | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::Consent.new(
+  name: null,
+  text: null,
+  url: null
+)
+```
+

data/docs/CountrySubdivision.md

@@ -0,0 +1,22 @@
+# Trulioo::CountrySubdivision
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the area, in english or one of the languages of the country | [optional] |
+| **code** | **String** | Code for the area | [optional] |
+| **parent_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::CountrySubdivision.new(
+  name: null,
+  code: null,
+  parent_code: null
+)
+```
+

data/docs/DataField.md

@@ -0,0 +1,22 @@
+# Trulioo::DataField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_name** | **String** |  | [optional] |
+| **value** | **String** |  | [optional] |
+| **field_group** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::DataField.new(
+  field_name: null,
+  value: null,
+  field_group: null
+)
+```
+

data/docs/DataFields.md

@@ -0,0 +1,34 @@
+# Trulioo::DataFields
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **person_info** | [**PersonInfo**](PersonInfo.md) |  | [optional] |
+| **location** | [**Location**](Location.md) |  | [optional] |
+| **communication** | [**Communication**](Communication.md) |  | [optional] |
+| **driver_licence** | [**DriverLicence**](DriverLicence.md) |  | [optional] |
+| **national_ids** | [**Array<NationalId>**](NationalId.md) | National Identification Information | [optional] |
+| **passport** | [**Passport**](Passport.md) |  | [optional] |
+| **document** | [**Document**](Document.md) |  | [optional] |
+| **business** | [**Business**](Business.md) |  | [optional] |
+| **country_specific** | **Hash<String, Hash<String, String>>** | CountrySpecific fields  {\"CountryCode\" : {\"Field1\" : \"Value\",  \"Field2\" : \"Value\"  }} | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::DataFields.new(
+  person_info: null,
+  location: null,
+  communication: null,
+  driver_licence: null,
+  national_ids: null,
+  passport: null,
+  document: null,
+  business: null,
+  country_specific: null
+)
+```
+

data/docs/DatasourceField.md

@@ -0,0 +1,24 @@
+# Trulioo::DatasourceField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_name** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **match_precision** | **String** |  | [optional] |
+| **field_group** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::DatasourceField.new(
+  field_name: null,
+  status: null,
+  match_precision: null,
+  field_group: null
+)
+```
+

data/docs/DatasourceResult.md

@@ -0,0 +1,28 @@
+# Trulioo::DatasourceResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datasource_status** | **String** |  | [optional] |
+| **datasource_name** | **String** |  | [optional] |
+| **datasource_fields** | [**Array<DatasourceField>**](DatasourceField.md) |  | [optional] |
+| **appended_fields** | [**Array<AppendedField>**](AppendedField.md) |  | [optional] |
+| **errors** | [**Array<ServiceError>**](ServiceError.md) |  | [optional] |
+| **field_groups** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::DatasourceResult.new(
+  datasource_status: null,
+  datasource_name: null,
+  datasource_fields: null,
+  appended_fields: null,
+  errors: null,
+  field_groups: null
+)
+```
+

data/docs/Document.md

@@ -0,0 +1,28 @@
+# Trulioo::Document
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_front_image** | **String** | Front of the document | [optional] |
+| **document_back_image** | **String** | Back of the document | [optional] |
+| **live_photo** | **String** | Selfie image | [optional] |
+| **document_type** | **String** | Document type | [optional] |
+| **accept_incomplete_document** | **Boolean** | Accept Incomplete Document | [optional] |
+| **validate_document_image_quality** | **Boolean** | Validate Document Image Quality | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::Document.new(
+  document_front_image: null,
+  document_back_image: null,
+  live_photo: null,
+  document_type: null,
+  accept_incomplete_document: null,
+  validate_document_image_quality: null
+)
+```
+

data/docs/DriverLicence.md

@@ -0,0 +1,26 @@
+# Trulioo::DriverLicence
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** | Driver's Licence Number of the individual to be verified | [optional] |
+| **state** | **String** | State of issue for Driver's Licence | [optional] |
+| **day_of_expiry** | **Integer** | Driver's Licence day of expiry of the individual to be verified | [optional] |
+| **month_of_expiry** | **Integer** | Driver's Licence month of expiry of the individual to be verified | [optional] |
+| **year_of_expiry** | **Integer** | Driver's Licence year of expiry of the individual to be verified | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::DriverLicence.new(
+  number: null,
+  state: null,
+  day_of_expiry: null,
+  month_of_expiry: null,
+  year_of_expiry: null
+)
+```
+

data/docs/Location.md

@@ -0,0 +1,42 @@
+# Trulioo::Location
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **building_number** | **String** | House / Civic / Building number of home address | [optional] |
+| **building_name** | **String** | Name of building of home address | [optional] |
+| **unit_number** | **String** | Flat/Unit/Apartment number of home address | [optional] |
+| **street_name** | **String** | Street name of primary residence | [optional] |
+| **street_type** | **String** | Street type of primary residence (e.g. St, Rd etc) | [optional] |
+| **city** | **String** | City of home address | [optional] |
+| **suburb** | **String** | Suburb / Subdivision / Municipality of home address | [optional] |
+| **county** | **String** | County / District of home address | [optional] |
+| **state_province_code** | **String** | State of primary residence. US sources expect 2 characters. Australian sources expect 2 or 3 characters. | [optional] |
+| **country** | **String** | Country of physical address (ISO 3166-1 alpha-2) | [optional] |
+| **postal_code** | **String** | ZIP Code or Postal Code of home address | [optional] |
+| **po_box** | **String** | Post Office Box | [optional] |
+| **additional_fields** | [**LocationAdditionalFields**](LocationAdditionalFields.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::Location.new(
+  building_number: null,
+  building_name: null,
+  unit_number: null,
+  street_name: null,
+  street_type: null,
+  city: null,
+  suburb: null,
+  county: null,
+  state_province_code: null,
+  country: null,
+  postal_code: null,
+  po_box: null,
+  additional_fields: null
+)
+```
+