plaid 16.0.0 → 17.1.0

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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -22,15 +22,15 @@ 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.
+    # The Plaid `access_token` for the account that will be debited or credited. Required if not using `payment_profile_token`.
     attr_accessor :access_token
 
-    # 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
-
-    # The Plaid `account_id` for the account that will be debited or credited.
+    # The Plaid `account_id` for the account that will be debited or credited. Required if not using `payment_profile_token`.
     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
+
     attr_accessor :type
 
     attr_accessor :network
@@ -50,14 +50,20 @@ module Plaid
     # The currency of the transfer amount. The default value is \"USD\".
     attr_accessor :iso_currency_code
 
+    # 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`.
     attr_accessor :user_present
 
     # If set to `false`, Plaid will not offer a `guarantee_decision` for this request(Guarantee customers only).
     attr_accessor :with_guarantee
 
-    # Plaid’s unique identifier for a payment profile.
-    attr_accessor :payment_profile_id
+    # 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.
+    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
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -65,8 +71,8 @@ module Plaid
         :'client_id' => :'client_id',
         :'secret' => :'secret',
         :'access_token' => :'access_token',
-        :'idempotency_key' => :'idempotency_key',
         :'account_id' => :'account_id',
+        :'payment_profile_token' => :'payment_profile_token',
         :'type' => :'type',
         :'network' => :'network',
         :'amount' => :'amount',
@@ -75,9 +81,11 @@ module Plaid
         :'device' => :'device',
         :'origination_account_id' => :'origination_account_id',
         :'iso_currency_code' => :'iso_currency_code',
+        :'idempotency_key' => :'idempotency_key',
         :'user_present' => :'user_present',
         :'with_guarantee' => :'with_guarantee',
-        :'payment_profile_id' => :'payment_profile_id'
+        :'beacon_session_id' => :'beacon_session_id',
+        :'originator_client_id' => :'originator_client_id'
       }
     end
 
@@ -92,8 +100,8 @@ module Plaid
         :'client_id' => :'String',
         :'secret' => :'String',
         :'access_token' => :'String',
-        :'idempotency_key' => :'String',
         :'account_id' => :'String',
+        :'payment_profile_token' => :'String',
         :'type' => :'TransferType',
         :'network' => :'TransferNetwork',
         :'amount' => :'String',
@@ -102,9 +110,11 @@ module Plaid
         :'device' => :'TransferAuthorizationDevice',
         :'origination_account_id' => :'String',
         :'iso_currency_code' => :'String',
+        :'idempotency_key' => :'String',
         :'user_present' => :'Boolean',
         :'with_guarantee' => :'Boolean',
-        :'payment_profile_id' => :'String'
+        :'beacon_session_id' => :'String',
+        :'originator_client_id' => :'String'
       }
     end
 
@@ -114,6 +124,8 @@ module Plaid
         :'idempotency_key',
         :'user_present',
         :'with_guarantee',
+        :'beacon_session_id',
+        :'originator_client_id'
       ])
     end
 
@@ -144,14 +156,14 @@ module Plaid
         self.access_token = attributes[:'access_token']
       end
 
-      if attributes.key?(:'idempotency_key')
-        self.idempotency_key = attributes[:'idempotency_key']
-      end
-
       if attributes.key?(:'account_id')
         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?(:'type')
         self.type = attributes[:'type']
       end
@@ -184,6 +196,10 @@ module Plaid
         self.iso_currency_code = attributes[:'iso_currency_code']
       end
 
+      if attributes.key?(:'idempotency_key')
+        self.idempotency_key = attributes[:'idempotency_key']
+      end
+
       if attributes.key?(:'user_present')
         self.user_present = attributes[:'user_present']
       end
@@ -194,8 +210,12 @@ module Plaid
         self.with_guarantee = true
       end
 
