Class: Twilio::REST::Chat::V1::ServiceContext::RoleInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/chat/v1/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.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 293

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/api/rest/account) that created the Role resource.

Returns:



333
334
335
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 333

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:



318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 318

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 [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



363
364
365
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 363

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 [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



369
370
371
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 369

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RoleInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



382
383
384
385
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 382

def delete

    context.delete
end

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:



390
391
392
393
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 390

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.



345
346
347
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 345

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



417
418
419
420
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 417

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

#permissions ⇒ Array<String>

Returns An array of the permissions the role has been granted, formatted as a JSON string.

Returns:

  • (Array<String>) —

    An array of the permissions the role has been granted, formatted as a JSON string.



357
358
359
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 357

def permissions
    @properties['permissions']
end

#service_sid ⇒ String

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

Returns:



339
340
341
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 339

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.



327
328
329
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 327

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



410
411
412
413
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 410

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

#type ⇒ RoleType

Returns:

  • (RoleType) 


351
352
353
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 351

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. The values for this parameter depend on the role’s ‘type` and are described in the documentation.

Returns:



399
400
401
402
403
404
405
406
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 399

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.



375
376
377
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 375

def url
    @properties['url']
end