Class: UspsApi::MailClass7

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

Overview

Mail Class of the mail piece (human readable). This will also include the service standard message if it exists. Note: Global Express Guaranteed Service is suspended as of September 29, 2024.

Constant Summary collapse

MAIL_CLASS7 = 
[
  # TODO: Write general description for BOUND_PRINTED_MATTER
  BOUND_PRINTED_MATTER = 'BOUND_PRINTED_MATTER'.freeze,

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

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

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

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

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

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

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

  # TODO: Write general description for FIRSTCLASS_MAIL
  FIRSTCLASS_MAIL = 'FIRST-CLASS_MAIL'.freeze,

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

  # TODO: Write general description for
  # FIRSTCLASS_PACKAGE_INTERNATIONAL_SERVICE
  FIRSTCLASS_PACKAGE_INTERNATIONAL_SERVICE = 'FIRST-CLASS_PACKAGE_INTERNATIONAL_SERVICE'.freeze,

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

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

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

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

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

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = BOUND_PRINTED_MATTER) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/usps_api/models/mail_class7.rb', line 74

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

  str = value.to_s.strip

  case str.downcase
  when 'bound_printed_matter' then BOUND_PRINTED_MATTER
  when 'library_mail' then LIBRARY_MAIL
  when 'usps_retail_ground' then USPS_RETAIL_GROUND
  when 'media_mail' then MEDIA_MAIL
  when 'critical_mail' then CRITICAL_MAIL
  when 'priority_mail_international_parcels' then PRIORITY_MAIL_INTERNATIONAL_PARCELS
  when 'domestic_matter_for_the_blind' then DOMESTIC_MATTER_FOR_THE_BLIND
  when 'priority_mail_express' then PRIORITY_MAIL_EXPRESS
  when 'firstclass_mail' then FIRSTCLASS_MAIL
  when 'priority_mail_express_international' then PRIORITY_MAIL_EXPRESS_INTERNATIONAL
  when 'firstclass_package_international_service' then FIRSTCLASS_PACKAGE_INTERNATIONAL_SERVICE
  when 'parcel_select_lightweight' then PARCEL_SELECT_LIGHTWEIGHT
  when 'priority_mail_guaranteed' then PRIORITY_MAIL_GUARANTEED
  when 'global_express_guaranteed' then GLOBAL_EXPRESS_GUARANTEED
  when 'priority_mail' then PRIORITY_MAIL
  when 'parcel_select' then PARCEL_SELECT
  when 'usps_marketing_mail' then USPS_MARKETING_MAIL
  when 'priority_mail_same_day' then PRIORITY_MAIL_SAME_DAY
  else
    default_value
  end
end

.validate(value) ⇒ Object 



68
69
70
71
72
 
# File 'lib/usps_api/models/mail_class7.rb', line 68

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

  MAIL_CLASS7.include?(value)
end