Class: PureCloud::DID

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DID

Returns a new instance of DID.



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

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'modifiedBy']
    self.modified_by = attributes[:'modifiedBy']
  end
  
  if attributes[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'modifiedByApp']
    self.modified_by_app = attributes[:'modifiedByApp']
  end
  
  if attributes[:'createdByApp']
    self.created_by_app = attributes[:'createdByApp']
  end
  
  if attributes[:'phoneNumber']
    self.phone_number = attributes[:'phoneNumber']
  end
  
  if attributes[:'didPool']
    self.did_pool = attributes[:'didPool']
  end
  
  if attributes[:'owner']
    self.owner = attributes[:'owner']
  end
  
  if attributes[:'ownerType']
    self.owner_type = attributes[:'ownerType']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#created_by ⇒ Object

Returns the value of attribute created_by.



22
23
24
 
# File 'lib/purecloud/models/did.rb', line 22

def created_by
  @created_by
end

#created_by_app ⇒ Object

Returns the value of attribute created_by_app.



28
29
30
 
# File 'lib/purecloud/models/did.rb', line 28

def created_by_app
  @created_by_app
end

#date_created ⇒ Object

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



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

def date_created
  @date_created
end

#date_modified ⇒ Object

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



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

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



10
11
12
 
# File 'lib/purecloud/models/did.rb', line 10

def description
  @description
end

#did_pool ⇒ Object

Returns the value of attribute did_pool.



32
33
34
 
# File 'lib/purecloud/models/did.rb', line 32

def did_pool
  @did_pool
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/did.rb', line 6

def id
  @id
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



20
21
22
 
# File 'lib/purecloud/models/did.rb', line 20

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

Returns the value of attribute modified_by_app.



26
27
28
 
# File 'lib/purecloud/models/did.rb', line 26

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/did.rb', line 8

def name
  @name
end

#owner ⇒ Object

A Uri reference to the owner of this DID, which is either a User or an IVR



35
36
37
 
# File 'lib/purecloud/models/did.rb', line 35

def owner
  @owner
end

#owner_type ⇒ Object

Returns the value of attribute owner_type.



37
38
39
 
# File 'lib/purecloud/models/did.rb', line 37

def owner_type
  @owner_type
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



30
31
32
 
# File 'lib/purecloud/models/did.rb', line 30

def phone_number
  @phone_number
end

#self_uri ⇒ Object

The URI for this object



40
41
42
 
# File 'lib/purecloud/models/did.rb', line 40

def self_uri
  @self_uri
end

#state ⇒ Object

Returns the value of attribute state.



24
25
26
 
# File 'lib/purecloud/models/did.rb', line 24

def state
  @state
end

#version ⇒ Object

Returns the value of attribute version.



12
13
14
 
# File 'lib/purecloud/models/did.rb', line 12

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
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
 
# File 'lib/purecloud/models/did.rb', line 43

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'version' => :'version',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'modified_by' => :'modifiedBy',
    
    :'created_by' => :'createdBy',
    
    :'state' => :'state',
    
    :'modified_by_app' => :'modifiedByApp',
    
    :'created_by_app' => :'createdByApp',
    
    :'phone_number' => :'phoneNumber',
    
    :'did_pool' => :'didPool',
    
    :'owner' => :'owner',
    
    :'owner_type' => :'ownerType',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/purecloud/models/did.rb', line 82

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'version' => :'Integer',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'modified_by' => :'String',
    :'created_by' => :'String',
    :'state' => :'String',
    :'modified_by_app' => :'String',
    :'created_by_app' => :'String',
    :'phone_number' => :'String',
    :'did_pool' => :'UriReference',
    :'owner' => :'UriReference',
    :'owner_type' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/purecloud/models/did.rb', line 196

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      version == o.version &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      modified_by == o.modified_by &&
      created_by == o.created_by &&
      state == o.state &&
      modified_by_app == o.modified_by_app &&
      created_by_app == o.created_by_app &&
      phone_number == o.phone_number &&
      did_pool == o.did_pool &&
      owner == o.owner &&
      owner_type == o.owner_type &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
279
280
 
# File 'lib/purecloud/models/did.rb', line 247

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/purecloud/models/did.rb', line 304

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/purecloud/models/did.rb', line 228

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


218
219
220
 
# File 'lib/purecloud/models/did.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



223
224
225
 
# File 'lib/purecloud/models/did.rb', line 223

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, phone_number, did_pool, owner, owner_type, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



287
288
289
 
# File 'lib/purecloud/models/did.rb', line 287

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



292
293
294
295
296
297
298
299
300
 
# File 'lib/purecloud/models/did.rb', line 292

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 



282
283
284
 
# File 'lib/purecloud/models/did.rb', line 282

def to_s
  to_hash.to_s
end