apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/student_loan_status.rb

@@ -0,0 +1,86 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing the status of the student loan
+  class StudentLoanStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date until which the loan will be in its current status. Dates are
+    # returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The status type of the student loan
+    # @return [Type2]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['end_date'] = 'end_date'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+      ]
+    end
+
+    def initialize(end_date:, type:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @end_date = end_date
+      @type = type
+      @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.
+      end_date = hash.key?('end_date') ? hash['end_date'] : nil
+      type = hash.key?('type') ? hash['type'] : 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.
+      StudentLoanStatus.new(end_date: end_date,
+                            type: type,
+                            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} end_date: #{@end_date}, type: #{@type}, 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} end_date: #{@end_date.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/student_repayment_plan.rb

@@ -0,0 +1,84 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing the repayment plan for the student loan
+  class StudentRepaymentPlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description of the repayment plan as provided by the servicer.
+    # @return [String]
+    attr_accessor :description
+
+    # The type of the repayment plan.
+    # @return [Type3]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(description:, type:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @description = description
+      @type = type
+      @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.
+      description = hash.key?('description') ? hash['description'] : nil
+      type = hash.key?('type') ? hash['type'] : 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.
+      StudentRepaymentPlan.new(description: description,
+                               type: type,
+                               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} description: #{@description}, type: #{@type}, 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} description: #{@description.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/subtype.rb

@@ -0,0 +1,209 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # 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 Subtype
+    SUBTYPE = [
+      # TODO: Write general description for ENUM_ACCOUNT_FEE
+      ENUM_ACCOUNT_FEE = 'account fee'.freeze,
+
+      # TODO: Write general description for ASSIGNMENT
+      ASSIGNMENT = 'assignment'.freeze,
+
+      # TODO: Write general description for BUY
+      BUY = 'buy'.freeze,
+
+      # TODO: Write general description for ENUM_BUY_TO_COVER
+      ENUM_BUY_TO_COVER = 'buy to cover'.freeze,
+
+      # TODO: Write general description for CONTRIBUTION
+      CONTRIBUTION = 'contribution'.freeze,
+
+      # TODO: Write general description for DEPOSIT
+      DEPOSIT = 'deposit'.freeze,
+
+      # TODO: Write general description for DISTRIBUTION
+      DISTRIBUTION = 'distribution'.freeze,
+
+      # TODO: Write general description for DIVIDEND
+      DIVIDEND = 'dividend'.freeze,
+
+      # TODO: Write general description for ENUM_DIVIDEND_REINVESTMENT
+      ENUM_DIVIDEND_REINVESTMENT = 'dividend reinvestment'.freeze,
+
+      # TODO: Write general description for EXERCISE
+      EXERCISE = 'exercise'.freeze,
+
+      # TODO: Write general description for EXPIRE
+      EXPIRE = 'expire'.freeze,
+
+      # TODO: Write general description for ENUM_FUND_FEE
+      ENUM_FUND_FEE = 'fund fee'.freeze,
+
+      # TODO: Write general description for INTEREST
+      INTEREST = 'interest'.freeze,
+
+      # TODO: Write general description for ENUM_INTEREST_RECEIVABLE
+      ENUM_INTEREST_RECEIVABLE = 'interest receivable'.freeze,
+
+      # TODO: Write general description for ENUM_INTEREST_REINVESTMENT
+      ENUM_INTEREST_REINVESTMENT = 'interest reinvestment'.freeze,
+
+      # TODO: Write general description for ENUM_LEGAL_FEE
+      ENUM_LEGAL_FEE = 'legal fee'.freeze,
+
+      # TODO: Write general description for ENUM_LOAN_PAYMENT
+      ENUM_LOAN_PAYMENT = 'loan payment'.freeze,
+
+      # TODO: Write general description for ENUM_LONGTERM_CAPITAL_GAIN
+      ENUM_LONGTERM_CAPITAL_GAIN = 'long-term capital gain'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_LONGTERM_CAPITAL_GAIN_REINVESTMENT
+      ENUM_LONGTERM_CAPITAL_GAIN_REINVESTMENT = 'long-term capital gain reinvestment'.freeze,
+
+      # TODO: Write general description for ENUM_MANAGEMENT_FEE
+      ENUM_MANAGEMENT_FEE = 'management fee'.freeze,
+
+      # TODO: Write general description for ENUM_MARGIN_EXPENSE
+      ENUM_MARGIN_EXPENSE = 'margin expense'.freeze,
+
+      # TODO: Write general description for MERGER
+      MERGER = 'merger'.freeze,
+
+      # TODO: Write general description for ENUM_MISCELLANEOUS_FEE
+      ENUM_MISCELLANEOUS_FEE = 'miscellaneous fee'.freeze,
+
+      # TODO: Write general description for ENUM_NONQUALIFIED_DIVIDEND
+      ENUM_NONQUALIFIED_DIVIDEND = 'non-qualified dividend'.freeze,
+
+      # TODO: Write general description for ENUM_NONRESIDENT_TAX
+      ENUM_NONRESIDENT_TAX = 'non-resident tax'.freeze,
+
+      # TODO: Write general description for ENUM_PENDING_CREDIT
+      ENUM_PENDING_CREDIT = 'pending credit'.freeze,
+
+      # TODO: Write general description for ENUM_PENDING_DEBIT
+      ENUM_PENDING_DEBIT = 'pending debit'.freeze,
+
+      # TODO: Write general description for ENUM_QUALIFIED_DIVIDEND
+      ENUM_QUALIFIED_DIVIDEND = 'qualified dividend'.freeze,
+
+      # TODO: Write general description for REBALANCE
+      REBALANCE = 'rebalance'.freeze,
+
+      # TODO: Write general description for ENUM_RETURN_OF_PRINCIPAL
+      ENUM_RETURN_OF_PRINCIPAL = 'return of principal'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'sell'.freeze,
+
+      # TODO: Write general description for ENUM_SELL_SHORT
+      ENUM_SELL_SHORT = 'sell short'.freeze,
+
+      # TODO: Write general description for ENUM_SHORTTERM_CAPITAL_GAIN
+      ENUM_SHORTTERM_CAPITAL_GAIN = 'short-term capital gain'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_SHORTTERM_CAPITAL_GAIN_REINVESTMENT
+      ENUM_SHORTTERM_CAPITAL_GAIN_REINVESTMENT = 'short-term capital gain reinvestment'.freeze,
+
+      # TODO: Write general description for ENUM_SPIN_OFF
+      ENUM_SPIN_OFF = 'spin off'.freeze,
+
+      # TODO: Write general description for SPLIT
+      SPLIT = 'split'.freeze,
+
+      # TODO: Write general description for ENUM_STOCK_DISTRIBUTION
+      ENUM_STOCK_DISTRIBUTION = 'stock distribution'.freeze,
+
+      # TODO: Write general description for TAX
+      TAX = 'tax'.freeze,
+
+      # TODO: Write general description for ENUM_TAX_WITHHELD
+      ENUM_TAX_WITHHELD = 'tax withheld'.freeze,
+
+      # TODO: Write general description for TRANSFER
+      TRANSFER = 'transfer'.freeze,
+
+      # TODO: Write general description for ENUM_TRANSFER_FEE
+      ENUM_TRANSFER_FEE = 'transfer fee'.freeze,
+
+      # TODO: Write general description for ENUM_TRUST_FEE
+      ENUM_TRUST_FEE = 'trust fee'.freeze,
+
+      # TODO: Write general description for ENUM_UNQUALIFIED_GAIN
+      ENUM_UNQUALIFIED_GAIN = 'unqualified gain'.freeze,
+
+      # TODO: Write general description for WITHDRAWAL
+      WITHDRAWAL = 'withdrawal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENUM_ACCOUNT_FEE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_account_fee' then ENUM_ACCOUNT_FEE
+      when 'assignment' then ASSIGNMENT
+      when 'buy' then BUY
+      when 'enum_buy_to_cover' then ENUM_BUY_TO_COVER
+      when 'contribution' then CONTRIBUTION
+      when 'deposit' then DEPOSIT
+      when 'distribution' then DISTRIBUTION
+      when 'dividend' then DIVIDEND
+      when 'enum_dividend_reinvestment' then ENUM_DIVIDEND_REINVESTMENT
+      when 'exercise' then EXERCISE
+      when 'expire' then EXPIRE
+      when 'enum_fund_fee' then ENUM_FUND_FEE
+      when 'interest' then INTEREST
+      when 'enum_interest_receivable' then ENUM_INTEREST_RECEIVABLE
+      when 'enum_interest_reinvestment' then ENUM_INTEREST_REINVESTMENT
+      when 'enum_legal_fee' then ENUM_LEGAL_FEE
+      when 'enum_loan_payment' then ENUM_LOAN_PAYMENT
+      when 'enum_longterm_capital_gain' then ENUM_LONGTERM_CAPITAL_GAIN
+      when 'enum_longterm_capital_gain_reinvestment' then ENUM_LONGTERM_CAPITAL_GAIN_REINVESTMENT
+      when 'enum_management_fee' then ENUM_MANAGEMENT_FEE
+      when 'enum_margin_expense' then ENUM_MARGIN_EXPENSE
+      when 'merger' then MERGER
+      when 'enum_miscellaneous_fee' then ENUM_MISCELLANEOUS_FEE
+      when 'enum_nonqualified_dividend' then ENUM_NONQUALIFIED_DIVIDEND
+      when 'enum_nonresident_tax' then ENUM_NONRESIDENT_TAX
+      when 'enum_pending_credit' then ENUM_PENDING_CREDIT
+      when 'enum_pending_debit' then ENUM_PENDING_DEBIT
+      when 'enum_qualified_dividend' then ENUM_QUALIFIED_DIVIDEND
+      when 'rebalance' then REBALANCE
+      when 'enum_return_of_principal' then ENUM_RETURN_OF_PRINCIPAL
+      when 'sell' then SELL
+      when 'enum_sell_short' then ENUM_SELL_SHORT
+      when 'enum_shortterm_capital_gain' then ENUM_SHORTTERM_CAPITAL_GAIN
+      when 'enum_shortterm_capital_gain_reinvestment' then ENUM_SHORTTERM_CAPITAL_GAIN_REINVESTMENT
+      when 'enum_spin_off' then ENUM_SPIN_OFF
+      when 'split' then SPLIT
+      when 'enum_stock_distribution' then ENUM_STOCK_DISTRIBUTION
+      when 'tax' then TAX
+      when 'enum_tax_withheld' then ENUM_TAX_WITHHELD
+      when 'transfer' then TRANSFER
+      when 'enum_transfer_fee' then ENUM_TRANSFER_FEE
+      when 'enum_trust_fee' then ENUM_TRUST_FEE
+      when 'enum_unqualified_gain' then ENUM_UNQUALIFIED_GAIN
+      when 'withdrawal' then WITHDRAWAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/switch_method.rb

@@ -0,0 +1,45 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The method used to make the deposit switch. - `instant` – User instantly
+  # switched their direct deposit to a new or existing bank account by
+  # connecting their payroll or employer account. - `mail` – User requested that
+  # Plaid contact their employer by mail to make the direct deposit switch. -
+  # `pdf` – User generated a PDF or email to be sent to their employer with the
+  # information necessary to make the deposit switch.'
+  class SwitchMethod
+    SWITCH_METHOD = [
+      # TODO: Write general description for INSTANT
+      INSTANT = 'instant'.freeze,
+
+      # TODO: Write general description for MAIL
+      MAIL = 'mail'.freeze,
+
+      # TODO: Write general description for PDF
+      PDF = 'pdf'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = INSTANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'instant' then INSTANT
+      when 'mail' then MAIL
+      when 'pdf' then PDF
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/taxform.rb

@@ -0,0 +1,84 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Taxform Model.
+  class Taxform < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of tax document.
+    # @return [String]
+    attr_accessor :document_type
+
+    # W2 is an object that represents income data taken from a W2 tax document.
+    # @return [W2]
+    attr_accessor :w2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['document_type'] = 'document_type'
+      @_hash['w2'] = 'w2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        w2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(document_type:, w2: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @document_type = document_type
+      @w2 = w2 unless w2 == 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.
+      document_type = hash.key?('document_type') ? hash['document_type'] : nil
+      w2 = W2.from_hash(hash['w2']) if hash['w2']
+
+      # 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.
+      Taxform.new(document_type: document_type,
+                  w2: w2,
+                  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} document_type: #{@document_type}, w2: #{@w2}, 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} document_type: #{@document_type.inspect}, w2: #{@w2.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/taxpayer_id.rb

@@ -0,0 +1,89 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # TaxpayerId Model.
+  class TaxpayerId < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of ID, e.g. 'SSN'
+    # @return [String]
+    attr_accessor :id_type
+
+    # Last 4 digits of unique number of ID.
+    # @return [String]
+    attr_accessor :last_4_digits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id_type'] = 'id_type'
+      @_hash['last_4_digits'] = 'last_4_digits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id_type
+        last_4_digits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        id_type
+        last_4_digits
+      ]
+    end
+
+    def initialize(id_type: SKIP, last_4_digits: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id_type = id_type unless id_type == SKIP
+      @last_4_digits = last_4_digits unless last_4_digits == 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.
+      id_type = hash.key?('id_type') ? hash['id_type'] : SKIP
+      last_4_digits = hash.key?('last_4_digits') ? hash['last_4_digits'] : 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.
+      TaxpayerId.new(id_type: id_type,
+                     last_4_digits: last_4_digits,
+                     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} id_type: #{@id_type}, last_4_digits: #{@last_4_digits},"\
+      " 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} id_type: #{@id_type.inspect}, last_4_digits: #{@last_4_digits.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end