apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/account_assets.rb

@@ -0,0 +1,258 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AccountAssets Model.
+  class AccountAssets < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Plaid’s unique identifier for the account. This value will not change
+    # unless Plaid can't reconcile the account with the data returned by the
+    # financial institution. This may occur, for example, when the name of the
+    # account changes. If this happens a new `account_id` will be assigned to
+    # the account.
+    # The `account_id` can also change if the `access_token` is deleted and the
+    # same credentials that were used to generate that `access_token` are used
+    # to generate a new `access_token` on a later date. In that case, the new
+    # `account_id` will be different from the old `account_id`.
+    # If an account with a specific `account_id` disappears instead of changing,
+    # the account is likely closed. Closed accounts are not returned by the
+    # Plaid API.
+    # Like all Plaid identifiers, the `account_id` is case sensitive.
+    # @return [String]
+    attr_accessor :account_id
+
+    # A set of fields describing the balance for an account. Balance information
+    # may be cached unless the balance object was returned by
+    # `/accounts/balance/get`.
+    # @return [AccountBalance]
+    attr_accessor :balances
+
+    # The last 2-4 alphanumeric characters of an account's official account
+    # number. Note that the mask may be non-unique between an Item's accounts,
+    # and it may also not match the mask that the bank displays to the user.
+    # @return [String]
+    attr_accessor :mask
+
+    # The name of the account, either assigned by the user or by the financial
+    # institution itself
+    # @return [String]
+    attr_accessor :name
+
+    # The official name of the account as given by the financial institution
+    # @return [String]
+    attr_accessor :official_name
+
+    # `investment:` Investment account
+    # `credit:` Credit card
+    # `depository:` Depository account
+    # `loan:` Loan account
+    # `brokerage`: An investment account. Used for `/assets/` endpoints only;
+    # other endpoints use `investment`.
+    # `other:` Non-specified account type
+    # See the [Account type
+    # schema](https://plaid.com/docs/api/accounts#account-type-schema) for a
+    # full listing of account types and corresponding subtypes.
+    # @return [AccountType]
+    attr_accessor :type
+
+    # See the [Account type
+    # schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a
+    # full listing of account types and corresponding subtypes.
+    # @return [AccountSubtype]
+    attr_accessor :subtype
+
+    # The current verification status of an Auth Item initiated through
+    # Automated or Manual micro-deposits.  Returned for Auth Items only.
+    # `pending_automatic_verification`: The Item is pending automatic
+    # verification
+    # `pending_manual_verification`: The Item is pending manual micro-deposit
+    # verification. Items remain in this state until the user successfully
+    # verifies the two amounts.
+    # `automatically_verified`: The Item has successfully been automatically
+    # verified	
+    # `manually_verified`: The Item has successfully been manually verified
+    # `verification_expired`: Plaid was unable to automatically verify the
+    # deposit within 7 calendar days and will no longer attempt to validate the
+    # Item. Users may retry by submitting their information again through Link.
+    # `verification_failed`: The Item failed manual micro-deposit verification
+    # because the user exhausted all 3 verification attempts. Users may retry by
+    # submitting their information again through Link.
+    # @return [VerificationStatus4]
+    attr_accessor :verification_status
+
+    # The duration of transaction history available for this Item, typically
+    # defined as the time since the date of the earliest transaction in that
+    # account. Only returned by Assets endpoints.
+    # @return [Float]
+    attr_accessor :days_available
+
+    # Transaction history associated with the account. Only returned by Assets
+    # endpoints. Transaction history returned by endpoints such as
+    # `/transactions/get` or `/investments/transactions/get` will be returned in
+    # the top-level `transactions` field instead.
+    # @return [Array[AssetReportTransaction]]
+    attr_accessor :transactions
+
+    # Data returned by the financial institution about the account owner or
+    # owners. Only returned by Identity or Assets endpoints. Multiple owners on
+    # a single account will be represented in the same `owner` object, not in
+    # multiple owner objects within the array.
+    # @return [Array[Owner]]
+    attr_accessor :owners
+
+    # Calculated data about the historical balances on the account. Only
+    # returned by Assets endpoints.
+    # @return [Array[HistoricalBalance]]
+    attr_accessor :historical_balances
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account_id'
+      @_hash['balances'] = 'balances'
+      @_hash['mask'] = 'mask'
+      @_hash['name'] = 'name'
+      @_hash['official_name'] = 'official_name'
+      @_hash['type'] = 'type'
+      @_hash['subtype'] = 'subtype'
+      @_hash['verification_status'] = 'verification_status'
+      @_hash['days_available'] = 'days_available'
+      @_hash['transactions'] = 'transactions'
+      @_hash['owners'] = 'owners'
+      @_hash['historical_balances'] = 'historical_balances'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        verification_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mask
+        official_name
+      ]
+    end
+
+    def initialize(account_id:, balances:, mask:, name:, official_name:, type:,
+                   subtype:, days_available:, transactions:, owners:,
+                   historical_balances:, verification_status: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id
+      @balances = balances
+      @mask = mask
+      @name = name
+      @official_name = official_name
+      @type = type
+      @subtype = subtype
+      @verification_status = verification_status unless verification_status == SKIP
+      @days_available = days_available
+      @transactions = transactions
+      @owners = owners
+      @historical_balances = historical_balances
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      balances = AccountBalance.from_hash(hash['balances']) if hash['balances']
+      mask = hash.key?('mask') ? hash['mask'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      official_name = hash.key?('official_name') ? hash['official_name'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      subtype = hash.key?('subtype') ? hash['subtype'] : nil
+      days_available =
+        hash.key?('days_available') ? hash['days_available'] : nil
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (AssetReportTransaction.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = nil unless hash.key?('transactions')
+      # Parameter is an array, so we need to iterate through it
+      owners = nil
+      unless hash['owners'].nil?
+        owners = []
+        hash['owners'].each do |structure|
+          owners << (Owner.from_hash(structure) if structure)
+        end
+      end
+
+      owners = nil unless hash.key?('owners')
+      # Parameter is an array, so we need to iterate through it
+      historical_balances = nil
+      unless hash['historical_balances'].nil?
+        historical_balances = []
+        hash['historical_balances'].each do |structure|
+          historical_balances << (HistoricalBalance.from_hash(structure) if structure)
+        end
+      end
+
+      historical_balances = nil unless hash.key?('historical_balances')
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccountAssets.new(account_id: account_id,
+                        balances: balances,
+                        mask: mask,
+                        name: name,
+                        official_name: official_name,
+                        type: type,
+                        subtype: subtype,
+                        days_available: days_available,
+                        transactions: transactions,
+                        owners: owners,
+                        historical_balances: historical_balances,
+                        verification_status: verification_status,
+                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, balances: #{@balances}, mask: #{@mask}, name:"\
+      " #{@name}, official_name: #{@official_name}, type: #{@type}, subtype: #{@subtype},"\
+      " verification_status: #{@verification_status}, days_available: #{@days_available},"\
+      " transactions: #{@transactions}, owners: #{@owners}, historical_balances:"\
+      " #{@historical_balances}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, balances: #{@balances.inspect}, mask:"\
+      " #{@mask.inspect}, name: #{@name.inspect}, official_name: #{@official_name.inspect}, type:"\
+      " #{@type.inspect}, subtype: #{@subtype.inspect}, verification_status:"\
+      " #{@verification_status.inspect}, days_available: #{@days_available.inspect}, transactions:"\
+      " #{@transactions.inspect}, owners: #{@owners.inspect}, historical_balances:"\
+      " #{@historical_balances.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/account_balance.rb

@@ -0,0 +1,189 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # A set of fields describing the balance for an account. Balance information
+  # may be cached unless the balance object was returned by
+  # `/accounts/balance/get`.
+  class AccountBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The amount of funds available to be withdrawn from the account, as
+    # determined by the financial institution.
+    # For `credit`-type accounts, the `available` balance typically equals the
+    # `limit` less the `current` balance, less any pending outflows plus any
+    # pending inflows.
+    # For `depository`-type accounts, the `available` balance typically equals
+    # the `current` balance less any pending outflows plus any pending inflows.
+    # For `depository`-type accounts, the `available` balance does not include
+    # the overdraft limit.
+    # For `investment`-type accounts, the `available` balance is the total cash
+    # available to withdraw as presented by the institution.
+    # Note that not all institutions calculate the `available`  balance. In the
+    # event that `available` balance is unavailable, Plaid will return an
+    # `available` balance value of `null`.
+    # Available balance may be cached and is not guaranteed to be up-to-date in
+    # realtime unless the value was returned by `/accounts/balance/get`.
+    # If `current` is `null` this field is guaranteed not to be `null`.
+    # @return [Float]
+    attr_accessor :available
+
+    # The total amount of funds in or owed by the account.
+    # For `credit`-type accounts, a positive balance indicates the amount owed;
+    # a negative amount indicates the lender owing the account holder.
+    # For `loan`-type accounts, the current balance is the principal remaining
+    # on the loan, except in the case of student loan accounts at Sallie Mae
+    # (`ins_116944`). For Sallie Mae student loans, the account's balance
+    # includes both principal and any outstanding interest.
+    # For `investment`-type accounts, the current balance is the total value of
+    # assets as presented by the institution.
+    # Note that balance information may be cached unless the value was returned
+    # by `/accounts/balance/get`; if the Item is enabled for Transactions, the
+    # balance will be at least as recent as the most recent Transaction update.
+    # If you require realtime balance information, use the `available` balance
+    # as provided by `/accounts/balance/get`.
+    # When returned by `/accounts/balance/get`, this field may be `null`. When
+    # this happens, `available` is guaranteed not to be `null`.
+    # @return [Float]
+    attr_accessor :current
+
+    # For `credit`-type accounts, this represents the credit limit.
+    # For `depository`-type accounts, this represents the pre-arranged overdraft
+    # limit, which is common for current (checking) accounts in Europe.
+    # In North America, this field is typically only available for `credit`-type
+    # accounts.
+    # @return [Float]
+    attr_accessor :limit
+
+    # The ISO-4217 currency code of the balance. Always null if
+    # `unofficial_currency_code` is non-null.
+    # @return [String]
+    attr_accessor :iso_currency_code
+
+    # The unofficial currency code associated with the balance. Always null if
+    # `iso_currency_code` is non-null. Unofficial currency codes are used for
+    # currencies that do not have official ISO currency codes, such as
+    # cryptocurrencies and the currencies of certain countries.
+    # See the [currency code
+    # schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a
+    # full listing of supported `unofficial_currency_code`s.
+    # @return [String]
+    attr_accessor :unofficial_currency_code
+
+    # Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (`YYYY-MM-DDTHH:mm:ssZ`) indicating the last time that the balance for the
+    # given account has been updated
+    # This is currently only provided when the `min_last_updated_datetime` is
+    # passed when calling `/accounts/balance/get` for `ins_128026` (Capital
+    # One).
+    # @return [DateTime]
+    attr_accessor :last_updated_datetime
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['available'] = 'available'
+      @_hash['current'] = 'current'
+      @_hash['limit'] = 'limit'
+      @_hash['iso_currency_code'] = 'iso_currency_code'
+      @_hash['unofficial_currency_code'] = 'unofficial_currency_code'
+      @_hash['last_updated_datetime'] = 'last_updated_datetime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last_updated_datetime
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        available
+        current
+        limit
+        iso_currency_code
+        unofficial_currency_code
+        last_updated_datetime
+      ]
+    end
+
+    def initialize(available:, current:, limit:, iso_currency_code:,
+                   unofficial_currency_code:, last_updated_datetime: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @available = available
+      @current = current
+      @limit = limit
+      @iso_currency_code = iso_currency_code
+      @unofficial_currency_code = unofficial_currency_code
+      @last_updated_datetime = last_updated_datetime unless last_updated_datetime == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      available = hash.key?('available') ? hash['available'] : nil
+      current = hash.key?('current') ? hash['current'] : nil
+      limit = hash.key?('limit') ? hash['limit'] : nil
+      iso_currency_code =
+        hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
+      unofficial_currency_code =
+        hash.key?('unofficial_currency_code') ? hash['unofficial_currency_code'] : nil
+      last_updated_datetime = if hash.key?('last_updated_datetime')
+                                (DateTimeHelper.from_rfc3339(hash['last_updated_datetime']) if hash['last_updated_datetime'])
+                              else
+                                SKIP
+                              end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccountBalance.new(available: available,
+                         current: current,
+                         limit: limit,
+                         iso_currency_code: iso_currency_code,
+                         unofficial_currency_code: unofficial_currency_code,
+                         last_updated_datetime: last_updated_datetime,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_last_updated_datetime
+      DateTimeHelper.to_rfc3339(last_updated_datetime)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} available: #{@available}, current: #{@current}, limit: #{@limit},"\
+      " iso_currency_code: #{@iso_currency_code}, unofficial_currency_code:"\
+      " #{@unofficial_currency_code}, last_updated_datetime: #{@last_updated_datetime},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} available: #{@available.inspect}, current: #{@current.inspect}, limit:"\
+      " #{@limit.inspect}, iso_currency_code: #{@iso_currency_code.inspect},"\
+      " unofficial_currency_code: #{@unofficial_currency_code.inspect}, last_updated_datetime:"\
+      " #{@last_updated_datetime.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/account_filter.rb

@@ -0,0 +1,107 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Enumerates the account subtypes that the application wishes for the user to
+  # be able to select from. For more details refer to Plaid documentation on
+  # account filters.
+  class AccountFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of account subtypes to be filtered.
+    # @return [Array[String]]
+    attr_accessor :depository
+
+    # A list of account subtypes to be filtered.
+    # @return [Array[String]]
+    attr_accessor :credit
+
+    # A list of account subtypes to be filtered.
+    # @return [Array[String]]
+    attr_accessor :loan
+
+    # A list of account subtypes to be filtered.
+    # @return [Array[String]]
+    attr_accessor :investment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['depository'] = 'depository'
+      @_hash['credit'] = 'credit'
+      @_hash['loan'] = 'loan'
+      @_hash['investment'] = 'investment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        depository
+        credit
+        loan
+        investment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(depository: SKIP, credit: SKIP, loan: SKIP, investment: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @depository = depository unless depository == SKIP
+      @credit = credit unless credit == SKIP
+      @loan = loan unless loan == SKIP
+      @investment = investment unless investment == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      depository = hash.key?('depository') ? hash['depository'] : SKIP
+      credit = hash.key?('credit') ? hash['credit'] : SKIP
+      loan = hash.key?('loan') ? hash['loan'] : SKIP
+      investment = hash.key?('investment') ? hash['investment'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccountFilter.new(depository: depository,
+                        credit: credit,
+                        loan: loan,
+                        investment: investment,
+                        additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} depository: #{@depository}, credit: #{@credit}, loan: #{@loan}, investment:"\
+      " #{@investment}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} depository: #{@depository.inspect}, credit: #{@credit.inspect}, loan:"\
+      " #{@loan.inspect}, investment: #{@investment.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/account_filters_response.rb

@@ -0,0 +1,106 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The `account_filters` specified in the original call to
+  # `/link/token/create`.
+  class AccountFiltersResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A filter to apply to `depository`-type accounts
+    # @return [DepositoryFilter]
+    attr_accessor :depository
+
+    # A filter to apply to `credit`-type accounts
+    # @return [CreditFilter]
+    attr_accessor :credit
+
+    # A filter to apply to `loan`-type accounts
+    # @return [LoanFilter]
+    attr_accessor :loan
+
+    # A filter to apply to `investment`-type accounts
+    # @return [InvestmentFilter]
+    attr_accessor :investment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['depository'] = 'depository'
+      @_hash['credit'] = 'credit'
+      @_hash['loan'] = 'loan'
+      @_hash['investment'] = 'investment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        depository
+        credit
+        loan
+        investment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(depository: SKIP, credit: SKIP, loan: SKIP, investment: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @depository = depository unless depository == SKIP
+      @credit = credit unless credit == SKIP
+      @loan = loan unless loan == SKIP
+      @investment = investment unless investment == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      depository = DepositoryFilter.from_hash(hash['depository']) if hash['depository']
+      credit = CreditFilter.from_hash(hash['credit']) if hash['credit']
+      loan = LoanFilter.from_hash(hash['loan']) if hash['loan']
+      investment = InvestmentFilter.from_hash(hash['investment']) if hash['investment']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccountFiltersResponse.new(depository: depository,
+                                 credit: credit,
+                                 loan: loan,
+                                 investment: investment,
+                                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} depository: #{@depository}, credit: #{@credit}, loan: #{@loan}, investment:"\
+      " #{@investment}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} depository: #{@depository.inspect}, credit: #{@credit.inspect}, loan:"\
+      " #{@loan.inspect}, investment: #{@investment.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end