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.



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

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:



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

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.



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

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:



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

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

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.



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

def duration
    @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



560
561
562
563
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 560

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.



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

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:



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

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:



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

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.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

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



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

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



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

def uri
    @properties['uri']
end