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 the resource is associated with.

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

    The SID of the Sync List resource to fetch.



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

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



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

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:



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

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



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

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



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SyncListInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ SyncListInstance

Fetch the SyncListInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

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



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

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



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

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



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

def sid
  @properties['sid']
end

#sync_list_items ⇒ sync_list_items

Access the sync_list_items

Returns:



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

def sync_list_items
  context.sync_list_items
end

#sync_list_permissions ⇒ sync_list_permissions

Access the sync_list_permissions

Returns:



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

def sync_list_permissions
  context.sync_list_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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:



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

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



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

def url
  @properties['url']
end