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 unique SID identifier of the Service Instance that hosts this List object.

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

    The sid



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

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 unique SID identifier of the Twilio Account.

Returns:

  • (String) —

    The unique SID identifier of the Twilio Account.



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

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:



335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 335

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 List creator.

Returns:

  • (String) —

    The identity of the List creator.



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

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_created
  @properties['date_created']
end

#date_expires ⇒ Time

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

Returns:

  • (Time) —

    Contains the date this List expires and gets deleted automatically.



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

def date_expires
  @properties['date_expires']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the SyncListInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ SyncListInstance

Fetch a SyncListInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns A dictionary of URL links to nested resources of this List.

Returns:

  • (String) —

    A dictionary of URL links to nested resources of this List.



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

def links
  @properties['links']
end

#revision ⇒ String

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

Returns:

  • (String) —

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



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

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.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

    The unique 34-character SID identifier of the List.



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

def sid
  @properties['sid']
end

#sync_list_items ⇒ sync_list_items

Access the sync_list_items

Returns:



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

def sync_list_items
  context.sync_list_items
end

#sync_list_permissions ⇒ sync_list_permissions

Access the sync_list_permissions

Returns:



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

def sync_list_permissions
  context.sync_list_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

Returns The unique and addressable name of this List.

Returns:

  • (String) —

    The unique and addressable name of this List.



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

def unique_name
  @properties['unique_name']
end

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

Update the SyncListInstance

Parameters:

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

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

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

    Time-to-live of this List in seconds, defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity.

Returns:



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

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

#url ⇒ String

Returns The absolute URL for this List.

Returns:

  • (String) —

    The absolute URL for this List.



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

def url
  @properties['url']
end