Class: AmzSpApi::MerchantFulfillmentApiModel::ShippingService

Inherits:
Object
  • Object
show all
Defined in:
lib/merchant-fulfillment-api-model/models/shipping_service.rb

Overview

A shipping service offer made by a carrier.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShippingService

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::MerchantFulfillmentApiModel::ShippingService` initialize method"
  end

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

  if attributes.key?(:'shipping_service_name')
    self.shipping_service_name = attributes[:'shipping_service_name']
  end

  if attributes.key?(:'carrier_name')
    self.carrier_name = attributes[:'carrier_name']
  end

  if attributes.key?(:'shipping_service_id')
    self.shipping_service_id = attributes[:'shipping_service_id']
  end

  if attributes.key?(:'shipping_service_offer_id')
    self.shipping_service_offer_id = attributes[:'shipping_service_offer_id']
  end

  if attributes.key?(:'ship_date')
    self.ship_date = attributes[:'ship_date']
  end

  if attributes.key?(:'earliest_estimated_delivery_date')
    self.earliest_estimated_delivery_date = attributes[:'earliest_estimated_delivery_date']
  end

  if attributes.key?(:'latest_estimated_delivery_date')
    self.latest_estimated_delivery_date = attributes[:'latest_estimated_delivery_date']
  end

  if attributes.key?(:'rate')
    self.rate = attributes[:'rate']
  end

  if attributes.key?(:'shipping_service_options')
    self.shipping_service_options = attributes[:'shipping_service_options']
  end

  if attributes.key?(:'available_shipping_service_options')
    self.available_shipping_service_options = attributes[:'available_shipping_service_options']
  end

  if attributes.key?(:'available_label_formats')
    self.available_label_formats = attributes[:'available_label_formats']
  end

  if attributes.key?(:'available_format_options_for_label')
    self.available_format_options_for_label = attributes[:'available_format_options_for_label']
  end

  if attributes.key?(:'requires_additional_seller_inputs')
    self.requires_additional_seller_inputs = attributes[:'requires_additional_seller_inputs']
  end
end

Instance Attribute Details

#available_format_options_for_label ⇒ Object

Returns the value of attribute available_format_options_for_label.



42
43
44
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 42

def available_format_options_for_label
  @available_format_options_for_label
end

#available_label_formats ⇒ Object

Returns the value of attribute available_label_formats.



40
41
42
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 40

def available_label_formats
  @available_label_formats
end

#available_shipping_service_options ⇒ Object

Returns the value of attribute available_shipping_service_options.



38
39
40
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 38

def available_shipping_service_options
  @available_shipping_service_options
end

#carrier_name ⇒ Object

The name of the carrier.



21
22
23
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 21

def carrier_name
  @carrier_name
end

#earliest_estimated_delivery_date ⇒ Object

Returns the value of attribute earliest_estimated_delivery_date.



30
31
32
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 30

def earliest_estimated_delivery_date
  @earliest_estimated_delivery_date
end

#latest_estimated_delivery_date ⇒ Object

Returns the value of attribute latest_estimated_delivery_date.



32
33
34
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 32

def latest_estimated_delivery_date
  @latest_estimated_delivery_date
end

#rate ⇒ Object

Returns the value of attribute rate.



34
35
36
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 34

def rate
  @rate
end

#requires_additional_seller_inputs ⇒ Object

When true, additional seller inputs are required.



45
46
47
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 45

def requires_additional_seller_inputs
  @requires_additional_seller_inputs
end

#ship_date ⇒ Object

Returns the value of attribute ship_date.



28
29
30
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 28

def ship_date
  @ship_date
end

#shipping_service_id ⇒ Object

Returns the value of attribute shipping_service_id.



23
24
25
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 23

def shipping_service_id
  @shipping_service_id
end

#shipping_service_name ⇒ Object

A plain text representation of a carrier’s shipping service. For example, "UPS Ground" or "FedEx Standard Overnight".



18
19
20
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 18

def shipping_service_name
  @shipping_service_name
end

#shipping_service_offer_id ⇒ Object

An Amazon-defined shipping service offer identifier.



26
27
28
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 26

def shipping_service_offer_id
  @shipping_service_offer_id
end

#shipping_service_options ⇒ Object

Returns the value of attribute shipping_service_options.



36
37
38
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 36

def shipping_service_options
  @shipping_service_options
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 48

def self.attribute_map
  {
    :'shipping_service_name' => :'ShippingServiceName',
    :'carrier_name' => :'CarrierName',
    :'shipping_service_id' => :'ShippingServiceId',
    :'shipping_service_offer_id' => :'ShippingServiceOfferId',
    :'ship_date' => :'ShipDate',
    :'earliest_estimated_delivery_date' => :'EarliestEstimatedDeliveryDate',
    :'latest_estimated_delivery_date' => :'LatestEstimatedDeliveryDate',
    :'rate' => :'Rate',
    :'shipping_service_options' => :'ShippingServiceOptions',
    :'available_shipping_service_options' => :'AvailableShippingServiceOptions',
    :'available_label_formats' => :'AvailableLabelFormats',
    :'available_format_options_for_label' => :'AvailableFormatOptionsForLabel',
    :'requires_additional_seller_inputs' => :'RequiresAdditionalSellerInputs'
  }
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



247
248
249
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 247

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 67

def self.openapi_types
  {
    :'shipping_service_name' => :'Object',
    :'carrier_name' => :'Object',
    :'shipping_service_id' => :'Object',
    :'shipping_service_offer_id' => :'Object',
    :'ship_date' => :'Object',
    :'earliest_estimated_delivery_date' => :'Object',
    :'latest_estimated_delivery_date' => :'Object',
    :'rate' => :'Object',
    :'shipping_service_options' => :'Object',
    :'available_shipping_service_options' => :'Object',
    :'available_label_formats' => :'Object',
    :'available_format_options_for_label' => :'Object',
    :'requires_additional_seller_inputs' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      shipping_service_name == o.shipping_service_name &&
      carrier_name == o.carrier_name &&
      shipping_service_id == o.shipping_service_id &&
      shipping_service_offer_id == o.shipping_service_offer_id &&
      ship_date == o.ship_date &&
      earliest_estimated_delivery_date == o.earliest_estimated_delivery_date &&
      latest_estimated_delivery_date == o.latest_estimated_delivery_date &&
      rate == o.rate &&
      shipping_service_options == o.shipping_service_options &&
      available_shipping_service_options == o.available_shipping_service_options &&
      available_label_formats == o.available_label_formats &&
      available_format_options_for_label == o.available_format_options_for_label &&
      requires_additional_seller_inputs == o.requires_additional_seller_inputs
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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 277

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
    AmzSpApi::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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 346

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 254

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


234
235
236
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 240

def hash
  [shipping_service_name, carrier_name, shipping_service_id, shipping_service_offer_id, ship_date, earliest_estimated_delivery_date, latest_estimated_delivery_date, rate, shipping_service_options, available_shipping_service_options, available_label_formats, available_format_options_for_label, requires_additional_seller_inputs].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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 161

def list_invalid_properties
  invalid_properties = Array.new
  if @shipping_service_name.nil?
    invalid_properties.push('invalid value for "shipping_service_name", shipping_service_name cannot be nil.')
  end

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

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

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

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

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

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

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

  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



322
323
324
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 322

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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 328

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



316
317
318
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 316

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



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/merchant-fulfillment-api-model/models/shipping_service.rb', line 200

def valid?
  return false if @shipping_service_name.nil?
  return false if @carrier_name.nil?
  return false if @shipping_service_id.nil?
  return false if @shipping_service_offer_id.nil?
  return false if @ship_date.nil?
  return false if @rate.nil?
  return false if @shipping_service_options.nil?
  return false if @requires_additional_seller_inputs.nil?
  true
end