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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_list.rb

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. Can be the Sync List resource's `sid` or its `unique_name`.


294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 294

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


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

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:


321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 321

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


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

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


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

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SyncListInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetch ⇒ SyncListInstance

Fetch the SyncListInstance

Returns:


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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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


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

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


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

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


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

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


330
331
332
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 330

def sid
  @properties['sid']
end

#sync_list_items ⇒ sync_list_items

Access the sync_list_items

Returns:


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

def sync_list_items
  context.sync_list_items
end

#sync_list_permissions ⇒ sync_list_permissions

Access the sync_list_permissions

Returns:


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

def sync_list_permissions
  context.sync_list_permissions
end

#to_s ⇒ Object

Provide a user friendly representation


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

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


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

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.

Returns:


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

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


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

def url
  @properties['url']
end