fuse_client 1.0.38 → 1.0.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 351d5ff5a46eaedee35749af460dc341d897dc6a9bc42e00b66316d57df26a8a
-  data.tar.gz: 2e1b7c5b760b4adf13f5458a5c4ea04be6c90108be98f0d4501946ea29574c03
+  metadata.gz: 405c7dda28ecef0c84f7d5139e118bd251b7642653664706b522660e27cbd4c6
+  data.tar.gz: 804299b0297286305bd7f256061195cfc16c213dafdfc3fd90c76e9a46291d9f
 SHA512:
-  metadata.gz: 4dcae290bc05b205832431c53b1375c8be1cfea1e2a18eff5dd59bb5b5b7c8b2854076d87fababc6a97583d75739a4b44fec6033858f6b65917a0c103d10873a
-  data.tar.gz: d8926148e2f571491c9e8f4e79e1df937dabe48c56aea0a94803250e4c6bde81d2203c7abcef2317897ded6fec3cd0fb924b71f9c51737ffef5e2222de513afb
+  metadata.gz: 66c922e7fd3dd49b6ee4eeac05401839f9b0853ec1c375163be10273ecb915d3d4901c0cca7fe321190e9066fc2e531f27ee9716f88a07345f9dad877678d1e6
+  data.tar.gz: f5b4045c9b26bbbb761548fc9dc6a0c17bd89a4a14fac0088a8fde8ddce48db6d1af86635cad4719a20baa251dd7eed183a7fb6b53478da67ac941397601c57d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuse_client (1.0.38)
+    fuse_client (1.0.40)
       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/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/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

@@ -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/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

data/lib/fuse_client/models/create_link_token_request_snaptrade.rb

@@ -0,0 +1,220 @@
+=begin
+#Fuse
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FuseClient
+  # An object specifying information about the SnapTrade configuration to use when creating a link token. 
+  class CreateLinkTokenRequestSnaptrade
+    attr_accessor :config
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'config' => :'config'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'config' => :'CreateLinkTokenRequestSnaptradeConfig'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FuseClient::CreateLinkTokenRequestSnaptrade` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `FuseClient::CreateLinkTokenRequestSnaptrade`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'config')
+        self.config = attributes[:'config']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          config == o.config
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [config].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = FuseClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end