Class: Twilio::REST::Events::V1::SinkInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/events/v1/sink.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ SinkInstance

Initialize the SinkInstance



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

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'description' => payload['description'],
        'sid' => payload['sid'],
        'sink_configuration' => payload['sink_configuration'],
        'sink_type' => payload['sink_type'],
        'status' => payload['status'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#context ⇒ SinkContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 331

def context
    unless @instance_context
        @instance_context = SinkContext.new(@version , @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time 



340
341
342
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 340

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



346
347
348
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 346

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SinkInstance



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

def delete

    context.delete
end

#description ⇒ String 



352
353
354
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 352

def description
    @properties['description']
end

#fetch ⇒ SinkInstance

Fetch the SinkInstance



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



444
445
446
447
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 444

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Events.V1.SinkInstance #{values}>"
end

#links ⇒ Hash 



388
389
390
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 388

def links
    @properties['links']
end

#sid ⇒ String 



358
359
360
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 358

def sid
    @properties['sid']
end

#sink_configuration ⇒ Hash 



364
365
366
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 364

def sink_configuration
    @properties['sink_configuration']
end

#sink_test ⇒ sink_test

Access the sink_test



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

def sink_test
    context.sink_test
end

#sink_type ⇒ SinkType 



370
371
372
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 370

def sink_type
    @properties['sink_type']
end

#sink_validate ⇒ sink_validate

Access the sink_validate



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

def sink_validate
    context.sink_validate
end

#status ⇒ Status 



376
377
378
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 376

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



437
438
439
440
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 437

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Events.V1.SinkInstance #{values}>"
end

#update(description: nil) ⇒ SinkInstance

Update the SinkInstance



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

def update(
    description: nil
)

    context.update(
        description: description, 
    )
end

#url ⇒ String 



382
383
384
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 382

def url
    @properties['url']
end