Class: PureCloud::PhoneStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/phone_status.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PhoneStatus

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
 
# File 'lib/purecloudplatformclientv2/models/phone_status.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?(:'operationalStatus')
    self.operational_status = attributes[:'operationalStatus']
  end

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

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

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

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

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

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

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

end

Instance Attribute Details

#edge ⇒ Object

The URI of the edge that provided this status information.



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 45

def edge
  @edge
end

#edges_status ⇒ Object

The status of the primary or secondary Edges assigned to the phone lines.



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 30

def edges_status
  @edges_status
end

#event_creation_time ⇒ Object

Event Creation Time represents an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 33

def event_creation_time
  @event_creation_time
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 22

def id
  @id
end

#line_statuses ⇒ Object

A list of LineStatus information for each of the lines of this phone



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 39

def line_statuses
  @line_statuses
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 24

def name
  @name
end

#operational_status ⇒ Object

The Operational Status of this phone



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 27

def operational_status
  @operational_status
end

#phone_assignment_to_edge_type ⇒ Object

The phone status’s edge assignment type.



42
43
44
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 42

def phone_assignment_to_edge_type
  @phone_assignment_to_edge_type
end

#provision ⇒ Object

Provision information for this phone



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 36

def provision
  @provision
end

#self_uri ⇒ Object

The URI for this object



48
49
50
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 48

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 51

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'operational_status' => :'operationalStatus',
    :'edges_status' => :'edgesStatus',
    :'event_creation_time' => :'eventCreationTime',
    :'provision' => :'provision',
    :'line_statuses' => :'lineStatuses',
    :'phone_assignment_to_edge_type' => :'phoneAssignmentToEdgeType',
    :'edge' => :'edge',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 67

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'operational_status' => :'String',
    :'edges_status' => :'String',
    :'event_creation_time' => :'String',
    :'provision' => :'ProvisionInfo',
    :'line_statuses' => :'Array<LineStatus>',
    :'phone_assignment_to_edge_type' => :'String',
    :'edge' => :'UriReference',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      operational_status == o.operational_status &&
      edges_status == o.edges_status &&
      event_creation_time == o.event_creation_time &&
      provision == o.provision &&
      line_statuses == o.line_statuses &&
      phone_assignment_to_edge_type == o.phone_assignment_to_edge_type &&
      edge == o.edge &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 237

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 297

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 218

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


207
208
209
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 213

def hash
  [id, name, operational_status, edges_status, event_creation_time, provision, line_statuses, phone_assignment_to_edge_type, edge, self_uri].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



136
137
138
139
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 136

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



280
281
282
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 280

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



285
286
287
288
289
290
291
292
293
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 285

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 



275
276
277
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 275

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/purecloudplatformclientv2/models/phone_status.rb', line 143

def valid?
  allowed_values = ["OPERATIONAL", "DEGRADED", "OFFLINE"]
  if @operational_status && !allowed_values.include?(@operational_status)
    return false
  end
  allowed_values = ["IN_SERVICE", "MIXED_SERVICE", "OUT_OF_SERVICE", "NO_EDGES"]
  if @edges_status && !allowed_values.include?(@edges_status)
    return false
  end
  allowed_values = ["PRIMARY", "SECONDARY"]
  if @phone_assignment_to_edge_type && !allowed_values.include?(@phone_assignment_to_edge_type)
    return false
  end
end