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.



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

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:



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

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.



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

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:



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

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

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.



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

def duration
    @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch the TranscriptionInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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:



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

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:



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

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.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def transcription_text
    @properties['transcription_text']
end

#type ⇒ String

Returns The transcription type.

Returns:

  • (String) —

    The transcription type.



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

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`.



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

def uri
    @properties['uri']
end