Class: Twilio::REST::Voice::V3::TranscriptionInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/voice/v3/transcription.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, transcription_id: nil) ⇒ TranscriptionInstance

Initialize the TranscriptionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Transcription resource.

  • sid (String) —

    The SID of the Call resource to fetch.



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 435

def initialize(version, payload , transcription_id: nil)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    
    # Marshaled Properties
    @properties = { 
        'status' => payload['status'],
        'status_url' => payload['status_url'],
        'transcription' => payload['transcription'],
        'operation_id' => payload['operation_id'],
    }

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

Instance Method Details

#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:



457
458
459
460
461
462
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 457

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

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



491
492
493
494
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 491

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



505
506
507
508
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 505

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

#operation_id ⇒ String

Returns Unique identifier for the transcription operation.

Returns:

  • (String) —

    Unique identifier for the transcription operation.



484
485
486
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 484

def operation_id
    @properties['operation_id']
end

#status ⇒ String

Returns Current status of the long-running operation. PENDING: accepted but not yet started. RUNNING: currently in progress. COMPLETED: successfully completed. FAILED: failed and cannot be completed.

Returns:

  • (String) —

    Current status of the long-running operation. PENDING: accepted but not yet started. RUNNING: currently in progress. COMPLETED: successfully completed. FAILED: failed and cannot be completed.



466
467
468
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 466

def status
    @properties['status']
end

#status_url ⇒ String

Returns URI to poll for operation status. Mirrors the Location response header. Provided as a body field for programmatic access by JSON-parsing clients (RFC 9110 Section 15.3.3).

Returns:

  • (String) —

    URI to poll for operation status. Mirrors the Location response header. Provided as a body field for programmatic access by JSON-parsing clients (RFC 9110 Section 15.3.3).



472
473
474
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 472

def status_url
    @properties['status_url']
end

#to_s ⇒ Object

Provide a user friendly representation



498
499
500
501
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 498

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

#transcription ⇒ VoiceV3TranscriptionTranscription

Returns:

  • (VoiceV3TranscriptionTranscription) 


478
479
480
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 478

def transcription
    @properties['transcription']
end