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 account_sid

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

    The recording_sid

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

    The sid



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb', line 214

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'].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' => ,
      'recording_sid' => recording_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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.

Returns:

  • (String) —

    The api_version



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:



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

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

Returns:

  • (Time) —

    The date_created



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

Returns:

  • (Time) —

    The date_updated



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

Deletes the TranscriptionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#duration ⇒ String

Returns The duration.

Returns:

  • (String) —

    The duration



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

def duration
  @properties['duration']
end

#fetch ⇒ TranscriptionInstance

Fetch a TranscriptionInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#price ⇒ String

Returns The price.

Returns:

  • (String) —

    The price



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

Returns:

  • (String) —

    The price_unit



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

Returns:

  • (String) —

    The recording_sid



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

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#status ⇒ transcription.Status

Returns The status.

Returns:

  • (transcription.Status) —

    The 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



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

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

#transcription_text ⇒ String

Returns The transcription_text.

Returns:

  • (String) —

    The transcription_text



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

Returns:

  • (String) —

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

Returns:

  • (String) —

    The uri



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

def uri
  @properties['uri']
end