org.wisepersist.pinpayments.api.impl

Class WebhookEndpointsApiImpl

java.lang.Object

org.wisepersist.pinpayments.api.impl.AbstractBaseApi

org.wisepersist.pinpayments.api.impl.WebhookEndpointsApiImpl

All Implemented Interfaces:

WebhookEndpointsApi

public class WebhookEndpointsApiImpl
extends AbstractBaseApi
implements WebhookEndpointsApi

Implementation of WebhookEndpointsApi interface.

Constructor Summary

Constructors

Constructor and Description
WebhookEndpointsApiImpl()

Method Summary

Modifier and Type	Method and Description
WebhookEndpointResponse	create(WebhookEndpoint endpoint) Creates a new webhook endpoint and returns its details.
DeletionResult	delete(java.lang.String endpointToken) Deletes a webhook endpoint and all of its webhook requests.
WebhookEndpointResponse	fetch(java.lang.String endpointToken) Returns the details of a webhook endpoint.
protected java.lang.String	getApiName()
WebhookEndpointListResponse	list(int page) Returns a paginated list of all webhook endpoints.

Methods inherited from class org.wisepersist.pinpayments.api.impl.AbstractBaseApi

executeList, executeSearch, getApiBase, getApiUrl, getDeletionResult, httpTransportForDelete, httpTransportForGet, httpTransportForPost, httpTransportForPut

Methods inherited from class java.lang.Object

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

Constructor Detail

WebhookEndpointsApiImpl

public WebhookEndpointsApiImpl()

Method Detail

create

public final WebhookEndpointResponse create(WebhookEndpoint endpoint)
                                     throws java.io.IOException

Description copied from interface: WebhookEndpointsApi

Creates a new webhook endpoint and returns its details.

Specified by:

create in interface WebhookEndpointsApi

Parameters:

endpoint - The endpoint specified.

Returns:

The details of the endpoint created.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

list

public final WebhookEndpointListResponse list(int page)
                                       throws java.io.IOException

Description copied from interface: WebhookEndpointsApi

Returns a paginated list of all webhook endpoints.

Specified by:

list in interface WebhookEndpointsApi

Parameters:

page - The page number specified.

Returns:

A paginated list of all webhook endpoints.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

fetch

public final WebhookEndpointResponse fetch(java.lang.String endpointToken)
                                    throws java.io.IOException

Description copied from interface: WebhookEndpointsApi

Returns the details of a webhook endpoint.

Specified by:

fetch in interface WebhookEndpointsApi

Parameters:

endpointToken - The endpoint token specified.

Returns:

The details of the webhook endpoint fetched.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

delete

public final DeletionResult delete(java.lang.String endpointToken)
                            throws java.io.IOException

Description copied from interface: WebhookEndpointsApi

Deletes a webhook endpoint and all of its webhook requests. You will not be able to recover them.

Specified by:

delete in interface WebhookEndpointsApi

Parameters:

endpointToken - The endpoint token specified.

Returns:

The deletion result.

Throws:

java.io.IOException - If IO errors occur while calling PinPayments REST API.

getApiName

protected final java.lang.String getApiName()

Specified by:

getApiName in class AbstractBaseApi