Class: FuseClient::FuseApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fuse_client/api/fuse_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FuseApi

Returns a new instance of FuseApi.



19
20
21
 
# File 'lib/fuse_client/api/fuse_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/fuse_client/api/fuse_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_account_events(account_id, opts = {}) ⇒ AddAccountEventsResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



26
27
28
29
 
# File 'lib/fuse_client/api/fuse_api.rb', line 26

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

#add_account_events_with_http_info(account_id, opts = {}) ⇒ Array<(AddAccountEventsResponse, Integer, Hash)>

Returns AddAccountEventsResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    AddAccountEventsResponse data, response status code and response headers



35
36
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
 
# File 'lib/fuse_client/api/fuse_api.rb', line 35

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.add_account_events ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling FuseApi.add_account_events"
  end
  # resource path
  local_var_path = '/v1/accounts/{account_id}/events'.sub('{' + 'account_id' + '}', CGI.escape(.to_s))

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'add_account_events_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'AddAccountEventsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.add_account_events",
    :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: FuseApi#add_account_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_asset_report(opts = {}) ⇒ CreateAssetReportResponse

Use this endpoint to generate an Asset Report for a user. For Plaid, you will need to have the assets product enabled on your plaid account.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



92
93
94
95
 
# File 'lib/fuse_client/api/fuse_api.rb', line 92

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

#create_asset_report_with_http_info(opts = {}) ⇒ Array<(CreateAssetReportResponse, Integer, Hash)>

Use this endpoint to generate an Asset Report for a user. For Plaid, you will need to have the assets product enabled on your plaid account.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CreateAssetReportResponse data, response status code and response headers



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/fuse_client/api/fuse_api.rb', line 101

def create_asset_report_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.create_asset_report ...'
  end
  # resource path
  local_var_path = '/v1/financial_connections/asset_report/create'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_asset_report_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CreateAssetReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.create_asset_report",
    :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: FuseApi#create_asset_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_consumer_risk_report(opts = {}) ⇒ CreateConsumerRiskReportResponse

Starts the background process that will calculate the consumer risk report depending on the customization passed in.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



154
155
156
157
 
# File 'lib/fuse_client/api/fuse_api.rb', line 154

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

#create_consumer_risk_report_customization(opts = {}) ⇒ CreateConsumerRiskReportCustomizationResponse

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



215
216
217
218
 
# File 'lib/fuse_client/api/fuse_api.rb', line 215

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

#create_consumer_risk_report_customization_with_http_info(opts = {}) ⇒ Array<(CreateConsumerRiskReportCustomizationResponse, Integer, Hash)>

Returns CreateConsumerRiskReportCustomizationResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/fuse_client/api/fuse_api.rb', line 223

def create_consumer_risk_report_customization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.create_consumer_risk_report_customization ...'
  end
  # resource path
  local_var_path = '/v1/risk_report/consumer/customization'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_consumer_risk_report_customization_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CreateConsumerRiskReportCustomizationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.create_consumer_risk_report_customization",
    :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: FuseApi#create_consumer_risk_report_customization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_consumer_risk_report_with_http_info(opts = {}) ⇒ Array<(CreateConsumerRiskReportResponse, Integer, Hash)>

Starts the background process that will calculate the consumer risk report depending on the customization passed in.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
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
 
# File 'lib/fuse_client/api/fuse_api.rb', line 163

def create_consumer_risk_report_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.create_consumer_risk_report ...'
  end
  # resource path
  local_var_path = '/v1/risk_report/consumer'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_consumer_risk_report_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CreateConsumerRiskReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.create_consumer_risk_report",
    :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: FuseApi#create_consumer_risk_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_link_token(opts = {}) ⇒ CreateLinkTokenResponse

Create a link token to start the process of a user connecting to a specific financial institution.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



276
277
278
279
 
# File 'lib/fuse_client/api/fuse_api.rb', line 276

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

