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 unique SID identifier of the Sync Service Instance.

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

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

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

    Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.



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

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 Twilio Account SID.

Returns:

  • (String) —

    Twilio Account SID.



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

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:



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

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

#delete ⇒ Boolean

Deletes the DocumentPermissionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#document_sid ⇒ String

Returns Sync Document SID.

Returns:

  • (String) —

    Sync Document SID.



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

def document_sid
  @properties['document_sid']
end

#fetch ⇒ DocumentPermissionInstance

Fetch a DocumentPermissionInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns Identity of the user to whom the Sync Document Permission applies.

Returns:

  • (String) —

    Identity of the user to whom the Sync Document Permission applies.



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

def manage
  @properties['manage']
end

#read ⇒ Boolean

Returns Read access.

Returns:

  • (Boolean) —

    Read access.



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

def read
  @properties['read']
end

#service_sid ⇒ String

Returns Sync Service Instance SID.

Returns:

  • (String) —

    Sync Service Instance SID.



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

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) —

    Boolean flag specifying whether the identity can read the Sync Document.

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

    Boolean flag specifying whether the identity can update the Sync Document.

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

    Boolean flag specifying whether the identity can delete the Sync Document.

Returns:



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

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

#url ⇒ String

Returns URL of this Sync Document Permission.

Returns:

  • (String) —

    URL of this Sync Document Permission.



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

def url
  @properties['url']
end

#write ⇒ Boolean

Returns Write access.

Returns:

  • (Boolean) —

    Write access.



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

def write
  @properties['write']
end