Class: WalmartApIs::PackingOptionSummary

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

Overview

Summary information about a packing option.

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(packing_option_id:, status:, additional_properties: nil) ⇒ PackingOptionSummary

Returns a new instance of PackingOptionSummary.



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

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

  @packing_option_id = packing_option_id
  @status = status
  @additional_properties = additional_properties
end

Instance Attribute Details

#packing_option_id ⇒ String

Identifier of a packing option.

Returns:

  • (String) 


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

def packing_option_id
  @packing_option_id
end

#status ⇒ String

The status of a packing option. Possible values: OFFERED, ACCEPTED, EXPIRED.

Returns:

  • (String) 


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

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/walmart_ap_is/models/packing_option_summary.rb', line 49

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  packing_option_id =
    hash.key?('packingOptionId') ? hash['packingOptionId'] : nil
  status = hash.key?('status') ? hash['status'] : nil

  # 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.
  PackingOptionSummary.new(packing_option_id: packing_option_id,
                           status: status,
                           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/packing_option_summary.rb', line 22

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



78
79
80
81
82
 
# File 'lib/walmart_ap_is/models/packing_option_summary.rb', line 78

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



71
72
73
74
75
 
# File 'lib/walmart_ap_is/models/packing_option_summary.rb', line 71

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