Class: Hookdeck::Resources::BulkEventRetry

Inherits:
Base
  • Object
show all
Defined in:
lib/hookdeck/resources/bulk_event_retry.rb

Instance Attribute Summary

Attributes inherited from Base

#client

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

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

Instance Method Details

#cancel(id) ⇒ Object

Cancel a pending bulk retry

Parameters:

  • Bulk retry ID



18
19
20
21
 
# File 'lib/hookdeck/resources/bulk_event_retry.rb', line 18

def cancel(id)
  validate_id!(id, 'blkr_')
  post("bulk/events/retry/#{id}/cancel")
end

#create(params) ⇒ Object

Create a new bulk retry

Parameters:

  • Bulk retry attributes

Options Hash (params):

  • :event_ids (Array<String>) —

    Event IDs to retry

  • :config (Hash) —

    Override default retry configuration



27
28
29
 
# File 'lib/hookdeck/resources/bulk_event_retry.rb', line 27

def create(params)
  post('bulk/events/retry', params)
end

#list(params = {}) ⇒ Object

List all pending bulk retries



5
6
7
 
# File 'lib/hookdeck/resources/bulk_event_retry.rb', line 5

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

#plan(params) ⇒ Object

Get the plan for a bulk retry

Parameters:

  • Bulk retry planning parameters

Options Hash (params):

  • :event_ids (Array<String>) —

    Event IDs to plan for

  • :config (Hash) —

    Override default retry configuration



35
36
37
 
# File 'lib/hookdeck/resources/bulk_event_retry.rb', line 35

def plan(params)
  get('bulk/events/retry/plan', params)
end

#retrieve(id) ⇒ Object

Retrieve a single bulk retry

Parameters:

  • Bulk retry ID



11
12
13
14
 
# File 'lib/hookdeck/resources/bulk_event_retry.rb', line 11

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