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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_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

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

    The SID of the Conversation Service the Role resource is associated with.

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

    The SID of the Role resource to fetch.


256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 256

def initialize(version, payload, chat_service_sid: nil, 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 = {'chat_service_sid' => chat_service_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#chat_service_sid ⇒ String

Returns The SID of the Conversation Service that the resource is associated with.

Returns:

  • (String) —

    The SID of the Conversation Service that the resource is associated with


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

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:


281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 281

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RoleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:


365
366
367
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 365

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


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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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


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

def permissions
  @properties['permissions']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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

#type ⇒ role.RoleType

Returns The type of role.

Returns:

  • (role.RoleType) —

    The type of role


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

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:


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

def update(permission: nil)
  context.update(permission: permission, )
end

#url ⇒ String

Returns An absolute URL for this user role.

Returns:

  • (String) —

    An absolute URL for this user role.


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

def url
  @properties['url']
end