Class: NucleusApi::ResourceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/api/resource_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResourceApi

Returns a new instance of ResourceApi.



19
20
21
 
# File 'lib/nucleus_api/api/resource_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/nucleus_api/api/resource_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_fx_rate_bulk_using_post(fx_rate_list, opts = {}) ⇒ Array<FxRate>

Create a bulk fxRate Create a bulk fxRate.

Parameters:

  • fx_rate_list —

    fxRateList

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/nucleus_api/api/resource_api.rb', line 27

def create_fx_rate_bulk_using_post(fx_rate_list, opts = {})
  data, _status_code, _headers = create_fx_rate_bulk_using_post_with_http_info(fx_rate_list, opts)
  data
end

#create_fx_rate_bulk_using_post_with_http_info(fx_rate_list, opts = {}) ⇒ Array<(Array<FxRate>, Fixnum, Hash)>

Create a bulk fxRate Create a bulk fxRate.

Parameters:

  • fx_rate_list —

    fxRateList

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

    the optional parameters

Returns:

  • (Array<(Array<FxRate>, Fixnum, Hash)>) —

    Array<FxRate> 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
 
# File 'lib/nucleus_api/api/resource_api.rb', line 37

def create_fx_rate_bulk_using_post_with_http_info(fx_rate_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.create_fx_rate_bulk_using_post ...'
  end
  # verify the required parameter 'fx_rate_list' is set
  if @api_client.config.client_side_validation && fx_rate_list.nil?
    fail ArgumentError, "Missing the required parameter 'fx_rate_list' when calling ResourceApi.create_fx_rate_bulk_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/fx_rate'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(fx_rate_list)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<FxRate>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#create_fx_rate_bulk_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_institution_using_post(institution, opts = {}) ⇒ Institution

Create a institution Create a new institution.

Parameters:

  • institution —

    institution

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/nucleus_api/api/resource_api.rb', line 81

def create_institution_using_post(institution, opts = {})
  data, _status_code, _headers = create_institution_using_post_with_http_info(institution, opts)
  data
end

#create_institution_using_post_with_http_info(institution, opts = {}) ⇒ Array<(Institution, Fixnum, Hash)>

Create a institution Create a new institution.

Parameters:

  • institution —

    institution

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

    the optional parameters

Returns:

  • (Array<(Institution, Fixnum, Hash)>) —

    Institution data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/nucleus_api/api/resource_api.rb', line 91

def create_institution_using_post_with_http_info(institution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.create_institution_using_post ...'
  end
  # verify the required parameter 'institution' is set
  if @api_client.config.client_side_validation && institution.nil?
    fail ArgumentError, "Missing the required parameter 'institution' when calling ResourceApi.create_institution_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/institution'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(institution)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Institution')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#create_institution_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_institution_using_delete(institution_id, opts = {}) ⇒ nil

Delete a institution Delete a institution.

Parameters:

  • institution_id —

    UUID institution_id

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

    the optional parameters

Returns:

  • (nil) 


135
136
137
138
 
# File 'lib/nucleus_api/api/resource_api.rb', line 135

def delete_institution_using_delete(institution_id, opts = {})
  delete_institution_using_delete_with_http_info(institution_id, opts)
  nil
end

#delete_institution_using_delete_with_http_info(institution_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a institution Delete a institution.

Parameters:

  • institution_id —

    UUID institution_id

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/nucleus_api/api/resource_api.rb', line 145

def delete_institution_using_delete_with_http_info(institution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.delete_institution_using_delete ...'
  end
  # verify the required parameter 'institution_id' is set
  if @api_client.config.client_side_validation && institution_id.nil?
    fail ArgumentError, "Missing the required parameter 'institution_id' when calling ResourceApi.delete_institution_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/institution/{institution_id}'.sub('{' + 'institution_id' + '}', institution_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#delete_institution_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_result_for_mapping(opts = {}) ⇒ Array<Object>

Get all account category mapping Get all account category mapping

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

  • :hydrogen_account_category_id (String) —

    hydrogen_account_category_id

  • :match_primary (BOOLEAN) —

    match_primary (default to false)

  • :tenant_name (String) —

    tenant_name

  • :vendor_name (String) —

    vendor_name

Returns:

  • (Array<Object>) 


190
191
192
193
 
# File 'lib/nucleus_api/api/resource_api.rb', line 190

def (opts = {})
  data, _status_code, _headers = (opts)
  data
end

#get_account_result_for_mapping_with_http_info(opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Get all account category mapping Get all account category mapping

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

  • :hydrogen_account_category_id (String) —

    hydrogen_account_category_id

  • :match_primary (BOOLEAN) —

    match_primary

  • :tenant_name (String) —

    tenant_name

  • :vendor_name (String) —

    vendor_name

Returns:

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

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



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
236
237
238
239
240
241
 
# File 'lib/nucleus_api/api/resource_api.rb', line 204

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_account_result_for_mapping ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/account_category'

  # query parameters
  query_params = {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'hydrogen_account_category_id'] = opts[:'hydrogen_account_category_id'] if !opts[:'hydrogen_account_category_id'].nil?
  query_params[:'match_primary'] = opts[:'match_primary'] if !opts[:'match_primary'].nil?
  query_params[:'tenant_name'] = opts[:'tenant_name'] if !opts[:'tenant_name'].nil?
  query_params[:'vendor_name'] = opts[:'vendor_name'] if !opts[:'vendor_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_account_result_for_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_country_using_get(opts = {}) ⇒ Array<Country>

Get All Countries Get All Countries.

Parameters:

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

    the optional parameters

Returns:

  • (Array<Country>) 


246
247
248
249
 
# File 'lib/nucleus_api/api/resource_api.rb', line 246

def get_all_country_using_get(opts = {})
  data, _status_code, _headers = get_all_country_using_get_with_http_info(opts)
  data
end

#get_all_country_using_get_with_http_info(opts = {}) ⇒ Array<(Array<Country>, Fixnum, Hash)>

Get All Countries Get All Countries.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<Country>, Fixnum, Hash)>) —

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



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
 
# File 'lib/nucleus_api/api/resource_api.rb', line 255

def get_all_country_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_all_country_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/country'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Country>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_all_country_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_currency_using_get(opts = {}) ⇒ Array<Currency>

Get All Currencies Get All Currencies.

Parameters:

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

    the optional parameters

Returns:



292
293
294
295
 
# File 'lib/nucleus_api/api/resource_api.rb', line 292

def get_all_currency_using_get(opts = {})
  data, _status_code, _headers = get_all_currency_using_get_with_http_info(opts)
  data
end

#get_all_currency_using_get_with_http_info(opts = {}) ⇒ Array<(Array<Currency>, Fixnum, Hash)>

Get All Currencies Get All Currencies.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<Currency>, Fixnum, Hash)>) —

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/nucleus_api/api/resource_api.rb', line 301

