Package software.xdev.brevo.api

Class WebhooksApi

java.lang.Object
software.xdev.brevo.api.WebhooksApi
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class WebhooksApi extends Object

  • Constructor Details

    • WebhooksApi

      public WebhooksApi()

    • WebhooksApi

      public WebhooksApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createWebhook

      public CreateModel createWebhook(CreateWebhook createWebhook) throws ApiException
      Create a webhook
      Parameters:
      createWebhook - Values to create a webhook (required)
      Returns:
      CreateModel
      Throws:
      ApiException - if fails to make API call

    • createWebhook

      public CreateModel createWebhook(CreateWebhook createWebhook, Map<String,String> additionalHeaders) throws ApiException
      Create a webhook
      Parameters:
      createWebhook - Values to create a webhook (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CreateModel
      Throws:
      ApiException - if fails to make API call

    • deleteWebhook

      public void deleteWebhook(Long webhookId) throws ApiException
      Delete a webhook
      Parameters:
      webhookId - Id of the webhook (required)
      Throws:
      ApiException - if fails to make API call

    • deleteWebhook

      public void deleteWebhook(Long webhookId, Map<String,String> additionalHeaders) throws ApiException
      Delete a webhook
      Parameters:
      webhookId - Id of the webhook (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • exportWebhooksHistory

      public CreatedProcessId exportWebhooksHistory(ExportWebhooksHistoryRequest exportWebhooksHistoryRequest) throws ApiException
      Export all webhook events This endpoint will submit a request to get the history of webhooks in the CSV file. The link to download the CSV file will be sent to the webhook that was provided in the notifyURL.
      Parameters:
      exportWebhooksHistoryRequest - Values to submit for webhooks history (required)
      Returns:
      CreatedProcessId
      Throws:
      ApiException - if fails to make API call

    • exportWebhooksHistory

      public CreatedProcessId exportWebhooksHistory(ExportWebhooksHistoryRequest exportWebhooksHistoryRequest, Map<String,String> additionalHeaders) throws ApiException
      Export all webhook events This endpoint will submit a request to get the history of webhooks in the CSV file. The link to download the CSV file will be sent to the webhook that was provided in the notifyURL.
      Parameters:
      exportWebhooksHistoryRequest - Values to submit for webhooks history (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CreatedProcessId
      Throws:
      ApiException - if fails to make API call

    • getWebhook

      public GetWebhook getWebhook(Long webhookId) throws ApiException
      Get a webhook details
      Parameters:
      webhookId - Id of the webhook (required)
      Returns:
      GetWebhook
      Throws:
      ApiException - if fails to make API call

    • getWebhook

      public GetWebhook getWebhook(Long webhookId, Map<String,String> additionalHeaders) throws ApiException
      Get a webhook details
      Parameters:
      webhookId - Id of the webhook (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetWebhook
      Throws:
      ApiException - if fails to make API call

    • getWebhooks

      public GetWebhooks getWebhooks(String type, String sort) throws ApiException
      Get all webhooks
      Parameters:
      type - Filter on webhook type (optional, default to transactional)
      sort - Sort the results in the ascending/descending order of webhook creation (optional, default to desc)
      Returns:
      GetWebhooks
      Throws:
      ApiException - if fails to make API call

    • getWebhooks

      public GetWebhooks getWebhooks(String type, String sort, Map<String,String> additionalHeaders) throws ApiException
      Get all webhooks
      Parameters:
      type - Filter on webhook type (optional, default to transactional)
      sort - Sort the results in the ascending/descending order of webhook creation (optional, default to desc)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetWebhooks
      Throws:
      ApiException - if fails to make API call

    • updateWebhook

      public void updateWebhook(Long webhookId, UpdateWebhook updateWebhook) throws ApiException
      Update a webhook
      Parameters:
      webhookId - Id of the webhook (required)
      updateWebhook - Values to update a webhook (required)
      Throws:
      ApiException - if fails to make API call

    • updateWebhook

      public void updateWebhook(Long webhookId, UpdateWebhook updateWebhook, Map<String,String> additionalHeaders) throws ApiException
      Update a webhook
      Parameters:
      webhookId - Id of the webhook (required)
      updateWebhook - Values to update a webhook (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call