apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/meta.rb

@@ -0,0 +1,90 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Allows specifying the metadata of the test account
+  class Meta < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account's name
+    # @return [String]
+    attr_accessor :name
+
+    # The account's official name
+    # @return [String]
+    attr_accessor :official_name
+
+    # The account's limit
+    # @return [Float]
+    attr_accessor :limit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['official_name'] = 'official_name'
+      @_hash['limit'] = 'limit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, official_name:, limit:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @official_name = official_name
+      @limit = limit
+      @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.
+      name = hash.key?('name') ? hash['name'] : nil
+      official_name = hash.key?('official_name') ? hash['official_name'] : nil
+      limit = hash.key?('limit') ? hash['limit'] : 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.
+      Meta.new(name: name,
+               official_name: official_name,
+               limit: limit,
+               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} name: #{@name}, official_name: #{@official_name}, limit: #{@limit},"\
+      " 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} name: #{@name.inspect}, official_name: #{@official_name.inspect}, limit:"\
+      " #{@limit.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/mfa.rb

@@ -0,0 +1,124 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Specifies the multi-factor authentication settings to use with this test
+  # account
+  class Mfa < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Possible values are `device`, `selections`, or `questions`.
+    # If value is `device`, the MFA answer is `1234`.
+    # If value is `selections`, the MFA answer is always the first option.
+    # If value is `questions`, the MFA answer is  `answer_<i>_<j>` for the j-th
+    # question in the i-th round, starting from 0. For example, the answer to
+    # the first question in the second round is `answer_1_0`.
+    # @return [String]
+    attr_accessor :type
+
+    # Number of rounds of questions. Required if value of `type` is `questions`.
+    # @return [Float]
+    attr_accessor :question_rounds
+
+    # Number of questions per round. Required if value of `type` is `questions`.
+    # If value of type is `selections`, default value is 2.
+    # @return [Float]
+    attr_accessor :questions_per_round
+
+    # Number of rounds of selections, used if `type` is `selections`. Defaults
+    # to 1.
+    # @return [Float]
+    attr_accessor :selection_rounds
+
+    # Number of available answers per question, used if `type` is `selection`.
+    # Defaults to 2.
+    # @return [Float]
+    attr_accessor :selections_per_question
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['question_rounds'] = 'question_rounds'
+      @_hash['questions_per_round'] = 'questions_per_round'
+      @_hash['selection_rounds'] = 'selection_rounds'
+      @_hash['selections_per_question'] = 'selections_per_question'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, question_rounds:, questions_per_round:,
+                   selection_rounds:, selections_per_question:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @question_rounds = question_rounds
+      @questions_per_round = questions_per_round
+      @selection_rounds = selection_rounds
+      @selections_per_question = selections_per_question
+      @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
+      question_rounds =
+        hash.key?('question_rounds') ? hash['question_rounds'] : nil
+      questions_per_round =
+        hash.key?('questions_per_round') ? hash['questions_per_round'] : nil
+      selection_rounds =
+        hash.key?('selection_rounds') ? hash['selection_rounds'] : nil
+      selections_per_question =
+        hash.key?('selections_per_question') ? hash['selections_per_question'] : 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.
+      Mfa.new(type: type,
+              question_rounds: question_rounds,
+              questions_per_round: questions_per_round,
+              selection_rounds: selection_rounds,
+              selections_per_question: selections_per_question,
+              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}, question_rounds: #{@question_rounds}, questions_per_round:"\
+      " #{@questions_per_round}, selection_rounds: #{@selection_rounds}, selections_per_question:"\
+      " #{@selections_per_question}, 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}, question_rounds: #{@question_rounds.inspect},"\
+      " questions_per_round: #{@questions_per_round.inspect}, selection_rounds:"\
+      " #{@selection_rounds.inspect}, selections_per_question:"\
+      " #{@selections_per_question.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/mortgage_interest_rate.rb