def get_all_currency_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_all_currency_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/currency'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Currency>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_all_currency_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_merchant_category_code_using_get(opts = {}) ⇒ Array<MerchantCategoryCode>

Get All Merchant Category Codes Get All Merchant Category Codes.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

Returns:



339
340
341
342
 
# File 'lib/nucleus_api/api/resource_api.rb', line 339

def get_all_merchant_category_code_using_get(opts = {})
  data, _status_code, _headers = get_all_merchant_category_code_using_get_with_http_info(opts)
  data
end

#get_all_merchant_category_code_using_get_with_http_info(opts = {}) ⇒ Array<(Array<MerchantCategoryCode>, Fixnum, Hash)>

Get All Merchant Category Codes Get All Merchant Category Codes.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

Returns:

  • (Array<(Array<MerchantCategoryCode>, Fixnum, Hash)>) —

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



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
380
381
382
 
# File 'lib/nucleus_api/api/resource_api.rb', line 349

def get_all_merchant_category_code_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_all_merchant_category_code_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/merchant_category_code'

  # query parameters
  query_params = {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<MerchantCategoryCode>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_all_merchant_category_code_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_states_using_get(opts = {}) ⇒ Array<State>

List all state resource Get the information for all possible state resource.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country_code (String) —

    country_code (default to US)

Returns:



388
389
390
391
 
# File 'lib/nucleus_api/api/resource_api.rb', line 388

def get_all_states_using_get(opts = {})
  data, _status_code, _headers = get_all_states_using_get_with_http_info(opts)
  data
end

#get_all_states_using_get_with_http_info(opts = {}) ⇒ Array<(Array<State>, Fixnum, Hash)>

List all state resource Get the information for all possible state resource.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country_code (String) —

    country_code

Returns:

  • (Array<(Array<State>, Fixnum, Hash)>) —

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



398
399
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
 
# File 'lib/nucleus_api/api/resource_api.rb', line 398

def get_all_states_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_all_states_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/state'

  # query parameters
  query_params = {}
  query_params[:'country_code'] = opts[:'country_code'] if !opts[:'country_code'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<State>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_all_states_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_statistics_using_get(opts = {}) ⇒ Hash<String, Array<StatisticResourceVO>>

List all statistic resource Get the information for all possible statistic resource.

Parameters:

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

    the optional parameters

Returns:



436
437
438
439
 
# File 'lib/nucleus_api/api/resource_api.rb', line 436

def get_all_statistics_using_get(opts = {})
  data, _status_code, _headers = get_all_statistics_using_get_with_http_info(opts)
  data
end

#get_all_statistics_using_get_with_http_info(opts = {}) ⇒ Array<(Hash<String, Array<StatisticResourceVO>>, Fixnum, Hash)>

List all statistic resource Get the information for all possible statistic resource.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Array<StatisticResourceVO>>, Fixnum, Hash)>) —

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



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/nucleus_api/api/resource_api.rb', line 445

