plaid 12.0.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff88844aefb3173ccb877c8764119b67120d08a2f7d3425eef174236be4b6161
-  data.tar.gz: 21103e33e95a4a54d984bdd4e30c0ac7c8e750f18eb542660ed8f55fc10a91c2
+  metadata.gz: 3e1b3a6dd1a43a81dec93cc841fa8272f94fd53e604d6f2826035c221ac0cd1e
+  data.tar.gz: 920032b3617aae75fecbe0e0288e0279ad99ca215103e4e5825322d198560e4f
 SHA512:
-  metadata.gz: 01dd7019a4fd8ee33dc4ebc5bdd069e5c2188476e835a806d8d1e170e84d0eb00f831cba66c65ab73db7264b54a264732e0c00a811f8be94d6f03c09f1f6c2bb
-  data.tar.gz: 363f9143a45caacc0abb0a668f7be9ee019e082814bec7545c00e092770faf2dca0cabe9304aef0624864acdaea8afc60a0baee2fe84209f1074f6bf785e99b2
+  metadata.gz: 1ed91a6d2994ea510d2830e2b002f839098328ef7ece3fe1ed84458e2554f1a5138f5e51b009c32b7367f691b16e3ed94ce0d33497e9adb8eb9d868d2fa278d9
+  data.tar.gz: c2cef50ce789faf7a22d97e0d381f07b3b029ad5406613b3df6bb41cd8402c4552fcf6b852146a8a0c7bf10eceed8460aadc722e292da4cab915ef1af4fd8df5

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-    - image: circleci/ruby:2.3
+    - image: circleci/ruby:2.4
     steps:
     - checkout
     - run:

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.4
 
 Style/FrozenStringLiteralComment:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 13.0.0
