plaid 9.0.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b01d399843f5783e0e0cf64e88392b8c883eb29288d8c0535c1b7fbc9c34c32
-  data.tar.gz: 8c267612077441ef461b8b590f4a40959d680085558d42145b0cc2d179e5a726
+  metadata.gz: faecc884c6c66ec104dda0a142bff5968dcfff6bbf205a5cd4ec9d02d69644e4
+  data.tar.gz: 63abb65cc3d5c5bf9bb9fd85bb78770fb54214161505e2575e890406363e62d6
 SHA512:
-  metadata.gz: e976a0ba72f8a33ac057ce3fe0589324934c8e292a314acc33ad9014999fa8e230beb15b45ee02a8f55a4c3c0b12c668a453091f1f9d091ac16add0575217038
-  data.tar.gz: 9b91b0105aa3ac0450d6bc38158390ebff5bc70066eb2d61924cd17039c7a9f670a9d1282169b38a2fb3ca860cf4af9ef14082ae992cdfe5b309bcb9a80b01f8
+  metadata.gz: 26a5e5ba54760e4c7193fc426e6f4187ef68250364fb16bea231a15ed9cf6a3a92d62743318613700470118699d0bc2ce91871ba3b74d931994c04ed0fccf6a4
+  data.tar.gz: e7a469afdd3bad0b6788f8f6de647065ce8bb1187375ba3595e694529959eaab871819a95767fdd5a769b147c21b0f7620ae9bb5de4f8a010c3773923aa55737

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 10.0.0
+
+- Add support for optional user fields for `/item/add_token/create` endpoint ([278](https://github.com/plaid/plaid-ruby/pull/278))
+- Add support for credit card liabilities ([286](https://github.com/plaid/plaid-ruby/pull/286))
+
+BREAKING CHANGES:
+
+- `RATE_LIMIT_EXCEEDED` Plaid error types will be correctly mapped to `RateLimitExceededError` ([285](https://github.com/plaid/plaid-ruby/pull/285))
+- `INSTITUTION_ERROR` Plaid error types will be correctly mapped to `InstitutionError` ([275](https://github.com/plaid/plaid-ruby/pull/275))
+- Enable payment recipient to be created with BACS ([288](https://github.com/plaid/plaid-ruby/pull/288))
+
 # 9.0.0
 
 - Adds support for `/sandbox/item/set_verification_status`

data/PUBLISH.md

@@ -2,13 +2,18 @@
 
 The module is published to [RubyGems][1] under the gem name [plaid][2].
 
-To publish:
+Prepare release:
 
-1. `rake test` (runs the test suite locally).
-2. Update, commit, and merge (with review) the `lib/plaid/version.rb` and `CHANGELOG.md` files. 
-5. `git pull` (makes sure your `HEAD` is up-to-date).
-6. `rake release` (builds the gem, creates a tag, pushes the gem to RubyGems and tag to GitHub).
-7. `rake update_github_docs` (generates RDoc files, updates `gh-pages` branch and pushes it to GitHub). (If you run into a `gh-pages` branch error, you may need to manually run `git checkout gh-pages` to ensure the branch is checked out locally.)
+1. update `lib/plaid/version.rb`, and `CHANGELOG.md` files.
+2. run `bundle` to bump the version in `Gemfile.lock`
+3. create and merge a PR with the changes from 1 and 2.
+
+Publish:
+
+1. `git checkout master` and `git pull` (makes sure your `HEAD` is up-to-date).
+2. Check that tests are passing on latest `master` build and (optional) `bundle exec rake test` to run tests locally
+3. `bundle exec rake release` (builds the gem, creates a tag, pushes the gem to RubyGems and tag to GitHub).
+4. `bundle exec rake update_github_docs` (generates RDoc files, updates `gh-pages` branch and pushes it to GitHub). (If you run into a `gh-pages` branch error, you may need to manually run `git checkout gh-pages` to ensure the branch is checked out locally.)
 
 [1]: https://rubygems.org/
 [2]: https://rubygems.org/gems/plaid

data/README.md

@@ -208,6 +208,8 @@ Any methods making API calls will result in an exception raised unless the respo
 
 `Plaid::ItemError` indicates that information provided for the Item (such as credentials or MFA) may be invalid or that the Item is not supported on Plaid's platform.
 
+`Plaid::InstitutionError` is returned when there are errors for the requested financial institution.
+
 Read more about response codes and their meaning in the
 [Plaid documentation](https://plaid.com/docs/api).
 

data/lib/plaid/errors.rb

@@ -58,14 +58,19 @@ TEXT
   # Plaid's platform.
   class ItemError              < PlaidAPIError; end
 
+  # Public: Returned when there are errors for the requested financial
+  # institution.
+  class InstitutionError       < PlaidAPIError; end
+
   # Internal: A module that provides utilities for errors.
   module Error
     ERROR_TYPE_MAP = {
       'INVALID_REQUEST' => Plaid::InvalidRequestError,
       'INVALID_INPUT' => Plaid::InvalidInputError,
-      'RATE_LIMIT_EXCEEDED_ERROR' => Plaid::RateLimitExceededError,
+      'RATE_LIMIT_EXCEEDED' => Plaid::RateLimitExceededError,
       'API_ERROR' => Plaid::APIError,
-      'ITEM_ERROR' => Plaid::ItemError
+      'ITEM_ERROR' => Plaid::ItemError,
+      'INSTITUTION_ERROR' => Plaid::InstitutionError
     }.freeze
 
     # Internal: Map error_type to PlaidAPIError.

data/lib/plaid/models.rb

@@ -1812,6 +1812,84 @@ module Plaid
       property :ytd_principal_paid
     end
 
+    # Public: A representation of a credit card liability APR
+    class CreditCardLiabilityAPRs < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Annual Percentage Rate applied.
+      property :apr_percentage
+
+      ##
+      # :attr_reader:
+      # Public: Enumerated response from the following options:
+      # "balance_transfer_apr", "cash_apr", "purchase_apr", or
+      # "special".
+      property :apr_type
+
+      ##
+      # :attr_reader:
+      # Public: Amount of money that is subjected to the APR if a
+      # balance was carried beyond payment due date. How it is
+      # calculated can vary by card issuer. It is often calculated as
+      # an average daily balance.
+      property :balance_subject_to_apr
+
+      ##
+      # :attr_reader:
+      # Public: Amount of money charged due to interest from last
+      # statement.
+      property :interest_charge_amount
+    end
+
+    # Public: A representation of a credit card liability
+    class CreditCardLiability < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The ID of the account that this liability belongs to.
+      property :account_id
+
+      ##
+      # :attr_reader:
+      # Public: See the APR object schema
+      property :aprs, coerce: Array[CreditCardLiabilityAPRs]
+
+      ##
+      # :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 of the last statement.
+      property :last_statement_issue_date
+
+      ##
+      # :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. The due date is null
+      # if a payment is not expected.
+      property :next_payment_due_date
+    end
+
     # Public: A representation of someone's liabilities of all types.
     class Liabilities < BaseModel
       include Hashie::Extensions::IgnoreUndeclared
@@ -1820,6 +1898,11 @@ module Plaid
       # :attr_reader:
       # Public: Student loan liabilities associated with the item.
       property :student, coerce: Array[StudentLoanLiability]
+
+      ##
+      # :attr_reader:
+      # Public: Credit card liabilities associated with the item.
+      property :credit, coerce: Array[CreditCardLiability]
     end
 
     # Public: A representation of a payment amount.
@@ -1858,6 +1941,19 @@ module Plaid
       property :country
     end
 
+    # Public: A representation of a payment recipient BACS number.
+    class PaymentRecipientBACS < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The String account number. E.g. "66374958".
+      property :account
+
+      ##
+      # :attr_reader:
+      # Public: The String sort code. E.g. "089999".
+      property :sort_code
+    end
+
     # Public: A representation of a payment recipient.
     class PaymentRecipient < BaseModel
       ##
@@ -1875,6 +1971,11 @@ module Plaid
       # Public: The recipient IBAN.
       property :iban
 
+      ##
+      # :attr_reader:
+      # Public: The recipient BACS number .
+      property :bacs, coerce: PaymentRecipientBACS
+
       ##
       # :attr_reader:
       # Public: The recipient address.

data/lib/plaid/products/payment_initiation.rb

@@ -6,13 +6,15 @@ module Plaid
     # name    - Recipient name.
     # iban    - Recipient IBAN.
     # address - Recipient address.
+    # bacs    - Recipient BACS (hash with "account" and "sort_code" keys)
     #
     # Returns a PaymentRecipientCreateResponse object.
-    def create_recipient(name, iban, address)
+    def create_recipient(name, iban, address, bacs)
       post_with_auth 'payment_initiation/recipient/create',
                      PaymentRecipientCreateResponse,
                      name: name,
                      iban: iban,
+                     bacs: bacs,
                      address: address
     end
 
@@ -112,6 +114,11 @@ module Plaid
     # Public: The recipient IBAN.
     property :iban
 
+    ##
+    # :attr_reader:
+    # Public: The recipient IBAN.
+    property :bacs, coerce: Models::PaymentRecipientBACS
+
     ##
     # :attr_reader:
     # Public: The recipient address.

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '9.0.0'.freeze
+  VERSION = '10.0.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: 9.0.0
+  version: 10.0.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday