Class: Twilio::REST::Conversations::V1::UserInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the UserInstance



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 585

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'chat_service_sid' => payload['chat_service_sid'],
        'role_sid' => payload['role_sid'],
        'identity' => payload['identity'],
        'friendly_name' => payload['friendly_name'],
        'attributes' => payload['attributes'],
        'is_online' => payload['is_online'],
        'is_notifiable' => payload['is_notifiable'],
        '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 = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



630
631
632
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 630

def 
    @properties['account_sid']
end

#attributes ⇒ String 



660
661
662
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 660

def attributes
    @properties['attributes']
end

#chat_service_sid ⇒ String 



636
637
638
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 636

def chat_service_sid
    @properties['chat_service_sid']
end

#context ⇒ UserContext

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



615
616
617
618
619
620
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 615

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

#date_created ⇒ Time 



678
679
680
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 678

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



684
685
686
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 684

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the UserInstance



704
705
706
707
708
709
710
711
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 704

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ UserInstance

Fetch the UserInstance



716
717
718
719
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 716

def fetch

    context.fetch
end

#friendly_name ⇒ String 



654
655
656
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 654

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String 



648
649
650
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 648

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



759
760
761
762
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 759

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

#is_notifiable ⇒ Boolean 



672
673
674
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 672

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean 



666
667
668
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 666

def is_online
    @properties['is_online']
end

#links ⇒ Hash 



696
697
698
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 696

def links
    @properties['links']
end

#role_sid ⇒ String 



642
643
644
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 642

def role_sid
    @properties['role_sid']
end

#sid ⇒ String 



624
625
626
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 624

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



752
753
754
755
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 752

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

#update(friendly_name: :unset, attributes: :unset, role_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance

Update the UserInstance



728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 728

def update(
    friendly_name: :unset, 
    attributes: :unset, 
    role_sid: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        friendly_name: friendly_name, 
        attributes: attributes, 
        role_sid: role_sid, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String 



690
691
692
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 690

def url
    @properties['url']
end

#user_conversations ⇒ user_conversations

Access the user_conversations



746
747
748
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 746

def user_conversations
    context.user_conversations
end