class AmzSpApi::MerchantFulfillmentApiModel::ShippingService

A shipping service offer made by a carrier.

Attributes

available_format_options_for_label[RW]
available_label_formats[RW]
available_shipping_service_options[RW]
carrier_name[RW]

The name of the carrier.

earliest_estimated_delivery_date[RW]
latest_estimated_delivery_date[RW]
rate[RW]
requires_additional_seller_inputs[RW]

When true, additional seller inputs are required.

ship_date[RW]
shipping_service_id[RW]
shipping_service_name[RW]

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

shipping_service_offer_id[RW]

An Amazon-defined shipping service offer identifier.

shipping_service_options[RW]

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/merchant-fulfillment-api-model/models/shipping_service.rb, line 247
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/merchant-fulfillment-api-model/models/shipping_service.rb, line 86
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/merchant-fulfillment-api-model/models/shipping_service.rb, line 234
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/merchant-fulfillment-api-model/models/shipping_service.rb, line 322
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/merchant-fulfillment-api-model/models/shipping_service.rb, line 316
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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