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.



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 337

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.



377
378
379
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 377

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



413
414
415
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 413

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:



368
369
370
371
372
373
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 368

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

#customer_key ⇒ String

Returns:

  • (String) 


431
432
433
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 431

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.



419
420
421
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 419

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.



395
396
397
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 395

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.



401
402
403
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 401

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#duration ⇒ String

Returns The duration of this Transcript’s source.

Returns:

  • (String) —

    The duration of this Transcript’s source



443
444
445
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 443

def duration
    @properties['duration']
end

#fetch ⇒ TranscriptInstance

Fetch the TranscriptInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



425
426
427
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 425

def language_code
    @properties['language_code']
end

#links ⇒ Hash

Returns:

  • (Hash) 


461
462
463
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 461

def links
    @properties['links']
end

#media ⇒ media

Access the media

Returns:



498
499
500
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 498

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.



437
438
439
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 437

def media_start_time
    @properties['media_start_time']
end

#operator_results ⇒ operator_results

Access the operator_results

Returns:



491
492
493
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 491

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.



455
456
457
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 455

def redaction
    @properties['redaction']
end

#sentences ⇒ sentences

Access the sentences

Returns:



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

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.



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

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.



389
390
391
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 389

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


407
408
409
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 407

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



449
450
451
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 449

def url
    @properties['url']
end