-      if attributes.key?(:'payment_profile_id')
-        self.payment_profile_id = attributes[:'payment_profile_id']
+      if attributes.key?(:'beacon_session_id')
+        self.beacon_session_id = attributes[:'beacon_session_id']
+      end
+
+      if attributes.key?(:'originator_client_id')
+        self.originator_client_id = attributes[:'originator_client_id']
       end
     end
 
@@ -203,11 +223,6 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if !@idempotency_key.nil? && @idempotency_key.to_s.length > 50
-        invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 50.')
-      end
-
-
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -220,26 +235,26 @@ module Plaid
         invalid_properties.push('invalid value for "amount", amount cannot be nil.')
       end
 
-      if @ach_class.nil?
-        invalid_properties.push('invalid value for "ach_class", ach_class cannot be nil.')
-      end
-
       if @user.nil?
         invalid_properties.push('invalid value for "user", user cannot be nil.')
       end
 
+      if !@idempotency_key.nil? && @idempotency_key.to_s.length > 50
+        invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 50.')
+      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 !@idempotency_key.nil? && @idempotency_key.to_s.length > 50
       return false if @type.nil?
       return false if @network.nil?
       return false if @amount.nil?
-      return false if @ach_class.nil?
       return false if @user.nil?
+      return false if !@idempotency_key.nil? && @idempotency_key.to_s.length > 50
       true
     end
 
@@ -262,8 +277,8 @@ module Plaid
           client_id == o.client_id &&
           secret == o.secret &&
           access_token == o.access_token &&
-          idempotency_key == o.idempotency_key &&
           account_id == o.account_id &&
+          payment_profile_token == o.payment_profile_token &&
           type == o.type &&
           network == o.network &&
           amount == o.amount &&
@@ -272,9 +287,11 @@ module Plaid
           device == o.device &&
           origination_account_id == o.origination_account_id &&
           iso_currency_code == o.iso_currency_code &&
+          idempotency_key == o.idempotency_key &&
           user_present == o.user_present &&
           with_guarantee == o.with_guarantee &&
-          payment_profile_id == o.payment_profile_id
+          beacon_session_id == o.beacon_session_id &&
+          originator_client_id == o.originator_client_id
     end
 
     # @see the `==` method
@@ -286,7 +303,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, access_token, idempotency_key, account_id, type, network, amount, ach_class, user, device, origination_account_id, iso_currency_code, user_present, with_guarantee, payment_profile_id].hash
+      [client_id, secret, access_token, 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
     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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -19,7 +19,8 @@ module Plaid
     RISK = "RISK".freeze
     TRANSFER_LIMIT_REACHED = "TRANSFER_LIMIT_REACHED".freeze
     MANUALLY_VERIFIED_ITEM = "MANUALLY_VERIFIED_ITEM".freeze
-    LOGIN_REQUIRED = "LOGIN_REQUIRED".freeze
+    ITEM_LOGIN_REQUIRED = "ITEM_LOGIN_REQUIRED".freeze
+    PAYMENT_PROFILE_LOGIN_REQUIRED = "PAYMENT_PROFILE_LOGIN_REQUIRED".freeze
     ERROR = "ERROR".freeze
     MIGRATED_ACCOUNT_ITEM = "MIGRATED_ACCOUNT_ITEM".freeze
 

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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -37,6 +37,9 @@ module Plaid
     # The currency of the transfer amount. The default value is \"USD\".
     attr_accessor :iso_currency_code
 
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -47,7 +50,8 @@ module Plaid
         :'amount' => :'amount',
         :'network' => :'network',
         :'origination_account_id' => :'origination_account_id',
-        :'iso_currency_code' => :'iso_currency_code'
+        :'iso_currency_code' => :'iso_currency_code',
+        :'originator_client_id' => :'originator_client_id'
       }
     end
 
@@ -66,13 +70,15 @@ module Plaid
         :'amount' => :'String',
         :'network' => :'String',
         :'origination_account_id' => :'String',
-        :'iso_currency_code' => :'String'
+        :'iso_currency_code' => :'String',
+        :'originator_client_id' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'originator_client_id'
       ])
     end
 
