Class: WalmartApIs::FulfillmentShipment

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

Overview

FulfillmentShipment 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(walmart_shipment_id: SKIP, fulfillment_center_id: SKIP, fulfillment_shipment_status: SKIP, shipping_date: SKIP, estimated_arrival_date: SKIP, tracking_number: SKIP, carrier: SKIP, additional_properties: nil) ⇒ FulfillmentShipment

Returns a new instance of FulfillmentShipment.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 72

def initialize(walmart_shipment_id: SKIP, fulfillment_center_id: SKIP,
               fulfillment_shipment_status: SKIP, shipping_date: SKIP,
               estimated_arrival_date: SKIP, tracking_number: SKIP,
               carrier: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @walmart_shipment_id = walmart_shipment_id unless walmart_shipment_id == SKIP
  @fulfillment_center_id = fulfillment_center_id unless fulfillment_center_id == SKIP
  unless fulfillment_shipment_status == SKIP
    @fulfillment_shipment_status =
      fulfillment_shipment_status
  end
  @shipping_date = shipping_date unless shipping_date == SKIP
  @estimated_arrival_date = estimated_arrival_date unless estimated_arrival_date == SKIP
  @tracking_number = tracking_number unless tracking_number == SKIP
  @carrier = carrier unless carrier == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#carrier ⇒ String

Walmart Ship Node ID

Returns:

  • (String) 


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

def carrier
  @carrier
end

#estimated_arrival_date ⇒ DateTime

Walmart Ship Node ID

Returns:

  • (DateTime) 


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

def estimated_arrival_date
  @estimated_arrival_date
end

#fulfillment_center_id ⇒ String

Walmart Ship Node ID

Returns:

  • (String) 


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

def fulfillment_center_id
  @fulfillment_center_id
end

#fulfillment_shipment_status ⇒ FulfillmentShipmentStatus

Walmart Ship Node ID

Returns:



23
24
25
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 23

def fulfillment_shipment_status
  @fulfillment_shipment_status
end

#shipping_date ⇒ DateTime

Walmart Ship Node ID

Returns:

  • (DateTime) 


27
28
29
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 27

def shipping_date
  @shipping_date
end

#tracking_number ⇒ String

Walmart Ship Node ID

Returns:

  • (String) 


35
36
37
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 35

def tracking_number
  @tracking_number
end

#walmart_shipment_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def walmart_shipment_id
  @walmart_shipment_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 93

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  walmart_shipment_id =
    hash.key?('walmartShipmentId') ? hash['walmartShipmentId'] : SKIP
  fulfillment_center_id =
    hash.key?('fulfillmentCenterId') ? hash['fulfillmentCenterId'] : SKIP
  fulfillment_shipment_status =
    hash.key?('fulfillmentShipmentStatus') ? hash['fulfillmentShipmentStatus'] : SKIP
  shipping_date = if hash.key?('shippingDate')
                    (DateTimeHelper.from_rfc3339(hash['shippingDate']) if hash['shippingDate'])
                  else
                    SKIP
                  end
  estimated_arrival_date = if hash.key?('estimatedArrivalDate')
                             (DateTimeHelper.from_rfc3339(hash['estimatedArrivalDate']) if hash['estimatedArrivalDate'])
                           else
                             SKIP
                           end
  tracking_number =
    hash.key?('trackingNumber') ? hash['trackingNumber'] : SKIP
  carrier = hash.key?('carrier') ? hash['carrier'] : 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.
  FulfillmentShipment.new(walmart_shipment_id: walmart_shipment_id,
                          fulfillment_center_id: fulfillment_center_id,
                          fulfillment_shipment_status: fulfillment_shipment_status,
                          shipping_date: shipping_date,
                          estimated_arrival_date: estimated_arrival_date,
                          tracking_number: tracking_number,
                          carrier: carrier,
                          additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['walmart_shipment_id'] = 'walmartShipmentId'
  @_hash['fulfillment_center_id'] = 'fulfillmentCenterId'
  @_hash['fulfillment_shipment_status'] = 'fulfillmentShipmentStatus'
  @_hash['shipping_date'] = 'shippingDate'
  @_hash['estimated_arrival_date'] = 'estimatedArrivalDate'
  @_hash['tracking_number'] = 'trackingNumber'
  @_hash['carrier'] = 'carrier'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



68
69
70
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 68

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 55

def self.optionals
  %w[
    walmart_shipment_id
    fulfillment_center_id
    fulfillment_shipment_status
    shipping_date
    estimated_arrival_date
    tracking_number
    carrier
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



154
155
156
157
158
159
160
161
162
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 154

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} walmart_shipment_id: #{@walmart_shipment_id.inspect},"\
  " fulfillment_center_id: #{@fulfillment_center_id.inspect}, fulfillment_shipment_status:"\
  " #{@fulfillment_shipment_status.inspect}, shipping_date: #{@shipping_date.inspect},"\
  " estimated_arrival_date: #{@estimated_arrival_date.inspect}, tracking_number:"\
  " #{@tracking_number.inspect}, carrier: #{@carrier.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_custom_estimated_arrival_date ⇒ Object 



139
140
141
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 139

def to_custom_estimated_arrival_date
  DateTimeHelper.to_rfc3339(estimated_arrival_date)
end

#to_custom_shipping_date ⇒ Object 



135
136
137
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 135

def to_custom_shipping_date
  DateTimeHelper.to_rfc3339(shipping_date)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



144
145
146
147
148
149
150
151
 
# File 'lib/walmart_ap_is/models/fulfillment_shipment.rb', line 144

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} walmart_shipment_id: #{@walmart_shipment_id}, fulfillment_center_id:"\
  " #{@fulfillment_center_id}, fulfillment_shipment_status: #{@fulfillment_shipment_status},"\
  " shipping_date: #{@shipping_date}, estimated_arrival_date: #{@estimated_arrival_date},"\
  " tracking_number: #{@tracking_number}, carrier: #{@carrier}, additional_properties:"\
  " #{@additional_properties}>"
end