class PureCloud::DocumentationResult

Attributes

categories[RW]

The category of the documentation entity. Will be returned in responses for certain entities.

content[RW]

The text or html content for the documentation entity. Will be returned in responses for certain entities.

description[RW]

The description of the documentation entity. Will be returned in responses for certain entities.

excerpt[RW]

The excerpt of the documentation entity. Will be returned in responses for certain entities.

facet_feature[RW]

The facet feature of the documentation entity. Will be returned in responses for certain entities.

facet_role[RW]

The facet role of the documentation entity. Will be returned in responses for certain entities.

facet_service[RW]

The facet service of the documentation entity. Will be returned in responses for certain entities.

faq_categories[RW]

The faq categories of the documentation entity. Will be returned in responses for certain entities.

get_type[RW]

The search type. Will be returned in responses for certain entities.

id[RW]

The globally unique identifier for the object.

modified[RW]

The modified date for the documentation entity. Will be returned in responses for certain entities. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

name[RW]

The name of the documentation entity. Will be returned in responses for certain entities.

releasenote_category[RW]

The releasenote category of the documentation entity. Will be returned in responses for certain entities.

releasenote_tag[RW]

The releasenote tag of the documentation entity. Will be returned in responses for certain entities.

service[RW]

The service of the documentation entity. Will be returned in responses for certain entities.

service_area[RW]

The service area of the documentation entity. Will be returned in responses for certain entities.

slug[RW]

The slug of the documentation entity. Will be returned in responses for certain entities.

title[RW]

The title of the documentation entity. Will be returned in responses for certain entities.

video_categories[RW]

The video categories of the documentation entity. Will be returned in responses for certain entities.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/documentation_result.rb, line 82
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'categories' => :'categories',
    
    :'description' => :'description',
    
    :'content' => :'content',
    
    :'excerpt' => :'excerpt',
    
    :'link' => :'link',
    
    :'modified' => :'modified',
    
    :'name' => :'name',
    
    :'service' => :'service',
    
    :'slug' => :'slug',
    
    :'title' => :'title',
    
    :'get_type' => :'get_type',
    
    :'facet_feature' => :'facet_feature',
    
    :'facet_role' => :'facet_role',
    
    :'facet_service' => :'facet_service',
    
    :'faq_categories' => :'faq_categories',
    
    :'releasenote_category' => :'releasenote_category',
    
    :'releasenote_tag' => :'releasenote_tag',
    
    :'service_area' => :'service-area',
    
    :'video_categories' => :'video_categories'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/documentation_result.rb, line 155
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'categories']
    if (value = attributes[:'categories']).is_a?(Array)
      self.categories = value
    end
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'content']
    self.content = attributes[:'content']
  end
  
  if attributes[:'excerpt']
    self.excerpt = attributes[:'excerpt']
  end
  
  if attributes[:'link']
    self.link = attributes[:'link']
  end
  
  if attributes[:'modified']
    self.modified = attributes[:'modified']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'service']
    if (value = attributes[:'service']).is_a?(Array)
      self.service = value
    end
  end
  
  if attributes[:'slug']
    self.slug = attributes[:'slug']
  end
  
  if attributes[:'title']
    self.title = attributes[:'title']
  end
  
  if attributes[:'get_type']
    self.get_type = attributes[:'get_type']
  end
  
  if attributes[:'facet_feature']
    if (value = attributes[:'facet_feature']).is_a?(Array)
      self.facet_feature = value
    end
  end
  
  if attributes[:'facet_role']
    if (value = attributes[:'facet_role']).is_a?(Array)
      self.facet_role = value
    end
  end
  
  if attributes[:'facet_service']
    if (value = attributes[:'facet_service']).is_a?(Array)
      self.facet_service = value
    end
  end
  
  if attributes[:'faq_categories']
    if (value = attributes[:'faq_categories']).is_a?(Array)
      self.faq_categories = value
    end
  end
  
  if attributes[:'releasenote_category']
    if (value = attributes[:'releasenote_category']).is_a?(Array)
      self.releasenote_category = value
    end
  end
  
  if attributes[:'releasenote_tag']
    if (value = attributes[:'releasenote_tag']).is_a?(Array)
      self.releasenote_tag = value
    end
  end
  
  if attributes[:'service-area']
    if (value = attributes[:'service-area']).is_a?(Array)
      self.service_area = value
    end
  end
  
  if attributes[:'video_categories']
    if (value = attributes[:'video_categories']).is_a?(Array)
      self.video_categories = value
    end
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/documentation_result.rb, line 129
def self.swagger_types
  {
    :'id' => :'Integer',
    :'categories' => :'Array<Integer>',
    :'description' => :'String',
    :'content' => :'String',
    :'excerpt' => :'String',
    :'link' => :'String',
    :'modified' => :'DateTime',
    :'name' => :'String',
    :'service' => :'Array<Integer>',
    :'slug' => :'String',
    :'title' => :'String',
    :'get_type' => :'String',
    :'facet_feature' => :'Array<Integer>',
    :'facet_role' => :'Array<Integer>',
    :'facet_service' => :'Array<Integer>',
    :'faq_categories' => :'Array<Integer>',
    :'releasenote_category' => :'Array<Integer>',
    :'releasenote_tag' => :'Array<Integer>',
    :'service_area' => :'Array<Integer>',
    :'video_categories' => :'Array<Integer>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/documentation_result.rb, line 265
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      categories == o.categories &&
      description == o.description &&
      content == o.content &&
      excerpt == o.excerpt &&
      link == o.link &&
      modified == o.modified &&
      name == o.name &&
      service == o.service &&
      slug == o.slug &&
      title == o.title &&
      get_type == o.get_type &&
      facet_feature == o.facet_feature &&
      facet_role == o.facet_role &&
      facet_service == o.facet_service &&
      faq_categories == o.faq_categories &&
      releasenote_category == o.releasenote_category &&
      releasenote_tag == o.releasenote_tag &&
      service_area == o.service_area &&
      video_categories == o.video_categories
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/documentation_result.rb, line 320
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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloud/models/documentation_result.rb, line 380
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

build the object from hash

# File lib/purecloud/models/documentation_result.rb, line 301
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
eql?(o) click to toggle source

@see the `==` method

# File lib/purecloud/models/documentation_result.rb, line 291
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/documentation_result.rb, line 296
def hash
  [id, categories, description, content, excerpt, link, modified, name, service, slug, title, get_type, facet_feature, facet_role, facet_service, faq_categories, releasenote_category, releasenote_tag, service_area, video_categories].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/documentation_result.rb, line 363
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/documentation_result.rb, line 368
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
# File lib/purecloud/models/documentation_result.rb, line 358
def to_s
  to_hash.to_s
end