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 service_sid

  • sid (String) —

    The sid



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

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, true otherwise



208
209
210
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 208

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

#fetch ⇒ RoleInstance

Fetch a RoleInstance

Returns:



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 193

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

#to_s ⇒ Object

Provide a user friendly representation



231
232
233
234
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 231

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) —

    (multiple) A permission this role should have. Consult the table above for the list of possible permissions.

Returns:



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 217

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