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

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

    The SID of the Role resource to fetch.


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 236

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 that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource


276
277
278
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 276

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


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

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:


261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 261

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RoleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:


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

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


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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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


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

def permissions
  @properties['permissions']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


270
271
272
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 270

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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


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

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:


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

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.


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

def url
  @properties['url']
end