Class: PureCloud::SystemMessageSystemMessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SystemMessageSystemMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#channel_id ⇒ Object

Returns the value of attribute channel_id.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 21

def channel_id
  @channel_id
end

#correlation_id ⇒ Object

Returns the value of attribute correlation_id.



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

def correlation_id
  @correlation_id
end

#data ⇒ Object

Returns the value of attribute data.



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

def data
  @data
end

#message ⇒ Object

Returns the value of attribute message.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 35

def message
  @message
end

#oauth_client_id ⇒ Object

Returns the value of attribute oauth_client_id.



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

def oauth_client_id
  @oauth_client_id
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



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

def organization_id
  @organization_id
end

#reason ⇒ Object

Returns the value of attribute reason.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 33

def reason
  @reason
end

#system_topic_type ⇒ Object

Returns the value of attribute system_topic_type.



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

def system_topic_type
  @system_topic_type
end

#user_id ⇒ Object

Returns the value of attribute user_id.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 29

def user_id
  @user_id
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
57
58
59
60
61
62
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 40

def self.attribute_map
  {
    
    :'channel_id' => :'channelId',
    
    :'system_topic_type' => :'systemTopicType',
    
    :'correlation_id' => :'correlationId',
    
    :'organization_id' => :'organizationId',
    
    :'user_id' => :'userId',
    
    :'oauth_client_id' => :'oauthClientId',
    
    :'reason' => :'reason',
    
    :'message' => :'message',
    
    :'data' => :'data'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 65

def self.swagger_types
  {
    
    :'channel_id' => :'String',
    
    :'system_topic_type' => :'String',
    
    :'correlation_id' => :'String',
    
    :'organization_id' => :'String',
    
    :'user_id' => :'String',
    
    :'oauth_client_id' => :'String',
    
    :'reason' => :'String',
    
    :'message' => :'String',
    
    :'data' => :'Object'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 308

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      channel_id == o.channel_id &&
      system_topic_type == o.system_topic_type &&
      correlation_id == o.correlation_id &&
      organization_id == o.organization_id &&
      user_id == o.user_id &&
      oauth_client_id == o.oauth_client_id &&
      reason == o.reason &&
      message == o.message &&
      data == o.data
end

#_deserialize(type, value) ⇒ Object 



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 354

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 414

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



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

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


324
325
326
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 324

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



330
331
332
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 330

def hash
  [channel_id, system_topic_type, correlation_id, organization_id, user_id, oauth_client_id, reason, message, data].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



183
184
185
186
187
188
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 183

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



397
398
399
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 397

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



402
403
404
405
406
407
408
409
410
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 402

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 



392
393
394
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 392

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



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/purecloudplatformclientv2/models/system_message_system_message.rb', line 192

def valid?
  
  
  
  
  
  
  
  allowed_values = ["no_longer_subscribed", "subscription_changed", "token_revoked"]
  if @system_topic_type && !allowed_values.include?(@system_topic_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["another_channel_subscribed", "user_tokens_revoked"]
  if @reason && !allowed_values.include?(@reason)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end