class Bandwidth::CallRecordingMetadata

CallRecordingMetadata Model.

Attributes

account_id[RW]

TODO: Write general description for this method @return [String]

application_id[RW]

TODO: Write general description for this method @return [String]

call_id[RW]

TODO: Write general description for this method @return [String]

channels[RW]

Format is ISO-8601 @return [Integer]

direction[RW]

Format is ISO-8601 @return [DirectionEnum]

duration[RW]

Format is ISO-8601 @return [String]

end_time[RW]

Format is ISO-8601 @return [DateTime]

file_format[RW]

Format is ISO-8601 @return [FileFormatEnum]

from[RW]

TODO: Write general description for this method @return [String]

media_url[RW]

The current status of the recording. Current values are 'processing', 'partial', 'complete', 'deleted' and 'error'. Additional states may be added in the future, so your application must be tolerant of unknown values. @return [String]

parent_call_id[RW]

TODO: Write general description for this method @return [String]

recording_id[RW]

TODO: Write general description for this method @return [String]

start_time[RW]

Format is ISO-8601 @return [DateTime]

status[RW]

The current status of the recording. Current values are 'processing', 'partial', 'complete', 'deleted' and 'error'. Additional states may be added in the future, so your application must be tolerant of unknown values. @return [String]

to[RW]

TODO: Write general description for this method @return [String]

transcription[RW]

The current status of the recording. Current values are 'processing', 'partial', 'complete', 'deleted' and 'error'. Additional states may be added in the future, so your application must be tolerant of unknown values. @return [TranscriptionMetadata]

transfer_caller_id[RW]

TODO: Write general description for this method @return [String]

transfer_to[RW]

TODO: Write general description for this method @return [String]

Public Class Methods

from_hash(hash) click to toggle source

Creates an instance of the object from a hash.

# File lib/bandwidth/voice_lib/voice/models/call_recording_metadata.rb, line 154
def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  application_id = hash['applicationId']
  account_id = hash['accountId']
  call_id = hash['callId']
  parent_call_id = hash['parentCallId']
  recording_id = hash['recordingId']
  to = hash['to']
  from = hash['from']
  transfer_caller_id = hash['transferCallerId']
  transfer_to = hash['transferTo']
  duration = hash['duration']
  direction = hash['direction']
  channels = hash['channels']
  start_time = DateTimeHelper.from_rfc3339(hash['startTime']) if
    hash['startTime']
  end_time = DateTimeHelper.from_rfc3339(hash['endTime']) if
    hash['endTime']
  file_format = hash['fileFormat']
  status = hash['status']
  media_url = hash['mediaUrl']
  transcription = TranscriptionMetadata.from_hash(hash['transcription']) if
    hash['transcription']

  # Create object from extracted values.
  CallRecordingMetadata.new(application_id,
                            account_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)
end
names() click to toggle source

A mapping from model property names to API property names.

# File lib/bandwidth/voice_lib/voice/models/call_recording_metadata.rb, line 92
def self.names
  @_hash = {} if @_hash.nil?
  @_hash['application_id'] = 'applicationId'
  @_hash['account_id'] = 'accountId'
  @_hash['call_id'] = 'callId'
  @_hash['parent_call_id'] = 'parentCallId'
  @_hash['recording_id'] = 'recordingId'
  @_hash['to'] = 'to'
  @_hash['from'] = 'from'
  @_hash['transfer_caller_id'] = 'transferCallerId'
  @_hash['transfer_to'] = 'transferTo'
  @_hash['duration'] = 'duration'
  @_hash['direction'] = 'direction'
  @_hash['channels'] = 'channels'
  @_hash['start_time'] = 'startTime'
  @_hash['end_time'] = 'endTime'
  @_hash['file_format'] = 'fileFormat'
  @_hash['status'] = 'status'
  @_hash['media_url'] = 'mediaUrl'
  @_hash['transcription'] = 'transcription'
  @_hash
end
new(application_id = nil, account_id = nil, call_id = nil, parent_call_id = nil, recording_id = nil, to = nil, from = nil, transfer_caller_id = nil, transfer_to = nil, duration = nil, direction = nil, channels = nil, start_time = nil, end_time = nil, file_format = nil, status = nil, media_url = nil, transcription = nil) click to toggle source
# File lib/bandwidth/voice_lib/voice/models/call_recording_metadata.rb, line 115
def initialize(application_id = nil,
               account_id = nil,
               call_id = nil,
               parent_call_id = nil,
               recording_id = nil,
               to = nil,
               from = nil,
               transfer_caller_id = nil,
               transfer_to = nil,
               duration = nil,
               direction = nil,
               channels = nil,
               start_time = nil,
               end_time = nil,
               file_format = nil,
               status = nil,
               media_url = nil,
               transcription = nil)
  @application_id = application_id
  @account_id = account_id
  @call_id = call_id
  @parent_call_id = parent_call_id
  @recording_id = recording_id
  @to = to
  @from = from
  @transfer_caller_id = transfer_caller_id
  @transfer_to = transfer_to
  @duration = duration
  @direction = direction
  @channels = channels
  @start_time = start_time
  @end_time = end_time
  @file_format = file_format
  @status = status
  @media_url = media_url
  @transcription = transcription
end

Public Instance Methods

to_end_time() click to toggle source
# File lib/bandwidth/voice_lib/voice/models/call_recording_metadata.rb, line 205
def to_end_time
  DateTimeHelper.to_rfc3339(end_time)
end
to_start_time() click to toggle source
# File lib/bandwidth/voice_lib/voice/models/call_recording_metadata.rb, line 201
def to_start_time
  DateTimeHelper.to_rfc3339(start_time)
end