fuse_client 1.0.31 → 1.0.34

data/docs/FuseApiAggregatorError.md

@@ -0,0 +1,28 @@
+# FuseClient::FuseApiAggregatorError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **details** | **String** |  | [optional] |
+| **code** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **path** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::FuseApiAggregatorError.new(
+  request_id: null,
+  title: null,
+  details: null,
+  code: null,
+  type: null,
+  path: null
+)
+```
+

data/docs/FuseApiError.md

@@ -4,11 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **title** | **String** |  | [optional] |
-| **details** | **String** |  | [optional] |
-| **code** | **String** |  | [optional] |
-| **type** | **String** |  | [optional] |
-| **source** | **String** |  | [optional] |
+| **request_id** | **String** |  |  |
+| **title** | **String** |  |  |
+| **details** | **String** |  |  |
+| **code** | [**FuseApiErrorCode**](FuseApiErrorCode.md) |  |  |
+| **type** | [**FuseApiErrorType**](FuseApiErrorType.md) |  |  |
+| **source** | **String** |  |  |
 | **data** | [**FuseApiErrorData**](FuseApiErrorData.md) |  | [optional] |
 
 ## Example
@@ -17,6 +18,7 @@
 require 'fuse_client'
 
 instance = FuseClient::FuseApiError.new(
+  request_id: null,
   title: null,
   details: null,
   code: null,

data/docs/FuseApiErrorCode.md

@@ -0,0 +1,15 @@
+# FuseClient::FuseApiErrorCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::FuseApiErrorCode.new()
+```
+

data/docs/FuseApiErrorData.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **aggregator** | [**Aggregator**](Aggregator.md) |  | [optional] |
-| **errors** | [**Array<FuseApiError>**](FuseApiError.md) |  | [optional] |
+| **errors** | [**Array<FuseApiAggregatorError>**](FuseApiAggregatorError.md) |  | [optional] |
 
 ## Example
 

data/docs/FuseApiErrorType.md

@@ -0,0 +1,15 @@
+# FuseClient::FuseApiErrorType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::FuseApiErrorType.new()
+```
+

data/docs/GetAssetReportRequest.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **access_token** | **String** | Access fuse token corresponding to the financial account to be refresh the Asset Report for. |  |
 | **asset_report_token** | **String** | The token associated with the Asset Report to retrieve. |  |
 
 ## Example
@@ -12,6 +13,7 @@
 require 'fuse_client'
 
 instance = FuseClient::GetAssetReportRequest.new(
+  access_token: null,
   asset_report_token: null
 )
 ```

data/docs/GetFinanceScoreResponse.md

@@ -0,0 +1,20 @@
+# FuseClient::GetFinanceScoreResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **finance_score** | **Float** | A value between 0 and 1 where 1 is a perfect finance score and 0 is the worst finance score. |  |
+| **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::GetFinanceScoreResponse.new(
+  finance_score: null,
+  request_id: null
+)
+```
+

data/docs/GetFinancialConnectionsAccountStatementRequest.md

@@ -0,0 +1,22 @@
+# FuseClient::GetFinancialConnectionsAccountStatementRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** | Access token for authentication |  |
+| **remote_account_id** | **String** | The remote account id to retrieve the statement for. |  |
+| **date** | **String** | The year and month for the account statement to be retrieved in YYYY-MM. | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::GetFinancialConnectionsAccountStatementRequest.new(
+  access_token: null,
+  remote_account_id: null,
+  date: null
+)
+```
+

data/docs/GetFinancialConnectionsAccountStatementResponse.md

