plaid 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bac1f4f002db7e866fd402fc1f5ffd564a4aa241
-  data.tar.gz: ef365c86c2c8443b0f9e1f74f497edfd62e3150e
+  metadata.gz: 1b5b0c86b267fc7ea3614ee8768c08add645832a
+  data.tar.gz: ebdabcd25e4812284f32e5c7e9c05a2d75f4eaa7
 SHA512:
-  metadata.gz: 0146aba875c55d08295b0f0488c7e8517977480c4d54a0b1e031081677e8b3854a961ee3cd8ededcd3d5a0ecc992e6fb3cd1357c2c0b9cc735b15b05a7e87462
-  data.tar.gz: d270ce69ab7a41afa2f53e76b1bce551f8683cfb9e4c5749cb2bf64bd5d22a87e87c914fabb50d63a2de227163dce4af940f42d0bc05a0a11ea247f696c3d3c7
+  metadata.gz: 36b86b9fe94a5b0ab84ed3a76ce7ab1352561be1c1ad0ce510dfd69b28ec16cc4451112bbd411d372b60d0e88d5101efcffbd52a876faca22d4f27dd7f383f76
+  data.tar.gz: 6f03c6dc683c52845519627ac96a6b0c872190bf180ef0e61d388b6b8c8090ff0e243d96a8044bb1136b03a56d805474a4f93684c58a1ddba55c28fbff775d8f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 8.1.0 23-Jul-2019
+
+* Add binding for the new [liabilities product](https://plaid.com/docs/api/#liabilities)
+
 # 8.0.0 19-Jun-2019
 
 * Deprecate direct integration as it is no longer supported

data/lib/plaid.rb

@@ -19,6 +19,7 @@ require_relative 'plaid/products/processor'
 require_relative 'plaid/products/sandbox'
 require_relative 'plaid/products/transactions'
 require_relative 'plaid/products/investments'
+require_relative 'plaid/products/liabilities'
 require_relative 'plaid/client'
 
 # Public: The namespace for all the things Plaid.

data/lib/plaid/client.rb

@@ -77,6 +77,11 @@ module Plaid
     # Public: The Plaid::Item product accessor.
     subproduct :item
 
+    ##
+    # :attr_reader:
+    # Public: The Plaid::Liabilities product accessor.
+    subproduct :liabilities
+
     ##
     # :attr_reader:
     # Public: The Plaid::Processor product accessor.

data/lib/plaid/models.rb

@@ -782,6 +782,11 @@ module Plaid
       # :attr_reader:
       # Public: The Array of String country codes supported by this institution.
       property :country_codes
+
+      ##
+      # :attr_reader:
+      # Public: The array of routing numbers associated with this institution.
+      property :routing_numbers
     end
 
     module MFA
@@ -1582,5 +1587,224 @@ module Plaid
       # Asset Report; see AssetReportItem object for fields.
       property :items, coerce: Array[AssetReportItem]
     end
+
+    # Public: A representation of an eligibility for the Public Service Loan
+    # Forgiveness program.
+    class PSLFStatus < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The estimated date borrower will have completed 120 qualifying
+      # monthly payments.
+      property :estimated_eligibility_date
+
+      ##
+      # :attr_reader:
+      # Public: The number of qualifying payments that have been made.
+      property :payments_made
+
+      ##
+      # :attr_reader:
+      # Public: The number of qualifying payments that are remaining.
+      property :payments_remaining
+    end
+
+    # Public: A representation of the status of a student loan.
+    class StudentLoanStatus < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The status of the loan, e.g. "repayment", "deferment",
+      # "forbearance".
+      property :type
+
+      ##
+      # :attr_reader:
+      # Public: The date the status expires.
+      property :end_date
+    end
+
+    # Public: A representation of a student loan repayment plan.
+    class StudentLoanRepaymentPlan < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The type of repayment plan, e.g., "standard", "income".
+      property :type
+
+      ##
+      # :attr_reader:
+      # Public: The full name of the repayment plan, e.g. "Standard Repayment".
+      property :description
+    end
+
+    # Public: A representation of a student loan servicer address.
+    class StudentLoanServicerAddress < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The full city name
+      property :city
+
+      ##
+      # :attr_reader:
+      # Public: The ISO 3166-1 alpha-2 country code
+      property :country
+
+      ##
+      # :attr_reader:
+      # Public: The postal code.
+      property :postal_code
+
+      ##
+      # :attr_reader:
+      # Public: The region or state.
+      property :region
+
+      ##
+      # :attr_reader:
+      # Public: The full street address.
+      property :street
+    end
+
+    # Public: A representation of a student loan liability.
+    class StudentLoanLiability < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The String account ID. E.g.
+      # "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
+      property :account_id
+
+      ##
+      # :attr_reader:
+      # Public: The account number of the loan.
+      property :account_number
+
+      ##
+      # :attr_reader:
+      # Public: The dates on which loaned funds were disbursed or will be
+      # disbursed. These are often in the past.
+      property :disbursement_dates
+
+      ##
+      # :attr_reader:
+      # Public: The date when the student loan is expected to be paid off.
+      property :expected_payoff_date
+
+      ##
+      # :attr_reader:
+      # Public: The guarantor of the student loan.
+      property :guarantor
+
+      ##
+      # :attr_reader:
+      # Public: The interest rate on loans shown as a percentage.
+      property :interest_rate_percentage
+
+      ##
+      # :attr_reader:
+      # Public: True if a payment is currently overdue.
+      property :is_overdue
+
+      ##
+      # :attr_reader:
+      # Public: The amount of the last payment.
+      property :last_payment_amount
+
+      ##
+      # :attr_reader:
+      # Public: The date of the last payment.
+      property :last_payment_date
+
+      ##
+      # :attr_reader:
+      # Public: The outstanding balance on the last statement.
+      property :last_statement_balance
+
+      ##
+      # :attr_reader:
+      # Public: The date the last statement was issued.
+      property :last_statement_issue_date
+
+      ##
+      # :attr_reader:
+      # Public: The status of the loan, e.g. "Repayment", "Deferment",
+      # "Forbearance".
+      property :loan_status, coerce: StudentLoanStatus
+
+      ##
+      # :attr_reader:
+      # Public: The type of loan, e.g., "Consolidation Loans".
+      property :loan_name
+
+      ##
+      # :attr_reader:
+      # Public: The minimum payment due for the next billing cycle.
+      property :minimum_payment_amount
+
+      ##
+      # :attr_reader:
+      # Public: The due date for the next payment.
+      property :next_payment_due_date
+
+      ##
+      # :attr_reader:
+      # Public: The date on which the loan was initially lent.
+      property :origination_date
+
+      ##
+      # :attr_reader:
+      # Public: The original principal balance of the loan.
+      property :origination_principal_amount
+
+      ##
+      # :attr_reader:
+      # Public: The dollar amount of the accrued interest balance.
+      property :outstanding_interest_amount
+
+      ##
+      # :attr_reader:
+      # Public: The relevant account number that should be used to reference
+      # this loan for payments. This is sometimes different from
+      # account_number.
+      property :payment_reference_number
+
+      ##
+      # :attr_reader:
+      # Public: Information about the student's eligibility in the Public
+      # Service Loan Forgiveness program.
+      property :pslf_status, coerce: PSLFStatus
+
+      ##
+      # :attr_reader:
+      # Public: Information about the repayment plan.
+      property :repayment_plan, coerce: StudentLoanRepaymentPlan
+
+      ##
+      # :attr_reader:
+      # Public: The sequence number of the student loan.
+      property :sequence_number
+
+      ##
+      # :attr_reader:
+      # Public: The servicer address for which payments should be sent.
+      property :servicer_address, coerce: StudentLoanServicerAddress
+
+      ##
+      # :attr_reader:
+      # Public: The year to date (YTD) interest paid.
+      property :ytd_interest_paid
+
+      ##
+      # :attr_reader:
+      # Public: The year to date (YTD) principal paid.
+      property :ytd_principal_paid
+    end
+
+    # Public: A representation of someone's liabilities of all types.
+    class Liabilities < BaseModel
+      include Hashie::Extensions::IgnoreUndeclared
+
+      ##
+      # :attr_reader:
+      # Public: Student loan liabilities associated with the item.
+      property :student, coerce: Array[StudentLoanLiability]
+    end
   end
 end

data/lib/plaid/products/liabilities.rb

@@ -0,0 +1,39 @@
+module Plaid
+  # Public: Class used to call the Liabilities product.
+  class Liabilities < BaseProduct
+    # Public: Get liabilities information.
+    #
+    # Does a POST /liabilities/get call which fetches liabilities associated
+    # with an access_token's item.
+    #
+    # access_token - access_token of an item to fetch liabilities for.
+    # account_ids  - Specific account ids to fetch liabilities for
+    #                (optional).
+    #
+    # Returns the LiabilitiesResponse object with liabilities data.
+    def get(access_token, account_ids: nil)
+      post_with_auth 'liabilities/get',
+                     LiabilitiesResponse,
+                     build_payload(access_token,
+                                   account_ids: account_ids)
+    end
+  end
+
+  # Public: Response wrapper for /liabilities/get.
+  class LiabilitiesResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The list of accounts: Array of Plaid::Models::Account.
+    property :accounts, coerce: Array[Models::Account]
+
+    ##
+    # :attr_reader:
+    # Public: The liabilities: Plaid::Models::Liabilities.
+    property :liabilities, coerce: Models::Liabilities
+
+    ##
+    # :attr_reader:
+    # Public: The item: Plaid::Models::Item.
+    property :item, coerce: Models::Item
+  end
+end

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '8.0.0'.freeze
+  VERSION = '8.1.0'.freeze
   API_VERSION = '2019-05-29'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2019-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -202,6 +202,7 @@ files:
 - lib/plaid/products/institutions.rb
 - lib/plaid/products/investments.rb
 - lib/plaid/products/item.rb
+- lib/plaid/products/liabilities.rb
 - lib/plaid/products/processor.rb
 - lib/plaid/products/sandbox.rb
 - lib/plaid/products/transactions.rb
@@ -228,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Plaid