Class: PureCloud::VoicemailOrganizationPolicy

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoicemailOrganizationPolicy

Returns a new instance of VoicemailOrganizationPolicy.



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
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 120

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[:'enabled']
    self.enabled = attributes[:'enabled']
  else
    self.enabled = false
  end
  
  if attributes[:'retentionTimeDays']
    self.retention_time_days = attributes[:'retentionTimeDays']
  end
  
  if attributes[:'alertTimeoutSeconds']
    self.alert_timeout_seconds = attributes[:'alertTimeoutSeconds']
  end
  
  if attributes[:'minimumRecordingTimeSeconds']
    self.minimum_recording_time_seconds = attributes[:'minimumRecordingTimeSeconds']
  end
  
  if attributes[:'maximumRecordingTimeSeconds']
    self.maximum_recording_time_seconds = attributes[:'maximumRecordingTimeSeconds']
  end
  
  if attributes[:'unavailableMessageUri']
    self.unavailable_message_uri = attributes[:'unavailableMessageUri']
  end
  
  if attributes[:'namePromptMessageUri']
    self.name_prompt_message_uri = attributes[:'namePromptMessageUri']
  end
  
  if attributes[:'fullMessageUri']
    self.full_message_uri = attributes[:'fullMessageUri']
  end
  
  if attributes[:'compressSilence']
    self.compress_silence = attributes[:'compressSilence']
  else
    self.compress_silence = false
  end
  
  if attributes[:'pinConfiguration']
    self.pin_configuration = attributes[:'pinConfiguration']
  end
  
  if attributes[:'quotaSizeBytes']
    self.quota_size_bytes = attributes[:'quotaSizeBytes']
  end
  
  if attributes[:'createdDate']
    self.created_date = attributes[:'createdDate']
  end
  
  if attributes[:'modifiedDate']
    self.modified_date = attributes[:'modifiedDate']
  end
  
  if attributes[:'voicemailExtension']
    self.voicemail_extension = attributes[:'voicemailExtension']
  end
  
  if attributes[:'pinRequired']
    self.pin_required = attributes[:'pinRequired']
  else
    self.pin_required = false
  end
  
  if attributes[:'sendEmailNotifications']
    self.send_email_notifications = attributes[:'sendEmailNotifications']
  else
    self.send_email_notifications = false
  end
  
end

Instance Attribute Details

#alert_timeout_seconds ⇒ Object

Returns the value of attribute alert_timeout_seconds.



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

def alert_timeout_seconds
  @alert_timeout_seconds
end

#compress_silence ⇒ Object

Returns the value of attribute compress_silence.



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

def compress_silence
  @compress_silence
end

#created_date ⇒ Object

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



44
45
46
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 44

def created_date
  @created_date
end

#enabled ⇒ Object

Returns the value of attribute enabled.



21
22
23
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 21

def enabled
  @enabled
end

#full_message_uri ⇒ Object

Returns the value of attribute full_message_uri.



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

def full_message_uri
  @full_message_uri
end

#maximum_recording_time_seconds ⇒ Object

Returns the value of attribute maximum_recording_time_seconds.



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

def maximum_recording_time_seconds
  @maximum_recording_time_seconds
end

#minimum_recording_time_seconds ⇒ Object

Returns the value of attribute minimum_recording_time_seconds.



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

def minimum_recording_time_seconds
  @minimum_recording_time_seconds
end

#modified_date ⇒ Object

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



47
48
49
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 47

def modified_date
  @modified_date
end

#name_prompt_message_uri ⇒ Object

Returns the value of attribute name_prompt_message_uri.



33
34
35
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 33

def name_prompt_message_uri
  @name_prompt_message_uri
end

#pin_configuration ⇒ Object

Returns the value of attribute pin_configuration.



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

def pin_configuration
  @pin_configuration
end

#pin_required ⇒ Object

If this is true, a PIN is required when accessing a user’s voicemail from a phone.



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

def pin_required
  @pin_required
end

#quota_size_bytes ⇒ Object

Returns the value of attribute quota_size_bytes.



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

def quota_size_bytes
  @quota_size_bytes
end

