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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

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

    The unique SID identifier of the Service Instance that hosts this List object.

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

    The unique 34-character SID identifier of the List containing this Item.

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

    The index



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 327

def initialize(version, payload, service_sid: nil, list_sid: nil, index: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      '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,
      'list_sid' => list_sid,
      'index' => index || @properties['index'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Twilio Account.

Returns:

  • (String) —

    The unique SID identifier of the Twilio Account.



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

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:



358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 358

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 this item’s creator.

Returns:

  • (String) —

    The identity of this item’s creator.



432
433
434
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 432

def created_by
  @properties['created_by']
end

#data ⇒ Hash

Returns Contains arbitrary user-defined, schema-less data that this List Item stores, represented by a JSON object, up to 16KB.

Returns:

  • (Hash) —

    Contains arbitrary user-defined, schema-less data that this List Item stores, represented by a JSON object, up to 16KB.



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

def data
  @properties['data']
end

#date_created ⇒ Time

Returns The date this item was created, given in UTC ISO 8601 format.

Returns:

  • (Time) —

    The date this item was created, given in UTC ISO 8601 format.



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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

Returns Contains the date this item expires and gets deleted automatically.

Returns:

  • (Time) —

    Contains the date this item expires and gets deleted automatically.



414
415
416
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 414

def date_expires
  @properties['date_expires']
end

#date_updated ⇒ Time

Returns Specifies the date this item was last updated, given in UTC ISO 8601 format.

Returns:

  • (Time) —

    Specifies the date this item was last updated, given in UTC ISO 8601 format.



426
427
428
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 426

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SyncListItemInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



446
447
448
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 446

def delete
  context.delete
end

#fetch ⇒ SyncListItemInstance

Fetch a SyncListItemInstance

Returns:



439
440
441
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 439

def fetch
  context.fetch
end

#index ⇒ String

Returns Contains the numeric index of this List Item.

Returns:

  • (String) —

    Contains the numeric index of this List Item.



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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



478
479
480
481
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 478

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

#list_sid ⇒ String

Returns The unique 34-character SID identifier of the List containing this Item.

Returns:

  • (String) —

    The unique 34-character SID identifier of the List containing this Item.



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

def list_sid
  @properties['list_sid']
end

#revision ⇒ String

Returns Contains the current revision of this item, represented by a string identifier.

Returns:

  • (String) —

    Contains the current revision of this item, represented by a string identifier.



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

def revision
  @properties['revision']
end

#service_sid ⇒ String

Returns The unique SID identifier of the Service Instance that hosts this List object.

Returns:

  • (String) —

    The unique SID identifier of the Service Instance that hosts this List object.



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

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



471
472
473
474
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 471

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) ⇒ SyncListItemInstance

Update the SyncListItemInstance

Parameters:

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

    Contains arbitrary user-defined, schema-less data that this List Item stores, represented by a JSON object, up to 16KB.

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

    Alias for item_ttl. If both are provided, this value is ignored.

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

    Time-to-live of this item in seconds, defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. Upon expiry, the list item will be cleaned up at least in a matter of hours, and often within seconds, making this a good tool for garbage management.

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

    Time-to-live of this item’s parent List in seconds, defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. This parameter can only be used when the list item’s data or ttl is updated in the same request.

Returns:



465
466
467
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 465

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

#url ⇒ String

Returns The absolute URL for this item.

Returns:

  • (String) —

    The absolute URL for this item.



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

def url
  @properties['url']
end