plaid 10.1.0 → 13.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67b2fb1563bb0f5dc21d092bd5ae83e043f7cd1f48728dc47eb094325dbf340d
-  data.tar.gz: '09ed65928719206c075b22ccb8dbba5929b2c309bca6f329071dac1a24b4db29'
+  metadata.gz: 889bbda3066333276dde988cc70df8d2b858685b9afa425ff18505073836b3a8
+  data.tar.gz: 563c58e930b00fa84d2ef79945139ce8267730433549964953cf26984ee30219
 SHA512:
-  metadata.gz: ede7755a232da3df4d8a464d77ccaa828ffba99e14d6677f0f85edcf21445475bf894a7dc7cbffccca38d9aed6fd3ee75f5591807460b05507213acc2c96cc8b
-  data.tar.gz: fc9cd109f8d7ee3fb75c323f10ea726e6cedd76000f260cbdce26b362e069eb1979cd3de853f5c6158e35f0e04546347620f0144a21e7331e0d90f4d1b7c4364
+  metadata.gz: 47a70ded60dc17d5517f9df0699a66b61aac31f0d02110b0123d7eb4b11e9129aa2f3033eba6fb4a04ac37740f7f2bd4618e45092ab4762f7b9c9c64890718ab
+  data.tar.gz: 9864f80769148aa5a2ebce0d488bf1518d8e0ec7868daf31084ba53b97e376ea337f1817afe558f7a1863e60e1acd079846423983dd9a5db1f4f07104308103c

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/.github/workflows/add_to_project.yml