#create_link_token_with_http_info(opts = {}) ⇒ Array<(CreateLinkTokenResponse, Integer, Hash)>

Create a link token to start the process of a user connecting to a specific financial institution.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CreateLinkTokenResponse data, response status code and response headers



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
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
 
# File 'lib/fuse_client/api/fuse_api.rb', line 285

def create_link_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.create_link_token ...'
  end
  # resource path
  local_var_path = '/v1/link/token'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_link_token_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CreateLinkTokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.create_link_token",
    :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: FuseApi#create_link_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_session(opts = {}) ⇒ CreateSessionResponse

Creates a session that returns a client_secret which is required as a parameter when initializing the Fuse SDK.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



338
339
340
341
 
# File 'lib/fuse_client/api/fuse_api.rb', line 338

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

#create_session_with_http_info(opts = {}) ⇒ Array<(CreateSessionResponse, Integer, Hash)>

Creates a session that returns a client_secret which is required as a parameter when initializing the Fuse SDK.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CreateSessionResponse data, response status code and response headers



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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/fuse_client/api/fuse_api.rb', line 347

def create_session_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.create_session ...'
  end
  # resource path
  local_var_path = '/v1/session'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_session_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CreateSessionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.create_session",
    :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: FuseApi#create_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_financial_connection(financial_connection_id_to_delete, opts = {}) ⇒ DeleteFinancialConnectionResponse

Delete a financial connection

Parameters:

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

    the optional parameters

Returns:



400
401
402
403
 
# File 'lib/fuse_client/api/fuse_api.rb', line 400

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

#delete_financial_connection_with_http_info(financial_connection_id_to_delete, opts = {}) ⇒ Array<(DeleteFinancialConnectionResponse, Integer, Hash)>

Delete a financial connection

Parameters:

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

    the optional parameters

Returns:



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
455
 
# File 'lib/fuse_client/api/fuse_api.rb', line 409

