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

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 with the Sync List resource to fetch.

  • sid (String) —

    The SID of the Sync List resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`.


180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 180

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

Delete the SyncListInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


204
205
206
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 204

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

#fetch ⇒ SyncListInstance

Fetch the SyncListInstance

Returns:


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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


277
278
279
280
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 277

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) 

228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 228

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) 

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

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


270
271
272
273
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 270

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.

Returns:


216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 216

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