Package software.xdev.brevo.model

Class RequestContactExport

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

  • Field Details

  • Constructor Details

    • RequestContactExport

      public RequestContactExport()

  • Method Details

    • exportAttributes

      public RequestContactExport exportAttributes(@Nullable List<String> exportAttributes)

    • addExportAttributesItem

      public RequestContactExport addExportAttributesItem(String exportAttributesItem)

    • getExportAttributes

      @Nullable public List<String> getExportAttributes()
      List of all the attributes that you want to export. **These attributes must be present in your contact database. It is required if exportMandatoryAttributes is set false. ** For example: **['fname', 'lname', 'email']**
      Returns:
      exportAttributes

    • setExportAttributes

      public void setExportAttributes(@Nullable List<String> exportAttributes)

    • customContactFilter

      public RequestContactExport customContactFilter(@Nonnull RequestContactExportCustomContactFilter customContactFilter)

    • getCustomContactFilter

      @Nonnull public RequestContactExportCustomContactFilter getCustomContactFilter()
      Get customContactFilter
      Returns:
      customContactFilter

    • setCustomContactFilter

      public void setCustomContactFilter(@Nonnull RequestContactExportCustomContactFilter customContactFilter)

    • notifyUrl

      public RequestContactExport notifyUrl(@Nullable String notifyUrl)

    • getNotifyUrl

      @Nullable public String getNotifyUrl()
      Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
      Returns:
      notifyUrl

    • setNotifyUrl

      public void setNotifyUrl(@Nullable String notifyUrl)

    • disableNotification

      public RequestContactExport disableNotification(@Nullable Boolean disableNotification)

    • getDisableNotification

      @Nullable public Boolean getDisableNotification()
      To avoid generating the email notification upon contact export, pass **true**
      Returns:
      disableNotification

    • setDisableNotification

      public void setDisableNotification(@Nullable Boolean disableNotification)

    • exportMandatoryAttributes

      public RequestContactExport exportMandatoryAttributes(@Nullable Boolean exportMandatoryAttributes)

    • getExportMandatoryAttributes

      @Nullable public Boolean getExportMandatoryAttributes()
      To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME
      Returns:
      exportMandatoryAttributes

    • setExportMandatoryAttributes

      public void setExportMandatoryAttributes(@Nullable Boolean exportMandatoryAttributes)

    • exportSubscriptionStatus

      public RequestContactExport exportSubscriptionStatus(@Nullable List<String> exportSubscriptionStatus)

    • addExportSubscriptionStatusItem

      public RequestContactExport addExportSubscriptionStatusItem(String exportSubscriptionStatusItem)

    • getExportSubscriptionStatus

      @Nullable public List<String> getExportSubscriptionStatus()
      Export subscription status of contacts for email & sms marketting. Pass email_marketing to obtain the marketing email subscription status & sms_marketing to retrieve the marketing SMS status of the contact.
      Returns:
      exportSubscriptionStatus

    • setExportSubscriptionStatus

      public void setExportSubscriptionStatus(@Nullable List<String> exportSubscriptionStatus)

    • exportMetadata

      public RequestContactExport exportMetadata(@Nullable List<String> exportMetadata)

    • addExportMetadataItem

      public RequestContactExport addExportMetadataItem(String exportMetadataItem)

    • getExportMetadata

      @Nullable public List<String> getExportMetadata()
      Export metadata of contacts such as _listIds, ADDED_TIME, MODIFIED_TIME.
      Returns:
      exportMetadata

    • setExportMetadata

      public void setExportMetadata(@Nullable List<String> exportMetadata)

    • 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