Class: Twilio::REST::Api::V2010::AccountContext::RecordingContext::TranscriptionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, recording_sid: nil, sid: nil) ⇒ TranscriptionInstance

Initialize the TranscriptionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Transcription resource.

  • recording_sid (String) (defaults to: nil) —

    The SID of the [Recording](www.twilio.com/docs/voice/api/recording) from which the transcription was created.

  • sid (String) (defaults to: nil) —

    The Twilio-provided string that uniquely identifies the Transcription resource to fetch.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 235

def initialize(version, payload, account_sid: nil, recording_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'api_version' => payload['api_version'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'duration' => payload['duration'],
      'price' => payload['price'].to_f,
      'price_unit' => payload['price_unit'],
      'recording_sid' => payload['recording_sid'],
      'sid' => payload['sid'],
      'status' => payload['status'],
      'transcription_text' => payload['transcription_text'],
      'type' => payload['type'],
      'uri' => payload['uri'],
  }

  # Context
  @instance_context = nil
  @params = {
      'account_sid' => ,
      'recording_sid' => recording_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



282
283
284
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 282

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to create the transcription.

Returns:

  • (String) —

    The API version used to create the transcription



288
289
290
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 288

def api_version
  @properties['api_version']
end

#context ⇒ TranscriptionContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 268

def context
  unless @instance_context
    @instance_context = TranscriptionContext.new(
        @version,
        @params['account_sid'],
        @params['recording_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was created



294
295
296
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 294

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was last updated



300
301
302
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 300

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TranscriptionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



368
369
370
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 368

def delete
  context.delete
end

#duration ⇒ String

Returns The duration of the transcribed audio in seconds.

Returns:

  • (String) —

    The duration of the transcribed audio in seconds.



306
307
308
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 306

def duration
  @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch a TranscriptionInstance

Returns:



361
362
363
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 361

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



381
382
383
384
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 381

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.TranscriptionInstance #{values}>"
end

#price ⇒ String

Returns The charge for the transcription.

Returns:

  • (String) —

    The charge for the transcription



312
313
314
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 312

def price
  @properties['price']
end

#price_unit ⇒ String

Returns The currency in which price is measured.

Returns:

  • (String) —

    The currency in which price is measured



318
319
320
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 318

def price_unit
  @properties['price_unit']
end

#recording_sid ⇒ String

Returns The SID that identifies the transcription’s recording.

Returns:

  • (String) —

    The SID that identifies the transcription’s recording



324
325
326
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 324

def recording_sid
  @properties['recording_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



330
331
332
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 330

def sid
  @properties['sid']
end

#status ⇒ transcription.Status

Returns The status of the transcription.

Returns:

  • (transcription.Status) —

    The status of the transcription



336
337
338
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 336

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



374
375
376
377
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 374

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.TranscriptionInstance #{values}>"
end

#transcription_text ⇒ String

Returns The text content of the transcription.

Returns:

  • (String) —

    The text content of the transcription.



342
343
344
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 342

def transcription_text
  @properties['transcription_text']
end

#type ⇒ String

Returns The transcription type.

Returns:

  • (String) —

    The transcription type



348
349
350
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 348

def type
  @properties['type']
end

#uri ⇒ String

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`



354
355
356
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 354

def uri
  @properties['uri']
end