Class: UspsApi::LabelsExtraServiceCodes

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

Overview

Extra Service Code (ESC) requested. Extra Service Code list: * 365 - Global Direct Entry * 415 - USPS Label Delivery * 480 - Tracking Plus 6 Months * 481 - Tracking Plus 1 Year * 482 - Tracking Plus 3 Years * 483 - Tracking Plus 5 Years * 484 - Tracking Plus 7 Years * 485 - Tracking Plus 10 Years * 486 - Tracking Plus Signature 3 Years * 487 - Tracking Plus Signature 5 Years * 488 - Tracking Plus Signature 7 Years

  • 489 - Tracking Plus Signature 10 Years * 810 - HAZMAT Air Eligible

Ethanol Package * 811 - HAZMAT Class 1 - Toy Propellant/Safety Fuse Package * 812 - HAZMAT Class 3 – Flammable Liquid Package * 813 - HAZMAT Class 7 - Radioactive Materials Package * 814 - HAZMAT Class 8 - Corrosive Materials Package * 815 - HAZMAT Class 8 - Nonspillable Wet Battery Package * 816 - HAZMAT Class 9 - Lithium Battery Marked - Ground Only Package * 817 - HAZMAT Class 9 - Lithium Battery - Returns Package * 818

  • HAZMAT Class 9 - Lithium batteries, marked package * 819 - HAZMAT Class

9 - Dry Ice Package * 820 - HAZMAT Class 9 - Lithium batteries, unmarked package * 821 - HAZMAT Class 9 - Magnetized Materials Package * 822 - HAZMAT Division 4.1 – Flammable Solids or Safety Matches Package * 823 - HAZMAT Division 5.1 - Oxidizers Package * 824 - HAZMAT Division 5.2 - Organic Peroxides Package * 825 - HAZMAT Division 6.1 – Toxic Materials Package * 826 - HAZMAT Division 6.2 – Infectious Substances Package * 827 - HAZMAT Excepted Quantity Provision Package * 828 - HAZMAT Ground Only * 829 - HAZMAT ID8000 Consumer Commodity Package * 830 - HAZMAT Lighters Package * 831 - HAZMAT LTD QTY Ground Package * 832 - HAZMAT Small Quantity Provision Package * 857 - Hazardous Material * 910 - Certified Mail * 911 - Certified Mail Restricted Delivery * 912 - Certified Mail Adult Signature Required * 913 - Certified Mail Adult Signature Restricted Delivery * 920 - USPS Tracking * 921 - Signature Confirmation * 922 - Adult Signature Required 21 or Over * 923 - Adult Signature Restricted Delivery 21 or Over * 924 - Signature Confirmation Restricted Delivery * 925 - Priority Mail Express Merchandise Insurance

  • 930 - Insurance <= $500 * 931 - Insurance > $500 * 934 - Insurance

Restricted Delivery * 955 - Return Receipt * 957 - Return Receipt Electronic * 981 - Signature Requested (PRIORITY_MAIL_EXPRESS only) * 986 - PO to Addressee (PRIORITY_MAIL_EXPRESS only) * 991 - Sunday Delivery

Note:  - Extra Service Code "415 - USPS Label Delivery": When

