plaid 18.1.0 → 19.1.0

data/lib/plaid/models/transactions_sync_request_options.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -19,7 +19,7 @@ module Plaid
     # Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager or submit a [Support request](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/product-functionality).
     attr_accessor :include_original_description
 
-    # Include the [`personal_finance_category`](https://plaid.com/docs/api/products/transactions/#transactions-sync-response-added-personal-finance-category) object in the response.  See the [`taxonomy csv file`](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.  We’re introducing Category Rules - a new beta endpoint that will enable you to change the `personal_finance_category` for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to transactions-feedback@plaid.com.
+    # Include the [`personal_finance_category`](https://plaid.com/docs/api/products/transactions/#transactions-sync-response-added-personal-finance-category) object in the response.  All implementations are encouraged to use set this field to `true` and to use the `personal_finance_category` instead of `category` for more meaningful and accurate categorization.  See the [`taxonomy csv file`](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.  We’re also introducing Category Rules - a new beta endpoint that will enable you to change the `personal_finance_category` for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to transactions-feedback@plaid.com.
     attr_accessor :include_personal_finance_category
 
     # Include counterparties and extra merchant fields in the transaction. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.

data/lib/plaid/models/transactions_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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -24,7 +24,7 @@ module Plaid
     # The Plaid `account_id` corresponding to the end-user account that will be debited or credited.
     attr_accessor :account_id
 
-    # The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.
+    # 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
 
     attr_accessor :type
@@ -82,11 +82,10 @@ module Plaid
     # The id of the recurring transfer if this transfer belongs to a recurring transfer.
     attr_accessor :recurring_transfer_id
 
-    # The accumulated amount that have been swept to date. This number does not reflect `return_swept` amount if the transfer is returned. Only applies to ACH debit transfers.
-    attr_accessor :settled_amount
+    # The expected sweep settlement schedule of this transfer, assuming this transfer is not `returned`. Only applies to ACH debit transfers.
+    attr_accessor :expected_sweep_settlement_schedule
 
-    # The expected settlement schedule of this transfer, if posted. Only applies to ACH debit transfers.
-    attr_accessor :expected_settlement_schedule
+    attr_accessor :credit_funds_source
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -116,8 +115,8 @@ module Plaid
         :'originator_client_id' => :'originator_client_id',
         :'refunds' => :'refunds',
         :'recurring_transfer_id' => :'recurring_transfer_id',
-        :'settled_amount' => :'settled_amount',
-        :'expected_settlement_schedule' => :'expected_settlement_schedule'
+        :'expected_sweep_settlement_schedule' => :'expected_sweep_settlement_schedule',
+        :'credit_funds_source' => :'credit_funds_source'
       }
     end
 
@@ -154,14 +153,15 @@ module Plaid
         :'originator_client_id' => :'String',
         :'refunds' => :'Array<TransferRefund>',
         :'recurring_transfer_id' => :'String',
-        :'settled_amount' => :'String',
-        :'expected_settlement_schedule' => :'Array<TransferExpectedSettlementScheduleItem>'
+        :'expected_sweep_settlement_schedule' => :'Array<TransferExpectedSweepSettlementScheduleItem>',
+        :'credit_funds_source' => :'TransferCreditFundsSource'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'funding_account_id',
         :'sweep_status',
         :'failure_reason',
         :'metadata',
@@ -172,7 +172,7 @@ module Plaid
         :'expected_settlement_date',
         :'originator_client_id',
         :'recurring_transfer_id',
-        :'settled_amount',
+        :'credit_funds_source'
       ])
     end
 
@@ -295,14 +295,14 @@ module Plaid
         self.recurring_transfer_id = attributes[:'recurring_transfer_id']
       end
 
-      if attributes.key?(:'settled_amount')
-        self.settled_amount = attributes[:'settled_amount']
+      if attributes.key?(:'expected_sweep_settlement_schedule')
+        if (value = attributes[:'expected_sweep_settlement_schedule']).is_a?(Array)
+          self.expected_sweep_settlement_schedule = value
+        end
       end
 
-      if attributes.key?(:'expected_settlement_schedule')
-        if (value = attributes[:'expected_settlement_schedule']).is_a?(Array)
-          self.expected_settlement_schedule = value
-        end
+      if attributes.key?(:'credit_funds_source')
+        self.credit_funds_source = attributes[:'credit_funds_source']
       end
     end
 
