plaid 21.3.0 → 23.0.0

data/lib/plaid/models/transfer_balance_get_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_balance_get_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_balance_type.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_cancel_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_cancel_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_capabilities_get_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -22,10 +22,10 @@ module Plaid
     # Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
     attr_accessor :secret
 
-    # The Plaid `access_token` for the account that will be debited or credited. Required if not using `payment_profile_token`.
+    # The Plaid `access_token` for the account that will be debited or credited.
     attr_accessor :access_token
 
-    # The Plaid `account_id` corresponding to the end-user account that will be debited or credited. Required when creating a transfer using an `access_token`.
+    # The Plaid `account_id` corresponding to the end-user account that will be debited or credited.
     attr_accessor :account_id
 
     # A payment profile token associated with the Payment Profile data that is being requested.
@@ -104,12 +104,22 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @access_token.nil?
+        invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @access_token.nil?
+      return false if @account_id.nil?
       true
     end
 

data/lib/plaid/models/transfer_capabilities_get_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_capabilities_get_rtp.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_configuration_get_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -22,7 +22,7 @@ module Plaid
     # Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
     attr_accessor :secret
 
-    # The Plaid client ID of the transfer originator. Should only be present if `client_id` is a third-party sender (TPS).
+    # The Plaid client ID of the transfer originator. Should only be present if `client_id` is a [Platform customer](https://plaid.com/docs/transfer/application/#originators-vs-platforms).
     attr_accessor :originator_client_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/plaid/models/transfer_configuration_get_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_create_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -25,15 +25,12 @@ module Plaid
     # Deprecated. `authorization_id` is now used as idempotency instead.  A random key provided by the client, per unique transfer. Maximum of 50 characters.  The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single transfer is created.
     attr_accessor :idempotency_key
 
-    # The Plaid `access_token` for the account that will be debited or credited. Required if not using `payment_profile_token`.
+    # The Plaid `access_token` for the account that will be debited or credited.
     attr_accessor :access_token
 
-    # The Plaid `account_id` corresponding to the end-user account that will be debited or credited. Required when creating a transfer using an `access_token`.
+    # The Plaid `account_id` corresponding to the end-user account that will be debited or credited.
     attr_accessor :account_id
 
-    # The payment profile token associated with the Payment Profile that will be debited or credited. Required if not using `access_token`.
-    attr_accessor :payment_profile_token
-
     # Plaid’s unique identifier for a transfer authorization. This parameter also serves the purpose of acting as an idempotency identifier.
     attr_accessor :authorization_id
 
@@ -63,6 +60,9 @@ module Plaid
     # Plaid’s unique identifier for a test clock. This field may only be used when using `sandbox` environment. If provided, the `transfer` is created at the `virtual_time` on the provided `test_clock`.
     attr_accessor :test_clock_id
 
+    # The amount to deduct from `transfer.amount` and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g. \"10.00\"). The remainder will go to the end-customer’s Ledger balance. This must be less than or equal to the `transfer.amount`.
+    attr_accessor :facilitator_fee
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -71,7 +71,6 @@ module Plaid
         :'idempotency_key' => :'idempotency_key',
         :'access_token' => :'access_token',
         :'account_id' => :'account_id',
-        :'payment_profile_token' => :'payment_profile_token',
         :'authorization_id' => :'authorization_id',
         :'type' => :'type',
         :'network' => :'network',
@@ -82,7 +81,8 @@ module Plaid
         :'metadata' => :'metadata',
         :'origination_account_id' => :'origination_account_id',
         :'iso_currency_code' => :'iso_currency_code',
-        :'test_clock_id' => :'test_clock_id'
+        :'test_clock_id' => :'test_clock_id',
+        :'facilitator_fee' => :'facilitator_fee'
       }
     end
 
@@ -99,7 +99,6 @@ module Plaid
         :'idempotency_key' => :'String',
         :'access_token' => :'String',
         :'account_id' => :'String',
-        :'payment_profile_token' => :'String',
         :'authorization_id' => :'String',
         :'type' => :'TransferType',
         :'network' => :'TransferNetwork',
@@ -110,7 +109,8 @@ module Plaid
         :'metadata' => :'Hash<String, String>',
         :'origination_account_id' => :'String',
         :'iso_currency_code' => :'String',
-        :'test_clock_id' => :'String'
+        :'test_clock_id' => :'String',
+        :'facilitator_fee' => :'String'
       }
     end
 
@@ -120,7 +120,7 @@ module Plaid
         :'user',
         :'metadata',
         :'origination_account_id',
-        :'test_clock_id'
+        :'test_clock_id',
       ])
     end
 
@@ -159,10 +159,6 @@ module Plaid
         self.account_id = attributes[:'account_id']
       end
 
-      if attributes.key?(:'payment_profile_token')
-        self.payment_profile_token = attributes[:'payment_profile_token']
-      end
-
       if attributes.key?(:'authorization_id')
         self.authorization_id = attributes[:'authorization_id']
       end
@@ -208,6 +204,10 @@ module Plaid
       if attributes.key?(:'test_clock_id')
         self.test_clock_id = attributes[:'test_clock_id']
       end
