Class: Freeclimb::QueueWaitWebhook

Inherits:
Webhook
  • Object
show all
Defined in:
lib/freeclimb/models/queue_wait_webhook.rb

Overview

A queued Call is requesting instructions to execute during the wait in the Queue and the corresponding waitUrl is being invoked. A PerCL response is expected. The following are the only PerCL commands supported in the PerCL script response to a request to the waitUrl: Play,Say,Pause,GetDigits,Dequeue,Hangup

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Webhook

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ QueueWaitWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
203
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 140

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::QueueWaitWebhook` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if !self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::QueueWaitWebhook`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super

  if attributes.key?(:request_type)
    self.request_type = attributes[:request_type]
  end

  if attributes.key?(:account_id)
    self. = attributes[:account_id]
  end

  if attributes.key?(:call_id)
    self.call_id = attributes[:call_id]
  end

  if attributes.key?(:from)
    self.from = attributes[:from]
  end

  if attributes.key?(:to)
    self.to = attributes[:to]
  end

  if attributes.key?(:call_status)
    self.call_status = attributes[:call_status]
  end

  if attributes.key?(:direction)
    self.direction = attributes[:direction]
  end

  if attributes.key?(:conference_id)
    self.conference_id = attributes[:conference_id]
  end

  if attributes.key?(:queue_id)
    self.queue_id = attributes[:queue_id]
  end

  if attributes.key?(:queue_position)
    self.queue_position = attributes[:queue_position]
  end

  if attributes.key?(:queue_time)
    self.queue_time = attributes[:queue_time]
  end

  if attributes.key?(:current_queue_size)
    self.current_queue_size = attributes[:current_queue_size]
  end
end

Instance Attribute Details

#account_id ⇒ Object

Account ID associated with your account.



28
29
30
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 28

def 
  @account_id
end

#call_id ⇒ Object

Unique identifier for this Call, generated by FreeClimb



31
32
33
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 31

def call_id
  @call_id
end

#call_status ⇒ Object

Returns the value of attribute call_status.



39
40
41
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 39

def call_status
  @call_status
end

#conference_id ⇒ Object

This is only populated if request pertains to a conference. Otherwise, it is set to null.



44
45
46
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 44

def conference_id
  @conference_id
end

#current_queue_size ⇒ Object

Current number of enqueued Calls in this Queue.



56
57
58
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 56

def current_queue_size
  @current_queue_size
end

#direction ⇒ Object

Returns the value of attribute direction.



41
42
43
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 41

def direction
  @direction
end

#from ⇒ Object

Phone number of the party that initiated the Call (in E.164 format).



34
35
36
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 34

def from
  @from
end

#queue_id ⇒ Object

This is only populated if the request pertains to a queue. Otherwise, it is set to null.



47
48
49
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 47

def queue_id
  @queue_id
end

#queue_position ⇒ Object

Current queue position of the enqueued Call.



50
51
52
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 50

def queue_position
  @queue_position
end

#queue_time ⇒ Object

Time (in seconds) the Call spent in the Queue. This is only available if the Call was actually enqueued.



53
54
55
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 53

def queue_time
  @queue_time
end

#request_type ⇒ Object

Context or reason why this request is being made. Will be queueWait - A queued call is requesting instructions to execute during the wait in the queue and the corresponding waitUrl is being invoked.



25
26
27
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 25

def request_type
  @request_type
end

#to ⇒ Object

Phone number provisioned to the customer and to which this Call is directed (in E.164 format).



37
38
39
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 37

def to
  @to
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



99
100
101
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 99

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 81

def self.attribute_map
  {
    request_type: :requestType,
    account_id: :accountId,
    call_id: :callId,
    from: :from,
    to: :to,
    call_status: :callStatus,
    direction: :direction,
    conference_id: :conferenceId,
    queue_id: :queueId,
    queue_position: :queuePosition,
    queue_time: :queueTime,
    current_queue_size: :currentQueueSize
  }
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



255
256
257
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 255

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.deserialize(payload) ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 17

def self.deserialize(payload)
  return nil if payload.nil? || payload.empty?
  data = JSON.parse("[#{payload}]")[0]
  inverted_attributes = attribute_map.invert
  hash = acceptable_attributes.uniq.map { |k| [inverted_attributes[k], data[k.to_s]] }.to_h
  QueueWaitWebhook.new(hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



132
133
134
135
136
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 132

def self.openapi_all_of
  [
    :Webhook
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
127
128
129
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 122

def self.openapi_nullable
  Set.new([
    :call_status,
    :direction,
    :conference_id,
    :queue_id
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 104

def self.openapi_types
  {
    request_type: :String,
    account_id: :String,
    call_id: :String,
    from: :String,
    to: :String,
    call_status: :CallStatus,
    direction: :CallDirection,
    conference_id: :String,
    queue_id: :String,
    queue_position: :String,
    queue_time: :Integer,
    current_queue_size: :Integer
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 223

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    request_type == other.request_type &&
     == other. &&
    call_id == other.call_id &&
    from == other.from &&
    to == other.to &&
    call_status == other.call_status &&
    direction == other.direction &&
    conference_id == other.conference_id &&
    queue_id == other.queue_id &&
    queue_position == other.queue_position &&
    queue_time == other.queue_time &&
    current_queue_size == other.current_queue_size && super
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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 286

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Freeclimb.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 357

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 262

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send(:"#{key}=", nil)
    elsif 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)
        send(:"#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send(:"#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


242
243
244
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 242

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 248

def hash
  [request_type, , call_id, from, to, call_status, direction, conference_id, queue_id, queue_position, queue_time, current_queue_size].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



207
208
209
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 207

def list_invalid_properties
  super
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



333
334
335
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 333

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 339

def to_hash
  hash = super
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



327
328
329
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 327

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



213
214
215
216
217
218
219
 
# File 'lib/freeclimb/models/queue_wait_webhook.rb', line 213

def valid?
  if @request_type.nil?
    false
  else
    list_invalid_properties.length == 0
  end
end