Class: ThePlaidApi::TransferLedgerSweepSimulateEventType

Inherits:
Object
  • Object
show all
Defined in:
lib/the_plaid_api/models/transfer_ledger_sweep_simulate_event_type.rb

Overview

The asynchronous event to be simulated. May be: ‘posted`, `settled`, `failed`, or `returned`. An error will be returned if the event type is incompatible with the current ledger sweep status. Compatible status –> event type transitions include: `sweep.pending` –> `sweep.posted` `sweep.pending` –> `sweep.failed` `sweep.posted` –> `sweep.settled` `sweep.posted` –> `sweep.returned` `sweep.settled` –> `sweep.returned`

Constant Summary collapse

TRANSFER_LEDGER_SWEEP_SIMULATE_EVENT_TYPE = 
[
  # TODO: Write general description for ENUM_SWEEPPOSTED
  ENUM_SWEEPPOSTED = 'sweep.posted'.freeze,

  # TODO: Write general description for ENUM_SWEEPSETTLED
  ENUM_SWEEPSETTLED = 'sweep.settled'.freeze,

  # TODO: Write general description for ENUM_SWEEPRETURNED
  ENUM_SWEEPRETURNED = 'sweep.returned'.freeze,

  # TODO: Write general description for ENUM_SWEEPFAILED
  ENUM_SWEEPFAILED = 'sweep.failed'.freeze
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = ENUM_SWEEPPOSTED) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/the_plaid_api/models/transfer_ledger_sweep_simulate_event_type.rb', line 34

def self.from_value(value, default_value = ENUM_SWEEPPOSTED)
  return default_value if value.nil?

  str = value.to_s.strip

  case str.downcase
  when 'enum_sweepposted' then ENUM_SWEEPPOSTED
  when 'enum_sweepsettled' then ENUM_SWEEPSETTLED
  when 'enum_sweepreturned' then ENUM_SWEEPRETURNED
  when 'enum_sweepfailed' then ENUM_SWEEPFAILED
  else
    default_value
  end
end

.validate(value) ⇒ Object 



28
29
30
31
32
 
# File 'lib/the_plaid_api/models/transfer_ledger_sweep_simulate_event_type.rb', line 28

def self.validate(value)
  return false if value.nil?

  TRANSFER_LEDGER_SWEEP_SIMULATE_EVENT_TYPE.include?(value)
end