@@ -314,10 +314,6 @@ module Plaid
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @funding_account_id.nil?
-        invalid_properties.push('invalid value for "funding_account_id", funding_account_id cannot be nil.')
-      end
-
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -370,7 +366,6 @@ module Plaid
     # @return true if the model is valid
     def valid?
       return false if @id.nil?
-      return false if @funding_account_id.nil?
       return false if @type.nil?
       return false if @user.nil?
       return false if @amount.nil?
@@ -423,8 +418,8 @@ module Plaid
           originator_client_id == o.originator_client_id &&
           refunds == o.refunds &&
           recurring_transfer_id == o.recurring_transfer_id &&
-          settled_amount == o.settled_amount &&
-          expected_settlement_schedule == o.expected_settlement_schedule
+          expected_sweep_settlement_schedule == o.expected_sweep_settlement_schedule &&
+          credit_funds_source == o.credit_funds_source
     end
 
     # @see the `==` method
@@ -436,7 +431,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, ach_class, account_id, funding_account_id, type, user, amount, description, created, status, sweep_status, network, cancellable, failure_reason, metadata, origination_account_id, guarantee_decision, guarantee_decision_rationale, iso_currency_code, standard_return_window, unauthorized_return_window, expected_settlement_date, originator_client_id, refunds, recurring_transfer_id, settled_amount, expected_settlement_schedule].hash
+      [id, ach_class, account_id, funding_account_id, type, user, amount, description, created, status, sweep_status, network, cancellable, failure_reason, metadata, origination_account_id, guarantee_decision, guarantee_decision_rationale, iso_currency_code, standard_return_window, unauthorized_return_window, expected_settlement_date, originator_client_id, refunds, recurring_transfer_id, expected_sweep_settlement_schedule, credit_funds_source].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transfer_authorization.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_authorization_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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -56,18 +56,20 @@ module Plaid
     # A random key provided by the client, per unique authorization. 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 an authorization fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single authorization is created.  Failure to provide this key may result in duplicate charges.  Required for guaranteed ACH customers.
     attr_accessor :idempotency_key
 
-    # Required for Guarantee. If the end user is initiating the specific transfer themselves via an interactive UI, this should be `true`; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be `false`.
+    # If the end user is initiating the specific transfer themselves via an interactive UI, this should be `true`; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be `false`.
     attr_accessor :user_present
 
-    # If set to `false`, Plaid will not offer a `guarantee_decision` for this request(Guarantee customers only).
+    # If set to `false`, Plaid will not offer a `guarantee_decision` for this request (Guarantee customers only).
     attr_accessor :with_guarantee
 
-    # The unique identifier returned by Plaid's [beacon](https://plaid.com/docs/transfer/guarantee/#using-a-beacon) when it is run on your webpage. Required for Guarantee customers who are not using [Transfer UI](https://plaid.com/docs/transfer/using-transfer-ui/) and have a web checkout experience.
+    # The unique identifier returned by Plaid's [beacon](https://plaid.com/docs/transfer/guarantee/#using-a-beacon) when it is run on your webpage.
     attr_accessor :beacon_session_id
 
     # The Plaid client ID that is the originator of this transfer. Only needed if creating transfers on behalf of another client as a third-party sender (TPS).
     attr_accessor :originator_client_id
 
+    attr_accessor :credit_funds_source
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -89,7 +91,8 @@ module Plaid
         :'user_present' => :'user_present',
         :'with_guarantee' => :'with_guarantee',
         :'beacon_session_id' => :'beacon_session_id',
-        :'originator_client_id' => :'originator_client_id'
+        :'originator_client_id' => :'originator_client_id',
+        :'credit_funds_source' => :'credit_funds_source'
       }
     end
 
@@ -119,7 +122,8 @@ module Plaid
         :'user_present' => :'Boolean',
         :'with_guarantee' => :'Boolean',
         :'beacon_session_id' => :'String',
-        :'originator_client_id' => :'String'
+        :'originator_client_id' => :'String',
+        :'credit_funds_source' => :'TransferCreditFundsSource'
       }
     end
 
@@ -131,7 +135,8 @@ module Plaid
         :'user_present',
         :'with_guarantee',
         :'beacon_session_id',
-        :'originator_client_id'
+        :'originator_client_id',
+        :'credit_funds_source'
       ])
     end
 
@@ -227,6 +232,10 @@ module Plaid
       if attributes.key?(:'originator_client_id')
         self.originator_client_id = attributes[:'originator_client_id']
       end
