Class: Twilio::REST::Voice::V2::RecordingInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/voice/v2/recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, id_or_unique_name: nil) ⇒ RecordingInstance

Initialize the RecordingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Recording resource.

  • sid (String) —

    The SID of the Call resource to fetch.



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 410

def initialize(version, payload , id_or_unique_name: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'id' => payload['id'],
        'account_sid' => payload['account_sid'],
        'unique_name' => payload['unique_name'],
        'description' => payload['description'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'configuration' => payload['configuration'],
        'message' => payload['message'],
        'code' => payload['code'],
        'status' => payload['status'],
        'more_info' => payload['more_info'],
    }

    # Context
    @instance_context = nil
    @params = { 'id_or_unique_name' => id_or_unique_name  || @properties['id_or_unique_name']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns Account sid.

Returns:

  • (String) —

    Account sid.



453
454
455
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 453

def 
    @properties['account_sid']
end

#code ⇒ String

Returns Twilio error code.

Returns:

  • (String) —

    Twilio error code



495
496
497
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 495

def code
    @properties['code']
end

#configuration ⇒ VoiceV2ConfigurationRecordingConfiguration

Returns:

  • (VoiceV2ConfigurationRecordingConfiguration) 


483
484
485
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 483

def configuration
    @properties['configuration']
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:



438
439
440
441
442
443
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 438

def context
    unless @instance_context
        @instance_context = RecordingContext.new(@version , @params['id_or_unique_name'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns:

  • (Time) 


471
472
473
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 471

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


477
478
479
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 477

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



514
515
516
517
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 514

def delete

    context.delete
end

#description ⇒ String

Returns The description.

Returns:

  • (String) —

    The description.



465
466
467
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 465

def description
    @properties['description']
end

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

Returns:



522
523
524
525
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 522

def fetch

    context.fetch
end

#id ⇒ String

Returns Configuration Identifier.

Returns:

  • (String) —

    Configuration Identifier.



447
448
449
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 447

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



548
549
550
551
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 548

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

#message ⇒ String

Returns Error message.

Returns:

  • (String) —

    Error message



489
490
491
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 489

def message
    @properties['message']
end

#more_info ⇒ String

Returns More information about the error.

Returns:

  • (String) —

    More information about the error



507
508
509
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 507

def more_info
    @properties['more_info']
end

#status ⇒ String

Returns status code.

Returns:

  • (String) —

    status code



501
502
503
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 501

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



541
542
543
544
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 541

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

#unique_name ⇒ String

Returns The unique name.

Returns:

  • (String) —

    The unique name.



459
460
461
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 459

def unique_name
    @properties['unique_name']
end

#update(voice_v2_configuration_recording_request: :unset) ⇒ RecordingInstance

Update the RecordingInstance

Parameters:

  • voice_v2_configuration_recording_request (VoiceV2ConfigurationRecordingRequest) (defaults to: :unset)

Returns:



531
532
533
534
535
536
537
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 531

def update(voice_v2_configuration_recording_request: :unset
)

    context.update(
        voice_v2_configuration_recording_request: voice_v2_configuration_recording_request, 
    )
end