Class: Twilio::REST::Voice::V2::TranscriptionInstance

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

Instance Method Summary collapse

Constructor Details

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



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 444

def initialize(version, payload , id_or_unique_name: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'id' => payload['id'],
        'account_sid' => payload['account_sid'],
        'unique_name' => payload['unique_name'],
        'description' => payload['description'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'configuration' => payload['configuration'],
        'message' => payload['message'],
        'code' => payload['code'],
        'status' => payload['status'],
        'more_info' => payload['more_info'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns Account sid.

Returns:

  • (String) —

    Account sid.



487
488
489
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 487

def 
    @properties['account_sid']
end

#code ⇒ String

Returns Twilio error code.

Returns:

  • (String) —

    Twilio error code



529
530
531
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 529

def code
    @properties['code']
end

#configuration ⇒ VoiceV2ConfigurationTranscriptionConfiguration

Returns:

  • (VoiceV2ConfigurationTranscriptionConfiguration) 


517
518
519
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 517

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



472
473
474
475
476
477
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 472

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

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


511
512
513
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 511

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



548
549
550
551
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 548

def delete

    context.delete
end

#description ⇒ String

Returns The description.

Returns:

  • (String) —

    The description.



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

def description
    @properties['description']
end

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



556
557
558
559
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 556

def fetch

    context.fetch
end

#id ⇒ String

Returns Configuration Identifier.

Returns:

  • (String) —

    Configuration Identifier.



481
482
483
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 481

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#message ⇒ String

Returns Error message.

Returns:

  • (String) —

    Error message



523
524
525
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 523

def message
    @properties['message']
end

#more_info ⇒ String

Returns More information about the error.

Returns:

  • (String) —

    More information about the error



541
542
543
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 541

def more_info
    @properties['more_info']
end

#status ⇒ String

Returns status code.

Returns:

  • (String) —

    status code



535
536
537
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 535

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



575
576
577
578
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 575

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

#unique_name ⇒ String

Returns The unique name.

Returns:

  • (String) —

    The unique name.



493
494
495
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 493

def unique_name
    @properties['unique_name']
end

#update(voice_v2_configuration_transcription_request: :unset) ⇒ TranscriptionInstance

Update the TranscriptionInstance

Parameters:

  • voice_v2_configuration_transcription_request (VoiceV2ConfigurationTranscriptionRequest) (defaults to: :unset)

Returns:



565
566
567
568
569
570
571
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 565

def update(voice_v2_configuration_transcription_request: :unset
)

    context.update(
        voice_v2_configuration_transcription_request: voice_v2_configuration_transcription_request, 
    )
end