Class: PureCloud::VoicemailUserPolicy

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoicemailUserPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 65

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

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

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

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

  
end

Instance Attribute Details

#alert_timeout_seconds ⇒ Object

The number of seconds to ring the user’s phone before a call is transfered to voicemail



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

def alert_timeout_seconds
  @alert_timeout_seconds
end

#enabled ⇒ Object

Whether the user has voicemail enabled



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

def enabled
  @enabled
end

#modified_date ⇒ Object

The date the policy was last modified. 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/voicemail_user_policy.rb', line 31

def modified_date
  @modified_date
end

#pin ⇒ Object

The user’s PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security



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

def pin
  @pin
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 34

def self.attribute_map
  {
    
    :'enabled' => :'enabled',
    
    :'alert_timeout_seconds' => :'alertTimeoutSeconds',
    
    :'pin' => :'pin',
    
    :'modified_date' => :'modifiedDate'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 49

def self.swagger_types
  {
    
    :'enabled' => :'BOOLEAN',
    
    :'alert_timeout_seconds' => :'Integer',
    
    :'pin' => :'String',
    
    :'modified_date' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enabled == o.enabled &&
      alert_timeout_seconds == o.alert_timeout_seconds &&
      pin == o.pin &&
      modified_date == o.modified_date
end

#_deserialize(type, value) ⇒ Object 



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

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 265

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 186

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


175
176
177
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 181

def hash
  [enabled, alert_timeout_seconds, pin, modified_date].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



112
113
114
115
116
117
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 112

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



248
249
250
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 248

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



253
254
255
256
257
258
259
260
261
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 253

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 



243
244
245
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 243

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/purecloudclient_v2a/models/voicemail_user_policy.rb', line 121

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end