fuse_client 1.0.38 → 1.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 351d5ff5a46eaedee35749af460dc341d897dc6a9bc42e00b66316d57df26a8a
-  data.tar.gz: 2e1b7c5b760b4adf13f5458a5c4ea04be6c90108be98f0d4501946ea29574c03
+  metadata.gz: a492d2f9e47ad292cf3bf5b39bc639e8cd84e2b16e0ffcd1f1a18892f0fce774
+  data.tar.gz: 4f74fa2de057c81976c219b732b81f9d5794c021c9bf76967c070a4785f2f031
 SHA512:
-  metadata.gz: 4dcae290bc05b205832431c53b1375c8be1cfea1e2a18eff5dd59bb5b5b7c8b2854076d87fababc6a97583d75739a4b44fec6033858f6b65917a0c103d10873a
-  data.tar.gz: d8926148e2f571491c9e8f4e79e1df937dabe48c56aea0a94803250e4c6bde81d2203c7abcef2317897ded6fec3cd0fb924b71f9c51737ffef5e2222de513afb
+  metadata.gz: 8a9fc8c27c141c0afe852afa4c9e545af02a38ce80cae2fee56900024be6ab61dc7a85336dc9322257d9687a489ac81d30ce4f7974410c645a69c99f631f60f9
+  data.tar.gz: ad609b8f0b24793fe29c901d125f86d8eb9a97d8ef4b6be353c20cdec2bc473360333d2acc3fef9c3f3eedf4e16dd0f9681d09f379545e966f74a5f695644fad

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuse_client (1.0.38)
+    fuse_client (1.0.41)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -40,7 +40,7 @@ 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.1)

