Class: Twilio::REST::Conversations::V1::ConversationContext::WebhookContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(version, conversation_sid, sid) ⇒ WebhookContext

Initialize the WebhookContext

Parameters:



193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 193

def initialize(version, conversation_sid, sid)
  super(version)

  # Path Solution
  @solution = {conversation_sid: conversation_sid, sid: sid, }
  @uri = "/Conversations/#{@solution[:conversation_sid]}/Webhooks/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Delete the WebhookInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



250
251
252
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 250

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

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 204

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



263
264
265
266
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 263

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

#to_s ⇒ Object

Provide a user friendly representation



256
257
258
259
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 256

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

#update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset) ⇒ WebhookInstance

Update the WebhookInstance

Parameters:

  • configuration_url (String) (defaults to: :unset) —

    The absolute url the webhook request should be sent to.

  • configuration_method (webhook.Method) (defaults to: :unset) —

    The HTTP method to be used when sending a webhook request.

  • configuration_filters (String) (defaults to: :unset) —

    The list of events, firing webhook event for this Conversation.

  • configuration_triggers (String) (defaults to: :unset) —

    The list of keywords, firing webhook event for this Conversation.

  • configuration_flow_sid (String) (defaults to: :unset) —

    The studio flow sid, where the webhook should be sent to.

Returns:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 228

def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset)
  data = Twilio::Values.of({
      'Configuration.Url' => configuration_url,
      'Configuration.Method' => configuration_method,
      'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
      'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
      'Configuration.FlowSid' => configuration_flow_sid,
  })

  payload = @version.update('POST', @uri, data: data)

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