Class: WalmartApIs::DeliverOrderLine

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

Overview

DeliverOrderLine 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(line_number:, delivered_quantity: SKIP, tracking_number: SKIP, package_number: SKIP, delivered_date: SKIP, additional_properties: nil) ⇒ DeliverOrderLine

Returns a new instance of DeliverOrderLine.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 64

def initialize(line_number:, delivered_quantity: SKIP,
               tracking_number: SKIP, package_number: SKIP,
               delivered_date: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @line_number = line_number
  @delivered_quantity = delivered_quantity unless delivered_quantity == SKIP
  @tracking_number = tracking_number unless tracking_number == SKIP
  @package_number = package_number unless package_number == SKIP
  @delivered_date = delivered_date unless delivered_date == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#delivered_date ⇒ DateTime

ISO-8601 timestamp at which the carrier reported delivery. Optional — if omitted, FMS defaults to server time.

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 36

def delivered_date
  @delivered_date
end

#delivered_quantity ⇒ QuantityWithUnit

TODO: Write general description for this method

Returns:



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

def delivered_quantity
  @delivered_quantity
end

#line_number ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def line_number
  @line_number
end

#package_number ⇒ String

Optional package identifier within a multi-package shipment. Maps to gmp-orders-mono's per-package delivery event.

Returns:

  • (String) 


31
32
33
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 31

def package_number
  @package_number
end

#tracking_number ⇒ String

Optional proof-of-delivery breadcrumb — the tracking number the carrier scanned at delivery. Not validated against the tracking number the seller posted at ship time; both are preserved verbatim for downstream audit.

Returns:

  • (String) 


26
27
28
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 26

def tracking_number
  @tracking_number
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 79

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  line_number = hash.key?('lineNumber') ? hash['lineNumber'] : nil
  delivered_quantity = QuantityWithUnit.from_hash(hash['deliveredQuantity']) if
    hash['deliveredQuantity']
  tracking_number =
    hash.key?('trackingNumber') ? hash['trackingNumber'] : SKIP
  package_number = hash.key?('packageNumber') ? hash['packageNumber'] : SKIP
  delivered_date = if hash.key?('deliveredDate')
                     (DateTimeHelper.from_rfc3339(hash['deliveredDate']) if hash['deliveredDate'])
                   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.
  DeliverOrderLine.new(line_number: line_number,
                       delivered_quantity: delivered_quantity,
                       tracking_number: tracking_number,
                       package_number: package_number,
                       delivered_date: delivered_date,
                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



39
40
41
42
43
44
45
46
47
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 39

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['line_number'] = 'lineNumber'
  @_hash['delivered_quantity'] = 'deliveredQuantity'
  @_hash['tracking_number'] = 'trackingNumber'
  @_hash['package_number'] = 'packageNumber'
  @_hash['delivered_date'] = 'deliveredDate'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



60
61
62
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 60

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



50
51
52
53
54
55
56
57
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 50

def self.optionals
  %w[
    delivered_quantity
    tracking_number
    package_number
    delivered_date
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



124
125
126
127
128
129
130
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 124

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} line_number: #{@line_number.inspect}, delivered_quantity:"\
  " #{@delivered_quantity.inspect}, tracking_number: #{@tracking_number.inspect},"\
  " package_number: #{@package_number.inspect}, delivered_date: #{@delivered_date.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_custom_delivered_date ⇒ Object 



111
112
113
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 111

def to_custom_delivered_date
  DateTimeHelper.to_rfc3339(delivered_date)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



116
117
118
119
120
121
 
# File 'lib/walmart_ap_is/models/deliver_order_line.rb', line 116

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} line_number: #{@line_number}, delivered_quantity: #{@delivered_quantity},"\
  " tracking_number: #{@tracking_number}, package_number: #{@package_number}, delivered_date:"\
  " #{@delivered_date}, additional_properties: #{@additional_properties}>"
end