#retention_time_days ⇒ Object

Returns the value of attribute retention_time_days.



23
24
25
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 23

def retention_time_days
  @retention_time_days
end

#send_email_notifications ⇒ Object

Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting.



56
57
58
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 56

def send_email_notifications
  @send_email_notifications
end

#unavailable_message_uri ⇒ Object

Returns the value of attribute unavailable_message_uri.



31
32
33
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 31

def unavailable_message_uri
  @unavailable_message_uri
end

#voicemail_extension ⇒ Object

The extension for voicemail retrieval. The default value is *86.



50
51
52
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 50

def voicemail_extension
  @voicemail_extension
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
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
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 59

def self.attribute_map
  {
    
    :'enabled' => :'enabled',
    
    :'retention_time_days' => :'retentionTimeDays',
    
    :'alert_timeout_seconds' => :'alertTimeoutSeconds',
    
    :'minimum_recording_time_seconds' => :'minimumRecordingTimeSeconds',
    
    :'maximum_recording_time_seconds' => :'maximumRecordingTimeSeconds',
    
    :'unavailable_message_uri' => :'unavailableMessageUri',
    
    :'name_prompt_message_uri' => :'namePromptMessageUri',
    
    :'full_message_uri' => :'fullMessageUri',
    
    :'compress_silence' => :'compressSilence',
    
    :'pin_configuration' => :'pinConfiguration',
    
    :'quota_size_bytes' => :'quotaSizeBytes',
    
    :'created_date' => :'createdDate',
    
    :'modified_date' => :'modifiedDate',
    
    :'voicemail_extension' => :'voicemailExtension',
    
    :'pin_required' => :'pinRequired',
    
    :'send_email_notifications' => :'sendEmailNotifications'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 98

def self.swagger_types
  {
    :'enabled' => :'BOOLEAN',
    :'retention_time_days' => :'Integer',
    :'alert_timeout_seconds' => :'Integer',
    :'minimum_recording_time_seconds' => :'Integer',
    :'maximum_recording_time_seconds' => :'Integer',
    :'unavailable_message_uri' => :'String',
    :'name_prompt_message_uri' => :'String',
    :'full_message_uri' => :'String',
    :'compress_silence' => :'BOOLEAN',
    :'pin_configuration' => :'PINConfiguration',
    :'quota_size_bytes' => :'Integer',
    :'created_date' => :'DateTime',
    :'modified_date' => :'DateTime',
    :'voicemail_extension' => :'String',
    :'pin_required' => :'BOOLEAN',
    :'send_email_notifications' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enabled == o.enabled &&
      retention_time_days == o.retention_time_days &&
      alert_timeout_seconds == o.alert_timeout_seconds &&
      minimum_recording_time_seconds == o.minimum_recording_time_seconds &&
      maximum_recording_time_seconds == o.maximum_recording_time_seconds &&
      unavailable_message_uri == o.unavailable_message_uri &&
      name_prompt_message_uri == o.name_prompt_message_uri &&
      full_message_uri == o.full_message_uri &&
      compress_silence == o.compress_silence &&
      pin_configuration == o.pin_configuration &&
      quota_size_bytes == o.quota_size_bytes &&
      created_date == o.created_date &&
      modified_date == o.modified_date &&
      voicemail_extension == o.voicemail_extension &&
      pin_required == o.pin_required &&
      send_email_notifications == o.send_email_notifications
end

#_deserialize(type, value) ⇒ Object 



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
284
285
286
287
288
289
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 253

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 313

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 234

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


224
225
226
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



229
230
231
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 229

def hash
  [enabled, retention_time_days, alert_timeout_seconds, minimum_recording_time_seconds, maximum_recording_time_seconds, unavailable_message_uri, name_prompt_message_uri, full_message_uri, compress_silence, pin_configuration, quota_size_bytes, created_date, modified_date, voicemail_extension, pin_required, send_email_notifications].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



296
297
298
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 296

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



301
302
303
304
305
306
307
308
309
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 301

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 



291
292
293
 
# File 'lib/purecloud/models/voicemail_organization_policy.rb', line 291

def to_s
  to_hash.to_s
end