Class: UspsApi::PricingCharacteristic1

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

Overview

| Enumeration | Format | Example | | – | – | – | | WEIGHT | number | 4.1 | | DIM_WEIGHT | number | 11.8 | | LENGTH | number | 8.6 | | WIDTH | number | 4.2 | | HEIGHT | number | 3.5 | | ORIGIN_ZIP_CODE | string | 20260 | | DESTINATION_ZIP_CODE | string | 20260 | | ZONE | string | 01 | | DESTINATION_ENTRY_FACILITY_TYPE | string | Temp | | RATE_INDICATOR | string | SP | | MAIL_CLASS | string | PRIORITY_MAIL |

Constant Summary collapse

PRICING_CHARACTERISTIC1 = 
[
  # TODO: Write general description for WEIGHT
  WEIGHT = 'WEIGHT'.freeze,

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

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

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

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

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

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

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

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

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = WEIGHT) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/usps_api/models/pricing_characteristic1.rb', line 55

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

  str = value.to_s.strip

  case str.downcase
  when 'weight' then WEIGHT
  when 'dim_weight' then DIM_WEIGHT
  when 'length' then LENGTH
  when 'width' then WIDTH
  when 'height' then HEIGHT
  when 'origin_zip_code' then ORIGIN_ZIP_CODE
  when 'destination_zip_code' then DESTINATION_ZIP_CODE
  when 'zone' then ZONE
  when 'destination_entry_facility_type' then DESTINATION_ENTRY_FACILITY_TYPE
  when 'rate_indicator' then RATE_INDICATOR
  when 'mail_class' then MAIL_CLASS
  else
    default_value
  end
end

.validate(value) ⇒ Object 



49
50
51
52
53
 
# File 'lib/usps_api/models/pricing_characteristic1.rb', line 49

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

  PRICING_CHARACTERISTIC1.include?(value)
end