Class: Twilio::REST::Conversations::V1::RoleInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the RoleInstance



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 533

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'],
        'friendly_name' => payload['friendly_name'],
        'type' => payload['type'],
        'permissions' => payload['permissions'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sidString



574
575
576
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 574

def 
    @properties['account_sid']
end

#chat_service_sidString



580
581
582
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 580

def chat_service_sid
    @properties['chat_service_sid']
end

#contextRoleContext

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



559
560
561
562
563
564
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 559

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

#date_createdTime



604
605
606
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 604

def date_created
    @properties['date_created']
end

#date_updatedTime



610
611
612
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 610

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the RoleInstance



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

def delete

    context.delete
end

#fetchRoleInstance

Fetch the RoleInstance



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

def fetch

    context.fetch
end

#friendly_nameString



586
587
588
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 586

def friendly_name
    @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



658
659
660
661
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 658

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

#permissionsArray<String>



598
599
600
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 598

def permissions
    @properties['permissions']
end

#sidString



568
569
570
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 568

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



651
652
653
654
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 651

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

#typeRoleType



592
593
594
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 592

def type
    @properties['type']
end

#update(permission: nil) ⇒ RoleInstance

Update the RoleInstance



640
641
642
643
644
645
646
647
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 640

def update(
    permission: nil
)

    context.update(
        permission: permission, 
    )
end

#urlString



616
617
618
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 616

def url
    @properties['url']
end