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 SID of the Sync Service the resource is associated with.

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

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

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

    The index of the Sync List Item resource to fetch.



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 359

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

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:



390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 390

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.

Returns:

  • (String) —

    The identity of the List Item’s creator



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

def created_by
  @properties['created_by']
end

#data ⇒ Hash

Returns An arbitrary, schema-less object that the List Item stores.

Returns:

  • (Hash) —

    An arbitrary, schema-less object that the List Item stores



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

def data
  @properties['data']
end

#date_created ⇒ Time

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

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



452
453
454
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 452

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

Returns The ISO 8601 date and time in GMT when the List Item expires.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the List Item expires



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

def date_expires
  @properties['date_expires']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



458
459
460
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 458

def date_updated
  @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the SyncListItemInstance

Parameters:

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

    The If-Match HTTP request header

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete(if_match: :unset)
  context.delete(if_match: if_match, )
end

#fetch ⇒ SyncListItemInstance

Fetch the SyncListItemInstance

Returns:



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

def fetch
  context.fetch
end

#index ⇒ String

Returns The automatically generated index of the List Item.

Returns:

  • (String) —

    The automatically generated index of the List Item



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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



521
522
523
524
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 521

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



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

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



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

def revision
  @properties['revision']
end

#service_sid ⇒ String

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

Returns:

  • (String) —

    The SID of the Sync Service that the resource is associated with



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

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



514
515
516
517
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 514

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 (Hash) (defaults to: :unset) —

    A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16KB 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, before the List Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is ‘0`, which means the List Item does not expire. The List Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources’s deletion.

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

    How long, in seconds, before the List Item’s parent Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is ‘0`, which means the parent Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources’s deletion.

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

    The If-Match HTTP request header

Returns:



502
503
504
505
506
507
508
509
510
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 502

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



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

def url
  @properties['url']
end