Class: Twilio::REST::Messaging::V1::SessionContext::WebhookContext

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, session_sid, sid) ⇒ WebhookContext

Initialize the WebhookContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • session_sid (String) —

    The unique id of the [Session](www.twilio.com/docs/sessions/api/session) for this webhook.

  • sid (String) —

    A 34 character string that uniquely identifies this resource.



208
209
210
211
212
213
214
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 208

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

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

Instance Method Details

#delete ⇒ Boolean

Deletes the WebhookInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



274
275
276
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 274

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

#fetch ⇒ WebhookInstance

Fetch a WebhookInstance

Returns:



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 219

def fetch
  params = Twilio::Values.of({})

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



287
288
289
290
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 287

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

#to_s ⇒ Object

Provide a user friendly representation



280
281
282
283
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 280

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

#update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset, configuration_buffer_messages: :unset, configuration_buffer_window: :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 Session.

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

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

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

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

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

    The number of retries in case of webhook request failures. Maximum 3 retries are allowed, the default value is 0.

  • configuration_buffer_messages (Boolean) (defaults to: :unset) —

    The flag whether buffering should be applied to messages. Not set by default

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

    The period of buffering messages. Default is 3000 ms.

Returns:



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 250

def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset, configuration_buffer_messages: :unset, configuration_buffer_window: :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,
      'Configuration.RetryCount' => configuration_retry_count,
      'Configuration.BufferMessages' => configuration_buffer_messages,
      'Configuration.BufferWindow' => configuration_buffer_window,
  })

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

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