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.



243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 243

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



258
259
260
261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 258

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 271

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:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 290

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:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 309

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



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

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:



393
394
395
396
397
398
399
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 393

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:



404
405
406
407
408
409
410
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 404

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



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

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:



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 335

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:



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
387
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 361

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