fuse_client 1.0.37 → 1.0.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97c0f377cd1fe329c490e38717e993b7083584e0ee02a9ce5016774ed86f9a87
-  data.tar.gz: a0205d7fbf59bccef126a42e6756b8479722d2c4c269c9be0eee78ffaecfc602
+  metadata.gz: 405c7dda28ecef0c84f7d5139e118bd251b7642653664706b522660e27cbd4c6
+  data.tar.gz: 804299b0297286305bd7f256061195cfc16c213dafdfc3fd90c76e9a46291d9f
 SHA512:
-  metadata.gz: 4f3e5e162fd03432fbb5ea5431be315c20db424fd614684c3c5e6ddc4483cbb046217b1af09c49d87191699eb671ed7a700b26098daa60cdb2a67b5f3e470ba8
-  data.tar.gz: a6cb5e33851c2e7fe87bdcd509924472b3abd0ee21f153f62e7d3dcbb389fe54ffdc6fa39239a570c223cc39e1817b4ca5530dc5bf8be639e38d6df6d9711e88
+  metadata.gz: 66c922e7fd3dd49b6ee4eeac05401839f9b0853ec1c375163be10273ecb915d3d4901c0cca7fe321190e9066fc2e531f27ee9716f88a07345f9dad877678d1e6
+  data.tar.gz: f5b4045c9b26bbbb761548fc9dc6a0c17bd89a4a14fac0088a8fde8ddce48db6d1af86635cad4719a20baa251dd7eed183a7fb6b53478da67ac941397601c57d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuse_client (1.0.37)
+    fuse_client (1.0.40)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -28,7 +28,7 @@ GEM
       pry (>= 0.13, < 0.15)
     psych (5.1.0)
       stringio
-    racc (1.7.0)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rspec (3.12.0)
@@ -40,10 +40,10 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)

data/docs/{SpendPower.md → ConsumerRiskReport.md}

@@ -1,16 +1,16 @@
-# FuseClient::SpendPower
+# FuseClient::ConsumerRiskReport
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The id of the spend power |  |
-| **customization_id** | **String** | The customization id of the spend power. |  |
+| **id** | **String** |  |  |
+| **customization_id** | **String** |  |  |
 | **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. |  |
+| **last_updated** | **String** | The datetime of when the consumer risk report was most recently updated, in ISO-8601 format. |  |
 | **finance_score** | [**FinanceScore**](FinanceScore.md) |  |  |
 | **predicted_balance** | **Float** | Predicted balance for the timeframe. |  |
 
@@ -19,7 +19,7 @@
 ```ruby
 require 'fuse_client'
 
-instance = FuseClient::SpendPower.new(
+instance = FuseClient::ConsumerRiskReport.new(
   id: null,
   customization_id: null,
   spend_limit: null,

data/docs/{SpendPowerCustomization.md → ConsumerRiskReportCustomization.md}

@@ -1,13 +1,13 @@
-# FuseClient::SpendPowerCustomization
+# FuseClient::ConsumerRiskReportCustomization
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The id of the spend power customization |  |
-| **timeframe** | [**SpendPowerTimeFrame**](SpendPowerTimeFrame.md) |  |  |
-| **min_limit** | **Integer** | The minimum allowed limit for the spend power, in cents. |  |
-| **max_limit** | **Integer** | The maximum allowed limit for the spend power, in cents. |  |
+| **id** | **String** |  |  |
+| **timeframe** | [**ConsumerRiskReportTimeFrame**](ConsumerRiskReportTimeFrame.md) |  |  |
+| **min_limit** | **Integer** | The minimum allowed limit, in cents. |  |
+| **max_limit** | **Integer** | The maximum allowed limit, in cents. |  |
 | **risk_tolerance** | **Integer** | 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
@@ -15,7 +15,7 @@
 ```ruby
 require 'fuse_client'
 
