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.



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

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_sid ⇒ String

Returns:

  • (String) 


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

def 
    @properties['account_sid']
end

#context ⇒ SyncListItemContext

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

Returns:



323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 323

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

#created_by ⇒ String

Returns:

  • (String) 


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

def created_by
    @properties['created_by']
end

#data ⇒ Hash

Returns:

  • (Hash) 


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

def data
    @properties['data']
end

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

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



394
395
396
397
398
399
400
401
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 394

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ SyncListItemInstance

Fetch the SyncListItemInstance

Returns:



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

def fetch

    context.fetch
end

#index ⇒ String

Returns:

  • (String) 


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

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#list_sid ⇒ String

Returns:

  • (String) 


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

def list_sid
    @properties['list_sid']
end

#revision ⇒ String

Returns:

  • (String) 


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

def revision
    @properties['revision']
end

#service_sid ⇒ String

Returns:

  • (String) 


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

def service_sid
    @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



416
417
418
419
420
421
422
423
424
425
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 416

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

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

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end