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 that contains the resource

  • payload that contains response from Twilio

  • The SID of the Account that created this SyncListItem resource.

  • The SID of the Call resource to fetch.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 313

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 that created the List Item resource.

Returns:

  • The SID of the Account that created the List Item resource.



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

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:

  • CallContext for this CallInstance



340
341
342
343
344
345
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 340

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:

  • 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.



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

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:

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



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

def data
    @properties['data']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in ISO 8601 format.

Returns:

  • The date and time in GMT when the resource was created specified in ISO 8601 format.



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

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 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:

  • The date and time in GMT when the List Item expires and will be deleted, specified in 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.



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

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 format.

Returns:

  • The date and time in GMT when the resource was last updated specified in ISO 8601 format.



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

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the SyncListItemInstance

Parameters:

  • (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.

Returns:

  • True if delete succeeds, false otherwise



417
418
419
420
421
422
423
424
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 417

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ SyncListItemInstance

Fetch the SyncListItemInstance

Returns:

  • Fetched SyncListItemInstance



429
430
431
432
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 429

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:

  • 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.



349
350
351
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 349

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



468
469
470
471
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 468

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:

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



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

def list_sid
    @properties['list_sid']
end

#revision ⇒ String

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

Returns:

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



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

def revision
    @properties['revision']
end

#service_sid ⇒ String

Returns The SID of the Sync Service the resource is associated with.

Returns:

  • The SID of the Sync Service the resource is associated with.



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

def service_sid
    @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



461
462
463
464
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 461

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:

  • (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.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    How long, in seconds, before the List Item expires (time-to-live) and is deleted.

  • (defaults to: :unset)

    How long, in seconds, 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.

  • (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.

Returns:

  • Updated SyncListItemInstance



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 442

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:

  • The absolute URL of the List Item resource.



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

def url
    @properties['url']
end