requesting this service, no images will be returned in the API response. The label and receipt will be printed and mailed to the ‘fromAddress` provided. The mailed label will always include a receipt on the page.

Constant Summary collapse

LABELS_EXTRA_SERVICE_CODES = 
[
  # TODO: Write general description for ENUM_365
  ENUM_365 = 365,

  # TODO: Write general description for ENUM_415
  ENUM_415 = 415,

  # TODO: Write general description for ENUM_480
  ENUM_480 = 480,

  # TODO: Write general description for ENUM_481
  ENUM_481 = 481,

  # TODO: Write general description for ENUM_482
  ENUM_482 = 482,

  # TODO: Write general description for ENUM_483
  ENUM_483 = 483,

  # TODO: Write general description for ENUM_484
  ENUM_484 = 484,

  # TODO: Write general description for ENUM_485
  ENUM_485 = 485,

  # TODO: Write general description for ENUM_486
  ENUM_486 = 486,

  # TODO: Write general description for ENUM_487
  ENUM_487 = 487,

  # TODO: Write general description for ENUM_488
  ENUM_488 = 488,

  # TODO: Write general description for ENUM_489
  ENUM_489 = 489,

  # TODO: Write general description for ENUM_810
  ENUM_810 = 810,

  # TODO: Write general description for ENUM_811
  ENUM_811 = 811,

  # TODO: Write general description for ENUM_812
  ENUM_812 = 812,

  # TODO: Write general description for ENUM_813
  ENUM_813 = 813,

  # TODO: Write general description for ENUM_814
  ENUM_814 = 814,

  # TODO: Write general description for ENUM_815
  ENUM_815 = 815,

  # TODO: Write general description for ENUM_816
  ENUM_816 = 816,

  # TODO: Write general description for ENUM_817
  ENUM_817 = 817,

  # TODO: Write general description for ENUM_818
  ENUM_818 = 818,

  # TODO: Write general description for ENUM_819
  ENUM_819 = 819,

  # TODO: Write general description for ENUM_820
  ENUM_820 = 820,

  # TODO: Write general description for ENUM_821
  ENUM_821 = 821,

  # TODO: Write general description for ENUM_822
  ENUM_822 = 822,

  # TODO: Write general description for ENUM_823
  ENUM_823 = 823,

  # TODO: Write general description for ENUM_824
  ENUM_824 = 824,

  # TODO: Write general description for ENUM_825
  ENUM_825 = 825,

  # TODO: Write general description for ENUM_826
  ENUM_826 = 826,

  # TODO: Write general description for ENUM_827
  ENUM_827 = 827,

  # TODO: Write general description for ENUM_828
  ENUM_828 = 828,

  # TODO: Write general description for ENUM_829
  ENUM_829 = 829,

  # TODO: Write general description for ENUM_830
  ENUM_830 = 830,

  # TODO: Write general description for ENUM_831
  ENUM_831 = 831,

  # TODO: Write general description for ENUM_832
  ENUM_832 = 832,

  # TODO: Write general description for ENUM_857
  ENUM_857 = 857,

  # TODO: Write general description for ENUM_910
  ENUM_910 = 910,

  # TODO: Write general description for ENUM_911
  ENUM_911 = 911,

  # TODO: Write general description for ENUM_912
  ENUM_912 = 912,

  # TODO: Write general description for ENUM_913
  ENUM_913 = 913,

  # TODO: Write general description for ENUM_920
  ENUM_920 = 920,

  # TODO: Write general description for ENUM_921
  ENUM_921 = 921,

  # TODO: Write general description for ENUM_922
  ENUM_922 = 922,

  # TODO: Write general description for ENUM_923
  ENUM_923 = 923,

  # TODO: Write general description for ENUM_924
  ENUM_924 = 924,

  # TODO: Write general description for ENUM_925
  ENUM_925 = 925,

  # TODO: Write general description for ENUM_930
  ENUM_930 = 930,

  # TODO: Write general description for ENUM_931
  ENUM_931 = 931,

  # TODO: Write general description for ENUM_934
  ENUM_934 = 934,

  # TODO: Write general description for ENUM_955
  ENUM_955 = 955,

  # TODO: Write general description for ENUM_957
  ENUM_957 = 957,

  # TODO: Write general description for ENUM_981
  ENUM_981 = 981,

  # TODO: Write general description for ENUM_986
  ENUM_986 = 986,

  # TODO: Write general description for ENUM_991
  ENUM_991 = 991
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = ENUM_365) ⇒ Object 



216
217
218
219
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
 
# File 'lib/usps_api/models/labels_extra_service_codes.rb', line 216

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

  str = value.to_s.strip
  if str.match?(/\A\d+\z/)
    num = str.to_i
    return num if LABELS_EXTRA_SERVICE_CODES.include?(num)

    return default_value
  end

  case str.downcase
  when 'enum_365' then ENUM_365
  when 'enum_415' then ENUM_415
  when 'enum_480' then ENUM_480
  when 'enum_481' then ENUM_481
  when 'enum_482' then ENUM_482
  when 'enum_483' then ENUM_483
  when 'enum_484' then ENUM_484
  when 'enum_485' then ENUM_485
  when 'enum_486' then ENUM_486
  when 'enum_487' then ENUM_487
  when 'enum_488' then ENUM_488
  when 'enum_489' then ENUM_489
  when 'enum_810' then ENUM_810
  when 'enum_811' then ENUM_811
  when 'enum_812' then ENUM_812
  when 'enum_813' then ENUM_813
  when 'enum_814' then ENUM_814
  when 'enum_815' then ENUM_815
  when 'enum_816' then ENUM_816
  when 'enum_817' then ENUM_817
  when 'enum_818' then ENUM_818
  when 'enum_819' then ENUM_819
  when 'enum_820' then ENUM_820
  when 'enum_821' then ENUM_821
  when 'enum_822' then ENUM_822
  when 'enum_823' then ENUM_823
  when 'enum_824' then ENUM_824
  when 'enum_825' then ENUM_825
  when 'enum_826' then ENUM_826
  when 'enum_827' then ENUM_827
  when 'enum_828' then ENUM_828
  when 'enum_829' then ENUM_829
  when 'enum_830' then ENUM_830
  when 'enum_831' then ENUM_831
  when 'enum_832' then ENUM_832
  when 'enum_857' then ENUM_857
  when 'enum_910' then ENUM_910
  when 'enum_911' then ENUM_911
  when 'enum_912' then ENUM_912
  when 'enum_913' then ENUM_913
  when 'enum_920' then ENUM_920
  when 'enum_921' then ENUM_921
  when 'enum_922' then ENUM_922
  when 'enum_923' then ENUM_923
  when 'enum_924' then ENUM_924
  when 'enum_925' then ENUM_925
  when 'enum_930' then ENUM_930
  when 'enum_931' then ENUM_931
  when 'enum_934' then ENUM_934
  when 'enum_955' then ENUM_955
  when 'enum_957' then ENUM_957
  when 'enum_981' then ENUM_981
  when 'enum_986' then ENUM_986
  when 'enum_991' then ENUM_991
  else
    default_value
  end
end

.validate(value) ⇒ Object 



210
211
212
213
214
 
# File 'lib/usps_api/models/labels_extra_service_codes.rb', line 210

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

  LABELS_EXTRA_SERVICE_CODES.include?(value)
end