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

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.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 262

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_sid ⇒ String

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

Returns:



302
303
304
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 302

def 
    @properties['account_sid']
end

#chat_service_sid ⇒ String

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

Returns:



308
309
310
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 308

def chat_service_sid
    @properties['chat_service_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:



287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 287

def context
    unless @instance_context
        @instance_context = RoleContext.new(@version , @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:



332
333
334
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 332

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:



338
339
340
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 338

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RoleInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:



359
360
361
362
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 359

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.



314
315
316
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 314

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



386
387
388
389
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 386

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Conversations.V1.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.



326
327
328
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 326

def permissions
    @properties['permissions']
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.



296
297
298
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 296

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



379
380
381
382
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 379

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

#type ⇒ RoleType

Returns:

  • (RoleType) 


320
321
322
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 320

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:



368
369
370
371
372
373
374
375
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 368

def update(
    permission: nil
)

    context.update(
        permission: permission, 
    )
end

#url ⇒ String

Returns An absolute API resource URL for this user role.

Returns:

  • (String) —

    An absolute API resource URL for this user role.



344
345
346
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 344

def url
    @properties['url']
end