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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, list_sid: nil, identity: nil) ⇒ SyncListPermissionInstance

Initialize the SyncListPermissionInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil)

    The SID of the Sync Service the resource is associated with.

  • list_sid (String) (defaults to: nil)

    The SID of the Sync List to which the Permission applies.

  • identity (String) (defaults to: nil)

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


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 247

def initialize(version, payload, service_sid: nil, list_sid: nil, identity: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'list_sid' => payload['list_sid'],
      'identity' => payload['identity'],
      'read' => payload['read'],
      'write' => payload['write'],
      'manage' => payload['manage'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {
      'service_sid' => service_sid,
      'list_sid' => list_sid,
      'identity' => identity || @properties['identity'],
  }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


289
290
291
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 289

def 
  @properties['account_sid']
end

#contextSyncListPermissionContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


275
276
277
278
279
280
281
282
283
284
285
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 275

def context
  unless @instance_context
    @instance_context = SyncListPermissionContext.new(
        @version,
        @params['service_sid'],
        @params['list_sid'],
        @params['identity'],
    )
  end
  @instance_context
end

#deleteBoolean

Delete the SyncListPermissionInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


345
346
347
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 345

def delete
  context.delete
end

#fetchSyncListPermissionInstance

Fetch the SyncListPermissionInstance

Returns:


338
339
340
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 338

def fetch
  context.fetch
end

#identityString

Returns The identity of the user to whom the Sync List Permission applies.

Returns:

  • (String)

    The identity of the user to whom the Sync List Permission applies


307
308
309
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 307

def identity
  @properties['identity']
end

#inspectObject

Provide a detailed, user friendly representation


371
372
373
374
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 371

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Sync.V1.SyncListPermissionInstance #{values}>"
end

#list_sidString

Returns The SID of the Sync List to which the Permission applies.

Returns:

  • (String)

    The SID of the Sync List to which the Permission applies


301
302
303
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 301

def list_sid
  @properties['list_sid']
end

#manageBoolean

Returns Manage access.

Returns:

  • (Boolean)

    Manage access


325
326
327
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 325

def manage
  @properties['manage']
end

#readBoolean

Returns Read access.

Returns:

  • (Boolean)

    Read access


313
314
315
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 313

def read
  @properties['read']
end

#service_sidString

Returns The SID of the Sync Service that the resource is associated with.

Returns:

  • (String)

    The SID of the Sync Service that the resource is associated with


295
296
297
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 295

def service_sid
  @properties['service_sid']
end

#to_sObject

Provide a user friendly representation


364
365
366
367
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 364

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Sync.V1.SyncListPermissionInstance #{values}>"
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:


358
359
360
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 358

def update(read: nil, write: nil, manage: nil)
  context.update(read: read, write: write, manage: manage, )
end

#urlString

Returns The absolute URL of the Sync List Permission resource.

Returns:

  • (String)

    The absolute URL of the Sync List Permission resource


331
332
333
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 331

def url
  @properties['url']
end

#writeBoolean

Returns Write access.

Returns:

  • (Boolean)

    Write access


319
320
321
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb', line 319

def write
  @properties['write']
end