class OpenapiClient::DeprecatedManifest

Deprecated manifest resource

Attributes

carrier_id[RW]

A string that uniquely identifies the carrier

created_at[RW]

The date-time that the manifest was created

form_id[RW]

A string that uniquely identifies the form

manifest_download[RW]
manifest_id[RW]

A string that uniquely identifies the manifest

ship_date[RW]

The date-time that the manifests shipments will be picked up

shipments[RW]

The number of shipments that are included in this manifest

submission_id[RW]

A string that uniquely identifies the submission

warehouse_id[RW]

A string that uniquely identifies the warehouse

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/deprecated_manifest.rb, line 45
def self.attribute_map
  {
    :'manifest_id' => :'manifest_id',
    :'form_id' => :'form_id',
    :'created_at' => :'created_at',
    :'ship_date' => :'ship_date',
    :'shipments' => :'shipments',
    :'warehouse_id' => :'warehouse_id',
    :'submission_id' => :'submission_id',
    :'carrier_id' => :'carrier_id',
    :'manifest_download' => :'manifest_download'
  }
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/openapi_client/models/deprecated_manifest.rb, line 206
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/openapi_client/models/deprecated_manifest.rb, line 82
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::DeprecatedManifest` 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 `OpenapiClient::DeprecatedManifest`. 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?(:'manifest_id')
    self.manifest_id = attributes[:'manifest_id']
  end

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

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

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

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

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

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

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

  if attributes.key?(:'manifest_download')
    self.manifest_download = attributes[:'manifest_download']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/openapi_client/models/deprecated_manifest.rb, line 75
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/deprecated_manifest.rb, line 60
def self.openapi_types
  {
    :'manifest_id' => :'String',
    :'form_id' => :'String',
    :'created_at' => :'DateTime',
    :'ship_date' => :'DateTime',
    :'shipments' => :'Integer',
    :'warehouse_id' => :'String',
    :'submission_id' => :'String',
    :'carrier_id' => :'String',
    :'manifest_download' => :'ManifestDownload'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/openapi_client/models/deprecated_manifest.rb, line 177
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      manifest_id == o.manifest_id &&
      form_id == o.form_id &&
      created_at == o.created_at &&
      ship_date == o.ship_date &&
      shipments == o.shipments &&
      warehouse_id == o.warehouse_id &&
      submission_id == o.submission_id &&
      carrier_id == o.carrier_id &&
      manifest_download == o.manifest_download
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/openapi_client/models/deprecated_manifest.rb, line 234
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
    OpenapiClient.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/openapi_client/models/deprecated_manifest.rb, line 303
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/openapi_client/models/deprecated_manifest.rb, line 213
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]]))
    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/openapi_client/models/deprecated_manifest.rb, line 193
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/openapi_client/models/deprecated_manifest.rb, line 199
def hash
  [manifest_id, form_id, created_at, ship_date, shipments, warehouse_id, submission_id, carrier_id, manifest_download].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/openapi_client/models/deprecated_manifest.rb, line 134
def list_invalid_properties
  invalid_properties = Array.new
  if !@shipments.nil? && @shipments < 1
    invalid_properties.push('invalid value for "shipments", must be greater than or equal to 1.')
  end

  if !@submission_id.nil? && @submission_id.to_s.length < 1
    invalid_properties.push('invalid value for "submission_id", the character length must be great than or equal to 1.')
  end

  invalid_properties
end
shipments=(shipments) click to toggle source

Custom attribute writer method with validation @param [Object] shipments Value to be assigned

# File lib/openapi_client/models/deprecated_manifest.rb, line 157
def shipments=(shipments)
  if !shipments.nil? && shipments < 1
    fail ArgumentError, 'invalid value for "shipments", must be greater than or equal to 1.'
  end

  @shipments = shipments
end
submission_id=(submission_id) click to toggle source

Custom attribute writer method with validation @param [Object] submission_id Value to be assigned

# File lib/openapi_client/models/deprecated_manifest.rb, line 167
def submission_id=(submission_id)
  if !submission_id.nil? && submission_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "submission_id", the character length must be great than or equal to 1.'
  end

  @submission_id = submission_id
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/openapi_client/models/deprecated_manifest.rb, line 279
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/openapi_client/models/deprecated_manifest.rb, line 285
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/openapi_client/models/deprecated_manifest.rb, line 273
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/openapi_client/models/deprecated_manifest.rb, line 149
def valid?
  return false if !@shipments.nil? && @shipments < 1
  return false if !@submission_id.nil? && @submission_id.to_s.length < 1
  true
end