class PureCloud::SurveyQuestion

Attributes

answer_options[RW]

Options from which to choose an answer for this question. Only used by Multiple Choice type questions.

explanation_prompt[RW]

Prompt for details explaining the chosen NPS score. Used by NPS questions.

help_text[RW]
id[RW]
max_response_characters[RW]

How many characters are allowed in the text response to this question. Used by NPS and Free Text question types.

na_enabled[RW]
text[RW]
type[RW]
visibility_condition[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/survey_question.rb, line 43
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'text' => :'text',
    
    :'help_text' => :'helpText',
    
    :'type' => :'type',
    
    :'na_enabled' => :'naEnabled',
    
    :'visibility_condition' => :'visibilityCondition',
    
    :'answer_options' => :'answerOptions',
    
    :'max_response_characters' => :'maxResponseCharacters',
    
    :'explanation_prompt' => :'explanationPrompt'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/survey_question.rb, line 94
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?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

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

  
  if attributes.has_key?(:'helpText')
    
    
    self.help_text = attributes[:'helpText']
    
  
  end

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

  
  if attributes.has_key?(:'naEnabled')
    
    
    self.na_enabled = attributes[:'naEnabled']
    
  
  end

  
  if attributes.has_key?(:'visibilityCondition')
    
    
    self.visibility_condition = attributes[:'visibilityCondition']
    
  
  end

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

  
  if attributes.has_key?(:'maxResponseCharacters')
    
    
    self.max_response_characters = attributes[:'maxResponseCharacters']
    
  
  end

  
  if attributes.has_key?(:'explanationPrompt')
    
    
    self.explanation_prompt = attributes[:'explanationPrompt']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/survey_question.rb, line 68
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'text' => :'String',
    
    :'help_text' => :'String',
    
    :'type' => :'String',
    
    :'na_enabled' => :'BOOLEAN',
    
    :'visibility_condition' => :'VisibilityCondition',
    
    :'answer_options' => :'Array<AnswerOption>',
    
    :'max_response_characters' => :'Integer',
    
    :'explanation_prompt' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/survey_question.rb, line 299
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 &&
      na_enabled == o.na_enabled &&
      visibility_condition == o.visibility_condition &&
      answer_options == o.answer_options &&
      max_response_characters == o.max_response_characters &&
      explanation_prompt == o.explanation_prompt
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/survey_question.rb, line 345
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/purecloudplatformclientv2/models/survey_question.rb, line 405
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/purecloudplatformclientv2/models/survey_question.rb, line 326
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 @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/survey_question.rb, line 315
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/survey_question.rb, line 321
def hash
  [id, text, help_text, type, na_enabled, visibility_condition, answer_options, max_response_characters, explanation_prompt].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/purecloudplatformclientv2/models/survey_question.rb, line 188
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/survey_question.rb, line 388
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/survey_question.rb, line 393
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/purecloudplatformclientv2/models/survey_question.rb, line 383
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/purecloudplatformclientv2/models/survey_question.rb, line 261
def type=(type)
  allowed_values = ["multipleChoiceQuestion", "freeTextQuestion", "npsQuestion", "readOnlyTextBlockQuestion"]
  if type && !allowed_values.include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
  end
  @type = type
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/purecloudplatformclientv2/models/survey_question.rb, line 197
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["multipleChoiceQuestion", "freeTextQuestion", "npsQuestion", "readOnlyTextBlockQuestion"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end