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 that created this Transcription resource.

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

    The SID of the Call resource to fetch.



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 424

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'],
        '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  || @properties['recording_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:



463
464
465
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 463

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.



469
470
471
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 469

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:



454
455
456
457
458
459
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 454

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 date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



475
476
477
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 475

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



481
482
483
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 481

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



542
543
544
545
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 542

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.



487
488
489
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 487

def duration
    @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



550
551
552
553
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 550

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



564
565
566
567
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 564

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

#price ⇒ Float

Returns The charge for the transcript in the currency associated with the account. This value is populated after the transcript is complete so it may not be available immediately.

Returns:

  • (Float) —

    The charge for the transcript in the currency associated with the account. This value is populated after the transcript is complete so it may not be available immediately.



493
494
495
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 493

def price
    @properties['price']
end

#price_unit ⇒ String

Returns The currency in which ‘price` is measured, in [ISO 4127](www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`).

Returns:



499
500
501
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 499

def price_unit
    @properties['price_unit']
end

#recording_sid ⇒ String

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

Returns:



505
506
507
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 505

def recording_sid
    @properties['recording_sid']
end

#sid ⇒ String

Returns The unique string that that we created to identify the Transcription resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Transcription resource.



511
512
513
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 511

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


517
518
519
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 517

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



557
558
559
560
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 557

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.



523
524
525
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 523

def transcription_text
    @properties['transcription_text']
end

#type ⇒ String

Returns The transcription type.

Returns:

  • (String) —

    The transcription type.



529
530
531
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 529

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



535
536
537
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 535

def uri
    @properties['uri']
end