class Bfwd::RefundPagedMetadata

Attributes

current_offset[RW]

{"description":"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.","verbs":}

current_page[RW]

{"description":"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.","verbs":}

execution_time[RW]

{"description":"Number of milliseconds taken by API to calculate response.","verbs":}

next_page[RW]

{"description":"Paging parameter. URL fragment that can be used to fetch next page of results.","verbs":}

records_requested[RW]

{"default":10,"description":"Paging parameter. Describes how many records you requested.","verbs":}

records_returned[RW]

{"description":"Describes how many records were returned by your query.","verbs":}

results[RW]

{"description":"The results returned by your query.","verbs":}

Public Class Methods

attribute_map() click to toggle source

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

# File lib/bf_ruby2/models/refund_paged_metadata.rb, line 41
def self.attribute_map
  {
    :'next_page' => :'nextPage',
    :'current_page' => :'currentPage',
    :'current_offset' => :'currentOffset',
    :'records_requested' => :'recordsRequested',
    :'records_returned' => :'recordsReturned',
    :'execution_time' => :'executionTime',
    :'results' => :'results'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/bf_ruby2/models/refund_paged_metadata.rb, line 68
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?(:'nextPage')
    self.next_page = attributes[:'nextPage']
  end

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/bf_ruby2/models/refund_paged_metadata.rb, line 54
def self.swagger_types
  {
    :'next_page' => :'String',
    :'current_page' => :'Integer',
    :'current_offset' => :'Integer',
    :'records_requested' => :'Integer',
    :'records_returned' => :'Integer',
    :'execution_time' => :'Integer',
    :'results' => :'Array<Refund>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/bf_ruby2/models/refund_paged_metadata.rb, line 156
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      next_page == o.next_page &&
      current_page == o.current_page &&
      current_offset == o.current_offset &&
      records_requested == o.records_requested &&
      records_returned == o.records_returned &&
      execution_time == o.execution_time &&
      results == o.results
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/bf_ruby2/models/refund_paged_metadata.rb, line 204
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
    temp_model = Bfwd.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/bf_ruby2/models/refund_paged_metadata.rb, line 270
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/bf_ruby2/models/refund_paged_metadata.rb, line 183
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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/bf_ruby2/models/refund_paged_metadata.rb, line 170
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/bf_ruby2/models/refund_paged_metadata.rb, line 176
def hash
  [next_page, current_page, current_offset, records_requested, records_returned, execution_time, results].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/bf_ruby2/models/refund_paged_metadata.rb, line 108
def list_invalid_properties
  invalid_properties = Array.new
  if @next_page.nil?
    invalid_properties.push("invalid value for 'next_page', next_page cannot be nil.")
  end

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

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

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

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

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

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

  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/bf_ruby2/models/refund_paged_metadata.rb, line 250
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/bf_ruby2/models/refund_paged_metadata.rb, line 256
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/bf_ruby2/models/refund_paged_metadata.rb, line 244
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/bf_ruby2/models/refund_paged_metadata.rb, line 143
def valid?
  return false if @next_page.nil?
  return false if @current_page.nil?
  return false if @current_offset.nil?
  return false if @records_requested.nil?
  return false if @records_returned.nil?
  return false if @execution_time.nil?
  return false if @results.nil?
  return true
end