Class: Bandwidth::ConferenceRecordingAvailableCallback

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/conference_recording_available_callback.rb

Overview

The Conference Recording Available event is sent after a conference recording has been processed. It indicates that the recording is available for download.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConferenceRecordingAvailableCallback

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 137

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::ConferenceRecordingAvailableCallback` 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 `Bandwidth::ConferenceRecordingAvailableCallback`. 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
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The user account associated with the call.



32
33
34
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 32

def 
  @account_id
end

#channels ⇒ Object

Always ‘1` for conference recordings; multi-channel recordings are not supported on conferences.



38
39
40
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 38

def channels
  @channels
end

#conference_id ⇒ Object

The unique, Bandwidth-generated ID of the conference that was recorded



26
27
28
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 26

def conference_id
  @conference_id
end

#duration ⇒ Object

The duration of the recording in ISO-8601 format



47
48
49
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 47

def duration
  @duration
end

#end_time ⇒ Object

The time that the recording ended in ISO-8601 format



44
45
46
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 44

def end_time
  @end_time
end

#event_time ⇒ Object

The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.



23
24
25
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 23

def event_time
  @event_time
end

#event_type ⇒ Object

The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.



20
21
22
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 20

def event_type
  @event_type
end

#file_format ⇒ Object

Returns the value of attribute file_format.



49
50
51
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 49

def file_format
  @file_format
end

#media_url ⇒ Object

The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.



52
53
54
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 52

def media_url
  @media_url
end

#name ⇒ Object

The user-specified name of the conference that was recorded



29
30
31
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 29

def name
  @name
end

#recording_id ⇒ Object

The unique ID of this recording



35
36
37
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 35

def recording_id
  @recording_id
end

#start_time ⇒ Object

Time the call was started, in ISO 8601 format.



41
42
43
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 41

def start_time
  @start_time
end

#status ⇒ Object

The current status of the process. For recording, current possible values are ‘processing’, ‘partial’, ‘complete’, ‘deleted’, and ‘error’. For transcriptions, current possible values are ‘none’, ‘processing’, ‘available’, ‘error’, ‘timeout’, ‘file-size-too-big’, and ‘file-size-too-small’. Additional states may be added in the future, so your application must be tolerant of unknown values.



58
59
60
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 58

def status
  @status
end

#tag ⇒ Object

(optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.



55
56
57
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 55

def tag
  @tag
end

Class Method Details

._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



282
283
284
285
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
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 282

def self._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 = Bandwidth.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 103

def self.acceptable_attributes
  attribute_map.values
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
100
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 83

def self.attribute_map
  {
    :'event_type' => :'eventType',
    :'event_time' => :'eventTime',
    :'conference_id' => :'conferenceId',
    :'name' => :'name',
    :'account_id' => :'accountId',
    :'recording_id' => :'recordingId',
    :'channels' => :'channels',
    :'start_time' => :'startTime',
    :'end_time' => :'endTime',
    :'duration' => :'duration',
    :'file_format' => :'fileFormat',
    :'media_url' => :'mediaUrl',
    :'tag' => :'tag',
    :'status' => :'status'
  }
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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 258

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
132
133
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 128

def self.openapi_nullable
  Set.new([
    :'media_url',
    :'tag',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 108

def self.openapi_types
  {
    :'event_type' => :'String',
    :'event_time' => :'Time',
    :'conference_id' => :'String',
    :'name' => :'String',
    :'account_id' => :'String',
    :'recording_id' => :'String',
    :'channels' => :'Integer',
    :'start_time' => :'Time',
    :'end_time' => :'Time',
    :'duration' => :'String',
    :'file_format' => :'FileFormatEnum',
    :'media_url' => :'String',
    :'tag' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_type == o.event_type &&
      event_time == o.event_time &&
      conference_id == o.conference_id &&
      name == o.name &&
       == o. &&
      recording_id == o.recording_id &&
      channels == o.channels &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      duration == o.duration &&
      file_format == o.file_format &&
      media_url == o.media_url &&
      tag == o.tag &&
      status == o.status
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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 353

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 251

def hash
  [event_type, event_time, conference_id, name, , recording_id, channels, start_time, end_time, duration, file_format, media_url, tag, status].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



209
210
211
212
213
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 209

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



329
330
331
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 329

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 335

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



323
324
325
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 323

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



217
218
219
220
 
# File 'lib/bandwidth-sdk/models/conference_recording_available_callback.rb', line 217

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end