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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ RoleContext

Initialize the RoleContext

Parameters:

  • version (Version)

    Version that contains the resource

  • sid (String)

    The SID of the Role resource to fetch.


173
174
175
176
177
178
179
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 173

def initialize(version, sid)
  super(version)

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

Instance Method Details

#deleteBoolean

Delete the RoleInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


201
202
203
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 201

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

#fetchRoleInstance

Fetch the RoleInstance

Returns:


208
209
210
211
212
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 208

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

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

#inspectObject

Provide a detailed, user friendly representation


223
224
225
226
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 223

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

#to_sObject

Provide a user friendly representation


216
217
218
219
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 216

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:


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

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