Class: PureCloud::Wrapup

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Wrapup

Returns a new instance of Wrapup.



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
109
110
111
112
113
114
 
# File 'lib/purecloud/models/wrapup.rb', line 77

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[:'code']
    self.code = attributes[:'code']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'notes']
    self.notes = attributes[:'notes']
  end
  
  if attributes[:'tags']
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end
  
  if attributes[:'durationSeconds']
    self.duration_seconds = attributes[:'durationSeconds']
  end
  
  if attributes[:'endTime']
    self.end_time = attributes[:'endTime']
  end
  
  if attributes[:'provisional']
    self.provisional = attributes[:'provisional']
  end
  
end

Instance Attribute Details

#code ⇒ Object

The user configured wrap up code id.



22
23
24
 
# File 'lib/purecloud/models/wrapup.rb', line 22

def code
  @code
end

#duration_seconds ⇒ Object

The length of time in seconds that the agent spent doing after call work.



34
35
36
 
# File 'lib/purecloud/models/wrapup.rb', line 34

def duration_seconds
  @duration_seconds
end

#end_time ⇒ Object

The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def end_time
  @end_time
end

#name ⇒ Object

The user configured wrap up code name.



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

def name
  @name
end

#notes ⇒ Object

Text entered by the agent to describe the call or disposition.



28
29
30
 
# File 'lib/purecloud/models/wrapup.rb', line 28

def notes
  @notes
end

#provisional ⇒ Object

Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later.



40
41
42
 
# File 'lib/purecloud/models/wrapup.rb', line 40

def provisional
  @provisional
end

#tags ⇒ Object

List of tags selected by the agent to describe the call or disposition.



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

def tags
  @tags
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
54
55
56
57
58
59
60
61
 
# File 'lib/purecloud/models/wrapup.rb', line 43

def self.attribute_map
  {
    
    :'code' => :'code',
    
    :'name' => :'name',
    
    :'notes' => :'notes',
    
    :'tags' => :'tags',
    
    :'duration_seconds' => :'durationSeconds',
    
    :'end_time' => :'endTime',
    
    :'provisional' => :'provisional'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/purecloud/models/wrapup.rb', line 64

def self.swagger_types
  {
    :'code' => :'String',
    :'name' => :'String',
    :'notes' => :'String',
    :'tags' => :'Array<String>',
    :'duration_seconds' => :'Integer',
    :'end_time' => :'DateTime',
    :'provisional' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/purecloud/models/wrapup.rb', line 117

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      name == o.name &&
      notes == o.notes &&
      tags == o.tags &&
      duration_seconds == o.duration_seconds &&
      end_time == o.end_time &&
      provisional == o.provisional
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/wrapup.rb', line 159

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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/purecloud/models/wrapup.rb', line 219

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/purecloud/models/wrapup.rb', line 140

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


130
131
132
 
# File 'lib/purecloud/models/wrapup.rb', line 130

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



135
136
137
 
# File 'lib/purecloud/models/wrapup.rb', line 135

def hash
  [code, name, notes, tags, duration_seconds, end_time, provisional].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



202
203
204
 
# File 'lib/purecloud/models/wrapup.rb', line 202

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



207
208
209
210
211
212
213
214
215
 
# File 'lib/purecloud/models/wrapup.rb', line 207

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 



197
198
199
 
# File 'lib/purecloud/models/wrapup.rb', line 197

def to_s
  to_hash.to_s
end