Package software.xdev.brevo.model

Class RequestContactExportCustomContactFilter

java.lang.Object
software.xdev.brevo.model.RequestContactExportCustomContactFilter
public class RequestContactExportCustomContactFilter extends Object
Set the filter for the contacts to be exported.

  • Field Details

  • Constructor Details

    • RequestContactExportCustomContactFilter

      public RequestContactExportCustomContactFilter()

  • Method Details

    • actionForContacts

      public RequestContactExportCustomContactFilter actionForContacts(@Nullable RequestContactExportCustomContactFilter.ActionForContactsEnum actionForContacts)

    • getActionForContacts

      @Nullable public RequestContactExportCustomContactFilter.ActionForContactsEnum getActionForContacts()
      **Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only.
      Returns:
      actionForContacts

    • setActionForContacts

      public void setActionForContacts(@Nullable RequestContactExportCustomContactFilter.ActionForContactsEnum actionForContacts)

    • actionForEmailCampaigns

      public RequestContactExportCustomContactFilter actionForEmailCampaigns(@Nullable RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum actionForEmailCampaigns)

    • getActionForEmailCampaigns

      @Nullable public RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum getActionForEmailCampaigns()
      **Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on email campaigns. * **openers & nonOpeners** - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * **clickers & nonClickers** - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * **unsubscribed** - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * **hardBounces & softBounces** - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s).
      Returns:
      actionForEmailCampaigns

    • setActionForEmailCampaigns

      public void setActionForEmailCampaigns(@Nullable RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum actionForEmailCampaigns)

    • actionForSmsCampaigns

      public RequestContactExportCustomContactFilter actionForSmsCampaigns(@Nullable RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum actionForSmsCampaigns)

    • getActionForSmsCampaigns

      @Nullable public RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum getActionForSmsCampaigns()
      **Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.** This will export the contacts on the basis of provided action applied on sms campaigns. * **unsubscribed** - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * **hardBounces & softBounces** - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns.
      Returns:
      actionForSmsCampaigns

    • setActionForSmsCampaigns

      public void setActionForSmsCampaigns(@Nullable RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum actionForSmsCampaigns)

    • listId

      public RequestContactExportCustomContactFilter listId(@Nullable Long listId)

    • getListId

      @Nullable public Long getListId()
      ID of the list. This is mandatory if actionForContacts is specified and segmentId is not provided. Either segmentId or listId must be included.
      Returns:
      listId

    • setListId

      public void setListId(@Nullable Long listId)

    • segmentId

      public RequestContactExportCustomContactFilter segmentId(@Nullable Long segmentId)

    • getSegmentId

      @Nullable public Long getSegmentId()
      ID of the segment. This is mandatory if actionForContacts is specified and listId is not provided. Either segmentId or listId must be included.
      Returns:
      segmentId

    • setSegmentId

      public void setSegmentId(@Nullable Long segmentId)

    • emailCampaignId

      public RequestContactExportCustomContactFilter emailCampaignId(@Nullable Long emailCampaignId)

    • getEmailCampaignId

      @Nullable public Long getEmailCampaignId()
      Considered only if **actionForEmailCampaigns** is passed, ignored otherwise. **Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed.** The id of the email campaign for which the corresponding action shall be applied in the filter.
      Returns:
      emailCampaignId

    • setEmailCampaignId

      public void setEmailCampaignId(@Nullable Long emailCampaignId)

    • smsCampaignId

      public RequestContactExportCustomContactFilter smsCampaignId(@Nullable Long smsCampaignId)

    • getSmsCampaignId

      @Nullable public Long getSmsCampaignId()
      Considered only if **actionForSmsCampaigns** is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter.
      Returns:
      smsCampaignId

    • setSmsCampaignId

      public void setSmsCampaignId(@Nullable Long smsCampaignId)

    • 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