Class: ApiReference::Action

Inherits:
Object
  • Object
show all
Defined in:
lib/api_reference/models/action.rb

Overview

Action.

Constant Summary collapse

ACTION = 
[
  # TODO: Write general description for APPLIED_TO_INVOICE
  APPLIED_TO_INVOICE = 'applied_to_invoice'.freeze,

  # TODO: Write general description for MANUAL_ADJUSTMENT
  MANUAL_ADJUSTMENT = 'manual_adjustment'.freeze,

  # TODO: Write general description for PRORATED_REFUND
  PRORATED_REFUND = 'prorated_refund'.freeze,

  # TODO: Write general description for REVERT_PRORATED_REFUND
  REVERT_PRORATED_REFUND = 'revert_prorated_refund'.freeze,

  # TODO: Write general description for RETURN_FROM_VOIDING
  RETURN_FROM_VOIDING = 'return_from_voiding'.freeze,

  # TODO: Write general description for CREDIT_NOTE_APPLIED
  CREDIT_NOTE_APPLIED = 'credit_note_applied'.freeze,

  # TODO: Write general description for CREDIT_NOTE_VOIDED
  CREDIT_NOTE_VOIDED = 'credit_note_voided'.freeze,

  # TODO: Write general description for OVERPAYMENT_REFUND
  OVERPAYMENT_REFUND = 'overpayment_refund'.freeze,

  # TODO: Write general description for EXTERNAL_PAYMENT
  EXTERNAL_PAYMENT = 'external_payment'.freeze,

  # TODO: Write general description for SMALL_INVOICE_CARRYOVER
  SMALL_INVOICE_CARRYOVER = 'small_invoice_carryover'.freeze
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = APPLIED_TO_INVOICE) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/api_reference/models/action.rb', line 47

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

  str = value.to_s.strip

  case str.downcase
  when 'applied_to_invoice' then APPLIED_TO_INVOICE
  when 'manual_adjustment' then MANUAL_ADJUSTMENT
  when 'prorated_refund' then PRORATED_REFUND
  when 'revert_prorated_refund' then REVERT_PRORATED_REFUND
  when 'return_from_voiding' then RETURN_FROM_VOIDING
  when 'credit_note_applied' then CREDIT_NOTE_APPLIED
  when 'credit_note_voided' then CREDIT_NOTE_VOIDED
  when 'overpayment_refund' then OVERPAYMENT_REFUND
  when 'external_payment' then EXTERNAL_PAYMENT
  when 'small_invoice_carryover' then SMALL_INVOICE_CARRYOVER
  else
    default_value
  end
end

.validate(value) ⇒ Object 



41
42
43
44
45
 
# File 'lib/api_reference/models/action.rb', line 41

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

  true
end