Class: PureCloud::SurveyDetailQueryPredicate

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SurveyDetailQueryPredicate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
136
137
138
139
140
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 79

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

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

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

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

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

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

  
end

Instance Attribute Details

#dimension ⇒ Object

Left hand side for dimension predicates



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

def dimension
  @dimension
end

#metric ⇒ Object

Left hand side for metric predicates



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 28

def metric
  @metric
end

#operator ⇒ Object

Optional operator, default is matches



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 31

def operator
  @operator
end

#range ⇒ Object

Right hand side for dimension or metric predicates



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 37

def range
  @range
end

#type ⇒ Object

Optional type, can usually be inferred



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 22

def type
  @type
end

#value ⇒ Object

Right hand side for dimension or metric predicates



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 34

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 40

def self.attribute_map
  {
    
    :'type' => :'type',
    
    :'dimension' => :'dimension',
    
    :'metric' => :'metric',
    
    :'operator' => :'operator',
    
    :'value' => :'value',
    
    :'range' => :'range'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 59

def self.swagger_types
  {
    
    :'type' => :'String',
    
    :'dimension' => :'String',
    
    :'metric' => :'String',
    
    :'operator' => :'String',
    
    :'value' => :'String',
    
    :'range' => :'NumericRange'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      dimension == o.dimension &&
      metric == o.metric &&
      operator == o.operator &&
      value == o.value &&
      range == o.range
end

#_deserialize(type, value) ⇒ Object 



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 313

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 373

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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 294

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


283
284
285
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



289
290
291
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 289

def hash
  [type, dimension, metric, operator, value, range].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



144
145
146
147
148
149
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 144

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



356
357
358
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 356

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



361
362
363
364
365
366
367
368
369
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 361

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 



351
352
353
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 351

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



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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb', line 153

def valid?
  
  
  
  allowed_values = ["dimension", "property", "metric"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  allowed_values = ["eventTime", "queueId", "surveyCompletedDate", "surveyFormContextId", "surveyFormId", "surveyFormName", "surveyId", "surveyPromoterScore", "surveyStatus", "userId"]
  if @dimension && !allowed_values.include?(@dimension)
    return false
  end
  
  
  
  
  
  allowed_values = ["oSurveyTotalScore"]
  if @metric && !allowed_values.include?(@metric)
    return false
  end
  
  
  
  
  
  allowed_values = ["matches", "exists", "notExists"]
  if @operator && !allowed_values.include?(@operator)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end