Package software.xdev.brevo.api

Class SendersApi

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

  • Constructor Details

    • SendersApi

      public SendersApi()

    • SendersApi

      public SendersApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createSender

      public CreateSenderModel createSender(CreateSender sender) throws ApiException
      Create a new sender
      Parameters:
      sender - sender's name (optional)
      Returns:
      CreateSenderModel
      Throws:
      ApiException - if fails to make API call

    • createSender

      public CreateSenderModel createSender(CreateSender sender, Map<String,String> additionalHeaders) throws ApiException
      Create a new sender
      Parameters:
      sender - sender's name (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CreateSenderModel
      Throws:
      ApiException - if fails to make API call

    • deleteSender

      public void deleteSender(Long senderId) throws ApiException
      Delete a sender
      Parameters:
      senderId - Id of the sender (required)
      Throws:
      ApiException - if fails to make API call

    • deleteSender

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

    • getIps

      public GetIps getIps() throws ApiException
      Get all the dedicated IPs for your account
      Returns:
      GetIps
      Throws:
      ApiException - if fails to make API call

    • getIps

      public GetIps getIps(Map<String,String> additionalHeaders) throws ApiException
      Get all the dedicated IPs for your account
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetIps
      Throws:
      ApiException - if fails to make API call

    • getIpsFromSender

      public GetIpsFromSender getIpsFromSender(Long senderId) throws ApiException
      Get all the dedicated IPs for a sender
      Parameters:
      senderId - Id of the sender (required)
      Returns:
      GetIpsFromSender
      Throws:
      ApiException - if fails to make API call

    • getIpsFromSender

      public GetIpsFromSender getIpsFromSender(Long senderId, Map<String,String> additionalHeaders) throws ApiException
      Get all the dedicated IPs for a sender
      Parameters:
      senderId - Id of the sender (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetIpsFromSender
      Throws:
      ApiException - if fails to make API call

    • getSenders

      public GetSendersList getSenders(String ip, String domain) throws ApiException
      Get the list of all your senders
      Parameters:
      ip - Filter your senders for a specific ip. **Available for dedicated IP usage only** (optional)
      domain - Filter your senders for a specific domain (optional)
      Returns:
      GetSendersList
      Throws:
      ApiException - if fails to make API call

    • getSenders

      public GetSendersList getSenders(String ip, String domain, Map<String,String> additionalHeaders) throws ApiException
      Get the list of all your senders
      Parameters:
      ip - Filter your senders for a specific ip. **Available for dedicated IP usage only** (optional)
      domain - Filter your senders for a specific domain (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetSendersList
      Throws:
      ApiException - if fails to make API call

    • updateSender

      public void updateSender(Long senderId, UpdateSender sender) throws ApiException
      Update a sender
      Parameters:
      senderId - Id of the sender (required)
      sender - sender's name (optional)
      Throws:
      ApiException - if fails to make API call

    • updateSender

      public void updateSender(Long senderId, UpdateSender sender, Map<String,String> additionalHeaders) throws ApiException
      Update a sender
      Parameters:
      senderId - Id of the sender (required)
      sender - sender's name (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • validateSenderByOTP

      public void validateSenderByOTP(Long senderId, Otp sender) throws ApiException
      Validate Sender using OTP
      Parameters:
      senderId - Id of the sender (required)
      sender - otp (optional)
      Throws:
      ApiException - if fails to make API call

    • validateSenderByOTP

      public void validateSenderByOTP(Long senderId, Otp sender, Map<String,String> additionalHeaders) throws ApiException
      Validate Sender using OTP
      Parameters:
      senderId - Id of the sender (required)
      sender - otp (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call