Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapContext::SyncMapPermissionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_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, payload, service_sid: nil, map_sid: nil, identity: nil) ⇒ SyncMapPermissionInstance

Initialize the SyncMapPermissionInstance

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](www.twilio.com/docs/sync/api/service) the resource is associated with.

  • map_sid (String) (defaults to: nil) —

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

  • identity (String) (defaults to: nil) —

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 263

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'map_sid' => payload['map_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,
      'map_sid' => map_sid,
      'identity' => identity || @properties['identity'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



305
306
307
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 305

def 
  @properties['account_sid']
end

#context ⇒ SyncMapPermissionContext

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

Returns:



291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 291

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

#delete ⇒ Boolean

Deletes the SyncMapPermissionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



361
362
363
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 361

def delete
  context.delete
end

#fetch ⇒ SyncMapPermissionInstance

Fetch a SyncMapPermissionInstance

Returns:



354
355
356
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 354

def fetch
  context.fetch
end

#identity ⇒ String

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

Returns:

  • (String) —

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



323
324
325
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 323

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



385
386
387
388
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 385

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

#manage ⇒ Boolean

Returns Manage access.

Returns:

  • (Boolean) —

    Manage access



341
342
343
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 341

def manage
  @properties['manage']
end

#map_sid ⇒ String

Returns Sync Map SID.

Returns:

  • (String) —

    Sync Map SID



317
318
319
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 317

def map_sid
  @properties['map_sid']
end

#read ⇒ Boolean

Returns Read access.

Returns:

  • (Boolean) —

    Read access



329
330
331
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 329

def read
  @properties['read']
end

#service_sid ⇒ String

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



311
312
313
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 311

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



378
379
380
381
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 378

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

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

Update the SyncMapPermissionInstance

Parameters:

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

    Whether the identity can read the Sync Map and its Items.

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

    Whether the identity can create, update and delete Items of the Sync Map.

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

    Whether the identity can delete the Sync Map.

Returns:



372
373
374
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 372

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

#url ⇒ String

Returns The absolute URL of the Sync Map Permission resource.

Returns:

  • (String) —

    The absolute URL of the Sync Map Permission resource



347
348
349
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 347

def url
  @properties['url']
end

#write ⇒ Boolean

Returns Write access.

Returns:

  • (Boolean) —

    Write access



335
336
337
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 335

def write
  @properties['write']
end