Class: Hookdeck::Resources::Event

Inherits:

Base

• Object
• Base
• Hookdeck::Resources::Event

Defined in:

lib/hookdeck/resources/event.rb

Instance Attribute Summary

Attributes inherited from Base

#client

Instance Method Summary

• #list(params = {}) ⇒ Object

  List all events.

• #mute(id, params = {}) ⇒ Object

  Mute an event.

• #retrieve(id) ⇒ Object

  Retrieve a single event.

• #retry(id, params = {}) ⇒ Object

  Retry an event.

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from Hookdeck::Resources::Base

Instance Method Details

#list(params = {}) ⇒ Object

List all events

# File 'lib/hookdeck/resources/event.rb', line 5

def list(params = {})
  get('events', params)
end

#mute(id, params = {}) ⇒ Object

Mute an event

# File 'lib/hookdeck/resources/event.rb', line 23

def mute(id, params = {})
  validate_id!(id, 'evt_')
  put("events/#{id}/mute", params)
end

#retrieve(id) ⇒ Object

Retrieve a single event

Parameters:

• id (String) —

  Event ID

# File 'lib/hookdeck/resources/event.rb', line 11

def retrieve(id)
  validate_id!(id, 'evt_')
  get("events/#{id}")
end

#retry(id, params = {}) ⇒ Object

Retry an event

# File 'lib/hookdeck/resources/event.rb', line 17

def retry(id, params = {})
  validate_id!(id, 'evt_')
  post("events/#{id}/retry", params)
end