Class: UspsApi::MailType

Inherits:
Object
  • Object
show all
Defined in:
lib/usps_api/models/mail_type.rb

Overview

Type of Mail: if kahalaIndicator is true mailTypeCode is IM (International mail)

Constant Summary collapse

MAIL_TYPE = 
[
  # TODO: Write general description for INTERNATIONAL_INBOUND
  INTERNATIONAL_INBOUND = 'INTERNATIONAL_INBOUND'.freeze,

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

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = INTERNATIONAL_INBOUND) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/usps_api/models/mail_type.rb', line 30

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

  str = value.to_s.strip

  case str.downcase
  when 'international_inbound' then INTERNATIONAL_INBOUND
  when 'international_outbound' then INTERNATIONAL_OUTBOUND
  when 'domestic_mail' then DOMESTIC_MAIL
  when 'unknown' then UNKNOWN
  else
    default_value
  end
end

.validate(value) ⇒ Object 



24
25
26
27
28
 
# File 'lib/usps_api/models/mail_type.rb', line 24

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

  MAIL_TYPE.include?(value)
end