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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

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

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

    The service_sid

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

    The list_sid

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

    The index


273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 273

def initialize(version, payload, service_sid: nil, list_sid: nil, index: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      '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,
      'list_sid' => list_sid,
      'index' => index || @properties['index'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid


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

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:


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 303

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 The created_by.

Returns:

  • (String) —

    The created_by


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

def created_by
  @properties['created_by']
end

#data ⇒ Hash

Returns The data.

Returns:

  • (Hash) —

    The data


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

def data
  @properties['data']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created


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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated


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

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


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

def delete(if_match: :unset)
  context.delete(if_match: if_match, )
end

#fetch ⇒ SyncListItemInstance

Fetch the SyncListItemInstance

Returns:


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

def fetch
  context.fetch
end

#index ⇒ String

Returns The index.

Returns:

  • (String) —

    The index


317
318
319
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 317

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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

#list_sid ⇒ String

Returns The list_sid.

Returns:

  • (String) —

    The list_sid


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

def list_sid
  @properties['list_sid']
end

#revision ⇒ String

Returns The revision.

Returns:

  • (String) —

    The revision


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

def revision
  @properties['revision']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid


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

def service_sid
  @properties['service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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 (Hash) (defaults to: nil) —

    The data

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

    The If-Match HTTP request header

Returns:


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

def update(data: nil, if_match: :unset)
  context.update(data: data, if_match: if_match, )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url


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

def url
  @properties['url']
end