```
public class WebhooksApi
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class WebhooksApi.APIlistWebhooksRequest

Constructor Summary

Constructors
Constructor Description

WebhooksApi()

WebhooksApi(FinixClient finixClient)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Webhook`	`create(CreateWebhookRequest createWebhookRequest)`	Create a Webhook Create a `Webhook` to specify an endpoint where Finix can send events.
`okhttp3.Call`	`createWebhookAsync(CreateWebhookRequest createWebhookRequest, ApiCallback<Webhook> _callback)`	Create a Webhook (asynchronously) Create a `Webhook` to specify an endpoint where Finix can send events.
`okhttp3.Call`	`createWebhookCall(CreateWebhookRequest createWebhookRequest, ApiCallback _callback)`	Build call for createWebhook
`ApiResponse<Webhook>`	`createWebhookWithHttpInfo(CreateWebhookRequest createWebhookRequest)`	Create a Webhook Create a `Webhook` to specify an endpoint where Finix can send events.
`Webhook`	`get(String webhookId)`	Fetch a Webhook Retrieve the details of a `Webhook`.
`String`	`getCustomBaseUrl()`
`FinixClient`	`getFinixClient()`
`int`	`getHostIndex()`
`okhttp3.Call`	`getWebhookAsync(String webhookId, ApiCallback<Webhook> _callback)`	Fetch a Webhook (asynchronously) Retrieve the details of a `Webhook`.
`okhttp3.Call`	`getWebhookCall(String webhookId, ApiCallback _callback)`	Build call for getWebhook
`ApiResponse<Webhook>`	`getWebhookWithHttpInfo(String webhookId)`	Fetch a Webhook Retrieve the details of a `Webhook`.
`FinixList`	`list(ListWebhooksQueryParams listWebhooksQueryParams)`	List Webhooks Retrieve a list of `Webhooks`.
`void`	`setCustomBaseUrl(String customBaseUrl)`
`void`	`setFinixClient(FinixClient finixClient)`
`void`	`setHostIndex(int hostIndex)`
`Webhook`	`update(String webhookId, UpdateWebhookRequest updateWebhookRequest)`	Update a Webhook Update an existing `Webhook`.
`okhttp3.Call`	`updateWebhookAsync(String webhookId, UpdateWebhookRequest updateWebhookRequest, ApiCallback<Webhook> _callback)`	Update a Webhook (asynchronously) Update an existing `Webhook`.
`okhttp3.Call`	`updateWebhookCall(String webhookId, UpdateWebhookRequest updateWebhookRequest, ApiCallback _callback)`	Build call for updateWebhook
`ApiResponse<Webhook>`	`updateWebhookWithHttpInfo(String webhookId, UpdateWebhookRequest updateWebhookRequest)`	Update a Webhook Update an existing `Webhook`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhooksApi
```
public WebhooksApi()
```

WebhooksApi

public WebhooksApi(FinixClient finixClient)

Method Detail

getFinixClient
```
public FinixClient getFinixClient()
```

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex
```
public int getHostIndex()
```

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl
```
public String getCustomBaseUrl()
```

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createWebhookCall

public okhttp3.Call createWebhookCall(CreateWebhookRequest createWebhookRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createWebhook

Parameters:

createWebhookRequest - (optional)

_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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

create

public Webhook create(CreateWebhookRequest createWebhookRequest)
               throws ApiException

Create a Webhook Create a `Webhook` to specify an endpoint where Finix can send events.

Parameters:

createWebhookRequest - (optional)

Returns:

Webhook

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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createWebhookWithHttpInfo

public ApiResponse<Webhook> createWebhookWithHttpInfo(CreateWebhookRequest createWebhookRequest)
                                               throws ApiException

Create a Webhook Create a `Webhook` to specify an endpoint where Finix can send events.

Parameters:

createWebhookRequest - (optional)

Returns:

ApiResponse<Webhook>

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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

createWebhookAsync

public okhttp3.Call createWebhookAsync(CreateWebhookRequest createWebhookRequest,
                                       ApiCallback<Webhook> _callback)
                                throws ApiException

Create a Webhook (asynchronously) Create a `Webhook` to specify an endpoint where Finix can send events.

Parameters:

createWebhookRequest - (optional)

_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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -
422	Invalid field	* finix-apiuser-role - * date - * x-request-id -

getWebhookCall

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

Build call for getWebhook

Parameters:

webhookId - ID of `Webhook` object. (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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

get

public Webhook get(String webhookId)
            throws ApiException

Fetch a Webhook Retrieve the details of a `Webhook`.

Parameters:

webhookId - ID of `Webhook` object. (required)

Returns:

Webhook

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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getWebhookWithHttpInfo

public ApiResponse<Webhook> getWebhookWithHttpInfo(String webhookId)
                                            throws ApiException

Fetch a Webhook Retrieve the details of a `Webhook`.

Parameters:

webhookId - ID of `Webhook` object. (required)

Returns:

ApiResponse<Webhook>

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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getWebhookAsync

public okhttp3.Call getWebhookAsync(String webhookId,
                                    ApiCallback<Webhook> _callback)
                             throws ApiException

Fetch a Webhook (asynchronously) Retrieve the details of a `Webhook`.

Parameters:

webhookId - ID of `Webhook` object. (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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

list

public FinixList list(ListWebhooksQueryParams listWebhooksQueryParams)
               throws ApiException

List Webhooks Retrieve a list of `Webhooks`.

Returns:

APIlistWebhooksRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	List of Webhook objects	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

updateWebhookCall

public okhttp3.Call updateWebhookCall(String webhookId,
                                      UpdateWebhookRequest updateWebhookRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for updateWebhook

Parameters:

webhookId - ID of `Webhook` object. (required)

updateWebhookRequest - (optional)

_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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

update

public Webhook update(String webhookId,
                      UpdateWebhookRequest updateWebhookRequest)
               throws ApiException

Update a Webhook Update an existing `Webhook`.

Parameters:

webhookId - ID of `Webhook` object. (required)

updateWebhookRequest - (optional)

Returns:

Webhook

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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

updateWebhookWithHttpInfo

public ApiResponse<Webhook> updateWebhookWithHttpInfo(String webhookId,
                                                      UpdateWebhookRequest updateWebhookRequest)
                                               throws ApiException

Update a Webhook Update an existing `Webhook`.

Parameters:

webhookId - ID of `Webhook` object. (required)

updateWebhookRequest - (optional)

Returns:

ApiResponse<Webhook>

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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

updateWebhookAsync

public okhttp3.Call updateWebhookAsync(String webhookId,
                                       UpdateWebhookRequest updateWebhookRequest,
                                       ApiCallback<Webhook> _callback)
                                throws ApiException

Update a Webhook (asynchronously) Update an existing `Webhook`.

Parameters:

webhookId - ID of `Webhook` object. (required)

updateWebhookRequest - (optional)

_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	Single Webhook object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

Class WebhooksApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebhooksApi

WebhooksApi

Method Detail

getFinixClient

setFinixClient

getHostIndex

setHostIndex

getCustomBaseUrl

setCustomBaseUrl

createWebhookCall

create

createWebhookWithHttpInfo

createWebhookAsync

getWebhookCall

get

getWebhookWithHttpInfo

getWebhookAsync

list

updateWebhookCall

update

updateWebhookWithHttpInfo

updateWebhookAsync