def get_all_statistics_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_all_statistics_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/statistic'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Array<StatisticResourceVO>>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_all_statistics_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_currency_exchange_rate_all_using_get(opts = {}) ⇒ Array<FxRateView>

List all fxRates Get information for all fxRates defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

Returns:



483
484
485
486
 
# File 'lib/nucleus_api/api/resource_api.rb', line 483

def get_currency_exchange_rate_all_using_get(opts = {})
  data, _status_code, _headers = get_currency_exchange_rate_all_using_get_with_http_info(opts)
  data
end

#get_currency_exchange_rate_all_using_get_with_http_info(opts = {}) ⇒ Array<(Array<FxRateView>, Fixnum, Hash)>

List all fxRates Get information for all fxRates defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

Returns:

  • (Array<(Array<FxRateView>, Fixnum, Hash)>) —

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



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
524
525
526
 
# File 'lib/nucleus_api/api/resource_api.rb', line 493

def get_currency_exchange_rate_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_currency_exchange_rate_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/fx_rate'

  # query parameters
  query_params = {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<FxRateView>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_currency_exchange_rate_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_institution_all_using_get(opts = {}) ⇒ PageInstitution

List all institutions List all institution.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



536
537
538
539
 
# File 'lib/nucleus_api/api/resource_api.rb', line 536

def get_institution_all_using_get(opts = {})
  data, _status_code, _headers = get_institution_all_using_get_with_http_info(opts)
  data
end

#get_institution_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageInstitution, Fixnum, Hash)>

List all institutions List all institution.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageInstitution, Fixnum, Hash)>) —

    PageInstitution data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/resource_api.rb', line 550

def get_institution_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_institution_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/institution'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PageInstitution')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_institution_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_institution_using_get(institution_id, opts = {}) ⇒ Institution

Retrieve a institution Retrieve a institution.

Parameters:

  • institution_id —

    UUID institution_id

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

    the optional parameters

Returns:



593
594
595
596
 
# File 'lib/nucleus_api/api/resource_api.rb', line 593

def get_institution_using_get(institution_id, opts = {})
  data, _status_code, _headers = get_institution_using_get_with_http_info(institution_id, opts)
  data
end

#get_institution_using_get_with_http_info(institution_id, opts = {}) ⇒ Array<(Institution, Fixnum, Hash)>

Retrieve a institution Retrieve a institution.

Parameters:

  • institution_id —

    UUID institution_id

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

    the optional parameters

Returns:

  • (Array<(Institution, Fixnum, Hash)>) —

    Institution data, response status code and response headers



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/nucleus_api/api/resource_api.rb', line 603

def get_institution_using_get_with_http_info(institution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_institution_using_get ...'
  end
  # verify the required parameter 'institution_id' is set
  if @api_client.config.client_side_validation && institution_id.nil?
    fail ArgumentError, "Missing the required parameter 'institution_id' when calling ResourceApi.get_institution_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/institution/{institution_id}'.sub('{' + 'institution_id' + '}', institution_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Institution')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_institution_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_merchants_all_using_get(opts = {}) ⇒ MXMerchantRes

Get all merchants List all merchants.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to id)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



