Class: WalmartApIs::GenerateTransportationOptionsRequest

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

Overview

The generateTransportationOptions request.

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(placement_option_id:, shipment_transportation_configurations:, additional_properties: nil) ⇒ GenerateTransportationOptionsRequest

Returns a new instance of GenerateTransportationOptionsRequest.



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

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

  @placement_option_id = placement_option_id
  @shipment_transportation_configurations = shipment_transportation_configurations
  @additional_properties = additional_properties
end

Instance Attribute Details

#placement_option_id ⇒ String

The placement option to generate transportation options for.

Returns:

  • (String) 


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

def placement_option_id
  @placement_option_id
end

#shipment_transportation_configurations ⇒ Array[ShipmentTransportationConfiguration]

List of shipment transportation configurations.

Returns:



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

def shipment_transportation_configurations
  @shipment_transportation_configurations
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/walmart_ap_is/models/generate_transportation_options_request.rb', line 51

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  placement_option_id =
    hash.key?('placementOptionId') ? hash['placementOptionId'] : nil
  # Parameter is an array, so we need to iterate through it
  shipment_transportation_configurations = nil
  unless hash['shipmentTransportationConfigurations'].nil?
    shipment_transportation_configurations = []
    hash['shipmentTransportationConfigurations'].each do |structure|
      shipment_transportation_configurations << (ShipmentTransportationConfiguration.from_hash(structure) if structure)
    end
  end

  shipment_transportation_configurations = nil unless hash.key?('shipmentTransportationConfigurations')

  # 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.
  GenerateTransportationOptionsRequest.new(placement_option_id: placement_option_id,
                                           shipment_transportation_configurations: shipment_transportation_configurations,
                                           additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
27
 
# File 'lib/walmart_ap_is/models/generate_transportation_options_request.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['placement_option_id'] = 'placementOptionId'
  @_hash['shipment_transportation_configurations'] =
    'shipmentTransportationConfigurations'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



90
91
92
93
94
95
96
 
# File 'lib/walmart_ap_is/models/generate_transportation_options_request.rb', line 90

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



82
83
84
85
86
87
 
# File 'lib/walmart_ap_is/models/generate_transportation_options_request.rb', line 82

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