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](www.twilio.com/docs/chat/rest/services) to fetch the Role resource from.

  • sid (String) —

    The SID of the Role resource to fetch.



186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 186

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

#delete ⇒ Boolean

Deletes the RoleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

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

#fetch ⇒ RoleInstance

Fetch a RoleInstance

Returns:



197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 197

def fetch
  params = Twilio::Values.of({})

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



246
247
248
249
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 246

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

#to_s ⇒ Object

Provide a user friendly representation



239
240
241
242
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 239

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 (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:



225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/twilio-ruby/rest/chat/v2/service/role.rb', line 225

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