Class: Bandwidth::CallRecordingMetadata

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CallRecordingMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 159

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The user account associated with the call.



22
23
24
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 22

def 
  @account_id
end

#application_id ⇒ Object

The id of the application associated with the call.



19
20
21
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 19

def application_id
  @application_id
end

#call_id ⇒ Object

The call id associated with the event.



25
26
27
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 25

def call_id
  @call_id
end

#channels ⇒ Object

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



51
52
53
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 51

def channels
  @channels
end

#direction ⇒ Object

Returns the value of attribute direction.



48
49
50
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 48

def direction
  @direction
end

#duration ⇒ Object

The duration of the recording in ISO-8601 format



46
47
48
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 46

def duration
  @duration
end

#end_time ⇒ Object

The time that the recording ended in ISO-8601 format



57
58
59
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 57

def end_time
  @end_time
end

#file_format ⇒ Object

Returns the value of attribute file_format.



59
60
61
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 59

def file_format
  @file_format
end

#from ⇒ Object

The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).



37
38
39
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 37

def from
  @from
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.



65
66
67
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 65

def media_url
  @media_url
end

#parent_call_id ⇒ Object

(optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present.



28
29
30
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 28

def parent_call_id
  @parent_call_id
end

#recording_id ⇒ Object

The unique ID of this recording



31
32
33
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 31

def recording_id
  @recording_id
end

#recording_name ⇒ Object

A name to identify this recording.



70
71
72
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 70

def recording_name
  @recording_name
end

#start_time ⇒ Object

Time the call was started, in ISO 8601 format.



54
55
56
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 54

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.



62
63
64
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 62

def status
  @status
end

#to ⇒ Object

The phone number that received the call, in E.164 format (e.g. +15555555555).



34
35
36
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 34

def to
  @to
end

#transcription ⇒ Object

Returns the value of attribute transcription.



67
68
69
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 67

def transcription
  @transcription
end

#transfer_caller_id ⇒ Object

The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).



40
41
42
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 40

def transfer_caller_id
  @transfer_caller_id
end

#transfer_to ⇒ Object

The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).



43
44
45
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 43

def transfer_to
  @transfer_to
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 329

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_any_of) || 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



120
121
122
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 120

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 95

def self.attribute_map
  {
    :'application_id' => :'applicationId',
    :'account_id' => :'accountId',
    :'call_id' => :'callId',
    :'parent_call_id' => :'parentCallId',
    :'recording_id' => :'recordingId',
    :'to' => :'to',
    :'from' => :'from',
    :'transfer_caller_id' => :'transferCallerId',
    :'transfer_to' => :'transferTo',
    :'duration' => :'duration',
    :'direction' => :'direction',
    :'channels' => :'channels',
    :'start_time' => :'startTime',
    :'end_time' => :'endTime',
    :'file_format' => :'fileFormat',
    :'status' => :'status',
    :'media_url' => :'mediaUrl',
    :'transcription' => :'transcription',
    :'recording_name' => :'recordingName'
  }
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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 305

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



150
151
152
153
154
155
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 150

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

.openapi_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 125

def self.openapi_types
  {
    :'application_id' => :'String',
    :'account_id' => :'String',
    :'call_id' => :'String',
    :'parent_call_id' => :'String',
    :'recording_id' => :'String',
    :'to' => :'String',
    :'from' => :'String',
    :'transfer_caller_id' => :'String',
    :'transfer_to' => :'String',
    :'duration' => :'String',
    :'direction' => :'CallDirectionEnum',
    :'channels' => :'Integer',
    :'start_time' => :'Time',
    :'end_time' => :'Time',
    :'file_format' => :'FileFormatEnum',
    :'status' => :'String',
    :'media_url' => :'String',
    :'transcription' => :'RecordingTranscriptionMetadata',
    :'recording_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      application_id == o.application_id &&
       == o. &&
      call_id == o.call_id &&
      parent_call_id == o.parent_call_id &&
      recording_id == o.recording_id &&
      to == o.to &&
      from == o.from &&
      transfer_caller_id == o.transfer_caller_id &&
      transfer_to == o.transfer_to &&
      duration == o.duration &&
      direction == o.direction &&
      channels == o.channels &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      file_format == o.file_format &&
      status == o.status &&
      media_url == o.media_url &&
      transcription == o.transcription &&
      recording_name == o.recording_name
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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 400

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


292
293
294
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



298
299
300
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 298

def hash
  [application_id, , call_id, parent_call_id, recording_id, to, from, transfer_caller_id, transfer_to, duration, direction, channels, start_time, end_time, file_format, status, media_url, transcription, recording_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



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

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



376
377
378
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 376

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 382

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



370
371
372
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 370

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



259
260
261
262
 
# File 'lib/bandwidth-sdk/models/call_recording_metadata.rb', line 259

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