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 collapse
-
#account_sid ⇒ String
The SID of the Account that created the 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 Sync Document SID.
-
#fetch ⇒ DocumentPermissionInstance
Fetch the DocumentPermissionInstance.
-
#identity ⇒ String
The identity of the user to whom the Sync Document Permission applies.
-
#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
Manage access.
-
#read ⇒ Boolean
Read access.
-
#service_sid ⇒ String
The SID of the Sync Service that 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
Write access.
Constructor Details
#initialize(version, payload, service_sid: nil, document_sid: nil, identity: nil) ⇒ DocumentPermissionInstance
Initialize the DocumentPermissionInstance
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 248 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.
290 291 292 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 290 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
276 277 278 279 280 281 282 283 284 285 286 |
# 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
346 347 348 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 346 def delete context.delete end |
#document_sid ⇒ String
Returns The Sync Document SID.
302 303 304 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 302 def document_sid @properties['document_sid'] end |
#fetch ⇒ DocumentPermissionInstance
Fetch the DocumentPermissionInstance
339 340 341 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 339 def fetch context.fetch end |
#identity ⇒ String
Returns The identity of the user to whom the Sync Document Permission applies.
308 309 310 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 308 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
372 373 374 375 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 372 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Sync.V1.DocumentPermissionInstance #{values}>" end |
#manage ⇒ Boolean
Returns Manage access.
326 327 328 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 326 def manage @properties['manage'] end |
#read ⇒ Boolean
Returns Read access.
314 315 316 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 314 def read @properties['read'] end |
#service_sid ⇒ String
Returns The SID of the Sync Service that the resource is associated with.
296 297 298 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 296 def service_sid @properties['service_sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
365 366 367 368 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 365 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
359 360 361 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 359 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.
332 333 334 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 332 def url @properties['url'] end |
#write ⇒ Boolean
Returns Write access.
320 321 322 |
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 320 def write @properties['write'] end |