@@ -0,0 +1,20 @@
+# FuseClient::GetFinancialConnectionsAccountStatementResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **statement_url** | **String** | PDF statement URL. |  |
+| **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::GetFinancialConnectionsAccountStatementResponse.new(
+  statement_url: null,
+  request_id: null
+)
+```
+

data/docs/GetInvestmentTransactionsRequest.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **access_token** | **String** | Access token for authentication |  |
-| **start_date** | **String** | The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD. | [optional] |
-| **end_date** | **String** | The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD. | [optional] |
-| **page** | **Integer** | Specify current page. | [optional] |
-| **records_per_page** | **Integer** | Number of items per page. | [optional][default to 25] |
+| **start_date** | **String** | The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD. |  |
+| **end_date** | **String** | The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD. |  |
+| **page** | **Integer** | Specify current page. |  |
+| **records_per_page** | **Integer** | Number of items per page. | [default to 25] |
 | **options** | [**GetInvestmentTransactionsRequestOptions**](GetInvestmentTransactionsRequestOptions.md) |  | [optional] |
 
 ## Example

data/docs/GetInvestmentTransactionsResponse.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **accounts** | [**Array<FinancialConnectionsAccount>**](FinancialConnectionsAccount.md) |  |  |
 | **investment_transactions** | [**Array<FinancialConnectionsInvestmentTransaction>**](FinancialConnectionsInvestmentTransaction.md) |  |  |
+| **total_transactions** | **Float** | The total number of transactions within the specified date range. | [optional] |
 | **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. |  |
 
 ## Example
@@ -16,6 +17,7 @@ require 'fuse_client'
 instance = FuseClient::GetInvestmentTransactionsResponse.new(
   accounts: null,
   investment_transactions: null,
+  total_transactions: null,
   request_id: null
 )
 ```

data/docs/GetSpendPowerCustomizationResponse.md

@@ -0,0 +1,20 @@
+# FuseClient::GetSpendPowerCustomizationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **spend_power_customization** | [**SpendPowerCustomization**](SpendPowerCustomization.md) |  |  |
+| **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::GetSpendPowerCustomizationResponse.new(
+  spend_power_customization: null,
+  request_id: null
+)
+```
+

data/docs/GetSpendPowerResponse.md

@@ -0,0 +1,20 @@
+# FuseClient::GetSpendPowerResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **spend_power** | [**SpendPower**](SpendPower.md) |  |  |
+| **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::GetSpendPowerResponse.new(
+  spend_power: null,
+  request_id: null
+)
+```
+

data/docs/InAppTransactionEvent.md

@@ -0,0 +1,34 @@
+# FuseClient::InAppTransactionEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the transaction |  |
+| **event_type** | **String** |  |  |
+| **status** | [**InAppTransactionEventStatus**](InAppTransactionEventStatus.md) |  |  |
+| **balance** | **Float** | The running balance of the account after the transaction has occurred, in cents. | [optional] |
+| **amount** | **Float** |  |  |
+| **merchant_name** | **String** |  |  |
+| **transaction_type** | [**TransactionEventType**](TransactionEventType.md) |  |  |
+| **iso_currency_code** | **String** | The ISO-4217 currency code. | [optional] |
+| **timestamp** | **String** | Datetime of the transaction In ISO-8601 format |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::InAppTransactionEvent.new(
+  id: null,
+  event_type: null,
+  status: null,
+  balance: null,
+  amount: null,
+  merchant_name: null,
+  transaction_type: null,
+  iso_currency_code: null,
+  timestamp: null
+)
+```
+

data/docs/InAppTransactionEventStatus.md

@@ -0,0 +1,15 @@
+# FuseClient::InAppTransactionEventStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::InAppTransactionEventStatus.new()
+```
+

data/docs/MigrateFinancialConnectionsAggregatorConnectionData.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **plaid** | [**MigrateFinancialConnectionsAggregatorConnectionDataPlaid**](MigrateFinancialConnectionsAggregatorConnectionDataPlaid.md) |  | [optional] |
 | **mx** | [**MigrateFinancialConnectionsAggregatorConnectionDataMx**](MigrateFinancialConnectionsAggregatorConnectionDataMx.md) |  | [optional] |
+| **teller** | [**MigrateFinancialConnectionsAggregatorConnectionDataTeller**](MigrateFinancialConnectionsAggregatorConnectionDataTeller.md) |  | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'fuse_client'
 
 instance = FuseClient::MigrateFinancialConnectionsAggregatorConnectionData.new(
   plaid: null,
-  mx: null
+  mx: null,
+  teller: null
 )
 ```
 

data/docs/MigrateFinancialConnectionsAggregatorConnectionDataPlaid.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **access_token** | **String** | The Plaid access token associated with the user's financial accounts. |  |
+| **use_item_webhook** | **Boolean** | If true, any webhooks received for this new financial connection will be sent to the webhook url used when the item was created. If false, the webhook url set at the organization sandbox/production environment level will be used instead. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'fuse_client'
 
 instance = FuseClient::MigrateFinancialConnectionsAggregatorConnectionDataPlaid.new(
-  access_token: null
+  access_token: null,
+  use_item_webhook: null
 )
 ```
 

