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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: SinkTestInstance, SinkTestList, SinkTestPage, SinkValidateInstance, SinkValidateList, SinkValidatePage

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.



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 175

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



199
200
201
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 199

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

#fetch ⇒ SinkInstance

Fetch the SinkInstance

Returns:



190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 190

def fetch
  payload = @version.fetch('GET', @uri)

  SinkInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



236
237
238
239
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 236

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:



207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 207

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:



219
220
221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 219

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



229
230
231
232
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 229

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