Class: PureCloud::VoicemailOrganizationPolicy

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoicemailOrganizationPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

end

Instance Attribute Details

#alert_timeout_seconds ⇒ Object

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



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

def alert_timeout_seconds
  @alert_timeout_seconds
end

#enabled ⇒ Object

Whether voicemail is enable for this organization



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_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



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 40

def modified_date
  @modified_date
end

#pin_configuration ⇒ Object

The configuration for user PINs to access their voicemail from a phone



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 28

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.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 34

def pin_required
  @pin_required
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.



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

def send_email_notifications
  @send_email_notifications
end

#voicemail_extension ⇒ Object

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



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

def voicemail_extension
  @voicemail_extension
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 43

def self.attribute_map
  {
    :'enabled' => :'enabled',
    :'alert_timeout_seconds' => :'alertTimeoutSeconds',
    :'pin_configuration' => :'pinConfiguration',
    :'voicemail_extension' => :'voicemailExtension',
    :'pin_required' => :'pinRequired',
    :'send_email_notifications' => :'sendEmailNotifications',
    :'modified_date' => :'modifiedDate'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 56

def self.swagger_types
  {
    :'enabled' => :'BOOLEAN',
    :'alert_timeout_seconds' => :'Integer',
    :'pin_configuration' => :'PINConfiguration',
    :'voicemail_extension' => :'String',
    :'pin_required' => :'BOOLEAN',
    :'send_email_notifications' => :'BOOLEAN',
    :'modified_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 120

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enabled == o.enabled &&
      alert_timeout_seconds == o.alert_timeout_seconds &&
      pin_configuration == o.pin_configuration &&
      voicemail_extension == o.voicemail_extension &&
      pin_required == o.pin_required &&
      send_email_notifications == o.send_email_notifications &&
      modified_date == o.modified_date
end

#_deserialize(type, value) ⇒ Object 



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
200
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 164

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



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 224

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 145

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


134
135
136
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 134

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



140
141
142
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 140

def hash
  [enabled, alert_timeout_seconds, pin_configuration, voicemail_extension, pin_required, send_email_notifications, 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



108
109
110
111
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 108

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



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

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



212
213
214
215
216
217
218
219
220
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 212

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 



202
203
204
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 202

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



115
116
 
# File 'lib/purecloudplatformclientv2/models/voicemail_organization_policy.rb', line 115

def valid?
end