@@ -0,0 +1,21 @@
+name: Auto Assign to CLIB Project
+
+on:
+  issues:
+    types: [opened]
+  pull_request:
+    types: [opened]
+env:
+  MY_GITHUB_TOKEN: ${{ secrets.CLIB_AUTOMATION_TOKEN }
+
+jobs:
+  assign_one_project:
+    runs-on: ubuntu-latest
+    name: Assign to One Project
+    steps:
+    - name: Assign NEW issues and NEW pull requests to project 1
+      uses: srggrs/assign-one-project-github-action@1.2.0
+      if: github.event.action == 'opened'
+      with:
+        project: 'https://github.com/orgs/plaid/projects/1'
+        column_name: 'Needs Investigation'

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.4
 
 Style/FrozenStringLiteralComment:
   Enabled: false
@@ -8,7 +8,7 @@ Layout/IndentHeredoc:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 20
+  Enabled: false
 
 Metrics/MethodLength:
   Max: 20

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+# 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))
+  - `link/token/get`
+
+# 11.0.0
+
+- Add `merchant_name` to `Transaction` (#294)
+
+BREAKING CHANGES:
+
+- Removes the public key as input to `Client`. The public key is no longer needed by the API. (#287)
+- Add link/token/create support (#293)
+
 # 10.1.0
 
 - Add support for more options (`override_username`, `override_password`) in the `/sandbox/public_token/create` endpoint ([219](https://github.com/plaid/plaid-ruby/pull/219))

data/CONTRIBUTING.md

@@ -8,14 +8,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 The gem test suite can be run in two modes. By default, it runs against the
 live sandbox environment, creating items on the fly and calling various API
-endpoints for them. For this to work you'll need real `client_id`, `secret`,
-and `public_key` from your Plaid dashboard. Create a file named `.env`
-based on `.env.sample` which is provided:
+endpoints for them. For this to work you'll need real `client_id` and `secret`
+from your Plaid dashboard. Create a file named `.env` based on `.env.sample`
+which is provided:
 
 ```text
 PLAID_RUBY_CLIENT_ID=the_real_client_id
 PLAID_RUBY_SECRET=the_real_secret
-PLAID_RUBY_PUBLIC_KEY=the_real_public_key
 ```
 This file will be loaded during the tests.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (10.1.0)
+    plaid (13.0.1)
       faraday
       faraday_middleware
       hashie (>= 3.4.3)
@@ -11,8 +11,11 @@ GEM
   specs:
     ast (2.4.0)
     dotenv (2.4.0)
-    faraday (1.0.1)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     hashie (4.1.0)
@@ -35,6 +38,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/PUBLISH.md

@@ -7,12 +7,13 @@ Prepare release:
 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.
+4. authenticate with rubygems with `gem signin` or manually set up your `~/.gem/credentials`
 
 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).
+3. `bundle exec rake release` (builds the gem, creates a tag, pushes the gem to RubyGems and tag to GitHub). **NOTE:** if this step hangs indefinitely, you need to set your MFA settings to "UI Only" [here](https://rubygems.org/profile/edit)
 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/

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: This major version of the library will only receive critical security patches after 7/12/21. 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` |
 
@@ -41,15 +44,14 @@ The RubyDoc for the gem is available [here](http://plaid.github.io/plaid-ruby/).
 
 ### Creating a Plaid client
 
-Create an instance of the client using the `client_id`, `secret`, and `public_key` from your Plaid dashboard along with your environment of choice:
+Create an instance of the client using the `client_id` and `secret` from your Plaid dashboard along with your environment of choice:
 
 ```ruby
 require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 ```
 
 The `env` field is the environment which the client will be running in. Your choices for the `env` field include:
@@ -63,7 +65,7 @@ The `env` field is the environment which the client will be running in. Your cho
 The gem uses Faraday to wrap HTTPS connections, which allows you to tune certain params:
 
 ```ruby
-client = Plaid::Client.new(env: :sandbox, client_id: '***', secret: '***', public_key: '***') do |builder|
+client = Plaid::Client.new(env: :sandbox, client_id: '***', secret: '***') do |builder|
   Plaid::Client.build_default_connection(builder)
 
   # Increase network timeout
@@ -73,6 +75,27 @@ end
 
 ## Examples
 
+### Create a new link_token
+
+```ruby
+# Grab the client_user_id by searching for the current user in your database
+user = User.find_by!(email: '***')
+client_user_id = user.id
+
+# Create the link_token with all of your configurations
+link_token_response = client.link_token.create(
+  user: { client_user_id: client_user_id.to_s },
+  client_name: 'My app',
+  products: %w[auth transactions],
+  country_codes: ['US'],
+  language: 'en'
+)
+
+# Pass the result to your client-side app to initialize Link
+#  and retrieve a public_token
+link_token = link_token_response.link_token
+```
+
 ### Exchanging a Link public_token for a Plaid access_token
 
 If you have a [Link](https://github.com/plaid/link) `public token`, use this function to get an `access_token`: `client.item.public_token.exchange(public_token)`
@@ -84,6 +107,7 @@ response = client.item.public_token.exchange(public_token)
 access_token = response.access_token
 ```
 
+
 ### Deleting an item
 
 ```ruby
@@ -91,8 +115,7 @@ require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 
 exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
 access_token = exchange_token_response.access_token
@@ -107,8 +130,7 @@ require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 
 exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
 access_token = exchange_token_response.access_token
@@ -136,8 +158,7 @@ require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 
 exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
 access_token = exchange_token_response.access_token
@@ -154,8 +175,7 @@ require 'plaid'
 
 client = Plaid::Client.new(env: :sandbox,
                            client_id: '***',
-                           secret: '***',
-                           public_key: '***')
+                           secret: '***')
 
 exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
 access_token = exchange_token_response.access_token
@@ -240,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/Rakefile

@@ -54,7 +54,7 @@ end
 
 desc 'Hide real credentials in VCR cassettes'
 task :vcr_hide_credentials do
-  all_creds = %w[PLAID_RUBY_CLIENT_ID PLAID_RUBY_SECRET PLAID_RUBY_PUBLIC_KEY]
+  all_creds = %w[PLAID_RUBY_CLIENT_ID PLAID_RUBY_SECRET]
 
   all_creds.each do |cred|
     raise "#{cred} is not set" unless ENV[cred]

data/lib/plaid.rb

@@ -21,6 +21,7 @@ require_relative 'plaid/products/sandbox'
 require_relative 'plaid/products/transactions'
 require_relative 'plaid/products/investments'
 require_relative 'plaid/products/liabilities'
+require_relative 'plaid/products/link_token'
 require_relative 'plaid/products/payment_initiation'
 require_relative 'plaid/products/webhooks'
 require_relative 'plaid/client'

data/lib/plaid/client.rb

@@ -19,13 +19,11 @@ module Plaid
     # env        - The Symbol (:sandbox, :development, :production)
     # client_id  - The String Plaid account client ID to authenticate requests
     # secret     - The String Plaid account secret to authenticate requests
-    # public_key - The String Plaid account public key to authenticate requests
-    def initialize(env:, client_id:, secret:, public_key:, &block)
+    def initialize(env:, client_id:, secret:, &block)
       @env        = env.to_sym
       @api_host   = api_host
       @client_id  = client_id
       @secret     = secret
-      @public_key = public_key
 
       create_connection(&block)
     end
@@ -117,6 +115,11 @@ module Plaid
     # Public: The Plaid::Webhooks endpoint accessor.
     subproduct :webhooks
 
+    ##
+    ## :attr_reader:
+    ## Public: The Plaid::LinkToken endpoint accessor.
+    subproduct :link_token
+
     # Public: Make a post request
     #
     # path    - Path or URL to make the request to
@@ -140,16 +143,6 @@ module Plaid
       ).body
     end
 
-    # Public: Make a post request with appended public key field.
-    #
-    # path    - Path or URL to make the request to.
-    # payload - The payload or data to post.
-    #
-    # Returns the resulting parsed JSON of the request.
-    def post_with_public_key(path, payload)
-      @connection.post(path, payload.merge(public_key: @public_key)).body
-    end
-
     # Public: Set Plaid defaults on the Faraday connection.
     #
     # builder - The Faraday builder object.

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
@@ -976,6 +986,12 @@ module Plaid
       # Public: The location where transaction occurred (TransactionLocation).
       property :location, coerce: TransactionLocation
 
+      ##
+      # :attr_reader:
+      # Public: The String merchant name (or nil).
+      # E.g. "Burger King".
+      property :merchant_name
+
       ##
       # :attr_reader:
       # Public: The String transaction name (or nil).
@@ -1918,6 +1934,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
       ##
@@ -2004,6 +2039,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.
@@ -2025,6 +2065,44 @@ module Plaid
       property :recipient_id
     end
 
+    # Public: Metadata associated with a link token.
+    class LinkTokenMetadata < BaseModel
+      ##
+      # :attr_reader:
+      # Public: List of products associated with the link token.
+      property :initial_products
+
+      ##
+      # :attr_reader:
+      # Public: The webhook associated with the link token.
+      property :webhook
+
+      ##
+      # :attr_reader:
+      # Public: The country codes associated with the link token.
+      property :country_codes
+
+      ##
+      # :attr_reader:
+      # Public: The language associated with the link token.
+      property :language
+
+      ##
+      # :attr_reader:
+      # Public: The account filters associated with the link token.
+      property :account_filters
+
+      ##
+      # :attr_reader:
+      # Public: The redirect URI associated with the link token.
+      property :redirect_uri
+
+      ##
+      # :attr_reader:
+      # Public: The client name associated with the link token.
+      property :client_name
+    end
+
     # Public: A representation of a payment amount.
     class WebhookVerificationKey < BaseModel
       ##

data/lib/plaid/products/base_product.rb

@@ -60,10 +60,5 @@ module Plaid
     def post_with_auth(path, response_class, payload)
       response_class.new(client.post_with_auth(path, payload))
     end
-
-    # Internal: Do a POST to API and capture it into a response object.
-    def post_with_public_key(path, response_class, payload)
-      response_class.new(client.post_with_public_key(path, payload))
-    end
   end
 end

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,14 +31,15 @@ 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_public_key 'institutions/get_by_id',
-                           SingleInstitutionResponse,
-                           payload
+      post_with_auth 'institutions/get_by_id',
+                     SingleInstitutionResponse,
+                     payload
     end
 
     # Public: Get information about all available institutions matching your
@@ -51,17 +53,18 @@ 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?
 
-      post_with_public_key 'institutions/search',
-                           MultipleInstitutionsResponse,
-                           payload
+      post_with_auth 'institutions/search',
+                     MultipleInstitutionsResponse,
+                     payload
     end
   end
 

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/link_token.rb

@@ -0,0 +1,74 @@
+LINK_TOKEN_FIELD_NAMES = %i[
+  user
+  client_name
+  products
+  country_codes
+  language
+  webhook
+  access_token
+  link_customization_name
+  redirect_uri
+  android_package_name
+  account_filters
+  cross_app_item_add
+  payment_initiation
+].freeze
+
+module Plaid
+  # Public: Class used to call the LinkToken sub-product.
+  class LinkToken < BaseProduct
+    def create(configs)
+      body = {}
+
+      LINK_TOKEN_FIELD_NAMES.each do |field|
+        body[field] = configs[field]
+      end
+
+      post_with_auth 'link/token/create',
+                     CreateResponse,
+                     body
+    end
+
+    def get(link_token)
+      post_with_auth 'link/token/get',
+                     GetResponse,
+                     link_token: link_token
+    end
+  end
+
+  # Public: Response for /link/token/create.
+  class CreateResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The String token.
+    property :link_token
+
+    ##
+    # :attr_reader:
+    # Public: The String token expiration time.
+    property :expiration
+  end
+
+  # Public: Response for /link/token/get.
+  class GetResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The String token.
+    property :link_token
+
+    ##
+    # :attr_reader:
+    # Public: The link token expiration time.
+    property :expiration
+
+    ##
+    # :attr_reader:
+    # Public: The link token created time.
+    property :created_at
+
+    ##
+    # :attr_reader:
+    # Public: The metadata associated with the link token.
+    property :metadata, coerce: Models::LinkTokenMetadata
+  end
+end

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,24 @@ module Plaid
     # recipient_id - Recipient ID that the payment will be initiated for.
     # reference    - Payment reference.
     # amount       - Payment amount.
+    # schedule     - Payment schedule.
     #
     # Returns a PaymentCreateResponse object.
-    def create_payment(recipient_id, reference, amount)
-      post_with_auth 'payment_initiation/payment/create',
-                     PaymentCreateResponse,
-                     recipient_id: recipient_id,
-                     reference: reference,
-                     amount: amount
+    def create_payment(recipient_id, reference, amount, schedule: nil)
+      if schedule.nil?
+        post_with_auth 'payment_initiation/payment/create',
+                       PaymentCreateResponse,
+                       recipient_id: recipient_id,
+                       reference: reference,
+                       amount: amount
+      else
+        post_with_auth 'payment_initiation/payment/create',
+                       PaymentCreateResponse,
+                       recipient_id: recipient_id,
+                       reference: reference,
+                       amount: amount,
+                       schedule: schedule
+      end
     end
 
     # Public: Create a payment token.
@@ -59,6 +71,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 +197,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.

data/lib/plaid/products/sandbox.rb

@@ -102,11 +102,11 @@ module Plaid
       end
       options_payload = options_payload.merge(options) unless options.nil?
 
-      post_with_public_key 'sandbox/public_token/create',
-                           SandboxCreateResponse,
-                           institution_id: institution_id,
-                           initial_products: initial_products,
-                           options: options_payload
+      post_with_auth 'sandbox/public_token/create',
+                     SandboxCreateResponse,
+                     institution_id: institution_id,
+                     initial_products: initial_products,
+                     options: options_payload
     end
 
     private def transaction_options(start_date, end_date)

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '10.1.0'.freeze
-  API_VERSION = '2019-05-29'.freeze
+  VERSION = '13.0.1'.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: 10.1.0
+  version: 13.0.1
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -174,6 +174,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".env.sample"
+- ".github/workflows/add_to_project.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -204,6 +205,7 @@ files:
 - lib/plaid/products/investments.rb
 - lib/plaid/products/item.rb
 - lib/plaid/products/liabilities.rb
+- lib/plaid/products/link_token.rb
 - lib/plaid/products/payment_initiation.rb
 - lib/plaid/products/processor.rb
 - lib/plaid/products/sandbox.rb
@@ -224,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:
   - - ">="