class Freeclimb::IncomingNumberList

Attributes

_end[RW]

Resource index at end of current page

incoming_phone_numbers[RW]
next_page_uri[RW]

Uri to retrieve the next page of items

num_pages[RW]

Total number of pages

page[RW]

Current page

page_size[RW]

Number of items per page

start[RW]

Resource index at start of current page

total[RW]

Total amount of requested resource.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/freeclimb/models/incoming_number_list.rb, line 41
def self.attribute_map
  {
    :'total' => :'total',
    :'start' => :'start',
    :'_end' => :'end',
    :'page' => :'page',
    :'num_pages' => :'numPages',
    :'page_size' => :'pageSize',
    :'next_page_uri' => :'nextPageUri',
    :'incoming_phone_numbers' => :'incomingPhoneNumbers'
  }
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/freeclimb/models/incoming_number_list.rb, line 175
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/freeclimb/models/incoming_number_list.rb, line 84
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::IncomingNumberList` 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 `Freeclimb::IncomingNumberList`. 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?(:'start')
    self.start = attributes[:'start']
  end

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

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

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

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

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

  if attributes.key?(:'incoming_phone_numbers')
    if (value = attributes[:'incoming_phone_numbers']).is_a?(Array)
      self.incoming_phone_numbers = value
    end
  end
end
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/freeclimb/models/incoming_number_list.rb, line 75
def self.openapi_all_of
  [
  :'IncomingNumberListAllOf',
  :'PaginationModel'
  ]
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/freeclimb/models/incoming_number_list.rb, line 55
def self.openapi_types
  {
    :'total' => :'Integer',
    :'start' => :'Integer',
    :'_end' => :'Integer',
    :'page' => :'Integer',
    :'num_pages' => :'Integer',
    :'page_size' => :'Integer',
    :'next_page_uri' => :'String',
    :'incoming_phone_numbers' => :'Array<IncomingNumberResult>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/freeclimb/models/incoming_number_list.rb, line 147
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      start == o.start &&
      _end == o._end &&
      page == o.page &&
      num_pages == o.num_pages &&
      page_size == o.page_size &&
      next_page_uri == o.next_page_uri &&
      incoming_phone_numbers == o.incoming_phone_numbers
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/freeclimb/models/incoming_number_list.rb, line 203
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
    Freeclimb.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/freeclimb/models/incoming_number_list.rb, line 272
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/freeclimb/models/incoming_number_list.rb, line 182
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/freeclimb/models/incoming_number_list.rb, line 162
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/freeclimb/models/incoming_number_list.rb, line 168
def hash
  [total, start, _end, page, num_pages, page_size, next_page_uri, incoming_phone_numbers].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/freeclimb/models/incoming_number_list.rb, line 134
def list_invalid_properties
  invalid_properties = Array.new
  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/freeclimb/models/incoming_number_list.rb, line 248
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/freeclimb/models/incoming_number_list.rb, line 254
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/freeclimb/models/incoming_number_list.rb, line 242
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/freeclimb/models/incoming_number_list.rb, line 141
def valid?
  true
end