fuse_client 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 628afaeb261c0f8ccd640b9db4ee825377761444dd444fb64d68846a4ab8ab7a
-  data.tar.gz: 37cb4afb9961af40906da1e336609ce9639f128a1983bd3bdaa4f5ea27e209a2
+  metadata.gz: 0dae65e9276d44e14f6989663bd0215a58d6b0fd3e912c5c26461b2e4aa5f21b
+  data.tar.gz: 32f2b4be1e2bf095eba7477ae3d392efd278671e39668762703df99a389054e2
 SHA512:
-  metadata.gz: 88d208df41f9955707ebe5d5b3face7a1397fa889cf6e504dec198d4b471d796ba41e3569255013d2bbf11ba80365f86f915f06f3439a559909c8084f7e7315d
-  data.tar.gz: e632699c37f9153ac118c4d0c9d95763e3dca283409500dae80ca9b671a2523ce2dafa6fbb2af04842da602fd70e7a63975023d22820bb67ecf64d8bc3fe73e5
+  metadata.gz: 13b2a77e95e647c30a0fb628c915b2253ee8e8a66e145c68487eff1b30f4c945ebb2d7087cacf2bac2157ea2cb1be02c3676853419c2f8d72c6b8c8fdbb67f97
+  data.tar.gz: df25b11a4dc47d17bd33f15e9e38e1e1a18a9fb3798d39df580bc5a14ae63649be55a7c99b7c773fb52f475e161d999fd75a937d1dab2caef7d1bf46ff4ab471

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuse_client (1.0.1)
+    fuse_client (1.0.3)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/docs/CreateLinkTokenRequest.md

@@ -4,12 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **institution_id** | **String** | An id that is unique for an institution. | [optional] |
-| **entity_id** | **String** | Unique identifier for the user or business account. |  |
-| **entity_name** | **String** | The name of the user or business account. | [optional] |
-| **entity_email** | **String** | Email address associated with the user or business account. | [optional] |
+| **institution_id** | **String** | An id that is unique for an institution. |  |
+| **entity** | [**Entity**](Entity.md) |  |  |
 | **reconnection_url** | **String** | This field is used to provide the user with a link to reconnect their financial account. It may be included in an automated email sent by Fuse to the entity's registered email address. It's important to note that the reconnection_url should be a valid URL and can only be used once to reconnect the disconnected account. | [optional] |
-| **client_name** | **String** | The name of your application. | [optional] |
+| **client_name** | **String** | The name of your application. |  |
 | **session_client_secret** | **String** | The session client secret created from the 'Create session client secret' endpoint |  |
 | **mx** | [**CreateLinkTokenRequestMx**](CreateLinkTokenRequestMx.md) |  | [optional] |
 | **plaid** | [**CreateLinkTokenRequestPlaid**](CreateLinkTokenRequestPlaid.md) |  | [optional] |
