plaid 8.3.0 → 8.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 20fabd5a473d42ddb2e3ae9cf23177a368b27a3a
-  data.tar.gz: 19b8c738694ef6da9635b2f422674a8ced3cfe62
+SHA256:
+  metadata.gz: f70479c2504298edafa057a0924b2c2132f20d88d0fa0cbe0ae9bcb56487aa06
+  data.tar.gz: b0a7b9a3976e543e02ca97c99544cc41745543bbfe77c23d319a1e57053e77d3
 SHA512:
-  metadata.gz: fe4fc9ee3f44a9b1318daa4a423aec82347bc09834211b2e85c2d413fdb54a976cfc2e80fd30f461bccc19a96c79edbf7487c2330796d6e7bc3bd08ce5890a5f
-  data.tar.gz: 6569336d7dcfea2f168ecd081a8c0a3fba27518d1006d5f23065ab68b0f68bbacc4b35e5257fc6f92cd71ba056a547295b6837c0644d0ac6df01d0d4207d6b2c
+  metadata.gz: ceab5477a6a2a2113c9025027a7f80c709d4db419c09e9f43f9a20500c29c7dd3abe28f8cf3ac849ee94a3e3006100846611344e63a34b9fa88f84629f453fa4
+  data.tar.gz: 8a6bb6cf0a09ee13dec7f8025599f112f891de8dfe899aa231d2467f961f9e4b2519564d791d52c886e2ee34c1eb8a27f7c2a45a0a6aa9fb0d7f8d89374df9f9

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 8.4.0 23-Jan-2020
+
+* Add support for new UK Payment Initiation product ([#246](https://github.com/plaid/plaid-ruby/pull/246))
+  * `/payment_initiation/recipient/create`
+  * `/payment_initiation/recipient/get`
+  * `/payment_initiation/recipient/list`
+  * `/payment_initiation/payment/create`
+  * `/payment_initiation/payment/token/create`
+  * `/payment_initiation/payment/get`
+  * `/payment_initiation/payment/list`
+* Add `consent_expiration_time` to the Item interface ([#247](https://github.com/plaid/plaid-ruby/pull/247))
+
+
 # 8.3.0 17-Sep-2019
 
 * Add support for new [Ocrolus Partnership](https://plaid.com/docs/ocrolus/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (6.2.1)
+    plaid (8.4.0)
       faraday
       faraday_middleware
       hashie (>= 3.4.3)
@@ -11,15 +11,15 @@ GEM
   specs:
     ast (2.4.0)
     dotenv (2.4.0)
-    faraday (0.15.2)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.12.2)
+    faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
-    hashie (3.5.7)
+    hashie (4.0.0)
     minitest (5.11.3)
     minitest-around (0.4.1)
       minitest (~> 5.0)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     parallel (1.12.1)
     parser (2.5.1.0)
       ast (~> 2.4.0)

data/lib/plaid.rb

@@ -20,6 +20,7 @@ require_relative 'plaid/products/sandbox'
 require_relative 'plaid/products/transactions'
 require_relative 'plaid/products/investments'
 require_relative 'plaid/products/liabilities'
+require_relative 'plaid/products/payment_initiation'
 require_relative 'plaid/client'
 
 # Public: The namespace for all the things Plaid.

data/lib/plaid/client.rb

@@ -102,6 +102,11 @@ module Plaid
     # Public: The Plaid::Investments product accessor.
     subproduct :investments
 
+    ##
+    # :attr_reader:
+    # Public: The Plaid::PaymentInitiation product accessor.
+    subproduct :payment_initiation
+
     # Public: Make a post request
     #
     # path    - Path or URL to make the request to

data/lib/plaid/models.rb

@@ -127,6 +127,12 @@ module Plaid
       # :attr_reader:
       # Public: The String webhook URL.
       property :webhook
+
+      ##
+      # :attr_reader:
+      # Public: The String consent expiration timestamp (or nil)
+      # (e.g. "2019-04-22T00:00:00Z").
+      property :consent_expiration_time
     end
 
     # Public: A representation of Item webhook status
@@ -159,6 +165,21 @@ module Plaid
       property :last_successful_update
     end
 
+    # Public: A representation of Item investments update status
+    class ItemStatusInvestments < 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
       ##
@@ -170,6 +191,11 @@ module Plaid
       # :attr_reader:
       # Public: The ItemStatusTransactions for this ItemStatus.
       property :transactions, coerce: ItemStatusTransactions
+
+      ##
+      # :attr_reader:
+      # Public: The ItemStatusInvestments for this ItemStatus.
+      property :investments, coerce: ItemStatusInvestments
     end
 
     # Public: A representation of account balances.
@@ -986,6 +1012,18 @@ module Plaid
       # :attr_reader:
       # Public: The String unofficial currency code for the amount
       property :unofficial_currency_code
+
+      ##
+      # :attr_reader:
+      # Public: The String channel used to make a payment, e.g.
+      # "online", "in store", or "other".
+      property :payment_channel
+
+      ##
+      # :attr_reader:
+      # Public: The String date that the transaction was authorized,
+      # e.g. "2017-01-01".
+      property :authorized_date
     end
 
     # Public: A representation of an InvestmentTransaction in an investment
@@ -1768,5 +1806,107 @@ module Plaid
       # Public: Student loan liabilities associated with the item.
       property :student, coerce: Array[StudentLoanLiability]
     end
+
+    # Public: A representation of a payment amount.
+    class PaymentAmount < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Currency for the payment amount.
+      property :currency
+
+      ##
+      # :attr_reader:
+      # Public: Value of the payment amount.
+      property :value
+    end
+
+    # Public: A representation of a payment amount.
+    class PaymentRecipientAddress < BaseModel
+      ##
+      # :attr_reader:
+      # Public: Street name.
+      property :street
+
+      ##
+      # :attr_reader:
+      # Public: City.
+      property :city
+
+      ##
+      # :attr_reader:
+      # Public: Postal code.
+      property :postal_code
+
+      ##
+      # :attr_reader:
+      # Public: Country.
+      property :country
+    end
+
+    # Public: A representation of a payment recipient.
+    class PaymentRecipient < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The recipient ID.
+      property :recipient_id
+
+      ##
+      # :attr_reader:
+      # Public: The recipient name.
+      property :name
+
+      ##
+      # :attr_reader:
+      # Public: The recipient IBAN.
+      property :iban
+
+      ##
+      # :attr_reader:
+      # Public: The recipient address.
+      property :address, coerce: PaymentRecipientAddress
+    end
+
+    # Public: A representation of a payment.
+    class Payment < BaseModel
+      ##
+      # :attr_reader:
+      # Public: The payment ID.
+      property :payment_id
+
+      ##
+      # :attr_reader:
+      # Public: The payment token.
+      property :payment_token
+
+      ##
+      # :attr_reader:
+      # Public: The payment reference.
+      property :reference
+
+      ##
+      # :attr_reader:
+      # Public: The payment amount.
+      property :amount, coerce: PaymentAmount
+
+      ##
+      # :attr_reader:
+      # Public: The payment's status.
+      property :status
+
+      ##
+      # :attr_reader:
+      # Public: The last status update time for payment.
+      property :last_status_update
+
+      ##
+      # :attr_reader:
+      # Public: The payment token's expiration time.
+      property :payment_token_expiration_time
+
+      ##
+      # :attr_reader:
+      # Public: The recipient ID for payment.
+      property :recipient_id
+    end
   end
 end

data/lib/plaid/products/payment_initiation.rb

@@ -0,0 +1,211 @@
+module Plaid
+  # Public: Class used to call the Payment product.
+  class PaymentInitiation < BaseProduct
+    # Public: Create a recipient.
+    #
+    # name    - Recipient name.
+    # iban    - Recipient IBAN.
+    # address - Recipient address.
+    #
+    # Returns a PaymentRecipientCreateResponse object.
+    def create_recipient(name, iban, address)
+      post_with_auth 'payment_initiation/recipient/create',
+                     PaymentRecipientCreateResponse,
+                     name: name,
+                     iban: iban,
+                     address: address
+    end
+
+    # Public: Retrieve a recipient.
+    #
+    # recipient_id - The recipient ID from the `create_recipient` response.
+    #
+    # Returns a PaymentRecipientGetResponse object.
+    def get_recipient(recipient_id)
+      post_with_auth 'payment_initiation/recipient/get',
+                     PaymentRecipientGetResponse,
+                     recipient_id: recipient_id
+    end
+
+    # Public: List all recipients.
+    #
+    # Returns a PaymentRecipientListResponse object.
+    def list_recipients
+      post_with_auth 'payment_initiation/recipient/list',
+                     PaymentRecipientListResponse,
+                     {}
+    end
+
+    # Public: Create a payment.
+    #
+    # recipient_id - Recipient ID that the payment will be initiated for.
+    # reference    - Payment reference.
+    # amount       - Payment amount.
+    #
+    # 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
+    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)
+      post_with_auth 'payment_initiation/payment/token/create',
+                     PaymentTokenCreateResponse,
+                     payment_id: payment_id
+    end
+
+    # Public: Retrieve a payment.
+    #
+    # payment_id - The payment ID from the `create_payment` response.
+    #
+    # Returns a PaymentGetResponse object.
+    def get_payment(payment_id)
+      post_with_auth 'payment_initiation/payment/get',
+                     PaymentGetResponse,
+                     payment_id: payment_id
+    end
+
+    # Public: List all payments.
+    #
+    # options - Object to specify optional parameters 'count' and 'cursor'.
+    #           e.g {count: 10, cursor: '2019-12-06T22:35:49Z'} returns 10
+    #           payments initiated before 2019-12-06T22:35:49Z.
+    #
+    # Returns a PaymentListResponse object.
+    def list_payments(options)
+      post_with_auth 'payment_initiation/payment/list',
+                     PaymentListResponse,
+                     options
+    end
+  end
+
+  # Public: The response wrapper for /payment_initiation/recipient/create.
+  class PaymentRecipientCreateResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The recipient ID.
+    property :recipient_id
+  end
+
+  # Public: The response wrapper for /payment_initiation/recipient/get.
+  class PaymentRecipientGetResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The recipient ID.
+    property :recipient_id
+
+    ##
+    # :attr_reader:
+    # Public: The recipient name.
+    property :name
+
+    ##
+    # :attr_reader:
+    # Public: The recipient IBAN.
+    property :iban
+
+    ##
+    # :attr_reader:
+    # Public: The recipient address.
+    property :address, coerce: Models::PaymentRecipientAddress
+  end
+
+  # Public: The response wrapper for /payment_initiation/recipient/list.
+  class PaymentRecipientListResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The list of recipients.
+    property :recipients, coerce: Array[Models::PaymentRecipient]
+  end
+
+  # Public: The response wrapper for /payment_initiation/payment/create.
+  class PaymentCreateResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The payment ID.
+    property :payment_id
+
+    ##
+    # :attr_reader:
+    # Public: The payment status.
+    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
+    ##
+    # :attr_reader:
+    # Public: The payment ID.
+    property :payment_id
+
+    ##
+    # :attr_reader:
+    # Public: The payment token.
+    property :payment_token
+
+    ##
+    # :attr_reader:
+    # Public: The payment reference.
+    property :reference
+
+    ##
+    # :attr_reader:
+    # Public: The payment amount.
+    property :amount, coerce: Models::PaymentAmount
+
+    ##
+    # :attr_reader:
+    # Public: The payment's status.
+    property :status
+
+    ##
+    # :attr_reader:
+    # Public: The last status update time for payment.
+    property :last_status_update
+
+    ##
+    # :attr_reader:
+    # Public: The payment token's expiration time.
+    property :payment_token_expiration_time
+
+    ##
+    # :attr_reader:
+    # Public: The recipient ID for payment.
+    property :recipient_id
+  end
+
+  # Public: The response wrapper for /payment_initiation/payment/list.
+  class PaymentListResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The list of payments.
+    property :payments, coerce: Array[Models::Payment]
+
+    ##
+    # :attr_reader:
+    # Public: The cursor (its a timestamp) to use in the next
+    # /payment_initiation/payment/list call for retrieving more older payments.
+    property :next_cursor
+  end
+end

data/lib/plaid/version.rb

@@ -1,4 +1,4 @@
 module Plaid
-  VERSION = '8.3.0'.freeze
+  VERSION = '8.4.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.3.0
+  version: 8.4.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -203,6 +203,7 @@ files:
 - lib/plaid/products/investments.rb
 - lib/plaid/products/item.rb
 - lib/plaid/products/liabilities.rb
+- lib/plaid/products/payment_initiation.rb
 - lib/plaid/products/processor.rb
 - lib/plaid/products/sandbox.rb
 - lib/plaid/products/transactions.rb
@@ -229,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Plaid