Module: PaypalAPI::WebhookEvents::APIs

Included in:
PaypalAPI::WebhookEvents, PaypalAPI::WebhookEvents
Defined in:
lib/paypal-api/api_collections/webhook_events.rb

Overview

Common methods for PaypalAPI::WebhookEvents class and client.webhook_events instance

Instance Method Summary collapse

Instance Method Details

#available(query: nil, body: nil, headers: nil) ⇒ Response

Lists available events to which any webhook can subscribe

Parameters:

  • query (Hash, nil) (defaults to: nil) —

    Request query parameters

  • body (Hash, nil) (defaults to: nil) —

    Request body parameters

  • headers (Hash, nil) (defaults to: nil) —

    Request headers

Returns:

See Also:



24
25
26
 
# File 'lib/paypal-api/api_collections/webhook_events.rb', line 24

def available(query: nil, body: nil, headers: nil)
  client.get("/v1/notifications/webhooks-event-types", query: query, body: body, headers: headers)
end

#list(query: nil, body: nil, headers: nil) ⇒ Response

List event notifications

Parameters:

  • query (Hash, nil) (defaults to: nil) —

    Request query parameters

  • body (Hash, nil) (defaults to: nil) —

    Request body parameters

  • headers (Hash, nil) (defaults to: nil) —

    Request headers

Returns:

See Also:



35
36
37
 
# File 'lib/paypal-api/api_collections/webhook_events.rb', line 35

def list(query: nil, body: nil, headers: nil)
  client.get("/v1/notifications/webhooks-events", query: query, body: body, headers: headers)
end

#resend(event_id, query: nil, body: nil, headers: nil) ⇒ Response

Resend event notification

Parameters:

  • event_id (String) —

    Event ID

  • query (Hash, nil) (defaults to: nil) —

    Request query parameters

  • body (Hash, nil) (defaults to: nil) —

    Request body parameters

  • headers (Hash, nil) (defaults to: nil) —

    Request headers

Returns:

See Also:



59
60
61
 
# File 'lib/paypal-api/api_collections/webhook_events.rb', line 59

def resend(event_id, query: nil, body: nil, headers: nil)
  client.post("/v1/notifications/webhooks-events/#{encode(event_id)}/resend", query: query, body: body, headers: headers)
end

#show(event_id, query: nil, body: nil, headers: nil) ⇒ Response

Show event notification details

Parameters:

  • event_id (String) —

    Event ID

  • query (Hash, nil) (defaults to: nil) —

    Request query parameters

  • body (Hash, nil) (defaults to: nil) —

    Request body parameters

  • headers (Hash, nil) (defaults to: nil) —

    Request headers

Returns:

See Also:



47
48
49
 
# File 'lib/paypal-api/api_collections/webhook_events.rb', line 47

def show(event_id, query: nil, body: nil, headers: nil)
  client.get("/v1/notifications/webhooks-events/#{encode(event_id)}", query: query, body: body, headers: headers)
end

#simulate(query: nil, body: nil, headers: nil) ⇒ Response

Simulate webhook event

Parameters:

  • query (Hash, nil) (defaults to: nil) —

    Request query parameters

  • body (Hash, nil) (defaults to: nil) —

    Request body parameters

  • headers (Hash, nil) (defaults to: nil) —

    Request headers

Returns:

See Also:



70
71
72
 
# File 'lib/paypal-api/api_collections/webhook_events.rb', line 70

def simulate(query: nil, body: nil, headers: nil)
  client.post("/v1/notifications/simulate-event", query: query, body: body, headers: headers)
end