Package com.adyen.service.management

Class WebhooksCompanyLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.WebhooksCompanyLevelApi

public class WebhooksCompanyLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
WebhooksCompanyLevelApi(Client client)	Webhooks - company level constructor in package.
WebhooksCompanyLevelApi(Client client, String baseURL)	Webhooks - company level constructor in package.

Method Summary

Modifier and Type	Method	Description
GenerateHmacKeyResponse	generateHmacKey(String companyId, String webhookId)	Generate an HMAC key
GenerateHmacKeyResponse	generateHmacKey(String companyId, String webhookId, RequestOptions requestOptions)	Generate an HMAC key
Webhook	getWebhook(String companyId, String webhookId)	Get a webhook
Webhook	getWebhook(String companyId, String webhookId, RequestOptions requestOptions)	Get a webhook
ListWebhooksResponse	listAllWebhooks(String companyId)	List all webhooks
ListWebhooksResponse	listAllWebhooks(String companyId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions)	List all webhooks
void	removeWebhook(String companyId, String webhookId)	Remove a webhook
void	removeWebhook(String companyId, String webhookId, RequestOptions requestOptions)	Remove a webhook
Webhook	setUpWebhook(String companyId, CreateCompanyWebhookRequest createCompanyWebhookRequest)	Set up a webhook
Webhook	setUpWebhook(String companyId, CreateCompanyWebhookRequest createCompanyWebhookRequest, RequestOptions requestOptions)	Set up a webhook
TestWebhookResponse	testWebhook(String companyId, String webhookId, TestCompanyWebhookRequest testCompanyWebhookRequest)	Test a webhook
TestWebhookResponse	testWebhook(String companyId, String webhookId, TestCompanyWebhookRequest testCompanyWebhookRequest, RequestOptions requestOptions)	Test a webhook
Webhook	updateWebhook(String companyId, String webhookId, UpdateCompanyWebhookRequest updateCompanyWebhookRequest)	Update a webhook
Webhook	updateWebhook(String companyId, String webhookId, UpdateCompanyWebhookRequest updateCompanyWebhookRequest, RequestOptions requestOptions)	Update a webhook

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

baseURL

protected String baseURL

Constructor Detail

WebhooksCompanyLevelApi

public WebhooksCompanyLevelApi(Client client)

Webhooks - company level constructor in package.

Parameters:

client - Client (required)

WebhooksCompanyLevelApi

public WebhooksCompanyLevelApi(Client client,
                               String baseURL)

Webhooks - company level constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

generateHmacKey

public GenerateHmacKeyResponse generateHmacKey(String companyId,
                                               String webhookId)
                                        throws ApiException,
                                               IOException

Generate an HMAC key

Parameters:

companyId - String The unique identifier of the company account. (required)

webhookId - String Unique identifier of the webhook configuration. (required)

Returns:

GenerateHmacKeyResponse

Throws:

ApiException - if fails to make API call

IOException

generateHmacKey

public GenerateHmacKeyResponse generateHmacKey(String companyId,
                                               String webhookId,
                                               RequestOptions requestOptions)
                                        throws ApiException,
                                               IOException

Generate an HMAC key

Parameters:

companyId - String The unique identifier of the company account. (required)

webhookId - String Unique identifier of the webhook configuration. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

GenerateHmacKeyResponse

Throws:

ApiException - if fails to make API call

IOException

getWebhook

public Webhook getWebhook(String companyId,
                          String webhookId)
                   throws ApiException,
                          IOException

Get a webhook

Parameters:

companyId - String Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required)

webhookId - String Unique identifier of the webhook configuration. (required)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

getWebhook

public Webhook getWebhook(String companyId,
                          String webhookId,
                          RequestOptions requestOptions)
                   throws ApiException,
                          IOException

Get a webhook

Parameters:

companyId - String Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required)

webhookId - String Unique identifier of the webhook configuration. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

listAllWebhooks

public ListWebhooksResponse listAllWebhooks(String companyId)
                                     throws ApiException,
                                            IOException

