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](www.twilio.com/docs/sync/api/service) with the Sync List resource to update.

  • sid (String) —

    The SID of the Sync List resource to update. Can be the Sync List resource’s ‘sid` or its `unique_name`.



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 161

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_permissions = nil
    @sync_list_items = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the SyncListInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



175
176
177
178
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 175

def delete

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

#fetch ⇒ SyncListInstance

Fetch the SyncListInstance

Returns:



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

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



266
267
268
269
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 266

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) 


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 241

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) 


222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 222

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



259
260
261
262
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 259

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](www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted.

Returns:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_list.rb', line 199

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