Class: AmznSpApi::MerchantFulfillmentApiModel::ShippingServiceOptions

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

Overview

Extra services provided by a carrier.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShippingServiceOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::MerchantFulfillmentApiModel::ShippingServiceOptions` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::MerchantFulfillmentApiModel::ShippingServiceOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.delivery_experience = attributes[:delivery_experience] if attributes.key?(:delivery_experience)

  self.declared_value = attributes[:declared_value] if attributes.key?(:declared_value)

  self.carrier_will_pick_up = attributes[:carrier_will_pick_up] if attributes.key?(:carrier_will_pick_up)

  self.carrier_will_pick_up_option = attributes[:carrier_will_pick_up_option] if attributes.key?(:carrier_will_pick_up_option)

  return unless attributes.key?(:label_format)

  self.label_format = attributes[:label_format]
end

Instance Attribute Details

#carrier_will_pick_up ⇒ Object

When true, the carrier will pick up the package. Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK).



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

def carrier_will_pick_up
  @carrier_will_pick_up
end

#carrier_will_pick_up_option ⇒ Object

Returns the value of attribute carrier_will_pick_up_option.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 15

def carrier_will_pick_up_option
  @carrier_will_pick_up_option
end

#declared_value ⇒ Object

Returns the value of attribute declared_value.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 15

def declared_value
  @declared_value
end

#delivery_experience ⇒ Object

Returns the value of attribute delivery_experience.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 15

def delivery_experience
  @delivery_experience
end

#label_format ⇒ Object

Returns the value of attribute label_format.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 15

def label_format
  @label_format
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



21
22
23
24
25
26
27
28
29
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 21

def self.attribute_map
  {
    'delivery_experience': :DeliveryExperience,
    'declared_value': :DeclaredValue,
    'carrier_will_pick_up': :CarrierWillPickUp,
    'carrier_will_pick_up_option': :CarrierWillPickUpOption,
    'label_format': :LabelFormat
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



120
121
122
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 120

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



43
44
45
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 43

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
40
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 32

def self.openapi_types
  {
    'delivery_experience': :Object,
    'declared_value': :Object,
    'carrier_will_pick_up': :Object,
    'carrier_will_pick_up_option': :Object,
    'label_format': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 94

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    delivery_experience == other.delivery_experience &&
    declared_value == other.declared_value &&
    carrier_will_pick_up == other.carrier_will_pick_up &&
    carrier_will_pick_up_option == other.carrier_will_pick_up_option &&
    label_format == other.label_format
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 149

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    AmznSpApi::MerchantFulfillmentApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 218

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 127

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


107
108
109
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



113
114
115
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 113

def hash
  [delivery_experience, declared_value, carrier_will_pick_up, carrier_will_pick_up_option, label_format].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



74
75
76
77
78
79
80
81
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 74

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "delivery_experience", delivery_experience cannot be nil.') if @delivery_experience.nil?

  invalid_properties.push('invalid value for "carrier_will_pick_up", carrier_will_pick_up cannot be nil.') if @carrier_will_pick_up.nil?

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



194
195
196
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 194

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 200

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



188
189
190
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 188

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



85
86
87
88
89
90
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service_options.rb', line 85

def valid?
  return false if @delivery_experience.nil?
  return false if @carrier_will_pick_up.nil?

  true
end