Class: UltracartClient::ConversationWebchatQueueStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/conversation_webchat_queue_status.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationWebchatQueueStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 92

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#agent_available_count ⇒ Object

Returns the value of attribute agent_available_count.



17
18
19
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 17

def agent_available_count
  @agent_available_count
end

#agent_busy_count ⇒ Object

Returns the value of attribute agent_busy_count.



19
20
21
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 19

def agent_busy_count
  @agent_busy_count
end

#agent_count ⇒ Object

Returns the value of attribute agent_count.



21
22
23
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 21

def agent_count
  @agent_count
end

#agent_unavailable_count ⇒ Object

Returns the value of attribute agent_unavailable_count.



23
24
25
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 23

def agent_unavailable_count
  @agent_unavailable_count
end

#agents ⇒ Object

Returns the value of attribute agents.



25
26
27
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 25

def agents
  @agents
end

#customer_abandon_count ⇒ Object

Returns the value of attribute customer_abandon_count.



27
28
29
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 27

def customer_abandon_count
  @customer_abandon_count
end

#customer_active_count ⇒ Object

Returns the value of attribute customer_active_count.



29
30
31
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 29

def customer_active_count
  @customer_active_count
end

#customer_average_abandon_time_seconds ⇒ Object

Returns the value of attribute customer_average_abandon_time_seconds.



31
32
33
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 31

def customer_average_abandon_time_seconds
  @customer_average_abandon_time_seconds
end

#customer_average_chat_time_seconds ⇒ Object

Returns the value of attribute customer_average_chat_time_seconds.



33
34
35
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 33

def customer_average_chat_time_seconds
  @customer_average_chat_time_seconds
end

#customer_average_hold_time_seconds ⇒ Object

Returns the value of attribute customer_average_hold_time_seconds.



35
36
37
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 35

def customer_average_hold_time_seconds
  @customer_average_hold_time_seconds
end

#customer_chat_count ⇒ Object

Returns the value of attribute customer_chat_count.



37
38
39
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 37

def customer_chat_count
  @customer_chat_count
end

#customer_waiting_count ⇒ Object

Returns the value of attribute customer_waiting_count.



39
40
41
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 39

def customer_waiting_count
  @customer_waiting_count
end

#customer_waiting_join_dts ⇒ Object

Date/time that the oldest person joined the queue



42
43
44
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 42

def customer_waiting_join_dts
  @customer_waiting_join_dts
end

#queue_entries ⇒ Object

Returns the value of attribute queue_entries.



44
45
46
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 44

def queue_entries
  @queue_entries
end

#queue_name ⇒ Object

Returns the value of attribute queue_name.



46
47
48
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 46

def queue_name
  @queue_name
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 49

def self.attribute_map
  {
    :'agent_available_count' => :'agent_available_count',
    :'agent_busy_count' => :'agent_busy_count',
    :'agent_count' => :'agent_count',
    :'agent_unavailable_count' => :'agent_unavailable_count',
    :'agents' => :'agents',
    :'customer_abandon_count' => :'customer_abandon_count',
    :'customer_active_count' => :'customer_active_count',
    :'customer_average_abandon_time_seconds' => :'customer_average_abandon_time_seconds',
    :'customer_average_chat_time_seconds' => :'customer_average_chat_time_seconds',
    :'customer_average_hold_time_seconds' => :'customer_average_hold_time_seconds',
    :'customer_chat_count' => :'customer_chat_count',
    :'customer_waiting_count' => :'customer_waiting_count',
    :'customer_waiting_join_dts' => :'customer_waiting_join_dts',
    :'queue_entries' => :'queue_entries',
    :'queue_name' => :'queue_name'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 70

def self.swagger_types
  {
    :'agent_available_count' => :'Integer',
    :'agent_busy_count' => :'Integer',
    :'agent_count' => :'Integer',
    :'agent_unavailable_count' => :'Integer',
    :'agents' => :'Array<ConversationWebchatQueueStatusAgent>',
    :'customer_abandon_count' => :'Integer',
    :'customer_active_count' => :'Integer',
    :'customer_average_abandon_time_seconds' => :'Integer',
    :'customer_average_chat_time_seconds' => :'Integer',
    :'customer_average_hold_time_seconds' => :'Integer',
    :'customer_chat_count' => :'Integer',
    :'customer_waiting_count' => :'Integer',
    :'customer_waiting_join_dts' => :'String',
    :'queue_entries' => :'Array<ConversationWebchatQueueStatusQueueEntry>',
    :'queue_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      agent_available_count == o.agent_available_count &&
      agent_busy_count == o.agent_busy_count &&
      agent_count == o.agent_count &&
      agent_unavailable_count == o.agent_unavailable_count &&
      agents == o.agents &&
      customer_abandon_count == o.customer_abandon_count &&
      customer_active_count == o.customer_active_count &&
      customer_average_abandon_time_seconds == o.customer_average_abandon_time_seconds &&
      customer_average_chat_time_seconds == o.customer_average_chat_time_seconds &&
      customer_average_hold_time_seconds == o.customer_average_hold_time_seconds &&
      customer_chat_count == o.customer_chat_count &&
      customer_waiting_count == o.customer_waiting_count &&
      customer_waiting_join_dts == o.customer_waiting_join_dts &&
      queue_entries == o.queue_entries &&
      queue_name == o.queue_name
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 234

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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 300

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 213

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



206
207
208
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 206

def hash
  [agent_available_count, agent_busy_count, agent_count, agent_unavailable_count, agents, customer_abandon_count, customer_active_count, customer_average_abandon_time_seconds, customer_average_chat_time_seconds, customer_average_hold_time_seconds, customer_chat_count, customer_waiting_count, customer_waiting_join_dts, queue_entries, queue_name].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



165
166
167
168
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 165

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



280
281
282
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 280

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



286
287
288
289
290
291
292
293
294
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 286

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



274
275
276
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 274

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



172
173
174
 
# File 'lib/ultracart_api/models/conversation_webchat_queue_status.rb', line 172

def valid?
  true
end