trulioo_sdk 1.0.3

data/docs/VerifyRequest.md

@@ -0,0 +1,38 @@
+# Trulioo::VerifyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accept_trulioo_terms_and_conditions** | **Boolean** | Indicate that Trulioo terms and conditions are accepted | [optional] |
+| **demo** | **Boolean** | This field is not used anymore.  If provided it must match the setting on your account or you will get an error. | [optional] |
+| **call_back_url** | **String** |  | [optional] |
+| **timeout** | **Integer** |  | [optional] |
+| **cleansed_address** | **Boolean** | Set to true if you want to receive address cleanse information,  This will only change the response if you have address cleansing enabled for the country you are querying for. | [optional] |
+| **configuration_name** | **String** | Indicate the configuration used for the verification. Currently only  'Identity Verification' is supported. | [optional] |
+| **consent_for_data_sources** | **Array<String>** | Some datasources required your customer provide consent to access them.  Set that the customer has provided consent for each  datasource that requires one.  If consent is not provided the datasource will not be queried. | [optional] |
+| **country_code** | **String** | The country code for which the verification needs to be performed. |  |
+| **customer_reference_id** | **String** | Customer Reference Id | [optional] |
+| **data_fields** | [**DataFields**](DataFields.md) |  |  |
+| **verbose_mode** | **Boolean** | Verbose Mode Output Flag. | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::VerifyRequest.new(
+  accept_trulioo_terms_and_conditions: null,
+  demo: null,
+  call_back_url: null,
+  timeout: null,
+  cleansed_address: null,
+  configuration_name: null,
+  consent_for_data_sources: null,
+  country_code: null,
+  customer_reference_id: null,
+  data_fields: null,
+  verbose_mode: null
+)
+```
+

data/docs/VerifyResult.md

@@ -0,0 +1,30 @@
+# Trulioo::VerifyResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | The id for the transaction it will be a GUID | [optional] |
+| **uploaded_dt** | **Time** | Time in UTC | [optional] |
+| **country_code** | **String** | Country Code | [optional] |
+| **product_name** | **String** | Product Name | [optional] |
+| **record** | [**Record**](Record.md) |  | [optional] |
+| **customer_reference_id** | **String** | Customer Reference Id | [optional] |
+| **errors** | [**Array<ServiceError>**](ServiceError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::VerifyResult.new(
+  transaction_id: null,
+  uploaded_dt: null,
+  country_code: null,
+  product_name: null,
+  record: null,
+  customer_reference_id: null,
+  errors: null
+)
+```
+

data/lib/trulioo_sdk.rb

@@ -0,0 +1,77 @@
+=begin
+Trulioo Ruby SDK
+
+Gem version: 1.0.3
+Trulioo OpenAPI version: v1
+Generated by OpenAPI Generator version: 5.0.1
+=end
+
+# Common files
+require 'trulioo_sdk/api_client'
+require 'trulioo_sdk/api_error'
+require 'trulioo_sdk/version'
+require 'trulioo_sdk/configuration'
+
+# Models
+require 'trulioo_sdk/models/address'
+require 'trulioo_sdk/models/appended_field'
+require 'trulioo_sdk/models/business'
+require 'trulioo_sdk/models/business_record'
+require 'trulioo_sdk/models/business_registration_number'
+require 'trulioo_sdk/models/business_registration_number_mask'
+require 'trulioo_sdk/models/business_result'
+require 'trulioo_sdk/models/business_search_request'
+require 'trulioo_sdk/models/business_search_request_business_search_model'
+require 'trulioo_sdk/models/business_search_response'
+require 'trulioo_sdk/models/business_search_response_industry_code'
+require 'trulioo_sdk/models/communication'
+require 'trulioo_sdk/models/consent'
+require 'trulioo_sdk/models/country_subdivision'
+require 'trulioo_sdk/models/data_field'
+require 'trulioo_sdk/models/data_fields'
+require 'trulioo_sdk/models/datasource_field'
+require 'trulioo_sdk/models/datasource_result'
+require 'trulioo_sdk/models/document'
+require 'trulioo_sdk/models/driver_licence'
+require 'trulioo_sdk/models/location'
+require 'trulioo_sdk/models/location_additional_fields'
+require 'trulioo_sdk/models/national_id'
+require 'trulioo_sdk/models/normalized_datasource_field'
+require 'trulioo_sdk/models/normalized_datasource_group_country'
+require 'trulioo_sdk/models/passport'
+require 'trulioo_sdk/models/person_info'
+require 'trulioo_sdk/models/person_info_additional_fields'
+require 'trulioo_sdk/models/record'
+require 'trulioo_sdk/models/record_rule'
+require 'trulioo_sdk/models/result'
+require 'trulioo_sdk/models/service_error'
+require 'trulioo_sdk/models/test_entity_data_fields'
+require 'trulioo_sdk/models/transaction_record_result'
+require 'trulioo_sdk/models/transaction_record_result_all_of'
+require 'trulioo_sdk/models/transaction_status'
+require 'trulioo_sdk/models/verify_request'
+require 'trulioo_sdk/models/verify_result'
+
+# APIs
+require 'trulioo_sdk/api/business_api'
+require 'trulioo_sdk/api/configuration_api'
+require 'trulioo_sdk/api/connection_api'
+require 'trulioo_sdk/api/verifications_api'
+
+module Trulioo
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Trulioo.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/trulioo_sdk/api/business_api.rb

