Class: Twilio::REST::Chat::V2::ServiceContext::RoleContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/role.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ RoleContext

Initialize the RoleContext

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String)

    The SID of the Service to fetch the Role resource from.

  • sid (String)

    The SID of the Role resource to fetch.


179
180
181
182
183
184
185
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 179

def initialize(version, service_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Roles/#{@solution[:sid]}"
end

Instance Method Details

#deleteBoolean

Delete the RoleInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


199
200
201
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 199

def delete
   @version.delete('DELETE', @uri)
end

#fetchRoleInstance

Fetch the RoleInstance

Returns:


190
191
192
193
194
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 190

def fetch
  payload = @version.fetch('GET', @uri)

  RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end

#inspectObject

Provide a detailed, user friendly representation


229
230
231
232
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 229

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Chat.V2.RoleContext #{context}>"
end

#to_sObject

Provide a user friendly representation


222
223
224
225
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 222

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Chat.V2.RoleContext #{context}>"
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:


212
213
214
215
216
217
218
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 212

def update(permission: nil)
  data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })

  payload = @version.update('POST', @uri, data: data)

  RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end