Class: Twilio::REST::Api::V2010::AccountContext::RecordingInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ RecordingInstance

Initialize the RecordingInstance

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 Recording resource.

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

    The SID of the Call resource to fetch.



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 307

def initialize(version, payload , account_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'api_version' => payload['api_version'],
        'call_sid' => payload['call_sid'],
        'conference_sid' => payload['conference_sid'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
        'duration' => payload['duration'],
        'sid' => payload['sid'],
        'price' => payload['price'],
        'price_unit' => payload['price_unit'],
        'status' => payload['status'],
        'channels' => payload['channels'] == nil ? payload['channels'] : payload['channels'].to_i,
        'source' => payload['source'],
        'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
        'uri' => payload['uri'],
        'encryption_details' => payload['encryption_details'],
        'subresource_uris' => payload['subresource_uris'],
        'media_url' => payload['media_url'],
    }

    # Context
    @instance_context = nil
    @params = { 'account_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 Recording resource.

Returns:



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

def 
    @properties['account_sid']
end

#add_on_results ⇒ add_on_results

Access the add_on_results

Returns:



487
488
489
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 487

def add_on_results
    context.add_on_results
end

#api_version ⇒ String

Returns The API version used during the recording.

Returns:

  • (String) —

    The API version used during the recording.



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

def api_version
    @properties['api_version']
end

#call_sid ⇒ String

Returns The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the Recording resource is associated with. This will always refer to the parent leg of a two-leg call.

Returns:



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

def call_sid
    @properties['call_sid']
end

#channels ⇒ String

Returns The number of channels in the final recording file. Can be: ‘1` or `2`.

Returns:

  • (String) —

    The number of channels in the final recording file. Can be: ‘1` or `2`.



423
424
425
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 423

def channels
    @properties['channels']
end

#conference_sid ⇒ String

Returns The Conference SID that identifies the conference associated with the recording, if a conference recording.

Returns:

  • (String) —

    The Conference SID that identifies the conference associated with the recording, if a conference recording.



369
370
371
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 369

def conference_sid
    @properties['conference_sid']
end

#context ⇒ RecordingContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



342
343
344
345
346
347
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 342

def context
    unless @instance_context
        @instance_context = RecordingContext.new(@version , @params['account_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:



375
376
377
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 375

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:



381
382
383
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 381

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



466
467
468
469
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 466

def delete

    context.delete
end

#duration ⇒ String

Returns The length of the recording in seconds.

Returns:

  • (String) —

    The length of the recording in seconds.



393
394
395
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 393

def duration
    @properties['duration']
end

#encryption_details ⇒ Hash

Returns How to decrypt the recording if it was encrypted using [Call Recording Encryption](www.twilio.com/docs/voice/tutorials/voice-recording-encryption) feature.

Returns:



447
448
449
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 447

def encryption_details
    @properties['encryption_details']
end

#error_code ⇒ String

Returns The error code that describes why the recording is ‘absent`. The error code is described in our [Error Dictionary](www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`.

Returns:

  • (String) —

    The error code that describes why the recording is ‘absent`. The error code is described in our [Error Dictionary](www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`.



435
436
437
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 435

def error_code
    @properties['error_code']
end

#fetch(include_soft_deleted: :unset) ⇒ RecordingInstance

Fetch the RecordingInstance

Parameters:

  • include_soft_deleted (Boolean) (defaults to: :unset) —

    A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.

Returns:



475
476
477
478
479
480
481
482
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 475

def fetch(
    include_soft_deleted: :unset
)

    context.fetch(
        include_soft_deleted: include_soft_deleted, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



507
508
509
510
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 507

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

#media_url ⇒ String

Returns The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file.

Returns:

  • (String) —

    The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file.



459
460
461
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 459

def media_url
    @properties['media_url']
end

#price ⇒ String

Returns The one-time cost of creating the recording in the ‘price_unit` currency.

Returns:

  • (String) —

    The one-time cost of creating the recording in the ‘price_unit` currency.



405
406
407
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 405

def price
    @properties['price']
end

#price_unit ⇒ String

Returns The currency used in the ‘price` property. Example: `USD`.

Returns:

  • (String) —

    The currency used in the ‘price` property. Example: `USD`.



411
412
413
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 411

def price_unit
    @properties['price_unit']
end

#sid ⇒ String

Returns The unique string that that we created to identify the Recording resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Recording resource.



399
400
401
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 399

def sid
    @properties['sid']
end

#source ⇒ Source

Returns:

  • (Source) 


429
430
431
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 429

def source
    @properties['source']
end

#start_time ⇒ Time

Returns The start time of the recording in GMT and in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.

Returns:



387
388
389
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 387

def start_time
    @properties['start_time']
end

#status ⇒ Status

Returns:

  • (Status) 


417
418
419
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 417

def status
    @properties['status']
end

#subresource_uris ⇒ Hash

Returns A list of related resources identified by their relative URIs.

Returns:

  • (Hash) —

    A list of related resources identified by their relative URIs.



453
454
455
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 453

def subresource_uris
    @properties['subresource_uris']
end

#to_s ⇒ Object

Provide a user friendly representation



500
501
502
503
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 500

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

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



494
495
496
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 494

def transcriptions
    context.transcriptions
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`.



441
442
443
 
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 441

def uri
    @properties['uri']
end