plaid 22.0.0 → 23.0.0

data/lib/plaid/models/{credit_freddie_verification_of_employment_deal_voe25.rb → transactions_user_insights_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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -14,20 +14,23 @@ require 'date'
 require 'time'
 
 module Plaid
-  # An object representing a Verification of Employment report.
-  class CreditFreddieVerificationOfEmploymentDealVOE25
-    attr_accessor :loans
+  # TransactionsUserInsightsGetRequest defines the request schema for `/beta/transactions/user_insights/v1/get`.
+  class TransactionsUserInsightsGetRequest
+    # Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
+    attr_accessor :client_id
 
-    attr_accessor :parties
+    # 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
 
-    attr_accessor :services
+    # A unique client-provided user_id to retrieve insights for.
+    attr_accessor :client_user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'loans' => :'LOANS',
-        :'parties' => :'PARTIES',
-        :'services' => :'SERVICES'
+        :'client_id' => :'client_id',
+        :'secret' => :'secret',
+        :'client_user_id' => :'client_user_id'
       }
     end
 
@@ -39,9 +42,9 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'loans' => :'CreditFreddieMacLoansVOA24',
-        :'parties' => :'CreditFreddieMacPartiesVOA24',
-        :'services' => :'CreditFreddieMacServicesVOE25'
+        :'client_id' => :'String',
+        :'secret' => :'String',
+        :'client_user_id' => :'String'
       }
     end
 
@@ -55,27 +58,27 @@ module Plaid
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CreditFreddieVerificationOfEmploymentDealVOE25` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransactionsUserInsightsGetRequest` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::CreditFreddieVerificationOfEmploymentDealVOE25`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransactionsUserInsightsGetRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'loans')
-        self.loans = attributes[:'loans']
+      if attributes.key?(:'client_id')
+        self.client_id = attributes[:'client_id']
       end
 
-      if attributes.key?(:'parties')
-        self.parties = attributes[:'parties']
+      if attributes.key?(:'secret')
+        self.secret = attributes[:'secret']
       end
 
-      if attributes.key?(:'services')
-        self.services = attributes[:'services']
+      if attributes.key?(:'client_user_id')
+        self.client_user_id = attributes[:'client_user_id']
       end
     end
 
@@ -83,16 +86,8 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @loans.nil?
-        invalid_properties.push('invalid value for "loans", loans cannot be nil.')
-      end
-
-      if @parties.nil?
-        invalid_properties.push('invalid value for "parties", parties cannot be nil.')
-      end
-
-      if @services.nil?
-        invalid_properties.push('invalid value for "services", services cannot be nil.')
+      if @client_user_id.nil?
+        invalid_properties.push('invalid value for "client_user_id", client_user_id cannot be nil.')
       end
 
       invalid_properties
@@ -101,9 +96,7 @@ 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 @loans.nil?
-      return false if @parties.nil?
-      return false if @services.nil?
+      return false if @client_user_id.nil?
       true
     end
 
@@ -112,9 +105,9 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          loans == o.loans &&
-          parties == o.parties &&
-          services == o.services
+          client_id == o.client_id &&
+          secret == o.secret &&
+          client_user_id == o.client_user_id
     end
 
     # @see the `==` method
@@ -126,7 +119,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [loans, parties, services].hash
+      [client_id, secret, client_user_id].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/{fraud_amount_nullable.rb → transactions_user_insights_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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -14,18 +14,20 @@ require 'date'
 require 'time'
 
 module Plaid
-  # The amount and currency of the fraud or attempted fraud. `fraud_amount` should be omitted to indicate an unknown fraud amount.
-  class FraudAmountNullable
-    attr_accessor :iso_currency_code
+  # TransactionsUserInsightsGetResponse defines the response schema for `/beta/transactions/user_insights/v1/get`.
+  class TransactionsUserInsightsGetResponse
+    attr_accessor :user_data_overview
 
-    # The amount value. This value can be 0 to indicate no money was lost. Must not contain more than two digits of precision (e.g., `1.23`).
-    attr_accessor :value
+    attr_accessor :counterparty_insights
+
+    attr_accessor :category_insights
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'iso_currency_code' => :'iso_currency_code',
-        :'value' => :'value'
+        :'user_data_overview' => :'user_data_overview',
+        :'counterparty_insights' => :'counterparty_insights',
+        :'category_insights' => :'category_insights'
       }
     end
 
@@ -37,8 +39,9 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'iso_currency_code' => :'ISOCurrencyCode',
-        :'value' => :'Float'
+        :'user_data_overview' => :'UserDataOverview',
+        :'counterparty_insights' => :'CounterpartyInsights',
+        :'category_insights' => :'CategoryInsights'
       }
     end
 
@@ -52,23 +55,27 @@ module Plaid
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::FraudAmountNullable` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransactionsUserInsightsGetResponse` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::FraudAmountNullable`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransactionsUserInsightsGetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'iso_currency_code')
-        self.iso_currency_code = attributes[:'iso_currency_code']
+      if attributes.key?(:'user_data_overview')
+        self.user_data_overview = attributes[:'user_data_overview']
+      end
+
+      if attributes.key?(:'counterparty_insights')
+        self.counterparty_insights = attributes[:'counterparty_insights']
       end
 
