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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_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.



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 412

def initialize(version, payload , account_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' =>   ,'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:



451
452
453
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 451

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.



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

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:



442
443
444
445
446
447
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 442

def context
    unless @instance_context
        @instance_context = TranscriptionContext.new(@version , @params['account_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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

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.



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

def duration
    @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



538
539
540
541
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 538

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



552
553
554
555
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 552

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.



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

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:



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

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:



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

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.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



545
546
547
548
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 545

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.



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

def transcription_text
    @properties['transcription_text']
end

#type ⇒ String

Returns The transcription type. Can only be: fast.

Returns:

  • (String) —

    The transcription type. Can only be: fast.



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

def type
    @properties['type']
end

#uri ⇒ String

Returns The URI of the resource, relative to https://api.twilio.com.

Returns:

  • (String) —

    The URI of the resource, relative to https://api.twilio.com.



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

def uri
    @properties['uri']
end