Class: PureCloud::AnalyticsProperty

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsProperty

Initializes the object

Parameters:

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

    Model attributes in the form of hash



58
59
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
91
92
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 58

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

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

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

  
end

Instance Attribute Details

#property ⇒ Object

User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly. This is the name of the user-defined property.



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

def property
  @property
end

#property_type ⇒ Object

Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match



22
23
24
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 22

def property_type
  @property_type
end

#value ⇒ Object

What property value to match against



28
29
30
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 28

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 31

def self.attribute_map
  {
    
    :'property_type' => :'propertyType',
    
    :'property' => :'property',
    
    :'value' => :'value'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 44

def self.swagger_types
  {
    
    :'property_type' => :'String',
    
    :'property' => :'String',
    
    :'value' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



168
169
170
171
172
173
174
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      property_type == o.property_type &&
      property == o.property &&
      value == o.value
end

#_deserialize(type, value) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 208

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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 268

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 189

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


178
179
180
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



184
185
186
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 184

def hash
  [property_type, property, value].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



96
97
98
99
100
101
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 96

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



251
252
253
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 251

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



256
257
258
259
260
261
262
263
264
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 256

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 



246
247
248
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 246

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



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
136
137
138
139
 
# File 'lib/purecloudclient_v2a/models/analytics_property.rb', line 105

def valid?
  
  
  if @property_type.nil?
    return false
  end

  
  
  allowed_values = ["bool", "integer", "real", "date", "string", "uuid"]
  if @property_type && !allowed_values.include?(@property_type)
    return false
  end
  
  
  
  
  if @property.nil?
    return false
  end

  
  
  
  
  
  if @value.nil?
    return false
  end

  
  
  
  
end