Class: PureCloud::WrapupCode

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WrapupCode

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 84

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#created_byObject

Returns the value of attribute created_by.



35
36
37
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 35

def created_by
  @created_by
end

#date_createdObject

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



28
29
30
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 28

def date_created
  @date_created
end

#date_modifiedObject

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



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

def date_modified
  @date_modified
end

#idObject

The globally unique identifier for the object.



22
23
24
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 22

def id
  @id
end

#modified_byObject

Returns the value of attribute modified_by.



33
34
35
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 33

def modified_by
  @modified_by
end

#nameObject

The wrap-up code name.



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

def name
  @name
end

#self_uriObject

The URI for this object



38
39
40
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 38

def self_uri
  @self_uri
end

Class Method Details

.attribute_mapObject

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 41

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'modified_by' => :'modifiedBy',
    
    :'created_by' => :'createdBy',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 62

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'modified_by' => :'String',
    
    :'created_by' => :'String',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



242
243
244
245
246
247
248
249
250
251
252
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      modified_by == o.modified_by &&
      created_by == o.created_by &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



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
316
317
318
319
320
321
322
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 286

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



346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 346

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 267

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


256
257
258
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 256

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



262
263
264
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 262

def hash
  [id, name, date_created, date_modified, modified_by, created_by, self_uri].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



158
159
160
161
162
163
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 158

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



329
330
331
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 329

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



334
335
336
337
338
339
340
341
342
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 334

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



324
325
326
# File 'lib/purecloudclient_v2a/models/wrapup_code.rb', line 324

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



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

def valid?
  
  
  
  
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end