Class: PureCloud::Phone

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Phone

Returns a new instance of Phone.



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
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
241
242
243
244
245
246
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
281
282
283
 
# File 'lib/purecloud/models/phone.rb', line 172

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[:'site']
    self.site = attributes[:'site']
  end
  
  if attributes[:'phoneBaseSettings']
    self.phone_base_settings = attributes[:'phoneBaseSettings']
  end
  
  if attributes[:'lineBaseSettings']
    self.line_base_settings = attributes[:'lineBaseSettings']
  end
  
  if attributes[:'phoneMetaBase']
    self.phone_meta_base = attributes[:'phoneMetaBase']
  end
  
  if attributes[:'lines']
    if (value = attributes[:'lines']).is_a?(Array)
      self.lines = value
    end
  end
  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'secondaryStatus']
    self.secondary_status = attributes[:'secondaryStatus']
  end
  
  if attributes[:'userAgentInfo']
    self.user_agent_info = attributes[:'userAgentInfo']
  end
  
  if attributes[:'properties']
    if (value = attributes[:'properties']).is_a?(Array)
      self.properties = value
    end
  end
  
  if attributes[:'capabilities']
    self.capabilities = attributes[:'capabilities']
  end
  
  if attributes[:'webRtcUser']
    self.web_rtc_user = attributes[:'webRtcUser']
  end
  
  if attributes[:'primaryEdge']
    self.primary_edge = attributes[:'primaryEdge']
  end
  
  if attributes[:'secondaryEdge']
    self.secondary_edge = attributes[:'secondaryEdge']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#capabilities ⇒ Object

Returns the value of attribute capabilities.



71
72
73
 
# File 'lib/purecloud/models/phone.rb', line 71

def capabilities
  @capabilities
end

#created_by ⇒ Object

Returns the value of attribute created_by.



39
40
41
 
# File 'lib/purecloud/models/phone.rb', line 39

def created_by
  @created_by
end

#created_by_app ⇒ Object

Returns the value of attribute created_by_app.



45
46
47
 
# File 'lib/purecloud/models/phone.rb', line 45

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



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

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



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

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



27
28
29
 
# File 'lib/purecloud/models/phone.rb', line 27

def description
  @description
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#line_base_settings ⇒ Object

Returns the value of attribute line_base_settings.



53
54
55
 
# File 'lib/purecloud/models/phone.rb', line 53

def line_base_settings
  @line_base_settings
end

#lines ⇒ Object

Lines



58
59
60
 
# File 'lib/purecloud/models/phone.rb', line 58

def lines
  @lines
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



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

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

Returns the value of attribute modified_by_app.



43
44
45
 
# File 'lib/purecloud/models/phone.rb', line 43

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

The name of the entity.



25
26
27
 
# File 'lib/purecloud/models/phone.rb', line 25

def name
  @name
end

#phone_base_settings ⇒ Object

Phone Base Settings



51
52
53
 
# File 'lib/purecloud/models/phone.rb', line 51

def phone_base_settings
  @phone_base_settings
end

#phone_meta_base ⇒ Object

Returns the value of attribute phone_meta_base.



55
56
57
 
# File 'lib/purecloud/models/phone.rb', line 55

def phone_meta_base
  @phone_meta_base
end

#primary_edge ⇒ Object

Returns the value of attribute primary_edge.



76
77
78
 
# File 'lib/purecloud/models/phone.rb', line 76

def primary_edge
  @primary_edge
end

#properties ⇒ Object

Returns the value of attribute properties.



69
70
71
 
# File 'lib/purecloud/models/phone.rb', line 69

def properties
  @properties
end

#secondary_edge ⇒ Object

Returns the value of attribute secondary_edge.



78
79
80
 
# File 'lib/purecloud/models/phone.rb', line 78

def secondary_edge
  @secondary_edge
end

#secondary_status ⇒ Object

The status of the phone and lines from the secondary Edge.



64
65
66
 
# File 'lib/purecloud/models/phone.rb', line 64

def secondary_status
  @secondary_status
end

#self_uri ⇒ Object