+
+      if attributes.key?(:'facilitator_fee')
+        self.facilitator_fee = attributes[:'facilitator_fee']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -290,7 +290,6 @@ module Plaid
           idempotency_key == o.idempotency_key &&
           access_token == o.access_token &&
           account_id == o.account_id &&
-          payment_profile_token == o.payment_profile_token &&
           authorization_id == o.authorization_id &&
           type == o.type &&
           network == o.network &&
@@ -301,7 +300,8 @@ module Plaid
           metadata == o.metadata &&
           origination_account_id == o.origination_account_id &&
           iso_currency_code == o.iso_currency_code &&
-          test_clock_id == o.test_clock_id
+          test_clock_id == o.test_clock_id &&
+          facilitator_fee == o.facilitator_fee
     end
 
     # @see the `==` method
@@ -313,7 +313,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, idempotency_key, access_token, account_id, payment_profile_token, authorization_id, type, network, amount, description, ach_class, user, metadata, origination_account_id, iso_currency_code, test_clock_id].hash
+      [client_id, secret, idempotency_key, access_token, account_id, authorization_id, type, network, amount, description, ach_class, user, metadata, origination_account_id, iso_currency_code, test_clock_id, facilitator_fee].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transfer_create_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_credit_funds_source.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_credit_usage_configuration.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_debit_usage_configuration.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_device.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_diligence_document_upload_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -19,7 +19,7 @@ module Plaid
     # The Client ID of the originator whose document that you want to upload.
     attr_accessor :originator_client_id
 
-    # A file to upload.
+    # A file to upload. The file size must be less than 20MB. Supported file extensions: .pdf, .docx, .doc.
     attr_accessor :file
 
     attr_accessor :purpose

data/lib/plaid/models/transfer_diligence_document_upload_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_diligence_status.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -15,6 +15,8 @@ require 'time'
 
 module Plaid
   class TransferDiligenceStatus
+    NOT_SUBMITTED = "not_submitted".freeze
+    SUBMITTED = "submitted".freeze
     UNDER_REVIEW = "under_review".freeze
     APPROVED = "approved".freeze
     DENIED = "denied".freeze

data/lib/plaid/models/transfer_diligence_submit_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_diligence_submit_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_document_purpose.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_event.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -24,13 +24,13 @@ module Plaid
 
     attr_accessor :event_type
 
-    # The account ID associated with the transfer.
+    # The account ID associated with the transfer. This field is omitted for Plaid Ledger Sweep events.
     attr_accessor :account_id
 
     # The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.
     attr_accessor :funding_account_id
 
-    # Plaid’s unique identifier for a transfer.
+    # Plaid’s unique identifier for a transfer. This field is `null` for Plaid Ledger Sweep events.
     attr_accessor :transfer_id
 
     # The ID of the origination account that this balance belongs to.
@@ -38,7 +38,7 @@ module Plaid
 
     attr_accessor :transfer_type
 
-    # The amount of the transfer (decimal string with two digits of precision e.g. \"10.00\").
+    # The amount of the transfer (decimal string with two digits of precision e.g. \"10.00\"). This field is omitted for Plaid Ledger Sweep events.
     attr_accessor :transfer_amount
 
     attr_accessor :failure_reason
@@ -90,7 +90,7 @@ module Plaid
         :'funding_account_id' => :'String',
         :'transfer_id' => :'String',
         :'origination_account_id' => :'String',
-        :'transfer_type' => :'TransferType',
+        :'transfer_type' => :'OmittableTransferType',
         :'transfer_amount' => :'String',
         :'failure_reason' => :'TransferFailure',
         :'sweep_id' => :'String',
@@ -206,22 +206,10 @@ module Plaid
         invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
       end
 
-      if @account_id.nil?
-        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
-      end
-
       if @transfer_id.nil?
         invalid_properties.push('invalid value for "transfer_id", transfer_id cannot be nil.')
       end
 
-      if @transfer_type.nil?
-        invalid_properties.push('invalid value for "transfer_type", transfer_type cannot be nil.')
-      end
-
-      if @transfer_amount.nil?
-        invalid_properties.push('invalid value for "transfer_amount", transfer_amount cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -232,10 +220,7 @@ module Plaid
       return false if @event_id < 0
       return false if @timestamp.nil?
       return false if @event_type.nil?
-      return false if @account_id.nil?
       return false if @transfer_id.nil?
-      return false if @transfer_type.nil?
-      return false if @transfer_amount.nil?
       true
     end
 

data/lib/plaid/models/transfer_event_list_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_event_list_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_event_list_transfer_type.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_event_sync_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_event_sync_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_event_type.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -24,6 +24,11 @@ module Plaid
     SWEPT = "swept".freeze
     SWEPT_SETTLED = "swept_settled".freeze
     RETURN_SWEPT = "return_swept".freeze
+    SWEEP_PENDING = "sweep.pending".freeze
+    SWEEP_POSTED = "sweep.posted".freeze
+    SWEEP_SETTLED = "sweep.settled".freeze
+    SWEEP_RETURNED = "sweep.returned".freeze
+    SWEEP_FAILED = "sweep.failed".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/plaid/models/transfer_events_update_webhook.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/transfer_failure.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.419.0
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0