649
650
651
652
 
# File 'lib/nucleus_api/api/resource_api.rb', line 649

def get_merchants_all_using_get(opts = {})
  data, _status_code, _headers = get_merchants_all_using_get_with_http_info(opts)
  data
end

#get_merchants_all_using_get_with_http_info(opts = {}) ⇒ Array<(MXMerchantRes, Fixnum, Hash)>

Get all merchants List all merchants.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(MXMerchantRes, Fixnum, Hash)>) —

    MXMerchantRes data, response status code and response headers



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/nucleus_api/api/resource_api.rb', line 663

def get_merchants_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_merchants_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/merchant'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MXMerchantRes')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_merchants_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transaction_result_for_mapping(opts = {}) ⇒ Array<Object>

Get all transaction category mapping Get all transaction category mapping

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

  • :hydrogen_transaction_category_id (String) —

    hydrogen_transaction_category_id

  • :match_primary (BOOLEAN) —

    match_primary (default to false)

  • :tenant_name (String) —

    tenant_name

  • :vendor_name (String) —

    vendor_name

Returns:

  • (Array<Object>) 


710
711
712
713
 
# File 'lib/nucleus_api/api/resource_api.rb', line 710

def get_transaction_result_for_mapping(opts = {})
  data, _status_code, _headers = get_transaction_result_for_mapping_with_http_info(opts)
  data
end

#get_transaction_result_for_mapping_with_http_info(opts = {}) ⇒ Array<(Array<Object>, Fixnum, Hash)>

Get all transaction category mapping Get all transaction category mapping

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    filter

  • :hydrogen_transaction_category_id (String) —

    hydrogen_transaction_category_id

  • :match_primary (BOOLEAN) —

    match_primary

  • :tenant_name (String) —

    tenant_name

  • :vendor_name (String) —

    vendor_name

Returns:

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

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



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
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/nucleus_api/api/resource_api.rb', line 724

def get_transaction_result_for_mapping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.get_transaction_result_for_mapping ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/transaction_category'

  # query parameters
  query_params = {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'hydrogen_transaction_category_id'] = opts[:'hydrogen_transaction_category_id'] if !opts[:'hydrogen_transaction_category_id'].nil?
  query_params[:'match_primary'] = opts[:'match_primary'] if !opts[:'match_primary'].nil?
  query_params[:'tenant_name'] = opts[:'tenant_name'] if !opts[:'tenant_name'].nil?
  query_params[:'vendor_name'] = opts[:'vendor_name'] if !opts[:'vendor_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#get_transaction_result_for_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_institution_using_put(institution, institution_id, opts = {}) ⇒ Institution

Update a institution Update a institution.

Parameters:

  • institution —

    institution

  • institution_id —

    UUID institution_id

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

    the optional parameters

Returns:



768
769
770
771
 
# File 'lib/nucleus_api/api/resource_api.rb', line 768

def update_institution_using_put(institution, institution_id, opts = {})
  data, _status_code, _headers = update_institution_using_put_with_http_info(institution, institution_id, opts)
  data
end

#update_institution_using_put_with_http_info(institution, institution_id, opts = {}) ⇒ Array<(Institution, Fixnum, Hash)>

Update a institution Update a institution.

Parameters:

  • institution —

    institution

  • institution_id —

    UUID institution_id

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

    the optional parameters

Returns:

  • (Array<(Institution, Fixnum, Hash)>) —

    Institution data, response status code and response headers



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File 'lib/nucleus_api/api/resource_api.rb', line 779

def update_institution_using_put_with_http_info(institution, institution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourceApi.update_institution_using_put ...'
  end
  # verify the required parameter 'institution' is set
  if @api_client.config.client_side_validation && institution.nil?
    fail ArgumentError, "Missing the required parameter 'institution' when calling ResourceApi.update_institution_using_put"
  end
  # verify the required parameter 'institution_id' is set
  if @api_client.config.client_side_validation && institution_id.nil?
    fail ArgumentError, "Missing the required parameter 'institution_id' when calling ResourceApi.update_institution_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/resource/institution/{institution_id}'.sub('{' + 'institution_id' + '}', institution_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(institution)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Institution')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResourceApi#update_institution_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end