Class: WalmartApIs::FulfillmentOrderItem

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

Overview

FulfillmentOrderItem 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(seller_sku: SKIP, seller_fulfillment_order_item_id: SKIP, quantity: SKIP, order_item_disposition: SKIP, additional_properties: nil) ⇒ FulfillmentOrderItem

Returns a new instance of FulfillmentOrderItem.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/walmart_ap_is/models/fulfillment_order_item.rb', line 54

def initialize(seller_sku: SKIP, seller_fulfillment_order_item_id: SKIP,
               quantity: SKIP, order_item_disposition: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @seller_sku = seller_sku unless seller_sku == SKIP
  unless seller_fulfillment_order_item_id == SKIP
    @seller_fulfillment_order_item_id =
      seller_fulfillment_order_item_id
  end
  @quantity = quantity unless quantity == SKIP
  @order_item_disposition = order_item_disposition unless order_item_disposition == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#order_item_disposition ⇒ OrderItemDisposition

TODO: Write general description for this method

Returns:



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

def order_item_disposition
  @order_item_disposition
end

#quantity ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/walmart_ap_is/models/fulfillment_order_item.rb', line 22

def quantity
  @quantity
end

#seller_fulfillment_order_item_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/walmart_ap_is/models/fulfillment_order_item.rb', line 18

def seller_fulfillment_order_item_id
  @seller_fulfillment_order_item_id
end

#seller_sku ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/walmart_ap_is/models/fulfillment_order_item.rb', line 14

def seller_sku
  @seller_sku
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/walmart_ap_is/models/fulfillment_order_item.rb', line 71

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  seller_sku = hash.key?('sellerSku') ? hash['sellerSku'] : SKIP
  seller_fulfillment_order_item_id =
    hash.key?('sellerFulfillmentOrderItemId') ? hash['sellerFulfillmentOrderItemId'] : SKIP
  quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
  order_item_disposition =
    hash.key?('orderItemDisposition') ? hash['orderItemDisposition'] : 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.
  FulfillmentOrderItem.new(seller_sku: seller_sku,
                           seller_fulfillment_order_item_id: seller_fulfillment_order_item_id,
                           quantity: quantity,
                           order_item_disposition: order_item_disposition,
                           additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
37
 
# File 'lib/walmart_ap_is/models/fulfillment_order_item.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['seller_sku'] = 'sellerSku'
  @_hash['seller_fulfillment_order_item_id'] =
    'sellerFulfillmentOrderItemId'
  @_hash['quantity'] = 'quantity'
  @_hash['order_item_disposition'] = 'orderItemDisposition'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



50
51
52
 
# File 'lib/walmart_ap_is/models/fulfillment_order_item.rb', line 50

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    seller_sku
    seller_fulfillment_order_item_id
    quantity
    order_item_disposition
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



106
107
108
109
110
111
112
 
# File 'lib/walmart_ap_is/models/fulfillment_order_item.rb', line 106

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

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