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.



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 546

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'],
        'id' => payload['id'],
        'account_id' => payload['account_id'],
        'transcription_configuration_id' => payload['transcription_configuration_id'],
        'media_url' => payload['media_url'],
        'source_id' => payload['source_id'],
        'audio_started_at' => Twilio.deserialize_iso8601_datetime(payload['audio_started_at']),
        'conversation_id' => payload['conversation_id'],
        'participants' => payload['participants'],
        'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
        'resolved_configuration' => payload['resolved_configuration'],
        'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
        'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_id ⇒ String

Returns Twilio Account SID.

Returns:

  • (String) —

    Twilio Account SID



621
622
623
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 621

def 
    @properties['account_id']
end

#audio_started_at ⇒ Time

Returns The call/recording start time. When the transcription was created using a sourceId, this value is inferred from the recording resource's start time. When created using a mediaUrl, this reflects the value supplied by the caller.

Returns:

  • (Time) —

    The call/recording start time. When the transcription was created using a sourceId, this value is inferred from the recording resource's start time. When created using a mediaUrl, this reflects the value supplied by the caller.



645
646
647
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 645

def audio_started_at
    @properties['audio_started_at']
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:



582
583
584
585
586
587
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 582

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

#conversation_id ⇒ String

Returns Maestro conversation ID, populated once the transcription has been stored in Maestro.

Returns:

  • (String) —

    Maestro conversation ID, populated once the transcription has been stored in Maestro.



651
652
653
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 651

def conversation_id
    @properties['conversation_id']
end

#created_at ⇒ Time

Returns When this transcript was created.

Returns:

  • (Time) —

    When this transcript was created



675
676
677
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 675

def created_at
    @properties['created_at']
end

#duration ⇒ String

Returns Audio duration in seconds.

Returns:

  • (String) —

    Audio duration in seconds



663
664
665
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 663

def duration
    @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



700
701
702
703
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 700

def fetch

    context.fetch
end

#id ⇒ String

Returns Unique identifier for a Transcription. This is also the transcriptionId returned in the LRO 202 response.

Returns:

  • (String) —

    Unique identifier for a Transcription. This is also the transcriptionId returned in the LRO 202 response.



615
616
617
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 615

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



714
715
716
717
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 714

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

#links ⇒ Hash

Returns Absolute URLs of resources related to this Transcription. Includes conversation, the Conversations API resource for this Transcription's conversationId, once the transcript has been stored. Omitted entirely when there is no related resource to link to.

Returns:

  • (Hash) —

    Absolute URLs of resources related to this Transcription. Includes conversation, the Conversations API resource for this Transcription's conversationId, once the transcript has been stored. Omitted entirely when there is no related resource to link to.



693
694
695
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 693

def links
    @properties['links']
end

#media_url ⇒ String

Returns The third party media URL.

Returns:

  • (String) —

    The third party media URL



633
634
635
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 633

def media_url
    @properties['media_url']
end

#operation_id ⇒ String

Returns Unique identifier for the transcription operation.

Returns:

  • (String) —

    Unique identifier for the transcription operation.



609
610
611
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 609

def operation_id
    @properties['operation_id']
end

#participants ⇒ Array<VoiceV3TranscriptionParticipant>

Returns Array of participants in the conversation.

Returns:

  • (Array<VoiceV3TranscriptionParticipant>) —

    Array of participants in the conversation



657
658
659
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 657

def participants
    @properties['participants']
end

#resolved_configuration ⇒ VoiceV3TranscriptionResolvedConfiguration

Returns:

  • (VoiceV3TranscriptionResolvedConfiguration) 


669
670
671
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 669

def resolved_configuration
    @properties['resolved_configuration']
end

#source_id ⇒ String

Returns The source ID (recording ID) - used for tracking only.

Returns:

  • (String) —

    The source ID (recording ID) - used for tracking only



639
640
641
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 639

def source_id
    @properties['source_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.



591
592
593
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 591

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



597
598
599
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 597

def status_url
    @properties['status_url']
end

#to_s ⇒ Object

Provide a user friendly representation



707
708
709
710
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 707

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

#transcription ⇒ VoiceV3TranscriptionTranscription

Returns:

  • (VoiceV3TranscriptionTranscription) 


603
604
605
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 603

def transcription
    @properties['transcription']
end

#transcription_configuration_id ⇒ String

Returns Unique identifier for a Transcription configuration.

Returns:

  • (String) —

    Unique identifier for a Transcription configuration.



627
628
629
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 627

def transcription_configuration_id
    @properties['transcription_configuration_id']
end

#updated_at ⇒ Time

Returns When this transcript was last updated.

Returns:

  • (Time) —

    When this transcript was last updated



681
682
683
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 681

def updated_at
    @properties['updated_at']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource



687
688
689
 
# File 'lib/twilio-ruby/rest/voice/v3/transcription.rb', line 687

def url
    @properties['url']
end