data/docs/CreateConsumerRiskReportRequest.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **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
@@ -16,6 +17,7 @@ require 'fuse_client'
 instance = FuseClient::CreateConsumerRiskReportRequest.new(
   account_id: null,
   iso_currency_code: null,
+  end_user_name: null,
   customization_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/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/ExchangeFinancialConnectionsPublicTokenResponse.md

@@ -6,6 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **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.  |  |
+| **institution** | [**FinancialInstitution**](FinancialInstitution.md) |  | [optional] |
+| **aggregator** | [**Aggregator**](Aggregator.md) |  |  |
 | **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 +18,8 @@ require 'fuse_client'
 instance = FuseClient::ExchangeFinancialConnectionsPublicTokenResponse.new(
   access_token: null,
   financial_connection_id: null,
+  institution: null,
+  aggregator: null,
   request_id: null
 )
 ```

data/docs/ExternalTransactionEvent.md

@@ -8,8 +8,11 @@
 | **event_type** | **String** |  |  |
 | **status** | [**ExternalTransactionEventStatus**](ExternalTransactionEventStatus.md) |  |  |
 | **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) |  | [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

@@ -19,6 +19,7 @@
 | **finverse** | [**FinancialConnectionDetailsFinverse**](FinancialConnectionDetailsFinverse.md) |  | [optional] |
 | **basiq** | [**FinancialConnectionDetailsBasiq**](FinancialConnectionDetailsBasiq.md) |  | [optional] |
 | **belvo** | [**FinancialConnectionDetailsBelvo**](FinancialConnectionDetailsBelvo.md) |  | [optional] |
+| **finicity** | [**FinancialConnectionDetailsFinicity**](FinancialConnectionDetailsFinicity.md) |  | [optional] |
 
 ## Example
 
@@ -40,7 +41,8 @@ instance = FuseClient::FinancialConnectionDetails.new(
   truelayer: null,
   finverse: null,
   basiq: null,
-  belvo: null
+  belvo: null,
+  finicity: null
 )
 ```
 

data/docs/FinancialConnectionDetailsFinicity.md

@@ -0,0 +1,20 @@
+# FuseClient::FinancialConnectionDetailsFinicity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | The identifier of the customer for Finicity. |  |
+| **institution_login_id** | **String** | The Finicity institution login id. |  |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::FinancialConnectionDetailsFinicity.new(
+  customer_id: null,
+  institution_login_id: 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/FuseApi.md

@@ -451,7 +451,7 @@ end
 
 api_instance = FuseClient::FuseApi.new
 opts = {
-  create_session_request: FuseClient::CreateSessionRequest.new({supported_financial_institution_aggregators: [FuseClient::Aggregator::PLAID], products: [FuseClient::Product::ACCOUNT_DETAILS], entity: FuseClient::Entity.new({id: 'id_example'})}) # CreateSessionRequest | 
+  create_session_request: FuseClient::CreateSessionRequest.new({supported_financial_institution_aggregators: [FuseClient::Aggregator::BASIQ], products: [FuseClient::Product::ACCOUNT_DETAILS], entity: FuseClient::Entity.new({id: 'id_example'})}) # CreateSessionRequest | 
 }
 
 begin
@@ -603,7 +603,7 @@ api_instance = FuseClient::FuseApi.new
 fuse_client_id = 'fuse_client_id_example' # String | 
 fuse_api_key = 'fuse_api_key_example' # String | 
 opts = {
-  enrich_transactions_request: FuseClient::EnrichTransactionsRequest.new({transactions: [FuseClient::TransactionToEnrich.new({id: 'id_example', merchant_name: 'merchant_name_example'})]}) # EnrichTransactionsRequest | 
+  enrich_transactions_request: FuseClient::EnrichTransactionsRequest.new({transactions: [FuseClient::TransactionToEnrich.new({id: 'id_example', description: 'description_example', amount: 3.56, direction: 'incoming'})]}) # EnrichTransactionsRequest | 
 }
 
 begin

data/docs/TransactionToEnrich.md

@@ -5,10 +5,14 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | A unique ID for the transaction that to help you tie data back to your systems. |  |
-| **merchant_name** | **String** | The name of the merchant. |  |
+| **description** | **String** | The name of the merchant if available or a description of the transaction. |  |
 | **mcc** | **String** | The merchant category code. | [optional] |
-| **amount** | **Float** | The amount of the transaction in cents, in the currency of the account.  | [optional] |
-| **type** | **String** | The type of the transaction | [optional] |
+| **amount** | **Float** | The amount of the transaction in cents, in the currency of the account. Must be a positive value. Use the type field to indicate the direction. |  |
+| **direction** | **String** | The direction of the transaction. |  |
+| **country_code** | **String** |  | [optional][default to 'US'] |
+| **iso_currency_code** | **String** |  | [optional][default to 'USD'] |
+| **date** | **String** | The date the transaction was posted. | [optional] |
+| **owner_type** | **String** |  | [optional][default to 'consumer'] |
 
 ## Example
 
@@ -17,10 +21,14 @@ require 'fuse_client'
 
 instance = FuseClient::TransactionToEnrich.new(
   id: null,
-  merchant_name: null,
+  description: null,
   mcc: null,
   amount: null,
-  type: null
+  direction: null,
+  country_code: null,
+  iso_currency_code: null,
+  date: null,
+  owner_type: null
 )
 ```
 

data/lib/fuse_client/configuration.rb

@@ -422,7 +422,11 @@ module FuseClient
       [
         {
           url: "https://sandbox-api.letsfuse.com",
-          description: "sandbox",
+          description: "Fuse sandbox API server",
+        },
+        {
+          url: "https://api.letsfuse.com",
+          description: "Fuse production API server",
         }
       ]
     end

data/lib/fuse_client/models/aggregator.rb

@@ -15,19 +15,20 @@ require 'time'
 
 module FuseClient
   class Aggregator
-    PLAID = "plaid".freeze
-    TELLER = "teller".freeze
-    MX = "mx".freeze
-    SNAPTRADE = "snaptrade".freeze
+    BASIQ = "basiq".freeze
+    BELVO = "belvo".freeze
+    FINICITY = "finicity".freeze
+    FINVERSE = "finverse".freeze
     FLINKS = "flinks".freeze
     MONO = "mono".freeze
+    MX = "mx".freeze
+    PLAID = "plaid".freeze
+    SNAPTRADE = "snaptrade".freeze
+    TELLER = "teller".freeze
     TRUELAYER = "truelayer".freeze
-    FINVERSE = "finverse".freeze
-    BASIQ = "basiq".freeze
-    BELVO = "belvo".freeze
 
     def self.all_vars
-      @all_vars ||= [PLAID, TELLER, MX, SNAPTRADE, FLINKS, MONO, TRUELAYER, FINVERSE, BASIQ, BELVO].freeze
+      @all_vars ||= [BASIQ, BELVO, FINICITY, FINVERSE, FLINKS, MONO, MX, PLAID, SNAPTRADE, TELLER, TRUELAYER].freeze
     end
 
     # Builds the enum from string

data/lib/fuse_client/models/create_consumer_risk_report_request.rb

@@ -21,6 +21,9 @@ module FuseClient
     # The ISO-4217 currency code of the transaction
     attr_accessor :iso_currency_code
 
+    # The name of the end user associated with this consumer risk report.
+    attr_accessor :end_user_name
+
     # This is used to determine the timeframe and other metadata for the consumer risk report.
     attr_accessor :customization_id
 
@@ -29,6 +32,7 @@ module FuseClient
       {
         :'account_id' => :'account_id',
         :'iso_currency_code' => :'iso_currency_code',
+        :'end_user_name' => :'end_user_name',
         :'customization_id' => :'customization_id'
       }
     end
@@ -43,6 +47,7 @@ module FuseClient
       {
         :'account_id' => :'String',
         :'iso_currency_code' => :'String',
+        :'end_user_name' => :'String',
         :'customization_id' => :'String'
       }
     end
@@ -76,6 +81,10 @@ module FuseClient
         self.iso_currency_code = attributes[:'iso_currency_code']
       end
 
+      if attributes.key?(:'end_user_name')
+        self.end_user_name = attributes[:'end_user_name']
+      end
+
       if attributes.key?(:'customization_id')
         self.customization_id = attributes[:'customization_id']
       end
@@ -116,6 +125,7 @@ module FuseClient
       self.class == o.class &&
           account_id == o.account_id &&
           iso_currency_code == o.iso_currency_code &&
+          end_user_name == o.end_user_name &&
           customization_id == o.customization_id
     end
 
@@ -128,7 +138,7 @@ module FuseClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, iso_currency_code, customization_id].hash
+      [account_id, iso_currency_code, end_user_name, customization_id].hash
     end
 
     # Builds the object from hash

data/lib/fuse_client/models/create_link_token_request.rb

@@ -35,6 +35,8 @@ module FuseClient
 
     attr_accessor :teller
 
+    attr_accessor :snaptrade
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -45,7 +47,8 @@ module FuseClient
         :'webhook_url' => :'webhook_url',
         :'mx' => :'mx',
         :'plaid' => :'plaid',
-        :'teller' => :'teller'
+        :'teller' => :'teller',
+        :'snaptrade' => :'snaptrade'
       }
     end
 
@@ -64,7 +67,8 @@ module FuseClient
         :'webhook_url' => :'String',
         :'mx' => :'CreateLinkTokenRequestMx',
         :'plaid' => :'CreateLinkTokenRequestPlaid',
-        :'teller' => :'CreateLinkTokenRequestTeller'
+        :'teller' => :'CreateLinkTokenRequestTeller',
+        :'snaptrade' => :'CreateLinkTokenRequestSnaptrade'
       }
     end
 
@@ -120,6 +124,10 @@ module FuseClient
       if attributes.key?(:'teller')
         self.teller = attributes[:'teller']
       end
+
+      if attributes.key?(:'snaptrade')
+        self.snaptrade = attributes[:'snaptrade']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -167,7 +175,8 @@ module FuseClient
           webhook_url == o.webhook_url &&
           mx == o.mx &&
           plaid == o.plaid &&
-          teller == o.teller
+          teller == o.teller &&
+          snaptrade == o.snaptrade
     end
 
     # @see the `==` method
@@ -179,7 +188,7 @@ module FuseClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [institution_id, entity, client_name, session_client_secret, webhook_url, mx, plaid, teller].hash
+      [institution_id, entity, client_name, session_client_secret, webhook_url, mx, plaid, teller, snaptrade].hash
     end
 
     # Builds the object from hash