Module: PaypalAPI::WebhookLookups::APIs

Included in:
PaypalAPI::WebhookLookups, PaypalAPI::WebhookLookups
Defined in:
lib/paypal-api/api_collections/webhook_lookups.rb

Overview

Common methods for PaypalAPI::WebhookLookups class and client.webhook_lookups instance

Instance Method Summary collapse

Instance Method Details

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

Create webhook lookup

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:



25
26
27
 
# File 'lib/paypal-api/api_collections/webhook_lookups.rb', line 25

def create(query: nil, body: nil, headers: nil)
  client.post("/v1/notifications/webhooks-lookup", query: query, body: body, headers: headers)
end

#delete(webhook_lookup_id, query: nil, body: nil, headers: nil) ⇒ Response

Delete webhook lookup

Parameters:

  • webhook_lookup_id (String) —

    Webhook lookup 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:



60
61
62
 
# File 'lib/paypal-api/api_collections/webhook_lookups.rb', line 60

def delete(webhook_lookup_id, query: nil, body: nil, headers: nil)
  client.delete("/v1/notifications/webhooks-lookup/#{encode(webhook_lookup_id)}", query: query, body: body, headers: headers)
end

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

List webhook lookups

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:



36
37
38
 
# File 'lib/paypal-api/api_collections/webhook_lookups.rb', line 36

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

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

Show webhook lookup details

Parameters:

  • webhook_lookup_id (String) —

    Webhook lookup 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:



48
49
50
 
# File 'lib/paypal-api/api_collections/webhook_lookups.rb', line 48

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