com.bookeo.api.service

Class WebhooksApi

java.lang.Object

com.bookeo.api.service.WebhooksApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-03T18:48:57.986-05:00")
public class WebhooksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WebhooksApi()
WebhooksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
WebhooksList	webhooksGet() List all webhooks Retrieve all the webhooks for this api key
void	webhooksPost(Webhook webhook) Create a new webhook Note that if an existing webhook for the same domain and type was already set for this api key, it will be automatically replaced by this new webhook.\n In other words, there can be only one webhook for each combination of domain and type, for an API key.\n So to upgrade an existing webhook URL, simply create a new one with the same domain and type, but a different URL.\n\n For webhook with domain \"bookings\" and type \"deleted\", the notification will be sent whether the booking is canceled or completely deleted.\n Users can delete bookings by, for example, deleting their associated customer.\n Also note that these \"bookings\" \"deleted\" notifications are sent even for bookings in the past.
void	webhooksWebhookIdDelete(String webhookId) Delete a webhook Delete a webhook
Webhook	webhooksWebhookIdGet(String webhookId) Retrieve a webhook Retrieve a 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(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

webhooksGet

public WebhooksList webhooksGet()
                         throws ApiException

List all webhooks Retrieve all the webhooks for this api key

Returns:

WebhooksList

Throws:

ApiException

webhooksPost

public void webhooksPost(Webhook webhook)
                  throws ApiException

Create a new webhook Note that if an existing webhook for the same domain and type was already set for this api key, it will be automatically replaced by this new webhook.\n In other words, there can be only one webhook for each combination of domain and type, for an API key.\n So to upgrade an existing webhook URL, simply create a new one with the same domain and type, but a different URL.\n\n For webhook with domain \"bookings\" and type \"deleted\", the notification will be sent whether the booking is canceled or completely deleted.\n Users can delete bookings by, for example, deleting their associated customer.\n Also note that these \"bookings\" \"deleted\" notifications are sent even for bookings in the past.

Parameters:

webhook -

Throws:

ApiException

webhooksWebhookIdGet

public Webhook webhooksWebhookIdGet(String webhookId)
                             throws ApiException

Retrieve a webhook Retrieve a webhook

Parameters:

webhookId -

Returns:

Webhook

Throws:

ApiException

webhooksWebhookIdDelete

public void webhooksWebhookIdDelete(String webhookId)
                             throws ApiException

Delete a webhook Delete a webhook

Parameters:

webhookId -

Throws:

ApiException