fuse_client 1.0.33 → 1.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca72dbf2bc898395d54eb0df6c34a5db41fc38ecc106eecac08d0ef7d42ade4
-  data.tar.gz: bb5b81f8e7432c42db84d430cfb12db3655a6638a8ece572043da51eba8642b4
+  metadata.gz: '02886ed9535818b22f39447f40aae1f8ba44b781f434b682e1c438e084ac06d8'
+  data.tar.gz: 9f7a078ad93faaf0af259d32dce402ad0b82248d4b9f348fbc9261da97626e06
 SHA512:
-  metadata.gz: a7f647519d4602e1898d03234816b5885bde16355097c85ad31aa68a4f5adda45f5e139f026f6b3caa342f32cd831a447a1a8fda570addbd37326ab39c218133
-  data.tar.gz: 75b9bf702e2261e4e59e26f34e87a8d653e8eebe7121d3cea8a8e238cb50a37913051aa0a226af470b03a5d2304d1e64a43d27059e64c0f55e0b15654938a350
+  metadata.gz: cbc5cfad18c6a8fee2dec2c6cfea7c31c5d73d34538b22631aff3786e8ee38d68b4875ef01880074bd7e66478f9ccff3fbc45ccd11f0f50e0130f27f39caf315
+  data.tar.gz: b332f2afc3f34597f46b07d9146cfb1b20dea75b9ba731e9395155f7c3c3620f7062b6334a8f37508fe6639c8927a4bc5855e59546a374b9c4687d1ddc6fda30

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuse_client (1.0.33)
+    fuse_client (1.0.35)
       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.6)
     method_source (1.0.0)
     parallel (1.23.0)
     parser (3.2.2.1)
@@ -51,7 +51,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
-    stringio (3.0.6)
+    stringio (3.0.7)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     unicode-display_width (1.5.0)
@@ -67,4 +67,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.4.12
+   2.4.13

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,9 @@ class FuseService
 
 end
 ```
+
+### Pushing to gems
+```
+gem build fuse_client.gemspec
+gem push fuse_client-${VERSION}.gem
+```

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/CreateLinkTokenRequestTellerConfig.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **select_account** | **String** | The mode of account selection: - 'disabled': automatically connect all the supported financial accounts associated with this user's account at the institution (default). - 'single': the user will see a list of supported financial accounts and will need to select one to connect - 'multiple': the user will see a list of supported financial accounts and will need to select one or more to connect | [optional] |
+| **account_filter** | [**CreateLinkTokenRequestTellerConfigAccountFilter**](CreateLinkTokenRequestTellerConfigAccountFilter.md) |  | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'fuse_client'
 
 instance = FuseClient::CreateLinkTokenRequestTellerConfig.new(
-  select_account: null
+  select_account: null,
+  account_filter: null
 )
 ```
 

data/docs/CreateLinkTokenRequestTellerConfigAccountFilter.md

@@ -0,0 +1,20 @@
+# FuseClient::CreateLinkTokenRequestTellerConfigAccountFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **depository** | [**CreateLinkTokenRequestTellerConfigAccountFilterDepository**](CreateLinkTokenRequestTellerConfigAccountFilterDepository.md) |  | [optional] |
+| **credit** | [**CreateLinkTokenRequestTellerConfigAccountFilterCredit**](CreateLinkTokenRequestTellerConfigAccountFilterCredit.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::CreateLinkTokenRequestTellerConfigAccountFilter.new(
+  depository: null,
+  credit: null
+)
+```
+

data/docs/CreateLinkTokenRequestTellerConfigAccountFilterCredit.md

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

data/docs/CreateLinkTokenRequestTellerConfigAccountFilterCreditOneOf.md

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

data/docs/CreateLinkTokenRequestTellerConfigAccountFilterDepository.md

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

data/docs/CreateLinkTokenRequestTellerConfigAccountFilterDepositoryOneOf.md

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

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,24 @@
+# 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. |  |
+| **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
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::CreateSpendPowerCustomizationRequest.new(
+  timeframe: null,
+  min_limit: null,
+  max_limit: null,
+  risk_tolerance: 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,48 @@
+# 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. |  |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::EnrichedTransaction.new(
+  id: null,
+  merchant_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/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,24 @@
+# FuseClient::EvalSpendPowerResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mean_granted_above_failed_payments** | **Float** |  | [optional] |
+| **mean_granted_below_failed_payments** | **Float** |  | [optional] |
+| **mean_predicted_limits** | **Float** |  | [optional] |
+| **mean_successful_payments** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::EvalSpendPowerResponse.new(
+  mean_granted_above_failed_payments: null,
+  mean_granted_below_failed_payments: null,
+  mean_predicted_limits: null,
+  mean_successful_payments: null
+)
+```
+

data/docs/ExternalTransactionEvent.md

@@ -0,0 +1,34 @@
+# FuseClient::ExternalTransactionEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **iso_currency_code** | **String** | The ISO-4217 currency code. |  |
+| **transaction_type** | [**TransactionEventType**](TransactionEventType.md) |  |  |
+| **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] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::ExternalTransactionEvent.new(
+  id: null,
+  event_type: null,
+  status: null,
+  amount: null,
+  iso_currency_code: null,
+  transaction_type: null,
+  merchant_name: null,
+  timestamp: null,
+  balance: 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/FinQLComparisonFeature.md

@@ -0,0 +1,26 @@
+# FuseClient::FinQLComparisonFeature
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_a** | [**Merchant**](Merchant.md) |  | [optional] |
+| **merchant_b** | [**Merchant**](Merchant.md) |  | [optional] |
+| **comparison_metric** | **String** |  | [optional] |
+| **value_a** | **String** |  | [optional] |
+| **value_b** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::FinQLComparisonFeature.new(
+  merchant_a: null,
+  merchant_b: null,
+  comparison_metric: null,
+  value_a: null,
+  value_b: null
+)
+```
+