Package software.xdev.brevo.api

Class ExternalFeedsApi

java.lang.Object
software.xdev.brevo.client.BaseApi
software.xdev.brevo.api.ExternalFeedsApi
public class ExternalFeedsApi extends BaseApi

  • Constructor Details

    • ExternalFeedsApi

      public ExternalFeedsApi()

    • ExternalFeedsApi

      public ExternalFeedsApi(ApiClient apiClient)

  • Method Details

    • createExternalFeed

      public CreateExternalFeed201Response createExternalFeed(@Nonnull CreateExternalFeed createExternalFeed) throws ApiException
      Create an external feed This endpoint will create an external feed.
      Parameters:
      createExternalFeed - Values to create a feed (required)
      Returns:
      CreateExternalFeed201Response
      Throws:
      ApiException - if fails to make API call

    • createExternalFeed

      public CreateExternalFeed201Response createExternalFeed(@Nonnull CreateExternalFeed createExternalFeed, Map<String,String> additionalHeaders) throws ApiException
      Create an external feed This endpoint will create an external feed.
      Parameters:
      createExternalFeed - Values to create a feed (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CreateExternalFeed201Response
      Throws:
      ApiException - if fails to make API call

    • deleteExternalFeed

      public void deleteExternalFeed(@Nonnull String uuid) throws ApiException
      Delete an external feed This endpoint will delete an external feed.
      Parameters:
      uuid - UUID of the feed to delete (required)
      Throws:
      ApiException - if fails to make API call

    • deleteExternalFeed

      public void deleteExternalFeed(@Nonnull String uuid, Map<String,String> additionalHeaders) throws ApiException
      Delete an external feed This endpoint will delete an external feed.
      Parameters:
      uuid - UUID of the feed to delete (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getAllExternalFeeds

      public GetAllExternalFeeds getAllExternalFeeds(@Nullable String search, @Nullable LocalDate startDate, @Nullable LocalDate endDate, @Nullable String sort, @Nullable String authType, @Nullable Long limit, @Nullable Long offset) throws ApiException
      Fetch all external feeds This endpoint can fetch all created external feeds.
      Parameters:
      search - Can be used to filter records by search keyword on feed name (optional)
      startDate - Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. (optional)
      endDate - Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional)
      sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. (optional, default to desc)
      authType - Filter the records by `authType` of the feed. (optional)
      limit - Number of documents returned per page. (optional, default to 50)
      offset - Index of the first document on the page. (optional, default to 0)
      Returns:
      GetAllExternalFeeds
      Throws:
      ApiException - if fails to make API call

    • getAllExternalFeeds

      public GetAllExternalFeeds getAllExternalFeeds(@Nullable String search, @Nullable LocalDate startDate, @Nullable LocalDate endDate, @Nullable String sort, @Nullable String authType, @Nullable Long limit, @Nullable Long offset, Map<String,String> additionalHeaders) throws ApiException
      Fetch all external feeds This endpoint can fetch all created external feeds.
      Parameters:
      search - Can be used to filter records by search keyword on feed name (optional)
      startDate - Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date. (optional)
      endDate - Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional)
      sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. (optional, default to desc)
      authType - Filter the records by `authType` of the feed. (optional)
      limit - Number of documents returned per page. (optional, default to 50)
      offset - Index of the first document on the page. (optional, default to 0)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetAllExternalFeeds
      Throws:
      ApiException - if fails to make API call

    • getExternalFeedByUUID

      public GetExternalFeedByUUID getExternalFeedByUUID(@Nonnull String uuid) throws ApiException
      Get an external feed by UUID This endpoint will update an external feed.
      Parameters:
      uuid - UUID of the feed to fetch (required)
      Returns:
      GetExternalFeedByUUID
      Throws:
      ApiException - if fails to make API call

    • getExternalFeedByUUID

      public GetExternalFeedByUUID getExternalFeedByUUID(@Nonnull String uuid, Map<String,String> additionalHeaders) throws ApiException
      Get an external feed by UUID This endpoint will update an external feed.
      Parameters:
      uuid - UUID of the feed to fetch (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetExternalFeedByUUID
      Throws:
      ApiException - if fails to make API call

    • updateExternalFeed

      public void updateExternalFeed(@Nonnull String uuid, @Nonnull UpdateExternalFeed updateExternalFeed) throws ApiException
      Update an external feed This endpoint will update an external feed.
      Parameters:
      uuid - UUID of the feed to update (required)
      updateExternalFeed - Values to update a feed (required)
      Throws:
      ApiException - if fails to make API call

    • updateExternalFeed

      public void updateExternalFeed(@Nonnull String uuid, @Nonnull UpdateExternalFeed updateExternalFeed, Map<String,String> additionalHeaders) throws ApiException
      Update an external feed This endpoint will update an external feed.
      Parameters:
      uuid - UUID of the feed to update (required)
      updateExternalFeed - Values to update a feed (required)
      additionalHeaders - additionalHeaders for this call
      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.