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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 204

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



242
243
244
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 242

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The api_version.

Returns:

  • (String) —

    The api_version



248
249
250
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 248

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:



233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 233

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TranscriptionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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.



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

def duration
  @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch a TranscriptionInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

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



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

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



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

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



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

def sid
  @properties['sid']
end

#status ⇒ transcription.Status

Returns The status of the transcription.

Returns:

  • (transcription.Status) —

    The status of the transcription



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def transcription_text
  @properties['transcription_text']
end

#type ⇒ String

Returns The type.

Returns:

  • (String) —

    The type



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

def type
  @properties['type']
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



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

def uri
  @properties['uri']
end