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, 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.



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

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



186
187
188
189
190
191
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 186

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ SinkInstance

Fetch the SinkInstance

Returns:



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 196

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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:



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

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:



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

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



255
256
257
258
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 255

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:



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 212

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