Class: Twilio::REST::Preview::Sync::ServiceContext::SyncListContext::SyncListItemInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/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

  • account_sid (String)

    The SID of the Account that created this SyncListItem resource.

  • sid (String)

    The SID of the Call resource to fetch.



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

def initialize(version, payload , service_sid: nil, list_sid: nil, index: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'index' => payload['index'] == nil ? payload['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_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  || @properties['service_sid']  ,'list_sid' => list_sid  || @properties['list_sid']  ,'index' => index  || @properties['index']  , }
end

Instance Method Details

#account_sidString

Returns:

  • (String)


334
335
336
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 334

def 
    @properties['account_sid']
end

#contextSyncListItemContext

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

Returns:



319
320
321
322
323
324
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 319

def context
    unless @instance_context
        @instance_context = SyncListItemContext.new(@version , @params['service_sid'], @params['list_sid'], @params['index'])
    end
    @instance_context
end

#created_byString

Returns:

  • (String)


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

def created_by
    @properties['created_by']
end

#dataHash

Returns:

  • (Hash)


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

def data
    @properties['data']
end

#date_createdTime

Returns:

  • (Time)


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

def date_created
    @properties['date_created']
end

#date_updatedTime

Returns:

  • (Time)


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

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the SyncListItemInstance

Parameters:

  • if_match (String) (defaults to: :unset)

    The If-Match HTTP request header

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



390
391
392
393
394
395
396
397
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 390

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetchSyncListItemInstance

Fetch the SyncListItemInstance

Returns:



402
403
404
405
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 402

def fetch

    context.fetch
end

#indexString

Returns:

  • (String)


328
329
330
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 328

def index
    @properties['index']
end

#inspectObject

Provide a detailed, user friendly representation



432
433
434
435
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 432

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

#list_sidString

Returns:

  • (String)


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

def list_sid
    @properties['list_sid']
end

#revisionString

Returns:

  • (String)


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

def revision
    @properties['revision']
end

#service_sidString

Returns:

  • (String)


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

def service_sid
    @properties['service_sid']
end

#to_sObject

Provide a user friendly representation



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

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

#update(data: nil, if_match: :unset) ⇒ SyncListItemInstance

Update the SyncListItemInstance

Parameters:

  • data (Object) (defaults to: nil)
  • if_match (String) (defaults to: :unset)

    The If-Match HTTP request header

Returns:



412
413
414
415
416
417
418
419
420
421
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 412

def update(
    data: nil, 
    if_match: :unset
)

    context.update(
        data: data, 
        if_match: if_match, 
    )
end

#urlString

Returns:

  • (String)


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

def url
    @properties['url']
end