Class: Twilio::REST::Conversations::V1::ServiceContext::RoleContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, chat_service_sid, sid) ⇒ RoleContext

Initialize the RoleContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • chat_service_sid (String) —

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

  • sid (String) —

    The SID of the Role resource to fetch.


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

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

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

Instance Method Details

#delete ⇒ Boolean

Delete the RoleInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

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

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:


220
221
222
223
224
225
226
227
228
229
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 220

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


240
241
242
243
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 240

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

#to_s ⇒ Object

Provide a user friendly representation


233
234
235
236
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 233

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


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

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,
      chat_service_sid: @solution[:chat_service_sid],
      sid: @solution[:sid],
  )
end