-      if attributes.key?(:'value')
-        self.value = attributes[:'value']
+      if attributes.key?(:'category_insights')
+        self.category_insights = attributes[:'category_insights']
       end
     end
 
@@ -76,12 +83,8 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @iso_currency_code.nil?
-        invalid_properties.push('invalid value for "iso_currency_code", iso_currency_code cannot be nil.')
-      end
-
-      if @value.nil?
-        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      if @user_data_overview.nil?
+        invalid_properties.push('invalid value for "user_data_overview", user_data_overview cannot be nil.')
       end
 
       invalid_properties
@@ -90,8 +93,7 @@ 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 @iso_currency_code.nil?
-      return false if @value.nil?
+      return false if @user_data_overview.nil?
       true
     end
 
@@ -100,8 +102,9 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          iso_currency_code == o.iso_currency_code &&
-          value == o.value
+          user_data_overview == o.user_data_overview &&
+          counterparty_insights == o.counterparty_insights &&
+          category_insights == o.category_insights
     end
 
     # @see the `==` method
@@ -113,7 +116,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [iso_currency_code, value].hash
+      [user_data_overview, counterparty_insights, category_insights].hash
     end
 
     # Builds the object from hash

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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -76,7 +76,7 @@ module Plaid
     # The expected date when the full amount of the transfer settles at the consumers’ account, if the transfer is credit; or at the customer's business checking account, if the transfer is debit. Only set for ACH transfers and is null for non-ACH transfers. Only set for ACH transfers. This will be of the form YYYY-MM-DD.
     attr_accessor :expected_settlement_date
 
-    # 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).
+    # The Plaid client ID that is the originator of this transfer. Only present if created on behalf of another client as a [Platform customer](https://plaid.com/docs/transfer/application/#originators-vs-platforms).
     attr_accessor :originator_client_id
 
     # A list of refunds associated with this transfer.
@@ -90,6 +90,9 @@ module Plaid
 
     attr_accessor :credit_funds_source
 
+    # 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
       {
@@ -120,7 +123,8 @@ module Plaid
         :'refunds' => :'refunds',
         :'recurring_transfer_id' => :'recurring_transfer_id',
         :'expected_sweep_settlement_schedule' => :'expected_sweep_settlement_schedule',
-        :'credit_funds_source' => :'credit_funds_source'
+        :'credit_funds_source' => :'credit_funds_source',
+        :'facilitator_fee' => :'facilitator_fee'
       }
     end
 
@@ -159,7 +163,8 @@ module Plaid
         :'refunds' => :'Array<TransferRefund>',
         :'recurring_transfer_id' => :'String',
         :'expected_sweep_settlement_schedule' => :'Array<TransferExpectedSweepSettlementScheduleItem>',
-        :'credit_funds_source' => :'TransferCreditFundsSource'
+        :'credit_funds_source' => :'TransferCreditFundsSource',
+        :'facilitator_fee' => :'String'
       }
     end
 
@@ -177,7 +182,7 @@ module Plaid
         :'expected_settlement_date',
         :'originator_client_id',
         :'recurring_transfer_id',
-        :'credit_funds_source'
+        :'credit_funds_source',
       ])
     end
 
@@ -313,6 +318,10 @@ module Plaid
       if attributes.key?(:'credit_funds_source')
         self.credit_funds_source = attributes[:'credit_funds_source']
       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?
@@ -434,7 +443,8 @@ module Plaid
           refunds == o.refunds &&
           recurring_transfer_id == o.recurring_transfer_id &&
           expected_sweep_settlement_schedule == o.expected_sweep_settlement_schedule &&
-          credit_funds_source == o.credit_funds_source
+          credit_funds_source == o.credit_funds_source &&
+          facilitator_fee == o.facilitator_fee
     end
 
     # @see the `==` method
