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



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 572

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 



622
623
624
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 622

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



601
602
603
604
605
606
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 601

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

#created_by ⇒ String 



676
677
678
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 676

def created_by
    @properties['created_by']
end

#data ⇒ Hash 



652
653
654
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 652

def data
    @properties['data']
end

#date_created ⇒ Time 



664
665
666
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 664

def date_created
    @properties['date_created']
end

#date_expires ⇒ Time 



658
659
660
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 658

def date_expires
    @properties['date_expires']
end

#date_updated ⇒ Time 



670
671
672
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 670

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DocumentInstance



683
684
685
686
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 683

def delete

    context.delete
end

#document_permissions ⇒ document_permissions

Access the document_permissions



718
719
720
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 718

def document_permissions
    context.document_permissions
end

#fetch ⇒ DocumentInstance

Fetch the DocumentInstance



691
692
693
694
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 691

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



731
732
733
734
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 731

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

#links ⇒ Hash 



640
641
642
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 640

def links
    @properties['links']
end

#revision ⇒ String 



646
647
648
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 646

def revision
    @properties['revision']
end

#service_sid ⇒ String 



628
629
630
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 628

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



610
611
612
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 610

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



724
725
726
727
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 724

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

#unique_name ⇒ String 



616
617
618
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 616

def unique_name
    @properties['unique_name']
end

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

Update the DocumentInstance



702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 702

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

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

#url ⇒ String 



634
635
636
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document.rb', line 634

def url
    @properties['url']
end