fuse_client 1.0.31 → 1.0.34

data/docs/EnrichedTransactionLogo.md

@@ -0,0 +1,18 @@
+# FuseClient::EnrichedTransactionLogo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The URL of the logo. | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::EnrichedTransactionLogo.new(
+  url: null
+)
+```
+

data/docs/Entity.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique identifier for the user or business account. |  |
+| **id** | **String** | Unique identifier for the user or business account that is connecting to an institution. Use this id when calling the GET /entities/${entity_id} endpoint. |  |
 | **name** | **String** | Name for the user or business account. | [optional] |
 | **email** | **String** | Email address associated with the user or business account. | [optional] |
 

data/docs/EvalSpendPowerRequest.md

@@ -0,0 +1,22 @@
+# FuseClient::EvalSpendPowerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **window_size** | **Float** | The size of the window for training |  |
+| **time_frame** | [**SpendPowerTimeFrame**](SpendPowerTimeFrame.md) |  |  |
+| **events** | [**Array<EvalSpendPowerRequestEventsInner>**](EvalSpendPowerRequestEventsInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::EvalSpendPowerRequest.new(
+  window_size: null,
+  time_frame: null,
+  events: null
+)
+```
+

data/docs/EvalSpendPowerRequestEventsInner.md

@@ -0,0 +1,20 @@
+# FuseClient::EvalSpendPowerRequestEventsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The id of the account that event belongs to |  |
+| **event** | [**AddAccountEventsRequestEventsInner**](AddAccountEventsRequestEventsInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::EvalSpendPowerRequestEventsInner.new(
+  account_id: null,
+  event: null
+)
+```
+

data/docs/EvalSpendPowerResponse.md

@@ -0,0 +1,20 @@
+# FuseClient::EvalSpendPowerResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mean_absolute_overestimation_error** | **Float** | The mean absolute overestimation error for the data | [optional] |
+| **mean_absolute_underestimation_error** | **Float** | The mean absolute underestimation error for the data | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::EvalSpendPowerResponse.new(
+  mean_absolute_overestimation_error: null,
+  mean_absolute_underestimation_error: null
+)
+```
+

data/docs/ExchangeFinancialConnectionsPublicTokenRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **public_token** | **String** | The public token created after a user connects with their financial institution | [optional] |
+| **public_token** | **String** | The public token created after a user connects with their financial institution |  |
 
 ## Example
 

data/docs/ExchangeFinancialConnectionsPublicTokenResponse.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **access_token** | **String** | Token used for querying data on the user |  |
-| **financial_connection_id** | **String** | The id of the new financial connection. Every webhook will be sent with this id. |  |
+| **access_token** | **String** | Token used for querying data on the user, ie account details, balances etc. This does NOT expire and should be stored securely. |  |
+| **financial_connection_id** | **String** | The id of the new financial connection. Every webhook will be sent with this id. Use this id when calling the GET /financial_connection/${financial_connection_id} endpoint.  |  |
 | **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. |  |
 
 ## Example

data/docs/ExternalTransactionEvent.md

@@ -0,0 +1,36 @@
+# FuseClient::ExternalTransactionEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the transaction |  |
+| **event_type** | **String** |  |  |
+| **status** | [**ExternalTransactionEventStatus**](ExternalTransactionEventStatus.md) |  |  |
+| **balance** | **Float** | The running balance of the account after the transaction has occurred, in cents | [optional] |
+| **amount** | **Float** | Use positive values to represent money going out and negative to represent money going in. |  |
+| **merchant_name** | **String** |  |  |
+| **transaction_type** | [**TransactionEventType**](TransactionEventType.md) |  |  |
+| **category** | [**TransactionCategory**](TransactionCategory.md) |  |  |
+| **iso_currency_code** | **String** | The ISO-4217 currency code. |  |
+| **timestamp** | **String** | Datetime of the transaction In ISO-8601 format |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::ExternalTransactionEvent.new(
+  id: null,
+  event_type: null,
+  status: null,
+  balance: null,
+  amount: null,
+  merchant_name: null,
+  transaction_type: null,
+  category: null,
+  iso_currency_code: null,
+  timestamp: null
+)
+```
+

data/docs/ExternalTransactionEventStatus.md

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

data/docs/FinancialConnectionsAccountBalance.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **remote_account_id** | **String** | Remote Account Id of the transaction, ie Plaid Account Id |  |
-| **available** | **Float** | Amount in cents after factoring in pending balances | [optional] |
-| **current** | **Float** | Amount in cents without factoring in pending balances | [optional] |
+| **available** | **Float** | Amount in cents after factoring in pending balances. The format of this value is a double. For accounts with credit features, the available funds generally equal the credit limit. Some institutions may not provide an available balance calculation. If this is the case, Fuse will return a null value for the available balance. To ensure you have the most accurate information, we recommend obtaining the current balance by using 'balance.available || balance.current'. | [optional] |
+| **current** | **Float** | Amount in cents without factoring in pending balances. The format of this value is a double. | [optional] |
 | **iso_currency_code** | **String** | The ISO-4217 currency code of the balance. | [optional] |
 | **last_updated_date** | **String** | The last time the account balance was updated, represented as an ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ssZ). This value may not be available for some accounts. | [optional] |
 

data/docs/FinancialConnectionsAccountCachedBalance.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **available** | **Float** | The amount of funds available to be withdrawn from the account, as determined by the financial institution Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /financial_connections/balances. | [optional] |
-| **current** | **Float** | Amount without factoring in pending balances | [optional] |
+| **available** | **Float** | The amount of funds available, in cents, to be withdrawn from the account, as determined by the financial institution. The format of this value is a double. Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /financial_connections/balances. For accounts with credit features, the available funds generally equal the credit limit. Some institutions may not provide an available balance calculation. If this is the case, Fuse will return a null value for the available balance. To ensure you have the most accurate information, we recommend obtaining the current balance by using 'balance.available || balance.current'. | [optional] |
+| **current** | **Float** | Amount without factoring in pending balances, in cents. The format of this value is a double. | [optional] |
 | **iso_currency_code** | **String** | The ISO-4217 currency code of the balance. | [optional] |
 | **last_updated_date** | **String** | The date of the last update to the balance. | [optional] |
 

data/docs/FinancialConnectionsHolding.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **remote_account_id** | **String** | The remote account ID associated with this holding. |  |
-| **cost_basis** | **Float** | The original total value of the holding when it was purchased. |  |
-| **value** | **Float** | The current market value of the holding. |  |
+| **cost_basis** | **Float** | The original total value of the holding, in cents, when it was purchased. The format of this value is a double. |  |
+| **value** | **Float** | The current market value of the holding, in cents. The format of this value is a double. |  |
 | **quantity** | **Float** | The number of units of the security held in this holding. |  |
-| **institution_price** | **Float** | The price of the security as provided by the financial institution managing the holding. |  |
+| **institution_price** | **Float** | The price of the security, in cents, as provided by the financial institution managing the holding. The format of this value is a double. |  |
 | **security** | [**FinancialConnectionsInvestmentSecurity**](FinancialConnectionsInvestmentSecurity.md) |  |  |
 
 ## Example

data/docs/FinancialConnectionsInvestmentSecurity.md

@@ -9,10 +9,10 @@
 | **isin** | **String** | The International Securities Identification Number (ISIN) uniquely identifies the security. | [optional] |
 | **sedol** | **String** | The Stock Exchange Daily Official List (SEDOL) code uniquely identifies the security, primarily used in the United Kingdom and Ireland. | [optional] |
 | **cusip** | **String** | The Committee on Uniform Securities Identification Procedures (CUSIP) number uniquely identifies the security, primarily used in the United States and Canada. | [optional] |
-| **close_price** | **Float** | The closing price of the security at the end of the most recent trading day. |  |
+| **close_price** | **Float** | The closing price of the security, in cents, at the end of the most recent trading day. The format of this value is a double. | [optional] |
 | **currency** | [**Currency**](Currency.md) |  |  |
 | **name** | **String** | A descriptive name for the security, suitable for display. | [optional] |
-| **type** | **String** | The type of security (e.g., equity, mutual fund) | [optional] |
+| **type** | [**FinancialConnectionsInvestmentSecurityType**](FinancialConnectionsInvestmentSecurityType.md) |  | [optional] |
 | **exchange** | [**FinancialConnectionsInvestmentSecurityExchange**](FinancialConnectionsInvestmentSecurityExchange.md) |  | [optional] |
 
 ## Example

data/docs/FinancialConnectionsInvestmentSecurityType.md

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

data/docs/FinancialConnectionsInvestmentTransaction.md

@@ -7,13 +7,15 @@
 | **remote_id** | **String** | The remote ID of the Investment transaction |  |
 | **remote_account_id** | **String** | Remote Account Id of the transaction, ie Plaid Account Id |  |
 | **account_name** | **String** | The name of the account associated with the investment transaction | [optional] |
-| **amount** | **Float** | The amount of the investment transaction |  |
+| **amount** | **Float** | The amount of the investment transaction, in cents. The format of this value is a double. |  |
 | **description** | **String** | A description of the investment transaction |  |
-| **fees** | **Float** | The fees associated with the investment transaction |  |
+| **fees** | **Float** | The fees associated with the investment transaction, in cents. The format of this value is a double. |  |
+| **currency** | [**Currency**](Currency.md) |  |  |
 | **date** | **Time** | The date and time of the investment transaction |  |
 | **type** | **String** | The type of the investment transaction (e.g., 'buy', 'sell', 'dividend') |  |
+| **subtype** | [**FinancialConnectionsInvestmentTransactionSubtype**](FinancialConnectionsInvestmentTransactionSubtype.md) |  | [optional] |
 | **quantity** | **Float** | The number of units of the security involved in this transaction |  |
-| **price** | **Float** | The price of the security involved in this transaction |  |
+| **price** | **Float** | The price of the security involved in this transaction, in cents. The format of this value is a double. |  |
 | **security** | [**FinancialConnectionsInvestmentSecurity**](FinancialConnectionsInvestmentSecurity.md) |  |  |
 
 ## Example
@@ -28,8 +30,10 @@ instance = FuseClient::FinancialConnectionsInvestmentTransaction.new(
   amount: null,
   description: null,
   fees: null,
+  currency: null,
   date: null,
   type: null,
+  subtype: null,
   quantity: null,
   price: null,
   security: null

data/docs/FinancialConnectionsInvestmentTransactionSubtype.md

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