Module: Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action

Extended by:

Internal::Type::Union

Defined in:

lib/lithic/models/auth_rules/v2_list_results_response.rb

Defined Under Namespace

Classes: CreateCaseAction, TagAction

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_token:, mode:, rule_version:, transaction_token:, event_stream: :ACH_PAYMENT_UPDATE) ⇒ Object

Methods included from Internal::Type::Union

==, ===, coerce, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/lithic/models/auth_rules/v2_list_results_response.rb', line 1224

Instance Method Details

#initialize(token:, actions:, auth_rule_token:, evaluation_time:, event_token:, mode:, rule_version:, transaction_token:, event_stream: :ACH_PAYMENT_UPDATE) ⇒ Object

Parameters:

• token (String) —

  Globally unique identifier for the evaluation

• actions (Array<Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::TagAction, Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction>) —

  Actions returned by the rule evaluation

• auth_rule_token (String) —

  The Auth Rule token

• evaluation_time (Time) —

  Timestamp of the rule evaluation

• event_token (String) —

  Token of the event that triggered the evaluation

• mode (Symbol, Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Mode) —

  The state of the Auth Rule

• rule_version (Integer) —

  Version of the rule that was evaluated

• transaction_token (String, nil) —

  The token of the transaction that triggered the rule evaluation

• event_stream (Symbol, :ACH_PAYMENT_UPDATE) (defaults to: :ACH_PAYMENT_UPDATE) —

  The event stream during which the rule was evaluated

# File 'lib/lithic/models/auth_rules/v2_list_results_response.rb', line 1174

module Action
  extend Lithic::Internal::Type::Union

  variant -> { Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::TagAction }

  variant -> { Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction }

  class TagAction < Lithic::Internal::Type::BaseModel
    # @!attribute key
    #   The key of the tag to apply to the payment
    #
    #   @return [String]
    required :key, String

    # @!attribute type
    #   Tag the payment with key-value metadata
    #
    #   @return [Symbol, Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::TagAction::Type]
    required :type,
             enum: -> { Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::TagAction::Type }

    # @!attribute value
    #   The value of the tag to apply to the payment
    #
    #   @return [String]
    required :value, String

    # @!attribute explanation
    #   Optional explanation for why this action was taken
    #
    #   @return [String, nil]
    optional :explanation, String

    # @!method initialize(key:, type:, value:, explanation: nil)
    #   @param key [String] The key of the tag to apply to the payment
    #
    #   @param type [Symbol, Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::TagAction::Type] Tag the payment with key-value metadata
    #
    #   @param value [String] The value of the tag to apply to the payment
    #
    #   @param explanation [String] Optional explanation for why this action was taken

    # Tag the payment with key-value metadata
    #
    # @see Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::TagAction#type
    module Type
      extend Lithic::Internal::Type::Enum

      TAG = :TAG

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  class CreateCaseAction < Lithic::Internal::Type::BaseModel
    # @!attribute queue_token
    #   The token of the queue to create the case in
    #
    #   @return [String]
    required :queue_token, String

    # @!attribute scope
    #   The scope of the case to create
    #
    #   @return [Symbol, Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction::Scope]
    required :scope,
             enum: -> { Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction::Scope }

    # @!attribute type
    #   Create a case for the payment
    #
    #   @return [Symbol, Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction::Type]
    required :type,
             enum: -> { Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction::Type }

    # @!attribute explanation
    #   Optional explanation for why this action was taken
    #
    #   @return [String, nil]
    optional :explanation, String

    # @!method initialize(queue_token:, scope:, type:, explanation: nil)
    #   @param queue_token [String] The token of the queue to create the case in
    #
    #   @param scope [Symbol, Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction::Scope] The scope of the case to create
    #
    #   @param type [Symbol, Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction::Type] Create a case for the payment
    #
    #   @param explanation [String] Optional explanation for why this action was taken

    # The scope of the case to create
    #
    # @see Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction#scope
    module Scope
      extend Lithic::Internal::Type::Enum

      FINANCIAL_ACCOUNT = :FINANCIAL_ACCOUNT

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    # Create a case for the payment
    #
    # @see Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction#type
    module Type
      extend Lithic::Internal::Type::Enum

      CREATE_CASE = :CREATE_CASE

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  # @!method self.variants
  #   @return [Array(Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::TagAction, Lithic::Models::AuthRules::V2ListResultsResponse::ACHPaymentUpdateResult::Action::CreateCaseAction)]
end