Class: Twilio::REST::Sync::V1::ServiceContext::SyncListContext::SyncListItemInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, list_sid: nil, index: nil) ⇒ SyncListItemInstance

Initialize the SyncListItemInstance

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 SyncListItem resource.

  • sid (String) —

    The SID of the Call resource to fetch.



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 608

def initialize(version, payload , service_sid: nil, list_sid: nil, index: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'index' => payload['index'] == nil ? payload['index'] : payload['index'].to_i,
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'list_sid' => payload['list_sid'],
        'url' => payload['url'],
        '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']  ,'list_sid' => list_sid  || @properties['list_sid']  ,'index' => index  || @properties['index']  , }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:



651
652
653
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 651

def 
    @properties['account_sid']
end

#context ⇒ SyncListItemContext

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

Returns:



636
637
638
639
640
641
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 636

def context
    unless @instance_context
        @instance_context = SyncListItemContext.new(@version , @params['service_sid'], @params['list_sid'], @params['index'])
    end
    @instance_context
end

#created_by ⇒ String

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

Returns:

  • (String) —

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



705
706
707
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 705

def created_by
    @properties['created_by']
end

#data ⇒ Hash

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

Returns:

  • (Hash) —

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



681
682
683
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 681

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:



693
694
695
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 693

def date_created
    @properties['date_created']
end

#date_expires ⇒ Time

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

Returns:

  • (Time) —

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



687
688
689
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 687

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:



699
700
701
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 699

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the SyncListItemInstance

Parameters:

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

    If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



713
714
715
716
717
718
719
720
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 713

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ SyncListItemInstance

Fetch the SyncListItemInstance

Returns:



725
726
727
728
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 725

def fetch

    context.fetch
end

#index ⇒ String

Returns The automatically generated index of the List Item. The index values of the List Items in a Sync List can have gaps in their sequence.

Returns:

  • (String) —

    The automatically generated index of the List Item. The index values of the List Items in a Sync List can have gaps in their sequence.



645
646
647
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 645

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



764
765
766
767
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 764

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

#list_sid ⇒ String

Returns The SID of the Sync List that contains the List Item.

Returns:

  • (String) —

    The SID of the Sync List that contains the List Item.



663
664
665
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 663

def list_sid
    @properties['list_sid']
end

#revision ⇒ String

Returns The current revision of the item, represented as a string.

Returns:

  • (String) —

    The current revision of the item, represented as a string.



675
676
677
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 675

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:



657
658
659
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 657

def service_sid
    @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



757
758
759
760
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 757

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

#update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset) ⇒ SyncListItemInstance

Update the SyncListItemInstance

Parameters:

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

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

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

    An alias for item_ttl. If both parameters are provided, this value is ignored.

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

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

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

    How long, [in seconds](www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item’s parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item’s data or ttl is updated in the same request.

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

    If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).

Returns:



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 738

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

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

#url ⇒ String

Returns The absolute URL of the List Item resource.

Returns:

  • (String) —

    The absolute URL of the List Item resource.



669
670
671
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 669

def url
    @properties['url']
end