Class: PureCloud::AcwSettings

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AcwSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 51

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

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

  
end

Instance Attribute Details

#timeout_ms ⇒ Object

The amount of time the agent can stay in ACW (Min: 1 sec, Max: 1 day). Can only be used when ACW is MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT.



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

def timeout_ms
  @timeout_ms
end

#wrapup_prompt ⇒ Object

This field controls how the UI prompts the agent for a wrapup.



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

def wrapup_prompt
  @wrapup_prompt
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 28

def self.attribute_map
  {
    
    :'wrapup_prompt' => :'wrapupPrompt',
    
    :'timeout_ms' => :'timeoutMs'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 39

def self.swagger_types
  {
    
    :'wrapup_prompt' => :'String',
    
    :'timeout_ms' => :'Integer'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      wrapup_prompt == o.wrapup_prompt &&
      timeout_ms == o.timeout_ms
end

#_deserialize(type, value) ⇒ Object 



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

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



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 227

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 148

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


137
138
139
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 137

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 143

def hash
  [wrapup_prompt, timeout_ms].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



80
81
82
83
84
85
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 80

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



210
211
212
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 210

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



215
216
217
218
219
220
221
222
223
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 215

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 



205
206
207
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 205

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/purecloudclient_v2a/models/acw_settings.rb', line 89

def valid?
  
  
  
  allowed_values = ["MANDATORY", "OPTIONAL", "MANDATORY_TIMEOUT", "MANDATORY_FORCED_TIMEOUT"]
  if @wrapup_prompt && !allowed_values.include?(@wrapup_prompt)
    return false
  end
  
  
  
  
  
  
  
end