Class: AmznSpApi::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

Raises:

  • (ArgumentError) 


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 74

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::MerchantFulfillmentApiModel::ShippingService` 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::ShippingService`. 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.shipping_service_name = attributes[:shipping_service_name] if attributes.key?(:shipping_service_name)

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

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:requires_additional_seller_inputs)

  self.requires_additional_seller_inputs = attributes[:requires_additional_seller_inputs]
end

Instance Attribute Details

#available_format_options_for_label ⇒ Object

Returns the value of attribute available_format_options_for_label.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 21

def available_format_options_for_label
  @available_format_options_for_label
end

#available_label_formats ⇒ Object

Returns the value of attribute available_label_formats.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 21

def available_label_formats
  @available_label_formats
end

#available_shipping_service_options ⇒ Object

Returns the value of attribute available_shipping_service_options.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 21

def available_shipping_service_options
  @available_shipping_service_options
end

#carrier_name ⇒ Object

The name of the carrier.



19
20
21
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 19

def carrier_name
  @carrier_name
end

#earliest_estimated_delivery_date ⇒ Object

Returns the value of attribute earliest_estimated_delivery_date.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 21

def earliest_estimated_delivery_date
  @earliest_estimated_delivery_date
end

#latest_estimated_delivery_date ⇒ Object

Returns the value of attribute latest_estimated_delivery_date.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 21

def latest_estimated_delivery_date
  @latest_estimated_delivery_date
end

#rate ⇒ Object

Returns the value of attribute rate.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 21

def rate
  @rate
end

#requires_additional_seller_inputs ⇒ Object

When true, additional seller inputs are required.



27
28
29
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 27

def requires_additional_seller_inputs
  @requires_additional_seller_inputs
end

#ship_date ⇒ Object

Returns the value of attribute ship_date.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 21

def ship_date
  @ship_date
end

#shipping_service_id ⇒ Object

Returns the value of attribute shipping_service_id.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 21

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".



16
17
18
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 16

def shipping_service_name
  @shipping_service_name
end

#shipping_service_offer_id ⇒ Object

An Amazon-defined shipping service offer identifier.



24
25
26
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 24

def shipping_service_offer_id
  @shipping_service_offer_id
end

#shipping_service_options ⇒ Object

Returns the value of attribute shipping_service_options.



21
22
23
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 21

def shipping_service_options
  @shipping_service_options
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 30

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



187
188
189
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 187

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 68

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 153

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

  self.class == other.class &&
    shipping_service_name == other.shipping_service_name &&
    carrier_name == other.carrier_name &&
    shipping_service_id == other.shipping_service_id &&
    shipping_service_offer_id == other.shipping_service_offer_id &&
    ship_date == other.ship_date &&
    earliest_estimated_delivery_date == other.earliest_estimated_delivery_date &&
    latest_estimated_delivery_date == other.latest_estimated_delivery_date &&
    rate == other.rate &&
    shipping_service_options == other.shipping_service_options &&
    available_shipping_service_options == other.available_shipping_service_options &&
    available_label_formats == other.available_label_formats &&
    available_format_options_for_label == other.available_format_options_for_label &&
    requires_additional_seller_inputs == other.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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 216

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 285

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 194

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


174
175
176
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 174

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 180

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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 115

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

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

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

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

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

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

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

  invalid_properties.push('invalid value for "requires_additional_seller_inputs", requires_additional_seller_inputs cannot be nil.') if @requires_additional_seller_inputs.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



261
262
263
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 261

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 267

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



255
256
257
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 255

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



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/merchant_fulfillment_api_model/models/shipping_service.rb', line 138

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