Class: WalmartApIs::CreateFulfillmentOrderItem

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

Overview

CreateFulfillmentOrderItem 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:, seller_fulfillment_order_item_id:, quantity:, gift_message: SKIP, displayable_comment: SKIP, additional_properties: nil) ⇒ CreateFulfillmentOrderItem

Returns a new instance of CreateFulfillmentOrderItem.



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/walmart_ap_is/models/create_fulfillment_order_item.rb', line 57

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

  @seller_sku = seller_sku
  @seller_fulfillment_order_item_id = seller_fulfillment_order_item_id
  @quantity = quantity
  @gift_message = gift_message unless gift_message == SKIP
  @displayable_comment = displayable_comment unless displayable_comment == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#displayable_comment ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


30
31
32
 
# File 'lib/walmart_ap_is/models/create_fulfillment_order_item.rb', line 30

def displayable_comment
  @displayable_comment
end

#gift_message ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def gift_message
  @gift_message
end

#quantity ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/walmart_ap_is/models/create_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/create_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/create_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.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  seller_sku = hash.key?('sellerSku') ? hash['sellerSku'] : nil
  seller_fulfillment_order_item_id =
    hash.key?('sellerFulfillmentOrderItemId') ? hash['sellerFulfillmentOrderItemId'] : nil
  quantity = hash.key?('quantity') ? hash['quantity'] : nil
  gift_message = hash.key?('giftMessage') ? hash['giftMessage'] : SKIP
  displayable_comment =
    hash.key?('displayableComment') ? hash['displayableComment'] : 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.
  CreateFulfillmentOrderItem.new(seller_sku: seller_sku,
                                 seller_fulfillment_order_item_id: seller_fulfillment_order_item_id,
                                 quantity: quantity,
                                 gift_message: gift_message,
                                 displayable_comment: displayable_comment,
                                 additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/walmart_ap_is/models/create_fulfillment_order_item.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['seller_sku'] = 'sellerSku'
  @_hash['seller_fulfillment_order_item_id'] =
    'sellerFulfillmentOrderItemId'
  @_hash['quantity'] = 'quantity'
  @_hash['gift_message'] = 'giftMessage'
  @_hash['displayable_comment'] = 'displayableComment'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



53
54
55
 
# File 'lib/walmart_ap_is/models/create_fulfillment_order_item.rb', line 53

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



45
46
47
48
49
50
 
# File 'lib/walmart_ap_is/models/create_fulfillment_order_item.rb', line 45

def self.optionals
  %w[
    gift_message
    displayable_comment
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



110
111
112
113
114
115
116
 
# File 'lib/walmart_ap_is/models/create_fulfillment_order_item.rb', line 110

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},"\
  " gift_message: #{@gift_message.inspect}, displayable_comment:"\
  " #{@displayable_comment.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



101
102
103
104
105
106
107
 
# File 'lib/walmart_ap_is/models/create_fulfillment_order_item.rb', line 101

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}, gift_message:"\
  " #{@gift_message}, displayable_comment: #{@displayable_comment}, additional_properties:"\
  " #{@additional_properties}>"
end