plaid 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18ef4b160f63f39b30052f19f7ca073f168f4b6a
-  data.tar.gz: 7e30c7bf3971f6fdfc5c4f8863511c3a7b2467ac
+  metadata.gz: bac1f4f002db7e866fd402fc1f5ffd564a4aa241
+  data.tar.gz: ef365c86c2c8443b0f9e1f74f497edfd62e3150e
 SHA512:
-  metadata.gz: d94f18dcde295e44579da99448868145253ecc85d67699f2e60e8b332776c2e2cde77fed83eae657c517b99f3777407d27ffeb86583b2d78477606cc5b5d2b4e
-  data.tar.gz: f163eb2379937e625e852094398cc6b7c9e6f60ff801a400e25b30e2e4ce3fc779ffa1f1dd7657855d0ab6a5d5b2a32be4670b1706a1380da800ec8b1a067f65
+  metadata.gz: 0146aba875c55d08295b0f0488c7e8517977480c4d54a0b1e031081677e8b3854a961ee3cd8ededcd3d5a0ecc992e6fb3cd1357c2c0b9cc735b15b05a7e87462
+  data.tar.gz: d270ce69ab7a41afa2f53e76b1bce551f8683cfb9e4c5749cb2bf64bd5d22a87e87c914fabb50d63a2de227163dce4af940f42d0bc05a0a11ea247f696c3d3c7

data/.circleci/config.yml

@@ -1,23 +1,21 @@
 version: 2
-
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.3
+    - image: circleci/ruby:2.3
     steps:
-      - checkout
-      - run:
-          name: Bundle Install
-          command: bundle check || bundle install
-      - run:
-          name: Stubbed API test
-          command: bundle exec rake test
-          environment:
-            STUB_API: yes
-      - run:
-          name: Live API test
-          command: bundle exec rake test
-      - run:
-          name: Rubocop test
-          command: bundle exec rubocop
-
+    - checkout
+    - run:
+        name: Bundle Install
+        command: bundle check || bundle install
+    - run:
+        name: Stubbed API test
+        command: bundle exec rake test
+        environment:
+          STUB_API: true
+    - run:
+        name: Live API test
+        command: bundle exec rake test
+    - run:
+        name: Rubocop test
+        command: bundle exec rubocop

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 8.0.0 19-Jun-2019
+
+* Deprecate direct integration as it is no longer supported
+
+# 7.1.0 17-Jun-2019
+
+* Add bindings for the new [investments product](https://plaid.com/docs/api/#investments).
+
 # 7.0.0 20-May-2019
 
 * Add support for 2019-05-29 API version

data/CONTRIBUTING.md

@@ -44,6 +44,13 @@ changes in API you'll need to update the pre-recorded responses. Here's how:
    stubbed ones used by `STUB_API=1 rake test`.
 4. Run `STUB_API=1 rake test` and verify that everything works.
 
+
+## Running lint
+
+```bash
+bundle exec rubocop
+```
+
 ## Contributing
 
 1.  Make one or more atomic commits, and ensure that each commit has a

data/README.md

@@ -26,7 +26,7 @@ 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**) | `7.x.x` |
+| [`2019-05-29`][api-version-2019-05-29] (**latest**) | `8.x.x`, `7.x.x` |
 | [`2018-05-22`][api-version-2018-05-22] | `6.x.x` |
 | `2017-03-08` | `5.x.x` |
 
@@ -172,6 +172,8 @@ There are also a number of other methods you can use to retrieve data:
 * `client.identity.get(access_token, ...)`: identity
 * `client.transactions.get(access_token, ...)`: transactions
 * `client.credit_details.get(access_token, ...)`: credit details
