Package software.xdev.brevo.api

Class PaymentsApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.PaymentsApi

public class PaymentsApi
extends BaseApi

Field Summary

Fields inherited from class software.xdev.brevo.client.BaseApi

apiClient

Constructor Summary

Constructors

Constructor	Description
PaymentsApi()
PaymentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CreatePaymentResponse	createPaymentRequest(CreatePaymentRequest createPaymentRequest)	Create a payment request
CreatePaymentResponse	createPaymentRequest(CreatePaymentRequest createPaymentRequest, Map<String,String> additionalHeaders)	Create a payment request
void	deletePaymentRequest(UUID id)	Delete a payment request.
void	deletePaymentRequest(UUID id, Map<String,String> additionalHeaders)	Delete a payment request.
GetPaymentRequest	getPaymentRequest(String id)	Get payment request details
GetPaymentRequest	getPaymentRequest(String id, Map<String,String> additionalHeaders)	Get payment request details
<T> T	invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.

Methods inherited from class software.xdev.brevo.client.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

Methods inherited from class java.lang.Object

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

Constructor Details

PaymentsApi

public PaymentsApi()

PaymentsApi

public PaymentsApi(ApiClient apiClient)

Method Details

createPaymentRequest

public CreatePaymentResponse createPaymentRequest(@Nonnull
 CreatePaymentRequest createPaymentRequest)
                                           throws ApiException

Create a payment request

Parameters:

createPaymentRequest - Create a payment request (required)

Returns:

CreatePaymentResponse

Throws:

ApiException - if fails to make API call

createPaymentRequest

public CreatePaymentResponse createPaymentRequest(@Nonnull
 CreatePaymentRequest createPaymentRequest,
 Map<String,String> additionalHeaders)
                                           throws ApiException

Create a payment request

Parameters:

createPaymentRequest - Create a payment request (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreatePaymentResponse

Throws:

ApiException - if fails to make API call

deletePaymentRequest

public void deletePaymentRequest(@Nonnull
 UUID id)
                          throws ApiException

Delete a payment request.

Parameters:

id - ID of the payment request. (required)

Throws:

ApiException - if fails to make API call

deletePaymentRequest

public void deletePaymentRequest(@Nonnull
 UUID id,
 Map<String,String> additionalHeaders)
                          throws ApiException

Delete a payment request.

Parameters:

id - ID of the payment request. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getPaymentRequest

public GetPaymentRequest getPaymentRequest(@Nonnull
 String id)
                                    throws ApiException

Get payment request details

Parameters:

id - Id of the payment Request (required)

Returns:

GetPaymentRequest

Throws:

ApiException - if fails to make API call

getPaymentRequest

public GetPaymentRequest getPaymentRequest(@Nonnull
 String id,
 Map<String,String> additionalHeaders)
                                    throws ApiException

Get payment request details

Parameters:

id - Id of the payment Request (required)

additionalHeaders - additionalHeaders for this call

Returns:

GetPaymentRequest

Throws:

ApiException - if fails to make API call

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.