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


194
195
196
197
198
199
200
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 194

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(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


221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 221

def delete(if_match: :unset)
  headers = Twilio::Values.of({'If-Match' => if_match, })

   @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ SyncListItemInstance

Fetch the SyncListItemInstance

Returns:


205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 205

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


256
257
258
259
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 256

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

#to_s ⇒ Object

Provide a user friendly representation


249
250
251
252
 
# File 'lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb', line 249

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


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

def update(data: nil, if_match: :unset)
  data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), })
  headers = Twilio::Values.of({'If-Match' => if_match, })

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

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