Class: Freeclimb::CreateConferenceWebhook

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

Overview

A Conference has been created and its statusCallbackUrl or actionUrl is being invoked. A PerCL response is expected if the actionUrl is being invoked.

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 = {}) ⇒ CreateConferenceWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 147

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::CreateConferenceWebhook` 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::CreateConferenceWebhook`. 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?(:call_id)
    self.call_id = attributes[:call_id]
  end

  if attributes.key?(:account_id)
    self. = attributes[:account_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?(:status)
    self.status = attributes[:status]
  end

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Account ID associated with your account.



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

def 
  @account_id
end

#call_id ⇒ Object

Unique ID for this Call, generated by FreeClimb.



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

def call_id
  @call_id
end

#call_status ⇒ Object

Returns the value of attribute call_status.



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

def call_status
  @call_status
end

#conference_id ⇒ Object

Unique ID of the Conference.



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

def conference_id
  @conference_id
end

#direction ⇒ Object

Returns the value of attribute direction.



41
42
43
 
# File 'lib/freeclimb/models/create_conference_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/create_conference_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/create_conference_webhook.rb', line 47

def queue_id
  @queue_id
end

#recording_duration_sec ⇒ Object

The duration of the recorded audio rounded up to the nearest second (in seconds). Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked.



58
59
60
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 58

def recording_duration_sec
  @recording_duration_sec
end

#recording_id ⇒ Object

The unique ID of the Recording from this Conference. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked.



55
56
57
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 55

def recording_id
  @recording_id
end

#recording_url ⇒ Object

The URL of the Conference’s recorded audio. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked.



52
53
54
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 52

def recording_url
  @recording_url
end

#request_type ⇒ Object

Context or reason why this request is being made. Will be createConference - A Conference has been created and its statusCallbackUrl or actionUrl is being invoked.



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

def request_type
  @request_type
end

#status ⇒ Object

Returns the value of attribute status.



49
50
51
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 49

def status
  @status
end

#to ⇒ Object

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



37
38
39
 
# File 'lib/freeclimb/models/create_conference_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)



102
103
104
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 102

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.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 83

def self.attribute_map
  {
    request_type: :requestType,
    call_id: :callId,
    account_id: :accountId,
    from: :from,
    to: :to,
    call_status: :callStatus,
    direction: :direction,
    conference_id: :conferenceId,
    queue_id: :queueId,
    status: :status,
    recording_url: :recordingUrl,
    recording_id: :recordingId,
    recording_duration_sec: :recordingDurationSec
  }
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



267
268
269
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 267

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/create_conference_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
  CreateConferenceWebhook.new(hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



139
140
141
142
143
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 139

def self.openapi_all_of
  [
    :Webhook
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 126

def self.openapi_nullable
  Set.new([
    :call_status,
    :direction,
    :queue_id,
    :status,
    :recording_url,
    :recording_id,
    :recording_duration_sec
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 107

def self.openapi_types
  {
    request_type: :String,
    call_id: :String,
    account_id: :String,
    from: :String,
    to: :String,
    call_status: :CallStatus,
    direction: :CallDirection,
    conference_id: :String,
    queue_id: :String,
    status: :ConferenceStatus,
    recording_url: :String,
    recording_id: :String,
    recording_duration_sec: :Integer
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    request_type == other.request_type &&
    call_id == other.call_id &&
     == other. &&
    from == other.from &&
    to == other.to &&
    call_status == other.call_status &&
    direction == other.direction &&
    conference_id == other.conference_id &&
    queue_id == other.queue_id &&
    status == other.status &&
    recording_url == other.recording_url &&
    recording_id == other.recording_id &&
    recording_duration_sec == other.recording_duration_sec && 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



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
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 298

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 369

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 274

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


254
255
256
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 254

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 260

def hash
  [request_type, call_id, , from, to, call_status, direction, conference_id, queue_id, status, recording_url, recording_id, recording_duration_sec].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



218
219
220
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 218

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



345
346
347
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 345

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 351

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



339
340
341
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 339

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



224
225
226
227
228
229
230
 
# File 'lib/freeclimb/models/create_conference_webhook.rb', line 224

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