Class: WalmartApIs::TrackingDetails

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

Overview

Tracking information for LTL and SPD shipments.

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(ltl_tracking_detail: SKIP, spd_tracking_detail: SKIP, additional_properties: nil) ⇒ TrackingDetails

Returns a new instance of TrackingDetails.



43
44
45
46
47
48
49
50
51
 
# File 'lib/walmart_ap_is/models/tracking_details.rb', line 43

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

  @ltl_tracking_detail = ltl_tracking_detail unless ltl_tracking_detail == SKIP
  @spd_tracking_detail = spd_tracking_detail unless spd_tracking_detail == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#ltl_tracking_detail ⇒ LtlTrackingDetail

Contains information related to Less-Than-Truckload (LTL) shipment tracking.

Returns:



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

def ltl_tracking_detail
  @ltl_tracking_detail
end

#spd_tracking_detail ⇒ SpdTrackingDetail

Contains information related to Small Parcel Delivery (SPD) shipment tracking.

Returns:



20
21
22
 
# File 'lib/walmart_ap_is/models/tracking_details.rb', line 20

def spd_tracking_detail
  @spd_tracking_detail
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  ltl_tracking_detail = LtlTrackingDetail.from_hash(hash['ltlTrackingDetail']) if
    hash['ltlTrackingDetail']
  spd_tracking_detail = SpdTrackingDetail.from_hash(hash['spdTrackingDetail']) if
    hash['spdTrackingDetail']

  # 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.
  TrackingDetails.new(ltl_tracking_detail: ltl_tracking_detail,
                      spd_tracking_detail: spd_tracking_detail,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



23
24
25
26
27
28
 
# File 'lib/walmart_ap_is/models/tracking_details.rb', line 23

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['ltl_tracking_detail'] = 'ltlTrackingDetail'
  @_hash['spd_tracking_detail'] = 'spdTrackingDetail'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/walmart_ap_is/models/tracking_details.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



31
32
33
34
35
36
 
# File 'lib/walmart_ap_is/models/tracking_details.rb', line 31

def self.optionals
  %w[
    ltl_tracking_detail
    spd_tracking_detail
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



84
85
86
87
88
 
# File 'lib/walmart_ap_is/models/tracking_details.rb', line 84

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



77
78
79
80
81
 
# File 'lib/walmart_ap_is/models/tracking_details.rb', line 77

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