Class: Twilio::REST::Proxy::V1::ServiceContext::SessionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/session.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ SessionInstance

Initialize the SessionInstance



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 612

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'service_sid' => payload['service_sid'],
        'account_sid' => payload['account_sid'],
        'date_started' => Twilio.deserialize_iso8601_datetime(payload['date_started']),
        'date_ended' => Twilio.deserialize_iso8601_datetime(payload['date_ended']),
        'date_last_interaction' => Twilio.deserialize_iso8601_datetime(payload['date_last_interaction']),
        'date_expiry' => Twilio.deserialize_iso8601_datetime(payload['date_expiry']),
        'unique_name' => payload['unique_name'],
        'status' => payload['status'],
        'closed_reason' => payload['closed_reason'],
        'ttl' => payload['ttl'] == nil ? payload['ttl'] : payload['ttl'].to_i,
        'mode' => payload['mode'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String 



666
667
668
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 666

def 
    @properties['account_sid']
end

#closed_reason ⇒ String 



708
709
710
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 708

def closed_reason
    @properties['closed_reason']
end

#context ⇒ SessionContext

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



645
646
647
648
649
650
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 645

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

#date_created ⇒ Time 



726
727
728
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 726

def date_created
    @properties['date_created']
end

#date_ended ⇒ Time 



678
679
680
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 678

def date_ended
    @properties['date_ended']
end

#date_expiry ⇒ Time 



690
691
692
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 690

def date_expiry
    @properties['date_expiry']
end

#date_last_interaction ⇒ Time 



684
685
686
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 684

def date_last_interaction
    @properties['date_last_interaction']
end

#date_started ⇒ Time 



672
673
674
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 672

def date_started
    @properties['date_started']
end

#date_updated ⇒ Time 



732
733
734
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 732

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SessionInstance



751
752
753
754
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 751

def delete

    context.delete
end

#fetch ⇒ SessionInstance

Fetch the SessionInstance



759
760
761
762
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 759

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



806
807
808
809
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 806

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

#interactions ⇒ interactions

Access the interactions



786
787
788
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 786

def interactions
    context.interactions
end

#links ⇒ Hash 



744
745
746
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 744

def links
    @properties['links']
end

#mode ⇒ Mode 



720
721
722
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 720

def mode
    @properties['mode']
end

#participants ⇒ participants

Access the participants



793
794
795
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 793

def participants
    context.participants
end

#service_sid ⇒ String 



660
661
662
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 660

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



654
655
656
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 654

def sid
    @properties['sid']
end

#status ⇒ Status 



702
703
704
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 702

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



799
800
801
802
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 799

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

#ttl ⇒ String 



714
715
716
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 714

def ttl
    @properties['ttl']
end

#unique_name ⇒ String 



696
697
698
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 696

def unique_name
    @properties['unique_name']
end

#update(date_expiry: :unset, ttl: :unset, status: :unset) ⇒ SessionInstance

Update the SessionInstance



770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 770

def update(
    date_expiry: :unset, 
    ttl: :unset, 
    status: :unset
)

    context.update(
        date_expiry: date_expiry, 
        ttl: ttl, 
        status: status, 
    )
end

#url ⇒ String 



738
739
740
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 738

def url
    @properties['url']
end