fuse_client 1.0.37 → 1.0.38

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/docs/{SpendPower.md → ConsumerRiskReport.md} +5 -5
  4. data/docs/{SpendPowerCustomization.md → ConsumerRiskReportCustomization.md} +6 -6
  5. data/docs/{SpendPowerTimeFrame.md → ConsumerRiskReportTimeFrame.md} +2 -2
  6. data/docs/{CreateSpendPowerCustomizationRequest.md → CreateConsumerRiskReportCustomizationRequest.md} +5 -5
  7. data/docs/{CreateSpendPowerCustomizationResponse.md → CreateConsumerRiskReportCustomizationResponse.md} +2 -2
  8. data/docs/{CreateSpendPowerRequest.md → CreateConsumerRiskReportRequest.md} +4 -4
  9. data/docs/{DeleteSpendPowerResponse.md → CreateConsumerRiskReportResponse.md} +3 -3
  10. data/docs/{CreateSpendPowerResponse.md → DeleteConsumerRiskReportResponse.md} +3 -3
  11. data/docs/EvalConsumerRiskReportRequest.md +22 -0
  12. data/docs/{EvalSpendPowerRequestEventsInner.md → EvalConsumerRiskReportRequestEventsInner.md} +2 -2
  13. data/docs/{EvalSpendPowerResponse.md → EvalConsumerRiskReportResponse.md} +2 -2
  14. data/docs/ExternalTransactionEvent.md +2 -2
  15. data/docs/FinancialConnectionDetails.md +5 -1
  16. data/docs/FinancialConnectionDetailsBasiq.md +20 -0
  17. data/docs/FinancialConnectionDetailsBelvo.md +20 -0
  18. data/docs/FinancialConnectionsInvestmentSecurityExchange.md +3 -1
  19. data/docs/FinancialConnectionsOwnerAddressesInnerData.md +2 -0
  20. data/docs/FuseApi.md +152 -148
  21. data/docs/{GetSpendPowerCustomizationResponse.md → GetConsumerRiskReportCustomizationResponse.md} +4 -4
  22. data/docs/{GetSpendPowerResponse.md → GetConsumerRiskReportResponse.md} +4 -4
  23. data/docs/InAppTransactionEvent.md +1 -1
  24. data/docs/RiskReportApi.md +165 -0
  25. data/docs/Transaction.md +1 -1
  26. data/docs/{UpdateSpendPowerCustomizationRequest.md → UpdateConsumerRiskReportCustomizationRequest.md} +5 -5
  27. data/docs/{UpdateSpendPowerCustomizationResponse.md → UpdateConsumerRiskReportCustomizationResponse.md} +2 -2
  28. data/docs/UpdatedBalanceEvent.md +2 -2
  29. data/fuse_client-1.0.37.gem +0 -0
  30. data/lib/fuse_client/api/fuse_api.rb +142 -139
  31. data/lib/fuse_client/api/{spend_power_api.rb → risk_report_api.rb} +39 -39
  32. data/lib/fuse_client/models/account_subtype.rb +3 -2
  33. data/lib/fuse_client/models/aggregator.rb +3 -1
  34. data/lib/fuse_client/models/{spend_power.rb → consumer_risk_report.rb} +4 -6
  35. data/lib/fuse_client/models/{spend_power_customization.rb → consumer_risk_report_customization.rb} +6 -7
  36. data/lib/fuse_client/models/{spend_power_time_frame.rb → consumer_risk_report_time_frame.rb} +3 -3
  37. data/lib/fuse_client/models/{create_spend_power_customization_request.rb → create_consumer_risk_report_customization_request.rb} +6 -6
  38. data/lib/fuse_client/models/{create_spend_power_customization_response.rb → create_consumer_risk_report_customization_response.rb} +3 -3
  39. data/lib/fuse_client/models/{create_spend_power_request.rb → create_consumer_risk_report_request.rb} +5 -5
  40. data/lib/fuse_client/models/{delete_spend_power_response.rb → create_consumer_risk_report_response.rb} +3 -4
  41. data/lib/fuse_client/models/{create_spend_power_response.rb → delete_consumer_risk_report_response.rb} +3 -4
  42. data/lib/fuse_client/models/{eval_spend_power_request.rb → eval_consumer_risk_report_request.rb} +5 -5
  43. data/lib/fuse_client/models/{eval_spend_power_request_events_inner.rb → eval_consumer_risk_report_request_events_inner.rb} +3 -3
  44. data/lib/fuse_client/models/{eval_spend_power_response.rb → eval_consumer_risk_report_response.rb} +3 -3
  45. data/lib/fuse_client/models/external_transaction_event.rb +1 -6
  46. data/lib/fuse_client/models/financial_connection_details.rb +22 -4
  47. data/lib/fuse_client/models/financial_connection_details_basiq.rb +241 -0
  48. data/lib/fuse_client/models/financial_connection_details_belvo.rb +236 -0
  49. data/lib/fuse_client/models/financial_connections_investment_security_exchange.rb +14 -4
  50. data/lib/fuse_client/models/financial_connections_owner_addresses_inner_data.rb +11 -1
  51. data/lib/fuse_client/models/fuse_api_error_code.rb +6 -3
  52. data/lib/fuse_client/models/get_consumer_risk_report_customization_response.rb +239 -0
  53. data/lib/fuse_client/models/{get_spend_power_response.rb → get_consumer_risk_report_response.rb} +13 -13
  54. data/lib/fuse_client/models/in_app_transaction_event.rb +0 -5
  55. data/lib/fuse_client/models/transaction.rb +1 -1
  56. data/lib/fuse_client/models/{update_spend_power_customization_request.rb → update_consumer_risk_report_customization_request.rb} +6 -6
  57. data/lib/fuse_client/models/{update_spend_power_customization_response.rb → update_consumer_risk_report_customization_response.rb} +3 -3
  58. data/lib/fuse_client/models/updated_balance_event.rb +2 -2
  59. data/lib/fuse_client/version.rb +1 -1
  60. data/lib/fuse_client.rb +18 -16
  61. data/spec/api/fuse_api_spec.rb +37 -36
  62. data/spec/api/{spend_power_api_spec.rb → risk_report_api_spec.rb} +16 -16
  63. data/spec/models/{spend_power_customization_spec.rb → consumer_risk_report_customization_spec.rb} +6 -6
  64. data/spec/models/{spend_power_spec.rb → consumer_risk_report_spec.rb} +6 -6
  65. data/spec/models/{spend_power_time_frame_spec.rb → consumer_risk_report_time_frame_spec.rb} +6 -6
  66. data/spec/models/{create_spend_power_customization_request_spec.rb → create_consumer_risk_report_customization_request_spec.rb} +6 -6
  67. data/spec/models/{create_spend_power_customization_response_spec.rb → create_consumer_risk_report_customization_response_spec.rb} +6 -6
  68. data/spec/models/{create_spend_power_request_spec.rb → create_consumer_risk_report_request_spec.rb} +6 -6
  69. data/spec/models/{delete_spend_power_response_spec.rb → create_consumer_risk_report_response_spec.rb} +6 -6
  70. data/spec/models/{create_spend_power_response_spec.rb → delete_consumer_risk_report_response_spec.rb} +6 -6
  71. data/spec/models/{eval_spend_power_request_events_inner_spec.rb → eval_consumer_risk_report_request_events_inner_spec.rb} +6 -6
  72. data/spec/models/{eval_spend_power_request_spec.rb → eval_consumer_risk_report_request_spec.rb} +6 -6
  73. data/spec/models/{eval_spend_power_response_spec.rb → eval_consumer_risk_report_response_spec.rb} +6 -6
  74. data/spec/models/financial_connection_details_basiq_spec.rb +40 -0
  75. data/spec/models/financial_connection_details_belvo_spec.rb +40 -0
  76. data/spec/models/financial_connection_details_spec.rb +12 -0
  77. data/spec/models/financial_connections_investment_security_exchange_spec.rb +6 -0
  78. data/spec/models/financial_connections_owner_addresses_inner_data_spec.rb +6 -0
  79. data/spec/models/{get_spend_power_customization_response_spec.rb → get_consumer_risk_report_customization_response_spec.rb} +7 -7
  80. data/spec/models/{get_spend_power_response_spec.rb → get_consumer_risk_report_response_spec.rb} +7 -7
  81. data/spec/models/{update_spend_power_customization_request_spec.rb → update_consumer_risk_report_customization_request_spec.rb} +6 -6
  82. data/spec/models/{update_spend_power_customization_response_spec.rb → update_consumer_risk_report_customization_response_spec.rb} +6 -6
  83. metadata +74 -65
  84. data/docs/EvalSpendPowerRequest.md +0 -22
  85. data/docs/SpendPowerApi.md +0 -165
  86. data/lib/fuse_client/models/get_spend_power_customization_response.rb +0 -239
