Class: Trulioo::ConfigurationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/trulioo_sdk/api/configuration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationApi

Returns a new instance of ConfigurationApi.



15
16
17
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 15

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#get_business_registration_numbers(mode, country_code, jurisdiction_code, opts = {}) ⇒ Array<BusinessRegistrationNumber>

Get Business Registration Numbers Gets the currently configured business registration numbers, for country and an optionally supplied jurisdiction

Parameters:

Returns:



25
26
27
28
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 25

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_with_http_info(mode, country_code, jurisdiction_code, opts = {}) ⇒ Array<(Array<BusinessRegistrationNumber>, Integer, Hash)>

Get Business Registration Numbers Gets the currently configured business registration numbers, for country and an optionally supplied jurisdiction

Parameters:

Returns:

  • (Array<(Array<BusinessRegistrationNumber>, Integer, Hash)>) —

    Array<BusinessRegistrationNumber> data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 37

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(mode, configuration_name, country_code, opts = {}) ⇒ Array<String>

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.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<String>) 


100
101
102
103
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 100

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_with_http_info(mode, configuration_name, country_code, opts = {}) ⇒ Array<(Array<String>, Integer, Hash)>

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.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<String>, Integer, Hash)>) —

    Array<String> data, response status code and response headers



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 112

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(mode, configuration_name, opts = {}) ⇒ Array<String>

Get Country Codes This method retrieves all the countries that are available to perform a verification.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<String>) 


174
175
176
177
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 174

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_with_http_info(mode, configuration_name, opts = {}) ⇒ Array<(Array<String>, Integer, Hash)>

Get Country Codes This method retrieves all the countries that are available to perform a verification.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<String>, Integer, Hash)>) —

    Array<String> data, response status code and response headers



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 185

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(mode, country_code, opts = {}) ⇒ Array<CountrySubdivision>

Get Country Subdivisions Gets the provinces states or other subdivisions for a country, mostly matches ISO 3166-2

Parameters:

  • mode (String) —

    trial or live

  • country_code (String) —

    Country alpha2 code, get the the call to countrycodes

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 243

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_with_http_info(mode, country_code, opts = {}) ⇒ Array<(Array<CountrySubdivision>, Integer, Hash)>

Get Country Subdivisions Gets the provinces states or other subdivisions for a country, mostly matches ISO 3166-2

Parameters:

  • mode (String) —

    trial or live

  • country_code (String) —

    Country alpha2 code, get the the call to countrycodes

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<CountrySubdivision>, Integer, Hash)>) —

    Array<CountrySubdivision> data, response status code and response headers



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 254

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(mode, configuration_name, country_code, opts = {}) ⇒ Array<NormalizedDatasourceGroupCountry>

Get Datasources Gets datasource groups configured for your product and country.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



313
314
315
316
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 313

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_with_http_info(mode, configuration_name, country_code, opts = {}) ⇒ Array<(Array<NormalizedDatasourceGroupCountry>, Integer, Hash)>

Get Datasources Gets datasource groups configured for your product and country.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 325

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(mode, configuration_name, country_code, opts = {}) ⇒ Array<Consent>

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.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



388
389
390
391
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 388

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_with_http_info(mode, configuration_name, country_code, opts = {}) ⇒ Array<(Array<Consent>, Integer, Hash)>

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.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<Consent>, Integer, Hash)>) —

    Array<Consent> data, response status code and response headers



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 400

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(mode, country_code, opts = {}) ⇒ Hash<String, Array<String>>

Get Document Types Gets the document types available for a country.

Parameters:

  • mode (String) —

    trial or live

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Array<String>>) 


462
463
464
465
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 462

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_with_http_info(mode, country_code, opts = {}) ⇒ Array<(Hash<String, Array<String>>, Integer, Hash)>

Get Document Types Gets the document types available for a country.

Parameters:

  • mode (String) —

    trial or live

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Array<String>>, Integer, Hash)>) —

    Hash<String, Array<String>> data, response status code and response headers



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 473

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(mode, configuration_name, country_code, opts = {}) ⇒ Object

Get Fields Generates json schema for the API, the schema is dynamic based on the country and configuration you are using. json-schema.org/documentation.html

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


532
533
534
535
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 532

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_with_http_info(mode, configuration_name, country_code, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get Fields Generates json schema for the API, the schema is dynamic based on the country and configuration you are using. json-schema.org/documentation.html

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 544

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(mode, configuration_name, country_code, opts = {}) ⇒ Object

Get Recommended Fields Generates json schema for the API, the schema is dynamic based on the recommendedFields country and account you are using. json-schema.org/documentation.html

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


607
608
609
610
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 607

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_with_http_info(mode, configuration_name, country_code, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get Recommended Fields Generates json schema for the API, the schema is dynamic based on the recommendedFields country and account you are using. json-schema.org/documentation.html

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 619

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(mode, configuration_name, country_code, opts = {}) ⇒ Array<TestEntityDataFields>

Get Test Entities Gets the test entities configured for your product and country.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



682
683
684
685
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 682

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_with_http_info(mode, configuration_name, country_code, opts = {}) ⇒ Array<(Array<TestEntityDataFields>, Integer, Hash)>

Get Test Entities Gets the test entities configured for your product and country.

Parameters:

  • mode (String) —

    trial or live

  • configuration_name (String) —

    The product configuration. Currently &quot;Identity Verification&quot; for all products.

  • country_code (String) —

    Call CountryCodes to get the countries available to you.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<TestEntityDataFields>, Integer, Hash)>) —

    Array<TestEntityDataFields> data, response status code and response headers



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/trulioo_sdk/api/configuration_api.rb', line 694

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