Class: PureCloud::PolicyErrorMessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PolicyErrorMessage

Returns a new instance of PolicyErrorMessage.



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
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/purecloud/models/policy_error_message.rb', line 55

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'statusCode']
    self.status_code = attributes[:'statusCode']
  end
  
  if attributes[:'userMessage']
    self.user_message = attributes[:'userMessage']
  end
  
  if attributes[:'userParamsMessage']
    self.user_params_message = attributes[:'userParamsMessage']
  end
  
  if attributes[:'errorCode']
    self.error_code = attributes[:'errorCode']
  end
  
  if attributes[:'correlationId']
    self.correlation_id = attributes[:'correlationId']
  end
  
  if attributes[:'userParams']
    if (value = attributes[:'userParams']).is_a?(Array)
      self.user_params = value
    end
  end
  
  if attributes[:'insertDate']
    self.insert_date = attributes[:'insertDate']
  end
  
end

Instance Attribute Details

#correlation_idObject

Returns the value of attribute correlation_id.



13
14
15
# File 'lib/purecloud/models/policy_error_message.rb', line 13

def correlation_id
  @correlation_id
end

#error_codeObject

Returns the value of attribute error_code.



11
12
13
# File 'lib/purecloud/models/policy_error_message.rb', line 11

def error_code
  @error_code
end

#insert_dateObject

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



18
19
20
# File 'lib/purecloud/models/policy_error_message.rb', line 18

def insert_date
  @insert_date
end

#status_codeObject

Returns the value of attribute status_code.



5
6
7
# File 'lib/purecloud/models/policy_error_message.rb', line 5

def status_code
  @status_code
end

#user_messageObject

Returns the value of attribute user_message.



7
8
9
# File 'lib/purecloud/models/policy_error_message.rb', line 7

def user_message
  @user_message
end

#user_paramsObject

Returns the value of attribute user_params.



15
16
17
# File 'lib/purecloud/models/policy_error_message.rb', line 15

def user_params
  @user_params
end

#user_params_messageObject

Returns the value of attribute user_params_message.



9
10
11
# File 'lib/purecloud/models/policy_error_message.rb', line 9

def user_params_message
  @user_params_message
end

Class Method Details

.attribute_mapObject

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



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/purecloud/models/policy_error_message.rb', line 21

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_typesObject

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/purecloud/models/policy_error_message.rb', line 42

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

Check equality by comparing each attribute.



95
96
97
98
99
100
101
102
103
104
105
# File 'lib/purecloud/models/policy_error_message.rb', line 95

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



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

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/purecloud/models/policy_error_message.rb', line 194

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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/purecloud/models/policy_error_message.rb', line 118

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

Returns:

  • (Boolean)

See Also:

  • `==` method


108
109
110
# File 'lib/purecloud/models/policy_error_message.rb', line 108

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



113
114
115
# File 'lib/purecloud/models/policy_error_message.rb', line 113

def hash
  [status_code, user_message, user_params_message, error_code, correlation_id, user_params, insert_date].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



177
178
179
# File 'lib/purecloud/models/policy_error_message.rb', line 177

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



182
183
184
185
186
187
188
189
190
# File 'lib/purecloud/models/policy_error_message.rb', line 182

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_sObject



172
173
174
# File 'lib/purecloud/models/policy_error_message.rb', line 172

def to_s
  to_hash.to_s
end