Class: Twilio::REST::Events::V1::SubscriptionInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/events/v1/subscription.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ SubscriptionInstance

Initialize the SubscriptionInstance



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 569

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'sid' => payload['sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'description' => payload['description'],
        'sink_sid' => payload['sink_sid'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String 



603
604
605
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 603

def 
    @properties['account_sid']
end

#context ⇒ SubscriptionContext

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



594
595
596
597
598
599
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 594

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

#date_created ⇒ Time 



615
616
617
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 615

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



621
622
623
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 621

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SubscriptionInstance



652
653
654
655
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 652

def delete

    context.delete
end

#description ⇒ String 



627
628
629
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 627

def description
    @properties['description']
end

#fetch ⇒ SubscriptionInstance

Fetch the SubscriptionInstance



660
661
662
663
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 660

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



694
695
696
697
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 694

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

#links ⇒ Hash 



645
646
647
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 645

def links
    @properties['links']
end

#sid ⇒ String 



609
610
611
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 609

def sid
    @properties['sid']
end

#sink_sid ⇒ String 



633
634
635
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 633

def sink_sid
    @properties['sink_sid']
end

#subscribed_events ⇒ subscribed_events

Access the subscribed_events



681
682
683
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 681

def subscribed_events
    context.subscribed_events
end

#to_s ⇒ Object

Provide a user friendly representation



687
688
689
690
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 687

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

#update(description: :unset) ⇒ SubscriptionInstance

Update the SubscriptionInstance



669
670
671
672
673
674
675
676
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 669

def update(
  description: :unset
)

    context.update(
        description: description, 
    )
end

#url ⇒ String 



639
640
641
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 639

def url
    @properties['url']
end