Class: PureCloud::PolicyErrorMessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PolicyErrorMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 80

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

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

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

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

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

  
  if attributes.has_key?(:'userParams')
    
    if (value = attributes[:'userParams']).is_a?(Array)
      self.user_params = value
    end
    
    
  
  end

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

  
end

Instance Attribute Details

#correlation_id ⇒ Object

Returns the value of attribute correlation_id.



29
30
31
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 29

def correlation_id
  @correlation_id
end

#error_code ⇒ Object

Returns the value of attribute error_code.



27
28
29
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 27

def error_code
  @error_code
end

#insert_date ⇒ Object

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



34
35
36
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 34

def insert_date
  @insert_date
end

#status_code ⇒ Object

Returns the value of attribute status_code.



21
22
23
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 21

def status_code
  @status_code
end

#user_message ⇒ Object

Returns the value of attribute user_message.



23
24
25
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 23

def user_message
  @user_message
end

#user_params ⇒ Object

Returns the value of attribute user_params.



31
32
33
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 31

def user_params
  @user_params
end

#user_params_message ⇒ Object

Returns the value of attribute user_params_message.



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

def user_params_message
  @user_params_message
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 37

def self.attribute_map
  {
    
    :'status_code' => :'statusCode',
    
    :'user_message' => :'userMessage',
    
    :'user_params_message' => :'userParamsMessage',
    
    :'error_code' => :'errorCode',
    
    :'correlation_id' => :'correlationId',
    
    :'user_params' => :'userParams',
    
    :'insert_date' => :'insertDate'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'status_code' => :'Integer',
    
    :'user_message' => :'Object',
    
    :'user_params_message' => :'String',
    
    :'error_code' => :'String',
    
    :'correlation_id' => :'String',
    
    :'user_params' => :'Array<UserParam>',
    
    :'insert_date' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status_code == o.status_code &&
      user_message == o.user_message &&
      user_params_message == o.user_params_message &&
      error_code == o.error_code &&
      correlation_id == o.correlation_id &&
      user_params == o.user_params &&
      insert_date == o.insert_date
end

#_deserialize(type, value) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 279

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 339

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 260

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


249
250
251
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 255

def hash
  [status_code, user_message, user_params_message, error_code, correlation_id, user_params, insert_date].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



156
157
158
159
160
161
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 156

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



322
323
324
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 322

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



327
328
329
330
331
332
333
334
335
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 327

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 



317
318
319
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 317

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



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
 
# File 'lib/purecloudclient_v2a/models/policy_error_message.rb', line 165

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end