class SunshineConversationsClient::Page

Attributes

after[RW]

A record id. Results will only contain the records that come after the specified record. Only one of `after` or `before` can be provided, not both.

before[RW]

A record id. Results will only contain the records that come before the specified record. Only one of `after` or `before` can be provided, not both.

size[RW]

The number of records to return. Does not apply to the `listMessages` endpoint.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/sunshine-conversations-client/models/page.rb, line 24
def self.attribute_map
  {
    :'after' => :'after',
    :'before' => :'before',
    :'size' => :'size'
  }
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/sunshine-conversations-client/models/page.rb, line 187
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/sunshine-conversations-client/models/page.rb, line 49
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Page` 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 `SunshineConversationsClient::Page`. 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?(:'after')
    self.after = attributes[:'after']
  end

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

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

List of attributes with nullable: true

# File lib/sunshine-conversations-client/models/page.rb, line 42
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/sunshine-conversations-client/models/page.rb, line 33
def self.openapi_types
  {
    :'after' => :'String',
    :'before' => :'String',
    :'size' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/sunshine-conversations-client/models/page.rb, line 164
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      after == o.after &&
      before == o.before &&
      size == o.size
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/sunshine-conversations-client/models/page.rb, line 215
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
    SunshineConversationsClient.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/sunshine-conversations-client/models/page.rb, line 284
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
after=(after) click to toggle source

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

# File lib/sunshine-conversations-client/models/page.rb, line 122
def after=(after)
  if !after.nil? && after.to_s.length > 24
    fail ArgumentError, 'invalid value for "after", the character length must be smaller than or equal to 24.'
  end

  if !after.nil? && after.to_s.length < 24
    fail ArgumentError, 'invalid value for "after", the character length must be great than or equal to 24.'
  end

  @after = after
end
before=(before) click to toggle source

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

# File lib/sunshine-conversations-client/models/page.rb, line 136
def before=(before)
  if !before.nil? && before.to_s.length > 24
    fail ArgumentError, 'invalid value for "before", the character length must be smaller than or equal to 24.'
  end

  if !before.nil? && before.to_s.length < 24
    fail ArgumentError, 'invalid value for "before", the character length must be great than or equal to 24.'
  end

  @before = before
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/sunshine-conversations-client/models/page.rb, line 194
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/sunshine-conversations-client/models/page.rb, line 174
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/sunshine-conversations-client/models/page.rb, line 180
def hash
  [after, before, size].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/sunshine-conversations-client/models/page.rb, line 79
def list_invalid_properties
  invalid_properties = Array.new
  if !@after.nil? && @after.to_s.length > 24
    invalid_properties.push('invalid value for "after", the character length must be smaller than or equal to 24.')
  end

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

  if !@before.nil? && @before.to_s.length > 24
    invalid_properties.push('invalid value for "before", the character length must be smaller than or equal to 24.')
  end

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

  if !@size.nil? && @size > 100
    invalid_properties.push('invalid value for "size", must be smaller than or equal to 100.')
  end

  if !@size.nil? && @size < 1
    invalid_properties.push('invalid value for "size", must be greater than or equal to 1.')
  end

  invalid_properties
end
size=(size) click to toggle source

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

# File lib/sunshine-conversations-client/models/page.rb, line 150
def size=(size)
  if !size.nil? && size > 100
    fail ArgumentError, 'invalid value for "size", must be smaller than or equal to 100.'
  end

  if !size.nil? && size < 1
    fail ArgumentError, 'invalid value for "size", must be greater than or equal to 1.'
  end

  @size = size
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/sunshine-conversations-client/models/page.rb, line 260
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/sunshine-conversations-client/models/page.rb, line 266
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/sunshine-conversations-client/models/page.rb, line 254
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/sunshine-conversations-client/models/page.rb, line 110
def valid?
  return false if !@after.nil? && @after.to_s.length > 24
  return false if !@after.nil? && @after.to_s.length < 24
  return false if !@before.nil? && @before.to_s.length > 24
  return false if !@before.nil? && @before.to_s.length < 24
  return false if !@size.nil? && @size > 100
  return false if !@size.nil? && @size < 1
  true
end