The URI for this object



81
82
83
 
# File 'lib/purecloud/models/phone.rb', line 81

def self_uri
  @self_uri
end

#site ⇒ Object

The site associated to the phone.



48
49
50
 
# File 'lib/purecloud/models/phone.rb', line 48

def site
  @site
end

#state ⇒ Object

Returns the value of attribute state.



41
42
43
 
# File 'lib/purecloud/models/phone.rb', line 41

def state
  @state
end

#status ⇒ Object

The status of the phone and lines from the primary Edge.



61
62
63
 
# File 'lib/purecloud/models/phone.rb', line 61

def status
  @status
end

#user_agent_info ⇒ Object

User Agent Information for this phone. This includes model, firmware version, and manufacturer.



67
68
69
 
# File 'lib/purecloud/models/phone.rb', line 67

def user_agent_info
  @user_agent_info
end

#version ⇒ Object

Returns the value of attribute version.



29
30
31
 
# File 'lib/purecloud/models/phone.rb', line 29

def version
  @version
end

#web_rtc_user ⇒ Object

This is the user associated with a WebRTC type phone. It is required for all WebRTC phones.



74
75
76
 
# File 'lib/purecloud/models/phone.rb', line 74

def web_rtc_user
  @web_rtc_user
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    
    :'site' => :'site',
    
    :'phone_base_settings' => :'phoneBaseSettings',
    
    :'line_base_settings' => :'lineBaseSettings',
    
    :'phone_meta_base' => :'phoneMetaBase',
    
    :'lines' => :'lines',
    
    :'status' => :'status',
    
    :'secondary_status' => :'secondaryStatus',
    
    :'user_agent_info' => :'userAgentInfo',
    
    :'properties' => :'properties',
    
    :'capabilities' => :'capabilities',
    
    :'web_rtc_user' => :'webRtcUser',
    
    :'primary_edge' => :'primaryEdge',
    
    :'secondary_edge' => :'secondaryEdge',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/phone.rb', line 141

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',
    :'site' => :'UriReference',
    :'phone_base_settings' => :'UriReference',
    :'line_base_settings' => :'UriReference',
    :'phone_meta_base' => :'UriReference',
    :'lines' => :'Array<Line>',
    :'status' => :'PhoneStatus',
    :'secondary_status' => :'PhoneStatus',
    :'user_agent_info' => :'UserAgentInfo',
    :'properties' => :'Hash<String, Object>',
    :'capabilities' => :'PhoneCapabilities',
    :'web_rtc_user' => :'UriReference',
    :'primary_edge' => :'Edge',
    :'secondary_edge' => :'Edge',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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
323
 
# File 'lib/purecloud/models/phone.rb', line 295

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 &&
      site == o.site &&
      phone_base_settings == o.phone_base_settings &&
      line_base_settings == o.line_base_settings &&
      phone_meta_base == o.phone_meta_base &&
      lines == o.lines &&
      status == o.status &&
      secondary_status == o.secondary_status &&
      user_agent_info == o.user_agent_info &&
      properties == o.properties &&
      capabilities == o.capabilities &&
      web_rtc_user == o.web_rtc_user &&
      primary_edge == o.primary_edge &&
      secondary_edge == o.secondary_edge &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
391
 
# File 'lib/purecloud/models/phone.rb', line 355

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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/purecloud/models/phone.rb', line 415

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



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

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


326
327
328
 
# File 'lib/purecloud/models/phone.rb', line 326

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



331
332
333
 
# File 'lib/purecloud/models/phone.rb', line 331

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, site, phone_base_settings, line_base_settings, phone_meta_base, lines, status, secondary_status, user_agent_info, properties, capabilities, web_rtc_user, primary_edge, secondary_edge, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



398
399
400
 
# File 'lib/purecloud/models/phone.rb', line 398

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



403
404
405
406
407
408
409
410
411
 
# File 'lib/purecloud/models/phone.rb', line 403

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 



393
394
395
 
# File 'lib/purecloud/models/phone.rb', line 393

def to_s
  to_hash.to_s
end