plaid 8.0.0 → 8.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/plaid.rb +1 -0
- data/lib/plaid/client.rb +5 -0
- data/lib/plaid/models.rb +224 -0
- data/lib/plaid/products/liabilities.rb +39 -0
- data/lib/plaid/version.rb +1 -1
- metadata +4 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1b5b0c86b267fc7ea3614ee8768c08add645832a
|
4
|
+
data.tar.gz: ebdabcd25e4812284f32e5c7e9c05a2d75f4eaa7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 36b86b9fe94a5b0ab84ed3a76ce7ab1352561be1c1ad0ce510dfd69b28ec16cc4451112bbd411d372b60d0e88d5101efcffbd52a876faca22d4f27dd7f383f76
|
7
|
+
data.tar.gz: 6f03c6dc683c52845519627ac96a6b0c872190bf180ef0e61d388b6b8c8090ff0e243d96a8044bb1136b03a56d805474a4f93684c58a1ddba55c28fbff775d8f
|
data/CHANGELOG.md
CHANGED
data/lib/plaid.rb
CHANGED
@@ -19,6 +19,7 @@ require_relative 'plaid/products/processor'
|
|
19
19
|
require_relative 'plaid/products/sandbox'
|
20
20
|
require_relative 'plaid/products/transactions'
|
21
21
|
require_relative 'plaid/products/investments'
|
22
|
+
require_relative 'plaid/products/liabilities'
|
22
23
|
require_relative 'plaid/client'
|
23
24
|
|
24
25
|
# Public: The namespace for all the things Plaid.
|
data/lib/plaid/client.rb
CHANGED
@@ -77,6 +77,11 @@ module Plaid
|
|
77
77
|
# Public: The Plaid::Item product accessor.
|
78
78
|
subproduct :item
|
79
79
|
|
80
|
+
##
|
81
|
+
# :attr_reader:
|
82
|
+
# Public: The Plaid::Liabilities product accessor.
|
83
|
+
subproduct :liabilities
|
84
|
+
|
80
85
|
##
|
81
86
|
# :attr_reader:
|
82
87
|
# Public: The Plaid::Processor product accessor.
|
data/lib/plaid/models.rb
CHANGED
@@ -782,6 +782,11 @@ module Plaid
|
|
782
782
|
# :attr_reader:
|
783
783
|
# Public: The Array of String country codes supported by this institution.
|
784
784
|
property :country_codes
|
785
|
+
|
786
|
+
##
|
787
|
+
# :attr_reader:
|
788
|
+
# Public: The array of routing numbers associated with this institution.
|
789
|
+
property :routing_numbers
|
785
790
|
end
|
786
791
|
|
787
792
|
module MFA
|
@@ -1582,5 +1587,224 @@ module Plaid
|
|
1582
1587
|
# Asset Report; see AssetReportItem object for fields.
|
1583
1588
|
property :items, coerce: Array[AssetReportItem]
|
1584
1589
|
end
|
1590
|
+
|
1591
|
+
# Public: A representation of an eligibility for the Public Service Loan
|
1592
|
+
# Forgiveness program.
|
1593
|
+
class PSLFStatus < BaseModel
|
1594
|
+
##
|
1595
|
+
# :attr_reader:
|
1596
|
+
# Public: The estimated date borrower will have completed 120 qualifying
|
1597
|
+
# monthly payments.
|
1598
|
+
property :estimated_eligibility_date
|
1599
|
+
|
1600
|
+
##
|
1601
|
+
# :attr_reader:
|
1602
|
+
# Public: The number of qualifying payments that have been made.
|
1603
|
+
property :payments_made
|
1604
|
+
|
1605
|
+
##
|
1606
|
+
# :attr_reader:
|
1607
|
+
# Public: The number of qualifying payments that are remaining.
|
1608
|
+
property :payments_remaining
|
1609
|
+
end
|
1610
|
+
|
1611
|
+
# Public: A representation of the status of a student loan.
|
1612
|
+
class StudentLoanStatus < BaseModel
|
1613
|
+
##
|
1614
|
+
# :attr_reader:
|
1615
|
+
# Public: The status of the loan, e.g. "repayment", "deferment",
|
1616
|
+
# "forbearance".
|
1617
|
+
property :type
|
1618
|
+
|
1619
|
+
##
|
1620
|
+
# :attr_reader:
|
1621
|
+
# Public: The date the status expires.
|
1622
|
+
property :end_date
|
1623
|
+
end
|
1624
|
+
|
1625
|
+
# Public: A representation of a student loan repayment plan.
|
1626
|
+
class StudentLoanRepaymentPlan < BaseModel
|
1627
|
+
##
|
1628
|
+
# :attr_reader:
|
1629
|
+
# Public: The type of repayment plan, e.g., "standard", "income".
|
1630
|
+
property :type
|
1631
|
+
|
1632
|
+
##
|
1633
|
+
# :attr_reader:
|
1634
|
+
# Public: The full name of the repayment plan, e.g. "Standard Repayment".
|
1635
|
+
property :description
|
1636
|
+
end
|
1637
|
+
|
1638
|
+
# Public: A representation of a student loan servicer address.
|
1639
|
+
class StudentLoanServicerAddress < BaseModel
|
1640
|
+
##
|
1641
|
+
# :attr_reader:
|
1642
|
+
# Public: The full city name
|
1643
|
+
property :city
|
1644
|
+
|
1645
|
+
##
|
1646
|
+
# :attr_reader:
|
1647
|
+
# Public: The ISO 3166-1 alpha-2 country code
|
1648
|
+
property :country
|
1649
|
+
|
1650
|
+
##
|
1651
|
+
# :attr_reader:
|
1652
|
+
# Public: The postal code.
|
1653
|
+
property :postal_code
|
1654
|
+
|
1655
|
+
##
|
1656
|
+
# :attr_reader:
|
1657
|
+
# Public: The region or state.
|
1658
|
+
property :region
|
1659
|
+
|
1660
|
+
##
|
1661
|
+
# :attr_reader:
|
1662
|
+
# Public: The full street address.
|
1663
|
+
property :street
|
1664
|
+
end
|
1665
|
+
|
1666
|
+
# Public: A representation of a student loan liability.
|
1667
|
+
class StudentLoanLiability < BaseModel
|
1668
|
+
##
|
1669
|
+
# :attr_reader:
|
1670
|
+
# Public: The String account ID. E.g.
|
1671
|
+
# "vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D".
|
1672
|
+
property :account_id
|
1673
|
+
|
1674
|
+
##
|
1675
|
+
# :attr_reader:
|
1676
|
+
# Public: The account number of the loan.
|
1677
|
+
property :account_number
|
1678
|
+
|
1679
|
+
##
|
1680
|
+
# :attr_reader:
|
1681
|
+
# Public: The dates on which loaned funds were disbursed or will be
|
1682
|
+
# disbursed. These are often in the past.
|
1683
|
+
property :disbursement_dates
|
1684
|
+
|
1685
|
+
##
|
1686
|
+
# :attr_reader:
|
1687
|
+
# Public: The date when the student loan is expected to be paid off.
|
1688
|
+
property :expected_payoff_date
|
1689
|
+
|
1690
|
+
##
|
1691
|
+
# :attr_reader:
|
1692
|
+
# Public: The guarantor of the student loan.
|
1693
|
+
property :guarantor
|
1694
|
+
|
1695
|
+
##
|
1696
|
+
# :attr_reader:
|
1697
|
+
# Public: The interest rate on loans shown as a percentage.
|
1698
|
+
property :interest_rate_percentage
|
1699
|
+
|
1700
|
+
##
|
1701
|
+
# :attr_reader:
|
1702
|
+
# Public: True if a payment is currently overdue.
|
1703
|
+
property :is_overdue
|
1704
|
+
|
1705
|
+
##
|
1706
|
+
# :attr_reader:
|
1707
|
+
# Public: The amount of the last payment.
|
1708
|
+
property :last_payment_amount
|
1709
|
+
|
1710
|
+
##
|
1711
|
+
# :attr_reader:
|
1712
|
+
# Public: The date of the last payment.
|
1713
|
+
property :last_payment_date
|
1714
|
+
|
1715
|
+
##
|
1716
|
+
# :attr_reader:
|
1717
|
+
# Public: The outstanding balance on the last statement.
|
1718
|
+
property :last_statement_balance
|
1719
|
+
|
1720
|
+
##
|
1721
|
+
# :attr_reader:
|
1722
|
+
# Public: The date the last statement was issued.
|
1723
|
+
property :last_statement_issue_date
|
1724
|
+
|
1725
|
+
##
|
1726
|
+
# :attr_reader:
|
1727
|
+
# Public: The status of the loan, e.g. "Repayment", "Deferment",
|
1728
|
+
# "Forbearance".
|
1729
|
+
property :loan_status, coerce: StudentLoanStatus
|
1730
|
+
|
1731
|
+
##
|
1732
|
+
# :attr_reader:
|
1733
|
+
# Public: The type of loan, e.g., "Consolidation Loans".
|
1734
|
+
property :loan_name
|
1735
|
+
|
1736
|
+
##
|
1737
|
+
# :attr_reader:
|
1738
|
+
# Public: The minimum payment due for the next billing cycle.
|
1739
|
+
property :minimum_payment_amount
|
1740
|
+
|
1741
|
+
##
|
1742
|
+
# :attr_reader:
|
1743
|
+
# Public: The due date for the next payment.
|
1744
|
+
property :next_payment_due_date
|
1745
|
+
|
1746
|
+
##
|
1747
|
+
# :attr_reader:
|
1748
|
+
# Public: The date on which the loan was initially lent.
|
1749
|
+
property :origination_date
|
1750
|
+
|
1751
|
+
##
|
1752
|
+
# :attr_reader:
|
1753
|
+
# Public: The original principal balance of the loan.
|
1754
|
+
property :origination_principal_amount
|
1755
|
+
|
1756
|
+
##
|
1757
|
+
# :attr_reader:
|
1758
|
+
# Public: The dollar amount of the accrued interest balance.
|
1759
|
+
property :outstanding_interest_amount
|
1760
|
+
|
1761
|
+
##
|
1762
|
+
# :attr_reader:
|
1763
|
+
# Public: The relevant account number that should be used to reference
|
1764
|
+
# this loan for payments. This is sometimes different from
|
1765
|
+
# account_number.
|
1766
|
+
property :payment_reference_number
|
1767
|
+
|
1768
|
+
##
|
1769
|
+
# :attr_reader:
|
1770
|
+
# Public: Information about the student's eligibility in the Public
|
1771
|
+
# Service Loan Forgiveness program.
|
1772
|
+
property :pslf_status, coerce: PSLFStatus
|
1773
|
+
|
1774
|
+
##
|
1775
|
+
# :attr_reader:
|
1776
|
+
# Public: Information about the repayment plan.
|
1777
|
+
property :repayment_plan, coerce: StudentLoanRepaymentPlan
|
1778
|
+
|
1779
|
+
##
|
1780
|
+
# :attr_reader:
|
1781
|
+
# Public: The sequence number of the student loan.
|
1782
|
+
property :sequence_number
|
1783
|
+
|
1784
|
+
##
|
1785
|
+
# :attr_reader:
|
1786
|
+
# Public: The servicer address for which payments should be sent.
|
1787
|
+
property :servicer_address, coerce: StudentLoanServicerAddress
|
1788
|
+
|
1789
|
+
##
|
1790
|
+
# :attr_reader:
|
1791
|
+
# Public: The year to date (YTD) interest paid.
|
1792
|
+
property :ytd_interest_paid
|
1793
|
+
|
1794
|
+
##
|
1795
|
+
# :attr_reader:
|
1796
|
+
# Public: The year to date (YTD) principal paid.
|
1797
|
+
property :ytd_principal_paid
|
1798
|
+
end
|
1799
|
+
|
1800
|
+
# Public: A representation of someone's liabilities of all types.
|
1801
|
+
class Liabilities < BaseModel
|
1802
|
+
include Hashie::Extensions::IgnoreUndeclared
|
1803
|
+
|
1804
|
+
##
|
1805
|
+
# :attr_reader:
|
1806
|
+
# Public: Student loan liabilities associated with the item.
|
1807
|
+
property :student, coerce: Array[StudentLoanLiability]
|
1808
|
+
end
|
1585
1809
|
end
|
1586
1810
|
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
module Plaid
|
2
|
+
# Public: Class used to call the Liabilities product.
|
3
|
+
class Liabilities < BaseProduct
|
4
|
+
# Public: Get liabilities information.
|
5
|
+
#
|
6
|
+
# Does a POST /liabilities/get call which fetches liabilities associated
|
7
|
+
# with an access_token's item.
|
8
|
+
#
|
9
|
+
# access_token - access_token of an item to fetch liabilities for.
|
10
|
+
# account_ids - Specific account ids to fetch liabilities for
|
11
|
+
# (optional).
|
12
|
+
#
|
13
|
+
# Returns the LiabilitiesResponse object with liabilities data.
|
14
|
+
def get(access_token, account_ids: nil)
|
15
|
+
post_with_auth 'liabilities/get',
|
16
|
+
LiabilitiesResponse,
|
17
|
+
build_payload(access_token,
|
18
|
+
account_ids: account_ids)
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
# Public: Response wrapper for /liabilities/get.
|
23
|
+
class LiabilitiesResponse < Models::BaseResponse
|
24
|
+
##
|
25
|
+
# :attr_reader:
|
26
|
+
# Public: The list of accounts: Array of Plaid::Models::Account.
|
27
|
+
property :accounts, coerce: Array[Models::Account]
|
28
|
+
|
29
|
+
##
|
30
|
+
# :attr_reader:
|
31
|
+
# Public: The liabilities: Plaid::Models::Liabilities.
|
32
|
+
property :liabilities, coerce: Models::Liabilities
|
33
|
+
|
34
|
+
##
|
35
|
+
# :attr_reader:
|
36
|
+
# Public: The item: Plaid::Models::Item.
|
37
|
+
property :item, coerce: Models::Item
|
38
|
+
end
|
39
|
+
end
|
data/lib/plaid/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: plaid
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 8.
|
4
|
+
version: 8.1.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Edmund Loo
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-07-
|
11
|
+
date: 2019-07-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|
@@ -202,6 +202,7 @@ files:
|
|
202
202
|
- lib/plaid/products/institutions.rb
|
203
203
|
- lib/plaid/products/investments.rb
|
204
204
|
- lib/plaid/products/item.rb
|
205
|
+
- lib/plaid/products/liabilities.rb
|
205
206
|
- lib/plaid/products/processor.rb
|
206
207
|
- lib/plaid/products/sandbox.rb
|
207
208
|
- lib/plaid/products/transactions.rb
|
@@ -228,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
228
229
|
version: '0'
|
229
230
|
requirements: []
|
230
231
|
rubyforge_project:
|
231
|
-
rubygems_version: 2.5.
|
232
|
+
rubygems_version: 2.5.1
|
232
233
|
signing_key:
|
233
234
|
specification_version: 4
|
234
235
|
summary: Ruby bindings for Plaid
|