class AmzSpApi::FulfillmentOutboundApiModel::FulfillmentOrder

General information about a fulfillment order, including its status.

Attributes

cod_settings[RW]
delivery_window[RW]
destination_address[RW]
displayable_order_comment[RW]

A text block submitted with the createFulfillmentOrder operation. Displays in recipient-facing materials such as the packing slip.

displayable_order_date[RW]
displayable_order_id[RW]

A fulfillment order identifier submitted with the createFulfillmentOrder operation. Displays as the order identifier in recipient-facing materials such as the packing slip.

feature_constraints[RW]

A list of features and their fulfillment policies to apply to the order.

fulfillment_action[RW]
fulfillment_order_status[RW]
fulfillment_policy[RW]
marketplace_id[RW]

The identifier for the marketplace the fulfillment order is placed against.

notification_emails[RW]
received_date[RW]
seller_fulfillment_order_id[RW]

The fulfillment order identifier submitted with the createFulfillmentOrder operation.

shipping_speed_category[RW]
status_updated_date[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 55
def self.attribute_map
  {
    :'seller_fulfillment_order_id' => :'sellerFulfillmentOrderId',
    :'marketplace_id' => :'marketplaceId',
    :'displayable_order_id' => :'displayableOrderId',
    :'displayable_order_date' => :'displayableOrderDate',
    :'displayable_order_comment' => :'displayableOrderComment',
    :'shipping_speed_category' => :'shippingSpeedCategory',
    :'delivery_window' => :'deliveryWindow',
    :'destination_address' => :'destinationAddress',
    :'fulfillment_action' => :'fulfillmentAction',
    :'fulfillment_policy' => :'fulfillmentPolicy',
    :'cod_settings' => :'codSettings',
    :'received_date' => :'receivedDate',
    :'fulfillment_order_status' => :'fulfillmentOrderStatus',
    :'status_updated_date' => :'statusUpdatedDate',
    :'notification_emails' => :'notificationEmails',
    :'feature_constraints' => :'featureConstraints'
  }
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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 287
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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 106
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FulfillmentOutboundApiModel::FulfillmentOrder` 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::FulfillmentOutboundApiModel::FulfillmentOrder`. 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?(:'seller_fulfillment_order_id')
    self.seller_fulfillment_order_id = attributes[:'seller_fulfillment_order_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'feature_constraints')
    if (value = attributes[:'feature_constraints']).is_a?(Array)
      self.feature_constraints = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 77
def self.openapi_types
  {
    :'seller_fulfillment_order_id' => :'Object',
    :'marketplace_id' => :'Object',
    :'displayable_order_id' => :'Object',
    :'displayable_order_date' => :'Object',
    :'displayable_order_comment' => :'Object',
    :'shipping_speed_category' => :'Object',
    :'delivery_window' => :'Object',
    :'destination_address' => :'Object',
    :'fulfillment_action' => :'Object',
    :'fulfillment_policy' => :'Object',
    :'cod_settings' => :'Object',
    :'received_date' => :'Object',
    :'fulfillment_order_status' => :'Object',
    :'status_updated_date' => :'Object',
    :'notification_emails' => :'Object',
    :'feature_constraints' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 251
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      seller_fulfillment_order_id == o.seller_fulfillment_order_id &&
      marketplace_id == o.marketplace_id &&
      displayable_order_id == o.displayable_order_id &&
      displayable_order_date == o.displayable_order_date &&
      displayable_order_comment == o.displayable_order_comment &&
      shipping_speed_category == o.shipping_speed_category &&
      delivery_window == o.delivery_window &&
      destination_address == o.destination_address &&
      fulfillment_action == o.fulfillment_action &&
      fulfillment_policy == o.fulfillment_policy &&
      cod_settings == o.cod_settings &&
      received_date == o.received_date &&
      fulfillment_order_status == o.fulfillment_order_status &&
      status_updated_date == o.status_updated_date &&
      notification_emails == o.notification_emails &&
      feature_constraints == o.feature_constraints
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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 317
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::FulfillmentOutboundApiModel.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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 386
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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 294
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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 274
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 280
def hash
  [seller_fulfillment_order_id, marketplace_id, displayable_order_id, displayable_order_date, displayable_order_comment, shipping_speed_category, delivery_window, destination_address, fulfillment_action, fulfillment_policy, cod_settings, received_date, fulfillment_order_status, status_updated_date, notification_emails, feature_constraints].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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 188
def list_invalid_properties
  invalid_properties = Array.new
  if @seller_fulfillment_order_id.nil?
    invalid_properties.push('invalid value for "seller_fulfillment_order_id", seller_fulfillment_order_id cannot be nil.')
  end

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

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

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

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

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

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

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

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

  if @status_updated_date.nil?
    invalid_properties.push('invalid value for "status_updated_date", status_updated_date 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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 362
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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 368
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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 356
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/fulfillment-outbound-api-model/models/fulfillment_order.rb, line 235
def valid?
  return false if @seller_fulfillment_order_id.nil?
  return false if @marketplace_id.nil?
  return false if @displayable_order_id.nil?
  return false if @displayable_order_date.nil?
  return false if @displayable_order_comment.nil?
  return false if @shipping_speed_category.nil?
  return false if @destination_address.nil?
  return false if @received_date.nil?
  return false if @fulfillment_order_status.nil?
  return false if @status_updated_date.nil?
  true
end