class Twilio::REST::Conversations::V1::ConversationContext::WebhookContext

Public Class Methods

new(version, conversation_sid, sid) click to toggle source

Initialize the WebhookContext @param [Version] version Version that contains the resource @param [String] conversation_sid The unique ID of the

{Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
for this webhook.

@param [String] sid A 34 character string that uniquely identifies this

resource.

@return [WebhookContext] WebhookContext

Calls superclass method Twilio::REST::InstanceContext::new
    # File lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb
189 def initialize(version, conversation_sid, sid)
190   super(version)
191 
192   # Path Solution
193   @solution = {conversation_sid: conversation_sid, sid: sid, }
194   @uri = "/Conversations/#{@solution[:conversation_sid]}/Webhooks/#{@solution[:sid]}"
195 end

Public Instance Methods

delete() click to toggle source

Delete the WebhookInstance @return [Boolean] true if delete succeeds, false otherwise

    # File lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb
246 def delete
247    @version.delete('DELETE', @uri)
248 end
fetch() click to toggle source

Fetch the WebhookInstance @return [WebhookInstance] Fetched WebhookInstance

    # File lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb
200 def fetch
201   payload = @version.fetch('GET', @uri)
202 
203   WebhookInstance.new(
204       @version,
205       payload,
206       conversation_sid: @solution[:conversation_sid],
207       sid: @solution[:sid],
208   )
209 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb
259 def inspect
260   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
261   "#<Twilio.Conversations.V1.WebhookContext #{context}>"
262 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb
252 def to_s
253   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
254   "#<Twilio.Conversations.V1.WebhookContext #{context}>"
255 end
update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset) click to toggle source

Update the WebhookInstance @param [String] configuration_url The absolute url the webhook request should be

sent to.

@param [webhook.Method] configuration_method The HTTP method to be used when

sending a webhook request.

@param [Array] configuration_filters The list of events, firing webhook

event for this Conversation.

@param [Array] configuration_triggers The list of keywords, firing

webhook event for this Conversation.

@param [String] configuration_flow_sid The studio flow SID, where the webhook

should be sent to.

@return [WebhookInstance] Updated WebhookInstance

    # File lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb
224 def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset)
225   data = Twilio::Values.of({
226       'Configuration.Url' => configuration_url,
227       'Configuration.Method' => configuration_method,
228       'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
229       'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
230       'Configuration.FlowSid' => configuration_flow_sid,
231   })
232 
233   payload = @version.update('POST', @uri, data: data)
234 
235   WebhookInstance.new(
236       @version,
237       payload,
238       conversation_sid: @solution[:conversation_sid],
239       sid: @solution[:sid],
240   )
241 end