@@ -0,0 +1,86 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Object containing metadata about the interest rate for the mortgage.
+  class MortgageInterestRate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Percentage value (interest rate of current mortgage, not APR) of interest
+    # payable on a loan.
+    # @return [Float]
+    attr_accessor :percentage
+
+    # The type of interest charged (fixed or variable).
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['percentage'] = 'percentage'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        percentage
+        type
+      ]
+    end
+
+    def initialize(percentage:, type:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @percentage = percentage
+      @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.
+      percentage = hash.key?('percentage') ? hash['percentage'] : 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.
+      MortgageInterestRate.new(percentage: percentage,
+                               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} percentage: #{@percentage}, 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} percentage: #{@percentage.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/mortgage_liability.rb

@@ -0,0 +1,295 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Contains details about a mortgage account.
+  class MortgageLiability < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the account that this liability belongs to.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The account number of the loan.
+    # @return [String]
+    attr_accessor :account_number
+
+    # The current outstanding amount charged for late payment.
+    # @return [Float]
+    attr_accessor :current_late_fee
+
+    # Total amount held in escrow to pay taxes and insurance on behalf of the
+    # borrower.
+    # @return [Float]
+    attr_accessor :escrow_balance
+
+    # Indicates whether the borrower has private mortgage insurance in effect.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_pmi
+
+    # Indicates whether the borrower will pay a penalty for early payoff of
+    # mortgage.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_prepayment_penalty
+
+    # Object containing metadata about the interest rate for the mortgage.
+    # @return [MortgageInterestRate]
+    attr_accessor :interest_rate
+
+    # The amount of the last payment.
+    # @return [Float]
+    attr_accessor :last_payment_amount
+
+    # The date of the last payment. Dates are returned in an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :last_payment_date
+
+    # Description of the type of loan, for example `conventional`, `fixed`, or
+    # `variable`. This field is provided directly from the loan servicer and
+    # does not have an enumerated set of possible values.
+    # @return [String]
+    attr_accessor :loan_type_description
+
+    # Full duration of mortgage as at origination (e.g. `10 year`).
+    # @return [String]
+    attr_accessor :loan_term
+
+    # Original date on which mortgage is due in full. Dates are returned in an
+    # [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :maturity_date
+
+    # The amount of the next payment.
+    # @return [Float]
+    attr_accessor :next_monthly_payment
+
+    # The due date for the next payment. Dates are returned in an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :next_payment_due_date
+
+    # The date on which the loan was initially lent. Dates are returned in an
+    # [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :origination_date
+
+    # The original principal balance of the mortgage.
+    # @return [Float]
+    attr_accessor :origination_principal_amount
+
+    # Amount of loan (principal + interest) past due for payment.
+    # @return [Float]
+    attr_accessor :past_due_amount
+
+    # Object containing fields describing property address.
+    # @return [MortgagePropertyAddress]
+    attr_accessor :property_address
+
+    # The year to date (YTD) interest paid.
+    # @return [Float]
+    attr_accessor :ytd_interest_paid
+
+    # The YTD principal paid.
+    # @return [Float]
+    attr_accessor :ytd_principal_paid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account_id'
+      @_hash['account_number'] = 'account_number'
+      @_hash['current_late_fee'] = 'current_late_fee'
+      @_hash['escrow_balance'] = 'escrow_balance'
+      @_hash['has_pmi'] = 'has_pmi'
+      @_hash['has_prepayment_penalty'] = 'has_prepayment_penalty'
+      @_hash['interest_rate'] = 'interest_rate'
+      @_hash['last_payment_amount'] = 'last_payment_amount'
+      @_hash['last_payment_date'] = 'last_payment_date'
+      @_hash['loan_type_description'] = 'loan_type_description'
+      @_hash['loan_term'] = 'loan_term'
+      @_hash['maturity_date'] = 'maturity_date'
+      @_hash['next_monthly_payment'] = 'next_monthly_payment'
+      @_hash['next_payment_due_date'] = 'next_payment_due_date'
+      @_hash['origination_date'] = 'origination_date'
+      @_hash['origination_principal_amount'] = 'origination_principal_amount'
+      @_hash['past_due_amount'] = 'past_due_amount'
+      @_hash['property_address'] = 'property_address'
+      @_hash['ytd_interest_paid'] = 'ytd_interest_paid'
+      @_hash['ytd_principal_paid'] = 'ytd_principal_paid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        current_late_fee
+        escrow_balance
+        has_pmi
+        has_prepayment_penalty
+        last_payment_amount
+        last_payment_date
+        loan_type_description
+        loan_term
+        maturity_date
+        next_monthly_payment
+        next_payment_due_date
+        origination_date
+        origination_principal_amount
+        past_due_amount
+        ytd_interest_paid
+        ytd_principal_paid
+      ]
+    end
+
+    def initialize(account_id:, account_number:, current_late_fee:,
+                   escrow_balance:, has_pmi:, has_prepayment_penalty:,
+                   interest_rate:, last_payment_amount:, last_payment_date:,
+                   loan_type_description:, loan_term:, maturity_date:,
+                   next_monthly_payment:, next_payment_due_date:,
+                   origination_date:, origination_principal_amount:,
+                   past_due_amount:, property_address:, ytd_interest_paid:,
+                   ytd_principal_paid:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id
+      @account_number = account_number
+      @current_late_fee = current_late_fee
+      @escrow_balance = escrow_balance
+      @has_pmi = has_pmi
+      @has_prepayment_penalty = has_prepayment_penalty
+      @interest_rate = interest_rate
+      @last_payment_amount = last_payment_amount
+      @last_payment_date = last_payment_date
+      @loan_type_description = loan_type_description
+      @loan_term = loan_term
+      @maturity_date = maturity_date
+      @next_monthly_payment = next_monthly_payment
+      @next_payment_due_date = next_payment_due_date
+      @origination_date = origination_date
+      @origination_principal_amount = origination_principal_amount
+      @past_due_amount = past_due_amount
+      @property_address = property_address
+      @ytd_interest_paid = ytd_interest_paid
+      @ytd_principal_paid = ytd_principal_paid
+      @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
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : nil
+      current_late_fee =
+        hash.key?('current_late_fee') ? hash['current_late_fee'] : nil
+      escrow_balance =
+        hash.key?('escrow_balance') ? hash['escrow_balance'] : nil
+      has_pmi = hash.key?('has_pmi') ? hash['has_pmi'] : nil
+      has_prepayment_penalty =
+        hash.key?('has_prepayment_penalty') ? hash['has_prepayment_penalty'] : nil
+      interest_rate = MortgageInterestRate.from_hash(hash['interest_rate']) if
+        hash['interest_rate']
+      last_payment_amount =
+        hash.key?('last_payment_amount') ? hash['last_payment_amount'] : nil
+      last_payment_date =
+        hash.key?('last_payment_date') ? hash['last_payment_date'] : nil
+      loan_type_description =
+        hash.key?('loan_type_description') ? hash['loan_type_description'] : nil
+      loan_term = hash.key?('loan_term') ? hash['loan_term'] : nil
+      maturity_date = hash.key?('maturity_date') ? hash['maturity_date'] : nil
+      next_monthly_payment =
+        hash.key?('next_monthly_payment') ? hash['next_monthly_payment'] : nil
+      next_payment_due_date =
+        hash.key?('next_payment_due_date') ? hash['next_payment_due_date'] : nil
+      origination_date =
+        hash.key?('origination_date') ? hash['origination_date'] : nil
+      origination_principal_amount =
+        hash.key?('origination_principal_amount') ? hash['origination_principal_amount'] : nil
+      past_due_amount =
+        hash.key?('past_due_amount') ? hash['past_due_amount'] : nil
+      property_address = MortgagePropertyAddress.from_hash(hash['property_address']) if
+        hash['property_address']
+      ytd_interest_paid =
+        hash.key?('ytd_interest_paid') ? hash['ytd_interest_paid'] : nil
+      ytd_principal_paid =
+        hash.key?('ytd_principal_paid') ? hash['ytd_principal_paid'] : 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.
+      MortgageLiability.new(account_id: account_id,
+                            account_number: account_number,
+                            current_late_fee: current_late_fee,
+                            escrow_balance: escrow_balance,
+                            has_pmi: has_pmi,
+                            has_prepayment_penalty: has_prepayment_penalty,
+                            interest_rate: interest_rate,
+                            last_payment_amount: last_payment_amount,
+                            last_payment_date: last_payment_date,
+                            loan_type_description: loan_type_description,
+                            loan_term: loan_term,
+                            maturity_date: maturity_date,
+                            next_monthly_payment: next_monthly_payment,
+                            next_payment_due_date: next_payment_due_date,
+                            origination_date: origination_date,
+                            origination_principal_amount: origination_principal_amount,
+                            past_due_amount: past_due_amount,
+                            property_address: property_address,
+                            ytd_interest_paid: ytd_interest_paid,
+                            ytd_principal_paid: ytd_principal_paid,
+                            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}, account_number: #{@account_number},"\
+      " current_late_fee: #{@current_late_fee}, escrow_balance: #{@escrow_balance}, has_pmi:"\
+      " #{@has_pmi}, has_prepayment_penalty: #{@has_prepayment_penalty}, interest_rate:"\
+      " #{@interest_rate}, last_payment_amount: #{@last_payment_amount}, last_payment_date:"\
+      " #{@last_payment_date}, loan_type_description: #{@loan_type_description}, loan_term:"\
+      " #{@loan_term}, maturity_date: #{@maturity_date}, next_monthly_payment:"\
+      " #{@next_monthly_payment}, next_payment_due_date: #{@next_payment_due_date},"\
+      " origination_date: #{@origination_date}, origination_principal_amount:"\
+      " #{@origination_principal_amount}, past_due_amount: #{@past_due_amount}, property_address:"\
+      " #{@property_address}, ytd_interest_paid: #{@ytd_interest_paid}, ytd_principal_paid:"\
+      " #{@ytd_principal_paid}, 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}, account_number:"\
+      " #{@account_number.inspect}, current_late_fee: #{@current_late_fee.inspect},"\
+      " escrow_balance: #{@escrow_balance.inspect}, has_pmi: #{@has_pmi.inspect},"\
+      " has_prepayment_penalty: #{@has_prepayment_penalty.inspect}, interest_rate:"\
+      " #{@interest_rate.inspect}, last_payment_amount: #{@last_payment_amount.inspect},"\
+      " last_payment_date: #{@last_payment_date.inspect}, loan_type_description:"\
+      " #{@loan_type_description.inspect}, loan_term: #{@loan_term.inspect}, maturity_date:"\
+      " #{@maturity_date.inspect}, next_monthly_payment: #{@next_monthly_payment.inspect},"\
+      " next_payment_due_date: #{@next_payment_due_date.inspect}, origination_date:"\
+      " #{@origination_date.inspect}, origination_principal_amount:"\
+      " #{@origination_principal_amount.inspect}, past_due_amount: #{@past_due_amount.inspect},"\
+      " property_address: #{@property_address.inspect}, ytd_interest_paid:"\
+      " #{@ytd_interest_paid.inspect}, ytd_principal_paid: #{@ytd_principal_paid.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end