Class: PureCloud::FacetTerm

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 60

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/purecloudplatformclientv2/models/facet_term.rb', line 29

def count
  @count
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#key ⇒ Object

Returns the value of attribute key.



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

def key
  @key
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#term ⇒ Object

Returns the value of attribute term.



21
22
23
 
# File 'lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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
 
# File 'lib/purecloudplatformclientv2/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.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 47

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



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 106

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 



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
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 149

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



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

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 130

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


119
120
121
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 119

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 125

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



94
95
96
97
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 94

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



192
193
194
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 192

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



197
198
199
200
201
202
203
204
205
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 197

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 



187
188
189
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 187

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



101
102
 
# File 'lib/purecloudplatformclientv2/models/facet_term.rb', line 101

def valid?
end