plaid 9.0.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b01d399843f5783e0e0cf64e88392b8c883eb29288d8c0535c1b7fbc9c34c32
-  data.tar.gz: 8c267612077441ef461b8b590f4a40959d680085558d42145b0cc2d179e5a726
+  metadata.gz: ff88844aefb3173ccb877c8764119b67120d08a2f7d3425eef174236be4b6161
+  data.tar.gz: 21103e33e95a4a54d984bdd4e30c0ac7c8e750f18eb542660ed8f55fc10a91c2
 SHA512:
-  metadata.gz: e976a0ba72f8a33ac057ce3fe0589324934c8e292a314acc33ad9014999fa8e230beb15b45ee02a8f55a4c3c0b12c668a453091f1f9d091ac16add0575217038
-  data.tar.gz: 9b91b0105aa3ac0450d6bc38158390ebff5bc70066eb2d61924cd17039c7a9f670a9d1282169b38a2fb3ca860cf4af9ef14082ae992cdfe5b309bcb9a80b01f8
+  metadata.gz: 01dd7019a4fd8ee33dc4ebc5bdd069e5c2188476e835a806d8d1e170e84d0eb00f831cba66c65ab73db7264b54a264732e0c00a811f8be94d6f03c09f1f6c2bb
+  data.tar.gz: 363f9143a45caacc0abb0a668f7be9ee019e082814bec7545c00e092770faf2dca0cabe9304aef0624864acdaea8afc60a0baee2fe84209f1074f6bf785e99b2

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

@@ -8,7 +8,7 @@ Layout/IndentHeredoc:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 20
+  Enabled: false
 
 Metrics/MethodLength:
   Max: 20

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+# 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))
+
+# 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/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 (9.0.0)
+    plaid (12.0.0)
       faraday
       faraday_middleware
       hashie (>= 3.4.3)

data/PUBLISH.md

@@ -2,13 +2,19 @@
 
 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.
+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). **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/
 [2]: https://rubygems.org/gems/plaid

data/README.md

@@ -26,7 +26,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 +42,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 +63,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 +73,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 +105,7 @@ response = client.item.public_token.exchange(public_token)
 access_token = response.access_token
 ```
 
+
 ### Deleting an item
 
 ```ruby
@@ -91,8 +113,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 +128,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 +156,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 +173,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
@@ -208,6 +226,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).
 
@@ -241,3 +261,4 @@ If you're looking for a Ruby client that works with the legacy Plaid API, use th
 [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
+[api-version-2020-09-14]: https://plaid.com/docs/api-upgrades#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/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

@@ -976,6 +976,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).
@@ -1812,6 +1818,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 +1904,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 +1947,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 +1977,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.
@@ -1924,6 +2031,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,57 +25,8 @@ 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.
-    #
-    # Does a POST /item/public_token/create call which can be used to
-    # initialize Link in update mode.
-    #
-    # access_token - access_token to create a public token for
-    #
-    # Returns a CreateResponse object with a public token and expiration info.
-    def create(access_token)
-      post_with_auth 'item/public_token/create',
-                     CreateResponse,
-                     access_token: access_token
-    end
-
-    # Public: Response for /item/public_token/create.
-    class CreateResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The String token.
-      property :public_token
-
-      ##
-      # :attr_reader:
-      # Public: The String token expiration time.
-      property :expiration
-    end
-
     # Public: Exchange a public token for an access_token
     #
     # Does a POST /item/public_token/exchange call helps you exchange a public
@@ -146,11 +97,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

@@ -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
 
@@ -51,17 +53,6 @@ module Plaid
                      amount: amount
     end
 
-    # Public: Create a payment token.
-    #
-    # payment_id - Payment ID that the token will be created for.
-    #
-    # Returns a PaymentTokenCreateResponse object.
-    def create_payment_token(payment_id)
-      post_with_auth 'payment_initiation/payment/token/create',
-                     PaymentTokenCreateResponse,
-                     payment_id: payment_id
-    end
-
     # Public: Retrieve a payment.
     #
     # payment_id - The payment ID from the `create_payment` response.
@@ -112,6 +103,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.
@@ -139,19 +135,6 @@ module Plaid
     property :status
   end
 
-  # Public: The response wrapper for /payment_initiation/payment/token/create.
-  class PaymentTokenCreateResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The payment token.
-    property :payment_token
-
-    ##
-    # :attr_reader:
-    # Public: The payment token's expiration time.
-    property :payment_token_expiration_time
-  end
-
   # Public: The response wrapper for /payment_initiation/payment/get.
   class PaymentGetResponse < Models::BaseResponse
     ##

data/lib/plaid/products/sandbox.rb

@@ -72,10 +72,12 @@ module Plaid
     # to generate a public_token given an institution and list of
     # products.
     #
-    # institution_id   - Specific institution id to generate token for.
-    # initial_products - Products for which generated token is valid for.
-    # webhook          - webhook to associate with the item (optional).
-    # options          - Additional options to merge into API request.
+    # institution_id    - Specific institution id to generate token for.
+    # initial_products  - Products for which generated token is valid for.
+    # webhook           - webhook to associate with the item (optional).
+    # override_username - Specific test credential username to use
+    # override_password - Specific test credential password to use
+    # options           - Additional options to merge into API request.
     #
     # Returns a SandboxCreateResponse object with a public token and item id.
     def create(institution_id:,
@@ -83,6 +85,8 @@ module Plaid
                transactions_start_date: nil,
                transactions_end_date: nil,
                webhook: nil,
+               override_username: nil,
+               override_password: nil,
                options: nil)
 
       options_payload = {}
@@ -90,13 +94,19 @@ module Plaid
       txn_options = transaction_options transactions_start_date,
                                         transactions_end_date
       options_payload[:transactions] = txn_options if txn_options != {}
+      unless override_username.nil?
+        options_payload[:override_username] = override_username
+      end
+      unless override_password.nil?
+        options_payload[:override_password] = override_password
+      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 = '9.0.0'.freeze
-  API_VERSION = '2019-05-29'.freeze
+  VERSION = '12.0.0'.freeze
+  API_VERSION = '2020-09-14'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Edmund Loo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-10-07 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
@@ -216,7 +218,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -231,8 +233,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Ruby bindings for Plaid
 test_files: []