fuse_client 1.0.37 → 1.0.38

data/docs/RiskReportApi.md

@@ -0,0 +1,165 @@
+# FuseClient::RiskReportApi
+
+All URIs are relative to *https://sandbox-api.letsfuse.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_consumer_risk_report**](RiskReportApi.md#delete_consumer_risk_report) | **DELETE** /v1/risk_report/consumer/{consumer_risk_report_id} | Delete consumer risk report |
+| [**get_consumer_risk_report_customization**](RiskReportApi.md#get_consumer_risk_report_customization) | **GET** /v1/risk_report/consumer/customization/{consumer_risk_report_customization_id} | Get consumer risk report customization |
+
+
+## delete_consumer_risk_report
+
+> <DeleteConsumerRiskReportResponse> delete_consumer_risk_report(consumer_risk_report_id, fuse_client_id, fuse_api_key)
+
+Delete consumer risk report
+
+### Examples
+
+```ruby
+require 'time'
+require 'fuse_client'
+# setup authorization
+FuseClient.configure do |config|
+  # Configure API key authorization: fuseApiKey
+  config.api_key['fuseApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseApiKey'] = 'Bearer'
+
+  # Configure API key authorization: fuseClientId
+  config.api_key['fuseClientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseClientId'] = 'Bearer'
+end
+
+api_instance = FuseClient::RiskReportApi.new
+consumer_risk_report_id = 'consumer_risk_report_id_example' # String | 
+fuse_client_id = 'fuse_client_id_example' # String | 
+fuse_api_key = 'fuse_api_key_example' # String | 
+
+begin
+  # Delete consumer risk report
+  result = api_instance.delete_consumer_risk_report(consumer_risk_report_id, fuse_client_id, fuse_api_key)
+  p result
+rescue FuseClient::ApiError => e
+  puts "Error when calling RiskReportApi->delete_consumer_risk_report: #{e}"
+end
+```
+
+#### Using the delete_consumer_risk_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteConsumerRiskReportResponse>, Integer, Hash)> delete_consumer_risk_report_with_http_info(consumer_risk_report_id, fuse_client_id, fuse_api_key)
+
+```ruby
+begin
+  # Delete consumer risk report
+  data, status_code, headers = api_instance.delete_consumer_risk_report_with_http_info(consumer_risk_report_id, fuse_client_id, fuse_api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteConsumerRiskReportResponse>
+rescue FuseClient::ApiError => e
+  puts "Error when calling RiskReportApi->delete_consumer_risk_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **consumer_risk_report_id** | **String** |  |  |
+| **fuse_client_id** | **String** |  |  |
+| **fuse_api_key** | **String** |  |  |
+
+### Return type
+
+[**DeleteConsumerRiskReportResponse**](DeleteConsumerRiskReportResponse.md)
+
+### Authorization
+
+[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_consumer_risk_report_customization
+
+> <GetConsumerRiskReportCustomizationResponse> get_consumer_risk_report_customization(consumer_risk_report_customization_id, fuse_client_id, fuse_api_key)
+
+Get consumer risk report customization
+
+### Examples
+
+```ruby
+require 'time'
+require 'fuse_client'
+# setup authorization
+FuseClient.configure do |config|
+  # Configure API key authorization: fuseApiKey
+  config.api_key['fuseApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseApiKey'] = 'Bearer'
+
+  # Configure API key authorization: fuseClientId
+  config.api_key['fuseClientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseClientId'] = 'Bearer'
+end
+
+api_instance = FuseClient::RiskReportApi.new
+consumer_risk_report_customization_id = 'consumer_risk_report_customization_id_example' # String | 
+fuse_client_id = 'fuse_client_id_example' # String | 
+fuse_api_key = 'fuse_api_key_example' # String | 
+
+begin
+  # Get consumer risk report customization
+  result = api_instance.get_consumer_risk_report_customization(consumer_risk_report_customization_id, fuse_client_id, fuse_api_key)
+  p result
+rescue FuseClient::ApiError => e
+  puts "Error when calling RiskReportApi->get_consumer_risk_report_customization: #{e}"
+end
+```
+
+#### Using the get_consumer_risk_report_customization_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetConsumerRiskReportCustomizationResponse>, Integer, Hash)> get_consumer_risk_report_customization_with_http_info(consumer_risk_report_customization_id, fuse_client_id, fuse_api_key)
+
+```ruby
+begin
+  # Get consumer risk report customization
+  data, status_code, headers = api_instance.get_consumer_risk_report_customization_with_http_info(consumer_risk_report_customization_id, fuse_client_id, fuse_api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetConsumerRiskReportCustomizationResponse>
+rescue FuseClient::ApiError => e
+  puts "Error when calling RiskReportApi->get_consumer_risk_report_customization_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **consumer_risk_report_customization_id** | **String** |  |  |
+| **fuse_client_id** | **String** |  |  |
+| **fuse_api_key** | **String** |  |  |
+
+### Return type
+
+[**GetConsumerRiskReportCustomizationResponse**](GetConsumerRiskReportCustomizationResponse.md)
+
+### Authorization
+
+[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Transaction.md

@@ -10,7 +10,7 @@
 | **amount** | **Float** | Amount in cents associated with the transaction. The format of this value is a double.  Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative. |  |
 | **date** | **String** | Date of the transaction (YYYY-MM-DD) |  |
 | **description** | **String** | Description of the transaction |  |
-| **category** | **Array<String>** | Categories of the transaction, ie Computers and Electronics |  |
+| **category** | **Array<String>** | Categories of the transaction, i.e., Computers and Electronics. You can download the categories from [here](https://fuse-public-bucket.s3.amazonaws.com/transaction-categories.csv) |  |
 | **merchant** | [**TransactionMerchant**](TransactionMerchant.md) |  |  |
 | **status** | **String** | The status of the transaction. This will be either posted or pending. |  |
 | **type** | **String** | Type of the transaction, ie adjustment. '-' means we were not able to map the upstream type. |  |

data/docs/{UpdateSpendPowerCustomizationRequest.md → UpdateConsumerRiskReportCustomizationRequest.md}

@@ -1,12 +1,12 @@
-# FuseClient::UpdateSpendPowerCustomizationRequest
+# FuseClient::UpdateConsumerRiskReportCustomizationRequest
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **timeframe** | [**SpendPowerTimeFrame**](SpendPowerTimeFrame.md) |  | [optional] |
-| **min_limit** | **Float** | The minimum allowed limit for the spend power, in cents. | [optional] |
-| **max_limit** | **Float** | The maximum allowed limit for the spend power, in cents. | [optional] |
+| **timeframe** | [**ConsumerRiskReportTimeFrame**](ConsumerRiskReportTimeFrame.md) |  | [optional] |
+| **min_limit** | **Float** | The minimum allowed limit, in cents. | [optional] |
+| **max_limit** | **Float** | The maximum allowed limit, in cents. | [optional] |
 | **risk_tolerance** | **Float** | This parameter indicates the risk tolerance associated with spend limits. A high risk tolerance allow for higher limits, increasing both potential gains and losses. A Lower risk tolerance enforces strict limits, reducing the potential for loss but also limiting transaction volume for reliable users. | [optional] |
 
 ## Example
@@ -14,7 +14,7 @@
 ```ruby
 require 'fuse_client'
 
-instance = FuseClient::UpdateSpendPowerCustomizationRequest.new(
+instance = FuseClient::UpdateConsumerRiskReportCustomizationRequest.new(
   timeframe: null,
   min_limit: null,
   max_limit: null,

data/docs/{UpdateSpendPowerCustomizationResponse.md → UpdateConsumerRiskReportCustomizationResponse.md}

@@ -1,4 +1,4 @@
-# FuseClient::UpdateSpendPowerCustomizationResponse
+# FuseClient::UpdateConsumerRiskReportCustomizationResponse
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'fuse_client'
 
-instance = FuseClient::UpdateSpendPowerCustomizationResponse.new(
+instance = FuseClient::UpdateConsumerRiskReportCustomizationResponse.new(
   id: null,
   request_id: null
 )

data/docs/UpdatedBalanceEvent.md

@@ -7,8 +7,8 @@
 | **event_type** | **String** |  |  |
 | **iso_currency_code** | **String** | The ISO-4217 currency code. |  |
 | **timestamp** | **String** | Datetime that the balance is accurate for In ISO-8601 format |  |
-| **available** | **Float** | The current balance of the account factoring in pending transactions. Use positive values to represent money going out and negative to represent money going in. | [optional] |
-| **current** | **Float** | The current balance of the account without factoring in pending transactions. Use positive values to represent money going out and negative to represent money going in. | [optional] |
+| **available** | **Float** | The current balance of the account factoring in pending transactions. | [optional] |
+| **current** | **Float** | The current balance of the account without factoring in pending transactions. | [optional] |
 
 ## Example