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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_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 unique id of the Account responsible for this transcription.

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

    The transcription Sid that uniquely identifies this resource



220
221
222
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/transcription.rb', line 220

def initialize(version, payload, account_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'].to_f,
      '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' => ,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique sid that identifies this account.

Returns:

  • (String) —

    The unique sid that identifies this account



265
266
267
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 265

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The api_version.

Returns:

  • (String) —

    The api_version



271
272
273
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 271

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
258
259
260
261
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 252

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

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



277
278
279
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 277

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



283
284
285
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 283

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TranscriptionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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.



289
290
291
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 289

def duration
  @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch a TranscriptionInstance

Returns:



344
345
346
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 344

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#price ⇒ String

Returns The charge for this transcription.

Returns:

  • (String) —

    The charge for this transcription



295
296
297
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 295

def price
  @properties['price']
end

#price_unit ⇒ String

Returns The currency in which Price is measured.

Returns:

  • (String) —

    The currency in which Price is measured



301
302
303
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 301

def price_unit
  @properties['price_unit']
end

#recording_sid ⇒ String

Returns The string that uniquely identifies the recording.

Returns:

  • (String) —

    The string that uniquely identifies the recording



307
308
309
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 307

def recording_sid
  @properties['recording_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this transcription.

Returns:

  • (String) —

    A string that uniquely identifies this transcription



313
314
315
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 313

def sid
  @properties['sid']
end

#status ⇒ transcription.Status

Returns The status of the transcription.

Returns:

  • (transcription.Status) —

    The status of the transcription



319
320
321
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 319

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



325
326
327
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 325

def transcription_text
  @properties['transcription_text']
end

#type ⇒ String

Returns The type.

Returns:

  • (String) —

    The type



331
332
333
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 331

def type
  @properties['type']
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



337
338
339
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 337

def uri
  @properties['uri']
end