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](www.twilio.com/docs/iam/api/account) responsible for this transcription.

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

    The unique SID that identifies this Transcription



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

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



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

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The api_version.

Returns:

  • (String) —

    The api_version



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

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:



237
238
239
240
241
242
 
# File 'lib/twilio-ruby/rest/api/v2010/account/transcription.rb', line 237

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TranscriptionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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.



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

def duration
  @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch a TranscriptionInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

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



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

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



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

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



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

def sid
  @properties['sid']
end

#status ⇒ transcription.Status

Returns The status of the transcription.

Returns:

  • (transcription.Status) —

    The status of the transcription



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def transcription_text
  @properties['transcription_text']
end

#type ⇒ String

Returns The type.

Returns:

  • (String) —

    The type



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

def type
  @properties['type']
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



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

def uri
  @properties['uri']
end