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.



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 276

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:



316
317
318
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 316

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:



301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 301

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RoleInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



365
366
367
368
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 365

def delete

    context.delete
end

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:



373
374
375
376
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 373

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



400
401
402
403
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 400

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.



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

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:



322
323
324
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 322

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.



310
311
312
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 310

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



393
394
395
396
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 393

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

#type ⇒ RoleType

Returns:

  • (RoleType) 


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

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:



382
383
384
385
386
387
388
389
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 382

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.



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

def url
    @properties['url']
end