Class: UspsApi::OriginalPackage

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

Overview

Information about the original package when an over labeled package is being created.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(original_tracking_number:, original_construct_code: OriginalConstructCode::I01, additional_properties: nil) ⇒ OriginalPackage

Returns a new instance of OriginalPackage.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/usps_api/models/original_package.rb', line 41

def initialize(original_tracking_number:,
               original_construct_code: OriginalConstructCode::I01,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @original_tracking_number = original_tracking_number
  @original_construct_code = original_construct_code
  @additional_properties = additional_properties
end

Instance Attribute Details

#original_construct_code ⇒ OriginalConstructCode

A 3-character code to identify the construct of the Original Label Tracking Number.

Returns:



21
22
23
 
# File 'lib/usps_api/models/original_package.rb', line 21

def original_construct_code
  @original_construct_code
end

#original_tracking_number ⇒ String

The tracking number associated with the package before it was over labeled.

Returns:

  • (String) 


16
17
18
 
# File 'lib/usps_api/models/original_package.rb', line 16

def original_tracking_number
  @original_tracking_number
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  original_tracking_number =
    hash.key?('originalTrackingNumber') ? hash['originalTrackingNumber'] : nil
  original_construct_code =
    hash['originalConstructCode'] ||= OriginalConstructCode::I01

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  OriginalPackage.new(original_tracking_number: original_tracking_number,
                      original_construct_code: original_construct_code,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



24
25
26
27
28
29
 
# File 'lib/usps_api/models/original_package.rb', line 24

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['original_tracking_number'] = 'originalTrackingNumber'
  @_hash['original_construct_code'] = 'originalConstructCode'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/usps_api/models/original_package.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



32
33
34
 
# File 'lib/usps_api/models/original_package.rb', line 32

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



84
85
86
87
88
89
 
# File 'lib/usps_api/models/original_package.rb', line 84

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} original_tracking_number: #{@original_tracking_number.inspect},"\
  " original_construct_code: #{@original_construct_code.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} original_tracking_number: #{@original_tracking_number},"\
  " original_construct_code: #{@original_construct_code}, additional_properties:"\
  " #{@additional_properties}>"
end