com.mailslurp.apis

Class WebhookControllerApi

java.lang.Object

com.mailslurp.apis.WebhookControllerApi

public class WebhookControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WebhookControllerApi()
WebhookControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
WebhookDto	createWebhook(UUID inboxId, CreateWebhookOptions webhookOptions) Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL.
okhttp3.Call	createWebhookAsync(UUID inboxId, CreateWebhookOptions webhookOptions, ApiCallback<WebhookDto> _callback) Attach a WebHook URL to an inbox (asynchronously) Get notified whenever an inbox receives an email via a WebHook URL.
okhttp3.Call	createWebhookCall(UUID inboxId, CreateWebhookOptions webhookOptions, ApiCallback _callback) Build call for createWebhook
ApiResponse<WebhookDto>	createWebhookWithHttpInfo(UUID inboxId, CreateWebhookOptions webhookOptions) Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL.
void	deleteWebhook(UUID inboxId, UUID webhookId) Delete and disable a Webhook for an Inbox
okhttp3.Call	deleteWebhookAsync(UUID inboxId, UUID webhookId, ApiCallback<Void> _callback) Delete and disable a Webhook for an Inbox (asynchronously)
okhttp3.Call	deleteWebhookCall(UUID inboxId, UUID webhookId, ApiCallback _callback) Build call for deleteWebhook
ApiResponse<Void>	deleteWebhookWithHttpInfo(UUID inboxId, UUID webhookId) Delete and disable a Webhook for an Inbox
PageWebhookProjection	getAllWebhooks(Integer page, Integer size, String sort) List Webhooks Paginated List webhooks in paginated form.
okhttp3.Call	getAllWebhooksAsync(Integer page, Integer size, String sort, ApiCallback<PageWebhookProjection> _callback) List Webhooks Paginated (asynchronously) List webhooks in paginated form.
okhttp3.Call	getAllWebhooksCall(Integer page, Integer size, String sort, ApiCallback _callback) Build call for getAllWebhooks
ApiResponse<PageWebhookProjection>	getAllWebhooksWithHttpInfo(Integer page, Integer size, String sort) List Webhooks Paginated List webhooks in paginated form.
ApiClient	getApiClient()
WebhookDto	getWebhook(UUID webhookId) Get a webhook for an Inbox
okhttp3.Call	getWebhookAsync(UUID webhookId, ApiCallback<WebhookDto> _callback) Get a webhook for an Inbox (asynchronously)
okhttp3.Call	getWebhookCall(UUID webhookId, ApiCallback _callback) Build call for getWebhook
List<WebhookDto>	getWebhooks(UUID inboxId) Get all Webhooks for an Inbox
okhttp3.Call	getWebhooksAsync(UUID inboxId, ApiCallback<List<WebhookDto>> _callback) Get all Webhooks for an Inbox (asynchronously)
okhttp3.Call	getWebhooksCall(UUID inboxId, ApiCallback _callback) Build call for getWebhooks
ApiResponse<List<WebhookDto>>	getWebhooksWithHttpInfo(UUID inboxId) Get all Webhooks for an Inbox
ApiResponse<WebhookDto>	getWebhookWithHttpInfo(UUID webhookId) Get a webhook for an Inbox
WebhookTestResult	sendTestData(UUID webhookId) Send webhook test data
okhttp3.Call	sendTestDataAsync(UUID webhookId, ApiCallback<WebhookTestResult> _callback) Send webhook test data (asynchronously)
okhttp3.Call	sendTestDataCall(UUID webhookId, ApiCallback _callback) Build call for sendTestData
ApiResponse<WebhookTestResult>	sendTestDataWithHttpInfo(UUID webhookId) Send webhook test data
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebhookControllerApi

public WebhookControllerApi()

WebhookControllerApi

public WebhookControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createWebhookCall

