Class: UspsApi::RateIndicator

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

Overview

Rate ingredient to determine pricing categorization for calculating the price * 3D - 3-Digit * 3N - 3-Digit Dimensional Rectangular * 3R - 3-Digit Dimensional Nonrectangular * 5D - 5-Digit * BA - Basic * BB - Mixed NDC * BM - NDC * C1 - Cubic Pricing Tier 1 * C2 - Cubic Pricing Tier 2 * C3 - Cubic Pricing Tier 3 * C4 - Cubic Pricing Tier 4 * C5 - Cubic Pricing Tier 5 * CP - Cubic Parcel * CM - USPS Connect Local® Mail * DC - NDC * DE - SCF * DF - 5-Digit * DN - Dimensional Nonrectangular * DR - Dimensional Rectangular * E4 - Priority Mail Express Flat Rate Envelope - Post Office To Addressee * E6 - Priority Mail Express Legal Flat Rate Envelope * E7 - Priority Mail Express Legal Flat Rate Envelope Sunday / Holiday * FA - Legal Flat Rate Envelope * FB - Medium Flat Rate Box/Large Flat Rate Bag * FE - Flat Rate Envelope * FP - Padded Flat Rate Envelope * FS - Small Flat Rate Box * LC - USPS Connect® Local Single Piece * LF - USPS Connect® Local Flat Rate Box * LL - USPS Connect® Local Large Flat Rate Bag * LO - USPS Connect® Local Oversized * LS - USPS Connect® Local Small Flat Rate Bag * NP - Non-Presorted * O1 - Full Tray Box * O2 - Half Tray Box

  • O3 - EMM Tray Box * O4 - Flat Tub Tray Box * O5 - Surface Transported

Pallet * O6 - Full Pallet Box * O7 - Half Pallet Box * OS - Oversized

  • P5 - Cubic Soft Pack Tier 1 * P6 - Cubic Soft Pack Tier 2 * P7 - Cubic

Soft Pack Tier 3 * P8 - Cubic Soft Pack Tier 4 * P9 - Cubic Soft Pack Tier 5 * Q6 - Cubic Soft Pack Tier 6 * Q7 - Cubic Soft Pack Tier 7 * Q8 - Cubic Soft Pack Tier 8 * Q9 - Cubic Soft Pack Tier 9 * Q0 - Cubic Soft Pack Tier 10 * PA - Priority Mail Express Single Piece * PL - Large Flat Rate Box * PM - Large Flat Rate Box APO/FPO/DPO * PR - Presorted * SB - Small Flat Rate Bag * SN - SCF Dimensional Nonrectangular * SP - Single Piece * SR - SCF Dimensional Rectangular

Constant Summary collapse

RATE_INDICATOR = 
[
  # TODO: Write general description for ENUM_3D
  ENUM_3D = '3D'.freeze,

  # TODO: Write general description for ENUM_3N
  ENUM_3N = '3N'.freeze,

  # TODO: Write general description for ENUM_3R
  ENUM_3R = '3R'.freeze,

  # TODO: Write general description for ENUM_5D
  ENUM_5D = '5D'.freeze,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = ENUM_3D) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/usps_api/models/rate_indicator.rb', line 220

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

  str = value.to_s.strip

  case str.downcase
  when 'enum_3d' then ENUM_3D
  when 'enum_3n' then ENUM_3N
  when 'enum_3r' then ENUM_3R
  when 'enum_5d' then ENUM_5D
  when 'ba' then BA
  when 'bb' then BB
  when 'bm' then BM
  when 'c1' then C1
  when 'c2' then C2
  when 'c3' then C3
  when 'c4' then C4
  when 'c5' then C5
  when 'cp' then CP
  when 'cm' then CM
  when 'dc' then DC
  when 'de' then DE
  when 'df' then DF
  when 'dn' then DN
  when 'dr' then DR
  when 'e4' then E4
  when 'e6' then E6
  when 'e7' then E7
  when 'fa' then FA
  when 'fb' then FB
  when 'fe' then FE
  when 'fp' then FP
  when 'fs' then FS
  when 'lc' then LC
  when 'lf' then LF
  when 'll' then LL
  when 'lo' then LO
  when 'ls' then LS
  when 'np' then NP
  when 'o1' then O1
  when 'o2' then O2
  when 'o3' then O3
  when 'o4' then O4
  when 'o5' then O5
  when 'o6' then O6
  when 'o7' then O7
  when 'os' then OS
  when 'p5' then P5
  when 'p6' then P6
  when 'p7' then P7
  when 'p8' then P8
  when 'p9' then P9
  when 'q6' then Q6
  when 'q7' then Q7
  when 'q8' then Q8
  when 'q9' then Q9
  when 'q0' then Q0
  when 'pa' then PA
  when 'pl' then PL
  when 'pm' then PM
  when 'pr' then PR
  when 'sb' then SB
  when 'sn' then SN
  when 'sp' then SP
  when 'sr' then SR
  else
    default_value
  end
end

.validate(value) ⇒ Object 



214
215
216
217
218
 
# File 'lib/usps_api/models/rate_indicator.rb', line 214

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

  RATE_INDICATOR.include?(value)
end