Class: WalmartApIs::ShippingServiceOptions

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

Overview

ShippingServiceOptions 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(delivery_experience: SKIP, carrier_will_pick_up: SKIP, carrier_will_pick_up_option: SKIP, declared_value: SKIP, additional_properties: nil) ⇒ ShippingServiceOptions

Returns a new instance of ShippingServiceOptions.



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

def initialize(delivery_experience: SKIP, carrier_will_pick_up: SKIP,
               carrier_will_pick_up_option: SKIP, declared_value: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @delivery_experience = delivery_experience unless delivery_experience == SKIP
  @carrier_will_pick_up = carrier_will_pick_up unless carrier_will_pick_up == SKIP
  unless carrier_will_pick_up_option == SKIP
    @carrier_will_pick_up_option =
      carrier_will_pick_up_option
  end
  @declared_value = declared_value unless declared_value == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#carrier_will_pick_up ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def carrier_will_pick_up
  @carrier_will_pick_up
end

#carrier_will_pick_up_option ⇒ CarrierWillPickUpOption

TODO: Write general description for this method

Returns:



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

def carrier_will_pick_up_option
  @carrier_will_pick_up_option
end

#declared_value ⇒ Money

TODO: Write general description for this method

Returns:



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

def declared_value
  @declared_value
end

#delivery_experience ⇒ DeliveryExperience

TODO: Write general description for this method

Returns:



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

def delivery_experience
  @delivery_experience
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



70
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/shipping_service_options.rb', line 70

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  delivery_experience =
    hash.key?('deliveryExperience') ? hash['deliveryExperience'] : SKIP
  carrier_will_pick_up =
    hash.key?('carrierWillPickUp') ? hash['carrierWillPickUp'] : SKIP
  carrier_will_pick_up_option =
    hash.key?('carrierWillPickUpOption') ? hash['carrierWillPickUpOption'] : SKIP
  declared_value = Money.from_hash(hash['declaredValue']) if hash['declaredValue']

  # 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.
  ShippingServiceOptions.new(delivery_experience: delivery_experience,
                             carrier_will_pick_up: carrier_will_pick_up,
                             carrier_will_pick_up_option: carrier_will_pick_up_option,
                             declared_value: declared_value,
                             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
 
# File 'lib/walmart_ap_is/models/shipping_service_options.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['delivery_experience'] = 'deliveryExperience'
  @_hash['carrier_will_pick_up'] = 'carrierWillPickUp'
  @_hash['carrier_will_pick_up_option'] = 'carrierWillPickUpOption'
  @_hash['declared_value'] = 'declaredValue'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/walmart_ap_is/models/shipping_service_options.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    delivery_experience
    carrier_will_pick_up
    carrier_will_pick_up_option
    declared_value
  ]
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/shipping_service_options.rb', line 106

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} delivery_experience: #{@delivery_experience.inspect}, carrier_will_pick_up:"\
  " #{@carrier_will_pick_up.inspect}, carrier_will_pick_up_option:"\
  " #{@carrier_will_pick_up_option.inspect}, declared_value: #{@declared_value.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/shipping_service_options.rb', line 98

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