plaid 7.0.0.rc0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f251b7c70ec04163c7e8e4fd398fb51289335177
-  data.tar.gz: d2a80a47518e12c6ca387e16d23a005d30bf4d63
+  metadata.gz: 18ef4b160f63f39b30052f19f7ca073f168f4b6a
+  data.tar.gz: 7e30c7bf3971f6fdfc5c4f8863511c3a7b2467ac
 SHA512:
-  metadata.gz: cf03af5a0686a67c11388a8ba91fc10728c0c2d6e61e9fa48e1f9374d569eda9f4251b19dac1a83a5b300ebb553a6fc38cc642f47db93e0350c80c7e6e075264
-  data.tar.gz: 52fee6178dd77d0cb0320744c55f9b594a9cd40c10050876b238ba805ef857ed3fec2a8e7d6029b4fd466b19abb1e4a825c7c35bc0d603b293e4608c6ba2aaa1
+  metadata.gz: d94f18dcde295e44579da99448868145253ecc85d67699f2e60e8b332776c2e2cde77fed83eae657c517b99f3777407d27ffeb86583b2d78477606cc5b5d2b4e
+  data.tar.gz: f163eb2379937e625e852094398cc6b7c9e6f60ff801a400e25b30e2e4ce3fc779ffa1f1dd7657855d0ab6a5d5b2a32be4670b1706a1380da800ec8b1a067f65

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 7.0.0 20-May-2019
+
+* Add support for 2019-05-29 API version
+
+# 6.3.1 20-Mar-2019
+
+* Remove unnecessary log line
+
 # 6.3.0 5-Mar-2019
 
 * Add support for include_institution_data to /institutions/search endpoint.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (7.0.0.rc0)
+    plaid (6.2.1)
       faraday
       faraday_middleware
       hashie (>= 3.4.3)
@@ -10,23 +10,23 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    dotenv (2.7.1)
-    faraday (0.15.4)
+    dotenv (2.4.0)
+    faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.13.1)
+    faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
-    hashie (3.6.0)
+    hashie (3.5.7)
     minitest (5.11.3)
     minitest-around (0.4.1)
       minitest (~> 5.0)
     multipart-post (2.0.0)
-    parallel (1.14.0)
-    parser (2.6.0.0)
+    parallel (1.12.1)
+    parser (2.5.1.0)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
+    powerpack (0.1.1)
     rainbow (3.0.0)
-    rake (12.3.2)
-    rdoc (6.1.1)
+    rake (12.3.1)
+    rdoc (6.0.4)
     rubocop (0.53.0)
       parallel (~> 1.10)
       parser (>= 2.5)
@@ -34,17 +34,17 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.9.0)
     sdoc (1.0.0)
       rdoc (>= 5.0)
-    unicode-display_width (1.5.0)
+    unicode-display_width (1.3.2)
     vcr (4.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 1.7)
   dotenv
   minitest (~> 5.10)
   minitest-around (~> 0.4.0)
@@ -55,4 +55,4 @@ DEPENDENCIES
   vcr (~> 4.0.0)
 
 BUNDLED WITH
-   1.17.3
+   1.16.2

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 |
 | ----------- | ------------------ |
