apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/status3.rb

@@ -0,0 +1,73 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The status of the payment. `PAYMENT_STATUS_INPUT_NEEDED`: This is the
+  # initial state of all payments. It indicates that the payment is waiting on
+  # user input to continue processing. A payment may re-enter this state later
+  # on if further input is needed. `PAYMENT_STATUS_PROCESSING`: The payment is
+  # currently being processed. The payment will automatically exit this state
+  # when processing is complete. `PAYMENT_STATUS_INITIATED`: The payment has
+  # been successfully initiated and is considered complete.
+  # `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been
+  # successfully established. This state is only used for standing orders.
+  # `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to
+  # insufficient funds. `PAYMENT_STATUS_FAILED`: The payment has failed to be
+  # initiated. This error is retryable once the root cause is resolved.
+  # `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable
+  # error. `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
+  class Status3
+    STATUS3 = [
+      # TODO: Write general description for PAYMENT_STATUS_INPUT_NEEDED
+      PAYMENT_STATUS_INPUT_NEEDED = 'PAYMENT_STATUS_INPUT_NEEDED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_PROCESSING
+      PAYMENT_STATUS_PROCESSING = 'PAYMENT_STATUS_PROCESSING'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_INITIATED
+      PAYMENT_STATUS_INITIATED = 'PAYMENT_STATUS_INITIATED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_COMPLETED
+      PAYMENT_STATUS_COMPLETED = 'PAYMENT_STATUS_COMPLETED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_INSUFFICIENT_FUNDS
+      PAYMENT_STATUS_INSUFFICIENT_FUNDS = 'PAYMENT_STATUS_INSUFFICIENT_FUNDS'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_FAILED
+      PAYMENT_STATUS_FAILED = 'PAYMENT_STATUS_FAILED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_BLOCKED
+      PAYMENT_STATUS_BLOCKED = 'PAYMENT_STATUS_BLOCKED'.freeze,
+
+      # TODO: Write general description for PAYMENT_STATUS_UNKNOWN
+      PAYMENT_STATUS_UNKNOWN = 'PAYMENT_STATUS_UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PAYMENT_STATUS_INPUT_NEEDED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'payment_status_input_needed' then PAYMENT_STATUS_INPUT_NEEDED
+      when 'payment_status_processing' then PAYMENT_STATUS_PROCESSING
+      when 'payment_status_initiated' then PAYMENT_STATUS_INITIATED
+      when 'payment_status_completed' then PAYMENT_STATUS_COMPLETED
+      when 'payment_status_insufficient_funds' then PAYMENT_STATUS_INSUFFICIENT_FUNDS
+      when 'payment_status_failed' then PAYMENT_STATUS_FAILED
+      when 'payment_status_blocked' then PAYMENT_STATUS_BLOCKED
+      when 'payment_status_unknown' then PAYMENT_STATUS_UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/status_breakdown.rb

@@ -0,0 +1,111 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A detailed breakdown of the institution's performance for a request type.
+  # The values for `success`, `error_plaid`, and `error_institution` sum to 1.
+  class StatusBreakdown < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The percentage of login attempts that are successful, expressed as a
+    # decimal.
+    # @return [Float]
+    attr_accessor :success
+
+    # The percentage of logins that are failing due to an internal Plaid issue,
+    # expressed as a decimal.
+    # @return [Float]
+    attr_accessor :error_plaid
+
+    # The percentage of logins that are failing due to an issue in the
+    # institution's system, expressed as a decimal.
+    # @return [Float]
+    attr_accessor :error_institution
+
+    # The `refresh_interval` may be `DELAYED` or `STOPPED` even when the success
+    # rate is high. This value is only returned for Transactions status
+    # breakdowns.
+    # @return [RefreshInterval]
+    attr_accessor :refresh_interval
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'success'
+      @_hash['error_plaid'] = 'error_plaid'
+      @_hash['error_institution'] = 'error_institution'
+      @_hash['refresh_interval'] = 'refresh_interval'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        refresh_interval
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(success:, error_plaid:, error_institution:,
+                   refresh_interval: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @success = success
+      @error_plaid = error_plaid
+      @error_institution = error_institution
+      @refresh_interval = refresh_interval unless refresh_interval == 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.
+      success = hash.key?('success') ? hash['success'] : nil
+      error_plaid = hash.key?('error_plaid') ? hash['error_plaid'] : nil
+      error_institution =
+        hash.key?('error_institution') ? hash['error_institution'] : nil
+      refresh_interval =
+        hash.key?('refresh_interval') ? hash['refresh_interval'] : 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.
+      StatusBreakdown.new(success: success,
+                          error_plaid: error_plaid,
+                          error_institution: error_institution,
+                          refresh_interval: refresh_interval,
+                          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} success: #{@success}, error_plaid: #{@error_plaid}, error_institution:"\
+      " #{@error_institution}, refresh_interval: #{@refresh_interval}, 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} success: #{@success.inspect}, error_plaid: #{@error_plaid.inspect},"\
+      " error_institution: #{@error_institution.inspect}, refresh_interval:"\
+      " #{@refresh_interval.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/student_loan.rb

@@ -0,0 +1,367 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Contains details about a student loan account
+  class StudentLoan < 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. For some institutions, this may be a
+    # masked version of the number (e.g., the last 4 digits instead of the
+    # entire number).
+    # @return [String]
+    attr_accessor :account_number
+
+    # The dates on which loaned funds were disbursed or will be disbursed. These
+    # are often in the past. Dates are returned in an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # @return [Array[Date]]
+    attr_accessor :disbursement_dates
+
+    # The date when the student loan is expected to be paid off. Availability
+    # for this field is limited. Dates are returned in an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :expected_payoff_date
+
+    # The guarantor of the student loan.
+    # @return [String]
+    attr_accessor :guarantor
+
+    # The interest rate on the loan as a percentage.
+    # @return [Float]
+    attr_accessor :interest_rate_percentage
+
+    # `true` if a payment is currently overdue. Availability for this field is
+    # limited.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_overdue
+
+    # 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
+
+    # The date of the last statement. Dates are returned in an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :last_statement_issue_date
+
+    # The type of loan, e.g., "Consolidation Loans".
+    # @return [String]
+    attr_accessor :loan_name
+
+    # An object representing the status of the student loan
+    # @return [StudentLoanStatus]
+    attr_accessor :loan_status
+
+    # The minimum payment due for the next billing cycle. There are some
+    # exceptions:
+    # Some institutions require a minimum payment across all loans associated
+    # with an account number. Our API presents that same minimum payment amount
+    # on each loan. The institutions that do this are: Great Lakes (
+    # `ins_116861`), Firstmark (`ins_116295`), Commonbond Firstmark Services
+    # (`ins_116950`), Nelnet (`ins_116528`), EdFinancial Services
+    # (`ins_116304`), Granite State (`ins_116308`), and Oklahoma Student Loan
+    # Authority (`ins_116945`).
+    # Firstmark (`ins_116295` ) will display as $0 if there is an autopay
+    # program in effect.
+    # @return [Float]
+    attr_accessor :minimum_payment_amount
+
+    # The due date for the next payment. The due date is `null` if a payment is
+    # not expected. A payment is not expected if `loan_status.type` is
+    # `deferment`, `in_school`, `consolidated`, `paid in full`, or
+    # `transferred`. 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 loan.
+    # @return [Float]
+    attr_accessor :origination_principal_amount
+
+    # The total dollar amount of the accrued interest balance. For Sallie Mae (
+    # `ins_116944`), this amount is included in the current balance of the loan,
+    # so this field will return as `null`.
+    # @return [Float]
+    attr_accessor :outstanding_interest_amount
+
+    # The relevant account number that should be used to reference this loan for
+    # payments. In the majority of cases, `payment_reference_number` will match
+    # a`ccount_number,` but in some institutions, such as Great Lakes
+    # (`ins_116861`), it will be different.
+    # @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
+
+    # An object representing the repayment plan for the student loan
+    # @return [StudentRepaymentPlan]
+    attr_accessor :repayment_plan
+
+    # The sequence number of the student loan. Heartland ECSI (`ins_116948`)
+    # does not make this field available.
+    # @return [String]
+    attr_accessor :sequence_number
+
+    # The address of the student loan servicer. This is generally the remittance
+    # address to which payments should be sent.
+    # @return [ServicerAddressData]
+    attr_accessor :servicer_address
+
+    # The year to date (YTD) interest paid. Availability for this field is
+    # limited.
+    # @return [Float]
+    attr_accessor :ytd_interest_paid
+
+    # The year to date (YTD) principal paid. Availability for this field is
+    # limited.
+    # @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['disbursement_dates'] = 'disbursement_dates'
+      @_hash['expected_payoff_date'] = 'expected_payoff_date'
+      @_hash['guarantor'] = 'guarantor'
+      @_hash['interest_rate_percentage'] = 'interest_rate_percentage'
+      @_hash['is_overdue'] = 'is_overdue'
+      @_hash['last_payment_amount'] = 'last_payment_amount'
+      @_hash['last_payment_date'] = 'last_payment_date'
+      @_hash['last_statement_issue_date'] = 'last_statement_issue_date'
+      @_hash['loan_name'] = 'loan_name'
+      @_hash['loan_status'] = 'loan_status'
+      @_hash['minimum_payment_amount'] = 'minimum_payment_amount'
+      @_hash['next_payment_due_date'] = 'next_payment_due_date'
+      @_hash['origination_date'] = 'origination_date'
+      @_hash['origination_principal_amount'] = 'origination_principal_amount'
+      @_hash['outstanding_interest_amount'] = 'outstanding_interest_amount'
+      @_hash['payment_reference_number'] = 'payment_reference_number'
+      @_hash['pslf_status'] = 'pslf_status'
+      @_hash['repayment_plan'] = 'repayment_plan'
+      @_hash['sequence_number'] = 'sequence_number'
+      @_hash['servicer_address'] = 'servicer_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[
+        account_id
+        account_number
+        disbursement_dates
+        expected_payoff_date
+        guarantor
+        is_overdue
+        last_payment_amount
+        last_payment_date
+        last_statement_issue_date
+        loan_name
+        minimum_payment_amount
+        next_payment_due_date
+        origination_date
+        origination_principal_amount
+        outstanding_interest_amount
+        payment_reference_number
+        sequence_number
+        ytd_interest_paid
+        ytd_principal_paid
+      ]
+    end
+
+    def initialize(account_id:, account_number:, disbursement_dates:,
+                   expected_payoff_date:, guarantor:, interest_rate_percentage:,
+                   is_overdue:, last_payment_amount:, last_payment_date:,
+                   last_statement_issue_date:, loan_name:, loan_status:,
+                   minimum_payment_amount:, next_payment_due_date:,
+                   origination_date:, origination_principal_amount:,
+                   outstanding_interest_amount:, payment_reference_number:,
+                   pslf_status:, repayment_plan:, sequence_number:,
+                   servicer_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
+      @disbursement_dates = disbursement_dates
+      @expected_payoff_date = expected_payoff_date
+      @guarantor = guarantor
+      @interest_rate_percentage = interest_rate_percentage
+      @is_overdue = is_overdue
+      @last_payment_amount = last_payment_amount
+      @last_payment_date = last_payment_date
+      @last_statement_issue_date = last_statement_issue_date
+      @loan_name = loan_name
+      @loan_status = loan_status
+      @minimum_payment_amount = minimum_payment_amount
+      @next_payment_due_date = next_payment_due_date
+      @origination_date = origination_date
+      @origination_principal_amount = origination_principal_amount
+      @outstanding_interest_amount = outstanding_interest_amount
+      @payment_reference_number = payment_reference_number
+      @pslf_status = pslf_status
+      @repayment_plan = repayment_plan
+      @sequence_number = sequence_number
+      @servicer_address = servicer_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
+      disbursement_dates =
+        hash.key?('disbursement_dates') ? hash['disbursement_dates'] : nil
+      expected_payoff_date =
+        hash.key?('expected_payoff_date') ? hash['expected_payoff_date'] : nil
+      guarantor = hash.key?('guarantor') ? hash['guarantor'] : nil
+      interest_rate_percentage =
+        hash.key?('interest_rate_percentage') ? hash['interest_rate_percentage'] : nil
+      is_overdue = hash.key?('is_overdue') ? hash['is_overdue'] : nil
+      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
+      last_statement_issue_date =
+        hash.key?('last_statement_issue_date') ? hash['last_statement_issue_date'] : nil
+      loan_name = hash.key?('loan_name') ? hash['loan_name'] : nil
+      loan_status = StudentLoanStatus.from_hash(hash['loan_status']) if hash['loan_status']
+      minimum_payment_amount =
+        hash.key?('minimum_payment_amount') ? hash['minimum_payment_amount'] : 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
+      outstanding_interest_amount =
+        hash.key?('outstanding_interest_amount') ? hash['outstanding_interest_amount'] : nil
+      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 = StudentRepaymentPlan.from_hash(hash['repayment_plan']) if
+        hash['repayment_plan']
+      sequence_number =
+        hash.key?('sequence_number') ? hash['sequence_number'] : nil
+      servicer_address = ServicerAddressData.from_hash(hash['servicer_address']) if
+        hash['servicer_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.
+      StudentLoan.new(account_id: account_id,
+                      account_number: account_number,
+                      disbursement_dates: disbursement_dates,
+                      expected_payoff_date: expected_payoff_date,
+                      guarantor: guarantor,
+                      interest_rate_percentage: interest_rate_percentage,
+                      is_overdue: is_overdue,
+                      last_payment_amount: last_payment_amount,
+                      last_payment_date: last_payment_date,
+                      last_statement_issue_date: last_statement_issue_date,
+                      loan_name: loan_name,
+                      loan_status: loan_status,
+                      minimum_payment_amount: minimum_payment_amount,
+                      next_payment_due_date: next_payment_due_date,
+                      origination_date: origination_date,
+                      origination_principal_amount: origination_principal_amount,
+                      outstanding_interest_amount: outstanding_interest_amount,
+                      payment_reference_number: payment_reference_number,
+                      pslf_status: pslf_status,
+                      repayment_plan: repayment_plan,
+                      sequence_number: sequence_number,
+                      servicer_address: servicer_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},"\
+      " disbursement_dates: #{@disbursement_dates}, expected_payoff_date:"\
+      " #{@expected_payoff_date}, guarantor: #{@guarantor}, interest_rate_percentage:"\
+      " #{@interest_rate_percentage}, is_overdue: #{@is_overdue}, last_payment_amount:"\
+      " #{@last_payment_amount}, last_payment_date: #{@last_payment_date},"\
+      " last_statement_issue_date: #{@last_statement_issue_date}, loan_name: #{@loan_name},"\
+      " loan_status: #{@loan_status}, minimum_payment_amount: #{@minimum_payment_amount},"\
+      " next_payment_due_date: #{@next_payment_due_date}, origination_date: #{@origination_date},"\
+      " origination_principal_amount: #{@origination_principal_amount},"\
+      " outstanding_interest_amount: #{@outstanding_interest_amount}, payment_reference_number:"\
+      " #{@payment_reference_number}, pslf_status: #{@pslf_status}, repayment_plan:"\
+      " #{@repayment_plan}, sequence_number: #{@sequence_number}, servicer_address:"\
+      " #{@servicer_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}, disbursement_dates: #{@disbursement_dates.inspect},"\
+      " expected_payoff_date: #{@expected_payoff_date.inspect}, guarantor: #{@guarantor.inspect},"\
+      " interest_rate_percentage: #{@interest_rate_percentage.inspect}, is_overdue:"\
+      " #{@is_overdue.inspect}, last_payment_amount: #{@last_payment_amount.inspect},"\
+      " last_payment_date: #{@last_payment_date.inspect}, last_statement_issue_date:"\
+      " #{@last_statement_issue_date.inspect}, loan_name: #{@loan_name.inspect}, loan_status:"\
+      " #{@loan_status.inspect}, minimum_payment_amount: #{@minimum_payment_amount.inspect},"\
+      " next_payment_due_date: #{@next_payment_due_date.inspect}, origination_date:"\
+      " #{@origination_date.inspect}, origination_principal_amount:"\
+      " #{@origination_principal_amount.inspect}, outstanding_interest_amount:"\
+      " #{@outstanding_interest_amount.inspect}, payment_reference_number:"\
+      " #{@payment_reference_number.inspect}, pslf_status: #{@pslf_status.inspect},"\
+      " repayment_plan: #{@repayment_plan.inspect}, sequence_number: #{@sequence_number.inspect},"\
+      " servicer_address: #{@servicer_address.inspect}, ytd_interest_paid:"\
+      " #{@ytd_interest_paid.inspect}, ytd_principal_paid: #{@ytd_principal_paid.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/student_loan_repayment_model.rb

@@ -0,0 +1,95 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Student loan repayment information used to configure Sandbox test data for
+  # the Liabilities product
+  class StudentLoanRepaymentModel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The only currently supported value for this field is `standard`.
+    # @return [String]
+    attr_accessor :type
+
+    # Configures the number of months before repayment starts.
+    # @return [Float]
+    attr_accessor :non_repayment_months
+
+    # Configures the number of months of repayments before the loan is paid off.
+    # @return [Float]
+    attr_accessor :repayment_months
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['non_repayment_months'] = 'non_repayment_months'
+      @_hash['repayment_months'] = 'repayment_months'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, non_repayment_months:, repayment_months:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @non_repayment_months = non_repayment_months
+      @repayment_months = repayment_months
+      @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
+      non_repayment_months =
+        hash.key?('non_repayment_months') ? hash['non_repayment_months'] : nil
+      repayment_months =
+        hash.key?('repayment_months') ? hash['repayment_months'] : 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.
+      StudentLoanRepaymentModel.new(type: type,
+                                    non_repayment_months: non_repayment_months,
+                                    repayment_months: repayment_months,
+                                    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}, non_repayment_months: #{@non_repayment_months},"\
+      " repayment_months: #{@repayment_months}, 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}, non_repayment_months:"\
+      " #{@non_repayment_months.inspect}, repayment_months: #{@repayment_months.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end