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

Inherits:
InstanceContext
  • 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, service_sid, list_sid, index) ⇒ SyncListItemContext

Initialize the SyncListItemContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The service_sid

  • list_sid (String) —

    The list_sid

  • index (String) —

    The index



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 217

def initialize(version, service_sid, list_sid, index)
  super(version)

  # Path Solution
  @solution = {
      service_sid: service_sid,
      list_sid: list_sid,
      index: index,
  }
  @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Items/#{@solution[:index]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the SyncListItemInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



253
254
255
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 253

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ SyncListItemInstance

Fetch a SyncListItemInstance

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 232

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  SyncListItemInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      list_sid: @solution[:list_sid],
      index: @solution[:index],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



283
284
285
286
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 283

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.Sync.SyncListItemContext #{context}>"
end

#update(data: nil) ⇒ SyncListItemInstance

Update the SyncListItemInstance

Parameters:

  • data (Hash) (defaults to: nil) —

    The data

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 261

def update(data: nil)
  data = Twilio::Values.of({
      'Data' => Twilio.serialize_object(data),
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  SyncListItemInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      list_sid: @solution[:list_sid],
      index: @solution[:index],
  )
end