+* `client.investments.transactions.get(access_token, ...)`: investment-account transactions
+* `client.investments.holdings.get(access_token, ...)`: investment-account holdings
 
 All of these methods return appropriate data. More information can be found on the [API documentation](https://plaid.com/docs/api).
 

data/lib/plaid.rb

@@ -18,6 +18,7 @@ require_relative 'plaid/products/item'
 require_relative 'plaid/products/processor'
 require_relative 'plaid/products/sandbox'
 require_relative 'plaid/products/transactions'
+require_relative 'plaid/products/investments'
 require_relative 'plaid/client'
 
 # Public: The namespace for all the things Plaid.

data/lib/plaid/client.rb

@@ -92,6 +92,11 @@ module Plaid
     # Public: The Plaid::Transactions product accessor.
     subproduct :transactions
 
+    ##
+    # :attr_reader:
+    # Public: The Plaid::Investments product accessor.
+    subproduct :investments
+
     # Public: Make a post request
     #
     # path    - Path or URL to make the request to

data/lib/plaid/models.rb

@@ -983,6 +983,213 @@ module Plaid
       property :unofficial_currency_code
     end
 
+    # Public: A representation of an InvestmentTransaction in an investment
+    # account.
+    class InvestmentTransaction < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The String investment transaction ID.
+      property :investment_transaction_id
+
+      ##
+      # :attr_reader:
+      # Public: The String account ID.
+      property :account_id
+
+      ##
+      # :attr_reader:
+      # Public: The String security ID.
+      property :security_id
+
+      ##
+      # :attr_reader:
+      # Public: The String transaction date. E.g. "2017-01-01".
+      property :date
+
+      ##
+      # :attr_reader:
+      # Public: The String transaction name (or nil).
+      # E.g. "CREDIT CARD 3333 PAYMENT *//".
+      property :name
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric quantity of the security involved (if applicable).
+      property :quantity
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric amount (or nil).
+      property :amount
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric price of the security that was used for the trade
+      # (if applicable).
+      property :price
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric fee amount.
+      property :fees
+
+      ##
+      # :attr_reader:
+      # Public: The String transaction type (or nil). E.g. "buy" or "sell".
+      property :type
+
+      ##
+      # :attr_reader:
+      # Public: The ISO currency code of the transaction, either USD or CAD.
+      # Always nil if unofficial_currency_code is non-nil.
+      property :iso_currency_code
+
+      ##
+      # :attr_reader:
+      # Public: The unofficial currency code associated with the transaction.
+      # Always nil if iso_currency_code is non-nil.
+      property :unofficial_currency_code
+
+      ##
+      # :attr_reader:
+      # Public: Present if the transaction class is cancel, and indicates the
+      # ID of the transaction which was cancelled.
+      property :cancel_transaction_id
+    end
+
+    # Public: A representation of a Holding in an investment account.
+    class Holding < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The String account ID.
+      property :account_id
+
+      ##
+      # :attr_reader:
+      # Public: The String security ID.
+      property :security_id
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric value of the holding (price * quantity) as reported
+      # by the institution.
+      property :institution_value
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric price of the holding as reported by the institution.
+      property :institution_price
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric quantity.
+      property :quantity
+
+      ##
+      # :attr_reader:
+      # Public: The String date when the price reported by the institution was
+      # current. E.g. "2017-01-01".
+      property :institution_price_as_of
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric cost basis.
+      property :cost_basis
+
+      ##
+      # :attr_reader:
+      # Public: The ISO currency code of the holding, either USD or CAD.
+      # Always nil if unofficial_currency_code is non-nil.
+      property :iso_currency_code
+
+      ##
+      # :attr_reader:
+      # Public: The unofficial currency code associated with the holding.
+      # Always nil if iso_currency_code is non-nil.
+      property :unofficial_currency_code
+    end
+
+    # Public: A representation of a Security.
+    class Security < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The String security ID.
+      property :security_id
+
+      ##
+      # :attr_reader:
+      # Public: The String CUSIP identitfier of this security.
+      property :cusip
+
+      ##
+      # :attr_reader:
+      # Public: The String SEDOL identifier of this security.
+      property :sedol
+
+      ##
+      # :attr_reader:
+      # Public: The String ISIN identifier of this security.
+      property :isin
+
+      ##
+      # :attr_reader:
+      # Public: The String ID of this security as reported by the institution.
+      property :institution_security_id
+
+      ##
+      # :attr_reader:
+      # Public: The String institution ID (if institution_security_id is set).
+      property :institution_id
+
+      ##
+      # :attr_reader:
+      # Public: The String security ID of the proxied security.
+      property :proxy_security_id
+
+      ##
+      # :attr_reader:
+      # Public: The String security name.
+      property :name
+
+      ##
+      # :attr_reader:
+      # Public: The String ticker symbol.
+      property :ticker_symbol
+
+      ##
+      # :attr_reader:
+      # Public: The Boolean flag indicating whether this security is
+      # cash-equivalent.
+      property :is_cash_equivalent
+
+      ##
+      # :attr_reader:
+      # Public: The String Type.
+      property :type
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric close price.
+      property :close_price
+
+      ##
+      # :attr_reader:
+      # Public: The String date when the close price was current.
+      property :close_price_as_of
+
+      ##
+      # :attr_reader:
+      # Public: The ISO currency code of the security, either USD or CAD.
+      # Always nil if unofficial_currency_code is non-nil.
+      property :iso_currency_code
+
+      ##
+      # :attr_reader:
+      # Public: The unofficial currency code associated with the security.
+      # Always nil if iso_currency_code is non-nil.
+      property :unofficial_currency_code
+    end
+
     # Public: A representation of asset report address details.
     class AssetReportAddressData < BaseModel
       ##

data/lib/plaid/products/investments.rb

@@ -0,0 +1,127 @@
+require 'date'
+
+module Plaid
+  # Public: Class used to get InvestmentTransactions for the Investments
+  # product.
+  class InvestmentTransactions < BaseProduct
+    # Public: Get information about all available investment transactions.
+    #
+    # Does a POST /investments/transactions/get call which gives you high level
+    # account data along with investment transactions and associated securities
+    # from all investment accounts contained in the access_token's item.
+    #
+    # access_token - access_token who's item to get investment transactions for.
+    # start_date   - Start of query for investment transactions.
+    # end_date     - End of query for investment transactions.
+    # account_ids  - Specific account ids to fetch transactions for (optional).
+    # count        - Amount of investment transactions to pull (optional).
+    # offset       - Offset to start pulling investment transactions (optional).
+    # options      - Additional options to merge into API request.
+    #
+    # Returns GetResponse.
+    def get(access_token, start_date, end_date,
+            account_ids: nil, count: nil, offset: nil, options: nil)
+
+      options_payload = {}
+      options_payload[:account_ids] = account_ids unless account_ids.nil?
+      options_payload[:count] = count unless count.nil?
+      options_payload[:offset] = offset unless offset.nil?
+      options_payload.merge!(options) unless options.nil?
+
+      post_with_auth 'investments/transactions/get',
+                     GetResponse,
+                     access_token: access_token,
+                     start_date: Plaid.convert_to_date_string(start_date),
+                     end_date: Plaid.convert_to_date_string(end_date),
+                     options: options_payload
+    end
+
+    # Public: Response for /investments/transactions/get.
+    class GetResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The item: Plaid::Models::Item.
+      property :item, coerce: Models::Item
+
+      ##
+      # :attr_reader:
+      # Public: The list of accounts: Array of Plaid::Models::Account.
+      property :accounts, coerce: Array[Models::Account]
+
+      ##
+      # :attr_reader:
+      # Public: The list of investment transactions: Array of
+      # Plaid::Models::InvestmentTransaction.
+      property :investment_transactions,
+               coerce: Array[Models::InvestmentTransaction]
+
+      ##
+      # :attr_reader:
+      # Public: The list of securities referenced by the investment
+      # transactions: Array of Plaid::Models::Security.
+      property :securities, coerce: Array[Models::Security]
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric total investment transactions count.
+      property :total_investment_transactions
+    end
+  end
+
+  # Public: Class used to get Holdings for the Investments product.
+  class Holdings < BaseProduct
+    # Public: Get information about all available investment holdings.
+    #
+    # Does a POST /investments/holdings/get call which gives you high level
+    # account data along with investment holdings and associated securities
+    # from all investment accounts contained in the access_token's item.
+    #
+    # access_token - access_token who's item to fetch holdings for.
+    # account_ids  - Specific account ids to fetch holdings for (optional).
+    # options      - Additional options to merge into API request.
+    #
+    # Returns GetResponse.
+    def get(access_token, account_ids: nil, options: nil)
+      post_with_auth 'investments/holdings/get',
+                     GetResponse,
+                     build_payload(access_token,
+                                   account_ids: account_ids,
+                                   options: options)
+    end
+
+    # Public: Response for /investments/holdings/get.
+    class GetResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The item: Plaid::Models::Item.
+      property :item, coerce: Models::Item
+
+      ##
+      # :attr_reader:
+      # Public: The list of accounts: Array of Plaid::Models::Account.
+      property :accounts, coerce: Array[Models::Account]
+
+      ##
+      # :attr_reader:
+      # Public: The list of holdings: Array of Plaid::Models::Holding.
+      property :holdings, coerce: Array[Models::Holding]
+
+      ##
+      # :attr_reader:
+      # Public: The list of securities referenced by the holdings: Array of
+      # Plaid::Models::Security.
+      property :securities, coerce: Array[Models::Security]
+    end
+  end
+
+  # Public: Class used to call the Accounts product.
+  class Investments < BaseProduct
+    ##
+    # Public: The Plaid::InvestmentTransactions product accessor.
+    subproduct :transactions, Plaid::InvestmentTransactions
+
+    ##
+    # Public: The Plaid::Holdings product accessor.
+    subproduct :holdings
+  end
+end

data/lib/plaid/products/item.rb

@@ -53,34 +53,6 @@ module Plaid
     end
   end
 
-  # Public: Class used to call the Credentials sub-product.
-  class Credentials < BaseProduct
-    # Public: Update credentials for an access_token.
-    #
-    # Does a POST /item/credentials/update call which is used to update
-    # credentials if the credentials become no longer valid.
-    #
-    # access_token - access_token who's item to update credentials for
-    # credentials  - New credentials
-    #
-    # Returns an UpdateResponse object with either an ItemStatus or MFA
-    # response.
-    def update(access_token, credentials)
-      post_with_auth 'item/credentials/update',
-                     UpdateResponse,
-                     access_token: access_token,
-                     credentials: credentials
-    end
-
-    # Public: Response for /item/credentials/update.
-    class UpdateResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The item: Plaid::Models::Item.
-      property :item, coerce: Models::Item
-    end
-  end
-
   # Public: Class used to call the PublicToken sub-product
   class PublicToken < BaseProduct
     # Public: Creates a public token from an access_token.
@@ -175,11 +147,6 @@ module Plaid
     # Public: The Plaid::AccessToken product accessor.
     subproduct :access_token
 
-    ##
-    # :attr_reader:
-    # Public: The Plaid::Credentials product accessor.
-    subproduct :credentials
-
     ##
     # :attr_reader:
     # Public: The Plaid::PublicToken product accessor.
@@ -190,127 +157,6 @@ module Plaid
     # Public: The Plaid::Webhook product accessor.
     subproduct :webhook
 
-    # Public: Creates an item.
-    #
-    # Does a POST /item/create call which attemps to create a new item for you
-    # possibly returning a success, error, or multi-factor authentication
-    # response.
-    #
-    # credentials                - Institution credentials to create item with.
-    # institution_id             - Institution ID to create item with.
-    # initial_products           - Initial products to create the item with,
-    #                              i.e. [:transactions].
-    # transactions_start_date    - date at which to begin the item's initial
-    #                              transaction pull (optional).
-    # transactions_end_date      - date at which to end the item's initial
-    #                              transaction pull (optional).
-    # transactions_await_results - if true, the initial transaction pull will
-    #                              be performed synchronously (optional).
-    # webhook                    - webhook to associate with the item
-    #                              (optional).
-    # options                    - Additional options to merge into API
-    #                              request.
-    #
-    # Returns an ItemResponse object with item info including access_token and
-    # ItemStatus, or MFA response or error.
-    def create(credentials:,
-               institution_id:,
-               initial_products:,
-               transactions_start_date: nil,
-               transactions_end_date: nil,
-               transactions_await_results: nil,
-               webhook: nil,
-               options: nil)
-
-      options_payload = {}
-
-      txn_options = transaction_options transactions_start_date,
-                                        transactions_end_date,
-                                        transactions_await_results
-
-      options_payload[:transactions] = txn_options if txn_options != {}
-      options_payload[:webhook] = webhook unless webhook.nil?
-      options_payload = options_payload.merge(options) unless options.nil?
-
-      post_with_auth 'item/create',
-                     ItemResponse,
-                     credentials: credentials,
-                     institution_id: institution_id,
-                     initial_products: initial_products,
-                     options: options_payload
-    end
-
-    private def transaction_options(start_date, end_date, await_results)
-      {}.tap do |options|
-        options[:start_date] = Plaid.convert_to_date_string(start_date) \
-          if start_date
-
-        options[:end_date] = Plaid.convert_to_date_string(end_date) \
-          if end_date
-
-        options[:await_results] = await_results if await_results
-      end
-    end
-
-    # Public: Response for /item/create and /item/mfa endpoints.
-    class ItemResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The String access_token to use with API.
-      property :access_token
-
-      ##
-      # :attr_reader:
-      # Public: The Plaid::Models::Item object, returned if item has been
-      # successfully created.
-      property :item, coerce: Models::Item
-
-      ##
-      # :attr_reader:
-      # Public: The MFA/OTP device information: Plaid::Models::MFA::Device.
-      property :device, coerce: Models::MFA::Device
-
-      ##
-      # :attr_reader:
-      # Public: The list of devices to send the OTP to:
-      # Array of Plaid::Models::MFA::DeviceListElement.
-      property :device_list, coerce: Array[Models::MFA::DeviceListElement]
-
-      ##
-      # :attr_reader:
-      # Public: The String MFA type. E.g. "device_list", "device", "questions",
-      # "selections".
-      property :mfa_type
-
-      ##
-      # :attr_reader:
-      # Public: The Array of String MFA questions.
-      property :questions
-
-      ##
-      # :attr_reader:
-      # Public: The Array of MFA selections: Plaid::Models::MFA::Selection.
-      property :selections, coerce: Array[Models::MFA::Selection]
-    end
-
-    # Public: Submit an MFA step.
-    #
-    # Does a POST /item/mfa call which gives you the ability to respond to an
-    # MFA.
-    #
-    # access_token - To submit MFA step for.
-    # mfa_type     - The MFA type indicated in the MFA response.
-    # responses    - List of answers/responses to MFA.
-    #
-    # Returns an ItemResponse instance.
-    def mfa(access_token, mfa_type, responses)
-      post_with_auth 'item/mfa',
-                     ItemResponse,
-                     access_token: access_token,
-                     mfa_type: mfa_type,
-                     responses: responses
-    end
-
     # Public: Get information about an item.
     #
     # Does a POST /item/get call which returns information about an item or

data/lib/plaid/products/sandbox.rb

@@ -62,11 +62,16 @@ module Plaid
     # Returns a SandboxCreateResponse object with a public token and item id.
     def create(institution_id:,
                initial_products:,
+               transactions_start_date: nil,
+               transactions_end_date: nil,
                webhook: nil,
                options: nil)
 
       options_payload = {}
       options_payload[:webhook] = webhook unless webhook.nil?
+      txn_options = transaction_options transactions_start_date,
+                                        transactions_end_date
+      options_payload[:transactions] = txn_options if txn_options != {}
       options_payload = options_payload.merge(options) unless options.nil?
 
       post_with_public_key 'sandbox/public_token/create',
@@ -76,6 +81,16 @@ module Plaid
                            options: options_payload
     end
 
+    private def transaction_options(start_date, end_date)
+      {}.tap do |options|
+        options[:start_date] = Plaid.convert_to_date_string(start_date) \
+          if start_date
+
+        options[:end_date] = Plaid.convert_to_date_string(end_date) \
+          if end_date
+      end
+    end
+
     # Public: Response for /sandbox/public_token/create.
     class SandboxCreateResponse < Models::BaseResponse
       ##

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '7.0.0'.freeze
+  VERSION = '8.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: 7.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -200,6 +200,7 @@ files:
 - lib/plaid/products/identity.rb
 - lib/plaid/products/income.rb
 - lib/plaid/products/institutions.rb
+- lib/plaid/products/investments.rb
 - lib/plaid/products/item.rb
 - lib/plaid/products/processor.rb
 - lib/plaid/products/sandbox.rb