Class: PureCloud::CallForwarding

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CallForwarding

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 98

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#calls ⇒ Object

An ordered list of CallRoutes to be executed when CallForwarding is enabled



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

def calls
  @calls
end

#enabled ⇒ Object

Whether or not CallForwarding is enabled



29
30
31
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 29

def enabled
  @enabled
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#modified_date ⇒ Object

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



41
42
43
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 41

def modified_date
  @modified_date
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 24

def name
  @name
end

#phone_number ⇒ Object

This property is deprecated. Please use the calls property



32
33
34
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 32

def phone_number
  @phone_number
end

#self_uri ⇒ Object

The URI for this object



44
45
46
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 44

def self_uri
  @self_uri
end

#user ⇒ Object

Returns the value of attribute user.



26
27
28
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 26

def user
  @user
end

#voicemail ⇒ Object

The type of voicemail to use with the callForwarding configuration



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

def voicemail
  @voicemail
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 47

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'user' => :'user',
    
    :'enabled' => :'enabled',
    
    :'phone_number' => :'phoneNumber',
    
    :'calls' => :'calls',
    
    :'voicemail' => :'voicemail',
    
    :'modified_date' => :'modifiedDate',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 72

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'user' => :'User',
    
    :'enabled' => :'BOOLEAN',
    
    :'phone_number' => :'String',
    
    :'calls' => :'Array<CallRoute>',
    
    :'voicemail' => :'String',
    
    :'modified_date' => :'DateTime',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 303

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      user == o.user &&
      enabled == o.enabled &&
      phone_number == o.phone_number &&
      calls == o.calls &&
      voicemail == o.voicemail &&
      modified_date == o.modified_date &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



349
350
351
352
353
354
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
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 349

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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 409

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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 330

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


319
320
321
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 319

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



325
326
327
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 325

def hash
  [id, name, user, enabled, phone_number, calls, voicemail, modified_date, 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



192
193
194
195
196
197
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 192

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



392
393
394
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 392

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



397
398
399
400
401
402
403
404
405
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 397

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 



387
388
389
 
# File 'lib/purecloudclient_v2a/models/call_forwarding.rb', line 387

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["PURECLOUD", "LASTCALL", "NONE"]
  if @voicemail && !allowed_values.include?(@voicemail)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end