data/docs/MigrateFinancialConnectionsAggregatorConnectionDataTeller.md

@@ -0,0 +1,18 @@
+# FuseClient::MigrateFinancialConnectionsAggregatorConnectionDataTeller
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** | The Teller access token associated with the user's financial accounts. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::MigrateFinancialConnectionsAggregatorConnectionDataTeller.new(
+  access_token: null
+)
+```
+

data/docs/MigrateFinancialConnectionsTokenRequest.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **connection_data** | [**MigrateFinancialConnectionsAggregatorConnectionData**](MigrateFinancialConnectionsAggregatorConnectionData.md) |  |  |
-| **aggregator** | **String** | The aggregator being migrated (either 'plaid' or 'mx'). |  |
+| **aggregator** | **String** | The aggregator being migrated (either 'plaid', 'mx' or 'teller). |  |
 | **entity** | [**MigrateFinancialConnectionsTokenRequestEntity**](MigrateFinancialConnectionsTokenRequestEntity.md) |  |  |
 | **fuse_products** | [**Array<Product>**](Product.md) | A list of Fuse products that the migrated connection will have access to. |  |
 

data/docs/RefreshAssetReportRequest.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **access_token** | **String** | The asset_report_token returned by the original call to /asset_report/create | [optional] |
-| **days_requested** | **Float** | The maximum integer number of days of history to include in the Asset Report |  |
-| **include_identity** | **Boolean** | Indicates whether to include identity data in the Asset Report | [optional][default to true] |
+| **access_token** | **String** | Access fuse token corresponding to the financial account to be refresh the Asset Report for. |  |
+| **asset_report_token** | **String** | The asset_report_token returned by the original call to /asset_report/create |  |
+| **days_requested** | **Float** | The maximum integer number of days of history to include in the Asset Report | [optional] |
 
 ## Example
 
@@ -15,8 +15,8 @@ require 'fuse_client'
 
 instance = FuseClient::RefreshAssetReportRequest.new(
   access_token: null,
-  days_requested: null,
-  include_identity: null
+  asset_report_token: null,
+  days_requested: null
 )
 ```
 

data/docs/RefreshAssetReportResponse.md

@@ -0,0 +1,22 @@
+# FuseClient::RefreshAssetReportResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **asset_report_token** | **String** | A token that can be provided to endpoints such as /asset_report to fetch an asset report. | [optional] |
+| **asset_report_id** | **String** | A unique ID identifying an Asset Report. | [optional] |
+| **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::RefreshAssetReportResponse.new(
+  asset_report_token: null,
+  asset_report_id: null,
+  request_id: null
+)
+```
+

data/docs/SpendPower.md

@@ -0,0 +1,30 @@
+# FuseClient::SpendPower
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the spend power |  |
+| **customization_id** | **String** | The customization id of the spend power. |  |
+| **spend_limit** | **Float** | The total limit for the current timeframe, in cents. |  |
+| **current_spend** | **Float** | The total current spend in the current timeframe, in cents, without factoring in pending payments. |  |
+| **pending_payments_amount** | **Float** | The total unpaid amount, in cents, from all timeframes. |  |
+| **iso_currency_code** | **String** | The ISO-4217 currency code of the transaction |  |
+| **last_updated** | **String** | The datetime of when the spend power was most recently updated, in ISO-8601 format. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::SpendPower.new(
+  id: null,
+  customization_id: null,
+  spend_limit: null,
+  current_spend: null,
+  pending_payments_amount: null,
+  iso_currency_code: null,
+  last_updated: null
+)
+```
+

data/docs/SpendPowerApi.md

