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

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


326
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
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 326

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


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

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:


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

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


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

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


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

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


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

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the SyncListItemInstance

Parameters:

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


449
450
451
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 449

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

#fetch ⇒ SyncListItemInstance

Fetch the SyncListItemInstance

Returns:


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

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


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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


491
492
493
494
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 491

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


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

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


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

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


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

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation


484
485
486
487
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 484

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 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, before the List Item expires (time-to-live) and is deleted.

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

Returns:


472
473
474
475
476
477
478
479
480
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb', line 472

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


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

def url
  @properties['url']
end