Class: Twilio::REST::Intelligence::V2::TranscriptInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/intelligence/v2/transcript.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ TranscriptInstance

Initialize the TranscriptInstance

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 Transcript resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 352

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'sid' => payload['sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'status' => payload['status'],
        'channel' => payload['channel'],
        'data_logging' => payload['data_logging'],
        'language_code' => payload['language_code'],
        'customer_key' => payload['customer_key'],
        'media_start_time' => Twilio.deserialize_iso8601_datetime(payload['media_start_time']),
        'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
        'url' => payload['url'],
        'redaction' => payload['redaction'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



392
393
394
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 392

def 
    @properties['account_sid']
end

#channel ⇒ Hash

Returns Media Channel describing Transcript Source and Participant Mapping.

Returns:

  • (Hash) —

    Media Channel describing Transcript Source and Participant Mapping



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

def channel
    @properties['channel']
end

#context ⇒ TranscriptContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



383
384
385
386
387
388
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 383

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

#customer_key ⇒ String

Returns:

  • (String) 


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

def customer_key
    @properties['customer_key']
end

#data_logging ⇒ Boolean

Returns Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.

Returns:

  • (Boolean) —

    Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models.



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

def data_logging
    @properties['data_logging']
end

#date_created ⇒ Time

Returns The date that this Transcript was created, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Transcript was created, given in ISO 8601 format.



410
411
412
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 410

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this Transcript was updated, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Transcript was updated, given in ISO 8601 format.



416
417
418
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 416

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



483
484
485
486
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 483

def delete

    context.delete
end

#duration ⇒ String

Returns The duration of this Transcript’s source.

Returns:

  • (String) —

    The duration of this Transcript’s source



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

def duration
    @properties['duration']
end

#fetch(redacted: :unset) ⇒ TranscriptInstance

Fetch the TranscriptInstance

Parameters:

  • redacted (Boolean) (defaults to: :unset) —

    Grant access to PII Redacted/Unredacted Transcript. The default is ‘true` to access redacted Transcript.

Returns:



492
493
494
495
496
497
498
499
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 492

def fetch(
    redacted: :unset
)

    context.fetch(
        redacted: redacted, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



531
532
533
534
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 531

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

#language_code ⇒ String

Returns The default language code of the audio.

Returns:

  • (String) —

    The default language code of the audio.



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

def language_code
    @properties['language_code']
end

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#media ⇒ media

Access the media

Returns:



518
519
520
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 518

def media
    context.media
end

#media_start_time ⇒ Time

Returns The date that this Transcript’s media was started, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Transcript’s media was started, given in ISO 8601 format.



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

def media_start_time
    @properties['media_start_time']
end

#operator_results ⇒ operator_results

Access the operator_results

Returns:



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

def operator_results
    context.operator_results
end

#redaction ⇒ Boolean

Returns If the transcript has been redacted, a redacted alternative of the transcript will be available.

Returns:

  • (Boolean) —

    If the transcript has been redacted, a redacted alternative of the transcript will be available.



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

def redaction
    @properties['redaction']
end

#sentences ⇒ sentences

Access the sentences

Returns:



504
505
506
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 504

def sentences
    context.sentences
end

#service_sid ⇒ String

Returns The unique SID identifier of the Service.

Returns:

  • (String) —

    The unique SID identifier of the Service.



398
399
400
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 398

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Transcript.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Transcript.



404
405
406
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 404

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



524
525
526
527
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 524

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
    @properties['url']
end