Class: WalmartApIs::SpdTrackingItem

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/walmart_ap_is/models/spd_tracking_item.rb

Overview

Contains information used to track and identify a Small Parcel Delivery (SPD) item.

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(box_id: SKIP, tracking_id: SKIP, tracking_number_validation_status: SKIP, additional_properties: nil) ⇒ SpdTrackingItem

Returns a new instance of SpdTrackingItem.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 50

def initialize(box_id: SKIP, tracking_id: SKIP,
               tracking_number_validation_status: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @box_id = box_id unless box_id == SKIP
  @tracking_id = tracking_id unless tracking_id == SKIP
  unless tracking_number_validation_status == SKIP
    @tracking_number_validation_status =
      tracking_number_validation_status
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#box_id ⇒ String

The ID provided by Walmart that identifies a given box.

Returns:

  • (String) 


15
16
17
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 15

def box_id
  @box_id
end

#tracking_id ⇒ String

The tracking ID associated with each box in a non-partnered SPD shipment.

Returns:

  • (String) 


19
20
21
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 19

def tracking_id
  @tracking_id
end

#tracking_number_validation_status ⇒ String

Indicates whether Walmart has validated the tracking number. Possible values: VALIDATED, NOT_VALIDATED, NOT_SUPPORTED.

Returns:

  • (String) 


24
25
26
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 24

def tracking_number_validation_status
  @tracking_number_validation_status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 66

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  box_id = hash.key?('boxId') ? hash['boxId'] : SKIP
  tracking_id = hash.key?('trackingId') ? hash['trackingId'] : SKIP
  tracking_number_validation_status =
    hash.key?('trackingNumberValidationStatus') ? hash['trackingNumberValidationStatus'] : SKIP

  # 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.
  SpdTrackingItem.new(box_id: box_id,
                      tracking_id: tracking_id,
                      tracking_number_validation_status: tracking_number_validation_status,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



27
28
29
30
31
32
33
34
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 27

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['box_id'] = 'boxId'
  @_hash['tracking_id'] = 'trackingId'
  @_hash['tracking_number_validation_status'] =
    'trackingNumberValidationStatus'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



46
47
48
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 46

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



37
38
39
40
41
42
43
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 37

def self.optionals
  %w[
    box_id
    tracking_id
    tracking_number_validation_status
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



98
99
100
101
102
103
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 98

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



90
91
92
93
94
95
 
# File 'lib/walmart_ap_is/models/spd_tracking_item.rb', line 90

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