Package software.xdev.brevo.model

Class ExportWebhooksHistory

java.lang.Object
software.xdev.brevo.model.ExportWebhooksHistory
public class ExportWebhooksHistory extends Object
ExportWebhooksHistory

  • Field Details

  • Constructor Details

    • ExportWebhooksHistory

      public ExportWebhooksHistory()

  • Method Details

    • days

      public ExportWebhooksHistory days(@Nullable Integer days)

    • getDays

      @Nullable public Integer getDays()
      Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
      Returns:
      days

    • setDays

      public void setDays(@Nullable Integer days)

    • startDate

      public ExportWebhooksHistory startDate(@Nullable String startDate)

    • getStartDate

      @Nullable public String getStartDate()
      Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than equal to endDate
      Returns:
      startDate

    • setStartDate

      public void setStartDate(@Nullable String startDate)

    • endDate

      public ExportWebhooksHistory endDate(@Nullable String endDate)

    • getEndDate

      @Nullable public String getEndDate()
      Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
      Returns:
      endDate

    • setEndDate

      public void setEndDate(@Nullable String endDate)

    • sort

      public ExportWebhooksHistory sort(@Nullable String sort)

    • getSort

      @Nullable public String getSort()
      Sorting order of records (asc or desc)
      Returns:
      sort

    • setSort

      public void setSort(@Nullable String sort)

    • type

      public ExportWebhooksHistory type(@Nonnull ExportWebhooksHistory.TypeEnum type)

    • getType

      @Nonnull public ExportWebhooksHistory.TypeEnum getType()
      Filter the history based on webhook type
      Returns:
      type

    • setType

      public void setType(@Nonnull ExportWebhooksHistory.TypeEnum type)

    • event

      public ExportWebhooksHistory event(@Nonnull ExportWebhooksHistory.EventEnum event)

    • getEvent

      @Nonnull public ExportWebhooksHistory.EventEnum getEvent()
      Filter the history for a specific event type
      Returns:
      event

    • setEvent

      public void setEvent(@Nonnull ExportWebhooksHistory.EventEnum event)

    • notifyURL

      public ExportWebhooksHistory notifyURL(@Nonnull String notifyURL)

    • getNotifyURL

      @Nonnull public String getNotifyURL()
      Webhook URL to receive CSV file link
      Returns:
      notifyURL

    • setNotifyURL

      public void setNotifyURL(@Nonnull String notifyURL)

    • webhookId

      public ExportWebhooksHistory webhookId(@Nullable Integer webhookId)

    • getWebhookId

      @Nullable public Integer getWebhookId()
      Filter the history for a specific webhook id
      Returns:
      webhookId

    • setWebhookId

      public void setWebhookId(@Nullable Integer webhookId)

    • email

      public ExportWebhooksHistory email(@Nullable String email)

    • getEmail

      @Nullable public String getEmail()
      Filter the history for a specific email
      Returns:
      email

    • setEmail

      public void setEmail(@Nullable String email)

    • messageId

      public ExportWebhooksHistory messageId(@Nullable Integer messageId)

    • getMessageId

      @Nullable public Integer getMessageId()
      Filter the history for a specific message id. Applicable only for transactional webhooks.
      Returns:
      messageId

    • setMessageId

      public void setMessageId(@Nullable Integer messageId)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string