+- Add support for providing a payment initiation schedule
+- Add back the (now deprecated) `/item/public_token/create` endpoint
+- Add back the (now deprecated) `/payment_initiation/payment/token/create` endpoint
+
+BREAKING CHANGES:
+
+- Update minimum required Ruby version to 2.4
+
 # 12.0.0
 
 - The library has been pinned to the '2020-09-14' API release. Visit the [docs](https://plaid.com/docs/api/versioning/) to see what changed.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (12.0.0)
+    plaid (13.0.0)
       faraday
       faraday_middleware
       hashie (>= 3.4.3)
@@ -11,8 +11,11 @@ GEM
   specs:
     ast (2.4.0)
     dotenv (2.4.0)
-    faraday (1.0.1)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     hashie (4.1.0)
@@ -35,6 +38,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
+    ruby2_keywords (0.0.2)
     sdoc (1.0.0)
       rdoc (>= 5.0)
     unicode-display_width (1.3.2)

data/README.md

@@ -258,7 +258,7 @@ 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/api-upgrades
-[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
-[api-version-2020-09-14]: https://plaid.com/docs/api-upgrades#2020-09-14
+[version-changelog]: https://plaid.com/docs/api/versioning/
+[api-version-2018-05-22]: https://plaid.com/docs/api/versioning/#2018-05-22
+[api-version-2019-05-29]: https://plaid.com/docs/api/versioning/#2019-05-29
+[api-version-2020-09-14]: https://plaid.com/docs/api/versioning/#2020-09-14

data/lib/plaid/models.rb

@@ -1924,6 +1924,25 @@ module Plaid
       property :value
     end
 
+    # Public: A representation of a payment amount.
+    class PaymentSchedule < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Interval for the standing order.
+      property :interval
+
+      ##
+      # :attr_reader:
+      # Public: Day or the week or day of the month to execute
+      # the standing order.
+      property :interval_execution_day
+
+      ##
+      # :attr_reader:
+      # Public: Start date for the standing order.
+      property :start_date
+    end
+
     # Public: A representation of a payment amount.
     class PaymentRecipientAddress < BaseModel
       ##
@@ -2010,6 +2029,11 @@ module Plaid
       # Public: The payment amount.
       property :amount, coerce: PaymentAmount
 
+      ##
+      # :attr_reader:
+      # Public: The payment schedule.
+      property :schedule, coerce: PaymentSchedule
+
       ##
       # :attr_reader:
       # Public: The payment's status.

data/lib/plaid/products/item.rb

@@ -27,6 +27,37 @@ module Plaid
 
   # Public: Class used to call the PublicToken sub-product
   class PublicToken < BaseProduct
+    # Public: Creates a public token from an access_token.
+    #
+    # Does a POST /item/public_token/create call which can be used to
+    # initialize Link in update mode.
+    #
+    # access_token - access_token to create a public token for
+    #
+    # Returns a CreateResponse object with a public token and expiration info.
+    def create(access_token)
+      puts 'Warning: this method will be deprecated in a future version. '\
+           'To replace the public_token for initializing Link, look into '\
+           'the link_token at https://plaid.com/docs/api/tokens/#linktokencreate.'
+
+      post_with_auth 'item/public_token/create',
+                     CreateResponse,
+                     access_token: access_token
+    end
+
+    # Public: Response for /item/public_token/create.
+    class CreateResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The String token.
+      property :public_token
+
+      ##
+      # :attr_reader:
+      # Public: The String token expiration time.
+      property :expiration
+    end
+
     # Public: Exchange a public token for an access_token
     #
     # Does a POST /item/public_token/exchange call helps you exchange a public

data/lib/plaid/products/payment_initiation.rb

@@ -43,14 +43,39 @@ module Plaid
     # recipient_id - Recipient ID that the payment will be initiated for.
     # reference    - Payment reference.
     # amount       - Payment amount.
+    # schedule     - Payment schedule.
     #
     # Returns a PaymentCreateResponse object.
-    def create_payment(recipient_id, reference, amount)
-      post_with_auth 'payment_initiation/payment/create',
-                     PaymentCreateResponse,
-                     recipient_id: recipient_id,
-                     reference: reference,
-                     amount: amount
+    def create_payment(recipient_id, reference, amount, schedule: nil)
+      if schedule.nil?
+        post_with_auth 'payment_initiation/payment/create',
+                       PaymentCreateResponse,
+                       recipient_id: recipient_id,
+                       reference: reference,
+                       amount: amount
+      else
+        post_with_auth 'payment_initiation/payment/create',
+                       PaymentCreateResponse,
+                       recipient_id: recipient_id,
+                       reference: reference,
+                       amount: amount,
+                       schedule: schedule
+      end
+    end
+
+    # Public: Create a payment token.
+    #
+    # payment_id - Payment ID that the token will be created for.
+    #
+    # Returns a PaymentTokenCreateResponse object.
+    def create_payment_token(payment_id)
+      puts 'Warning: this method will be deprecated in a future version. '\
+           'To replace the payment_token, look into the link_token at '\
+           'https://plaid.com/docs/api/tokens/#linktokencreate.'
+
+      post_with_auth 'payment_initiation/payment/token/create',
+                     PaymentTokenCreateResponse,
+                     payment_id: payment_id
     end
 
     # Public: Retrieve a payment.
@@ -135,6 +160,19 @@ module Plaid
     property :status
   end
 
+  # Public: The response wrapper for /payment_initiation/payment/token/create.
+  class PaymentTokenCreateResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The payment token.
+    property :payment_token
+
+    ##
+    # :attr_reader:
+    # Public: The payment token's expiration time.
+    property :payment_token_expiration_time
+  end
+
   # Public: The response wrapper for /payment_initiation/payment/get.
   class PaymentGetResponse < Models::BaseResponse
     ##
@@ -157,6 +195,11 @@ module Plaid
     # Public: The payment amount.
     property :amount, coerce: Models::PaymentAmount
 
+    ##
+    # :attr_reader:
+    # Public: The payment schedule.
+    property :schedule, coerce: Models::PaymentSchedule
+
     ##
     # :attr_reader:
     # Public: The payment's status.

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '12.0.0'.freeze
+  VERSION = '13.0.0'.freeze
   API_VERSION = '2020-09-14'.freeze
 end

data/plaid.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.4.0'
 
   spec.add_dependency 'faraday'
   spec.add_dependency 'faraday_middleware'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 12.0.0
+  version: 13.0.0
 platform: ruby
 authors:
 - Edmund Loo
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -218,7 +218,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -226,7 +226,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Ruby bindings for Plaid
 test_files: []