trulioo_sdk 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55e97d4c58bbe43eb729fb252554b715ca8b85a80280316a4078406d63de7088
+  data.tar.gz: 494cbb47f9904871b16d7be564b6453cdae5e84830e79c72ebdc3ad13507bc4b
+SHA512:
+  metadata.gz: 111a683a169f02e1110000d65ab8d4804a3b47d3f737dd210631418bf8a2bf86847aba06c174d2b995344d3444ea14743d2973637fcdaf767f80a563411619e4
+  data.tar.gz: '084fc998bc0baa4bfc64c1019defc1181d089a537a98d00f08195527275fac73f0531037d62de8bc5f44a2ce27cba4df9d368eac4c3fce8b1808819f2c1eda39'

data/README.md

@@ -0,0 +1,155 @@
+# Trulioo Ruby SDK
+
+- Gem version: 1.0.3
+- API version: v1
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+Ruby 2.4 or later is required.
+
+### From [RubyGems](https://rubygems.org/)
+
+```shell
+gem install trulioo_sdk
+```
+
+### With local build
+
+```shell
+gem build trulioo_sdk.gemspec
+gem install trulioo_sdk-1.0.0.gem
+```
+
+### As a dependency
+
+Add the following line to the Gemfile:
+
+```ruby
+gem "trulioo_sdk", "~> 1.0.0"
+```
+
+## Sample Application
+
+Check out our sample application for this SDK in the
+[sample-app](https://github.com/Trulioo/sdk-ruby/tree/1.0.3/sample-app) folder.
+
+## Getting Started
+
+### Example of testing authentication
+
+```ruby
+require "trulioo_sdk"
+
+config = Trulioo::Configuration.new()
+
+# Configure API key authorization
+config.api_key["ApiKeyAuth"] = "YOUR-X-TRULIOO-API-KEY"
+
+# Configure mode: "trial" or "live"
+mode = "trial"
+
+# Initialize instance of Trulioo::ApiClient with config
+api_client = Trulioo::ApiClient.new(config)
+
+# Initialize instance of Trulioo::ConnectionApi with api_client
+connection_api = Trulioo::ConnectionApi.new(api_client)
+
+# Call Trulioo::ConnectionApi#test_authentication
+begin
+  result = connection_api.test_authentication(mode)
+  puts(result)
+rescue Trulioo::ApiError => error
+  puts("Error when calling Trulioo::ConnectionApi#test_authentication")
+  puts("HTTP status code: #{error.code}")
+  puts("Response headers: #{error.response_headers}")
+  puts("Response body: #{error.response_body}")
+end
+```
+
+## Testing
+
+Install [Bundler](https://bundler.io/) by running `gem install bundler`, then execute:
+
+```shell
+bundle install
+bundle exec rake test
+```
+
+## Documentation for APIs
+
+All URIs are relative to *https://gateway.trulioo.com*.
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Trulioo::BusinessApi* | [**get_business_search_result**](docs/BusinessApi.md#get_business_search_result) | **GET** /{mode}/business/v1/search/transactionrecord/{id} | Get Business Search Result
+*Trulioo::BusinessApi* | [**search**](docs/BusinessApi.md#search) | **POST** /{mode}/business/v1/search | Search
+*Trulioo::ConfigurationApi* | [**get_business_registration_numbers**](docs/ConfigurationApi.md#get_business_registration_numbers) | **GET** /{mode}/configuration/v1/businessregistrationnumbers/{countryCode}/{jurisdictionCode} | Get Business Registration Numbers
+*Trulioo::ConfigurationApi* | [**get_consents**](docs/ConfigurationApi.md#get_consents) | **GET** /{mode}/configuration/v1/consents/{configurationName}/{countryCode} | Get Consents
+*Trulioo::ConfigurationApi* | [**get_country_codes**](docs/ConfigurationApi.md#get_country_codes) | **GET** /{mode}/configuration/v1/countrycodes/{configurationName} | Get Country Codes
+*Trulioo::ConfigurationApi* | [**get_country_subdivisions**](docs/ConfigurationApi.md#get_country_subdivisions) | **GET** /{mode}/configuration/v1/countrysubdivisions/{countryCode} | Get Country Subdivisions
+*Trulioo::ConfigurationApi* | [**get_datasources**](docs/ConfigurationApi.md#get_datasources) | **GET** /{mode}/configuration/v1/datasources/{configurationName}/{countryCode} | Get Datasources
+*Trulioo::ConfigurationApi* | [**get_detailed_consents**](docs/ConfigurationApi.md#get_detailed_consents) | **GET** /{mode}/configuration/v1/detailedConsents/{configurationName}/{countryCode} | Get Detailed Consents
+*Trulioo::ConfigurationApi* | [**get_document_types**](docs/ConfigurationApi.md#get_document_types) | **GET** /{mode}/configuration/v1/documentTypes/{countryCode} | Get Document Types
+*Trulioo::ConfigurationApi* | [**get_fields**](docs/ConfigurationApi.md#get_fields) | **GET** /{mode}/configuration/v1/fields/{configurationName}/{countryCode} | Get Fields
+*Trulioo::ConfigurationApi* | [**get_recommended_fields**](docs/ConfigurationApi.md#get_recommended_fields) | **GET** /{mode}/configuration/v1/recommendedfields/{configurationName}/{countryCode} | Get Recommended Fields
+*Trulioo::ConfigurationApi* | [**get_test_entities**](docs/ConfigurationApi.md#get_test_entities) | **GET** /{mode}/configuration/v1/testentities/{configurationName}/{countryCode} | Get Test Entities
+*Trulioo::ConnectionApi* | [**connection_async_callback_url**](docs/ConnectionApi.md#connection_async_callback_url) | **POST** /{mode}/connection/v1/async-callback | Connection Async Callback Url
+*Trulioo::ConnectionApi* | [**say_hello**](docs/ConnectionApi.md#say_hello) | **GET** /{mode}/connection/v1/sayhello/{name} | Say Hello
+*Trulioo::ConnectionApi* | [**test_authentication**](docs/ConnectionApi.md#test_authentication) | **GET** /{mode}/connection/v1/testauthentication | Test Authentication
+*Trulioo::VerificationsApi* | [**document_download**](docs/VerificationsApi.md#document_download) | **GET** /{mode}/verifications/v1/documentdownload/{transactionRecordId}/{fieldName} | Document Download
+*Trulioo::VerificationsApi* | [**get_transaction_record**](docs/VerificationsApi.md#get_transaction_record) | **GET** /{mode}/verifications/v1/transactionrecord/{id} | Get Transaction Record
+*Trulioo::VerificationsApi* | [**get_transaction_record_address**](docs/VerificationsApi.md#get_transaction_record_address) | **GET** /{mode}/verifications/v1/transactionrecord/{id}/withaddress | Get Transaction Record Address
+*Trulioo::VerificationsApi* | [**get_transaction_record_document**](docs/VerificationsApi.md#get_transaction_record_document) | **GET** /{mode}/verifications/v1/transactionrecord/{transactionRecordID}/{documentField} | Get Transaction Record Document
+*Trulioo::VerificationsApi* | [**get_transaction_record_verbose**](docs/VerificationsApi.md#get_transaction_record_verbose) | **GET** /{mode}/verifications/v1/transactionrecord/{id}/verbose | Get Transaction Record Verbose
+*Trulioo::VerificationsApi* | [**get_transaction_status**](docs/VerificationsApi.md#get_transaction_status) | **GET** /{mode}/verifications/v1/transaction/{id}/status | Get Transaction Status
+*Trulioo::VerificationsApi* | [**verify**](docs/VerificationsApi.md#verify) | **POST** /{mode}/verifications/v1/verify | Verify
+
+## Documentation for Models
+
+ - [Trulioo::Address](docs/Address.md)
+ - [Trulioo::AppendedField](docs/AppendedField.md)
+ - [Trulioo::Business](docs/Business.md)
+ - [Trulioo::BusinessRecord](docs/BusinessRecord.md)
+ - [Trulioo::BusinessRegistrationNumber](docs/BusinessRegistrationNumber.md)
+ - [Trulioo::BusinessRegistrationNumberMask](docs/BusinessRegistrationNumberMask.md)
+ - [Trulioo::BusinessResult](docs/BusinessResult.md)
+ - [Trulioo::BusinessSearchRequest](docs/BusinessSearchRequest.md)
+ - [Trulioo::BusinessSearchRequestBusinessSearchModel](docs/BusinessSearchRequestBusinessSearchModel.md)
+ - [Trulioo::BusinessSearchResponse](docs/BusinessSearchResponse.md)
+ - [Trulioo::BusinessSearchResponseIndustryCode](docs/BusinessSearchResponseIndustryCode.md)
+ - [Trulioo::Communication](docs/Communication.md)
+ - [Trulioo::Consent](docs/Consent.md)
+ - [Trulioo::CountrySubdivision](docs/CountrySubdivision.md)
+ - [Trulioo::DataField](docs/DataField.md)
+ - [Trulioo::DataFields](docs/DataFields.md)
+ - [Trulioo::DatasourceField](docs/DatasourceField.md)
+ - [Trulioo::DatasourceResult](docs/DatasourceResult.md)
+ - [Trulioo::Document](docs/Document.md)
+ - [Trulioo::DriverLicence](docs/DriverLicence.md)
+ - [Trulioo::Location](docs/Location.md)
+ - [Trulioo::LocationAdditionalFields](docs/LocationAdditionalFields.md)
+ - [Trulioo::NationalId](docs/NationalId.md)
+ - [Trulioo::NormalizedDatasourceField](docs/NormalizedDatasourceField.md)
+ - [Trulioo::NormalizedDatasourceGroupCountry](docs/NormalizedDatasourceGroupCountry.md)
+ - [Trulioo::Passport](docs/Passport.md)
+ - [Trulioo::PersonInfo](docs/PersonInfo.md)
+ - [Trulioo::PersonInfoAdditionalFields](docs/PersonInfoAdditionalFields.md)
+ - [Trulioo::Record](docs/Record.md)
+ - [Trulioo::RecordRule](docs/RecordRule.md)
+ - [Trulioo::Result](docs/Result.md)
+ - [Trulioo::ServiceError](docs/ServiceError.md)
+ - [Trulioo::TestEntityDataFields](docs/TestEntityDataFields.md)
+ - [Trulioo::TransactionRecordResult](docs/TransactionRecordResult.md)
+ - [Trulioo::TransactionRecordResultAllOf](docs/TransactionRecordResultAllOf.md)
+ - [Trulioo::TransactionStatus](docs/TransactionStatus.md)
+ - [Trulioo::VerifyRequest](docs/VerifyRequest.md)
+ - [Trulioo::VerifyResult](docs/VerifyResult.md)
+
+## Documentation for Authorization
+
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: x-trulioo-api-key
+- **Location**: HTTP header

data/docs/Address.md

@@ -0,0 +1,44 @@
+# Trulioo::Address
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **unit_number** | **String** | Flat/Unit/Apartment number of address | [optional] |
+| **building_number** | **String** | House / Civic / Building number of address | [optional] |
+| **building_name** | **String** | Name of building | [optional] |
+| **street_name** | **String** | Street name | [optional] |
+| **street_type** | **String** | Street type of address (Typically St, Rd etc) | [optional] |
+| **city** | **String** | City | [optional] |
+| **suburb** | **String** | Suburb / Subdivision / Municipality | [optional] |
+| **state_province_code** | **String** | State or province of address. US sources expect 2 characters. Australian sources expect 2 or 3 characters. | [optional] |
+| **postal_code** | **String** | ZIP Code or Postal Code | [optional] |
+| **address1** | **String** | Address1 | [optional] |
+| **address_type** | **String** | Address Type | [optional] |
+| **state_province** | **String** | State Province | [optional] |
+| **country** | **String** |  | [optional] |
+| **country_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::Address.new(
+  unit_number: null,
+  building_number: null,
+  building_name: null,
+  street_name: null,
+  street_type: null,
+  city: null,
+  suburb: null,
+  state_province_code: null,
+  postal_code: null,
+  address1: null,
+  address_type: null,
+  state_province: null,
+  country: null,
+  country_code: null
+)
+```
+

data/docs/AppendedField.md

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

data/docs/Business.md

@@ -0,0 +1,36 @@
+# Trulioo::Business
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **business_name** | **String** | Name of the business to be verified | [optional] |
+| **business_registration_number** | **String** | Registration number of business to be verified | [optional] |
+| **day_of_incorporation** | **Integer** | Day of incorporation of the business to be verified | [optional] |
+| **month_of_incorporation** | **Integer** | Month of incorporation of the business to be verified | [optional] |
+| **year_of_incorporation** | **Integer** | Year of incorporation of the business to be verified | [optional] |
+| **jurisdiction_of_incorporation** | **String** | Jurisdiction Of Incorporation of the business to be verified | [optional] |
+| **shareholder_list_document** | **Boolean** | Whether or not to retrieve shareholderList document | [optional] |
+| **financial_information_document** | **Boolean** | Whether or not to retrieve financial information document | [optional] |
+| **duns_number** | **String** | Duns Number | [optional] |
+| **entities** | **Boolean** | Whether or not to retrieve entity detail | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::Business.new(
+  business_name: null,
+  business_registration_number: null,
+  day_of_incorporation: null,
+  month_of_incorporation: null,
+  year_of_incorporation: null,
+  jurisdiction_of_incorporation: null,
+  shareholder_list_document: null,
+  financial_information_document: null,
+  duns_number: null,
+  entities: null
+)
+```
+

data/docs/BusinessApi.md

@@ -0,0 +1,155 @@
+# Trulioo::BusinessApi
+
+All URIs are relative to *https://gateway.trulioo.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_business_search_result**](BusinessApi.md#get_business_search_result) | **GET** /{mode}/business/v1/search/transactionrecord/{id} | Get Business Search Result |
+| [**search**](BusinessApi.md#search) | **POST** /{mode}/business/v1/search | Search |
+
+
+## get_business_search_result
+
+> <BusinessSearchResponse> get_business_search_result(mode, id)
+
+Get Business Search Result
+
+returns the a business search result.
+
+### 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::BusinessApi.new
+mode = 'mode_example' # String | trial or live
+id = 'id_example' # String | transaction record id
+
+begin
+  # Get Business Search Result
+  result = api_instance.get_business_search_result(mode, id)
+  p result
+rescue Trulioo::ApiError => e
+  puts "Error when calling BusinessApi->get_business_search_result: #{e}"
+end
+```
+
+#### Using the get_business_search_result_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BusinessSearchResponse>, Integer, Hash)> get_business_search_result_with_http_info(mode, id)
+
+```ruby
+begin
+  # Get Business Search Result
+  data, status_code, headers = api_instance.get_business_search_result_with_http_info(mode, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BusinessSearchResponse>
+rescue Trulioo::ApiError => e
+  puts "Error when calling BusinessApi->get_business_search_result_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | trial or live | [default to &#39;trial&#39;] |
+| **id** | **String** | transaction record id |  |
+
+### Return type
+
+[**BusinessSearchResponse**](BusinessSearchResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/json
+
+
+## search
+
+> <BusinessSearchResponse> search(mode, business_search_request)
+
+Search
+
+Calling this method will perform a business search.
+
+### 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::BusinessApi.new
+mode = 'mode_example' # String | trial or live
+business_search_request = Trulioo::BusinessSearchRequest.new({country_code: 'country_code_example'}) # BusinessSearchRequest | 
+
+begin
+  # Search
+  result = api_instance.search(mode, business_search_request)
+  p result
+rescue Trulioo::ApiError => e
+  puts "Error when calling BusinessApi->search: #{e}"
+end
+```
+
+#### Using the search_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BusinessSearchResponse>, Integer, Hash)> search_with_http_info(mode, business_search_request)
+
+```ruby
+begin
+  # Search
+  data, status_code, headers = api_instance.search_with_http_info(mode, business_search_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BusinessSearchResponse>
+rescue Trulioo::ApiError => e
+  puts "Error when calling BusinessApi->search_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | trial or live | [default to &#39;trial&#39;] |
+| **business_search_request** | [**BusinessSearchRequest**](BusinessSearchRequest.md) |  |  |
+
+### Return type
+
+[**BusinessSearchResponse**](BusinessSearchResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json
+- **Accept**: application/json, text/json
+

data/docs/BusinessRecord.md

@@ -0,0 +1,24 @@
+# Trulioo::BusinessRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_record_id** | **String** | The TransactionRecordID, this is the ID you will use to fetch the transaction again. | [optional] |
+| **record_status** | **String** | 'match' or 'nomatch' if the verification passed the rules configured on your account this will be 'match'. | [optional] |
+| **datasource_results** | [**Array<BusinessResult>**](BusinessResult.md) | Results for each datasource that was queried | [optional] |
+| **errors** | [**Array<ServiceError>**](ServiceError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::BusinessRecord.new(
+  transaction_record_id: null,
+  record_status: null,
+  datasource_results: null,
+  errors: null
+)
+```
+