class PureCloud::Question

Attributes

answer_options[RW]
comments_required[RW]
help_text[RW]
id[RW]
is_critical[RW]
is_kill[RW]
na_enabled[RW]
na_required[RW]
text[RW]
type[RW]
visibility_condition[RW]
weight[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/question.rb, line 46
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'text' => :'text',
    
    :'help_text' => :'helpText',
    
    :'type' => :'type',
    
    :'weight' => :'weight',
    
    :'na_required' => :'naRequired',
    
    :'comments_required' => :'commentsRequired',
    
    :'is_kill' => :'isKill',
    
    :'is_critical' => :'isCritical',
    
    :'na_enabled' => :'naEnabled',
    
    :'visibility_condition' => :'visibilityCondition',
    
    :'answer_options' => :'answerOptions'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/question.rb, line 95
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[:'text']
    self.text = attributes[:'text']
  end
  
  if attributes[:'helpText']
    self.help_text = attributes[:'helpText']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'weight']
    self.weight = attributes[:'weight']
  end
  
  if attributes[:'naRequired']
    self.na_required = attributes[:'naRequired']
  end
  
  if attributes[:'commentsRequired']
    self.comments_required = attributes[:'commentsRequired']
  end
  
  if attributes[:'isKill']
    self.is_kill = attributes[:'isKill']
  end
  
  if attributes[:'isCritical']
    self.is_critical = attributes[:'isCritical']
  end
  
  if attributes[:'naEnabled']
    self.na_enabled = attributes[:'naEnabled']
  end
  
  if attributes[:'visibilityCondition']
    self.visibility_condition = attributes[:'visibilityCondition']
  end
  
  if attributes[:'answerOptions']
    if (value = attributes[:'answerOptions']).is_a?(Array)
      self.answer_options = value
    end
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/question.rb, line 77
def self.swagger_types
  {
    :'id' => :'String',
    :'text' => :'String',
    :'help_text' => :'String',
    :'type' => :'String',
    :'weight' => :'Float',
    :'na_required' => :'BOOLEAN',
    :'comments_required' => :'BOOLEAN',
    :'is_kill' => :'BOOLEAN',
    :'is_critical' => :'BOOLEAN',
    :'na_enabled' => :'BOOLEAN',
    :'visibility_condition' => :'VisibilityCondition',
    :'answer_options' => :'Array<AnswerOption>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/question.rb, line 155
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      text == o.text &&
      help_text == o.help_text &&
      type == o.type &&
      weight == o.weight &&
      na_required == o.na_required &&
      comments_required == o.comments_required &&
      is_kill == o.is_kill &&
      is_critical == o.is_critical &&
      na_enabled == o.na_enabled &&
      visibility_condition == o.visibility_condition &&
      answer_options == o.answer_options
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/question.rb, line 202
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/question.rb, line 262
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/question.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 =~ /^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/question.rb, line 173
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/question.rb, line 178
def hash
  [id, text, help_text, type, weight, na_required, comments_required, is_kill, is_critical, na_enabled, visibility_condition, answer_options].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloud/models/question.rb, line 250
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/question.rb, line 240
def to_s
  to_hash.to_s
end