data/docs/FuseApi.md CHANGED
@@ -6,15 +6,16 @@ All URIs are relative to *https://sandbox-api.letsfuse.com*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**add_account_events**](FuseApi.md#add_account_events) | **POST** /v1/accounts/{account_id}/events | |
8
8
  | [**create_asset_report**](FuseApi.md#create_asset_report) | **POST** /v1/financial_connections/asset_report/create | |
9
+ | [**create_consumer_risk_report**](FuseApi.md#create_consumer_risk_report) | **POST** /v1/risk_report/consumer | |
10
+ | [**create_consumer_risk_report_customization**](FuseApi.md#create_consumer_risk_report_customization) | **POST** /v1/risk_report/consumer/customization | |
9
11
  | [**create_link_token**](FuseApi.md#create_link_token) | **POST** /v1/link/token | |
10
12
  | [**create_session**](FuseApi.md#create_session) | **POST** /v1/session | |
11
- | [**create_spend_power**](FuseApi.md#create_spend_power) | **POST** /v1/spend_power | |
12
- | [**create_spend_power_customization**](FuseApi.md#create_spend_power_customization) | **POST** /v1/spend_power/customization | |
13
13
  | [**delete_financial_connection**](FuseApi.md#delete_financial_connection) | **DELETE** /v1/financial_connections/{financial_connection_id_to_delete} | Delete a financial connection |
14
14
  | [**enrich_transactions**](FuseApi.md#enrich_transactions) | **POST** /v1/transactions/enrich | |
15
15
  | [**exchange_financial_connections_public_token**](FuseApi.md#exchange_financial_connections_public_token) | **POST** /v1/financial_connections/public_token/exchange | |
16
16
  | [**fin_ql_prompt**](FuseApi.md#fin_ql_prompt) | **POST** /v1/finql/prompt | FinQL Prompt |
17
17
  | [**get_asset_report**](FuseApi.md#get_asset_report) | **POST** /v1/financial_connections/asset_report | |
18
+ | [**get_consumer_risk_report**](FuseApi.md#get_consumer_risk_report) | **GET** /v1/risk_report/consumer/{consumer_risk_report_id} | Get consumer risk report |
18
19
  | [**get_entity**](FuseApi.md#get_entity) | **GET** /v1/entities/{entity_id} | Get entity |
19
20
  | [**get_finance_score**](FuseApi.md#get_finance_score) | **GET** /v1/accounts/{account_id}/finance_score | Get finance score |
20
21
  | [**get_financial_connection**](FuseApi.md#get_financial_connection) | **GET** /v1/financial_connections/{financial_connection_id} | Get financial connection details |
@@ -27,11 +28,10 @@ All URIs are relative to *https://sandbox-api.letsfuse.com*
27
28
  | [**get_financial_institution**](FuseApi.md#get_financial_institution) | **GET** /v1/financial_connections/institutions/{institution_id} | Get a financial institution |
28
29
  | [**get_investment_holdings**](FuseApi.md#get_investment_holdings) | **POST** /v1/financial_connections/investments/holdings | Get investment holdings |
29
30
  | [**get_investment_transactions**](FuseApi.md#get_investment_transactions) | **POST** /v1/financial_connections/investments/transactions | Get investment transactions |
30
- | [**get_spend_power**](FuseApi.md#get_spend_power) | **GET** /v1/spend_power/{spend_power_id} | Get spend power |
31
31
  | [**migrate_financial_connection**](FuseApi.md#migrate_financial_connection) | **POST** /v1/financial_connections/migrate | Migrate financial connection |
32
32
  | [**refresh_asset_report**](FuseApi.md#refresh_asset_report) | **POST** /v1/financial_connections/asset_report/refresh | |
33
33
  | [**sync_financial_connections_data**](FuseApi.md#sync_financial_connections_data) | **POST** /v1/financial_connections/sync | Sync financial connections data |
34
- | [**update_spend_power_customization**](FuseApi.md#update_spend_power_customization) | **POST** /v1/spend_power/customization/{spend_power_customization_id} | Update spend power customization |
34
+ | [**update_consumer_risk_report_customization**](FuseApi.md#update_consumer_risk_report_customization) | **POST** /v1/risk_report/consumer/customization/{consumer_risk_report_customization_id} | Update consumer risk report customization |
35
35
  | [**v1_financial_connections_liabilities_post**](FuseApi.md#v1_financial_connections_liabilities_post) | **POST** /v1/financial_connections/liabilities | Get liabilities |
36
36
 
37
37
 
@@ -62,7 +62,7 @@ end
62
62
  api_instance = FuseClient::FuseApi.new
63
63
  account_id = 'account_id_example' # String |
64
64
  opts = {
65
- add_account_events_request: FuseClient::AddAccountEventsRequest.new({events: [FuseClient::ExternalTransactionEvent.new({id: 'id_example', event_type: 'external_transaction', status: FuseClient::ExternalTransactionEventStatus::PENDING, amount: 3.56, iso_currency_code: 'iso_currency_code_example', transaction_type: FuseClient::TransactionEventType::ACH, merchant_name: 'merchant_name_example', timestamp: 'timestamp_example'})]}) # AddAccountEventsRequest |
65
+ add_account_events_request: FuseClient::AddAccountEventsRequest.new({events: [FuseClient::ExternalTransactionEvent.new({id: 'id_example', event_type: 'external_transaction', status: FuseClient::ExternalTransactionEventStatus::PENDING, amount: 3.56, iso_currency_code: 'iso_currency_code_example', merchant_name: 'merchant_name_example', timestamp: 'timestamp_example'})]}) # AddAccountEventsRequest |
66
66
  }
67
67
 
68
68
  begin
@@ -191,13 +191,13 @@ end
191
191
  - **Accept**: application/json
192
192
 
193
193
 
194
- ## create_link_token
194
+ ## create_consumer_risk_report
195
195
 
196
- > <CreateLinkTokenResponse> create_link_token(opts)
196
+ > <CreateConsumerRiskReportResponse> create_consumer_risk_report(opts)
197
197
 
198
198
 
199
199
 
200
- Create a link token to start the process of a user connecting to a specific financial institution.
200
+ Starts the background process that will calculate the consumer risk report depending on the customization passed in.
201
201
 
202
202
  ### Examples
203
203
 
@@ -219,33 +219,33 @@ end
219
219
 
220
220
  api_instance = FuseClient::FuseApi.new
221
221
  opts = {
222
- create_link_token_request: FuseClient::CreateLinkTokenRequest.new({institution_id: 'institution_id_example', entity: FuseClient::Entity.new({id: 'id_example'}), client_name: 'client_name_example', session_client_secret: 'session_client_secret_example'}) # CreateLinkTokenRequest |
222
+ create_consumer_risk_report_request: FuseClient::CreateConsumerRiskReportRequest.new({account_id: 'account_id_example', iso_currency_code: 'iso_currency_code_example', customization_id: 'customization_id_example'}) # CreateConsumerRiskReportRequest |
223
223
  }
224
224
 
225
225
  begin
226
226
 
227
- result = api_instance.create_link_token(opts)
227
+ result = api_instance.create_consumer_risk_report(opts)
228
228
  p result
229
229
  rescue FuseClient::ApiError => e
230
- puts "Error when calling FuseApi->create_link_token: #{e}"
230
+ puts "Error when calling FuseApi->create_consumer_risk_report: #{e}"
231
231
  end
232
232
  ```
233
233
 
234
- #### Using the create_link_token_with_http_info variant
234
+ #### Using the create_consumer_risk_report_with_http_info variant
235
235
 
236
236
  This returns an Array which contains the response data, status code and headers.
237
237
 
238
- > <Array(<CreateLinkTokenResponse>, Integer, Hash)> create_link_token_with_http_info(opts)
238
+ > <Array(<CreateConsumerRiskReportResponse>, Integer, Hash)> create_consumer_risk_report_with_http_info(opts)
239
239
 
240
240
  ```ruby
241
241
  begin
242
242
 
243
- data, status_code, headers = api_instance.create_link_token_with_http_info(opts)
243
+ data, status_code, headers = api_instance.create_consumer_risk_report_with_http_info(opts)
244
244
  p status_code # => 2xx
245
245
  p headers # => { ... }
246
- p data # => <CreateLinkTokenResponse>
246
+ p data # => <CreateConsumerRiskReportResponse>
247
247
  rescue FuseClient::ApiError => e
248
- puts "Error when calling FuseApi->create_link_token_with_http_info: #{e}"
248
+ puts "Error when calling FuseApi->create_consumer_risk_report_with_http_info: #{e}"
249
249
  end
250
250
  ```
251
251
 
@@ -253,11 +253,11 @@ end
253
253
 
254
254
  | Name | Type | Description | Notes |
255
255
  | ---- | ---- | ----------- | ----- |
256
- | **create_link_token_request** | [**CreateLinkTokenRequest**](CreateLinkTokenRequest.md) | | [optional] |
256
+ | **create_consumer_risk_report_request** | [**CreateConsumerRiskReportRequest**](CreateConsumerRiskReportRequest.md) | | [optional] |
257
257
 
258
258
  ### Return type
259
259
 
260
- [**CreateLinkTokenResponse**](CreateLinkTokenResponse.md)
260
+ [**CreateConsumerRiskReportResponse**](CreateConsumerRiskReportResponse.md)
261
261
 
262
262
  ### Authorization
263
263
 
@@ -269,13 +269,11 @@ end
269
269
  - **Accept**: application/json
270
270
 
271
271
 
272
- ## create_session
273
-
274
- > <CreateSessionResponse> create_session(opts)
272
+ ## create_consumer_risk_report_customization
275
273
 
274
+ > <CreateConsumerRiskReportCustomizationResponse> create_consumer_risk_report_customization(opts)
276
275
 
277
276
 
278
- Creates a session that returns a client_secret which is required as a parameter when initializing the Fuse SDK.
279
277
 
280
278
  ### Examples
281
279
 
@@ -297,33 +295,33 @@ end
297
295
 
298
296
  api_instance = FuseClient::FuseApi.new
299
297
  opts = {
300
- create_session_request: FuseClient::CreateSessionRequest.new({supported_financial_institution_aggregators: [FuseClient::Aggregator::PLAID], products: [FuseClient::Product::ACCOUNT_DETAILS], entity: FuseClient::Entity.new({id: 'id_example'})}) # CreateSessionRequest |
298
+ create_consumer_risk_report_customization_request: FuseClient::CreateConsumerRiskReportCustomizationRequest.new({timeframe: FuseClient::ConsumerRiskReportTimeFrame::DAILY, min_limit: 3.56, max_limit: 3.56, risk_tolerance: 3.56}) # CreateConsumerRiskReportCustomizationRequest |
301
299
  }
302
300
 
303
301
  begin
304
302
 
305
- result = api_instance.create_session(opts)
303
+ result = api_instance.create_consumer_risk_report_customization(opts)
306
304
  p result
307
305
  rescue FuseClient::ApiError => e
308
- puts "Error when calling FuseApi->create_session: #{e}"
306
+ puts "Error when calling FuseApi->create_consumer_risk_report_customization: #{e}"
309
307
  end
310
308
  ```
311
309
 
312
- #### Using the create_session_with_http_info variant
310
+ #### Using the create_consumer_risk_report_customization_with_http_info variant
313
311
 
314
312
  This returns an Array which contains the response data, status code and headers.
315
313
 
316
- > <Array(<CreateSessionResponse>, Integer, Hash)> create_session_with_http_info(opts)
314
+ > <Array(<CreateConsumerRiskReportCustomizationResponse>, Integer, Hash)> create_consumer_risk_report_customization_with_http_info(opts)
317
315
 
318
316
  ```ruby
319
317
  begin
320
318
 
321
- data, status_code, headers = api_instance.create_session_with_http_info(opts)
319
+ data, status_code, headers = api_instance.create_consumer_risk_report_customization_with_http_info(opts)
322
320
  p status_code # => 2xx
323
321
  p headers # => { ... }
324
- p data # => <CreateSessionResponse>
322
+ p data # => <CreateConsumerRiskReportCustomizationResponse>
325
323
  rescue FuseClient::ApiError => e
326
- puts "Error when calling FuseApi->create_session_with_http_info: #{e}"
324
+ puts "Error when calling FuseApi->create_consumer_risk_report_customization_with_http_info: #{e}"
327
325
  end
328
326
  ```
329
327
 
@@ -331,11 +329,11 @@ end
331
329
 
332
330
  | Name | Type | Description | Notes |
333
331
  | ---- | ---- | ----------- | ----- |
334
- | **create_session_request** | [**CreateSessionRequest**](CreateSessionRequest.md) | | [optional] |
332
+ | **create_consumer_risk_report_customization_request** | [**CreateConsumerRiskReportCustomizationRequest**](CreateConsumerRiskReportCustomizationRequest.md) | | [optional] |
335
333
 
336
334
  ### Return type
337
335
 
338
- [**CreateSessionResponse**](CreateSessionResponse.md)
336
+ [**CreateConsumerRiskReportCustomizationResponse**](CreateConsumerRiskReportCustomizationResponse.md)
339
337
 
340
338
  ### Authorization
341
339
 
@@ -347,13 +345,13 @@ end
347
345
  - **Accept**: application/json
348
346
 
349
347
 
350
- ## create_spend_power
348
+ ## create_link_token
351
349
 
352
- > <CreateSpendPowerResponse> create_spend_power(opts)
350
+ > <CreateLinkTokenResponse> create_link_token(opts)
353
351
 
354
352
 
355
353
 
356
- Starts the background process that will determine the spend power depending on the customization passed in.
354
+ Create a link token to start the process of a user connecting to a specific financial institution.
357
355
 
358
356
  ### Examples
359
357
 
@@ -375,33 +373,33 @@ end
375
373
 
376
374
  api_instance = FuseClient::FuseApi.new
377
375
  opts = {
378
- create_spend_power_request: FuseClient::CreateSpendPowerRequest.new({account_id: 'account_id_example', iso_currency_code: 'iso_currency_code_example', customization_id: 'customization_id_example'}) # CreateSpendPowerRequest |
376
+ create_link_token_request: FuseClient::CreateLinkTokenRequest.new({institution_id: 'institution_id_example', entity: FuseClient::Entity.new({id: 'id_example'}), client_name: 'client_name_example', session_client_secret: 'session_client_secret_example'}) # CreateLinkTokenRequest |
379
377
  }
380
378
 
381
379
  begin
382
380
 
383
- result = api_instance.create_spend_power(opts)
381
+ result = api_instance.create_link_token(opts)
384
382
  p result
385
383
  rescue FuseClient::ApiError => e
386
- puts "Error when calling FuseApi->create_spend_power: #{e}"
384
+ puts "Error when calling FuseApi->create_link_token: #{e}"
387
385
  end
388
386
  ```
389
387
 
390
- #### Using the create_spend_power_with_http_info variant
388
+ #### Using the create_link_token_with_http_info variant
391
389
 
392
390
  This returns an Array which contains the response data, status code and headers.
393
391
 
394
- > <Array(<CreateSpendPowerResponse>, Integer, Hash)> create_spend_power_with_http_info(opts)
392
+ > <Array(<CreateLinkTokenResponse>, Integer, Hash)> create_link_token_with_http_info(opts)
395
393
 
396
394
  ```ruby
397
395
  begin
398
396
 
399
- data, status_code, headers = api_instance.create_spend_power_with_http_info(opts)
397
+ data, status_code, headers = api_instance.create_link_token_with_http_info(opts)
400
398
  p status_code # => 2xx
401
399
  p headers # => { ... }
402
- p data # => <CreateSpendPowerResponse>
400
+ p data # => <CreateLinkTokenResponse>
403
401
  rescue FuseClient::ApiError => e
404
- puts "Error when calling FuseApi->create_spend_power_with_http_info: #{e}"
402
+ puts "Error when calling FuseApi->create_link_token_with_http_info: #{e}"
405
403
  end
406
404
  ```
407
405
 
@@ -409,11 +407,11 @@ end
409
407
 
410
408
  | Name | Type | Description | Notes |
411
409
  | ---- | ---- | ----------- | ----- |
412
- | **create_spend_power_request** | [**CreateSpendPowerRequest**](CreateSpendPowerRequest.md) | | [optional] |
410
+ | **create_link_token_request** | [**CreateLinkTokenRequest**](CreateLinkTokenRequest.md) | | [optional] |
413
411
 
414
412
  ### Return type
415
413
 
416
- [**CreateSpendPowerResponse**](CreateSpendPowerResponse.md)
414
+ [**CreateLinkTokenResponse**](CreateLinkTokenResponse.md)
417
415
 
418
416
  ### Authorization
419
417
 
@@ -425,12 +423,14 @@ end
425
423
  - **Accept**: application/json
426
424
 
427
425
 
428
- ## create_spend_power_customization
426
+ ## create_session
429
427
 
430
- > <CreateSpendPowerCustomizationResponse> create_spend_power_customization(opts)
428
+ > <CreateSessionResponse> create_session(opts)
431
429
 
432
430
 
433
431
 
432
+ Creates a session that returns a client_secret which is required as a parameter when initializing the Fuse SDK.
433
+
434
434
  ### Examples
435
435
 
436
436
  ```ruby
@@ -451,33 +451,33 @@ end
451
451
 
452
452
  api_instance = FuseClient::FuseApi.new
453
453
  opts = {
454
- create_spend_power_customization_request: FuseClient::CreateSpendPowerCustomizationRequest.new({timeframe: FuseClient::SpendPowerTimeFrame::DAILY, min_limit: 3.56, max_limit: 3.56, risk_tolerance: 3.56}) # CreateSpendPowerCustomizationRequest |
454
+ create_session_request: FuseClient::CreateSessionRequest.new({supported_financial_institution_aggregators: [FuseClient::Aggregator::PLAID], products: [FuseClient::Product::ACCOUNT_DETAILS], entity: FuseClient::Entity.new({id: 'id_example'})}) # CreateSessionRequest |
455
455
  }
456
456
 
457
457
  begin
458
458
 
459
- result = api_instance.create_spend_power_customization(opts)
459
+ result = api_instance.create_session(opts)
460
460
  p result
461
461
  rescue FuseClient::ApiError => e
462
- puts "Error when calling FuseApi->create_spend_power_customization: #{e}"
462
+ puts "Error when calling FuseApi->create_session: #{e}"
463
463
  end
464
464
  ```
465
465
 
466
- #### Using the create_spend_power_customization_with_http_info variant
466
+ #### Using the create_session_with_http_info variant
467
467
 
468
468
  This returns an Array which contains the response data, status code and headers.
469
469
 
470
- > <Array(<CreateSpendPowerCustomizationResponse>, Integer, Hash)> create_spend_power_customization_with_http_info(opts)
470
+ > <Array(<CreateSessionResponse>, Integer, Hash)> create_session_with_http_info(opts)
471
471
 
472
472
  ```ruby
473
473
  begin
474
474
 
475
- data, status_code, headers = api_instance.create_spend_power_customization_with_http_info(opts)
475
+ data, status_code, headers = api_instance.create_session_with_http_info(opts)
476
476
  p status_code # => 2xx
477
477
  p headers # => { ... }
478
- p data # => <CreateSpendPowerCustomizationResponse>
478
+ p data # => <CreateSessionResponse>
479
479
  rescue FuseClient::ApiError => e
480
- puts "Error when calling FuseApi->create_spend_power_customization_with_http_info: #{e}"
480
+ puts "Error when calling FuseApi->create_session_with_http_info: #{e}"
481
481
  end
482
482
  ```
483
483
 
@@ -485,11 +485,11 @@ end
485
485
 
486
486
  | Name | Type | Description | Notes |
487
487
  | ---- | ---- | ----------- | ----- |
488
- | **create_spend_power_customization_request** | [**CreateSpendPowerCustomizationRequest**](CreateSpendPowerCustomizationRequest.md) | | [optional] |
488
+ | **create_session_request** | [**CreateSessionRequest**](CreateSessionRequest.md) | | [optional] |
489
489
 
490
490
  ### Return type
491
491
 
492
- [**CreateSpendPowerCustomizationResponse**](CreateSpendPowerCustomizationResponse.md)
492
+ [**CreateSessionResponse**](CreateSessionResponse.md)
493
493
 
494
494
  ### Authorization
495
495
 
@@ -889,6 +889,84 @@ end
889
889
  - **Accept**: application/json
890
890
 
891
891
 
892
+ ## get_consumer_risk_report
893
+
894
+ > <GetConsumerRiskReportResponse> get_consumer_risk_report(consumer_risk_report_id, opts)
895
+
896
+ Get consumer risk report
897
+
898
+ ### Examples
899
+
900
+ ```ruby
901
+ require 'time'
902
+ require 'fuse_client'
903
+ # setup authorization
904
+ FuseClient.configure do |config|
905
+ # Configure API key authorization: fuseApiKey
906
+ config.api_key['fuseApiKey'] = 'YOUR API KEY'
907
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
908
+ # config.api_key_prefix['fuseApiKey'] = 'Bearer'
909
+
910
+ # Configure API key authorization: fuseClientId
911
+ config.api_key['fuseClientId'] = 'YOUR API KEY'
912
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
913
+ # config.api_key_prefix['fuseClientId'] = 'Bearer'
914
+ end
915
+
916
+ api_instance = FuseClient::FuseApi.new
917
+ consumer_risk_report_id = 'consumer_risk_report_id_example' # String |
918
+ opts = {
919
+ recalculate: true # 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.
920
+ }
921
+
922
+ begin
923
+ # Get consumer risk report
924
+ result = api_instance.get_consumer_risk_report(consumer_risk_report_id, opts)
925
+ p result
926
+ rescue FuseClient::ApiError => e
927
+ puts "Error when calling FuseApi->get_consumer_risk_report: #{e}"
928
+ end
929
+ ```
930
+
931
+ #### Using the get_consumer_risk_report_with_http_info variant
932
+
933
+ This returns an Array which contains the response data, status code and headers.
934
+
935
+ > <Array(<GetConsumerRiskReportResponse>, Integer, Hash)> get_consumer_risk_report_with_http_info(consumer_risk_report_id, opts)
936
+
937
+ ```ruby
938
+ begin
939
+ # Get consumer risk report
940
+ data, status_code, headers = api_instance.get_consumer_risk_report_with_http_info(consumer_risk_report_id, opts)
941
+ p status_code # => 2xx
942
+ p headers # => { ... }
943
+ p data # => <GetConsumerRiskReportResponse>
944
+ rescue FuseClient::ApiError => e
945
+ puts "Error when calling FuseApi->get_consumer_risk_report_with_http_info: #{e}"
946
+ end
947
+ ```
948
+
949
+ ### Parameters
950
+
951
+ | Name | Type | Description | Notes |
952
+ | ---- | ---- | ----------- | ----- |
953
+ | **consumer_risk_report_id** | **String** | | |
954
+ | **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. | [optional] |
955
+
956
+ ### Return type
957
+
958
+ [**GetConsumerRiskReportResponse**](GetConsumerRiskReportResponse.md)
959
+
960
+ ### Authorization
961
+
962
+ [fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
963
+
964
+ ### HTTP request headers
965
+
966
+ - **Content-Type**: Not defined
967
+ - **Accept**: application/json
968
+
969
+
892
970
  ## get_entity
893
971
 
894
972
  > <GetEntityResponse> get_entity(entity_id)
@@ -1785,80 +1863,6 @@ end
1785
1863
  - **Accept**: application/json
1786
1864
 
1787
1865
 
1788
- ## get_spend_power
1789
-
1790
- > <GetSpendPowerResponse> get_spend_power(spend_power_id)
1791
-
1792
- Get spend power
1793
-
1794
- ### Examples
1795
-
1796
- ```ruby
1797
- require 'time'
1798
- require 'fuse_client'
1799
- # setup authorization
1800
- FuseClient.configure do |config|
1801
- # Configure API key authorization: fuseApiKey
1802
- config.api_key['fuseApiKey'] = 'YOUR API KEY'
1803
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1804
- # config.api_key_prefix['fuseApiKey'] = 'Bearer'
1805
-
1806
- # Configure API key authorization: fuseClientId
1807
- config.api_key['fuseClientId'] = 'YOUR API KEY'
1808
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1809
- # config.api_key_prefix['fuseClientId'] = 'Bearer'
1810
- end
1811
-
1812
- api_instance = FuseClient::FuseApi.new
1813
- spend_power_id = 'spend_power_id_example' # String |
1814
-
1815
- begin
1816
- # Get spend power
1817
- result = api_instance.get_spend_power(spend_power_id)
1818
- p result
1819
- rescue FuseClient::ApiError => e
1820
- puts "Error when calling FuseApi->get_spend_power: #{e}"
1821
- end
1822
- ```
1823
-
1824
- #### Using the get_spend_power_with_http_info variant
1825
-
1826
- This returns an Array which contains the response data, status code and headers.
1827
-
1828
- > <Array(<GetSpendPowerResponse>, Integer, Hash)> get_spend_power_with_http_info(spend_power_id)
1829
-
1830
- ```ruby
1831
- begin
1832
- # Get spend power
1833
- data, status_code, headers = api_instance.get_spend_power_with_http_info(spend_power_id)
1834
- p status_code # => 2xx
1835
- p headers # => { ... }
1836
- p data # => <GetSpendPowerResponse>
1837
- rescue FuseClient::ApiError => e
1838
- puts "Error when calling FuseApi->get_spend_power_with_http_info: #{e}"
1839
- end
1840
- ```
1841
-
1842
- ### Parameters
1843
-
1844
- | Name | Type | Description | Notes |
1845
- | ---- | ---- | ----------- | ----- |
1846
- | **spend_power_id** | **String** | | |
1847
-
1848
- ### Return type
1849
-
1850
- [**GetSpendPowerResponse**](GetSpendPowerResponse.md)
1851
-
1852
- ### Authorization
1853
-
1854
- [fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
1855
-
1856
- ### HTTP request headers
1857
-
1858
- - **Content-Type**: Not defined
1859
- - **Accept**: application/json
1860
-
1861
-
1862
1866
  ## migrate_financial_connection
1863
1867
 
1864
1868
  > <MigrateFinancialConnectionsTokenResponse> migrate_financial_connection(opts)
@@ -2091,11 +2095,11 @@ end
2091
2095
  - **Accept**: application/json
2092
2096
 
2093
2097
 
2094
- ## update_spend_power_customization
2098
+ ## update_consumer_risk_report_customization
2095
2099
 
2096
- > <UpdateSpendPowerCustomizationResponse> update_spend_power_customization(spend_power_customization_id, opts)
2100
+ > <UpdateConsumerRiskReportCustomizationResponse> update_consumer_risk_report_customization(consumer_risk_report_customization_id, opts)
2097
2101
 
2098
- Update spend power customization
2102
+ Update consumer risk report customization
2099
2103
 
2100
2104
  ### Examples
2101
2105
 
@@ -2116,35 +2120,35 @@ FuseClient.configure do |config|
2116
2120
  end
2117
2121
 
2118
2122
  api_instance = FuseClient::FuseApi.new
2119
- spend_power_customization_id = 'spend_power_customization_id_example' # String |
2123
+ consumer_risk_report_customization_id = 'consumer_risk_report_customization_id_example' # String |
2120
2124
  opts = {
2121
- update_spend_power_customization_request: FuseClient::UpdateSpendPowerCustomizationRequest.new # UpdateSpendPowerCustomizationRequest |
2125
+ update_consumer_risk_report_customization_request: FuseClient::UpdateConsumerRiskReportCustomizationRequest.new # UpdateConsumerRiskReportCustomizationRequest |
2122
2126
  }
2123
2127
 
2124
2128
  begin
2125
- # Update spend power customization
2126
- result = api_instance.update_spend_power_customization(spend_power_customization_id, opts)
2129
+ # Update consumer risk report customization
2130
+ result = api_instance.update_consumer_risk_report_customization(consumer_risk_report_customization_id, opts)
2127
2131
  p result
2128
2132
  rescue FuseClient::ApiError => e
2129
- puts "Error when calling FuseApi->update_spend_power_customization: #{e}"
2133
+ puts "Error when calling FuseApi->update_consumer_risk_report_customization: #{e}"
2130
2134
  end
2131
2135
  ```
2132
2136
 
2133
- #### Using the update_spend_power_customization_with_http_info variant
2137
+ #### Using the update_consumer_risk_report_customization_with_http_info variant
2134
2138
 
2135
2139
  This returns an Array which contains the response data, status code and headers.
2136
2140
 
2137
- > <Array(<UpdateSpendPowerCustomizationResponse>, Integer, Hash)> update_spend_power_customization_with_http_info(spend_power_customization_id, opts)
2141
+ > <Array(<UpdateConsumerRiskReportCustomizationResponse>, Integer, Hash)> update_consumer_risk_report_customization_with_http_info(consumer_risk_report_customization_id, opts)
2138
2142
 
2139
2143
  ```ruby
2140
2144
  begin
2141
- # Update spend power customization
2142
- data, status_code, headers = api_instance.update_spend_power_customization_with_http_info(spend_power_customization_id, opts)
2145
+ # Update consumer risk report customization
2146
+ data, status_code, headers = api_instance.update_consumer_risk_report_customization_with_http_info(consumer_risk_report_customization_id, opts)
2143
2147
  p status_code # => 2xx
2144
2148
  p headers # => { ... }
2145
- p data # => <UpdateSpendPowerCustomizationResponse>
2149
+ p data # => <UpdateConsumerRiskReportCustomizationResponse>
2146
2150
  rescue FuseClient::ApiError => e
2147
- puts "Error when calling FuseApi->update_spend_power_customization_with_http_info: #{e}"
2151
+ puts "Error when calling FuseApi->update_consumer_risk_report_customization_with_http_info: #{e}"
2148
2152
  end
2149
2153
  ```
2150
2154
 
@@ -2152,12 +2156,12 @@ end
2152
2156
 
2153
2157
  | Name | Type | Description | Notes |
2154
2158
  | ---- | ---- | ----------- | ----- |
2155
- | **spend_power_customization_id** | **String** | | |
2156
- | **update_spend_power_customization_request** | [**UpdateSpendPowerCustomizationRequest**](UpdateSpendPowerCustomizationRequest.md) | | [optional] |
2159
+ | **consumer_risk_report_customization_id** | **String** | | |
2160
+ | **update_consumer_risk_report_customization_request** | [**UpdateConsumerRiskReportCustomizationRequest**](UpdateConsumerRiskReportCustomizationRequest.md) | | [optional] |
2157
2161
 
2158
2162
  ### Return type
2159
2163
 
2160
- [**UpdateSpendPowerCustomizationResponse**](UpdateSpendPowerCustomizationResponse.md)
2164
+ [**UpdateConsumerRiskReportCustomizationResponse**](UpdateConsumerRiskReportCustomizationResponse.md)
2161
2165
 
2162
2166
  ### Authorization
2163
2167
 
@@ -1,10 +1,10 @@
1
- # FuseClient::GetSpendPowerCustomizationResponse
1
+ # FuseClient::GetConsumerRiskReportCustomizationResponse
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **spend_power_customization** | [**SpendPowerCustomization**](SpendPowerCustomization.md) | | |
7
+ | **consumer_risk_report_customization** | [**ConsumerRiskReportCustomization**](ConsumerRiskReportCustomization.md) | | |
8
8
  | **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. | |
9
9
 
10
10
  ## Example
@@ -12,8 +12,8 @@
12
12
  ```ruby
13
13
  require 'fuse_client'
14
14
 
15
- instance = FuseClient::GetSpendPowerCustomizationResponse.new(
16
- spend_power_customization: null,
15
+ instance = FuseClient::GetConsumerRiskReportCustomizationResponse.new(
16
+ consumer_risk_report_customization: null,
17
17
  request_id: null
18
18
  )
19
19
  ```
@@ -1,10 +1,10 @@
1
- # FuseClient::GetSpendPowerResponse
1
+ # FuseClient::GetConsumerRiskReportResponse
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **spend_power** | [**SpendPower**](SpendPower.md) | | |
7
+ | **consumer_risk_report** | [**ConsumerRiskReport**](ConsumerRiskReport.md) | | |
8
8
  | **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. | |
9
9
 
10
10
  ## Example
@@ -12,8 +12,8 @@
12
12
  ```ruby
13
13
  require 'fuse_client'
14
14
 
15
- instance = FuseClient::GetSpendPowerResponse.new(
16
- spend_power: null,
15
+ instance = FuseClient::GetConsumerRiskReportResponse.new(
16
+ consumer_risk_report: null,
17
17
  request_id: null
18
18
  )
19
19
  ```
@@ -9,7 +9,7 @@
9
9
  | **status** | [**InAppTransactionEventStatus**](InAppTransactionEventStatus.md) | | |
10
10
  | **amount** | **Float** | | |
11
11
  | **iso_currency_code** | **String** | The ISO-4217 currency code. | |
12
- | **transaction_type** | [**TransactionEventType**](TransactionEventType.md) | | |
12
+ | **transaction_type** | [**TransactionEventType**](TransactionEventType.md) | | [optional] |
13
13
  | **merchant_name** | **String** | | |
14
14
  | **timestamp** | **String** | Datetime of the transaction In ISO-8601 format | |
15
15
  | **balance** | **Float** | The running balance of the account after the transaction has occurred, in cents. | [optional] |