Class: WalmartApIs::TrackingSummary

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

Overview

TrackingSummary Model.

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(status: SKIP, status_updated_time: SKIP, additional_properties: nil) ⇒ TrackingSummary

Returns a new instance of TrackingSummary.



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

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

  @status = status unless status == SKIP
  @status_updated_time = status_updated_time unless status_updated_time == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#status ⇒ Status5

TODO: Write general description for this method

Returns:



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

def status
  @status
end

#status_updated_time ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


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

def status_updated_time
  @status_updated_time
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
74
75
 
# File 'lib/walmart_ap_is/models/tracking_summary.rb', line 53

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  status = hash.key?('status') ? hash['status'] : SKIP
  status_updated_time = if hash.key?('statusUpdatedTime')
                          (DateTimeHelper.from_rfc3339(hash['statusUpdatedTime']) if hash['statusUpdatedTime'])
                        else
                          SKIP
                        end

  # 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.
  TrackingSummary.new(status: status,
                      status_updated_time: status_updated_time,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['status'] = 'status'
  @_hash['status_updated_time'] = 'statusUpdatedTime'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



38
39
40
 
# File 'lib/walmart_ap_is/models/tracking_summary.rb', line 38

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    status
    status_updated_time
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



89
90
91
92
93
 
# File 'lib/walmart_ap_is/models/tracking_summary.rb', line 89

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

#to_custom_status_updated_time ⇒ Object 



77
78
79
 
# File 'lib/walmart_ap_is/models/tracking_summary.rb', line 77

def to_custom_status_updated_time
  DateTimeHelper.to_rfc3339(status_updated_time)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



82
83
84
85
86
 
# File 'lib/walmart_ap_is/models/tracking_summary.rb', line 82

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