class OpenapiClient::PagedListResponseBody

Many ShipEngine endpoints return a paged list of items. In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.

Attributes

page[RW]

The current page number of results. For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.

pages[RW]

The total number of pages of results. For example, if there are 80 results, and the page size is 25, then `pages` would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then `pages` will be zero.

total[RW]

The total number of items across all pages of results

Public Class Methods

attribute_map() click to toggle source

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

# File lib/openapi_client/models/paged_list_response_body.rb, line 30
def self.attribute_map
  {
    :'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/openapi_client/models/paged_list_response_body.rb, line 203
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/paged_list_response_body.rb, line 57
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PagedListResponseBody` 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::PagedListResponseBody`. 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?(:'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/openapi_client/models/paged_list_response_body.rb, line 50
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/paged_list_response_body.rb, line 40
def self.openapi_types
  {
    :'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/openapi_client/models/paged_list_response_body.rb, line 179
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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/openapi_client/models/paged_list_response_body.rb, line 231
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/paged_list_response_body.rb, line 300
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/paged_list_response_body.rb, line 210
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/paged_list_response_body.rb, line 190
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/paged_list_response_body.rb, line 196
def hash
  [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/openapi_client/models/paged_list_response_body.rb, line 89
def list_invalid_properties
  invalid_properties = Array.new
  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 < 0
    invalid_properties.push('invalid value for "pages", must be greater than or equal to 0.')
  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/openapi_client/models/paged_list_response_body.rb, line 151
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/openapi_client/models/paged_list_response_body.rb, line 165
def pages=(pages)
  if pages.nil?
    fail ArgumentError, 'pages cannot be nil'
  end

  if pages < 0
    fail ArgumentError, 'invalid value for "pages", must be greater than or equal to 0.'
  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/openapi_client/models/paged_list_response_body.rb, line 276
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/paged_list_response_body.rb, line 282
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/paged_list_response_body.rb, line 270
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/openapi_client/models/paged_list_response_body.rb, line 137
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/openapi_client/models/paged_list_response_body.rb, line 124
def valid?
  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 < 0
  return false if @links.nil?
  true
end