Class: PureCloud::Callback

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Callback

Returns a new instance of Callback.



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
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/purecloud/models/callback.rb', line 97

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[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'segments']
    if (value = attributes[:'segments']).is_a?(Array)
      self.segments = value
    end
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'held']
    self.held = attributes[:'held']
  else
    self.held = false
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'startHoldTime']
    self.start_hold_time = attributes[:'startHoldTime']
  end
  
  if attributes[:'dialerPreview']
    self.dialer_preview = attributes[:'dialerPreview']
  end
  
  if attributes[:'callbackNumbers']
    if (value = attributes[:'callbackNumbers']).is_a?(Array)
      self.callback_numbers = value
    end
  end
  
  if attributes[:'callbackUserName']
    self.callback_user_name = attributes[:'callbackUserName']
  end
  
  if attributes[:'scriptId']
    self.script_id = attributes[:'scriptId']
  end
  
  if attributes[:'skipEnabled']
    self.skip_enabled = attributes[:'skipEnabled']
  else
    self.skip_enabled = false
  end
  
  if attributes[:'timeoutSeconds']
    self.timeout_seconds = attributes[:'timeoutSeconds']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
  if attributes[:'disconnectedTime']
    self.disconnected_time = attributes[:'disconnectedTime']
  end
  
end

Instance Attribute Details

#callback_numbers ⇒ Object

Returns the value of attribute callback_numbers.



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

def callback_numbers
  @callback_numbers
end

#callback_user_name ⇒ Object

Returns the value of attribute callback_user_name.



24
25
26
 
# File 'lib/purecloud/models/callback.rb', line 24

def callback_user_name
  @callback_user_name
end

#connected_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



33
34
35
 
# File 'lib/purecloud/models/callback.rb', line 33

def connected_time
  @connected_time
end

#dialer_preview ⇒ Object

Returns the value of attribute dialer_preview.



20
21
22
 
# File 'lib/purecloud/models/callback.rb', line 20

def dialer_preview
  @dialer_preview
end

#direction ⇒ Object

Returns the value of attribute direction.



11
12
13
 
# File 'lib/purecloud/models/callback.rb', line 11

def direction
  @direction
end

#disconnect_type ⇒ Object

Returns the value of attribute disconnect_type.



15
16
17
 
# File 'lib/purecloud/models/callback.rb', line 15

def disconnect_type
  @disconnect_type
end

#disconnected_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



36
37
38
 
# File 'lib/purecloud/models/callback.rb', line 36

def disconnected_time
  @disconnected_time
end

#held ⇒ Object

Returns the value of attribute held.



13
14
15
 
# File 'lib/purecloud/models/callback.rb', line 13

def held
  @held
end

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/purecloud/models/callback.rb', line 7

def id
  @id
end

#script_id ⇒ Object

Returns the value of attribute script_id.



26
27
28
 
# File 'lib/purecloud/models/callback.rb', line 26

def script_id
  @script_id
end

#segments ⇒ Object

Returns the value of attribute segments.



9
10
11
 
# File 'lib/purecloud/models/callback.rb', line 9

def segments
  @segments
end

#skip_enabled ⇒ Object

Returns the value of attribute skip_enabled.



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

def skip_enabled
  @skip_enabled
end

#start_hold_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



18
19
20
 
# File 'lib/purecloud/models/callback.rb', line 18

def start_hold_time
  @start_hold_time
end

#state ⇒ Object

Returns the value of attribute state.



5
6
7
 
# File 'lib/purecloud/models/callback.rb', line 5

def state
  @state
end

#timeout_seconds ⇒ Object

Returns the value of attribute timeout_seconds.



30
31
32
 
# File 'lib/purecloud/models/callback.rb', line 30

def timeout_seconds
  @timeout_seconds
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/purecloud/models/callback.rb', line 39

def self.attribute_map
  {
    
    :'state' => :'state',
    
    :'id' => :'id',
    
    :'segments' => :'segments',
    
    :'direction' => :'direction',
    
    :'held' => :'held',
    
    :'disconnect_type' => :'disconnectType',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'dialer_preview' => :'dialerPreview',
    
    :'callback_numbers' => :'callbackNumbers',
    
    :'callback_user_name' => :'callbackUserName',
    
    :'script_id' => :'scriptId',
    
    :'skip_enabled' => :'skipEnabled',
    
    :'timeout_seconds' => :'timeoutSeconds',
    
    :'connected_time' => :'connectedTime',
    
    :'disconnected_time' => :'disconnectedTime'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/purecloud/models/callback.rb', line 76

def self.swagger_types
  {
    :'state' => :'String',
    :'id' => :'String',
    :'segments' => :'Array<Segment>',
    :'direction' => :'String',
    :'held' => :'BOOLEAN',
    :'disconnect_type' => :'String',
    :'start_hold_time' => :'DateTime',
    :'dialer_preview' => :'DialerPreview',
    :'callback_numbers' => :'Array<String>',
    :'callback_user_name' => :'String',
    :'script_id' => :'String',
    :'skip_enabled' => :'BOOLEAN',
    :'timeout_seconds' => :'Integer',
    :'connected_time' => :'DateTime',
    :'disconnected_time' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/purecloud/models/callback.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      segments == o.segments &&
      direction == o.direction &&
      held == o.held &&
      disconnect_type == o.disconnect_type &&
      start_hold_time == o.start_hold_time &&
      dialer_preview == o.dialer_preview &&
      callback_numbers == o.callback_numbers &&
      callback_user_name == o.callback_user_name &&
      script_id == o.script_id &&
      skip_enabled == o.skip_enabled &&
      timeout_seconds == o.timeout_seconds &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time
end

#_deserialize(type, value) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/purecloud/models/callback.rb', line 252

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/purecloud/models/callback.rb', line 309

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/purecloud/models/callback.rb', line 233

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


223
224
225
 
# File 'lib/purecloud/models/callback.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



228
229
230
 
# File 'lib/purecloud/models/callback.rb', line 228

def hash
  [state, id, segments, direction, held, disconnect_type, start_hold_time, dialer_preview, callback_numbers, callback_user_name, script_id, skip_enabled, timeout_seconds, connected_time, disconnected_time].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



292
293
294
 
# File 'lib/purecloud/models/callback.rb', line 292

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



297
298
299
300
301
302
303
304
305
 
# File 'lib/purecloud/models/callback.rb', line 297

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 



287
288
289
 
# File 'lib/purecloud/models/callback.rb', line 287

def to_s
  to_hash.to_s
end