Class: Twilio::REST::Sync::V1::ServiceContext::SyncListInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_list.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, sid: nil) ⇒ SyncListInstance

Initialize the SyncListInstance

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](www.twilio.com/docs/sync/api/service) the resource is associated with.

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

    The SID of the Sync List resource to fetch.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 304

def initialize(version, payload, service_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'unique_name' => payload['unique_name'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'url' => payload['url'],
      'links' => payload['links'],
      'revision' => payload['revision'],
      '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, 'sid' => sid || @properties['sid'], }
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



352
353
354
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 352

def 
  @properties['account_sid']
end

#context ⇒ SyncListContext

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

Returns:



331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 331

def context
  unless @instance_context
    @instance_context = SyncListContext.new(@version, @params['service_sid'], @params['sid'], )
  end
  @instance_context
end

#created_by ⇒ String

Returns The identity of the Sync List’s creator.

Returns:

  • (String) —

    The identity of the Sync List’s creator



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

def created_by
  @properties['created_by']
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



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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

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

Returns:

  • (Time) —

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SyncListInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ SyncListInstance

Fetch the SyncListInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



455
456
457
458
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 455

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

#links ⇒ String

Returns The URLs of the Sync List’s nested resources.

Returns:

  • (String) —

    The URLs of the Sync List’s nested resources



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

def links
  @properties['links']
end

#revision ⇒ String

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

Returns:

  • (String) —

    The current revision of the Sync List, represented as a string



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

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



358
359
360
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 358

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#sync_list_items ⇒ sync_list_items

Access the sync_list_items

Returns:



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

def sync_list_items
  context.sync_list_items
end

#sync_list_permissions ⇒ sync_list_permissions

Access the sync_list_permissions

Returns:



442
443
444
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 442

def sync_list_permissions
  context.sync_list_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource



346
347
348
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 346

def unique_name
  @properties['unique_name']
end

#update(ttl: :unset, collection_ttl: :unset) ⇒ SyncListInstance

Update the SyncListInstance

Parameters:

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

    An alias for ‘collection_ttl`. If both are provided, this value is ignored.

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

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

Returns:



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

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

#url ⇒ String

Returns The absolute URL of the Sync List resource.

Returns:

  • (String) —

    The absolute URL of the Sync List resource



364
365
366
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 364

def url
  @properties['url']
end