def delete_financial_connection_with_http_info(financial_connection_id_to_delete, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.delete_financial_connection ...'
  end
  # verify the required parameter 'financial_connection_id_to_delete' is set
  if @api_client.config.client_side_validation && financial_connection_id_to_delete.nil?
    fail ArgumentError, "Missing the required parameter 'financial_connection_id_to_delete' when calling FuseApi.delete_financial_connection"
  end
  # resource path
  local_var_path = '/v1/financial_connections/{financial_connection_id_to_delete}'.sub('{' + 'financial_connection_id_to_delete' + '}', CGI.escape(financial_connection_id_to_delete.to_s))

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteFinancialConnectionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.delete_financial_connection",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FuseApi#delete_financial_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#enrich_transactions(fuse_client_id, fuse_api_key, opts = {}) ⇒ EnrichTransactionsResponse

Parameters:

  • fuse_client_id (String)
  • fuse_api_key (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



462
463
464
465
 
# File 'lib/fuse_client/api/fuse_api.rb', line 462

def enrich_transactions(fuse_client_id, fuse_api_key, opts = {})
  data, _status_code, _headers = enrich_transactions_with_http_info(fuse_client_id, fuse_api_key, opts)
  data
end

#enrich_transactions_with_http_info(fuse_client_id, fuse_api_key, opts = {}) ⇒ Array<(EnrichTransactionsResponse, Integer, Hash)>

Returns EnrichTransactionsResponse data, response status code and response headers.

Parameters:

  • fuse_client_id (String)
  • fuse_api_key (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    EnrichTransactionsResponse data, response status code and response headers



472
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
524
525
526
527
528
529
 
# File 'lib/fuse_client/api/fuse_api.rb', line 472

def enrich_transactions_with_http_info(fuse_client_id, fuse_api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.enrich_transactions ...'
  end
  # verify the required parameter 'fuse_client_id' is set
  if @api_client.config.client_side_validation && fuse_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'fuse_client_id' when calling FuseApi.enrich_transactions"
  end
  # verify the required parameter 'fuse_api_key' is set
  if @api_client.config.client_side_validation && fuse_api_key.nil?
    fail ArgumentError, "Missing the required parameter 'fuse_api_key' when calling FuseApi.enrich_transactions"
  end
  # resource path
  local_var_path = '/v1/transactions/enrich'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Fuse-Client-Id'] = fuse_client_id
  header_params[:'Fuse-Api-Key'] = fuse_api_key

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'enrich_transactions_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'EnrichTransactionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.enrich_transactions",
    :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: FuseApi#enrich_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#exchange_financial_connections_public_token(opts = {}) ⇒ ExchangeFinancialConnectionsPublicTokenResponse

API to exchange a public token for an access token and financial connection id

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



535
536
537
538
 
# File 'lib/fuse_client/api/fuse_api.rb', line 535

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

#exchange_financial_connections_public_token_with_http_info(opts = {}) ⇒ Array<(ExchangeFinancialConnectionsPublicTokenResponse, Integer, Hash)>

API to exchange a public token for an access token and financial connection id

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
 
# File 'lib/fuse_client/api/fuse_api.rb', line 544

def exchange_financial_connections_public_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.exchange_financial_connections_public_token ...'
  end
  # resource path
  local_var_path = '/v1/financial_connections/public_token/exchange'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'exchange_financial_connections_public_token_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'ExchangeFinancialConnectionsPublicTokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.exchange_financial_connections_public_token",
    :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: FuseApi#exchange_financial_connections_public_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_asset_report(opts = {}) ⇒ RefreshAssetReportResponse

Retrieves the Asset Report in JSON format. For Plaid, you will need to have the assets product enabled on your plaid account.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



597
598
599
600
 
# File 'lib/fuse_client/api/fuse_api.rb', line 597

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

#get_asset_report_with_http_info(opts = {}) ⇒ Array<(RefreshAssetReportResponse, Integer, Hash)>

Retrieves the Asset Report in JSON format. For Plaid, you will need to have the assets product enabled on your plaid account.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RefreshAssetReportResponse data, response status code and response headers



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
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/fuse_client/api/fuse_api.rb', line 606

def get_asset_report_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_asset_report ...'
  end
  # resource path
  local_var_path = '/v1/financial_connections/asset_report'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'get_asset_report_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'RefreshAssetReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_asset_report",
    :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: FuseApi#get_asset_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_consumer_risk_report(consumer_risk_report_id, opts = {}) ⇒ GetConsumerRiskReportResponse

Get consumer risk report

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :recalculate (Boolean) —

    An optional boolean parameter. If set to true, the system will recalculate before returning the risk report. If omitted or set to false, the current risk report will be returned without recalculation.

Returns:



660
661
662
663
 
# File 'lib/fuse_client/api/fuse_api.rb', line 660

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

#get_consumer_risk_report_with_http_info(consumer_risk_report_id, opts = {}) ⇒ Array<(GetConsumerRiskReportResponse, Integer, Hash)>

Get consumer risk report

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :recalculate (Boolean) —

    An optional boolean parameter. If set to true, the system will recalculate before returning the risk report. If omitted or set to false, the current risk report will be returned without recalculation.

Returns:



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
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/fuse_client/api/fuse_api.rb', line 670

def get_consumer_risk_report_with_http_info(consumer_risk_report_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_consumer_risk_report ...'
  end
  # verify the required parameter 'consumer_risk_report_id' is set
  if @api_client.config.client_side_validation && consumer_risk_report_id.nil?
    fail ArgumentError, "Missing the required parameter 'consumer_risk_report_id' when calling FuseApi.get_consumer_risk_report"
  end
  # resource path
  local_var_path = '/v1/risk_report/consumer/{consumer_risk_report_id}'.sub('{' + 'consumer_risk_report_id' + '}', CGI.escape(consumer_risk_report_id.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetConsumerRiskReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_consumer_risk_report",
    :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: FuseApi#get_consumer_risk_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_entity(entity_id, opts = {}) ⇒ GetEntityResponse

Get entity An entity is automatically created after a successful connection. The id of the entity is what is set when calling the ‘create session’ endpoint

Parameters:

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

    the optional parameters

Returns:



724
725
726
727
 
# File 'lib/fuse_client/api/fuse_api.rb', line 724

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

#get_entity_with_http_info(entity_id, opts = {}) ⇒ Array<(GetEntityResponse, Integer, Hash)>

Get entity An entity is automatically created after a successful connection. The id of the entity is what is set when calling the &#39;create session&#39; endpoint

Parameters:

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

    the optional parameters

Returns:

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

    GetEntityResponse data, response status code and response headers



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
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/fuse_client/api/fuse_api.rb', line 734

def get_entity_with_http_info(entity_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_entity ...'
  end
  # verify the required parameter 'entity_id' is set
  if @api_client.config.client_side_validation && entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_id' when calling FuseApi.get_entity"
  end
  # resource path
  local_var_path = '/v1/entities/{entity_id}'.sub('{' + 'entity_id' + '}', CGI.escape(entity_id.to_s))

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetEntityResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_entity",
    :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: FuseApi#get_entity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_finance_score(account_id, opts = {}) ⇒ GetFinanceScoreResponse

Get finance score

Parameters:

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

    the optional parameters

Returns:



786
787
788
789
 
# File 'lib/fuse_client/api/fuse_api.rb', line 786

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

#get_finance_score_with_http_info(account_id, opts = {}) ⇒ Array<(GetFinanceScoreResponse, Integer, Hash)>

Get finance score

Parameters:

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

    the optional parameters

Returns:

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

    GetFinanceScoreResponse data, response status code and response headers



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
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/fuse_client/api/fuse_api.rb', line 795

def get_finance_score_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_finance_score ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling FuseApi.get_finance_score"
  end
  # resource path
  local_var_path = '/v1/accounts/{account_id}/finance_score'.sub('{' + 'account_id' + '}', CGI.escape(.to_s))

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetFinanceScoreResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_finance_score",
    :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: FuseApi#get_finance_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_financial_connection(financial_connection_id, opts = {}) ⇒ GetFinancialConnectionResponse

Get financial connection details

Parameters:

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

    the optional parameters

Returns:



847
848
849
850
 
# File 'lib/fuse_client/api/fuse_api.rb', line 847

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

#get_financial_connection_with_http_info(financial_connection_id, opts = {}) ⇒ Array<(GetFinancialConnectionResponse, Integer, Hash)>

Get financial connection details

Parameters:

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

    the optional parameters

Returns:



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/fuse_client/api/fuse_api.rb', line 856

def get_financial_connection_with_http_info(financial_connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_financial_connection ...'
  end
  # verify the required parameter 'financial_connection_id' is set
  if @api_client.config.client_side_validation && financial_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'financial_connection_id' when calling FuseApi.get_financial_connection"
  end
  # resource path
  local_var_path = '/v1/financial_connections/{financial_connection_id}'.sub('{' + 'financial_connection_id' + '}', CGI.escape(financial_connection_id.to_s))

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetFinancialConnectionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_financial_connection",
    :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: FuseApi#get_financial_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_financial_connections_account_details(get_financial_connections_account_details_request, opts = {}) ⇒ GetFinancialConnectionsAccountDetailsResponse

Get account details

Parameters:

Returns:



908
909
910
911
 
# File 'lib/fuse_client/api/fuse_api.rb', line 908

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

#get_financial_connections_account_details_with_http_info(get_financial_connections_account_details_request, opts = {}) ⇒ Array<(GetFinancialConnectionsAccountDetailsResponse, Integer, Hash)>

Get account details

Parameters:

Returns:



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/fuse_client/api/fuse_api.rb', line 917

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_financial_connections_account_details ...'
  end
  # verify the required parameter 'get_financial_connections_account_details_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'get_financial_connections_account_details_request' when calling FuseApi.get_financial_connections_account_details"
  end
  # resource path
  local_var_path = '/v1/financial_connections/accounts/details'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'GetFinancialConnectionsAccountDetailsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_financial_connections_account_details",
    :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: FuseApi#get_financial_connections_account_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_financial_connections_account_statement(opts = {}) ⇒ GetFinancialConnectionsAccountStatementResponse

Retrieves an account statement for the given financial connection, account and date. This endpoint may time out so we recommend using a retry mechanism with exponential backoff.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



974
975
976
977
 
# File 'lib/fuse_client/api/fuse_api.rb', line 974

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

#get_financial_connections_account_statement_with_http_info(opts = {}) ⇒ Array<(GetFinancialConnectionsAccountStatementResponse, Integer, Hash)>

Retrieves an account statement for the given financial connection, account and date. This endpoint may time out so we recommend using a retry mechanism with exponential backoff.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/fuse_client/api/fuse_api.rb', line 983

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_financial_connections_account_statement ...'
  end
  # resource path
  local_var_path = '/v1/financial_connections/accounts/statement'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'get_financial_connections_account_statement_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'GetFinancialConnectionsAccountStatementResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_financial_connections_account_statement",
    :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: FuseApi#get_financial_connections_account_statement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_financial_connections_accounts(get_financial_connections_accounts_request, opts = {}) ⇒ GetFinancialConnectionsAccountsResponse

Get accounts

Parameters:

Returns:



1036
1037
1038
1039
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1036

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

#get_financial_connections_accounts_with_http_info(get_financial_connections_accounts_request, opts = {}) ⇒ Array<(GetFinancialConnectionsAccountsResponse, Integer, Hash)>

Get accounts

Parameters:

Returns:



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1045

def get_financial_connections_accounts_with_http_info(get_financial_connections_accounts_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_financial_connections_accounts ...'
  end
  # verify the required parameter 'get_financial_connections_accounts_request' is set
  if @api_client.config.client_side_validation && get_financial_connections_accounts_request.nil?
    fail ArgumentError, "Missing the required parameter 'get_financial_connections_accounts_request' when calling FuseApi.get_financial_connections_accounts"
  end
  # resource path
  local_var_path = '/v1/financial_connections/accounts'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_financial_connections_accounts_request)

  # return_type
  return_type = opts[:debug_return_type] || 'GetFinancialConnectionsAccountsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_financial_connections_accounts",
    :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: FuseApi#get_financial_connections_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_financial_connections_balances(get_financial_connections_balance_request, opts = {}) ⇒ GetFinancialConnectionsBalanceResponse

Get balances

Parameters:

Returns:



1102
1103
1104
1105
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1102

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

#get_financial_connections_balances_with_http_info(get_financial_connections_balance_request, opts = {}) ⇒ Array<(GetFinancialConnectionsBalanceResponse, Integer, Hash)>

Get balances

Parameters:

Returns:



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1111

def get_financial_connections_balances_with_http_info(get_financial_connections_balance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_financial_connections_balances ...'
  end
  # verify the required parameter 'get_financial_connections_balance_request' is set
  if @api_client.config.client_side_validation && get_financial_connections_balance_request.nil?
    fail ArgumentError, "Missing the required parameter 'get_financial_connections_balance_request' when calling FuseApi.get_financial_connections_balances"
  end
  # resource path
  local_var_path = '/v1/financial_connections/balances'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_financial_connections_balance_request)

  # return_type
  return_type = opts[:debug_return_type] || 'GetFinancialConnectionsBalanceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_financial_connections_balances",
    :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: FuseApi#get_financial_connections_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_financial_connections_owners(get_financial_connections_owners_request, opts = {}) ⇒ GetFinancialConnectionsOwnersResponse

Get account owners

Parameters:

Returns:



1168
1169
1170
1171
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1168

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

#get_financial_connections_owners_with_http_info(get_financial_connections_owners_request, opts = {}) ⇒ Array<(GetFinancialConnectionsOwnersResponse, Integer, Hash)>

Get account owners

Parameters:

Returns:



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1177

def get_financial_connections_owners_with_http_info(get_financial_connections_owners_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_financial_connections_owners ...'
  end
  # verify the required parameter 'get_financial_connections_owners_request' is set
  if @api_client.config.client_side_validation && get_financial_connections_owners_request.nil?
    fail ArgumentError, "Missing the required parameter 'get_financial_connections_owners_request' when calling FuseApi.get_financial_connections_owners"
  end
  # resource path
  local_var_path = '/v1/financial_connections/owners'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_financial_connections_owners_request)

  # return_type
  return_type = opts[:debug_return_type] || 'GetFinancialConnectionsOwnersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_financial_connections_owners",
    :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: FuseApi#get_financial_connections_owners\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_financial_connections_transactions(get_financial_connections_transactions_request, opts = {}) ⇒ GetFinancialConnectionsTransactionsResponse

Get transactions

Parameters:

Returns:



1234
1235
1236
1237
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1234

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

#get_financial_connections_transactions_with_http_info(get_financial_connections_transactions_request, opts = {}) ⇒ Array<(GetFinancialConnectionsTransactionsResponse, Integer, Hash)>

Get transactions

Parameters:

Returns:



1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1243

def get_financial_connections_transactions_with_http_info(get_financial_connections_transactions_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_financial_connections_transactions ...'
  end
  # verify the required parameter 'get_financial_connections_transactions_request' is set
  if @api_client.config.client_side_validation && get_financial_connections_transactions_request.nil?
    fail ArgumentError, "Missing the required parameter 'get_financial_connections_transactions_request' when calling FuseApi.get_financial_connections_transactions"
  end
  # resource path
  local_var_path = '/v1/financial_connections/transactions'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_financial_connections_transactions_request)

  # return_type
  return_type = opts[:debug_return_type] || 'GetFinancialConnectionsTransactionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_financial_connections_transactions",
    :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: FuseApi#get_financial_connections_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_financial_institution(institution_id, opts = {}) ⇒ GetFinancialInstitutionResponse

Get a financial institution Receive metadata for a financial institution

Parameters:

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

    the optional parameters

Returns:



1301
1302
1303
1304
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1301

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

#get_financial_institution_with_http_info(institution_id, opts = {}) ⇒ Array<(GetFinancialInstitutionResponse, Integer, Hash)>

Get a financial institution Receive metadata for a financial institution

Parameters:

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

    the optional parameters

Returns:



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1311

def get_financial_institution_with_http_info(institution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_financial_institution ...'
  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 FuseApi.get_financial_institution"
  end
  # resource path
  local_var_path = '/v1/financial_connections/institutions/{institution_id}'.sub('{' + 'institution_id' + '}', CGI.escape(institution_id.to_s))

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetFinancialInstitutionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_financial_institution",
    :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: FuseApi#get_financial_institution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_investment_holdings(get_investment_holdings_request, opts = {}) ⇒ GetInvestmentHoldingsResponse

Get investment holdings

Parameters:

Returns:



1363
1364
1365
1366
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1363

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

#get_investment_holdings_with_http_info(get_investment_holdings_request, opts = {}) ⇒ Array<(GetInvestmentHoldingsResponse, Integer, Hash)>

Get investment holdings

Parameters:

Returns:



1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1372

def get_investment_holdings_with_http_info(get_investment_holdings_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_investment_holdings ...'
  end
  # verify the required parameter 'get_investment_holdings_request' is set
  if @api_client.config.client_side_validation && get_investment_holdings_request.nil?
    fail ArgumentError, "Missing the required parameter 'get_investment_holdings_request' when calling FuseApi.get_investment_holdings"
  end
  # resource path
  local_var_path = '/v1/financial_connections/investments/holdings'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_investment_holdings_request)

  # return_type
  return_type = opts[:debug_return_type] || 'GetInvestmentHoldingsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_investment_holdings",
    :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: FuseApi#get_investment_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_investment_transactions(get_investment_transactions_request, opts = {}) ⇒ GetInvestmentTransactionsResponse

Get investment transactions

Parameters:

Returns:



1429
1430
1431
1432
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1429

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

#get_investment_transactions_with_http_info(get_investment_transactions_request, opts = {}) ⇒ Array<(GetInvestmentTransactionsResponse, Integer, Hash)>

Get investment transactions

Parameters:

Returns:



1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1438

def get_investment_transactions_with_http_info(get_investment_transactions_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.get_investment_transactions ...'
  end
  # verify the required parameter 'get_investment_transactions_request' is set
  if @api_client.config.client_side_validation && get_investment_transactions_request.nil?
    fail ArgumentError, "Missing the required parameter 'get_investment_transactions_request' when calling FuseApi.get_investment_transactions"
  end
  # resource path
  local_var_path = '/v1/financial_connections/investments/transactions'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_investment_transactions_request)

  # return_type
  return_type = opts[:debug_return_type] || 'GetInvestmentTransactionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.get_investment_transactions",
    :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: FuseApi#get_investment_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#migrate_financial_connection(opts = {}) ⇒ MigrateFinancialConnectionsTokenResponse

Migrate financial connection This endpoint migrates financial connections from Plaid or MX into the unified Fuse API. It accepts a POST request with connection data, aggregator, entity, and Fuse products, and responds with a JSON payload containing the migrated connection’s data, access token, ID, and request ID.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1496
1497
1498
1499
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1496

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

#migrate_financial_connection_with_http_info(opts = {}) ⇒ Array<(MigrateFinancialConnectionsTokenResponse, Integer, Hash)>

Migrate financial connection This endpoint migrates financial connections from Plaid or MX into the unified Fuse API. It accepts a POST request with connection data, aggregator, entity, and Fuse products, and responds with a JSON payload containing the migrated connection&#39;s data, access token, ID, and request ID.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1506

def migrate_financial_connection_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.migrate_financial_connection ...'
  end
  # resource path
  local_var_path = '/v1/financial_connections/migrate'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'migrate_financial_connections_token_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'MigrateFinancialConnectionsTokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.migrate_financial_connection",
    :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: FuseApi#migrate_financial_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#refresh_asset_report(opts = {}) ⇒ AssetReportResponse

Refreshes the Asset Report in JSON format. For Plaid, you will need to have the assets product enabled on your plaid account.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1559
1560
1561
1562
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1559

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

#refresh_asset_report_with_http_info(opts = {}) ⇒ Array<(AssetReportResponse, Integer, Hash)>

Refreshes the Asset Report in JSON format. For Plaid, you will need to have the assets product enabled on your plaid account.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    AssetReportResponse data, response status code and response headers



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1568

def refresh_asset_report_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.refresh_asset_report ...'
  end
  # resource path
  local_var_path = '/v1/financial_connections/asset_report/refresh'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'refresh_asset_report_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'AssetReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.refresh_asset_report",
    :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: FuseApi#refresh_asset_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_financial_connections_data(fuse_verification, body, opts = {}) ⇒ SyncFinancialConnectionsDataResponse

Sync financial connections data Call this endpoint upon receiving a financial_connection.sync_data webhook. This will keep the financial connections data up to date.

Parameters:

  • fuse_verification (String)
  • body (Object)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1623
1624
1625
1626
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1623

def sync_financial_connections_data(fuse_verification, body, opts = {})
  data, _status_code, _headers = sync_financial_connections_data_with_http_info(fuse_verification, body, opts)
  data
end

#sync_financial_connections_data_with_http_info(fuse_verification, body, opts = {}) ⇒ Array<(SyncFinancialConnectionsDataResponse, Integer, Hash)>

Sync financial connections data Call this endpoint upon receiving a financial_connection.sync_data webhook. This will keep the financial connections data up to date.

Parameters:

  • fuse_verification (String)
  • body (Object)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1634

def sync_financial_connections_data_with_http_info(fuse_verification, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.sync_financial_connections_data ...'
  end
  # verify the required parameter 'fuse_verification' is set
  if @api_client.config.client_side_validation && fuse_verification.nil?
    fail ArgumentError, "Missing the required parameter 'fuse_verification' when calling FuseApi.sync_financial_connections_data"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FuseApi.sync_financial_connections_data"
  end
  # resource path
  local_var_path = '/v1/financial_connections/sync'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Fuse-Verification'] = fuse_verification

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'SyncFinancialConnectionsDataResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.sync_financial_connections_data",
    :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: FuseApi#sync_financial_connections_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_consumer_risk_report_customization(consumer_risk_report_customization_id, opts = {}) ⇒ UpdateConsumerRiskReportCustomizationResponse

Update consumer risk report customization

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1697
1698
1699
1700
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1697

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

#update_consumer_risk_report_customization_with_http_info(consumer_risk_report_customization_id, opts = {}) ⇒ Array<(UpdateConsumerRiskReportCustomizationResponse, Integer, Hash)>

Update consumer risk report customization

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1707

def update_consumer_risk_report_customization_with_http_info(consumer_risk_report_customization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.update_consumer_risk_report_customization ...'
  end
  # verify the required parameter 'consumer_risk_report_customization_id' is set
  if @api_client.config.client_side_validation && consumer_risk_report_customization_id.nil?
    fail ArgumentError, "Missing the required parameter 'consumer_risk_report_customization_id' when calling FuseApi.update_consumer_risk_report_customization"
  end
  # resource path
  local_var_path = '/v1/risk_report/consumer/customization/{consumer_risk_report_customization_id}'.sub('{' + 'consumer_risk_report_customization_id' + '}', CGI.escape(consumer_risk_report_customization_id.to_s))

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_consumer_risk_report_customization_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'UpdateConsumerRiskReportCustomizationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.update_consumer_risk_report_customization",
    :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: FuseApi#update_consumer_risk_report_customization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_financial_connections_liabilities_post(get_liabilities_request, opts = {}) ⇒ GetLiabilitiesResponse

Get liabilities

Parameters:

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

    the optional parameters

Returns:



1764
1765
1766
1767
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1764

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

#v1_financial_connections_liabilities_post_with_http_info(get_liabilities_request, opts = {}) ⇒ Array<(GetLiabilitiesResponse, Integer, Hash)>

Get liabilities

Parameters:

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

    the optional parameters

Returns:

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

    GetLiabilitiesResponse data, response status code and response headers



1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
 
# File 'lib/fuse_client/api/fuse_api.rb', line 1773

def v1_financial_connections_liabilities_post_with_http_info(get_liabilities_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FuseApi.v1_financial_connections_liabilities_post ...'
  end
  # verify the required parameter 'get_liabilities_request' is set
  if @api_client.config.client_side_validation && get_liabilities_request.nil?
    fail ArgumentError, "Missing the required parameter 'get_liabilities_request' when calling FuseApi.v1_financial_connections_liabilities_post"
  end
  # resource path
  local_var_path = '/v1/financial_connections/liabilities'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(get_liabilities_request)

  # return_type
  return_type = opts[:debug_return_type] || 'GetLiabilitiesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']

  new_options = opts.merge(
    :operation => :"FuseApi.v1_financial_connections_liabilities_post",
    :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: FuseApi#v1_financial_connections_liabilities_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end