Class: Twilio::REST::Sync::V1::ServiceContext::SyncListContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_list.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_item.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_list/sync_list_permission.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: SyncListItemContext, SyncListItemInstance, SyncListItemList, SyncListItemPage, SyncListPermissionContext, SyncListPermissionInstance, SyncListPermissionList, SyncListPermissionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ SyncListContext

Initialize the SyncListContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) with the Sync List resource to fetch.

  • sid (String) —

    The SID of the Sync List resource to fetch.



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 193

def initialize(version, service_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:sid]}"

  # Dependents
  @sync_list_items = nil
  @sync_list_permissions = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the SyncListInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



223
224
225
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 223

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

#fetch ⇒ SyncListInstance

Fetch a SyncListInstance

Returns:



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 208

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

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

  SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



301
302
303
304
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 301

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

#sync_list_items(index = :unset) ⇒ SyncListItemList, SyncListItemContext

Access the sync_list_items

Returns:

Raises:

  • (ArgumentError) 


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 252

def sync_list_items(index=:unset)
  raise ArgumentError, 'index cannot be nil' if index.nil?

  if index != :unset
    return SyncListItemContext.new(@version, @solution[:service_sid], @solution[:sid], index, )
  end

  unless @sync_list_items
    @sync_list_items = SyncListItemList.new(
        @version,
        service_sid: @solution[:service_sid],
        list_sid: @solution[:sid],
    )
  end

  @sync_list_items
end

#sync_list_permissions(identity = :unset) ⇒ SyncListPermissionList, SyncListPermissionContext

Access the sync_list_permissions

Returns:

Raises:

  • (ArgumentError) 


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 274

def sync_list_permissions(identity=:unset)
  raise ArgumentError, 'identity cannot be nil' if identity.nil?

  if identity != :unset
    return SyncListPermissionContext.new(@version, @solution[:service_sid], @solution[:sid], identity, )
  end

  unless @sync_list_permissions
    @sync_list_permissions = SyncListPermissionList.new(
        @version,
        service_sid: @solution[:service_sid],
        list_sid: @solution[:sid],
    )
  end

  @sync_list_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



294
295
296
297
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 294

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

#update(ttl: :unset, collection_ttl: :unset) ⇒ SyncListInstance

Update the SyncListInstance

Parameters:

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

    An alias for ‘collection_ttl`. If both are provided, this value is ignored.

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

    How long, in seconds, before the Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is ‘0`, which means the Sync List does not expire. The Sync List might not be deleted immediately after it expires.

Returns:



236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 236

def update(ttl: :unset, collection_ttl: :unset)
  data = Twilio::Values.of({'Ttl' => ttl, 'CollectionTtl' => collection_ttl, })

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

  SyncListInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end