Class: Twilio::REST::Sync::V1::ServiceContext::DocumentInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ DocumentInstance

Initialize the DocumentInstance



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 318

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'url' => payload['url'],
        'links' => payload['links'],
        'revision' => payload['revision'],
        'data' => payload['data'],
        'date_expires' => Twilio.deserialize_iso8601_datetime(payload['date_expires']),
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'created_by' => payload['created_by'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



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

def 
    @properties['account_sid']
end

#context ⇒ DocumentContext

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



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

def context
    unless @instance_context
        @instance_context = DocumentContext.new(@version , @params['service_sid'], @params['sid'])
    end
    @instance_context
end

#created_by ⇒ String 



421
422
423
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 421

def created_by
    @properties['created_by']
end

#data ⇒ Hash 



397
398
399
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 397

def data
    @properties['data']
end

#date_created ⇒ Time 



409
410
411
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 409

def date_created
    @properties['date_created']
end

#date_expires ⇒ Time 



403
404
405
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 403

def date_expires
    @properties['date_expires']
end

#date_updated ⇒ Time 



415
416
417
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 415

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DocumentInstance



428
429
430
431
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 428

def delete

    context.delete
end

#document_permissions ⇒ document_permissions

Access the document_permissions



463
464
465
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 463

def document_permissions
    context.document_permissions
end

#fetch ⇒ DocumentInstance

Fetch the DocumentInstance



436
437
438
439
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 436

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



476
477
478
479
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 476

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

#links ⇒ Hash 



385
386
387
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 385

def links
    @properties['links']
end

#revision ⇒ String 



391
392
393
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 391

def revision
    @properties['revision']
end

#service_sid ⇒ String 



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



469
470
471
472
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 469

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

#unique_name ⇒ String 



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

def unique_name
    @properties['unique_name']
end

#update(data: :unset, ttl: :unset, if_match: :unset) ⇒ DocumentInstance

Update the DocumentInstance



447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 447

def update(
    data: :unset, 
    ttl: :unset, 
    if_match: :unset
)

    context.update(
        data: data, 
        ttl: ttl, 
        if_match: if_match, 
    )
end

#url ⇒ String 



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

def url
    @properties['url']
end