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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, document_sid: nil, identity: nil) ⇒ DocumentPermissionInstance

Initialize the DocumentPermissionInstance



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/preview/sync/service/document/document_permission.rb', line 263

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 



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

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



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

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



361
362
363
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb', line 361

def delete
  context.delete
end

#document_sid ⇒ String 



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

def document_sid
  @properties['document_sid']
end

#fetch ⇒ DocumentPermissionInstance

Fetch a DocumentPermissionInstance



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

def fetch
  context.fetch
end

#identity ⇒ String 



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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



387
388
389
390
 
# File 'lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb', line 387

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

#manage ⇒ Boolean 



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

def manage
  @properties['manage']
end

#read ⇒ Boolean 



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

def read
  @properties['read']
end

#service_sid ⇒ String 



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

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

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

Update the DocumentPermissionInstance



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

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

#url ⇒ String 



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

def url
  @properties['url']
end

#write ⇒ Boolean 



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

def write
  @properties['write']
end