plaid 8.4.0 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f70479c2504298edafa057a0924b2c2132f20d88d0fa0cbe0ae9bcb56487aa06
-  data.tar.gz: b0a7b9a3976e543e02ca97c99544cc41745543bbfe77c23d319a1e57053e77d3
+  metadata.gz: da09c74c4e425edb5481861ca9be64d5fbb8dbda67b742d34ca707fb90afc088
+  data.tar.gz: d43ec775772db6a2a89738654864378f6cbbe037c53d5673c2f93ff8516cf1c6
 SHA512:
-  metadata.gz: ceab5477a6a2a2113c9025027a7f80c709d4db419c09e9f43f9a20500c29c7dd3abe28f8cf3ac849ee94a3e3006100846611344e63a34b9fa88f84629f453fa4
-  data.tar.gz: 8a6bb6cf0a09ee13dec7f8025599f112f891de8dfe899aa231d2467f961f9e4b2519564d791d52c886e2ee34c1eb8a27f7c2a45a0a6aa9fb0d7f8d89374df9f9
+  metadata.gz: dbcc0d8ab622c492f5cbf61fb2f32f6d75b52099e7c379524fe6736d9674adca7b9e3f5b302f9571d43667a2f3431818fda9e2806397ab82f9cd74f492f0f569
+  data.tar.gz: 4e8f6b22c61ebd8f73e61c72e079900f3bce5356c5d524557163030a5a5313f35379b3c3069fdd6cd3313700025e243605513810c11ea9ebf971becf5222da69

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 8.5.0 10-Feb-2020
+
+* Add support for deposit switch product ([#251](https://github.com/plaid/plaid-ruby/pull/251))
+* Add support for generic processor token ([#256](https://github.com/plaid/plaid-ruby/pull/256))
+* Add support for webhook verification ([#249](https://github.com/plaid/plaid-ruby/pull/249))
+
 # 8.4.0 23-Jan-2020
 
 * Add support for new UK Payment Initiation product ([#246](https://github.com/plaid/plaid-ruby/pull/246))

data/Gemfile.lock

@@ -55,4 +55,4 @@ DEPENDENCIES
   vcr (~> 4.0.0)
 
 BUNDLED WITH
-   1.16.2
+   1.17.2

data/lib/plaid.rb

@@ -11,6 +11,7 @@ require_relative 'plaid/products/asset_report'
 require_relative 'plaid/products/auth'
 require_relative 'plaid/products/categories'
 require_relative 'plaid/products/credit_details'
+require_relative 'plaid/products/deposit_switch'
 require_relative 'plaid/products/identity'
 require_relative 'plaid/products/income'
 require_relative 'plaid/products/institutions'
@@ -21,6 +22,7 @@ require_relative 'plaid/products/transactions'
 require_relative 'plaid/products/investments'
 require_relative 'plaid/products/liabilities'
 require_relative 'plaid/products/payment_initiation'
+require_relative 'plaid/products/webhooks'
 require_relative 'plaid/client'
 
 # Public: The namespace for all the things Plaid.

data/lib/plaid/client.rb

@@ -57,6 +57,11 @@ module Plaid
     # Public: The Plaid::CreditDetails product accessor.
     subproduct :credit_details
 
+    ##
+    # :attr_reader:
+    # Public: The Plaid::DepositSwitch product accessor.
+    subproduct :deposit_switch
+
     ##
     # :attr_reader:
     # Public: The Plaid::Identity product accessor.
@@ -107,6 +112,11 @@ module Plaid
     # Public: The Plaid::PaymentInitiation product accessor.
     subproduct :payment_initiation
 
+    ##
+    # :attr_reader:
+    # Public: The Plaid::Webhooks endpoint accessor.
+    subproduct :webhooks
+
     # Public: Make a post request
     #
     # path    - Path or URL to make the request to

data/lib/plaid/models.rb

@@ -1081,6 +1081,11 @@ module Plaid
       # Public: The String transaction type (or nil). E.g. "buy" or "sell".
       property :type
 
+      ##
+      # :attr_reader:
+      # Public: The String transaction type (or nil). E.g. "buy" or "sell".
+      property :subtype
+
       ##
       # :attr_reader:
       # Public: The ISO currency code of the transaction, either USD or CAD.
@@ -1908,5 +1913,53 @@ module Plaid
       # Public: The recipient ID for payment.
       property :recipient_id
     end
+
+    # Public: A representation of a payment amount.
+    class WebhookVerificationKey < BaseModel
+      ##
+      # :attr_reader:
+      # Public: alg.
+      property :alg
+
+      ##
+      # :attr_reader:
+      # Public: created_at.
+      property :created_at
+
+      ##
+      # :attr_reader:
+      # Public: crv.
+      property :crv
+
+      ##
+      # :attr_reader:
+      # Public: expired_at.
+      property :expired_at
+
+      ##
+      # :attr_reader:
+      # Public: kid.
+      property :kid
+
+      ##
+      # :attr_reader:
+      # Public: kty.
+      property :kty
+
+      ##
+      # :attr_reader:
+      # Public: use.
+      property :use
+
+      ##
+      # :attr_reader:
+      # Public: x.
+      property :x
+
+      ##
+      # :attr_reader:
+      # Public: y.
+      property :y
+    end
   end
 end

data/lib/plaid/products/deposit_switch.rb

@@ -0,0 +1,99 @@
+module Plaid
+  # Public: Class used to call the Deposit Switch product.
+  class DepositSwitch < BaseProduct
+    # Public: Get Deposit Switch information.
+    #
+    # Does a POST /deposit_switch/get call which fetches deposit switch
+    # associated with a deposit switch id.
+    #
+    # deposit_switch_id - deposit_switch_id to fetch deposit switch
+    # Returns the DepositSwitchResponse object with deposit switch data.
+    def get(deposit_switch_id)
+      post_with_auth 'deposit_switch/get',
+                     GetResponse,
+                     deposit_switch_id: deposit_switch_id
+    end
+
+    # Public: Response wrapper for /deposit_switch/get.
+    class GetResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The ID associated with the deposit switch.
+      property :deposit_switch_id
+
+      ##
+      # :attr_reader:
+      # Public: The ID of the item that the deposit switch was a target to.
+      property :target_item_id
+
+      ##
+      # :attr_reader:
+      # Public: The ID of the account that the deposit switch was a target to.
+      property :target_account_id
+
+      ##
+      # :attr_reader:
+      # Public: The state that the deposit switch is in.
+      property :state
+
+      ##
+      # :attr_reader:
+      # Public: The date on which the deposit switch was created.
+      property :date_created
+
+      ##
+      # :attr_reader:
+      # Public: The date on which the deposit switch was completed.
+      property :date_completed
+    end
+
+    # Public: Create Deposit Switch.
+    #
+    # Does a POST /deposit_switch/create call which creates a deposit switch
+    #
+    # target_account_id - ID of the bank account for the deposit switch
+    # target_access_token - access token for the switch
+    #
+    # Returns the DepositSwitchResponse object with deposit switch data.
+    def create(target_account_id, target_access_token)
+      post_with_auth 'deposit_switch/create',
+                     CreateResponse,
+                     target_account_id: target_account_id,
+                     target_access_token: target_access_token
+    end
+    # Public: Response wrapper for /deposit_switch/create.
+    class CreateResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The ID associated with the deposit switch
+      property :deposit_switch_id
+    end
+
+    # Public: Create Deposit Switch token.
+    #
+    # Does a POST /deposit_switch/token/create call which creates a deposit
+    # switch.
+    #
+    # deposit_switch_item - ID of the deposit switch
+    #
+    # Returns the CreateTokenResponse object.
+    def create_token(deposit_switch_id)
+      post_with_auth 'deposit_switch/token/create',
+                     CreateTokenResponse,
+                     deposit_switch_id: deposit_switch_id
+    end
+
+    # Public: Response wrapper for /deposit_switch/create.
+    class CreateTokenResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: A deposit switch token for the deposit switch.
+      property :deposit_switch_token
+
+      ##
+      # :attr_reader:
+      # Public: The expiration time of the deposit switch token
+      property :deposit_switch_token_expiration_time
+    end
+  end
+end

data/lib/plaid/products/item.rb

@@ -204,5 +204,30 @@ module Plaid
       # Public: The Boolean flag meaning successful removal.
       property :removed
     end
+
+    # Public: Import an item.
+    #
+    # Does a POST /item/import call which imports an item.
+    #
+    # products - array of products to enable
+    # user_auth - hash map of user authentication information
+    # options - optional hash map of options
+    #
+    # Returns an access token for the item.
+    def import(products, user_auth, options)
+      post_with_auth 'item/import',
+                     ImportResponse,
+                     products: products,
+                     user_auth: user_auth,
+                     options: options
+    end
+
+    # Public: Response for /item/import.
+    class ImportResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The access token string
+      property :access_token
+    end
   end
 end

data/lib/plaid/products/processor.rb

@@ -126,6 +126,40 @@ module Plaid
     subproduct :processor_token, ProcessorToken
   end
 
+  # Public: Class used to call the generic ProcessorToken sub-product.
+  class ProcessorToken < BaseProduct
+    # Public: Creates a processor token from an access_token.
+    #
+    # Does a POST /processor/token/create call which can be used to
+    # generate any non-stripe processor token for a given account ID.
+    # If the processor is Stripe, the stripe endpoint will be called
+    # instead.
+    #
+    # access_token - access_token to create a public token for.
+    # account_id - ID of the account to create a processor token for.
+    # processor - name of the processor to create a token for.
+    #
+    # Returns a ProcessorTokenResponse object containing a processor token.
+    def create(access_token, account_id, processor)
+      endpoint = 'processor/token/create'
+      options = {
+        access_token: access_token,
+        account_id: account_id,
+        processor: processor
+      }
+
+      if processor == 'stripe'
+        endpoint = '/processor/stripe/bank_account_token/create'
+        options.delete(:processor)
+      elsif processor == 'apex'
+        endpoint = '/processor/apex/processor_token/create'
+        options.delete(:processor)
+      end
+
+      post_with_auth endpoint, ProcessorTokenResponse, **options
+    end
+  end
+
   # Public: Class used to call the Processor product.
   class Processor < BaseProduct
     ##
@@ -147,5 +181,10 @@ module Plaid
     # :attr_reader:
     # Public: The Plaid::Ocrolus product accessor.
     subproduct :ocrolus
+
+    ##
+    # :attr_reader:
+    # Public: The Plaid::ProcessorToken product accessor.
+    subproduct :processor_token
   end
 end

data/lib/plaid/products/webhooks.rb

@@ -0,0 +1,23 @@
+module Plaid
+  # Public: Class used to call the Webhooks endpoint.
+  class Webhooks < BaseProduct
+    # Public: Retrieve a webhook verification key.
+    #
+    # key_id - The key ID from the Plaid-Verification header.
+    #
+    # Returns a WebhookVerificationKeyGetResponse object.
+    def get_verification_key(key_id)
+      post_with_auth 'webhook_verification_key/get',
+                     WebhookVerificationKeyGetResponse,
+                     key_id: key_id
+    end
+
+    # Public: The response wrapper for /webhook_verification_key/get.
+    class WebhookVerificationKeyGetResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The webhook verification key.
+      property :key, coerce: Models::WebhookVerificationKey
+    end
+  end
+end

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '8.4.0'.freeze
+  VERSION = '8.5.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: 8.4.0
+  version: 8.5.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-23 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -197,6 +197,7 @@ files:
 - lib/plaid/products/base_product.rb
 - lib/plaid/products/categories.rb
 - lib/plaid/products/credit_details.rb
+- lib/plaid/products/deposit_switch.rb
 - lib/plaid/products/identity.rb
 - lib/plaid/products/income.rb
 - lib/plaid/products/institutions.rb
@@ -207,6 +208,7 @@ files:
 - lib/plaid/products/processor.rb
 - lib/plaid/products/sandbox.rb
 - lib/plaid/products/transactions.rb
+- lib/plaid/products/webhooks.rb
 - lib/plaid/version.rb
 - plaid.gemspec
 homepage: https://plaid.com/
@@ -229,8 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Plaid