@@ -122,20 +128,16 @@ module Plaid
       if attributes.key?(:'iso_currency_code')
         self.iso_currency_code = attributes[:'iso_currency_code']
       end
+
+      if attributes.key?(:'originator_client_id')
+        self.originator_client_id = attributes[:'originator_client_id']
+      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 @ach_class.nil?
-        invalid_properties.push('invalid value for "ach_class", ach_class cannot be nil.')
-      end
-
-      if @account_id.nil?
-        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
-      end
-
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -166,8 +168,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 @ach_class.nil?
-      return false if @account_id.nil?
       return false if @type.nil?
       return false if @user.nil?
       return false if @amount.nil?
@@ -189,7 +189,8 @@ module Plaid
           amount == o.amount &&
           network == o.network &&
           origination_account_id == o.origination_account_id &&
-          iso_currency_code == o.iso_currency_code
+          iso_currency_code == o.iso_currency_code &&
+          originator_client_id == o.originator_client_id
     end
 
     # @see the `==` method
@@ -201,7 +202,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ach_class, account_id, type, user, amount, network, origination_account_id, iso_currency_code].hash
+      [ach_class, account_id, type, user, amount, network, origination_account_id, iso_currency_code, originator_client_id].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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -25,12 +25,15 @@ 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.
+    # The Plaid `access_token` for the account that will be debited or credited. Required if not using `payment_profile_token`.
     attr_accessor :access_token
 
-    # The Plaid `account_id` for the account that will be debited or credited.
+    # The Plaid `account_id` for the account that will be debited or credited. Required if not using `payment_profile_token`.
     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
 
@@ -57,9 +60,6 @@ module Plaid
     # The currency of the transfer amount. The default value is \"USD\".
     attr_accessor :iso_currency_code
 
-    # Plaid’s unique identifier for a payment profile.
-    attr_accessor :payment_profile_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -68,6 +68,7 @@ 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',
@@ -77,8 +78,7 @@ module Plaid
         :'user' => :'user',
         :'metadata' => :'metadata',
         :'origination_account_id' => :'origination_account_id',
-        :'iso_currency_code' => :'iso_currency_code',
-        :'payment_profile_id' => :'payment_profile_id'
+        :'iso_currency_code' => :'iso_currency_code'
       }
     end
 
@@ -95,6 +95,7 @@ module Plaid
         :'idempotency_key' => :'String',
         :'access_token' => :'String',
         :'account_id' => :'String',
+        :'payment_profile_token' => :'String',
         :'authorization_id' => :'String',
         :'type' => :'TransferType',
         :'network' => :'TransferNetwork',
@@ -104,14 +105,14 @@ module Plaid
         :'user' => :'TransferUserInRequestDeprecated',
         :'metadata' => :'Hash<String, String>',
         :'origination_account_id' => :'String',
-        :'iso_currency_code' => :'String',
-        :'payment_profile_id' => :'String'
+        :'iso_currency_code' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'user',
         :'metadata',
         :'origination_account_id',
       ])
@@ -152,6 +153,10 @@ 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
@@ -193,10 +198,6 @@ module Plaid
       if attributes.key?(:'iso_currency_code')
         self.iso_currency_code = attributes[:'iso_currency_code']
       end
-
-      if attributes.key?(:'payment_profile_id')
-        self.payment_profile_id = attributes[:'payment_profile_id']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -279,6 +280,7 @@ 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 &&
@@ -288,8 +290,7 @@ module Plaid
           user == o.user &&
           metadata == o.metadata &&
           origination_account_id == o.origination_account_id &&
-          iso_currency_code == o.iso_currency_code &&
-          payment_profile_id == o.payment_profile_id
+          iso_currency_code == o.iso_currency_code
     end
 
     # @see the `==` method
@@ -301,7 +302,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, authorization_id, type, network, amount, description, ach_class, user, metadata, origination_account_id, iso_currency_code, payment_profile_id].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].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.181.1
+The version of the OpenAPI document: 2020-09-14_1.205.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1