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 update the resource from.

  • sid (String) —

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



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

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

Delete the RoleInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



173
174
175
176
 
# File 'lib/twilio-ruby/rest/chat/v1/service/role.rb', line 173

def delete

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

#fetch ⇒ RoleInstance

Fetch the RoleInstance

Returns:



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

def fetch

    payload = @version.fetch('GET', @uri)
    RoleInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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 (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. The values for this parameter depend on the role’s ‘type` and are described in the documentation.

Returns:



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

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