@@ -0,0 +1,165 @@
+# FuseClient::SpendPowerApi
+
+All URIs are relative to *https://sandbox-api.letsfuse.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_spend_power**](SpendPowerApi.md#delete_spend_power) | **DELETE** /v1/spend_power/{spend_power_id} | Delete spend power customization |
+| [**get_spend_power_customization**](SpendPowerApi.md#get_spend_power_customization) | **GET** /v1/spend_power/customization/{spend_power_customization_id} | Get spend power customization |
+
+
+## delete_spend_power
+
+> <DeleteSpendPowerResponse> delete_spend_power(spend_power_id, fuse_client_id, fuse_api_key)
+
+Delete spend power 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::SpendPowerApi.new
+spend_power_id = 'spend_power_id_example' # String | 
+fuse_client_id = 'fuse_client_id_example' # String | 
+fuse_api_key = 'fuse_api_key_example' # String | 
+
+begin
+  # Delete spend power customization
+  result = api_instance.delete_spend_power(spend_power_id, fuse_client_id, fuse_api_key)
+  p result
+rescue FuseClient::ApiError => e
+  puts "Error when calling SpendPowerApi->delete_spend_power: #{e}"
+end
+```
+
+#### Using the delete_spend_power_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteSpendPowerResponse>, Integer, Hash)> delete_spend_power_with_http_info(spend_power_id, fuse_client_id, fuse_api_key)
+
+```ruby
+begin
+  # Delete spend power customization
+  data, status_code, headers = api_instance.delete_spend_power_with_http_info(spend_power_id, fuse_client_id, fuse_api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteSpendPowerResponse>
+rescue FuseClient::ApiError => e
+  puts "Error when calling SpendPowerApi->delete_spend_power_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **spend_power_id** | **String** |  |  |
+| **fuse_client_id** | **String** |  |  |
+| **fuse_api_key** | **String** |  |  |
+
+### Return type
+
+[**DeleteSpendPowerResponse**](DeleteSpendPowerResponse.md)
+
+### Authorization
+
+[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_spend_power_customization
+
+> <GetSpendPowerCustomizationResponse> get_spend_power_customization(spend_power_customization_id, fuse_client_id, fuse_api_key)
+
+Get spend power 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::SpendPowerApi.new
+spend_power_customization_id = 'spend_power_customization_id_example' # String | 
+fuse_client_id = 'fuse_client_id_example' # String | 
+fuse_api_key = 'fuse_api_key_example' # String | 
+
+begin
+  # Get spend power customization
+  result = api_instance.get_spend_power_customization(spend_power_customization_id, fuse_client_id, fuse_api_key)
+  p result
+rescue FuseClient::ApiError => e
+  puts "Error when calling SpendPowerApi->get_spend_power_customization: #{e}"
+end
+```
+
+#### Using the get_spend_power_customization_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetSpendPowerCustomizationResponse>, Integer, Hash)> get_spend_power_customization_with_http_info(spend_power_customization_id, fuse_client_id, fuse_api_key)
+
+```ruby
+begin
+  # Get spend power customization
+  data, status_code, headers = api_instance.get_spend_power_customization_with_http_info(spend_power_customization_id, fuse_client_id, fuse_api_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetSpendPowerCustomizationResponse>
+rescue FuseClient::ApiError => e
+  puts "Error when calling SpendPowerApi->get_spend_power_customization_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **spend_power_customization_id** | **String** |  |  |
+| **fuse_client_id** | **String** |  |  |
+| **fuse_api_key** | **String** |  |  |
+
+### Return type
+
+[**GetSpendPowerCustomizationResponse**](GetSpendPowerCustomizationResponse.md)
+
+### Authorization
+
+[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SpendPowerCustomization.md

@@ -0,0 +1,24 @@
+# FuseClient::SpendPowerCustomization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the spend power customization |  |
+| **timeframe** | [**SpendPowerTimeFrame**](SpendPowerTimeFrame.md) |  |  |
+| **min_limit** | **Float** | The minimum allowed limit for the spend power, in cents. |  |
+| **max_limit** | **Float** | The maximum allowed limit for the spend power, in cents. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::SpendPowerCustomization.new(
+  id: null,
+  timeframe: null,
+  min_limit: null,
+  max_limit: null
+)
+```
+

data/docs/SpendPowerTimeFrame.md

@@ -0,0 +1,15 @@
+# FuseClient::SpendPowerTimeFrame
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::SpendPowerTimeFrame.new()
+```
+