Class: Twilio::REST::Events::V1::SinkContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/events/v1/sink.rb,
lib/twilio-ruby/rest/events/v1/sink/sink_test.rb,
lib/twilio-ruby/rest/events/v1/sink/sink_validate.rb

Defined Under Namespace

Classes: SinkTestInstance, SinkTestList, SinkTestListResponse, SinkTestPage, SinkTestPageMetadata, SinkValidateInstance, SinkValidateList, SinkValidateListResponse, SinkValidatePage, SinkValidatePageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ SinkContext

Initialize the SinkContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    A 34 character string that uniquely identifies this Sink.



251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 251

def initialize(version, sid)
    super(version)
    

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

    # Dependents
    @sink_test = nil
    @sink_validate = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the SinkInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 266

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 SinkInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete_with_metadata

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

#fetch ⇒ SinkInstance

Fetch the SinkInstance

Returns:



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 298

def fetch

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

#fetch_with_metadata ⇒ SinkInstance

Fetch the SinkInstanceMetadata

Returns:



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 317

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



429
430
431
432
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 429

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

#sink_test ⇒ SinkTestList, SinkTestContext

Access the sink_test

Returns:



401
402
403
404
405
406
407
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 401

def sink_test
  unless @sink_test
    @sink_test = SinkTestList.new(
            @version, sid: @solution[:sid], )
  end
  @sink_test
end

#sink_validate ⇒ SinkValidateList, SinkValidateContext

Access the sink_validate

Returns:



412
413
414
415
416
417
418
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 412

def sink_validate
  unless @sink_validate
    @sink_validate = SinkValidateList.new(
            @version, sid: @solution[:sid], )
  end
  @sink_validate
end

#to_s ⇒ Object

Provide a user friendly representation



422
423
424
425
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 422

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

#update(description: nil) ⇒ SinkInstance

Update the SinkInstance

Parameters:

  • description (String) (defaults to: nil) —

    A human readable description for the Sink **This value should not contain PII.**

Returns:



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 343

def update(
  description: nil
)

    data = Twilio::Values.of({
        'Description' => description,
    })

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

#update_with_metadata(description: nil) ⇒ SinkInstance

Update the SinkInstanceMetadata

Parameters:

  • description (String) (defaults to: nil) —

    A human readable description for the Sink **This value should not contain PII.**

Returns:



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 369

def update_with_metadata(
  description: nil
)

    data = Twilio::Values.of({
        'Description' => description,
    })

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