Class: ThePlaidApi::TransferSweepStatus

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

Overview

The status of the sweep for the transfer. ‘unswept`: The transfer hasn’t been swept yet. ‘swept`: The transfer was swept to the sweep account. `swept_settled`: Credits are available to be withdrawn or debits have been deducted from the customer’s business checking account. `return_swept`: The transfer was returned, funds were pulled back or pushed back to the sweep account. `null`: The transfer will never be swept (e.g. if the transfer is cancelled or returned before being swept)

Constant Summary collapse

TRANSFER_SWEEP_STATUS = 
[
  # TODO: Write general description for UNSWEPT
  UNSWEPT = 'unswept'.freeze,

  # TODO: Write general description for SWEPT
  SWEPT = 'swept'.freeze,

  # TODO: Write general description for SWEPT_SETTLED
  SWEPT_SETTLED = 'swept_settled'.freeze,

  # TODO: Write general description for RETURN_SWEPT
  RETURN_SWEPT = 'return_swept'.freeze
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = UNSWEPT) ⇒ Object 



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

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

  str = value.to_s.strip

  case str.downcase
  when 'unswept' then UNSWEPT
  when 'swept' then SWEPT
  when 'swept_settled' then SWEPT_SETTLED
  when 'return_swept' then RETURN_SWEPT
  else
    default_value
  end
end

.validate(value) ⇒ Object 



29
30
31
32
33
 
# File 'lib/the_plaid_api/models/transfer_sweep_status.rb', line 29

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

  TRANSFER_SWEEP_STATUS.include?(value)
end