Class: PureCloud::SubDataItem

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/sub_data_item.rb

Overview

An additional data element that was set by the user for this event.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubDataItem

Returns a new instance of SubDataItem.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/purecloud/models/sub_data_item.rb', line 50

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[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'value']
    self.value = attributes[:'value']
  end
  
  if attributes[:'prompt']
    self.prompt = attributes[:'prompt']
  end
  
  if attributes[:'displayValue']
    self.display_value = attributes[:'displayValue']
  end
  
end

Instance Attribute Details

#display_value ⇒ Object

The display value that was offered to the user (as opposed to the actual value used internally



19
20
21
 
# File 'lib/purecloud/models/sub_data_item.rb', line 19

def display_value
  @display_value
end

#id ⇒ Object

The id of this element



7
8
9
 
# File 'lib/purecloud/models/sub_data_item.rb', line 7

def id
  @id
end

#prompt ⇒ Object

The prompt displayed to the user that this data item was set from.



16
17
18
 
# File 'lib/purecloud/models/sub_data_item.rb', line 16

def prompt
  @prompt
end

#type ⇒ Object

The ‘type’ of the element, this may be a system value, EG ‘STRING’ or a user defined type



10
11
12
 
# File 'lib/purecloud/models/sub_data_item.rb', line 10

def type
  @type
end

#value ⇒ Object

The value of the element itself - This may be a simple value or more complex serialized data.



13
14
15
 
# File 'lib/purecloud/models/sub_data_item.rb', line 13

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/purecloud/models/sub_data_item.rb', line 22

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'type' => :'type',
    
    :'value' => :'value',
    
    :'prompt' => :'prompt',
    
    :'display_value' => :'displayValue'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/purecloud/models/sub_data_item.rb', line 39

def self.swagger_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'value' => :'String',
    :'prompt' => :'String',
    :'display_value' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



80
81
82
83
84
85
86
87
88
 
# File 'lib/purecloud/models/sub_data_item.rb', line 80

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      value == o.value &&
      prompt == o.prompt &&
      display_value == o.display_value
end

#_deserialize(type, value) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/purecloud/models/sub_data_item.rb', line 120

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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) ⇒ Object

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



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/purecloud/models/sub_data_item.rb', line 177

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) ⇒ Object

build the object from hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/purecloud/models/sub_data_item.rb', line 101

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) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


91
92
93
 
# File 'lib/purecloud/models/sub_data_item.rb', line 91

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



96
97
98
 
# File 'lib/purecloud/models/sub_data_item.rb', line 96

def hash
  [id, type, value, prompt, display_value].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



160
161
162
 
# File 'lib/purecloud/models/sub_data_item.rb', line 160

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



165
166
167
168
169
170
171
172
173
 
# File 'lib/purecloud/models/sub_data_item.rb', line 165

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 ⇒ Object 



155
156
157
 
# File 'lib/purecloud/models/sub_data_item.rb', line 155

def to_s
  to_hash.to_s
end