+
+      if attributes.key?(:'credit_funds_source')
+        self.credit_funds_source = attributes[:'credit_funds_source']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -302,7 +311,8 @@ module Plaid
           user_present == o.user_present &&
           with_guarantee == o.with_guarantee &&
           beacon_session_id == o.beacon_session_id &&
-          originator_client_id == o.originator_client_id
+          originator_client_id == o.originator_client_id &&
+          credit_funds_source == o.credit_funds_source
     end
 
     # @see the `==` method
@@ -314,7 +324,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, access_token, account_id, funding_account_id, payment_profile_token, type, network, amount, ach_class, user, device, origination_account_id, iso_currency_code, idempotency_key, user_present, with_guarantee, beacon_session_id, originator_client_id].hash
+      [client_id, secret, access_token, account_id, funding_account_id, payment_profile_token, type, network, amount, ach_class, user, device, origination_account_id, iso_currency_code, idempotency_key, user_present, with_guarantee, beacon_session_id, originator_client_id, credit_funds_source].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transfer_authorization_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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_authorization_decision.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_authorization_decision_rationale.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_authorization_decision_rationale_code.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_authorization_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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -16,10 +16,10 @@ require 'time'
 module Plaid
   # Information about the device being used to initiate the authorization.
   class TransferAuthorizationDevice
-    # The IP address of the device being used to initiate the authorization. Required for Guarantee.
+    # The IP address of the device being used to initiate the authorization. Required when the end-user is present at authorization create time.
     attr_accessor :ip_address
 
-    # The user agent of the device being used to initiate the authorization. Required for Guarantee.
+    # The user agent of the device being used to initiate the authorization. Required when the end-user is present at authorization create time.
     attr_accessor :user_agent
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/plaid/models/transfer_authorization_guarantee_decision.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/transfer_authorization_proposed_transfer.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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -21,7 +21,7 @@ module Plaid
     # The Plaid `account_id` for the account that will be debited or credited.
     attr_accessor :account_id
 
-    # The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.
+    # 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
 
     attr_accessor :type
@@ -43,6 +43,8 @@ module Plaid
     # The Plaid client ID that is the originator of this transfer. Only present if created on behalf of another client as a third-party sender (TPS).
     attr_accessor :originator_client_id
 
+    attr_accessor :credit_funds_source
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -55,7 +57,8 @@ module Plaid
         :'network' => :'network',
         :'origination_account_id' => :'origination_account_id',
         :'iso_currency_code' => :'iso_currency_code',
-        :'originator_client_id' => :'originator_client_id'
+        :'originator_client_id' => :'originator_client_id',
+        :'credit_funds_source' => :'credit_funds_source'
       }
     end
 
@@ -76,14 +79,17 @@ module Plaid
         :'network' => :'String',
         :'origination_account_id' => :'String',
         :'iso_currency_code' => :'String',
-        :'originator_client_id' => :'String'
+        :'originator_client_id' => :'String',
+        :'credit_funds_source' => :'TransferCreditFundsSource'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'originator_client_id'
+        :'funding_account_id',
+        :'originator_client_id',
+        :'credit_funds_source'
       ])
     end
 
@@ -141,16 +147,16 @@ module Plaid
       if attributes.key?(:'originator_client_id')
         self.originator_client_id = attributes[:'originator_client_id']
       end
+
+      if attributes.key?(:'credit_funds_source')
+        self.credit_funds_source = attributes[:'credit_funds_source']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @funding_account_id.nil?
-        invalid_properties.push('invalid value for "funding_account_id", funding_account_id cannot be nil.')
-      end
-
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -181,7 +187,6 @@ module Plaid
     # 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 @funding_account_id.nil?
       return false if @type.nil?
       return false if @user.nil?
       return false if @amount.nil?
@@ -205,7 +210,8 @@ module Plaid
           network == o.network &&
           origination_account_id == o.origination_account_id &&
           iso_currency_code == o.iso_currency_code &&
-          originator_client_id == o.originator_client_id
+          originator_client_id == o.originator_client_id &&
+          credit_funds_source == o.credit_funds_source
     end
 
     # @see the `==` method
@@ -217,7 +223,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ach_class, account_id, funding_account_id, type, user, amount, network, origination_account_id, iso_currency_code, originator_client_id].hash
+      [ach_class, account_id, funding_account_id, type, user, amount, network, origination_account_id, iso_currency_code, originator_client_id, credit_funds_source].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transfer_authorization_user_in_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.345.1
+The version of the OpenAPI document: 2020-09-14_1.379.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1