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.



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 469

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.



512
513
514
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 512

def 
    @properties['account_sid']
end

#code ⇒ String

Returns Twilio error code.

Returns:

  • (String) —

    Twilio error code



554
555
556
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 554

def code
    @properties['code']
end

#configuration ⇒ VoiceV2ConfigurationRecordingConfiguration

Returns:

  • (VoiceV2ConfigurationRecordingConfiguration) 


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

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:



497
498
499
500
501
502
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 497

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

#date_created ⇒ Time

Returns:

  • (Time) 


530
531
532
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 530

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


536
537
538
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 536

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



573
574
575
576
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 573

def delete

    context.delete
end

#description ⇒ String

Returns The description.

Returns:

  • (String) —

    The description.



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

def description
    @properties['description']
end

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

Returns:



581
582
583
584
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 581

def fetch

    context.fetch
end

#id ⇒ String

Returns Configuration Identifier.

Returns:

  • (String) —

    Configuration Identifier.



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

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



607
608
609
610
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 607

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



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

def message
    @properties['message']
end

#more_info ⇒ String

Returns More information about the error.

Returns:

  • (String) —

    More information about the error



566
567
568
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 566

def more_info
    @properties['more_info']
end

#status ⇒ String

Returns status code.

Returns:

  • (String) —

    status code



560
561
562
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 560

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



600
601
602
603
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 600

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.



518
519
520
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 518

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:



590
591
592
593
594
595
596
 
# File 'lib/twilio-ruby/rest/voice/v2/recording.rb', line 590

def update(voice_v2_configuration_recording_request: :unset
)

    context.update(
        voice_v2_configuration_recording_request: voice_v2_configuration_recording_request, 
    )
end