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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Document resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



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

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Document resource.

Returns:



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

Returns:



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

Returns The identity of the Sync Document’s creator. If the Sync Document is created from the client SDK, the value matches the Access Token’s identity field. If the Sync Document was created from the REST API, the value is system.

Returns:

  • (String) —

    The identity of the Sync Document’s creator. If the Sync Document is created from the client SDK, the value matches the Access Token’s identity field. If the Sync Document was created from the REST API, the value is system.



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

def created_by
    @properties['created_by']
end

#data ⇒ Hash

Returns An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.

Returns:

  • (Hash) —

    An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.



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

def data
    @properties['data']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

Returns The date and time in GMT when the Sync Document expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Sync Document does not expire, this value is null. The Document resource might not be deleted immediately after it expires.

Returns:

  • (Time) —

    The date and time in GMT when the Sync Document expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Sync Document does not expire, this value is null. The Document resource might not be deleted immediately after it expires.



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

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

Returns:



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

Returns:



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

Returns The URLs of resources related to the Sync Document.

Returns:

  • (Hash) —

    The URLs of resources related to the Sync Document.



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

def links
    @properties['links']
end

#revision ⇒ String

Returns The current revision of the Sync Document, represented as a string. The revision property is used with conditional updates to ensure data consistency.

Returns:

  • (String) —

    The current revision of the Sync Document, represented as a string. The revision property is used with conditional updates to ensure data consistency.



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

def revision
    @properties['revision']
end

#service_sid ⇒ String

Returns The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Document resource.

Returns:

  • (String) —

    The unique string that we created to identify the Document resource.



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

Returns An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s sid in the URL to address the resource and can be up to 320 characters long.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s sid in the URL to address the resource and can be up to 320 characters long.



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

Parameters:

  • data (Object) (defaults to: :unset) —

    A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.

  • ttl (String) (defaults to: :unset) —

    How long, [in seconds](www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (time-to-live).

  • if_match (String) (defaults to: :unset) —

    The If-Match HTTP request header

Returns:



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

Returns The absolute URL of the Document resource.

Returns:

  • (String) —

    The absolute URL of the Document resource.



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

def url
    @properties['url']
end