@@ -446,7 +456,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, authorization_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
+      [id, authorization_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, facilitator_fee].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transfer_ach_network.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.431.7
+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_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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -26,12 +26,12 @@ module Plaid
 
     attr_accessor :decision_rationale
 
-    attr_accessor :signal_insights
-
     attr_accessor :guarantee_decision
 
     attr_accessor :guarantee_decision_rationale
 
+    attr_accessor :payment_risk
+
     attr_accessor :proposed_transfer
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -41,9 +41,9 @@ module Plaid
         :'created' => :'created',
         :'decision' => :'decision',
         :'decision_rationale' => :'decision_rationale',
-        :'signal_insights' => :'signal_insights',
         :'guarantee_decision' => :'guarantee_decision',
         :'guarantee_decision_rationale' => :'guarantee_decision_rationale',
+        :'payment_risk' => :'payment_risk',
         :'proposed_transfer' => :'proposed_transfer'
       }
     end
@@ -60,9 +60,9 @@ module Plaid
         :'created' => :'Time',
         :'decision' => :'TransferAuthorizationDecision',
         :'decision_rationale' => :'TransferAuthorizationDecisionRationale',
-        :'signal_insights' => :'SignalInsights',
         :'guarantee_decision' => :'TransferAuthorizationGuaranteeDecision',
         :'guarantee_decision_rationale' => :'TransferAuthorizationGuaranteeDecisionRationale',
+        :'payment_risk' => :'TransferAuthorizationPaymentRisk',
         :'proposed_transfer' => :'TransferAuthorizationProposedTransfer'
       }
     end
@@ -71,9 +71,9 @@ module Plaid
     def self.openapi_nullable
       Set.new([
         :'decision_rationale',
-        :'signal_insights',
         :'guarantee_decision',
         :'guarantee_decision_rationale',
+        :'payment_risk',
       ])
     end
 
@@ -108,10 +108,6 @@ module Plaid
         self.decision_rationale = attributes[:'decision_rationale']
       end
 
-      if attributes.key?(:'signal_insights')
-        self.signal_insights = attributes[:'signal_insights']
-      end
-
       if attributes.key?(:'guarantee_decision')
         self.guarantee_decision = attributes[:'guarantee_decision']
       end
@@ -120,6 +116,10 @@ module Plaid
         self.guarantee_decision_rationale = attributes[:'guarantee_decision_rationale']
       end
 
+      if attributes.key?(:'payment_risk')
+        self.payment_risk = attributes[:'payment_risk']
+      end
+
       if attributes.key?(:'proposed_transfer')
         self.proposed_transfer = attributes[:'proposed_transfer']
       end
@@ -167,9 +167,9 @@ module Plaid
           created == o.created &&
           decision == o.decision &&
           decision_rationale == o.decision_rationale &&
-          signal_insights == o.signal_insights &&
           guarantee_decision == o.guarantee_decision &&
           guarantee_decision_rationale == o.guarantee_decision_rationale &&
+          payment_risk == o.payment_risk &&
           proposed_transfer == o.proposed_transfer
     end
 
@@ -182,7 +182,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, decision, decision_rationale, signal_insights, guarantee_decision, guarantee_decision_rationale, proposed_transfer].hash
+      [id, created, decision, decision_rationale, guarantee_decision, guarantee_decision_rationale, payment_risk, proposed_transfer].hash
     end
 
     # Builds the object from hash

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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -28,7 +28,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. Defaults to the account configured during onboarding. You can find your list of `funding_account_id`s in the Accounts page of your Plaid Dashboard, under the \"Account ID\" column.
+    # Specify the account used to fund the transfer. Should be specified if using legacy funding methods only. If using Plaid Ledger, leave this field blank. Customers can find a list of `funding_account_id`s in the Accounts page of your Plaid Dashboard, under the \"Account ID\" column. If this field is left blank and you are using legacy funding methods, this will default to the default `funding_account_id` specified during onboarding. Otherwise, Plaid Ledger will be used.
     attr_accessor :funding_account_id
 
     # The payment profile token associated with the Payment Profile that will be debited or credited. Required if not using `access_token`.
@@ -65,7 +65,7 @@ module Plaid
     # 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).
+    # The Plaid client ID that is the originator of this transfer. Only needed if creating transfers on behalf of another client as a [Platform customer](https://plaid.com/docs/transfer/application/#originators-vs-platforms).
     attr_accessor :originator_client_id
 
     attr_accessor :credit_funds_source

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