plaid 11.1.0 → 13.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 686ab2ca00fca888acdb2df51c73e8c7d69e8392729177b8ffa6fe153b4f12ec
-  data.tar.gz: bf6dcb19a57c770fbe22fe9371236d4e080f1cd536d7a0c433e4dfcfc27f991f
+  metadata.gz: d4032f5d56f2e441caf24526b827c17248114fdcc986fe9595134b180e3b7386
+  data.tar.gz: 1584b89290e96f0ef895e1f3401c51b8914e4391d2c4d9862c76f7b390fe065b
 SHA512:
-  metadata.gz: b9da4ab04bf3b21192eb8b102d11deff836dc26e3ffdcb8e786de03763a701d466b3a53afb22b262ac17fad5ee8e60aa37e1b0ce2d88e4183b4519dbc1ec3a94
-  data.tar.gz: cd282ef9020162621f103c02c82091b37b79265480284523c04bccee2ffef995127bc94da91b6a3d4468b302ebdffb85c7ba88aeaaac9908ba7ba4c9aead339a
+  metadata.gz: a24eef51a825719aa30edb6a3165272f8d38db81d23b3130e5b09a8c33571bfda06e661e030c8c8a1bde0efa60f33fa7a60f22b22a8d5686c691b718c71adb01
+  data.tar.gz: 4ae990701822770f0098b5e48bac694427a3b6a11ffb626a120cdb281db6caf36daee34fe39aaee4866cca0c30e52ab50c2508630ce929f30368f45ab2bca55a

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-    - image: circleci/ruby:2.3
+    - image: circleci/ruby:2.4
     steps:
     - checkout
     - run:

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.4
 
 Style/FrozenStringLiteralComment:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## 13.2.0
