Class: Twilio::REST::Api::V2010::AccountContext::RecordingContext::TranscriptionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, recording_sid: nil, sid: nil) ⇒ TranscriptionInstance

Initialize the TranscriptionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Account that created this Transcription resource.

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

    The SID of the Call resource to fetch.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 224

def initialize(version, payload , account_sid: nil, recording_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'api_version' => payload['api_version'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'duration' => payload['duration'],
        'price' => payload['price'],
        'price_unit' => payload['price_unit'],
        'recording_sid' => payload['recording_sid'],
        'sid' => payload['sid'],
        'status' => payload['status'],
        'transcription_text' => payload['transcription_text'],
        'type' => payload['type'],
        'uri' => payload['uri'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Transcription resource.

Returns:



262
263
264
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 262

def 
    @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to create the transcription.

Returns:

  • (String) —

    The API version used to create the transcription.



268
269
270
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 268

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



253
254
255
256
257
258
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 253

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

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



274
275
276
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 274

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



280
281
282
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 280

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



341
342
343
344
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 341

def delete

    context.delete
end

#duration ⇒ String

Returns The duration of the transcribed audio in seconds.

Returns:

  • (String) —

    The duration of the transcribed audio in seconds.



286
287
288
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 286

def duration
    @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



349
350
351
352
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 349

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



363
364
365
366
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 363

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

#price ⇒ Float

Returns The charge for the transcript in the currency associated with the account. This value is populated after the transcript is complete so it may not be available immediately.

Returns:

  • (Float) —

    The charge for the transcript in the currency associated with the account. This value is populated after the transcript is complete so it may not be available immediately.



292
293
294
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 292

def price
    @properties['price']
end

#price_unit ⇒ String

Returns The currency in which ‘price` is measured, in [ISO 4127](www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`).

Returns:



298
299
300
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 298

def price_unit
    @properties['price_unit']
end

#recording_sid ⇒ String

Returns The SID of the [Recording](www.twilio.com/docs/voice/api/recording) from which the transcription was created.

Returns:



304
305
306
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 304

def recording_sid
    @properties['recording_sid']
end

#sid ⇒ String

Returns The unique string that that we created to identify the Transcription resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Transcription resource.



310
311
312
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 310

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


316
317
318
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 316

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



356
357
358
359
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 356

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

#transcription_text ⇒ String

Returns The text content of the transcription.

Returns:

  • (String) —

    The text content of the transcription.



322
323
324
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 322

def transcription_text
    @properties['transcription_text']
end

#type ⇒ String

Returns The transcription type.

Returns:

  • (String) —

    The transcription type.



328
329
330
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 328

def type
    @properties['type']
end

#uri ⇒ String

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`.



334
335
336
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 334

def uri
    @properties['uri']
end