apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/liabilities_object.rb

@@ -0,0 +1,121 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object containing liability accounts
+  class LiabilitiesObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The credit accounts returned.
+    # @return [Array[CreditCardLiability]]
+    attr_accessor :credit
+
+    # The mortgage accounts returned.
+    # @return [Array[MortgageLiability]]
+    attr_accessor :mortgage
+
+    # The student loan accounts returned.
+    # @return [Array[StudentLoan]]
+    attr_accessor :student
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credit'] = 'credit'
+      @_hash['mortgage'] = 'mortgage'
+      @_hash['student'] = 'student'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        credit
+        mortgage
+        student
+      ]
+    end
+
+    def initialize(credit:, mortgage:, student:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @credit = credit
+      @mortgage = mortgage
+      @student = student
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      credit = nil
+      unless hash['credit'].nil?
+        credit = []
+        hash['credit'].each do |structure|
+          credit << (CreditCardLiability.from_hash(structure) if structure)
+        end
+      end
+
+      credit = nil unless hash.key?('credit')
+      # Parameter is an array, so we need to iterate through it
+      mortgage = nil
+      unless hash['mortgage'].nil?
+        mortgage = []
+        hash['mortgage'].each do |structure|
+          mortgage << (MortgageLiability.from_hash(structure) if structure)
+        end
+      end
+
+      mortgage = nil unless hash.key?('mortgage')
+      # Parameter is an array, so we need to iterate through it
+      student = nil
+      unless hash['student'].nil?
+        student = []
+        hash['student'].each do |structure|
+          student << (StudentLoan.from_hash(structure) if structure)
+        end
+      end
+
+      student = nil unless hash.key?('student')
+
+      # 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.
+      LiabilitiesObject.new(credit: credit,
+                            mortgage: mortgage,
+                            student: student,
+                            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} credit: #{@credit}, mortgage: #{@mortgage}, student: #{@student},"\
+      " 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} credit: #{@credit.inspect}, mortgage: #{@mortgage.inspect}, student:"\
+      " #{@student.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/liability_override.rb

@@ -0,0 +1,326 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Used to configure Sandbox test data for the Liabilities product
+  class LiabilityOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of the liability object, either `credit` or `student`. Mortgages
+    # are not currently supported in the custom Sandbox.
+    # @return [String]
+    attr_accessor :type
+
+    # The purchase APR percentage value. For simplicity, this is the only
+    # interest rate used to calculate interest charges. Can only be set if
+    # `type` is `credit`.
+    # @return [Float]
+    attr_accessor :purchase_apr
+
+    # The cash APR percentage value. Can only be set if `type` is `credit`.
+    # @return [Float]
+    attr_accessor :cash_apr
+
+    # The balance transfer APR percentage value. Can only be set if `type` is
+    # `credit`. Can only be set if `type` is `credit`.
+    # @return [Float]
+    attr_accessor :balance_transfer_apr
+
+    # The special APR percentage value. Can only be set if `type` is `credit`.
+    # @return [Float]
+    attr_accessor :special_apr
+
+    # Override the `last_payment_amount` field. Can only be set if `type` is
+    # `credit`.
+    # @return [Float]
+    attr_accessor :last_payment_amount
+
+    # Override the `minimum_payment_amount` field. Can only be set if `type` is
+    # `credit` or `student`.
+    # @return [Float]
+    attr_accessor :minimum_payment_amount
+
+    # Override the `is_overdue` field
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_overdue
+
+    # The date on which the loan was initially lent, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Can only
+    # be set if `type` is `student`.
+    # @return [Date]
+    attr_accessor :origination_date
+
+    # The original loan principal. Can only be set if `type` is `student`.
+    # @return [Float]
+    attr_accessor :principal
+
+    # The interest rate on the loan as a percentage. Can only be set if `type`
+    # is `student`.
+    # @return [Float]
+    attr_accessor :nominal_apr
+
+    # If set, interest capitalization begins at the given number of months after
+    # loan origination. By default interest is never capitalized. Can only be
+    # set if `type` is `student`.
+    # @return [Float]
+    attr_accessor :interest_capitalization_grace_period_months
+
+    # Student loan repayment information used to configure Sandbox test data for
+    # the Liabilities product
+    # @return [StudentLoanRepaymentModel]
+    attr_accessor :repayment_model
+
+    # Override the `expected_payoff_date` field. Can only be set if `type` is
+    # `student`.
+    # @return [Date]
+    attr_accessor :expected_payoff_date
+
+    # Override the `guarantor` field. Can only be set if `type` is `student`.
+    # @return [String]
+    attr_accessor :guarantor
+
+    # Override the `is_federal` field. Can only be set if `type` is `student`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_federal
+
+    # Override the `loan_name` field. Can only be set if `type` is `student`.
+    # @return [String]
+    attr_accessor :loan_name
+
+    # An object representing the status of the student loan
+    # @return [StudentLoanStatus]
+    attr_accessor :loan_status
+
+    # Override the `payment_reference_number` field. Can only be set if `type`
+    # is `student`.
+    # @return [String]
+    attr_accessor :payment_reference_number
+
+    # Information about the student's eligibility in the Public Service Loan
+    # Forgiveness program. This is only returned if the institution is Fedloan
+    # (`ins_116527`).
+    # @return [PslfStatus]
+    attr_accessor :pslf_status
+
+    # Override the `repayment_plan.description` field. Can only be set if `type`
+    # is `student`.
+    # @return [String]
+    attr_accessor :repayment_plan_description
+
+    # Override the `repayment_plan.type` field. Can only be set if `type` is
+    # `student`. Possible values are: `"extended graduated"`, `"extended
+    # standard"`, `"graduated"`, `"income-contingent repayment"`, `"income-based
+    # repayment"`, `"interest only"`, `"other"`, `"pay as you earn"`, `"revised
+    # pay as you earn"`, or `"standard"`.
+    # @return [String]
+    attr_accessor :repayment_plan_type
+
+    # Override the `sequence_number` field. Can only be set if `type` is
+    # `student`.
+    # @return [String]
+    attr_accessor :sequence_number
+
+    # A physical mailing address.
+    # @return [Address]
+    attr_accessor :servicer_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['purchase_apr'] = 'purchase_apr'
+      @_hash['cash_apr'] = 'cash_apr'
+      @_hash['balance_transfer_apr'] = 'balance_transfer_apr'
+      @_hash['special_apr'] = 'special_apr'
+      @_hash['last_payment_amount'] = 'last_payment_amount'
+      @_hash['minimum_payment_amount'] = 'minimum_payment_amount'
+      @_hash['is_overdue'] = 'is_overdue'
+      @_hash['origination_date'] = 'origination_date'
+      @_hash['principal'] = 'principal'
+      @_hash['nominal_apr'] = 'nominal_apr'
+      @_hash['interest_capitalization_grace_period_months'] =
+        'interest_capitalization_grace_period_months'
+      @_hash['repayment_model'] = 'repayment_model'
+      @_hash['expected_payoff_date'] = 'expected_payoff_date'
+      @_hash['guarantor'] = 'guarantor'
+      @_hash['is_federal'] = 'is_federal'
+      @_hash['loan_name'] = 'loan_name'
+      @_hash['loan_status'] = 'loan_status'
+      @_hash['payment_reference_number'] = 'payment_reference_number'
+      @_hash['pslf_status'] = 'pslf_status'
+      @_hash['repayment_plan_description'] = 'repayment_plan_description'
+      @_hash['repayment_plan_type'] = 'repayment_plan_type'
+      @_hash['sequence_number'] = 'sequence_number'
+      @_hash['servicer_address'] = 'servicer_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, purchase_apr:, cash_apr:, balance_transfer_apr:,
+                   special_apr:, last_payment_amount:, minimum_payment_amount:,
+                   is_overdue:, origination_date:, principal:, nominal_apr:,
+                   interest_capitalization_grace_period_months:,
+                   repayment_model:, expected_payoff_date:, guarantor:,
+                   is_federal:, loan_name:, loan_status:,
+                   payment_reference_number:, pslf_status:,
+                   repayment_plan_description:, repayment_plan_type:,
+                   sequence_number:, servicer_address:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @purchase_apr = purchase_apr
+      @cash_apr = cash_apr
+      @balance_transfer_apr = balance_transfer_apr
+      @special_apr = special_apr
+      @last_payment_amount = last_payment_amount
+      @minimum_payment_amount = minimum_payment_amount
+      @is_overdue = is_overdue
+      @origination_date = origination_date
+      @principal = principal
+      @nominal_apr = nominal_apr
+      @interest_capitalization_grace_period_months = interest_capitalization_grace_period_months
+      @repayment_model = repayment_model
+      @expected_payoff_date = expected_payoff_date
+      @guarantor = guarantor
+      @is_federal = is_federal
+      @loan_name = loan_name
+      @loan_status = loan_status
+      @payment_reference_number = payment_reference_number
+      @pslf_status = pslf_status
+      @repayment_plan_description = repayment_plan_description
+      @repayment_plan_type = repayment_plan_type
+      @sequence_number = sequence_number
+      @servicer_address = servicer_address
+      @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.
+      type = hash.key?('type') ? hash['type'] : nil
+      purchase_apr = hash.key?('purchase_apr') ? hash['purchase_apr'] : nil
+      cash_apr = hash.key?('cash_apr') ? hash['cash_apr'] : nil
+      balance_transfer_apr =
+        hash.key?('balance_transfer_apr') ? hash['balance_transfer_apr'] : nil
+      special_apr = hash.key?('special_apr') ? hash['special_apr'] : nil
+      last_payment_amount =
+        hash.key?('last_payment_amount') ? hash['last_payment_amount'] : nil
+      minimum_payment_amount =
+        hash.key?('minimum_payment_amount') ? hash['minimum_payment_amount'] : nil
+      is_overdue = hash.key?('is_overdue') ? hash['is_overdue'] : nil
+      origination_date =
+        hash.key?('origination_date') ? hash['origination_date'] : nil
+      principal = hash.key?('principal') ? hash['principal'] : nil
+      nominal_apr = hash.key?('nominal_apr') ? hash['nominal_apr'] : nil
+      interest_capitalization_grace_period_months =
+        hash.key?('interest_capitalization_grace_period_months') ? hash['interest_capitalization_grace_period_months'] : nil
+      repayment_model = StudentLoanRepaymentModel.from_hash(hash['repayment_model']) if
+        hash['repayment_model']
+      expected_payoff_date =
+        hash.key?('expected_payoff_date') ? hash['expected_payoff_date'] : nil
+      guarantor = hash.key?('guarantor') ? hash['guarantor'] : nil
+      is_federal = hash.key?('is_federal') ? hash['is_federal'] : nil
+      loan_name = hash.key?('loan_name') ? hash['loan_name'] : nil
+      loan_status = StudentLoanStatus.from_hash(hash['loan_status']) if hash['loan_status']
+      payment_reference_number =
+        hash.key?('payment_reference_number') ? hash['payment_reference_number'] : nil
+      pslf_status = PslfStatus.from_hash(hash['pslf_status']) if hash['pslf_status']
+      repayment_plan_description =
+        hash.key?('repayment_plan_description') ? hash['repayment_plan_description'] : nil
+      repayment_plan_type =
+        hash.key?('repayment_plan_type') ? hash['repayment_plan_type'] : nil
+      sequence_number =
+        hash.key?('sequence_number') ? hash['sequence_number'] : nil
+      servicer_address = Address.from_hash(hash['servicer_address']) if hash['servicer_address']
+
+      # 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.
+      LiabilityOverride.new(type: type,
+                            purchase_apr: purchase_apr,
+                            cash_apr: cash_apr,
+                            balance_transfer_apr: balance_transfer_apr,
+                            special_apr: special_apr,
+                            last_payment_amount: last_payment_amount,
+                            minimum_payment_amount: minimum_payment_amount,
+                            is_overdue: is_overdue,
+                            origination_date: origination_date,
+                            principal: principal,
+                            nominal_apr: nominal_apr,
+                            interest_capitalization_grace_period_months: interest_capitalization_grace_period_months,
+                            repayment_model: repayment_model,
+                            expected_payoff_date: expected_payoff_date,
+                            guarantor: guarantor,
+                            is_federal: is_federal,
+                            loan_name: loan_name,
+                            loan_status: loan_status,
+                            payment_reference_number: payment_reference_number,
+                            pslf_status: pslf_status,
+                            repayment_plan_description: repayment_plan_description,
+                            repayment_plan_type: repayment_plan_type,
+                            sequence_number: sequence_number,
+                            servicer_address: servicer_address,
+                            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} type: #{@type}, purchase_apr: #{@purchase_apr}, cash_apr: #{@cash_apr},"\
+      " balance_transfer_apr: #{@balance_transfer_apr}, special_apr: #{@special_apr},"\
+      " last_payment_amount: #{@last_payment_amount}, minimum_payment_amount:"\
+      " #{@minimum_payment_amount}, is_overdue: #{@is_overdue}, origination_date:"\
+      " #{@origination_date}, principal: #{@principal}, nominal_apr: #{@nominal_apr},"\
+      ' interest_capitalization_grace_period_months:'\
+      " #{@interest_capitalization_grace_period_months}, repayment_model: #{@repayment_model},"\
+      " expected_payoff_date: #{@expected_payoff_date}, guarantor: #{@guarantor}, is_federal:"\
+      " #{@is_federal}, loan_name: #{@loan_name}, loan_status: #{@loan_status},"\
+      " payment_reference_number: #{@payment_reference_number}, pslf_status: #{@pslf_status},"\
+      " repayment_plan_description: #{@repayment_plan_description}, repayment_plan_type:"\
+      " #{@repayment_plan_type}, sequence_number: #{@sequence_number}, servicer_address:"\
+      " #{@servicer_address}, 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} type: #{@type.inspect}, purchase_apr: #{@purchase_apr.inspect}, cash_apr:"\
+      " #{@cash_apr.inspect}, balance_transfer_apr: #{@balance_transfer_apr.inspect}, special_apr:"\
+      " #{@special_apr.inspect}, last_payment_amount: #{@last_payment_amount.inspect},"\
+      " minimum_payment_amount: #{@minimum_payment_amount.inspect}, is_overdue:"\
+      " #{@is_overdue.inspect}, origination_date: #{@origination_date.inspect}, principal:"\
+      " #{@principal.inspect}, nominal_apr: #{@nominal_apr.inspect},"\
+      ' interest_capitalization_grace_period_months:'\
+      " #{@interest_capitalization_grace_period_months.inspect}, repayment_model:"\
+      " #{@repayment_model.inspect}, expected_payoff_date: #{@expected_payoff_date.inspect},"\
+      " guarantor: #{@guarantor.inspect}, is_federal: #{@is_federal.inspect}, loan_name:"\
+      " #{@loan_name.inspect}, loan_status: #{@loan_status.inspect}, payment_reference_number:"\
+      " #{@payment_reference_number.inspect}, pslf_status: #{@pslf_status.inspect},"\
+      " repayment_plan_description: #{@repayment_plan_description.inspect}, repayment_plan_type:"\
+      " #{@repayment_plan_type.inspect}, sequence_number: #{@sequence_number.inspect},"\
+      " servicer_address: #{@servicer_address.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/link_token_account_filters.rb

@@ -0,0 +1,120 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # By default, Link will provide limited account filtering: it will only
+  # display Institutions that are compatible with all products supplied in the
+  # `products` parameter of `/link/token/create`, and, if `auth` is specified in
+  # the `products` array, will also filter out accounts other than `checking`
+  # and `savings` accounts on the Account Select pane. You can further limit the
+  # accounts shown in Link by using `account_filters` to specify the account
+  # subtypes to be shown in Link. Only the specified subtypes will be shown.
+  # This filtering applies to both the Account Select view (if enabled) and the
+  # Institution Select view. Institutions that do not support the selected
+  # subtypes will be omitted from Link. To indicate that all subtypes should be
+  # shown, use the value `"all"`. If the `account_filters` filter is used, any
+  # account type for which a filter is not specified will be entirely omitted
+  # from Link. For a full list of valid types and subtypes, see the [Account
+  # schema](https://plaid.com/docs/api/accounts#accounts-schema). For
+  # institutions using OAuth, the filter will not affect the list of accounts
+  # shown by the bank in the OAuth window.
+  class LinkTokenAccountFilters < 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.
+      LinkTokenAccountFilters.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