+- Add support for `options` to `/payment_initiation/payment/create`
+
+# 13.1.0
+- Add Standing Orders support to Payment Initiation
+
+# 13.0.1
+- Add `update_type` to `Item` model.
+
+# 13.0.0
+- Add support for providing a payment initiation schedule
+- Add back the (now deprecated) `/item/public_token/create` endpoint
+- Add back the (now deprecated) `/payment_initiation/payment/token/create` endpoint
+
+BREAKING CHANGES:
+
+- Update minimum required Ruby version to 2.4
+
+# 12.0.0
+
+- The library has been pinned to the '2020-09-14' API release. Visit the [docs](https://plaid.com/docs/api/versioning/) to see what changed.
+- the `/item/public_token/create` endpoint has been disabled in favor of the /link/token/create
+    endpoint
+- The `/item/add_token/create endpoint` has been disabled in favor of the /link/token/create
+- The `/payment_initiation/payment/token/create` endpoint has been disabled in favor of the /link/token/create
+    endpoint
+- The `/item/remove` endpoint will no longer return a `removed` boolean.
+- The `/institutions/get`, `/institutions/get_by_id`, and `/institutions/search` now require
+    `country_codes` to be passed in.
+
 # 11.1.0
 
 - Add support for Link Token get endpoint ([#301](https://github.com/plaid/plaid-ruby/pull/301))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (11.1.0)
+    plaid (13.2.0)
       faraday
       faraday_middleware
       hashie (>= 3.4.3)
@@ -11,8 +11,15 @@ GEM
   specs:
     ast (2.4.0)
     dotenv (2.4.0)
-    faraday (1.0.1)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     hashie (4.1.0)
@@ -35,6 +42,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
+    ruby2_keywords (0.0.4)
     sdoc (1.0.0)
       rdoc (>= 5.0)
     unicode-display_width (1.3.2)

data/README.md

@@ -1,5 +1,7 @@
 # plaid-ruby [![Circle CI](https://circleci.com/gh/plaid/plaid-ruby.svg?style=svg&circle-token=30ee002ac2021da5b5b5a701d45fe2888af124a5)](https://circleci.com/gh/plaid/plaid-ruby) [![Gem Version](https://badge.fury.io/rb/plaid.svg)](http://badge.fury.io/rb/plaid)
 
+:warning: After 7/12/21, this major version of the library will only receive critical security patches. Please consider trying out our new [beta version](https://github.com/plaid/plaid-ruby/tree/14.0.0-beta-release).
+
 The official Ruby bindings for the [Plaid API](https://plaid.com/docs).
 
 ## Installation
@@ -26,7 +28,8 @@ Each major version of `plaid-ruby` targets a specific version of the Plaid API:
 
 | API version | plaid-ruby release |
 | ----------- | ------------------ |
-| [`2019-05-29`][api-version-2019-05-29] (**latest**) | `9.x.x`, `8.x.x`, `7.x.x` |
+| [`2020-09-14`][api-version-2020-09-14] (**latest**) | `12.x.x` |
+| [`2019-05-29`][api-version-2019-05-29] (**latest**) | `11.x.x`, `10.x.x`, `9.x.x`, `8.x.x`, `7.x.x` |
 | [`2018-05-22`][api-version-2018-05-22] | `6.x.x` |
 | `2017-03-08` | `5.x.x` |
 
@@ -257,6 +260,7 @@ The gem is available as open source under the terms of the [MIT License](http://
 If you're looking for a Ruby client that works with the legacy Plaid API, use the [`plaid-legacy` gem][2].
 
 [2]: https://github.com/plaid/plaid-ruby-legacy
-[version-changelog]: https://plaid.com/docs/api-upgrades
-[api-version-2018-05-22]: https://plaid.com/docs/api-upgrades#2018-05-22
-[api-version-2019-05-29]: https://plaid.com/docs/api-upgrades#2019-05-29
+[version-changelog]: https://plaid.com/docs/api/versioning/
+[api-version-2018-05-22]: https://plaid.com/docs/api/versioning/#2018-05-22
+[api-version-2019-05-29]: https://plaid.com/docs/api/versioning/#2019-05-29
+[api-version-2020-09-14]: https://plaid.com/docs/api/versioning/#2020-09-14

data/lib/plaid/models.rb

@@ -123,6 +123,11 @@ module Plaid
       # Public: The String item ID.
       property :item_id
 
+      ##
+      # :attr_reader:
+      # Public: The String update type.
+      property :update_type
+
       ##
       # :attr_reader:
       # Public: The String webhook URL.
@@ -133,6 +138,11 @@ module Plaid
       # Public: The String consent expiration timestamp (or nil)
       # (e.g. "2019-04-22T00:00:00Z").
       property :consent_expiration_time
+
+      ##
+      # :attr_reader:
+      # Public: The String update type.
+      property :update_type
     end
 
     # Public: A representation of Item webhook status
@@ -734,6 +744,55 @@ module Plaid
       property :item_logins, coerce: InstitutionStatusItemLogins
     end
 
+    # Public: A representation of standing order metadata for an institution.
+    class StandingOrderMetadata < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The Boolean flag indicating if the institution supports
+      # end date for standing orders.
+      property :supports_standing_order_end_date
+
+      ##
+      # :attr_reader:
+      # Public: The Boolean flag indicating if the institution supports
+      # negative execution days for standing orders.
+      property :supports_standing_order_negative_execution_days
+
+      ##
+      # :attr_reader:
+      # Public: The Array of valid standing order intervals for
+      # this institution.
+      # E.g. ["WEEKLY", "MONTHLY"].
+      property :valid_standing_order_intervals
+    end
+
+    # Public: A representation of an institution's payment initiation metadata.
+    class InstitutionPaymentInitiationMetadata < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The map of maximum payment amount per currency for this
+      # institution.
+      # E.g. {"GBP"=>"1000000"}.
+      property :maximum_payment_amount
+
+      ##
+      # :attr_reader:
+      # Public: The standing order metadata for this institution.
+      property :standing_order_metadata, coerce: StandingOrderMetadata
+
+      ##
+      # :attr_reader:
+      # Public: The Boolean flag indicating if the institution supports
+      # international payments.
+      property :supports_international_payments
+
+      ##
+      # :attr_reader:
+      # Public: The Boolean flag indicating if the institution supports
+      # refund details.
+      property :supports_refund_details
+    end
+
     # Public: A representation of Institution.
     class Institution < BaseModel
       @ignored_properties = ['input_spec']
@@ -818,6 +877,13 @@ module Plaid
       # :attr_reader:
       # Public: Indicates that the institution has an OAuth login flow.
       property :oauth
+
+      ##
+      # :attr_reader:
+      # Public: Specifies metadata related to the payment_initiation product
+      # (or nil).
+      property :payment_initiation_metadata,
+               coerce: InstitutionPaymentInitiationMetadata
     end
 
     module MFA
@@ -1924,6 +1990,25 @@ module Plaid
       property :value
     end
 
+    # Public: A representation of a payment amount.
+    class PaymentSchedule < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Interval for the standing order.
+      property :interval
+
+      ##
+      # :attr_reader:
+      # Public: Day or the week or day of the month to execute
+      # the standing order.
+      property :interval_execution_day
+
+      ##
+      # :attr_reader:
+      # Public: Start date for the standing order.
+      property :start_date
+    end
+
     # Public: A representation of a payment amount.
     class PaymentRecipientAddress < BaseModel
       ##
@@ -2010,6 +2095,11 @@ module Plaid
       # Public: The payment amount.
       property :amount, coerce: PaymentAmount
 
+      ##
+      # :attr_reader:
+      # Public: The payment schedule.
+      property :schedule, coerce: PaymentSchedule
+
       ##
       # :attr_reader:
       # Public: The payment's status.
@@ -2029,6 +2119,17 @@ module Plaid
       # :attr_reader:
       # Public: The recipient ID for payment.
       property :recipient_id
+
+      ##
+      # :attr_reader:
+      # Public: An object containing a BACS account number and sort code
+      # for the payer's account.
+      property :bacs
+
+      ##
+      # :attr_reader:
+      # Public: A string containing the IBAN for the payer's account.
+      property :iban
     end
 
     # Public: Metadata associated with a link token.

data/lib/plaid/products/institutions.rb

@@ -11,9 +11,10 @@ module Plaid
     # options - Options for filtering institutions.
     #
     # Returns a MultipleInstitutionsResponse instance.
-    def get(count:, offset:, options: nil)
+    def get(count:, offset:, country_codes:, options: nil)
       payload = { count: count,
-                  offset: offset }
+                  offset: offset,
+                  country_codes: country_codes }
       payload[:options] = options unless options.nil?
 
       post_with_auth 'institutions/get',
@@ -30,9 +31,10 @@ module Plaid
     # options - Options for filtering institutions.
     #
     # Returns a SingleInstitutionResponse instance.
-    def get_by_id(institution_id, options: nil)
+    def get_by_id(institution_id, country_codes, options: nil)
       payload = {
-        institution_id: institution_id
+        institution_id: institution_id,
+        country_codes: country_codes
       }
       payload[:options] = options unless options.nil?
       post_with_auth 'institutions/get_by_id',
@@ -51,10 +53,11 @@ module Plaid
     # options - Options for filtering institutions.
     #
     # Returns a MultipleInstitutionsResponse instance.
-    def search(query, products = nil, options: nil)
+    def search(query, country_codes, products = nil, options: nil)
       payload = {
         query: query,
-        products: products
+        products: products,
+        country_codes: country_codes
       }
 
       payload[:options] = options unless options.nil?

data/lib/plaid/products/item.rb

@@ -25,28 +25,6 @@ module Plaid
     end
   end
 
-  # Public: Class used to call the AddToken sub-product.
-  class AddToken < BaseProduct
-    def create(user)
-      post_with_auth 'item/add_token/create',
-                     CreateResponse,
-                     user: user
-    end
-
-    # Public: Response for /item/add_token/create.
-    class CreateResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The String token.
-      property :add_token
-
-      ##
-      # :attr_reader:
-      # Public: The String token expiration time.
-      property :expiration
-    end
-  end
-
   # Public: Class used to call the PublicToken sub-product
   class PublicToken < BaseProduct
     # Public: Creates a public token from an access_token.
@@ -58,6 +36,10 @@ module Plaid
     #
     # Returns a CreateResponse object with a public token and expiration info.
     def create(access_token)
+      puts 'Warning: this method will be deprecated in a future version. '\
+           'To replace the public_token for initializing Link, look into '\
+           'the link_token at https://plaid.com/docs/api/tokens/#linktokencreate.'
+
       post_with_auth 'item/public_token/create',
                      CreateResponse,
                      access_token: access_token
@@ -146,11 +128,6 @@ module Plaid
     # Public: The Plaid::PublicToken product accessor.
     subproduct :public_token
 
-    ##
-    # :attr_reader:
-    # Public: The Plaid::AddToken product accessor.
-    subproduct :add_token
-
     ##
     # :attr_reader:
     # Public: The Plaid::Webhook product accessor.

data/lib/plaid/products/payment_initiation.rb

@@ -4,9 +4,11 @@ module Plaid
     # Public: Create a recipient.
     #
     # name    - Recipient name.
-    # iban    - Recipient IBAN.
-    # address - Recipient address.
-    # bacs    - Recipient BACS (hash with "account" and "sort_code" keys)
+    # iban    - Recipient IBAN. Should be nil if using bacs.
+    # address - Recipient address (hash with "street", "city", "postal_code"
+    #           and "country"). Best practice is to set it as nil.
+    # bacs    - Recipient BACS (hash with "account" and "sort_code" keys).
+    #           Should be nil if using iban.
     #
     # Returns a PaymentRecipientCreateResponse object.
     def create_recipient(name, iban, address, bacs)
@@ -43,14 +45,25 @@ module Plaid
     # recipient_id - Recipient ID that the payment will be initiated for.
     # reference    - Payment reference.
     # amount       - Payment amount.
+    # schedule     - Payment schedule.
+    # options      - Payment options.
     #
     # Returns a PaymentCreateResponse object.
-    def create_payment(recipient_id, reference, amount)
-      post_with_auth 'payment_initiation/payment/create',
+    def create_payment(
+      recipient_id, reference, amount, schedule: nil, options: nil
+    )
+      create_payment = {
+        'recipient_id': recipient_id,
+        'reference': reference,
+        'amount': amount
+      }
+
+      create_payment['schedule'] = schedule unless schedule.nil?
+      create_payment['options'] = options unless options.nil?
+
+      post_with_auth('payment_initiation/payment/create',
                      PaymentCreateResponse,
-                     recipient_id: recipient_id,
-                     reference: reference,
-                     amount: amount
+                     create_payment)
     end
 
     # Public: Create a payment token.
@@ -59,6 +72,10 @@ module Plaid
     #
     # Returns a PaymentTokenCreateResponse object.
     def create_payment_token(payment_id)
+      puts 'Warning: this method will be deprecated in a future version. '\
+           'To replace the payment_token, look into the link_token at '\
+           'https://plaid.com/docs/api/tokens/#linktokencreate.'
+
       post_with_auth 'payment_initiation/payment/token/create',
                      PaymentTokenCreateResponse,
                      payment_id: payment_id
@@ -181,6 +198,11 @@ module Plaid
     # Public: The payment amount.
     property :amount, coerce: Models::PaymentAmount
 
+    ##
+    # :attr_reader:
+    # Public: The payment schedule.
+    property :schedule, coerce: Models::PaymentSchedule
+
     ##
     # :attr_reader:
     # Public: The payment's status.
@@ -200,6 +222,17 @@ module Plaid
     # :attr_reader:
     # Public: The recipient ID for payment.
     property :recipient_id
+
+    ##
+    # :attr_reader:
+    # Public: An object containing a BACS account number and sort code
+    # for the payer's account.
+    property :bacs
+
+    ##
+    # :attr_reader:
+    # Public: A string containing the IBAN for the payer's account.
+    property :iban
   end
 
   # Public: The response wrapper for /payment_initiation/payment/list.

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '11.1.0'.freeze
-  API_VERSION = '2019-05-29'.freeze
+  VERSION = '13.2.0'.freeze
+  API_VERSION = '2020-09-14'.freeze
 end

data/plaid.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.4.0'
 
   spec.add_dependency 'faraday'
   spec.add_dependency 'faraday_middleware'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 11.1.0
+  version: 13.2.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -226,7 +226,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="