Class: PureCloud::Wrapup

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Wrapup

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
105
106
 
# File 'lib/purecloudplatformclientv2/models/wrapup.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?(:'code')
    self.code = attributes[:'code']
  end

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

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

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

  if attributes.has_key?(:'durationSeconds')
    self.duration_seconds = attributes[:'durationSeconds']
  end

  if attributes.has_key?(:'endTime')
    self.end_time = attributes[:'endTime']
  end

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

end

Instance Attribute Details

#code ⇒ Object

The user configured wrap up code id.



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



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

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

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 122

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 



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
201
202
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 166

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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 226

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



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

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


136
137
138
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 136

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



142
143
144
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 142

def hash
  [code, name, notes, tags, duration_seconds, end_time, provisional].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



110
111
112
113
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 110

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



209
210
211
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 209

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



214
215
216
217
218
219
220
221
222
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 214

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 



204
205
206
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 204

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



117
118
 
# File 'lib/purecloudplatformclientv2/models/wrapup.rb', line 117

def valid?
end