-| [`2018-05-22`][api-version-2018-05-22] (**latest**) | `6.x.x` |
+| [`2019-05-29`][api-version-2019-05-29] (**latest**) | `7.x.x` |
+| [`2018-05-22`][api-version-2018-05-22] | `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].
@@ -215,8 +216,6 @@ Any API call returns a response object which is accessible by dot notation
 and `response['foo']['bar']`. Expected keys for all types of responses are defined,
 and any attempt to access an unknown key will cause `NoMethodError` exception.
 
-These strict model checks can be disabled by setting `Plaid.relaxed_models = true`.
-
 ## Network Timeout
 
 A network timeout value is currently defaulted at 600 seconds = 10 minutes.
@@ -238,4 +237,5 @@ If you're looking for a Ruby client that works with the legacy Plaid API, use th
 
 [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-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

data/lib/plaid.rb

@@ -26,9 +26,9 @@ module Plaid
   #
   # We support two modes for parsing response bodies.
   #
-  # Strict mode (default). Unknown attributes will cause NoMethodError.
+  # Strict mode: Unknown attributes will cause NoMethodError.
   #
-  # Relaxed mode. If a response contains an unknown
+  # Relaxed mode (default): If a response contains an unknown
   # attribute, it won't cause any error and will be accessible
   # using brackets notation: `response['unknown_attribute']`.
   #

data/lib/plaid/models.rb

@@ -7,10 +7,21 @@ module Plaid
       include Hashie::Extensions::Dash::IndifferentAccess
       include Hashie::Extensions::Dash::Coercion
 
+      @ignored_properties = []
+
+      def self.property_ignored?(property)
+        if defined? @ignored_properties
+          @ignored_properties.include?(property)
+        else
+          false
+        end
+      end
+
       # Internal: Be strict or forgiving depending on Plaid.relaxed_models
       # value.
       def assert_property_exists!(property)
-        super unless Plaid.relaxed_models?
+        super unless Plaid.relaxed_models? ||
+                     self.class.property_ignored?(property)
       end
     end
 
@@ -118,6 +129,49 @@ module Plaid
       property :webhook
     end
 
+    # Public: A representation of Item webhook status
+    class ItemStatusLastWebhook < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The String last code sent (or nil).
+      # (e.g. "HISTORICAL_UPDATE").
+      property :code_sent
+
+      ##
+      # :attr_reader:
+      # Public: the String sent at date (or nil).
+      # (e.g. "2019-04-22T00:00:00Z").
+      property :sent_at
+    end
+
+    # Public: A representation of Item transaction update status
+    class ItemStatusTransactions < BaseModel
+      ##
+      # :attr_reader:
+      # Public: the String last failed update date (or nil).
+      # (e.g. "2019-04-22T00:00:00Z").
+      property :last_failed_update
+
+      ##
+      # :attr_reader:
+      # Public: the String last successful update date (or nil).
+      # (e.g. "2019-04-22T00:00:00Z").
+      property :last_successful_update
+    end
+
+    # Public: A representation of Item status
+    class ItemStatus < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The ItemStatusLastWebhook for this ItemStatus.
+      property :last_webhook, coerce: ItemStatusLastWebhook
+
+      ##
+      # :attr_reader:
+      # Public: The ItemStatusTransactions for this ItemStatus.
+      property :transactions, coerce: ItemStatusTransactions
+    end
+
     # Public: A representation of account balances.
     class Balances < BaseModel
       ##
@@ -183,6 +237,12 @@ module Plaid
       # :attr_reader:
       # Public: The String subtype, e.g. "checking".
       property :subtype
+
+      ##
+      # :attr_reader:
+      # Public: The String verification status,
+      # e.g "manually_verified" (optional).
+      property :verification_status
     end
 
     # Public: A representation of an ACH account number.
@@ -233,7 +293,7 @@ module Plaid
       property :institution
     end
 
-    # Public: A representation of an international account number.
+    # Public: A representation of an International account number.
     class NumberInternational < BaseModel
       ##
       # :attr_reader:
@@ -243,16 +303,17 @@ module Plaid
 
       ##
       # :attr_reader:
-      # Public: The account's IBAN.
+      # Public: The String International Bank Account Number (IBAN). E.g.
+      # "GB33BUKB20201555555555".
       property :iban
 
       ##
       # :attr_reader:
-      # Public: The account's BIC.
+      # Public: The String Bank Identifier Code (BIC). E.g. "BUKBGB22".
       property :bic
     end
 
-    # Public: A representation of an BACS (UK) account number.
+    # Public: A representation of a BACS (British) account number.
     class NumberBACS < BaseModel
       ##
       # :attr_reader:
@@ -262,12 +323,12 @@ module Plaid
 
       ##
       # :attr_reader:
-      # Public: The account's (UK) account number.
+      # Public: The String account number. E.g. "66374958".
       property :account
 
       ##
       # :attr_reader:
-      # Public: The account's (UK) sort code.
+      # Public: The String sort code. E.g. "089999".
       property :sort_code
     end
 
@@ -407,7 +468,7 @@ module Plaid
 
       ##
       # :attr_reader:
-      # Public: The String region name.
+      # Public: The String region or state name.
       property :region
 
       ##
@@ -417,18 +478,12 @@ module Plaid
 
       ##
       # :attr_reader:
-      # Public: The String country, an ISO-3166-1 alpha-2 code.
+      # Public: The String country code.
       property :country
     end
 
     # Public: A representation of Identity address data.
     class IdentityAddress < BaseModel
-      ##
-      # :attr_reader:
-      # Public: The Array of String accounts, associated with this address.
-      # E.g. ["Plaid Credit Card 3333"].
-      property :accounts
-
       ##
       # :attr_reader:
       # Public: The Boolean primary flag (true if it's the primary address).
@@ -527,6 +582,14 @@ module Plaid
       property :name
     end
 
+    # Public: A representation of an account with owners
+    class AccountWithOwners < Account
+      ##
+      # :attr_reader:
+      # Public: The Array of owners.
+      property :owners, coerce: Array[Identity]
+    end
+
     # Public: A representation of Income data.
     class Income < BaseModel
       ##
@@ -578,6 +641,8 @@ module Plaid
 
     # Public: A representation of an institution login credential.
     class InstitutionCredential < BaseModel
+      @ignored_properties = ['flexible_input_spec']
+
       ##
       # :attr_reader:
       # Public: The String label. E.g. "User ID".
@@ -594,8 +659,59 @@ module Plaid
       property :type
     end
 
+    # Public: A representation of Institution status breakdown.
+    class InstitutionStatusBreakdown < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The Numeric success percentage.
+      # (e.g. 0.970)
+      property :success
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric Plaid error percentage.
+      # (e.g. 0.010)
+      property :error_plaid
+
+      ##
+      # :attr_reader:
+      # Public: The Numeric Institution error percentage.
+      # (e.g. 0.020)
+      property :error_institution
+    end
+
+    # Public: A representation of Institution item logins status.
+    class InstitutionStatusItemLogins < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The String last status change date.
+      # (e.g. "2019-04-22T20:52:00Z")
+      property :last_status_change
+
+      ##
+      # :attr_reader:
+      # Public: The String status.
+      # (e.g. one of "HEALTHY"|"DEGRADED"|"DOWN")
+      property :status
+
+      ##
+      # :attr_reader:
+      # Public: The breakdown for this Institution status.
+      property :breakdown, coerce: InstitutionStatusBreakdown
+    end
+
+    # Public: A representation of Institution status.
+    class InstitutionStatus < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The Item logins status for this InstitutionStatus.
+      property :item_logins, coerce: InstitutionStatusItemLogins
+    end
+
     # Public: A representation of Institution.
     class Institution < BaseModel
+      @ignored_properties = ['input_spec']
+
       ##
       # :attr_reader:
       # Public: The Array of InstitutionCredential, presenting information on
@@ -635,6 +751,12 @@ module Plaid
       # E.g. ["auth", "balance", "identity", "transactions"].
       property :products
 
+      ##
+      # :attr_reader:
+      # Public: The Array of String country codes supported by this institution.
+      # E.g. ["US", "GB"].
+      property :country_codes
+
       ##
       # :attr_reader:
       # Public: The String primary color for this institution (e.g. "#095aa6").
@@ -650,6 +772,16 @@ module Plaid
       # Public: The String base 64 encoded url for this institution
       # E.g. "https://www.plaid.com").
       property :url
+
+      ##
+      # :attr_reader:
+      # Public: The Status for this Institution (or nil).
+      property :status, coerce: InstitutionStatus
+
+      ##
+      # :attr_reader:
+      # Public: The Array of String country codes supported by this institution.
+      property :country_codes
     end
 
     module MFA
@@ -717,7 +849,7 @@ module Plaid
 
       ##
       # :attr_reader:
-      # Public: The String region name (or nil).
+      # Public: The String region or state name (or nil).
       property :region
 
       ##
@@ -732,7 +864,7 @@ module Plaid
 
       ##
       # :attr_reader:
-      # Public: The String country, an ISO-3166-1 alpha-2 code.
+      # Public: The country code (or nil).
       property :country
     end
 
@@ -851,8 +983,7 @@ module Plaid
       property :unofficial_currency_code
     end
 
-    # Public: A representation of Identity address details returned by the
-    # assets endpoint.
+    # Public: A representation of asset report address details.
     class AssetReportAddressData < BaseModel
       ##
       # :attr_reader:
@@ -871,7 +1002,7 @@ module Plaid
 
       ##
       # :attr_reader:
-      # Public: The String ZIP code.
+      # Public: The String zip code.
       property :zip
     end
 
@@ -880,7 +1011,7 @@ module Plaid
       ##
       # :attr_reader:
       # Public: Data about the components comprising an address; see
-      # AssetReportAddressData object for fields.
+      # IdentityAddressData object for fields.
       property :data, coerce: AssetReportAddressData
 
       ##
@@ -972,45 +1103,6 @@ module Plaid
       property :unofficial_currency_code
     end
 
-    # Public: A representation of Transaction location returned by asset
-    # reports.
-    class AssetReportTransactionLocation < BaseModel
-      ##
-      # :attr_reader:
-      # Public: The String address (or nil).
-      property :address
-
-      ##
-      # :attr_reader:
-      # Public: The String city name (or nil).
-      property :city
-
-      ##
-      # :attr_reader:
-      # Public: The Numeric latitude of the place (or nil).
-      property :lat
-
-      ##
-      # :attr_reader:
-      # Public: The Numeric longitude of the place (or nil).
-      property :lon
-
-      ##
-      # :attr_reader:
-      # Public: The String state name (or nil).
-      property :state
-
-      ##
-      # :attr_reader:
-      # Public: The String store number (or nil).
-      property :store_number
-
-      ##
-      # :attr_reader:
-      # Public: The String ZIP code (or nil).
-      property :zip
-    end
-
     # Public: A representation of an asset report transaction.
     class AssetReportTransaction < BaseModel
       ##
@@ -1085,9 +1177,9 @@ module Plaid
 
       ##
       # :attr_reader: Public: The location where transaction occurred
-      # (AssetReportTransactionLocation). This field only appears in an Asset
-      # Report with Insights.
-      property :location, coerce: AssetReportTransactionLocation
+      # (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

data/lib/plaid/products/identity.rb

@@ -21,12 +21,7 @@ module Plaid
     ##
     # :attr_reader:
     # Public: The list of accounts: Array of Plaid::Models::Account.
-    property :accounts, coerce: Array[Models::Account]
-
-    ##
-    # :attr_reader:
-    # Public: Identity information: Plaid::Models::Identity.
-    property :identity, coerce: Models::Identity
+    property :accounts, coerce: Array[Models::AccountWithOwners]
 
     ##
     # :attr_reader:

data/lib/plaid/products/item.rb

@@ -331,6 +331,11 @@ module Plaid
       # :attr_reader:
       # Public: The item: Plaid::Models::Item.
       property :item, coerce: Models::Item
+
+      ##
+      # :attr_reader:
+      # Public: The item status: Plaid::Models::ItemStatus.
+      property :status, coerce: Models::ItemStatus
     end
 
     # Public: Removes an item

data/lib/plaid/products/sandbox.rb

@@ -21,6 +21,29 @@ module Plaid
       # Public: The Boolean reset success flag.
       property :reset_login
     end
+
+    # Public: Fires a webhook for a sandbox item
+    #
+    # Does a POST /sandbox/item/fire_webhook call.
+    #
+    # access_token - access_token of the item to fire a webhook for.
+    # webhook_code - webhook_code to fire.
+    #
+    # Returns a FireWebhookResponse object.
+    def fire_webhook(access_token, webhook_code)
+      post_with_auth 'sandbox/item/fire_webhook',
+                     FireWebhookResponse,
+                     access_token: access_token,
+                     webhook_code: webhook_code
+    end
+
+    # Public: Response for /sandbox/item/fire_webhook.
+    class FireWebhookResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The Boolean webhook fired success flag.
+      property :webhook_fired
+    end
   end
 
   # Public: Class used to call the SandboxPublicToken sub-product

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '7.0.0.rc0'.freeze
-  API_VERSION = '2019-02-14'.freeze
+  VERSION = '7.0.0'.freeze
+  API_VERSION = '2019-05-29'.freeze
 end

data/plaid.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.add_dependency 'faraday_middleware'
   spec.add_dependency 'hashie', '>= 3.4.3'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'minitest', '~> 5.10'
   spec.add_development_dependency 'minitest-around', '~> 0.4.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 7.0.0.rc0
+  version: 7.0.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -222,12 +222,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Plaid