Class: PureCloud::AnalyticsSurvey

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsSurvey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
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
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#event_time ⇒ Object

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



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

def event_time
  @event_time
end

#o_survey_total_score ⇒ Object

Returns the value of attribute o_survey_total_score.



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 51

def o_survey_total_score
  @o_survey_total_score
end

#queue_id ⇒ Object

Unique identifier for the queue the conversation was on



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 40

def queue_id
  @queue_id
end

#survey_completed_date ⇒ Object

Completion date/time of the survey. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 49

def survey_completed_date
  @survey_completed_date
end

#survey_form_context_id ⇒ Object

Unique identifier for the survey form, regardless of version



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

def survey_form_context_id
  @survey_form_context_id
end

#survey_form_id ⇒ Object

Unique identifier for the survey form



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

def survey_form_id
  @survey_form_id
end

#survey_form_name ⇒ Object

Name of the survey form



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

def survey_form_name
  @survey_form_name
end

#survey_id ⇒ Object

Unique identifier for the survey



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

def survey_id
  @survey_id
end

#survey_promoter_score ⇒ Object

Promoter score of the survey



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 46

def survey_promoter_score
  @survey_promoter_score
end

#survey_status ⇒ Object

Survey status



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 43

def survey_status
  @survey_status
end

#user_id ⇒ Object

A unique identifier of the PureCloud user



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 54

def self.attribute_map
  {
    
    :'survey_id' => :'surveyId',
    
    :'survey_form_id' => :'surveyFormId',
    
    :'survey_form_name' => :'surveyFormName',
    
    :'survey_form_context_id' => :'surveyFormContextId',
    
    :'event_time' => :'eventTime',
    
    :'user_id' => :'userId',
    
    :'queue_id' => :'queueId',
    
    :'survey_status' => :'surveyStatus',
    
    :'survey_promoter_score' => :'surveyPromoterScore',
    
    :'survey_completed_date' => :'surveyCompletedDate',
    
    :'o_survey_total_score' => :'oSurveyTotalScore'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 83

def self.swagger_types
  {
    
    :'survey_id' => :'String',
    
    :'survey_form_id' => :'String',
    
    :'survey_form_name' => :'String',
    
    :'survey_form_context_id' => :'String',
    
    :'event_time' => :'DateTime',
    
    :'user_id' => :'String',
    
    :'queue_id' => :'String',
    
    :'survey_status' => :'String',
    
    :'survey_promoter_score' => :'Integer',
    
    :'survey_completed_date' => :'DateTime',
    
    :'o_survey_total_score' => :'Integer'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 338

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      survey_id == o.survey_id &&
      survey_form_id == o.survey_form_id &&
      survey_form_name == o.survey_form_name &&
      survey_form_context_id == o.survey_form_context_id &&
      event_time == o.event_time &&
      user_id == o.user_id &&
      queue_id == o.queue_id &&
      survey_status == o.survey_status &&
      survey_promoter_score == o.survey_promoter_score &&
      survey_completed_date == o.survey_completed_date &&
      o_survey_total_score == o.o_survey_total_score
end

#_deserialize(type, value) ⇒ Object 



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 386

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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 446

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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 367

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



362
363
364
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 362

def hash
  [survey_id, survey_form_id, survey_form_name, survey_form_context_id, event_time, user_id, queue_id, survey_status, survey_promoter_score, survey_completed_date, o_survey_total_score].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



223
224
225
226
227
228
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 223

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



429
430
431
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 429

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



434
435
436
437
438
439
440
441
442
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 434

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 



424
425
426
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 424

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
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
 
# File 'lib/purecloudplatformclientv2/models/analytics_survey.rb', line 232

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end