Class: Twilio::REST::Sync::V1::ServiceContext::SyncListContext::SyncListPermissionContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, list_sid, identity) ⇒ SyncListPermissionContext

Initialize the SyncListPermissionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) with the Sync List Permission resource to fetch.

  • list_sid (String) —

    The SID of the Sync List with the Sync List Permission resource to fetch. Can be the Sync List resource’s ‘sid` or its `unique_name`.

  • identity (String) —

    The application-defined string that uniquely identifies the User’s Sync List Permission resource to fetch.



172
173
174
175
176
177
178
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 172

def initialize(version, service_sid, list_sid, identity)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, list_sid: list_sid, identity: identity, }
  @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Permissions/#{@solution[:identity]}"
end

Instance Method Details

#delete ⇒ Boolean

Delete the SyncListPermissionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



198
199
200
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 198

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

#fetch ⇒ SyncListPermissionInstance

Fetch the SyncListPermissionInstance

Returns:



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 183

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

  SyncListPermissionInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      list_sid: @solution[:list_sid],
      identity: @solution[:identity],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



234
235
236
237
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 234

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

#to_s ⇒ Object

Provide a user friendly representation



227
228
229
230
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 227

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

#update(read: nil, write: nil, manage: nil) ⇒ SyncListPermissionInstance

Update the SyncListPermissionInstance

Parameters:

  • read (Boolean) (defaults to: nil) —

    Whether the identity can read the Sync List and its Items. Default value is ‘false`.

  • write (Boolean) (defaults to: nil) —

    Whether the identity can create, update, and delete Items in the Sync List. Default value is ‘false`.

  • manage (Boolean) (defaults to: nil) —

    Whether the identity can delete the Sync List. Default value is ‘false`.

Returns:



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 211

def update(read: nil, write: nil, manage: nil)
  data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage, })

  payload = @version.update('POST', @uri, data: data)

  SyncListPermissionInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      list_sid: @solution[:list_sid],
      identity: @solution[:identity],
  )
end