plaid 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4c5640b58e7e3dd7083d0c591e45e715a9909fe
-  data.tar.gz: b95f33803556ae6f1fbbaaef3c62a782bf479fc4
+  metadata.gz: 7753c38b254ac48f1746069f6f581ed48f920aa3
+  data.tar.gz: 7d27ac46a42222fd0fb58a5ca54c5fe4edad0012
 SHA512:
-  metadata.gz: 5fd30997779f028c382a74542c658a59d0103e05f8c510c1436ee2847ae772c665214855bf70f176d549bfa0ef20048bd2318ecd8cd60e7849f4abd60de8dd11
-  data.tar.gz: 129a894b83addada9e7b1193baf3e7681a90603c010927b3d75c1d16ef4fd9d3177eb91bde8c84af3c07254b841e0c02c445874c94fb7da62a1c994597b0ee07
+  metadata.gz: 1174e08a609f0f11c17008eebb891477f29c40d007d62472641ac499a0eb22ec17edc50a074c61497822f0cc7e701a6566e8f9b09b01a56a3f4b6936162963fc
+  data.tar.gz: b3fd48ff05090bb1b55502ff6a19055223c772cf467dd7c416c6751b7020e85b4884f49dd6b6b3807e16c29ad07782302e9af7023a067c5d4c8ed6ecf60d8fe8

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 6.1.0 20-Jun-2018
+
+* Add bindings for the new [assets product](https://plaid.com/docs/api/#assets).
+
 # 6.0.0 22-May-2018
 
 * Use `Plaid-Version` header to request the certain compatible API version.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (5.0.0)
+    plaid (6.1.0)
       faraday
       faraday_middleware
       hashie (>= 3.4.3)
@@ -11,7 +11,7 @@ GEM
   specs:
     ast (2.4.0)
     dotenv (2.4.0)
-    faraday (0.15.1)
+    faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
@@ -55,4 +55,4 @@ DEPENDENCIES
   vcr (~> 4.0.0)
 
 BUNDLED WITH
-   1.16.0
+   1.16.2

data/README.md

@@ -2,8 +2,6 @@
 
 The official Ruby bindings for the [Plaid API](https://plaid.com/docs).
 
-**Note:** This module was recently refactored and released as version `4.0.x` to support [Plaid's updated API][1]. The previous module version, `3.0.x`, and API legacy documentation, is still available via RubyGems and mirrored as [`plaid-legacy`][2].
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,7 +18,19 @@ Or install it yourself as:
 
     $ gem install plaid
 
-The gem supports Ruby 2.1+ only.
+The gem supports Ruby 2.2+ only.
+
+### Versioning
+
+Each major version of `plaid-ruby` targets a specific version of the Plaid API:
+
+| API version | plaid-ruby release |
+| ----------- | ------------------ |
+| [`2018-05-22`][api-version-2018-05-22] (**latest**) | `6.x.x` |
+| `2017-03-08` | `5.x.x` |
+
+For information about what has changed between versions and how to update your integration, head to the [version changelog][version-changelog].
+
 
 ## Usage
 
@@ -222,5 +232,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/plaid/
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-[1]: https://blog.plaid.com/improving-our-api/
+### Legacy API
+
+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/version-changelog
+[api-version-2018-05-22]: https://plaid.com/docs/api-upgrades#2018-05-22

data/Rakefile

@@ -4,6 +4,7 @@ require 'rdoc/task'
 require 'rake/testtask'
 require 'dotenv/load'
 require 'fileutils'
+require 'tmpdir'
 
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'doc/rdoc'

data/lib/plaid.rb

@@ -7,6 +7,7 @@ require_relative 'plaid/errors'
 require_relative 'plaid/version'
 require_relative 'plaid/models'
 require_relative 'plaid/products/accounts'
+require_relative 'plaid/products/asset_report'
 require_relative 'plaid/products/auth'
 require_relative 'plaid/products/categories'
 require_relative 'plaid/products/credit_details'

data/lib/plaid/client.rb

@@ -39,6 +39,11 @@ module Plaid
     # Public: The Plaid::Auth product accessor.
     subproduct :auth
 
+    ##
+    # :attr_reader:
+    # Public: The Plaid::AssetReport product accessor.
+    subproduct :asset_report
+
     ##
     # :attr_reader:
     # Public: The Plaid::Categories product accessor.

data/lib/plaid/models.rb

@@ -49,6 +49,37 @@ module Plaid
       property :display_message
     end
 
+    # Public: A representation of a cause.
+    class Cause < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The item ID.
+      property :item_id
+
+      ##
+      # :attr_reader:
+      # Public: The underlying error.
+      property :error, coerce: Error
+    end
+
+    # Public: A representation of a warning.
+    class Warning < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The type of warning.
+      property :warning_type
+
+      ##
+      # :attr_reader:
+      # Public: The warning code.
+      property :warning_code
+
+      ##
+      # :attr_reader:
+      # Public: The underlying cause.
+      property :cause, coerce: Cause
+    end
+
     # Public: A representation of an item.
     class Item < BaseModel
       ##
@@ -736,5 +767,325 @@ module Plaid
       # Public: The String unofficial currency code for the amount
       property :unofficial_currency_code
     end
+
+    # Public: A representation of an asset report address.
+    class AssetReportAddress < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Data about the components comprising an address; see
+      # IdentityAddressData object for fields.
+      property :data, coerce: IdentityAddressData
+
+      ##
+      # :attr_reader:
+      # Public: When true, identifies the address as the primary address on an
+      # account.
+      property :primary
+    end
+
+    # Public: A representation of an asset report owner.
+    class AssetReportOwner < BaseModel
+      ##
+      # :attr_reader:
+      # Public: A list of names associated with the account by the financial
+      # institution.
+      property :names, coerce: Array[String]
+
+      ##
+      # :attr_reader:
+      # Public: A list of phone numbers associated with the account by the
+      # financial institution; see IdentityPhoneNumber number object for
+      # fields.
+      property :phone_numbers, coerce: Array[IdentityPhoneNumber]
+
+      ##
+      # :attr_reader:
+      # Public: A list of emails associated with the account by the financial
+      # institution; see IdentityEmail object for fields.
+      property :emails, coerce: Array[IdentityEmail]
+
+      ##
+      # :attr_reader:
+      # Public: Data about the various addresses associated with the account
+      # by the financial institution; see AssetReportAddress object for fields.
+      property :addresses, coerce: Array[AssetReportAddress]
+    end
+
+    # Public: A representation of an asset report balance.
+    class AssetReportBalance < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The available balance as reported by the financial institution.
+      # This is usually, but not always, the current balance less any
+      # outstanding holds or debits that have not yet posted to the account.
+      property :available
+
+      ##
+      # :attr_reader:
+      # Public: The total amount of funds in the account.
+      property :current
+
+      ##
+      # :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
+    end
+
+    # Public: A representation of an asset report historical balance.
+    class AssetReportHistoricalBalance < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The date of the calculated historical balance.
+      property :date
+
+      ##
+      # :attr_reader:
+      # Public: The total amount of funds in the account, calculated from the
+      # current balance in the balance object by subtracting inflows and adding
+      # back outflows according to the posted date of each.
+      property :current
+
+      ##
+      # :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
+    end
+
+    # Public: A representation of an asset report transaction.
+    class AssetReportTransaction < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Plaid's unique identifier for the account.
+      property :account_id
+
+      ##
+      # :attr_reader:
+      # Public: Plaid's unique identifier for the transaction.
+      property :transaction_id
+
+      ##
+      # :attr_reader:
+      # Public: For pending transactions, Plaid returns the date the
+      # transaction occurred; for posted transactions, Plaid returns the date
+      # the transaction posts; both dates are returned in an ISO 8601 format
+      # (YYYY-MM-DD).
+      property :date
+
+      ##
+      # :attr_reader:
+      # Public: The string returned by the financial institution to describe
+      # the transaction.
+      property :original_description
+
+      ##
+      # :attr_reader:
+      # Public: When true, identifies the transaction as pending or unsettled;
+      # pending transaction details (description, amount) may change before
+      # they are settled.
+      property :pending
+
+      ##
+      # :attr_reader:
+      # Public: The settled dollar value; positive values when money moves out
+      # of the account, negative values when money moves in.
+      property :amount
+
+      ##
+      # :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
+    end
+
+    # Public: A representation of an asset report account.
+    class AssetReportAccount < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Plaid's unique identifier for the account.
+      property :account_id
+
+      ##
+      # :attr_reader:
+      # Public: The last 2-5 digits of the account's number.
+      property :mask
+
+      ##
+      # :attr_reader:
+      # Public: The name of the account, either assigned by the user or by the
+      # financial institution itself.
+      property :name
+
+      ##
+      # :attr_reader:
+      # Public: The official name of the account as given by the financial
+      # institution.
+      property :official_name
+
+      ##
+      # :attr_reader:
+      # Public: The primary type of the account (e.g., "depository").
+      property :type
+
+      ##
+      # :attr_reader:
+      # Public: The secondary type of the account (e.g., "checking").
+      property :subtype
+
+      ##
+      # :attr_reader:
+      # Public: Data returned by the financial institution about the account
+      # owner or owners; see AssetReportOwner object for fields.
+      property :owners, coerce: Array[AssetReportOwner]
+
+      ##
+      # :attr_reader:
+      # Public: Data about the various balances on the account; see
+      # AssetReportBalance object for fields.
+      property :balances, coerce: AssetReportBalance
+
+      ##
+      # :attr_reader:
+      # Public: Calculated data about the historical balances on the account;
+      # see AssetReportHistoricalBalance object for fields.
+      property :historical_balances, coerce: Array[AssetReportHistoricalBalance]
+
+      ##
+      # :attr_reader:
+      # Public: Data about the transactions.
+      property :transactions, coerce: Array[AssetReportTransaction]
+
+      ##
+      # :attr_reader:
+      # Public: The duration of transaction history available for this Item,
+      # typically defined as the time since the date of the earliest
+      # transaction in that account.
+      property :days_available
+    end
+
+    # Public: A representation of an asset report item.
+    class AssetReportItem < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Plaid's unique identifier for the Item.
+      property :item_id
+
+      ##
+      # :attr_reader:
+      # Public: The full financial institution name associated with the Item.
+      property :institution_name
+
+      ##
+      # :attr_reader:
+      # Public: The financial institution associated with the Item.
+      property :institution_id
+
+      ##
+      # :attr_reader:
+      # Public: The date and time when this Item's data was retrieved from the
+      # financial institution.
+      property :date_last_updated
+
+      ##
+      # :attr_reader:
+      # Public: Data about each of the accounts open on the Item; see Account
+      # object for fields.
+      property :accounts, coerce: Array[AssetReportAccount]
+    end
+
+    # Public: A representation of an asset report user.
+    class AssetReportUser < BaseModel
+      ##
+      # :attr_reader:
+      # Public: An identifier you determine and submit for the user.
+      property :client_user_id
+
+      ##
+      # :attr_reader:
+      # Public: The user's first name.
+      property :first_name
+
+      ##
+      # :attr_reader:
+      # Public: The user's middle name.
+      property :middle_name
+
+      ##
+      # :attr_reader:
+      # Public: The user's last name.
+      property :last_name
+
+      ##
+      # :attr_reader:
+      # Public: The user's social security number. Format:
+      # "\d\d\d-\d\d-\d\d\d\d".
+      property :ssn
+
+      ##
+      # :attr_reader:
+      # Public: The user's phone number Format:
+      # "+{country_code}{area code and subscriber number}", e.g.
+      # "+14155555555" (known as E.164 format)
+      property :phone_number
+
+      ##
+      # :attr_reader:
+      # Public: The user's email address.
+      property :email
+    end
+
+    # Public: A representation of an asset report.
+    class AssetReport < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Plaid's unique identifier for this asset report.
+      property :asset_report_id
+
+      ##
+      # :attr_reader:
+      # Public: An identifier you determine and submit for the Asset Report.
+      property :client_report_id
+
+      ##
+      # :attr_reader:
+      # Public: The date and time when the Asset Report was created.
+      property :date_generated
+
+      ##
+      # :attr_reader:
+      # Public: The duration of transaction history you requested.
+      property :days_requested
+
+      ##
+      # :attr_reader:
+      # Public: Data submitted by you about the user whose Asset Report is
+      # being compiled; see AssetReportUser object for fields.
+      property :user, coerce: AssetReportUser
+
+      ##
+      # :attr_reader:
+      # Public: Data returned by Plaid about each of the Items included in the
+      # Asset Report; see AssetReportItem object for fields.
+      property :items, coerce: Array[AssetReportItem]
+    end
   end
 end

data/lib/plaid/products/asset_report.rb

@@ -0,0 +1,133 @@
+module Plaid
+  # Public: Class used to call the Assets product. Documentation available at
+  # https://plaid.com/docs/api/#assets.
+  class AssetReport < BaseProduct
+    # Public: Create an asset report.
+    #
+    # access_tokens  - An array of access tokens, one token for each Item to be
+    #                  included in the Asset Report.
+    # days_requested - Days of transaction history requested to be included in
+    #                  the Asset Report. Plaid will return as much data as
+    #                  possible within the implied date range, up to a maximum
+    #                  of 730 days (2 years) of history.
+    # options -        An optional object containing client-provided user
+    #                  information, a client-provided report ID, and a webhook.
+    #                  For more information, see the website listed above.
+    #
+    # Returns a AssetReportCreateResponse object.
+    def create(access_tokens, days_requested, options)
+      post_with_auth 'asset_report/create',
+                     AssetReportCreateResponse,
+                     access_tokens: access_tokens,
+                     days_requested: days_requested,
+                     options: options
+    end
+
+    # Public: Retrieve an asset report.
+    #
+    # asset_report_token - The asset report token from the `create` response.
+    #
+    # Returns a AssetReportGetResponse object.
+    def get(asset_report_token)
+      post_with_auth 'asset_report/get',
+                     AssetReportGetResponse,
+                     asset_report_token: asset_report_token
+    end
+
+    # Public: Retrieve an asset report as a PDF.
+    #
+    # asset_report_token - The asset report token from the `create` response.
+    #
+    # Returns the PDF.
+    def get_pdf(asset_report_token)
+      client.post_with_auth 'asset_report/pdf/get',
+                            asset_report_token: asset_report_token
+    end
+
+    # Public: Remove an asset report.
+    #
+    # asset_report_token - The asset report token from the `create` response.
+    #
+    # Returns a AssetReportRemoveResponse object.
+    def remove(asset_report_token)
+      post_with_auth 'asset_report/remove',
+                     AssetReportRemoveResponse,
+                     asset_report_token: asset_report_token
+    end
+
+    # Public: Create an audit copy token.
+    #
+    # asset_report_token - The asset report token from the `create` response.
+    # auditor_id         - The ID of the third party with which you would like
+    #                      to share the asset report.
+    #
+    # Returns a AuditCopyCreateResponse object.
+    def create_audit_copy(asset_report_token, auditor_id)
+      post_with_auth 'asset_report/audit_copy/create',
+                     AuditCopyCreateResponse,
+                     asset_report_token: asset_report_token,
+                     auditor_id: auditor_id
+    end
+
+    # Public: Remove an audit copy token.
+    #
+    # audit_copy_token - The audit copy token from the `create` response.
+    #
+    # Returns a AuditCopyRemoveResponse object.
+    def remove_audit_copy(audit_copy_token)
+      post_with_auth 'asset_report/audit_copy/remove',
+                     AuditCopyRemoveResponse,
+                     audit_copy_token: audit_copy_token
+    end
+  end
+
+  # Public: The response wrapper for /asset_report/create.
+  class AssetReportCreateResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The asset report token.
+    property :asset_report_token
+
+    ##
+    # :attr_reader:
+    # Public: The asset report ID.
+    property :asset_report_id
+  end
+
+  # Public: The response wrapper for /asset_report/get.
+  class AssetReportGetResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The asset report token.
+    property :report, coerce: Models::AssetReport
+
+    ##
+    # :attr_reader:
+    # Public: Warnings encountered during asset report generation.
+    property :warnings, coerce: Array[Models::Warning]
+  end
+
+  # Public: The response wrapper for /asset_report/remove.
+  class AssetReportRemoveResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: A boolean indicating whether the report was removed.
+    property :removed
+  end
+
+  # Public: The response wrapper for /audit_copy/create.
+  class AuditCopyCreateResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The audit copy token.
+    property :audit_copy_token
+  end
+
+  # Public: The response wrapper for /audit_copy/remove.
+  class AuditCopyRemoveResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: A boolean indicating whether the audit copy was removed.
+    property :removed
+  end
+end

data/lib/plaid/products/sandbox.rb

@@ -23,11 +23,60 @@ module Plaid
     end
   end
 
+  # Public: Class used to call the SandboxPublicToken sub-product
+  class SandboxPublicToken < BaseProduct
+    # Public: Creates a public token for sandbox testing.
+    #
+    # Does a POST /sandbox/public_token/create call which can be used
+    # 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.
+    #
+    # Returns a SandboxCreateResponse object with a public token and item id.
+    def create(institution_id:,
+               initial_products:,
+               webhook: nil,
+               options: nil)
+
+      options_payload = {}
+      options_payload[:webhook] = webhook unless webhook.nil?
+      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
+    end
+
+    # Public: Response for /sandbox/public_token/create.
+    class SandboxCreateResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The String token.
+      property :public_token
+
+      ##
+      # :attr_reader:
+      # Public: The String item ID.
+      property :item_id
+    end
+  end
+
   # Public: Class used to call the Sandbox product.
   class Sandbox < BaseProduct
     ##
     # :attr_reader:
     # Public: The Plaid::SandboxItem product accessor.
     subproduct :sandbox_item
+
+    ##
+    # :attr_reader:
+    # Public: The Plaid::SandboxPublicToken product accessor.
+    subproduct :sandbox_public_token
   end
 end

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '6.0.0'.freeze
+  VERSION = '6.1.0'.freeze
   API_VERSION = '2018-05-22'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -192,6 +192,7 @@ files:
 - lib/plaid/middleware.rb
 - lib/plaid/models.rb
 - lib/plaid/products/accounts.rb
+- lib/plaid/products/asset_report.rb
 - lib/plaid/products/auth.rb
 - lib/plaid/products/base_product.rb
 - lib/plaid/products/categories.rb