Class: Twilio::REST::Chat::V1::ServiceContext::RoleContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v1/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 resource from.

  • sid (String)

    The Twilio-provided string that uniquely identifies the Role resource to fetch.


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

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


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

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

#fetchRoleInstance

Fetch the RoleInstance

Returns:


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

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


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

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

#to_sObject

Provide a user friendly representation


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

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Chat.V1.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. The values for this parameter depend on the role's `type` and are described in the documentation.

Returns:


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

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