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

  • sid (String) —

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



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

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



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

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

#fetch ⇒ RoleInstance

Fetch a RoleInstance

Returns:



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

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



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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