Class: Twilio::REST::Sync::V1::ServiceContext::DocumentContext::DocumentPermissionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/document/document_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, document_sid: nil, identity: nil) ⇒ DocumentPermissionInstance

Initialize the DocumentPermissionInstance

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.

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

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

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

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 256

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'document_sid' => payload['document_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,
      'document_sid' => document_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



298
299
300
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 298

def 
  @properties['account_sid']
end

#context ⇒ DocumentPermissionContext

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

Returns:



284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 284

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

#delete ⇒ Boolean

Delete the DocumentPermissionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#document_sid ⇒ String

Returns The Sync Document SID.

Returns:

  • (String) —

    The Sync Document SID



310
311
312
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 310

def document_sid
  @properties['document_sid']
end

#fetch ⇒ DocumentPermissionInstance

Fetch the DocumentPermissionInstance

Returns:



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

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



316
317
318
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 316

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



380
381
382
383
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 380

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

#manage ⇒ Boolean

Returns Manage access.

Returns:

  • (Boolean) —

    Manage access



334
335
336
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 334

def manage
  @properties['manage']
end

#read ⇒ Boolean

Returns Read access.

Returns:

  • (Boolean) —

    Read access



322
323
324
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 322

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



304
305
306
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 304

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



373
374
375
376
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 373

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

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

Update the DocumentPermissionInstance

Parameters:

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

    Whether the identity can read the Sync Document. Default value is ‘false`.

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

    Whether the identity can update the Sync Document. Default value is ‘false`.

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

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

Returns:



367
368
369
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 367

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 Document Permission resource.

Returns:

  • (String) —

    The absolute URL of the Sync Document Permission resource



340
341
342
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 340

def url
  @properties['url']
end

#write ⇒ Boolean

Returns Write access.

Returns:

  • (Boolean) —

    Write access



328
329
330
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 328

def write
  @properties['write']
end