Class: UspsApi::PricesMailClass

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

Overview

The mail service requested. Note: - ‘PARCEL_SELECT_LIGHTWEIGHT` is deprecated and will convert to `PARCEL_SELECT`. - `FIRST-CLASS_PACKAGE_SERVICE` is deprecated and will convert to `USPS_GROUND_ADVANTAGE`. - `FIRST-CLASS_PACKAGE_RETURN_SERVICE` is deprecated and will convert to `USPS_GROUND_ADVANTAGE_RETURN_SERVICE`. - `GROUND_RETURN_SERVICE` is deprecated and will convert to `USPS_GROUND_ADVANTAGE_RETURN_SERVICE`. - `USPS_RETAIL_GROUND` is no longer supported and will return a 400 if used. - Certain mail classes, such as `MEDIA_MAIL`, `BOUND_PRINTED_MATTER`, and `LIBRARY_MAIL`, have eligibility rules on what can be mailed using that service. For more details on these mail classes, please visit [What are Package Services?](faq.usps.com/s/article/What-are-Package-Services).

Constant Summary collapse

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

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

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

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

  # TODO: Write general description for FIRSTCLASS_PACKAGE_SERVICE
  FIRSTCLASS_PACKAGE_SERVICE = 'FIRST-CLASS_PACKAGE_SERVICE'.freeze,

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

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

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

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

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

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

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

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

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

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

  # TODO: Write general description for FIRSTCLASS_PACKAGE_RETURN_SERVICE
  FIRSTCLASS_PACKAGE_RETURN_SERVICE = 'FIRST-CLASS_PACKAGE_RETURN_SERVICE'.freeze,

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = PARCEL_SELECT) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/usps_api/models/prices_mail_class.rb', line 82

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

  str = value.to_s.strip

  case str.downcase
  when 'parcel_select' then PARCEL_SELECT
  when 'parcel_select_lightweight' then PARCEL_SELECT_LIGHTWEIGHT
  when 'priority_mail_express' then PRIORITY_MAIL_EXPRESS
  when 'priority_mail' then PRIORITY_MAIL
  when 'firstclass_package_service' then FIRSTCLASS_PACKAGE_SERVICE
  when 'library_mail' then LIBRARY_MAIL
  when 'media_mail' then MEDIA_MAIL
  when 'bound_printed_matter' then BOUND_PRINTED_MATTER
  when 'usps_connect_local' then USPS_CONNECT_LOCAL
  when 'usps_connect_mail' then USPS_CONNECT_MAIL
  when 'usps_connect_regional' then USPS_CONNECT_REGIONAL
  when 'usps_ground_advantage' then USPS_GROUND_ADVANTAGE
  when 'usps_ground_advantage_return_service' then USPS_GROUND_ADVANTAGE_RETURN_SERVICE
  when 'usps_retail_ground' then USPS_RETAIL_GROUND
  when 'ground_return_service' then GROUND_RETURN_SERVICE
  when 'firstclass_package_return_service' then FIRSTCLASS_PACKAGE_RETURN_SERVICE
  when 'priority_mail_return_service' then PRIORITY_MAIL_RETURN_SERVICE
  when 'priority_mail_express_return_service' then PRIORITY_MAIL_EXPRESS_RETURN_SERVICE
  else
    default_value
  end
end

.validate(value) ⇒ Object 



76
77
78
79
80
 
# File 'lib/usps_api/models/prices_mail_class.rb', line 76

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

  PRICES_MAIL_CLASS.include?(value)
end