-instance = FuseClient::SpendPowerCustomization.new(
+instance = FuseClient::ConsumerRiskReportCustomization.new(
   id: null,
   timeframe: null,
   min_limit: null,

data/docs/{SpendPowerTimeFrame.md → ConsumerRiskReportTimeFrame.md}

@@ -1,4 +1,4 @@
-# FuseClient::SpendPowerTimeFrame
+# FuseClient::ConsumerRiskReportTimeFrame
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'fuse_client'
 
-instance = FuseClient::SpendPowerTimeFrame.new()
+instance = FuseClient::ConsumerRiskReportTimeFrame.new()
 ```
 

data/docs/{CreateSpendPowerCustomizationRequest.md → CreateConsumerRiskReportCustomizationRequest.md}

@@ -1,12 +1,12 @@
-# FuseClient::CreateSpendPowerCustomizationRequest
+# FuseClient::CreateConsumerRiskReportCustomizationRequest
 
 ## 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. |  |
+| **timeframe** | [**ConsumerRiskReportTimeFrame**](ConsumerRiskReportTimeFrame.md) |  |  |
+| **min_limit** | **Float** | The minimum allowed limit, in cents. |  |
+| **max_limit** | **Float** | The maximum allowed limit, in cents. |  |
 | **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. |  |
 
 ## Example
@@ -14,7 +14,7 @@
 ```ruby
 require 'fuse_client'
 
-instance = FuseClient::CreateSpendPowerCustomizationRequest.new(
+instance = FuseClient::CreateConsumerRiskReportCustomizationRequest.new(
   timeframe: null,
   min_limit: null,
   max_limit: null,

data/docs/{CreateSpendPowerCustomizationResponse.md → CreateConsumerRiskReportCustomizationResponse.md}

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

data/docs/CreateConsumerRiskReportRequest.md

@@ -0,0 +1,24 @@
+# FuseClient::CreateConsumerRiskReportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | A unique ID representing the bank account that this risk report 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 consumer risk report. |  |
+| **iso_currency_code** | **String** | The ISO-4217 currency code of the transaction |  |
+| **end_user_name** | **String** | The name of the end user associated with this consumer risk report. | [optional] |
+| **customization_id** | **String** | This is used to determine the timeframe and other metadata for the consumer risk report. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::CreateConsumerRiskReportRequest.new(
+  account_id: null,
+  iso_currency_code: null,
+  end_user_name: null,
+  customization_id: null
+)
+```
+

data/docs/{DeleteSpendPowerResponse.md → CreateConsumerRiskReportResponse.md}

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

data/docs/CreateLinkTokenRequest.md

@@ -12,6 +12,7 @@
 | **mx** | [**CreateLinkTokenRequestMx**](CreateLinkTokenRequestMx.md) |  | [optional] |
 | **plaid** | [**CreateLinkTokenRequestPlaid**](CreateLinkTokenRequestPlaid.md) |  | [optional] |
 | **teller** | [**CreateLinkTokenRequestTeller**](CreateLinkTokenRequestTeller.md) |  | [optional] |
+| **snaptrade** | [**CreateLinkTokenRequestSnaptrade**](CreateLinkTokenRequestSnaptrade.md) |  | [optional] |
 
 ## Example
 
@@ -26,7 +27,8 @@ instance = FuseClient::CreateLinkTokenRequest.new(
   webhook_url: null,
   mx: null,
   plaid: null,
-  teller: null
+  teller: null,
+  snaptrade: null
 )
 ```
 

data/docs/CreateLinkTokenRequestSnaptrade.md

@@ -0,0 +1,18 @@
+# FuseClient::CreateLinkTokenRequestSnaptrade
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | [**CreateLinkTokenRequestSnaptradeConfig**](CreateLinkTokenRequestSnaptradeConfig.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::CreateLinkTokenRequestSnaptrade.new(
+  config: null
+)
+```
+

data/docs/CreateLinkTokenRequestSnaptradeConfig.md

@@ -0,0 +1,18 @@
+# FuseClient::CreateLinkTokenRequestSnaptradeConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_type** | **String** | SnapTrade connection type. Defaults to 'read' | [optional][default to 'read'] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::CreateLinkTokenRequestSnaptradeConfig.new(
+  connection_type: null
+)
+```
+

data/docs/{CreateSpendPowerResponse.md → DeleteConsumerRiskReportResponse.md}

@@ -1,10 +1,10 @@
-# FuseClient::CreateSpendPowerResponse
+# FuseClient::DeleteConsumerRiskReportResponse
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The id of the created spend power. |  |
+| **id** | **String** |  |  |
 | **request_id** | **String** | An identifier that is exclusive to the request and can serve as a means for investigating and resolving issues. |  |
 
 ## Example
@@ -12,7 +12,7 @@
 ```ruby
 require 'fuse_client'
 
-instance = FuseClient::CreateSpendPowerResponse.new(
+instance = FuseClient::DeleteConsumerRiskReportResponse.new(
   id: null,
   request_id: null
 )

data/docs/EnrichedTransaction.md

@@ -6,20 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | A original ID for the transaction that to help you tie data back to your systems. |  |
 | **merchant_id** | **String** | A Fuse defined, unique ID for the merchant associated with this transaction. | [optional] |
-| **name** | **String** | The original or enhanced name of the merchant. | [optional] |
+| **merchant_name** | **String** | The name of the merchant. | [optional] |
 | **logo** | [**MerchantLogo**](MerchantLogo.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] |
+| **categories** | **Array<String>** | Hierarchical transaction categories: Each element narrows down from parent to nested sub-categories. Example: ['personnel', 'employee', 'payroll']. | [optional] |
 
 ## Example
 
@@ -29,20 +18,9 @@ require 'fuse_client'
 instance = FuseClient::EnrichedTransaction.new(
   id: null,
   merchant_id: null,
-  name: null,
+  merchant_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
+  categories: null
 )
 ```
 

data/docs/EvalConsumerRiskReportRequest.md

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

data/docs/{EvalSpendPowerRequestEventsInner.md → EvalConsumerRiskReportRequestEventsInner.md}

@@ -1,4 +1,4 @@
-# FuseClient::EvalSpendPowerRequestEventsInner
+# FuseClient::EvalConsumerRiskReportRequestEventsInner
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'fuse_client'
 
-instance = FuseClient::EvalSpendPowerRequestEventsInner.new(
+instance = FuseClient::EvalConsumerRiskReportRequestEventsInner.new(
   account_id: null,
   event: null
 )

data/docs/{EvalSpendPowerResponse.md → EvalConsumerRiskReportResponse.md}

@@ -1,4 +1,4 @@
-# FuseClient::EvalSpendPowerResponse
+# FuseClient::EvalConsumerRiskReportResponse
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'fuse_client'
 
-instance = FuseClient::EvalSpendPowerResponse.new(
+instance = FuseClient::EvalConsumerRiskReportResponse.new(
   mean_granted_above_failed_payments: null,
   mean_granted_below_failed_payments: null,
   mean_predicted_limits: null,

data/docs/ExternalTransactionEvent.md

@@ -7,9 +7,12 @@
 | **id** | **String** | ID of the transaction |  |
 | **event_type** | **String** |  |  |
 | **status** | [**ExternalTransactionEventStatus**](ExternalTransactionEventStatus.md) |  |  |
-| **amount** | **Float** | Use positive values to represent money going out and negative to represent money going in. |  |
+| **amount** | **Float** | Amount in cents associated with the transaction. Use positive values to represent money going out and negative to represent money going in. |  |
+| **country_code** | **String** |  | [optional][default to 'US'] |
 | **iso_currency_code** | **String** | The ISO-4217 currency code. |  |
-| **transaction_type** | [**TransactionEventType**](TransactionEventType.md) |  |  |
+| **transaction_type** | [**TransactionEventType**](TransactionEventType.md) |  | [optional] |
+| **transaction_description** | **String** |  | [optional] |
+| **transaction_owner_type** | **String** |  | [optional][default to 'consumer'] |
 | **merchant_name** | **String** |  |  |
 | **timestamp** | **String** | Datetime of the transaction In ISO-8601 format |  |
 | **balance** | **Float** | The running balance of the account after the transaction has occurred, in cents | [optional] |
@@ -24,8 +27,11 @@ instance = FuseClient::ExternalTransactionEvent.new(
   event_type: null,
   status: null,
   amount: null,
+  country_code: null,
   iso_currency_code: null,
   transaction_type: null,
+  transaction_description: null,
+  transaction_owner_type: null,
   merchant_name: null,
   timestamp: null,
   balance: null

data/docs/FinancialConnectionDetails.md

@@ -17,6 +17,8 @@
 | **mono** | [**FinancialConnectionDetailsMono**](FinancialConnectionDetailsMono.md) |  | [optional] |
 | **truelayer** | [**FinancialConnectionDetailsTruelayer**](FinancialConnectionDetailsTruelayer.md) |  | [optional] |
 | **finverse** | [**FinancialConnectionDetailsFinverse**](FinancialConnectionDetailsFinverse.md) |  | [optional] |
+| **basiq** | [**FinancialConnectionDetailsBasiq**](FinancialConnectionDetailsBasiq.md) |  | [optional] |
+| **belvo** | [**FinancialConnectionDetailsBelvo**](FinancialConnectionDetailsBelvo.md) |  | [optional] |
 
 ## Example
 
@@ -36,7 +38,9 @@ instance = FuseClient::FinancialConnectionDetails.new(
   flinks: null,
   mono: null,
   truelayer: null,
-  finverse: null
+  finverse: null,
+  basiq: null,
+  belvo: null
 )
 ```
 

data/docs/FinancialConnectionDetailsBasiq.md

@@ -0,0 +1,20 @@
+# FuseClient::FinancialConnectionDetailsBasiq
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The identifier of the user for Basiq. |  |
+| **connection_id** | **String** | The identifier of the connection for Basiq. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::FinancialConnectionDetailsBasiq.new(
+  user_id: null,
+  connection_id: null
+)
+```
+

data/docs/FinancialConnectionDetailsBelvo.md

@@ -0,0 +1,20 @@
+# FuseClient::FinancialConnectionDetailsBelvo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **link_id** | **String** | The identifier of the link for Belvo. |  |
+| **institution** | **String** | The identifier of the institution for Belvo. | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::FinancialConnectionDetailsBelvo.new(
+  link_id: null,
+  institution: null
+)
+```
+

data/docs/FinancialConnectionsAccount.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **remote_id** | **String** | Remote Id of the account, ie Plaid or Teller account id |  |
+| **currency** | **String** | The ISO-4217 currency code of the account. |  |
 | **fingerprint** | **String** | Uniquely identifies this account across all accounts for a single financial connection. Used for reconnection deduplication. See more information here: https://letsfuse.readme.io/docs/duplicate-accounts |  |
 | **institution** | [**FinancialConnectionsAccountInstitution**](FinancialConnectionsAccountInstitution.md) |  | [optional] |
 | **mask** | **String** | The partial account number. | [optional] |
@@ -21,6 +22,7 @@ require 'fuse_client'
 
 instance = FuseClient::FinancialConnectionsAccount.new(
   remote_id: null,
+  currency: null,
   fingerprint: null,
   institution: null,
   mask: null,

data/docs/FinancialConnectionsAccountLiability.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **remote_id** | **String** | Remote Id of the account, ie Plaid or Teller account id |  |
+| **currency** | **String** | The ISO-4217 currency code of the account. |  |
 | **fingerprint** | **String** | Uniquely identifies this account across all accounts for a single financial connection. Used for reconnection deduplication. See more information here: https://letsfuse.readme.io/docs/duplicate-accounts |  |
 | **institution** | [**FinancialConnectionsAccountInstitution**](FinancialConnectionsAccountInstitution.md) |  | [optional] |
 | **mask** | **String** | The partial account number. | [optional] |
@@ -28,6 +29,7 @@ require 'fuse_client'
 
 instance = FuseClient::FinancialConnectionsAccountLiability.new(
   remote_id: null,
+  currency: null,
   fingerprint: null,
   institution: null,
   mask: null,

data/docs/FinancialConnectionsInvestmentSecurityExchange.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **mic_code** | **String** | The Market Identifier Code (MIC) associated with the specific financial market or exchange where the security is traded. | [optional] |
+| **suffix** | **String** | The suffix of the security's ticker symbol. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'fuse_client'
 
 instance = FuseClient::FinancialConnectionsInvestmentSecurityExchange.new(
-  mic_code: null
+  mic_code: null,
+  suffix: null
 )
 ```
 

data/docs/FinancialConnectionsOwnerAddressesInnerData.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **full_address** | **String** | Full address of the owner | [optional] |
 | **city** | **String** | City of the address | [optional] |
 | **country** | **String** | Country of the address | [optional] |
 | **postal_code** | **String** | Postal code of the address | [optional] |
@@ -16,6 +17,7 @@
 require 'fuse_client'
 
 instance = FuseClient::FinancialConnectionsOwnerAddressesInnerData.new(
+  full_address: null,
   city: null,
   country: null,
   postal_code: null,