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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Sync::V1::ServiceContext::DocumentContext::DocumentPermissionInstance

Defined in:

lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the Document Permission resource.

• #context ⇒ DocumentPermissionContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #delete ⇒ Boolean

  Delete the DocumentPermissionInstance.

• #document_sid ⇒ String

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

• #fetch ⇒ DocumentPermissionInstance

  Fetch the DocumentPermissionInstance.

• #identity ⇒ String

  The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.

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

  Initialize the DocumentPermissionInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #manage ⇒ Boolean

  Whether the identity can delete the Sync Document.

• #read ⇒ Boolean

  Whether the identity can read the Sync Document.

• #service_sid ⇒ String

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

• #to_s ⇒ Object

  Provide a user friendly representation.

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

  Update the DocumentPermissionInstance.

• #url ⇒ String

  The absolute URL of the Sync Document Permission resource.

• #write ⇒ Boolean

  Whether the identity can update the Sync Document.

Constructor Details

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

Initialize the DocumentPermissionInstance

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

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  || @properties['service_sid']  ,'document_sid' => document_sid  || @properties['document_sid']  ,'identity' => identity  || @properties['identity']  , }
end

Instance Method Details

#account_sid ⇒ String

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

def account_sid
    @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

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

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

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

def delete

    context.delete
end

#document_sid ⇒ String

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

def document_sid
    @properties['document_sid']
end

#fetch ⇒ DocumentPermissionInstance

Fetch the DocumentPermissionInstance

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

def fetch

    context.fetch
end

#identity ⇒ String

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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#manage ⇒ Boolean

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

def manage
    @properties['manage']
end

#read ⇒ Boolean

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

def read
    @properties['read']
end

#service_sid ⇒ String

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

def service_sid
    @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

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

def update(
    read: nil, 
    write: nil, 
    manage: nil
)

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

#url ⇒ String

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

def url
    @properties['url']
end

#write ⇒ Boolean

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

def write
    @properties['write']
end