List all webhooks

Parameters:

companyId - String Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required)

Returns:

ListWebhooksResponse

Throws:

ApiException - if fails to make API call

IOException

listAllWebhooks

public ListWebhooksResponse listAllWebhooks(String companyId,
                                            Integer pageNumber,
                                            Integer pageSize,
                                            RequestOptions requestOptions)
                                     throws ApiException,
                                            IOException

List all webhooks

Parameters:

companyId - String Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required)

pageNumber - Integer Query: The number of the page to fetch. (optional)

pageSize - Integer Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

ListWebhooksResponse

Throws:

ApiException - if fails to make API call

IOException

removeWebhook

public void removeWebhook(String companyId,
                          String webhookId)
                   throws ApiException,
                          IOException

Remove a webhook

Parameters:

companyId - String The unique identifier of the company account. (required)

webhookId - String Unique identifier of the webhook configuration. (required)

Throws:

ApiException - if fails to make API call

IOException

removeWebhook

public void removeWebhook(String companyId,
                          String webhookId,
                          RequestOptions requestOptions)
                   throws ApiException,
                          IOException

Remove a webhook

Parameters:

companyId - String The unique identifier of the company account. (required)

webhookId - String Unique identifier of the webhook configuration. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Throws:

ApiException - if fails to make API call

IOException

setUpWebhook

public Webhook setUpWebhook(String companyId,
                            CreateCompanyWebhookRequest createCompanyWebhookRequest)
                     throws ApiException,
                            IOException

Set up a webhook

Parameters:

companyId - String Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required)

createCompanyWebhookRequest - CreateCompanyWebhookRequest (required)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

setUpWebhook

public Webhook setUpWebhook(String companyId,
                            CreateCompanyWebhookRequest createCompanyWebhookRequest,
                            RequestOptions requestOptions)
                     throws ApiException,
                            IOException

Set up a webhook

Parameters:

companyId - String Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required)

createCompanyWebhookRequest - CreateCompanyWebhookRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

testWebhook

public TestWebhookResponse testWebhook(String companyId,
                                       String webhookId,
                                       TestCompanyWebhookRequest testCompanyWebhookRequest)
                                throws ApiException,
                                       IOException

Test a webhook

Parameters:

companyId - String The unique identifier of the company account. (required)

webhookId - String Unique identifier of the webhook configuration. (required)

testCompanyWebhookRequest - TestCompanyWebhookRequest (required)

Returns:

TestWebhookResponse

Throws:

ApiException - if fails to make API call

IOException

testWebhook

public TestWebhookResponse testWebhook(String companyId,
                                       String webhookId,
                                       TestCompanyWebhookRequest testCompanyWebhookRequest,
                                       RequestOptions requestOptions)
                                throws ApiException,
                                       IOException

Test a webhook

Parameters:

companyId - String The unique identifier of the company account. (required)

webhookId - String Unique identifier of the webhook configuration. (required)

testCompanyWebhookRequest - TestCompanyWebhookRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

TestWebhookResponse

Throws:

ApiException - if fails to make API call

IOException

updateWebhook

public Webhook updateWebhook(String companyId,
                             String webhookId,
                             UpdateCompanyWebhookRequest updateCompanyWebhookRequest)
                      throws ApiException,
                             IOException

Update a webhook

Parameters:

companyId - String The unique identifier of the company account. (required)

webhookId - String Unique identifier of the webhook configuration. (required)

updateCompanyWebhookRequest - UpdateCompanyWebhookRequest (required)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException

updateWebhook

public Webhook updateWebhook(String companyId,
                             String webhookId,
                             UpdateCompanyWebhookRequest updateCompanyWebhookRequest,
                             RequestOptions requestOptions)
                      throws ApiException,
                             IOException

Update a webhook

Parameters:

companyId - String The unique identifier of the company account. (required)

webhookId - String Unique identifier of the webhook configuration. (required)

updateCompanyWebhookRequest - UpdateCompanyWebhookRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

Webhook

Throws:

ApiException - if fails to make API call

IOException