fuse_client 1.0.33 → 1.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca72dbf2bc898395d54eb0df6c34a5db41fc38ecc106eecac08d0ef7d42ade4
-  data.tar.gz: bb5b81f8e7432c42db84d430cfb12db3655a6638a8ece572043da51eba8642b4
+  metadata.gz: 13808acb1caccaa1752875f52264434903b405cfb922cc63d6885dc58cb8ccac
+  data.tar.gz: 54255f1b24ecdaa6c097fd31cf941f002de6707857bb9bce01444f378a4d55c1
 SHA512:
-  metadata.gz: a7f647519d4602e1898d03234816b5885bde16355097c85ad31aa68a4f5adda45f5e139f026f6b3caa342f32cd831a447a1a8fda570addbd37326ab39c218133
-  data.tar.gz: 75b9bf702e2261e4e59e26f34e87a8d653e8eebe7121d3cea8a8e238cb50a37913051aa0a226af470b03a5d2304d1e64a43d27059e64c0f55e0b15654938a350
+  metadata.gz: 946aeeab6dceb80a9c4fd8799f69e57dcdd2b7236575119a4fa59f85b3d3ee4558f52d2649cd75361447edf5a6c5b661262d5ef8638583f2cb7961440f85c8fd
+  data.tar.gz: 3e17a21eb9a97b79fd50abde6bdc1f2a0c16a2692e2b6f4ff876fc2783c16287e395033e0a17ed6df3e428ba2bab9658f53e95fac837fc132aca65c699f7ec88

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuse_client (1.0.33)
+    fuse_client (1.0.34)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -14,7 +14,7 @@ GEM
     ethon (0.16.0)
       ffi (>= 1.15.0)
     ffi (1.15.5)
-    jaro_winkler (1.5.4)
+    jaro_winkler (1.5.5)
     method_source (1.0.0)
     parallel (1.23.0)
     parser (3.2.2.1)

data/README.md

@@ -3,7 +3,7 @@
 ### Add to gem file
 
 ```ruby
-gem 'fuse_client', "~> 1.0.6"
+gem 'fuse_client', "~> 1.0.33"
 ```
 
 ### Setup fuse client
@@ -83,3 +83,8 @@ class FuseService
 
 end
 ```
+
+### Pushing to gems
+```
+gem build fuse_client.gemspec
+```

data/docs/AddAccountEventsRequest.md

@@ -0,0 +1,18 @@
+# FuseClient::AddAccountEventsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | [**Array<AddAccountEventsRequestEventsInner>**](AddAccountEventsRequestEventsInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::AddAccountEventsRequest.new(
+  events: null
+)
+```
+

data/docs/AddAccountEventsRequestEventsInner.md

@@ -0,0 +1,51 @@
+# FuseClient::AddAccountEventsRequestEventsInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'fuse_client'
+
+FuseClient::AddAccountEventsRequestEventsInner.openapi_one_of
+# =>
+# [
+#   :'ExternalTransactionEvent',
+#   :'InAppTransactionEvent',
+#   :'UpdatedBalanceEvent'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'fuse_client'
+
+FuseClient::AddAccountEventsRequestEventsInner.build(data)
+# => #<ExternalTransactionEvent:0x00007fdd4aab02a0>
+
+FuseClient::AddAccountEventsRequestEventsInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ExternalTransactionEvent`
+- `InAppTransactionEvent`
+- `UpdatedBalanceEvent`
+- `nil` (if no type matches)
+

data/docs/{AddSpendPowerTransactionResponse.md → AddAccountEventsResponse.md}

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

data/docs/AssetReportTransaction.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **remote_id** | **String** | Remote Id of the transaction, ie Plaid or Teller Id |  |
 | **remote_account_id** | **String** | Remote Account Id of the transaction, ie Plaid Account Id |  |
-| **amount** | **Float** | Amount in cents associated with the transaction. 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. |  |
+| **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. '-' means we could not map the upstream category. |  |

data/docs/CreateSessionRequest.md

@@ -8,7 +8,7 @@
 | **products** | [**Array<Product>**](Product.md) | List of products that you would like the institutions to support |  |
 | **country_codes** | [**Array<CountryCode>**](CountryCode.md) | List of country codes that you would like the institutions to support | [optional] |
 | **entity** | [**Entity**](Entity.md) |  |  |
-| **access_token** | **String** | The fuse access token for an existing account integration. This will perform the process to reconnect an existing disconnected account. | [optional] |
+| **access_token** | **String** | The fuse access token for an existing financial connection. This will perform the process to reconnect an existing disconnected account. | [optional] |
 | **is_web_view** | **Boolean** | Set to false for web SDKs (e.g., React), and true for mobile SDKs (e.g., React Native, Flutter, iOS, Android). | [optional] |
 
 ## Example

data/docs/CreateSpendPowerCustomizationRequest.md

@@ -0,0 +1,22 @@
+# FuseClient::CreateSpendPowerCustomizationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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::CreateSpendPowerCustomizationRequest.new(
+  timeframe: null,
+  min_limit: null,
+  max_limit: null
+)
+```
+