@@ -0,0 +1,158 @@
+=begin
+Trulioo Ruby SDK
+
+Gem version: 1.0.3
+Trulioo OpenAPI version: v1
+Generated by OpenAPI Generator version: 5.0.1
+=end
+
+require 'cgi'
+
+module Trulioo
+  class BusinessApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Business Search Result
+    # returns the a business search result.
+    # @param mode [String] trial or live
+    # @param id [String] transaction record id
+    # @param [Hash] opts the optional parameters
+    # @return [BusinessSearchResponse]
+    def get_business_search_result(mode, id, opts = {})
+      data, _status_code, _headers = get_business_search_result_with_http_info(mode, id, opts)
+      data
+    end
+
+    # Get Business Search Result
+    # returns the a business search result.
+    # @param mode [String] trial or live
+    # @param id [String] transaction record id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BusinessSearchResponse, Integer, Hash)>] BusinessSearchResponse data, response status code and response headers
+    def get_business_search_result_with_http_info(mode, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BusinessApi.get_business_search_result ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling BusinessApi.get_business_search_result"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling BusinessApi.get_business_search_result"
+      end
+      # resource path
+      local_var_path = '/{mode}/business/v1/search/transactionrecord/{id}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'id' + '}', CGI.escape(id.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BusinessSearchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"BusinessApi.get_business_search_result",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BusinessApi#get_business_search_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search
+    # Calling this method will perform a business search.
+    # @param mode [String] trial or live
+    # @param business_search_request [BusinessSearchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BusinessSearchResponse]
+    def search(mode, business_search_request, opts = {})
+      data, _status_code, _headers = search_with_http_info(mode, business_search_request, opts)
+      data
+    end
+
+    # Search
+    # Calling this method will perform a business search.
+    # @param mode [String] trial or live
+    # @param business_search_request [BusinessSearchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BusinessSearchResponse, Integer, Hash)>] BusinessSearchResponse data, response status code and response headers
+    def search_with_http_info(mode, business_search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BusinessApi.search ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling BusinessApi.search"
+      end
+      # verify the required parameter 'business_search_request' is set
+      if @api_client.config.client_side_validation && business_search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'business_search_request' when calling BusinessApi.search"
+      end
+      # resource path
+      local_var_path = '/{mode}/business/v1/search'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(business_search_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BusinessSearchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"BusinessApi.search",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BusinessApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/trulioo_sdk/api/configuration_api.rb

@@ -0,0 +1,750 @@
+=begin
+Trulioo Ruby SDK
+
+Gem version: 1.0.3
+Trulioo OpenAPI version: v1
+Generated by OpenAPI Generator version: 5.0.1
+=end
+
+require 'cgi'
+
+module Trulioo
+  class ConfigurationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Business Registration Numbers
+    # Gets the currently configured business registration numbers, for country and an optionally supplied jurisdiction
+    # @param mode [String] trial or live
+    # @param country_code [String] Country alpha2 code, get via the call to https://developer.trulioo.com/reference#getcountrycodes
+    # @param jurisdiction_code [String] Optional jurisdiction code, get via the call to https://developer.trulioo.com/reference#getcountrysubdivisions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<BusinessRegistrationNumber>]
+    def get_business_registration_numbers(mode, country_code, jurisdiction_code, opts = {})
+      data, _status_code, _headers = get_business_registration_numbers_with_http_info(mode, country_code, jurisdiction_code, opts)
+      data
+    end
+
+    # Get Business Registration Numbers
+    # Gets the currently configured business registration numbers, for country and an optionally supplied jurisdiction
+    # @param mode [String] trial or live
+    # @param country_code [String] Country alpha2 code, get via the call to https://developer.trulioo.com/reference#getcountrycodes
+    # @param jurisdiction_code [String] Optional jurisdiction code, get via the call to https://developer.trulioo.com/reference#getcountrysubdivisions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<BusinessRegistrationNumber>, Integer, Hash)>] Array<BusinessRegistrationNumber> data, response status code and response headers
+    def get_business_registration_numbers_with_http_info(mode, country_code, jurisdiction_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_business_registration_numbers ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_business_registration_numbers"
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling ConfigurationApi.get_business_registration_numbers"
+      end
+      # verify the required parameter 'jurisdiction_code' is set
+      if @api_client.config.client_side_validation && jurisdiction_code.nil?
+        fail ArgumentError, "Missing the required parameter 'jurisdiction_code' when calling ConfigurationApi.get_business_registration_numbers"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/businessregistrationnumbers/{countryCode}/{jurisdictionCode}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'countryCode' + '}', CGI.escape(country_code.to_s).gsub('+', '%20')).sub('{' + 'jurisdictionCode' + '}', CGI.escape(jurisdiction_code.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<BusinessRegistrationNumber>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_business_registration_numbers",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_business_registration_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Consents
+    # This method retrieves the consents required for data sources currently configured in your account configuration.   The response for this method contains a collection of strings that Verify method's ConsentForDataSources field expects to perform a verification using those data sources.   A failure to provide an element from the string collection will lead to a <a class=\"link-to-api\" href=\"#errors\">1005</a> service error.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def get_consents(mode, configuration_name, country_code, opts = {})
+      data, _status_code, _headers = get_consents_with_http_info(mode, configuration_name, country_code, opts)
+      data
+    end
+
+    # Get Consents
+    # This method retrieves the consents required for data sources currently configured in your account configuration.   The response for this method contains a collection of strings that Verify method&#39;s ConsentForDataSources field expects to perform a verification using those data sources.   A failure to provide an element from the string collection will lead to a &lt;a class&#x3D;\&quot;link-to-api\&quot; href&#x3D;\&quot;#errors\&quot;&gt;1005&lt;/a&gt; service error.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def get_consents_with_http_info(mode, configuration_name, country_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_consents ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_consents"
+      end
+      # verify the required parameter 'configuration_name' is set
+      if @api_client.config.client_side_validation && configuration_name.nil?
+        fail ArgumentError, "Missing the required parameter 'configuration_name' when calling ConfigurationApi.get_consents"
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling ConfigurationApi.get_consents"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/consents/{configurationName}/{countryCode}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'configurationName' + '}', CGI.escape(configuration_name.to_s).gsub('+', '%20')).sub('{' + 'countryCode' + '}', CGI.escape(country_code.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<String>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_consents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_consents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Country Codes
+    # This method retrieves all the countries that are available to perform a verification.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def get_country_codes(mode, configuration_name, opts = {})
+      data, _status_code, _headers = get_country_codes_with_http_info(mode, configuration_name, opts)
+      data
+    end
+
+    # Get Country Codes
+    # This method retrieves all the countries that are available to perform a verification.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def get_country_codes_with_http_info(mode, configuration_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_country_codes ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_country_codes"
+      end
+      # verify the required parameter 'configuration_name' is set
+      if @api_client.config.client_side_validation && configuration_name.nil?
+        fail ArgumentError, "Missing the required parameter 'configuration_name' when calling ConfigurationApi.get_country_codes"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/countrycodes/{configurationName}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'configurationName' + '}', CGI.escape(configuration_name.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<String>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_country_codes",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_country_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Country Subdivisions
+    # Gets the provinces states or other subdivisions for a country, mostly matches ISO 3166-2
+    # @param mode [String] trial or live
+    # @param country_code [String] Country alpha2 code, get the the call to countrycodes
+    # @param [Hash] opts the optional parameters
+    # @return [Array<CountrySubdivision>]
+    def get_country_subdivisions(mode, country_code, opts = {})
+      data, _status_code, _headers = get_country_subdivisions_with_http_info(mode, country_code, opts)
+      data
+    end
+
+    # Get Country Subdivisions
+    # Gets the provinces states or other subdivisions for a country, mostly matches ISO 3166-2
+    # @param mode [String] trial or live
+    # @param country_code [String] Country alpha2 code, get the the call to countrycodes
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<CountrySubdivision>, Integer, Hash)>] Array<CountrySubdivision> data, response status code and response headers
+    def get_country_subdivisions_with_http_info(mode, country_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_country_subdivisions ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_country_subdivisions"
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling ConfigurationApi.get_country_subdivisions"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/countrysubdivisions/{countryCode}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'countryCode' + '}', CGI.escape(country_code.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<CountrySubdivision>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_country_subdivisions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_country_subdivisions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Datasources
+    # Gets datasource groups configured for your product and country.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<NormalizedDatasourceGroupCountry>]
+    def get_datasources(mode, configuration_name, country_code, opts = {})
+      data, _status_code, _headers = get_datasources_with_http_info(mode, configuration_name, country_code, opts)
+      data
+    end
+
+    # Get Datasources
+    # Gets datasource groups configured for your product and country.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<NormalizedDatasourceGroupCountry>, Integer, Hash)>] Array<NormalizedDatasourceGroupCountry> data, response status code and response headers
+    def get_datasources_with_http_info(mode, configuration_name, country_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_datasources ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_datasources"
+      end
+      # verify the required parameter 'configuration_name' is set
+      if @api_client.config.client_side_validation && configuration_name.nil?
+        fail ArgumentError, "Missing the required parameter 'configuration_name' when calling ConfigurationApi.get_datasources"
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling ConfigurationApi.get_datasources"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/datasources/{configurationName}/{countryCode}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'configurationName' + '}', CGI.escape(configuration_name.to_s).gsub('+', '%20')).sub('{' + 'countryCode' + '}', CGI.escape(country_code.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<NormalizedDatasourceGroupCountry>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_datasources",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_datasources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Detailed Consents
+    # This method retrieves details about consents required for data sources currently configured in your account configuration.   The response for this method contains a collection of objects.  Each object contains the Name of the data source, Text outlining what the user is consenting to, and optionally a Url where the user can find more information about how their data will be used.    Failure to provide a Name from the object collection will lead to a <a class=\"link-to-api\" href=\"#errors\">1005</a> service error.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Consent>]
+    def get_detailed_consents(mode, configuration_name, country_code, opts = {})
+      data, _status_code, _headers = get_detailed_consents_with_http_info(mode, configuration_name, country_code, opts)
+      data
+    end
+
+    # Get Detailed Consents
+    # This method retrieves details about consents required for data sources currently configured in your account configuration.   The response for this method contains a collection of objects.  Each object contains the Name of the data source, Text outlining what the user is consenting to, and optionally a Url where the user can find more information about how their data will be used.    Failure to provide a Name from the object collection will lead to a &lt;a class&#x3D;\&quot;link-to-api\&quot; href&#x3D;\&quot;#errors\&quot;&gt;1005&lt;/a&gt; service error.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Consent>, Integer, Hash)>] Array<Consent> data, response status code and response headers
+    def get_detailed_consents_with_http_info(mode, configuration_name, country_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_detailed_consents ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_detailed_consents"
+      end
+      # verify the required parameter 'configuration_name' is set
+      if @api_client.config.client_side_validation && configuration_name.nil?
+        fail ArgumentError, "Missing the required parameter 'configuration_name' when calling ConfigurationApi.get_detailed_consents"
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling ConfigurationApi.get_detailed_consents"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/detailedConsents/{configurationName}/{countryCode}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'configurationName' + '}', CGI.escape(configuration_name.to_s).gsub('+', '%20')).sub('{' + 'countryCode' + '}', CGI.escape(country_code.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Consent>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_detailed_consents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_detailed_consents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Document Types
+    # Gets the document types available for a country.
+    # @param mode [String] trial or live
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Array<String>>]
+    def get_document_types(mode, country_code, opts = {})
+      data, _status_code, _headers = get_document_types_with_http_info(mode, country_code, opts)
+      data
+    end
+
+    # Get Document Types
+    # Gets the document types available for a country.
+    # @param mode [String] trial or live
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Array<String>>, Integer, Hash)>] Hash<String, Array<String>> data, response status code and response headers
+    def get_document_types_with_http_info(mode, country_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_document_types ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_document_types"
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling ConfigurationApi.get_document_types"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/documentTypes/{countryCode}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'countryCode' + '}', CGI.escape(country_code.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, Array<String>>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_document_types",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_document_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Fields
+    # Generates json schema for the API, the schema is dynamic based on the country and configuration you are using.  http://json-schema.org/documentation.html
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_fields(mode, configuration_name, country_code, opts = {})
+      data, _status_code, _headers = get_fields_with_http_info(mode, configuration_name, country_code, opts)
+      data
+    end
+
+    # Get Fields
+    # Generates json schema for the API, the schema is dynamic based on the country and configuration you are using.  http://json-schema.org/documentation.html
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_fields_with_http_info(mode, configuration_name, country_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_fields ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_fields"
+      end
+      # verify the required parameter 'configuration_name' is set
+      if @api_client.config.client_side_validation && configuration_name.nil?
+        fail ArgumentError, "Missing the required parameter 'configuration_name' when calling ConfigurationApi.get_fields"
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling ConfigurationApi.get_fields"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/fields/{configurationName}/{countryCode}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'configurationName' + '}', CGI.escape(configuration_name.to_s).gsub('+', '%20')).sub('{' + 'countryCode' + '}', CGI.escape(country_code.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_fields",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Recommended Fields
+    # Generates json schema for the API, the schema is dynamic based on the recommendedFields country and account you are using.  http://json-schema.org/documentation.html
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_recommended_fields(mode, configuration_name, country_code, opts = {})
+      data, _status_code, _headers = get_recommended_fields_with_http_info(mode, configuration_name, country_code, opts)
+      data
+    end
+
+    # Get Recommended Fields
+    # Generates json schema for the API, the schema is dynamic based on the recommendedFields country and account you are using.  http://json-schema.org/documentation.html
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_recommended_fields_with_http_info(mode, configuration_name, country_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_recommended_fields ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_recommended_fields"
+      end
+      # verify the required parameter 'configuration_name' is set
+      if @api_client.config.client_side_validation && configuration_name.nil?
+        fail ArgumentError, "Missing the required parameter 'configuration_name' when calling ConfigurationApi.get_recommended_fields"
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling ConfigurationApi.get_recommended_fields"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/recommendedfields/{configurationName}/{countryCode}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'configurationName' + '}', CGI.escape(configuration_name.to_s).gsub('+', '%20')).sub('{' + 'countryCode' + '}', CGI.escape(country_code.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_recommended_fields",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_recommended_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Test Entities
+    # Gets the test entities configured for your product and country.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<TestEntityDataFields>]
+    def get_test_entities(mode, configuration_name, country_code, opts = {})
+      data, _status_code, _headers = get_test_entities_with_http_info(mode, configuration_name, country_code, opts)
+      data
+    end
+
+    # Get Test Entities
+    # Gets the test entities configured for your product and country.
+    # @param mode [String] trial or live
+    # @param configuration_name [String] The product configuration. Currently \&quot;Identity Verification\&quot; for all products.
+    # @param country_code [String] Call CountryCodes to get the countries available to you.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<TestEntityDataFields>, Integer, Hash)>] Array<TestEntityDataFields> data, response status code and response headers
+    def get_test_entities_with_http_info(mode, configuration_name, country_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_test_entities ...'
+      end
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling ConfigurationApi.get_test_entities"
+      end
+      # verify the required parameter 'configuration_name' is set
+      if @api_client.config.client_side_validation && configuration_name.nil?
+        fail ArgumentError, "Missing the required parameter 'configuration_name' when calling ConfigurationApi.get_test_entities"
+      end
+      # verify the required parameter 'country_code' is set
+      if @api_client.config.client_side_validation && country_code.nil?
+        fail ArgumentError, "Missing the required parameter 'country_code' when calling ConfigurationApi.get_test_entities"
+      end
+      # resource path
+      local_var_path = '/{mode}/configuration/v1/testentities/{configurationName}/{countryCode}'.sub('{' + 'mode' + '}', CGI.escape(mode.to_s).gsub('+', '%20')).sub('{' + 'configurationName' + '}', CGI.escape(configuration_name.to_s).gsub('+', '%20')).sub('{' + 'countryCode' + '}', CGI.escape(country_code.to_s).gsub('+', '%20'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<TestEntityDataFields>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConfigurationApi.get_test_entities",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConfigurationApi#get_test_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end