Class: PureCloud::FacetTerm

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/facet_term.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FacetTerm

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 74

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?(:'term')
    
    
    self.term = attributes[:'term']
    
  
  end

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

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

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

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

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

  
end

Instance Attribute Details

#count ⇒ Object

Returns the value of attribute count.



29
30
31
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 29

def count
  @count
end

#id ⇒ Object

Returns the value of attribute id.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 25

def id
  @id
end

#key ⇒ Object

Returns the value of attribute key.



23
24
25
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 23

def key
  @key
end

#name ⇒ Object

Returns the value of attribute name.



27
28
29
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 27

def name
  @name
end

#term ⇒ Object

Returns the value of attribute term.



21
22
23
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 21

def term
  @term
end

#time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



32
33
34
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 32

def time
  @time
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 35

def self.attribute_map
  {
    
    :'term' => :'term',
    
    :'key' => :'key',
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'count' => :'count',
    
    :'time' => :'time'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 54

def self.swagger_types
  {
    
    :'term' => :'String',
    
    :'key' => :'Integer',
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'count' => :'Integer',
    
    :'time' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      term == o.term &&
      key == o.key &&
      id == o.id &&
      name == o.name &&
      count == o.count &&
      time == o.time
end

#_deserialize(type, value) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 252

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

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 312

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 233

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


222
223
224
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 228

def hash
  [term, key, id, name, count, time].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



139
140
141
142
143
144
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 139

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



295
296
297
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 295

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



300
301
302
303
304
305
306
307
308
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 300

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 



290
291
292
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 290

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/purecloudclient_v2a/models/facet_term.rb', line 148

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end