Class: Twilio::REST::Chat::V2::ServiceContext::RoleInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/role.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the RoleInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Role resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 542

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Role resource.

Returns:



583
584
585
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 583

def 
    @properties['account_sid']
end

#context ⇒ RoleContext

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

Returns:



568
569
570
571
572
573
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 568

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



613
614
615
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 613

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



619
620
621
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 619

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RoleInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



632
633
634
635
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 632

def delete

    context.delete
end

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:



640
641
642
643
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 640

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



595
596
597
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 595

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



667
668
669
670
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 667

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

#permissions ⇒ Array<String>

Returns An array of the permissions the role has been granted.

Returns:

  • (Array<String>) —

    An array of the permissions the role has been granted.



607
608
609
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 607

def permissions
    @properties['permissions']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/chat/rest/service-resource) the Role resource is associated with.

Returns:



589
590
591
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 589

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Role resource.

Returns:

  • (String) —

    The unique string that we created to identify the Role resource.



577
578
579
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 577

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



660
661
662
663
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 660

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

#type ⇒ RoleType

Returns:

  • (RoleType) 


601
602
603
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 601

def type
    @properties['type']
end

#update(permission: nil) ⇒ RoleInstance

Update the RoleInstance

Parameters:

  • permission (Array[String]) (defaults to: nil) —

    A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role’s type.

Returns:



649
650
651
652
653
654
655
656
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 649

def update(
    permission: nil
)

    context.update(
        permission: permission, 
    )
end

#url ⇒ String

Returns The absolute URL of the Role resource.

Returns:

  • (String) —

    The absolute URL of the Role resource.



625
626
627
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 625

def url
    @properties['url']
end