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



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 593

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 



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

def 
    @properties['account_sid']
end

#attributes ⇒ String 



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

def attributes
    @properties['attributes']
end

#chat_service_sid ⇒ String 



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

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



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

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the UserInstance



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

def delete(
  x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ UserInstance

Fetch the UserInstance



724
725
726
727
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 724

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String 



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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



767
768
769
770
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 767

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

#is_notifiable ⇒ Boolean 



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

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean 



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

def is_online
    @properties['is_online']
end

#links ⇒ Hash 



704
705
706
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 704

def links
    @properties['links']
end

#role_sid ⇒ String 



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

def role_sid
    @properties['role_sid']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



736
737
738
739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/twilio-ruby/rest/conversations/v1/user.rb', line 736

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 



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

def url
    @properties['url']
end

#user_conversations ⇒ user_conversations

Access the user_conversations



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

def user_conversations
    context.user_conversations
end