class OrderCloud::BuyerShipment

Attributes

account[RW]
cost[RW]
date_delivered[RW]
date_shipped[RW]
from_address[RW]
from_address_id[RW]
id[RW]
shipper[RW]
to_address[RW]
to_address_id[RW]
tracking_number[RW]
xp[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/order_cloud/models/buyer_shipment.rb, line 55
def self.attribute_map
  {
    :'id' => :'ID',
    :'shipper' => :'Shipper',
    :'date_shipped' => :'DateShipped',
    :'date_delivered' => :'DateDelivered',
    :'tracking_number' => :'TrackingNumber',
    :'cost' => :'Cost',
    :'xp' => :'xp',
    :'account' => :'Account',
    :'from_address_id' => :'FromAddressID',
    :'to_address_id' => :'ToAddressID',
    :'from_address' => :'FromAddress',
    :'to_address' => :'ToAddress'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/order_cloud/models/buyer_shipment.rb, line 92
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'ID')
    self.id = attributes[:'ID']
  end

  if attributes.has_key?(:'Shipper')
    self.shipper = attributes[:'Shipper']
  end

  if attributes.has_key?(:'DateShipped')
    self.date_shipped = attributes[:'DateShipped']
  end

  if attributes.has_key?(:'DateDelivered')
    self.date_delivered = attributes[:'DateDelivered']
  end

  if attributes.has_key?(:'TrackingNumber')
    self.tracking_number = attributes[:'TrackingNumber']
  end

  if attributes.has_key?(:'Cost')
    self.cost = attributes[:'Cost']
  end

  if attributes.has_key?(:'xp')
    self.xp = attributes[:'xp']
  end

  if attributes.has_key?(:'Account')
    self.account = attributes[:'Account']
  end

  if attributes.has_key?(:'FromAddressID')
    self.from_address_id = attributes[:'FromAddressID']
  end

  if attributes.has_key?(:'ToAddressID')
    self.to_address_id = attributes[:'ToAddressID']
  end

  if attributes.has_key?(:'FromAddress')
    self.from_address = attributes[:'FromAddress']
  end

  if attributes.has_key?(:'ToAddress')
    self.to_address = attributes[:'ToAddress']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/order_cloud/models/buyer_shipment.rb, line 73
def self.swagger_types
  {
    :'id' => :'String',
    :'shipper' => :'String',
    :'date_shipped' => :'String',
    :'date_delivered' => :'String',
    :'tracking_number' => :'String',
    :'cost' => :'Float',
    :'xp' => :'Object',
    :'account' => :'String',
    :'from_address_id' => :'String',
    :'to_address_id' => :'String',
    :'from_address' => :'Address',
    :'to_address' => :'Address'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/order_cloud/models/buyer_shipment.rb, line 163
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      shipper == o.shipper &&
      date_shipped == o.date_shipped &&
      date_delivered == o.date_delivered &&
      tracking_number == o.tracking_number &&
      cost == o.cost &&
      xp == o.xp &&
      account == o.account &&
      from_address_id == o.from_address_id &&
      to_address_id == o.to_address_id &&
      from_address == o.from_address &&
      to_address == o.to_address
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/order_cloud/models/buyer_shipment.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 =~ /^(true|t|yes|y|1)$/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
    temp_model = OrderCloud.const_get(type).new
    temp_model.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/order_cloud/models/buyer_shipment.rb, line 282
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/order_cloud/models/buyer_shipment.rb, line 195
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the 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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/order_cloud/models/buyer_shipment.rb, line 182
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/order_cloud/models/buyer_shipment.rb, line 188
def hash
  [id, shipper, date_shipped, date_delivered, tracking_number, cost, xp, account, from_address_id, to_address_id, from_address, to_address].hash
end
list_invalid_properties() click to toggle source

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

# File lib/order_cloud/models/buyer_shipment.rb, line 150
def list_invalid_properties
  invalid_properties = Array.new
  return 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/order_cloud/models/buyer_shipment.rb, line 262
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/order_cloud/models/buyer_shipment.rb, line 268
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/order_cloud/models/buyer_shipment.rb, line 256
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/order_cloud/models/buyer_shipment.rb, line 157
def valid?
  return true
end