Class: PureCloud::OrgMediaUtilization

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrgMediaUtilization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  
end

Instance Attribute Details

#include_non_acd ⇒ Object

If true, then track non-ACD conversations against utilization



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

def include_non_acd
  @include_non_acd
end

#interruptable_media_types ⇒ Object

Defines the list of other media types that can interrupt a conversation of this media type. Values can be: call, chat, email, or socialExpression



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

def interruptable_media_types
  @interruptable_media_types
end

#maximum_capacity ⇒ Object

Defines the maximum number of conversations of this type that an agent can handle at one time.



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

def maximum_capacity
  @maximum_capacity
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 31

def self.attribute_map
  {
    
    :'maximum_capacity' => :'maximumCapacity',
    
    :'interruptable_media_types' => :'interruptableMediaTypes',
    
    :'include_non_acd' => :'includeNonAcd'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 44

def self.swagger_types
  {
    
    :'maximum_capacity' => :'Integer',
    
    :'interruptable_media_types' => :'Array<String>',
    
    :'include_non_acd' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      maximum_capacity == o.maximum_capacity &&
      interruptable_media_types == o.interruptable_media_types &&
      include_non_acd == o.include_non_acd
end

#_deserialize(type, value) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 181

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 241

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 162

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


151
152
153
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 157

def hash
  [maximum_capacity, interruptable_media_types, include_non_acd].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



98
99
100
101
102
103
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 98

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



224
225
226
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 224

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



229
230
231
232
233
234
235
236
237
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 229

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 



219
220
221
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 219

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/purecloudclient_v2a/models/org_media_utilization.rb', line 107

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
end