plaid 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7753c38b254ac48f1746069f6f581ed48f920aa3
-  data.tar.gz: 7d27ac46a42222fd0fb58a5ca54c5fe4edad0012
+  metadata.gz: 865a246047bc8acf858a9b9d521aa1aef8d275ce
+  data.tar.gz: 3a197bc1f6e0d94550e4063cd16fb984580934aa
 SHA512:
-  metadata.gz: 1174e08a609f0f11c17008eebb891477f29c40d007d62472641ac499a0eb22ec17edc50a074c61497822f0cc7e701a6566e8f9b09b01a56a3f4b6936162963fc
-  data.tar.gz: b3fd48ff05090bb1b55502ff6a19055223c772cf467dd7c416c6751b7020e85b4884f49dd6b6b3807e16c29ad07782302e9af7023a067c5d4c8ed6ecf60d8fe8
+  metadata.gz: 258a35dee81754143a6172f65a47e1a596aaada2336d0486d54d1fbdbf8da6f163fd152265e00e9c506c4b5b7dd1f584d17cc6eb28da4a64c31b98154b487fff
+  data.tar.gz: e32bd447ebd887917500e041b4dacb1d9b9afffdf71454566d60b1903e57bc642cf6bb25d58e5ce1f842d5988911862c027d401a013051fd174fce328ddce486

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 6.2.0 28-Nov-2018
+
+* Assets + Insights reports
+
 # 6.1.0 20-Jun-2018
 
 * Add bindings for the new [assets product](https://plaid.com/docs/api/#assets).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (6.1.0)
+    plaid (6.2.0)
       faraday
       faraday_middleware
       hashie (>= 3.4.3)

data/README.md

@@ -237,5 +237,5 @@ 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/version-changelog
+[version-changelog]: https://plaid.com/docs/api-upgrades
 [api-version-2018-05-22]: https://plaid.com/docs/api-upgrades#2018-05-22

data/lib/plaid/client.rb

@@ -8,6 +8,9 @@ module Plaid
     # Public: The current environment in use (one of ENVIRONMENTS).
     attr_reader :env
 
+    # Public: The client ID.
+    attr_reader :client_id
+
     # Public: Construct a Client instance
     #
     # Optionally takes a block to allow overriding the default Faraday

data/lib/plaid/models.rb

@@ -551,6 +551,12 @@ module Plaid
       # Public: The Boolean flag indicating if the institution uses MFA.
       property :has_mfa
 
+      ##
+      # :attr_reader:
+      # Public: The String reflecting the MFA code type ("numeric" /
+      # "alphanumeric")
+      property :mfa_code_type
+
       ##
       # :attr_reader:
       # Public: The String institution ID (e.g. "ins_109512").
@@ -915,6 +921,56 @@ module Plaid
       # 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: The String account owner (or nil). This field
+      # only appears in an Asset Report with Insights.
+      property :account_owner
+
+      ##
+      # :attr_reader: Public: The Array of String category (or nil). This field
+      # only appears in an Asset Report with Insights. E.g. ["Payment", "Credit
+      # Card"].
+      property :category
+
+      ##
+      # :attr_reader: Public: The String category_id (or nil). This field only
+      # appears in an Asset Report with Insights. E.g. "16001000".
+      property :category_id
+
+      ##
+      # :attr_reader: Public: The String date of the transaction (or nil). This
+      # field only appears in an Asset Report with Insights.
+      property :date_transacted
+
+      ##
+      # :attr_reader: Public: The location where transaction occurred
+      # (TransactionLocation). This field only appears in an Asset Report with
+      # Insights.
+      property :location, coerce: TransactionLocation
+
+      ##
+      # :attr_reader: Public: The String transaction name (or nil). This field
+      # only appears in an Asset Report with Insights. E.g. "CREDIT CARD 3333
+      # PAYMENT *//".
+      property :name
+
+      ##
+      # :attr_reader: Public: The payment meta information
+      # (TransactionPaymentMeta). This field only appears in an Asset Report
+      # with Insights.
+      property :payment_meta, coerce: TransactionPaymentMeta
+
+      ##
+      # :attr_reader: Public: The String pending transaction ID (or nil). This
+      # field only appears in an Asset Report with Insights.
+      property :pending_transaction_id
+
+      ##
+      # :attr_reader: Public: The String transaction type (or nil). E.g.
+      # "special", or "place". This field only appears in an Asset Report with
+      # Insights.
+      property :transaction_type
     end
 
     # Public: A representation of an asset report account.

data/lib/plaid/products/asset_report.rb

@@ -10,12 +10,12 @@ module Plaid
     #                  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
+    # 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)
+    def create(access_tokens, days_requested, options = {})
       post_with_auth 'asset_report/create',
                      AssetReportCreateResponse,
                      access_tokens: access_tokens,
@@ -23,15 +23,57 @@ module Plaid
                      options: options
     end
 
+    # Public: Create a new, filtered asset report.
+    #
+    # asset_report_token     - The asset report token for the asset report you
+    #                          want to filter.
+    # account_ids_to_exclude - The list of account IDs to exclude from the
+    #                          original asset report.
+    #
+    # Returns a AssetReportFilterResponse object.
+    def filter(asset_report_token, account_ids_to_exclude)
+      post_with_auth 'asset_report/filter',
+                     AssetReportFilterResponse,
+                     asset_report_token: asset_report_token,
+                     account_ids_to_exclude: account_ids_to_exclude
+    end
+
+    # Public: Create a new, refreshed asset report.
+    #
+    # asset_report_token - The asset report token for the asset report you want
+    #                      to refresh.
+    # 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 AssetReportRefreshResponse object.
+    def refresh(asset_report_token, days_requested, options = {})
+      post_with_auth 'asset_report/refresh',
+                     AssetReportRefreshResponse,
+                     asset_report_token: asset_report_token,
+                     days_requested: days_requested,
+                     options: options
+    end
+
     # Public: Retrieve an asset report.
     #
     # asset_report_token - The asset report token from the `create` response.
+    # include_insights   - An optional boolean specifying whether we should
+    #                      retrieve the report as an "Assets + Insights"
+    #                      report. For information about Assets + Insights
+    #                      reports, see https://plaid.com/docs/#assets.
     #
     # Returns a AssetReportGetResponse object.
-    def get(asset_report_token)
+    def get(asset_report_token, include_insights: false)
       post_with_auth 'asset_report/get',
                      AssetReportGetResponse,
-                     asset_report_token: asset_report_token
+                     asset_report_token: asset_report_token,
+                     include_insights: include_insights
     end
 
     # Public: Retrieve an asset report as a PDF.
@@ -69,6 +111,18 @@ module Plaid
                      auditor_id: auditor_id
     end
 
+    # Public: Retrieve an audit copy.
+    #
+    # audit_copy_token - The audit copy token from the `create_audit_copy`
+    #                    response.
+    #
+    # Returns a AuditCopyGetResponse object.
+    def get_audit_copy(audit_copy_token)
+      post_with_auth 'asset_report/audit_copy/get',
+                     AuditCopyGetResponse,
+                     audit_copy_token: audit_copy_token
+    end
+
     # Public: Remove an audit copy token.
     #
     # audit_copy_token - The audit copy token from the `create` response.
@@ -94,6 +148,14 @@ module Plaid
     property :asset_report_id
   end
 
+  # Public: The response wrapper for /asset_report/filter.
+  class AssetReportFilterResponse < AssetReportCreateResponse
+  end
+
+  # Public: The response wrapper for /asset_report/refresh.
+  class AssetReportRefreshResponse < AssetReportCreateResponse
+  end
+
   # Public: The response wrapper for /asset_report/get.
   class AssetReportGetResponse < Models::BaseResponse
     ##
@@ -115,7 +177,7 @@ module Plaid
     property :removed
   end
 
-  # Public: The response wrapper for /audit_copy/create.
+  # Public: The response wrapper for /asset_report/audit_copy/create.
   class AuditCopyCreateResponse < Models::BaseResponse
     ##
     # :attr_reader:
@@ -123,7 +185,11 @@ module Plaid
     property :audit_copy_token
   end
 
-  # Public: The response wrapper for /audit_copy/remove.
+  # Public: The response wrapper for /asset_report/audit_copy/get.
+  class AuditCopyGetResponse < AssetReportGetResponse
+  end
+
+  # Public: The response wrapper for /asset_report/audit_copy/remove.
   class AuditCopyRemoveResponse < Models::BaseResponse
     ##
     # :attr_reader:

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '6.1.0'.freeze
+  VERSION = '6.2.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.1.0
+  version: 6.2.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday