Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_map.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb,
lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb

Defined Under Namespace

Classes: SyncMapItemContext, SyncMapItemInstance, SyncMapItemInstanceMetadata, SyncMapItemList, SyncMapItemListResponse, SyncMapItemPage, SyncMapItemPageMetadata, SyncMapPermissionContext, SyncMapPermissionInstance, SyncMapPermissionInstanceMetadata, SyncMapPermissionList, SyncMapPermissionListResponse, SyncMapPermissionPage, SyncMapPermissionPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ SyncMapContext

Initialize the SyncMapContext



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

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

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

    # Dependents
    @sync_map_items = nil
    @sync_map_permissions = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the SyncMapInstance



247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 247

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

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

#delete_with_metadata ⇒ Boolean

Delete the SyncMapInstanceMetadata



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 260

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      syncMap_instance = SyncMapInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      SyncMapInstanceMetadata.new(@version, syncMap_instance, response.headers, response.status_code)
end

#fetch ⇒ SyncMapInstance

Fetch the SyncMapInstance



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 279

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    SyncMapInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ SyncMapInstance

Fetch the SyncMapInstanceMetadata



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 299

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    sync_map_instance = SyncMapInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
    SyncMapInstanceMetadata.new(
        @version,
        sync_map_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



436
437
438
439
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 436

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

#sync_map_items(key = :unset) ⇒ SyncMapItemList, SyncMapItemContext

Access the sync_map_items

Raises:

  • (ArgumentError) 


392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 392

def sync_map_items(key=:unset)

    raise ArgumentError, 'key cannot be nil' if key.nil?

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

    unless @sync_map_items
        @sync_map_items = SyncMapItemList.new(
            @version, service_sid: @solution[:service_sid], map_sid: @solution[:sid], )
    end

 @sync_map_items
end

#sync_map_permissions(identity = :unset) ⇒ SyncMapPermissionList, SyncMapPermissionContext

Access the sync_map_permissions

Raises:

  • (ArgumentError) 


411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 411

def sync_map_permissions(identity=:unset)

    raise ArgumentError, 'identity cannot be nil' if identity.nil?

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

    unless @sync_map_permissions
        @sync_map_permissions = SyncMapPermissionList.new(
            @version, service_sid: @solution[:service_sid], map_sid: @solution[:sid], )
    end

 @sync_map_permissions
end

#to_s ⇒ Object

Provide a user friendly representation



429
430
431
432
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 429

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

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

Update the SyncMapInstance



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 327

def update(
    ttl: :unset, 
    collection_ttl: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    SyncMapInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(ttl: :unset, collection_ttl: :unset) ⇒ SyncMapInstance

Update the SyncMapInstanceMetadata



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 357

def update_with_metadata(
  ttl: :unset, 
  collection_ttl: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    sync_map_instance = SyncMapInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        sid: @solution[:sid],
    )
    SyncMapInstanceMetadata.new(
        @version,
        sync_map_instance,
        response.headers,
        response.status_code
    )
end