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.



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 385

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.



428
429
430
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 428

def 
    @properties['account_sid']
end

#code ⇒ String

Returns Twilio error code.

Returns:

  • (String) —

    Twilio error code



470
471
472
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 470

def code
    @properties['code']
end

#configuration ⇒ VoiceV2ConfigurationTranscriptionConfiguration

Returns:

  • (VoiceV2ConfigurationTranscriptionConfiguration) 


458
459
460
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 458

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:



413
414
415
416
417
418
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 413

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

#date_created ⇒ Time

Returns:

  • (Time) 


446
447
448
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 446

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


452
453
454
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 452

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



489
490
491
492
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 489

def delete

    context.delete
end

#description ⇒ String

Returns The description.

Returns:

  • (String) —

    The description.



440
441
442
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 440

def description
    @properties['description']
end

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



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

def fetch

    context.fetch
end

#id ⇒ String

Returns Configuration Identifier.

Returns:

  • (String) —

    Configuration Identifier.



422
423
424
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 422

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



464
465
466
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 464

def message
    @properties['message']
end

#more_info ⇒ String

Returns More information about the error.

Returns:

  • (String) —

    More information about the error



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

def more_info
    @properties['more_info']
end

#status ⇒ String

Returns status code.

Returns:

  • (String) —

    status code



476
477
478
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 476

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



434
435
436
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 434

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:



506
507
508
509
510
511
512
 
# File 'lib/twilio-ruby/rest/voice/v2/transcription.rb', line 506

def update(voice_v2_configuration_transcription_request: :unset
)

    context.update(
        voice_v2_configuration_transcription_request: voice_v2_configuration_transcription_request, 
    )
end