Class: WalmartApIs::PackingConfiguration

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

Overview

A way to configure this 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(box_packing_methods: SKIP, box_requirements: SKIP, shipping_requirements: SKIP, additional_properties: nil) ⇒ PackingConfiguration

Returns a new instance of PackingConfiguration.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/walmart_ap_is/models/packing_configuration.rb', line 47

def initialize(box_packing_methods: SKIP, box_requirements: SKIP,
               shipping_requirements: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @box_packing_methods = box_packing_methods unless box_packing_methods == SKIP
  @box_requirements = box_requirements unless box_requirements == SKIP
  @shipping_requirements = shipping_requirements unless shipping_requirements == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#box_packing_methods ⇒ Array[BoxContentInformationSource]

The box content information sources that are allowed.

Returns:



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

def box_packing_methods
  @box_packing_methods
end

#box_requirements ⇒ BoxRequirements

The requirements for a box in the packing option.

Returns:



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

def box_requirements
  @box_requirements
end

#shipping_requirements ⇒ Array[ShippingRequirements]

A list of supported shipping requirements for this packing configuration.

Returns:



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

def shipping_requirements
  @shipping_requirements
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



59
60
61
62
63
64
65
66
67
68
69
70
71
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/packing_configuration.rb', line 59

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  box_packing_methods =
    hash.key?('boxPackingMethods') ? hash['boxPackingMethods'] : SKIP
  box_requirements = BoxRequirements.from_hash(hash['boxRequirements']) if
    hash['boxRequirements']
  # Parameter is an array, so we need to iterate through it
  shipping_requirements = nil
  unless hash['shippingRequirements'].nil?
    shipping_requirements = []
    hash['shippingRequirements'].each do |structure|
      shipping_requirements << (ShippingRequirements.from_hash(structure) if structure)
    end
  end

  shipping_requirements = SKIP unless hash.key?('shippingRequirements')

  # 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.
  PackingConfiguration.new(box_packing_methods: box_packing_methods,
                           box_requirements: box_requirements,
                           shipping_requirements: shipping_requirements,
                           additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/walmart_ap_is/models/packing_configuration.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['box_packing_methods'] = 'boxPackingMethods'
  @_hash['box_requirements'] = 'boxRequirements'
  @_hash['shipping_requirements'] = 'shippingRequirements'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/walmart_ap_is/models/packing_configuration.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/walmart_ap_is/models/packing_configuration.rb', line 34

def self.optionals
  %w[
    box_packing_methods
    box_requirements
    shipping_requirements
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



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

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



93
94
95
96
97
98
 
# File 'lib/walmart_ap_is/models/packing_configuration.rb', line 93

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