class ShipEngine::ListManifestsResponseBody

A list manifests response body

Attributes

manifests[RW]

The list of available manifests

page[RW]

Current page of the list manifests results

pages[RW]

Total number of pages for list manifests results

total[RW]

The total number of manifests returned

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ship_engine/models/list_manifests_response_body.rb, line 34
def self.attribute_map
  {
    :'manifests' => :'manifests',
    :'total' => :'total',
    :'page' => :'page',
    :'pages' => :'pages',
    :'links' => :'links'
  }
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/ship_engine/models/list_manifests_response_body.rb, line 219
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/ship_engine/models/list_manifests_response_body.rb, line 63
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::ListManifestsResponseBody` 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|

    h[k.to_sym] = v
  }

  if attributes.key?(:'manifests')
    if (value = attributes[:'manifests']).is_a?(Array)
      self.manifests = value
    end
  end

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/ship_engine/models/list_manifests_response_body.rb, line 45
def self.openapi_types
  {
    :'manifests' => :'Array<Manifest>',
    :'total' => :'Integer',
    :'page' => :'Integer',
    :'pages' => :'Integer',
    :'links' => :'PaginationLink'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ship_engine/models/list_manifests_response_body.rb, line 194
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      manifests == o.manifests &&
      total == o.total &&
      page == o.page &&
      pages == o.pages &&
      links == o.links
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/ship_engine/models/list_manifests_response_body.rb, line 247
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
    ShipEngine.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/ship_engine/models/list_manifests_response_body.rb, line 316
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/ship_engine/models/list_manifests_response_body.rb, line 226
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/ship_engine/models/list_manifests_response_body.rb, line 206
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ship_engine/models/list_manifests_response_body.rb, line 212
def hash
  [manifests, total, page, pages, links].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/ship_engine/models/list_manifests_response_body.rb, line 99
def list_invalid_properties
  invalid_properties = Array.new
  if @manifests.nil?
    invalid_properties.push('invalid value for "manifests", manifests cannot be nil.')
  end

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

  if @total < 0
    invalid_properties.push('invalid value for "total", must be greater than or equal to 0.')
  end

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

  if @page < 1
    invalid_properties.push('invalid value for "page", must be greater than or equal to 1.')
  end

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

  if @pages < 1
    invalid_properties.push('invalid value for "pages", must be greater than or equal to 1.')
  end

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

  invalid_properties
end
page=(page) click to toggle source

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

# File lib/ship_engine/models/list_manifests_response_body.rb, line 166
def page=(page)
  if page.nil?
    fail ArgumentError, 'page cannot be nil'
  end

  if page < 1
    fail ArgumentError, 'invalid value for "page", must be greater than or equal to 1.'
  end

  @page = page
end
pages=(pages) click to toggle source

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

# File lib/ship_engine/models/list_manifests_response_body.rb, line 180
def pages=(pages)
  if pages.nil?
    fail ArgumentError, 'pages cannot be nil'
  end

  if pages < 1
    fail ArgumentError, 'invalid value for "pages", must be greater than or equal to 1.'
  end

  @pages = pages
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/ship_engine/models/list_manifests_response_body.rb, line 292
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/ship_engine/models/list_manifests_response_body.rb, line 298
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/ship_engine/models/list_manifests_response_body.rb, line 286
def to_s
  to_hash.to_s
end
total=(total) click to toggle source

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

# File lib/ship_engine/models/list_manifests_response_body.rb, line 152
def total=(total)
  if total.nil?
    fail ArgumentError, 'total cannot be nil'
  end

  if total < 0
    fail ArgumentError, 'invalid value for "total", must be greater than or equal to 0.'
  end

  @total = total
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/ship_engine/models/list_manifests_response_body.rb, line 138
def valid?
  return false if @manifests.nil?
  return false if @total.nil?
  return false if @total < 0
  return false if @page.nil?
  return false if @page < 1
  return false if @pages.nil?
  return false if @pages < 1
  return false if @links.nil?
  true
end