apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/type2.rb

@@ -0,0 +1,100 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The status type of the student loan
+  class Type2
+    TYPE2 = [
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for ENUM_CHARGED_OFF
+      ENUM_CHARGED_OFF = 'charged off'.freeze,
+
+      # TODO: Write general description for CLAIM
+      CLAIM = 'claim'.freeze,
+
+      # TODO: Write general description for CONSOLIDATED
+      CONSOLIDATED = 'consolidated'.freeze,
+
+      # TODO: Write general description for DEFERMENT
+      DEFERMENT = 'deferment'.freeze,
+
+      # TODO: Write general description for DELINQUENT
+      DELINQUENT = 'delinquent'.freeze,
+
+      # TODO: Write general description for DISCHARGED
+      DISCHARGED = 'discharged'.freeze,
+
+      # TODO: Write general description for EXTENSION
+      EXTENSION = 'extension'.freeze,
+
+      # TODO: Write general description for FORBEARANCE
+      FORBEARANCE = 'forbearance'.freeze,
+
+      # TODO: Write general description for ENUM_IN_GRACE
+      ENUM_IN_GRACE = 'in grace'.freeze,
+
+      # TODO: Write general description for ENUM_IN_MILITARY
+      ENUM_IN_MILITARY = 'in military'.freeze,
+
+      # TODO: Write general description for ENUM_IN_SCHOOL
+      ENUM_IN_SCHOOL = 'in school'.freeze,
+
+      # TODO: Write general description for ENUM_NOT_FULLY_DISBURSED
+      ENUM_NOT_FULLY_DISBURSED = 'not fully disbursed'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze,
+
+      # TODO: Write general description for ENUM_PAID_IN_FULL
+      ENUM_PAID_IN_FULL = 'paid in full'.freeze,
+
+      # TODO: Write general description for REFUNDED
+      REFUNDED = 'refunded'.freeze,
+
+      # TODO: Write general description for REPAYMENT
+      REPAYMENT = 'repayment'.freeze,
+
+      # TODO: Write general description for TRANSFERRED
+      TRANSFERRED = 'transferred'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CANCELLED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cancelled' then CANCELLED
+      when 'enum_charged_off' then ENUM_CHARGED_OFF
+      when 'claim' then CLAIM
+      when 'consolidated' then CONSOLIDATED
+      when 'deferment' then DEFERMENT
+      when 'delinquent' then DELINQUENT
+      when 'discharged' then DISCHARGED
+      when 'extension' then EXTENSION
+      when 'forbearance' then FORBEARANCE
+      when 'enum_in_grace' then ENUM_IN_GRACE
+      when 'enum_in_military' then ENUM_IN_MILITARY
+      when 'enum_in_school' then ENUM_IN_SCHOOL
+      when 'enum_not_fully_disbursed' then ENUM_NOT_FULLY_DISBURSED
+      when 'other' then OTHER
+      when 'enum_paid_in_full' then ENUM_PAID_IN_FULL
+      when 'refunded' then REFUNDED
+      when 'repayment' then REPAYMENT
+      when 'transferred' then TRANSFERRED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/type3.rb

@@ -0,0 +1,68 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The type of the repayment plan.
+  class Type3
+    TYPE3 = [
+      # TODO: Write general description for ENUM_EXTENDED_GRADUATED
+      ENUM_EXTENDED_GRADUATED = 'extended graduated'.freeze,
+
+      # TODO: Write general description for ENUM_EXTENDED_STANDARD
+      ENUM_EXTENDED_STANDARD = 'extended standard'.freeze,
+
+      # TODO: Write general description for GRADUATED
+      GRADUATED = 'graduated'.freeze,
+
+      # TODO: Write general description for ENUM_INCOMECONTINGENT_REPAYMENT
+      ENUM_INCOMECONTINGENT_REPAYMENT = 'income-contingent repayment'.freeze,
+
+      # TODO: Write general description for ENUM_INCOMEBASED_REPAYMENT
+      ENUM_INCOMEBASED_REPAYMENT = 'income-based repayment'.freeze,
+
+      # TODO: Write general description for INTERESTONLY
+      INTERESTONLY = 'interest-only'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze,
+
+      # TODO: Write general description for ENUM_PAY_AS_YOU_EARN
+      ENUM_PAY_AS_YOU_EARN = 'pay as you earn'.freeze,
+
+      # TODO: Write general description for ENUM_REVISED_PAY_AS_YOU_EARN
+      ENUM_REVISED_PAY_AS_YOU_EARN = 'revised pay as you earn'.freeze,
+
+      # TODO: Write general description for STANDARD
+      STANDARD = 'standard'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENUM_EXTENDED_GRADUATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_extended_graduated' then ENUM_EXTENDED_GRADUATED
+      when 'enum_extended_standard' then ENUM_EXTENDED_STANDARD
+      when 'graduated' then GRADUATED
+      when 'enum_incomecontingent_repayment' then ENUM_INCOMECONTINGENT_REPAYMENT
+      when 'enum_incomebased_repayment' then ENUM_INCOMEBASED_REPAYMENT
+      when 'interestonly' then INTERESTONLY
+      when 'other' then OTHER
+      when 'enum_pay_as_you_earn' then ENUM_PAY_AS_YOU_EARN
+      when 'enum_revised_pay_as_you_earn' then ENUM_REVISED_PAY_AS_YOU_EARN
+      when 'standard' then STANDARD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/type4.rb

@@ -0,0 +1,60 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Value is one of the following: `buy`: Buying an investment `sell`: Selling
+  # an investment `cancel`: A cancellation of a pending transaction `cash`:
+  # Activity that modifies a cash position `fee`: A fee on the account
+  # `transfer`: Activity which modifies a position, but not through buy/sell
+  # activity e.g. options exercise, portfolio transfer For descriptions of
+  # possible transaction types and subtypes, see the [Investment transaction
+  # types
+  # schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-sc
+  # hema).
+  class Type4
+    TYPE4 = [
+      # TODO: Write general description for BUY
+      BUY = 'buy'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'sell'.freeze,
+
+      # TODO: Write general description for CANCEL
+      CANCEL = 'cancel'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze,
+
+      # TODO: Write general description for FEE
+      FEE = 'fee'.freeze,
+
+      # TODO: Write general description for TRANSFER
+      TRANSFER = 'transfer'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BUY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'buy' then BUY
+      when 'sell' then SELL
+      when 'cancel' then CANCEL
+      when 'cash' then CASH
+      when 'fee' then FEE
+      when 'transfer' then TRANSFER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/type5.rb

@@ -0,0 +1,41 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The type of income. Possible values include:   `"regular"`: regular income
+  # `"overtime"`: overtime income   `"bonus"`: bonus income
+  class Type5
+    TYPE5 = [
+      # TODO: Write general description for BONUS
+      BONUS = 'bonus'.freeze,
+
+      # TODO: Write general description for OVERTIME
+      OVERTIME = 'overtime'.freeze,
+
+      # TODO: Write general description for REGULAR
+      REGULAR = 'regular'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BONUS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bonus' then BONUS
+      when 'overtime' then OVERTIME
+      when 'regular' then REGULAR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/unofficial_currency_code_list.rb

@@ -0,0 +1,252 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # List of unofficial currency codes
+  class UnofficialCurrencyCodeList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Cardano
+    # @return [String]
+    attr_accessor :ada
+
+    # Basic Attention Token
+    # @return [String]
+    attr_accessor :bat
+
+    # Bitcoin Cash
+    # @return [String]
+    attr_accessor :bch
+
+    # Binance Coin
+    # @return [String]
+    attr_accessor :bnb
+
+    # Bitcoin
+    # @return [String]
+    attr_accessor :btc
+
+    # Bitcoin Gold
+    # @return [String]
+    attr_accessor :btg
+
+    # Chinese Yuan (offshore)
+    # @return [String]
+    attr_accessor :cnh
+
+    # Dash
+    # @return [String]
+    attr_accessor :dash
+
+    # Dogecoin
+    # @return [String]
+    attr_accessor :doge
+
+    # Ethereum Classic
+    # @return [String]
+    attr_accessor :etc
+
+    # Ethereum
+    # @return [String]
+    attr_accessor :eth
+
+    # Pence sterling, i.e. British penny
+    # @return [String]
+    attr_accessor :gbx
+
+    # Lisk
+    # @return [String]
+    attr_accessor :lsk
+
+    # Neo
+    # @return [String]
+    attr_accessor :neo
+
+    # OmiseGO
+    # @return [String]
+    attr_accessor :omg
+
+    # Qtum
+    # @return [String]
+    attr_accessor :qtum
+
+    # TehterUS
+    # @return [String]
+    attr_accessor :usdt
+
+    # Stellar Lumen
+    # @return [String]
+    attr_accessor :xlm
+
+    # Monero
+    # @return [String]
+    attr_accessor :xmr
+
+    # Ripple
+    # @return [String]
+    attr_accessor :xrp
+
+    # Zcash
+    # @return [String]
+    attr_accessor :zec
+
+    # 0x
+    # @return [String]
+    attr_accessor :zrx
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ada'] = 'ADA'
+      @_hash['bat'] = 'BAT'
+      @_hash['bch'] = 'BCH'
+      @_hash['bnb'] = 'BNB'
+      @_hash['btc'] = 'BTC'
+      @_hash['btg'] = 'BTG'
+      @_hash['cnh'] = 'CNH'
+      @_hash['dash'] = 'DASH'
+      @_hash['doge'] = 'DOGE'
+      @_hash['etc'] = 'ETC'
+      @_hash['eth'] = 'ETH'
+      @_hash['gbx'] = 'GBX'
+      @_hash['lsk'] = 'LSK'
+      @_hash['neo'] = 'NEO'
+      @_hash['omg'] = 'OMG'
+      @_hash['qtum'] = 'QTUM'
+      @_hash['usdt'] = 'USDT'
+      @_hash['xlm'] = 'XLM'
+      @_hash['xmr'] = 'XMR'
+      @_hash['xrp'] = 'XRP'
+      @_hash['zec'] = 'ZEC'
+      @_hash['zrx'] = 'ZRX'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ada:, bat:, bch:, bnb:, btc:, btg:, cnh:, dash:, doge:, etc:,
+                   eth:, gbx:, lsk:, neo:, omg:, qtum:, usdt:, xlm:, xmr:, xrp:,
+                   zec:, zrx:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ada = ada
+      @bat = bat
+      @bch = bch
+      @bnb = bnb
+      @btc = btc
+      @btg = btg
+      @cnh = cnh
+      @dash = dash
+      @doge = doge
+      @etc = etc
+      @eth = eth
+      @gbx = gbx
+      @lsk = lsk
+      @neo = neo
+      @omg = omg
+      @qtum = qtum
+      @usdt = usdt
+      @xlm = xlm
+      @xmr = xmr
+      @xrp = xrp
+      @zec = zec
+      @zrx = zrx
+      @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.
+      ada = hash.key?('ADA') ? hash['ADA'] : nil
+      bat = hash.key?('BAT') ? hash['BAT'] : nil
+      bch = hash.key?('BCH') ? hash['BCH'] : nil
+      bnb = hash.key?('BNB') ? hash['BNB'] : nil
+      btc = hash.key?('BTC') ? hash['BTC'] : nil
+      btg = hash.key?('BTG') ? hash['BTG'] : nil
+      cnh = hash.key?('CNH') ? hash['CNH'] : nil
+      dash = hash.key?('DASH') ? hash['DASH'] : nil
+      doge = hash.key?('DOGE') ? hash['DOGE'] : nil
+      etc = hash.key?('ETC') ? hash['ETC'] : nil
+      eth = hash.key?('ETH') ? hash['ETH'] : nil
+      gbx = hash.key?('GBX') ? hash['GBX'] : nil
+      lsk = hash.key?('LSK') ? hash['LSK'] : nil
+      neo = hash.key?('NEO') ? hash['NEO'] : nil
+      omg = hash.key?('OMG') ? hash['OMG'] : nil
+      qtum = hash.key?('QTUM') ? hash['QTUM'] : nil
+      usdt = hash.key?('USDT') ? hash['USDT'] : nil
+      xlm = hash.key?('XLM') ? hash['XLM'] : nil
+      xmr = hash.key?('XMR') ? hash['XMR'] : nil
+      xrp = hash.key?('XRP') ? hash['XRP'] : nil
+      zec = hash.key?('ZEC') ? hash['ZEC'] : nil
+      zrx = hash.key?('ZRX') ? hash['ZRX'] : nil
+
+      # 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.
+      UnofficialCurrencyCodeList.new(ada: ada,
+                                     bat: bat,
+                                     bch: bch,
+                                     bnb: bnb,
+                                     btc: btc,
+                                     btg: btg,
+                                     cnh: cnh,
+                                     dash: dash,
+                                     doge: doge,
+                                     etc: etc,
+                                     eth: eth,
+                                     gbx: gbx,
+                                     lsk: lsk,
+                                     neo: neo,
+                                     omg: omg,
+                                     qtum: qtum,
+                                     usdt: usdt,
+                                     xlm: xlm,
+                                     xmr: xmr,
+                                     xrp: xrp,
+                                     zec: zec,
+                                     zrx: zrx,
+                                     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} ada: #{@ada}, bat: #{@bat}, bch: #{@bch}, bnb: #{@bnb}, btc: #{@btc}, btg:"\
+      " #{@btg}, cnh: #{@cnh}, dash: #{@dash}, doge: #{@doge}, etc: #{@etc}, eth: #{@eth}, gbx:"\
+      " #{@gbx}, lsk: #{@lsk}, neo: #{@neo}, omg: #{@omg}, qtum: #{@qtum}, usdt: #{@usdt}, xlm:"\
+      " #{@xlm}, xmr: #{@xmr}, xrp: #{@xrp}, zec: #{@zec}, zrx: #{@zrx}, 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} ada: #{@ada.inspect}, bat: #{@bat.inspect}, bch: #{@bch.inspect}, bnb:"\
+      " #{@bnb.inspect}, btc: #{@btc.inspect}, btg: #{@btg.inspect}, cnh: #{@cnh.inspect}, dash:"\
+      " #{@dash.inspect}, doge: #{@doge.inspect}, etc: #{@etc.inspect}, eth: #{@eth.inspect}, gbx:"\
+      " #{@gbx.inspect}, lsk: #{@lsk.inspect}, neo: #{@neo.inspect}, omg: #{@omg.inspect}, qtum:"\
+      " #{@qtum.inspect}, usdt: #{@usdt.inspect}, xlm: #{@xlm.inspect}, xmr: #{@xmr.inspect}, xrp:"\
+      " #{@xrp.inspect}, zec: #{@zec.inspect}, zrx: #{@zrx.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/update_type.rb

@@ -0,0 +1,39 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Indicates whether an Item requires user interaction to be updated, which can
+  # be the case for Items with some forms of two-factor authentication.
+  # `background` - Item can be updated in the background `user_present_required`
+  # - Item requires user interaction to be updated
+  class UpdateType
+    UPDATE_TYPE = [
+      # TODO: Write general description for BACKGROUND
+      BACKGROUND = 'background'.freeze,
+
+      # TODO: Write general description for USER_PRESENT_REQUIRED
+      USER_PRESENT_REQUIRED = 'user_present_required'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BACKGROUND)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'background' then BACKGROUND
+      when 'user_present_required' then USER_PRESENT_REQUIRED
+      else
+        default_value
+      end
+    end
+  end
+end