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 update.



160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 160

def initialize(version, sid)
    super(version)

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the RoleInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 182

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.fetch('GET', @uri, headers: headers)
    RoleInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



226
227
228
229
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 226

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

#to_s ⇒ Object

Provide a user friendly representation



219
220
221
222
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 219

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:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/twilio-ruby/rest/conversations/v1/role.rb', line 198

def update(
    permission: nil
)

    data = Twilio::Values.of({
        'Permission' => Twilio.serialize_list(permission) { |e| e },
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    RoleInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end