data/docs/CreateSpendPowerRequest.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **access_token** | **String** | Access token for authentication |  |
-| **remote_account_id** | **String** | The remote account id to create the spend power for. |  |
-| **customization_id** | **String** | The spend power customization id. |  |
+| **account_id** | **String** | A unique ID representing the bank account that this spend power is calculated for. Typically this will be a bank connection account ID from your application. It is currently used as a means of connecting events to the spend power. |  |
+| **iso_currency_code** | **String** | The ISO-4217 currency code of the transaction |  |
+| **customization_id** | **String** | The spend power customization id. This is used to determine the timeframe and other metadata for the spend power. |  |
 
 ## Example
 
@@ -14,8 +14,8 @@
 require 'fuse_client'
 
 instance = FuseClient::CreateSpendPowerRequest.new(
-  access_token: null,
-  remote_account_id: null,
+  account_id: null,
+  iso_currency_code: null,
   customization_id: null
 )
 ```

data/docs/CreateSpendPowerResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The id of the created spend power |  |
+| **id** | **String** | The id of the created spend power. |  |
 | **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/DeleteSpendPowerResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **spend_power** | [**SpendPower**](SpendPower.md) |  |  |
+| **id** | **String** | The id of the deleted spend power |  |
 | **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. |  |
 
 ## Example
@@ -13,7 +13,7 @@
 require 'fuse_client'
 
 instance = FuseClient::DeleteSpendPowerResponse.new(
-  spend_power: null,
+  id: null,
   request_id: null
 )
 ```

data/docs/EnrichTransactionsRequest.md

@@ -0,0 +1,18 @@
+# FuseClient::EnrichTransactionsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transactions** | [**Array<TransactionToEnrich>**](TransactionToEnrich.md) |  |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::EnrichTransactionsRequest.new(
+  transactions: null
+)
+```
+

data/docs/EnrichTransactionsResponse.md

@@ -0,0 +1,18 @@
+# FuseClient::EnrichTransactionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enriched_transactions** | [**Array<EnrichedTransaction>**](EnrichedTransaction.md) | The enriched transactions. | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::EnrichTransactionsResponse.new(
+  enriched_transactions: null
+)
+```
+

data/docs/EnrichedTransaction.md

@@ -0,0 +1,46 @@
+# FuseClient::EnrichedTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A original ID for the transaction that to help you tie data back to your systems. |  |
+| **name** | **String** | The original or enhanced name of the merchant. | [optional] |
+| **logo** | [**EnrichedTransactionLogo**](EnrichedTransactionLogo.md) |  | [optional] |
+| **amount** | **Float** | The amount of the transaction in cents, in the currency of the account. | [optional] |
+| **category** | [**TransactionCategory**](TransactionCategory.md) |  | [optional] |
+| **is_bill_pay** | **Boolean** | Whether the transaction is a bill pay. | [optional] |
+| **is_direct_deposit** | **Boolean** | Whether the transaction is a direct deposit. | [optional] |
+| **is_expense** | **Boolean** | Whether the transaction is a an expense | [optional] |
+| **is_fee** | **Boolean** | Whether the transaction is a fee. | [optional] |
+| **is_income** | **Boolean** | Whether the transaction is income. | [optional] |
+| **is_international** | **Boolean** | Whether the transaction is international. | [optional] |
+| **is_overdraft_fee** | **Boolean** | This indicates whether the transaction represents an overdraft fee. | [optional] |
+| **is_payroll_advance** | **Boolean** | Whether the transaction is a payroll advance. | [optional] |
+| **is_subscription** | **Boolean** | Whether the transaction is a subscription. | [optional] |
+| **type** | **String** | The type of transaction | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::EnrichedTransaction.new(
+  id: null,
+  name: null,
+  logo: null,
+  amount: null,
+  category: null,
+  is_bill_pay: null,
+  is_direct_deposit: null,
+  is_expense: null,
+  is_fee: null,
+  is_income: null,
+  is_international: null,
+  is_overdraft_fee: null,
+  is_payroll_advance: null,
+  is_subscription: null,
+  type: null
+)
+```
+

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/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/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. 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 | [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. 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 | [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,7 +9,7 @@
 | **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. | [optional] |
+| **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** | [**FinancialConnectionsInvestmentSecurityType**](FinancialConnectionsInvestmentSecurityType.md) |  | [optional] |

data/docs/FinancialConnectionsInvestmentTransaction.md

@@ -7,14 +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
@@ -32,6 +33,7 @@ instance = FuseClient::FinancialConnectionsInvestmentTransaction.new(
   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()
+```
+