public okhttp3.Call createWebhookCall(UUID inboxId,
                                      CreateWebhookOptions webhookOptions,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createWebhook

Parameters:

inboxId - inboxId (required)

webhookOptions - webhookOptions (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

createWebhook

public WebhookDto createWebhook(UUID inboxId,
                                CreateWebhookOptions webhookOptions)
                         throws ApiException

Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

Parameters:

inboxId - inboxId (required)

webhookOptions - webhookOptions (required)

Returns:

WebhookDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

createWebhookWithHttpInfo

public ApiResponse<WebhookDto> createWebhookWithHttpInfo(UUID inboxId,
                                                         CreateWebhookOptions webhookOptions)
                                                  throws ApiException

Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

Parameters:

inboxId - inboxId (required)

webhookOptions - webhookOptions (required)

Returns:

ApiResponse<WebhookDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

createWebhookAsync

public okhttp3.Call createWebhookAsync(UUID inboxId,
                                       CreateWebhookOptions webhookOptions,
                                       ApiCallback<WebhookDto> _callback)
                                throws ApiException

Attach a WebHook URL to an inbox (asynchronously) Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

Parameters:

inboxId - inboxId (required)

webhookOptions - webhookOptions (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

deleteWebhookCall

public okhttp3.Call deleteWebhookCall(UUID inboxId,
                                      UUID webhookId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for deleteWebhook

Parameters:

inboxId - inboxId (required)

webhookId - webhookId (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteWebhook

public void deleteWebhook(UUID inboxId,
                          UUID webhookId)
                   throws ApiException

Delete and disable a Webhook for an Inbox

Parameters:

inboxId - inboxId (required)

webhookId - webhookId (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteWebhookWithHttpInfo

public ApiResponse<Void> deleteWebhookWithHttpInfo(UUID inboxId,
                                                   UUID webhookId)
                                            throws ApiException

Delete and disable a Webhook for an Inbox

Parameters:

inboxId - inboxId (required)

webhookId - webhookId (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteWebhookAsync

public okhttp3.Call deleteWebhookAsync(UUID inboxId,
                                       UUID webhookId,
                                       ApiCallback<Void> _callback)
                                throws ApiException

Delete and disable a Webhook for an Inbox (asynchronously)

Parameters:

inboxId - inboxId (required)

webhookId - webhookId (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

getAllWebhooksCall

public okhttp3.Call getAllWebhooksCall(Integer page,
                                       Integer size,
                                       String sort,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getAllWebhooks

Parameters:

page - Optional page index in inbox list pagination (optional, default to 0)

size - Optional page size in inbox list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getAllWebhooks

public PageWebhookProjection getAllWebhooks(Integer page,
                                            Integer size,
                                            String sort)
                                     throws ApiException

List Webhooks Paginated List webhooks in paginated form. Allows for page index, page size, and sort direction.

Parameters:

page - Optional page index in inbox list pagination (optional, default to 0)

size - Optional page size in inbox list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

Returns:

PageWebhookProjection

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getAllWebhooksWithHttpInfo

public ApiResponse<PageWebhookProjection> getAllWebhooksWithHttpInfo(Integer page,
                                                                     Integer size,
                                                                     String sort)
                                                              throws ApiException

List Webhooks Paginated List webhooks in paginated form. Allows for page index, page size, and sort direction.

Parameters:

page - Optional page index in inbox list pagination (optional, default to 0)

size - Optional page size in inbox list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

Returns:

ApiResponse<PageWebhookProjection>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getAllWebhooksAsync

public okhttp3.Call getAllWebhooksAsync(Integer page,
                                        Integer size,
                                        String sort,
                                        ApiCallback<PageWebhookProjection> _callback)
                                 throws ApiException

List Webhooks Paginated (asynchronously) List webhooks in paginated form. Allows for page index, page size, and sort direction.

Parameters:

page - Optional page index in inbox list pagination (optional, default to 0)

size - Optional page size in inbox list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getWebhookCall

public okhttp3.Call getWebhookCall(UUID webhookId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getWebhook

Parameters:

webhookId - webhookId (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getWebhook

public WebhookDto getWebhook(UUID webhookId)
                      throws ApiException

Get a webhook for an Inbox

Parameters:

webhookId - webhookId (required)

Returns:

WebhookDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getWebhookWithHttpInfo

public ApiResponse<WebhookDto> getWebhookWithHttpInfo(UUID webhookId)
                                               throws ApiException

Get a webhook for an Inbox

Parameters:

webhookId - webhookId (required)

Returns:

ApiResponse<WebhookDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getWebhookAsync

public okhttp3.Call getWebhookAsync(UUID webhookId,
                                    ApiCallback<WebhookDto> _callback)
                             throws ApiException

Get a webhook for an Inbox (asynchronously)

Parameters:

webhookId - webhookId (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getWebhooksCall

public okhttp3.Call getWebhooksCall(UUID inboxId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getWebhooks

Parameters:

inboxId - inboxId (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getWebhooks

public List<WebhookDto> getWebhooks(UUID inboxId)
                             throws ApiException

Get all Webhooks for an Inbox

Parameters:

inboxId - inboxId (required)

Returns:

List<WebhookDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getWebhooksWithHttpInfo

public ApiResponse<List<WebhookDto>> getWebhooksWithHttpInfo(UUID inboxId)
                                                      throws ApiException

Get all Webhooks for an Inbox

Parameters:

inboxId - inboxId (required)

Returns:

ApiResponse<List<WebhookDto>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getWebhooksAsync

public okhttp3.Call getWebhooksAsync(UUID inboxId,
                                     ApiCallback<List<WebhookDto>> _callback)
                              throws ApiException

Get all Webhooks for an Inbox (asynchronously)

Parameters:

inboxId - inboxId (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

sendTestDataCall

public okhttp3.Call sendTestDataCall(UUID webhookId,
                                     ApiCallback _callback)
                              throws ApiException

Build call for sendTestData

Parameters:

webhookId - webhookId (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

sendTestData

public WebhookTestResult sendTestData(UUID webhookId)
                               throws ApiException

Send webhook test data

Parameters:

webhookId - webhookId (required)

Returns:

WebhookTestResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

sendTestDataWithHttpInfo

public ApiResponse<WebhookTestResult> sendTestDataWithHttpInfo(UUID webhookId)
                                                        throws ApiException

Send webhook test data

Parameters:

webhookId - webhookId (required)

Returns:

ApiResponse<WebhookTestResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

sendTestDataAsync

public okhttp3.Call sendTestDataAsync(UUID webhookId,
                                      ApiCallback<WebhookTestResult> _callback)
                               throws ApiException

Send webhook test data (asynchronously)

Parameters:

webhookId - webhookId (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-