@@ -21,9 +19,7 @@ require 'fuse_client'
 
 instance = FuseClient::CreateLinkTokenRequest.new(
   institution_id: null,
-  entity_id: null,
-  entity_name: null,
-  entity_email: null,
+  entity: null,
   reconnection_url: null,
   client_name: null,
   session_client_secret: null,

data/docs/Entity.md

@@ -0,0 +1,22 @@
+# FuseClient::Entity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the user or business account. |  |
+| **name** | **String** | Name for the user or business account. | [optional] |
+| **email** | **String** | Email address associated with the user or business account. | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::Entity.new(
+  id: null,
+  name: null,
+  email: null
+)
+```
+

data/docs/FinancialInstitution.md

@@ -0,0 +1,24 @@
+# FuseClient::FinancialInstitution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the financial institution id. |  |
+| **name** | **String** | Name for the financial institution. |  |
+| **logo** | [**FinancialInstitutionLogo**](FinancialInstitutionLogo.md) |  | [optional] |
+| **website** | **String** | Website of the financial institution. | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::FinancialInstitution.new(
+  id: null,
+  name: null,
+  logo: null,
+  website: null
+)
+```
+

data/docs/FinancialInstitutionLogo.md

@@ -0,0 +1,22 @@
+# FuseClient::FinancialInstitutionLogo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image** | **String** | Base64-encoded image data or URL for the image. |  |
+| **type** | **String** | Type of the image. |  |
+| **format** | **String** | Optional format of the image, if known. | [optional] |
+
+## Example
+
+```ruby
+require 'fuse_client'
+
+instance = FuseClient::FinancialInstitutionLogo.new(
+  image: null,
+  type: null,
+  format: null
+)
+```
+

data/docs/FuseApi.md

@@ -16,6 +16,7 @@ All URIs are relative to *https://sandbox-api.letsfuse.com*
 | [**get_financial_connections_balances**](FuseApi.md#get_financial_connections_balances) | **POST** /v1/financial_connections/balances | Get balances |
 | [**get_financial_connections_owners**](FuseApi.md#get_financial_connections_owners) | **POST** /v1/financial_connections/owners | Get account owners |
 | [**get_financial_connections_transactions**](FuseApi.md#get_financial_connections_transactions) | **POST** /v1/financial_connections/transactions | Get transactions |
+| [**get_financial_institution**](FuseApi.md#get_financial_institution) | **GET** /v1/financial_connections/institutions/{institution_id} | Get a financial institution |
 | [**get_investment_holdings**](FuseApi.md#get_investment_holdings) | **POST** /v1/financial_connections/investments/holdings | Get investment holdings |
 | [**get_investment_transactions**](FuseApi.md#get_investment_transactions) | **POST** /v1/financial_connections/investments/transactions | Get investment transactions |
 | [**refresh_asset_report**](FuseApi.md#refresh_asset_report) | **POST** /v1/asset_report/refresh |  |
@@ -205,7 +206,7 @@ end
 
 api_instance = FuseClient::FuseApi.new
 opts = {
-  create_link_token_request: FuseClient::CreateLinkTokenRequest.new({entity_id: 'entity_id_example', session_client_secret: 'session_client_secret_example'}) # CreateLinkTokenRequest | 
+  create_link_token_request: FuseClient::CreateLinkTokenRequest.new({institution_id: 'institution_id_example', entity: FuseClient::Entity.new({id: 'id_example'}), client_name: 'client_name_example', session_client_secret: 'session_client_secret_example'}) # CreateLinkTokenRequest | 
 }
 
 begin
@@ -933,6 +934,82 @@ end
 - **Accept**: application/json
 
 
+## get_financial_institution
+
+> <FinancialInstitution> get_financial_institution(institution_id)
+
+Get a financial institution
+
+Receive metadata for a financial institution
+
+### Examples
+
+```ruby
+require 'time'
+require 'fuse_client'
+# setup authorization
+FuseClient.configure do |config|
+  # Configure API key authorization: fuseApiKey
+  config.api_key['fuseApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseApiKey'] = 'Bearer'
+
+  # Configure API key authorization: fuseClientId
+  config.api_key['fuseClientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['fuseClientId'] = 'Bearer'
+end
+
+api_instance = FuseClient::FuseApi.new
+institution_id = 'institution_id_example' # String | 
+
+begin
+  # Get a financial institution
+  result = api_instance.get_financial_institution(institution_id)
+  p result
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->get_financial_institution: #{e}"
+end
+```
+
+#### Using the get_financial_institution_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FinancialInstitution>, Integer, Hash)> get_financial_institution_with_http_info(institution_id)
+
+```ruby
+begin
+  # Get a financial institution
+  data, status_code, headers = api_instance.get_financial_institution_with_http_info(institution_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FinancialInstitution>
+rescue FuseClient::ApiError => e
+  puts "Error when calling FuseApi->get_financial_institution_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **institution_id** | **String** |  |  |
+
+### Return type
+
+[**FinancialInstitution**](FinancialInstitution.md)
+
+### Authorization
+
+[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_investment_holdings
 
 > <GetInvestmentHoldingsResponse> get_investment_holdings(get_investment_holdings_request)

data/lib/fuse_client/api/fuse_api.rb

@@ -786,6 +786,69 @@ module FuseClient
       return data, status_code, headers
     end
 
+    # Get a financial institution
+    # Receive metadata for a financial institution
+    # @param institution_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [FinancialInstitution]
+    def get_financial_institution(institution_id, opts = {})
+      data, _status_code, _headers = get_financial_institution_with_http_info(institution_id, opts)
+      data
+    end
+
+    # Get a financial institution
+    # Receive metadata for a financial institution
+    # @param institution_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FinancialInstitution, Integer, Hash)>] FinancialInstitution data, response status code and response headers
+    def get_financial_institution_with_http_info(institution_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FuseApi.get_financial_institution ...'
+      end
+      # verify the required parameter 'institution_id' is set
+      if @api_client.config.client_side_validation && institution_id.nil?
+        fail ArgumentError, "Missing the required parameter 'institution_id' when calling FuseApi.get_financial_institution"
+      end
+      # resource path
+      local_var_path = '/v1/financial_connections/institutions/{institution_id}'.sub('{' + 'institution_id' + '}', CGI.escape(institution_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FinancialInstitution'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['fuseApiKey', 'fuseClientId']
+
+      new_options = opts.merge(
+        :operation => :"FuseApi.get_financial_institution",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FuseApi#get_financial_institution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get investment holdings
     # @param get_investment_holdings_request [GetInvestmentHoldingsRequest] 
     # @param [Hash] opts the optional parameters

data/lib/fuse_client/models/create_link_token_request.rb

@@ -18,14 +18,7 @@ module FuseClient
     # An id that is unique for an institution.
     attr_accessor :institution_id
 
-    # Unique identifier for the user or business account.
-    attr_accessor :entity_id
-
-    # The name of the user or business account.
-    attr_accessor :entity_name
-
-    # Email address associated with the user or business account.
-    attr_accessor :entity_email
+    attr_accessor :entity
 
     # This field is used to provide the user with a link to reconnect their financial account. It may be included in an automated email sent by Fuse to the entity's registered email address. It's important to note that the reconnection_url should be a valid URL and can only be used once to reconnect the disconnected account.
     attr_accessor :reconnection_url
@@ -44,9 +37,7 @@ module FuseClient
     def self.attribute_map
       {
         :'institution_id' => :'institution_id',
-        :'entity_id' => :'entity_id',
-        :'entity_name' => :'entity_name',
-        :'entity_email' => :'entity_email',
+        :'entity' => :'entity',
         :'reconnection_url' => :'reconnection_url',
         :'client_name' => :'client_name',
         :'session_client_secret' => :'session_client_secret',
@@ -64,9 +55,7 @@ module FuseClient
     def self.openapi_types
       {
         :'institution_id' => :'String',
-        :'entity_id' => :'String',
-        :'entity_name' => :'String',
-        :'entity_email' => :'String',
+        :'entity' => :'Entity',
         :'reconnection_url' => :'String',
         :'client_name' => :'String',
         :'session_client_secret' => :'String',
@@ -100,16 +89,8 @@ module FuseClient
         self.institution_id = attributes[:'institution_id']
       end
 
-      if attributes.key?(:'entity_id')
-        self.entity_id = attributes[:'entity_id']
-      end
-
-      if attributes.key?(:'entity_name')
-        self.entity_name = attributes[:'entity_name']
-      end
-
-      if attributes.key?(:'entity_email')
-        self.entity_email = attributes[:'entity_email']
+      if attributes.key?(:'entity')
+        self.entity = attributes[:'entity']
       end
 
       if attributes.key?(:'reconnection_url')
@@ -137,8 +118,16 @@ module FuseClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @entity_id.nil?
-        invalid_properties.push('invalid value for "entity_id", entity_id cannot be nil.')
+      if @institution_id.nil?
+        invalid_properties.push('invalid value for "institution_id", institution_id cannot be nil.')
+      end
+
+      if @entity.nil?
+        invalid_properties.push('invalid value for "entity", entity cannot be nil.')
+      end
+
+      if @client_name.nil?
+        invalid_properties.push('invalid value for "client_name", client_name cannot be nil.')
       end
 
       if @session_client_secret.nil?
@@ -151,7 +140,9 @@ module FuseClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @entity_id.nil?
+      return false if @institution_id.nil?
+      return false if @entity.nil?
+      return false if @client_name.nil?
       return false if @session_client_secret.nil?
       true
     end
@@ -162,9 +153,7 @@ module FuseClient
       return true if self.equal?(o)
       self.class == o.class &&
           institution_id == o.institution_id &&
-          entity_id == o.entity_id &&
-          entity_name == o.entity_name &&
-          entity_email == o.entity_email &&
+          entity == o.entity &&
           reconnection_url == o.reconnection_url &&
           client_name == o.client_name &&
           session_client_secret == o.session_client_secret &&
@@ -181,7 +170,7 @@ module FuseClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [institution_id, entity_id, entity_name, entity_email, reconnection_url, client_name, session_client_secret, mx, plaid].hash
+      [institution_id, entity, reconnection_url, client_name, session_client_secret, mx, plaid].hash
     end
 
     # Builds the object from hash

data/lib/fuse_client/models/entity.rb

@@ -0,0 +1,245 @@
+=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.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FuseClient
+  class Entity
+    # Unique identifier for the user or business account.
+    attr_accessor :id
+
+    # Name for the user or business account.
+    attr_accessor :name
+
+    # Email address associated with the user or business account.
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'email' => :'email'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'email' => :'String'
+      }
+    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::Entity` 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::Entity`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      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
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      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?
+      return false if @id.nil?
+      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 &&
+          id == o.id &&
+          name == o.name &&
+          email == o.email
+    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
+      [id, name, email].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