Package software.xdev.brevo.model

Class RequestContactImport

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

  • Field Details

  • Constructor Details

    • RequestContactImport

      public RequestContactImport()

  • Method Details

    • fileUrl

      public RequestContactImport fileUrl(String fileUrl)

    • getFileUrl

      @Nullable public String getFileUrl()
      **Mandatory if fileBody and jsonBody is not defined.** URL of the file to be imported (**no local file**). Possible file formats: #### .txt, .csv, .json
      Returns:
      fileUrl

    • setFileUrl

      public void setFileUrl(String fileUrl)

    • fileBody

      public RequestContactImport fileBody(String fileBody)

    • getFileBody

      @Nullable public String getFileBody()
      **Mandatory if fileUrl and jsonBody is not defined.** CSV content to be imported. Use semicolon to separate multiple attributes. **Maximum allowed file body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files.
      Returns:
      fileBody

    • setFileBody

      public void setFileBody(String fileBody)

    • jsonBody

      public RequestContactImport jsonBody(List<RequestContactImportJsonBodyInner> jsonBody)

    • addJsonBodyItem

      public RequestContactImport addJsonBodyItem(RequestContactImportJsonBodyInner jsonBodyItem)

    • getJsonBody

      @Nullable public List<RequestContactImportJsonBodyInner> getJsonBody()
      **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files.
      Returns:
      jsonBody

    • setJsonBody

      public void setJsonBody(List<RequestContactImportJsonBodyInner> jsonBody)

    • listIds

      public RequestContactImport listIds(List<Long> listIds)

    • addListIdsItem

      public RequestContactImport addListIdsItem(Long listIdsItem)

    • getListIds

      @Nullable public List<Long> getListIds()
      **Mandatory if newList is not defined.** Ids of the lists in which the contacts shall be imported. For example, **[2, 4, 7]**.
      Returns:
      listIds

    • setListIds

      public void setListIds(List<Long> listIds)

    • notifyUrl

      public RequestContactImport notifyUrl(String notifyUrl)

    • getNotifyUrl

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

    • setNotifyUrl

      public void setNotifyUrl(String notifyUrl)

    • newList

      public RequestContactImport newList(RequestContactImportNewList newList)

    • getNewList

      @Nullable public RequestContactImportNewList getNewList()
      Get newList
      Returns:
      newList

    • setNewList

      public void setNewList(RequestContactImportNewList newList)

    • emailBlacklist

      public RequestContactImport emailBlacklist(Boolean emailBlacklist)

    • getEmailBlacklist

      @Nullable public Boolean getEmailBlacklist()
      To blacklist all the contacts for email
      Returns:
      emailBlacklist

    • setEmailBlacklist

      public void setEmailBlacklist(Boolean emailBlacklist)

    • disableNotification

      public RequestContactImport disableNotification(Boolean disableNotification)

    • getDisableNotification

      @Nullable public Boolean getDisableNotification()
      To disable email notification
      Returns:
      disableNotification

    • setDisableNotification

      public void setDisableNotification(Boolean disableNotification)

    • smsBlacklist

      public RequestContactImport smsBlacklist(Boolean smsBlacklist)

    • getSmsBlacklist

      @Nullable public Boolean getSmsBlacklist()
      To blacklist all the contacts for sms
      Returns:
      smsBlacklist

    • setSmsBlacklist

      public void setSmsBlacklist(Boolean smsBlacklist)

    • updateExistingContacts

      public RequestContactImport updateExistingContacts(Boolean updateExistingContacts)

    • getUpdateExistingContacts

      @Nullable public Boolean getUpdateExistingContacts()
      To facilitate the choice to update the existing contacts
      Returns:
      updateExistingContacts

    • setUpdateExistingContacts

      public void setUpdateExistingContacts(Boolean updateExistingContacts)

    • emptyContactsAttributes

      public RequestContactImport emptyContactsAttributes(Boolean emptyContactsAttributes)

    • getEmptyContactsAttributes

      @Nullable public Boolean getEmptyContactsAttributes()
      To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( **only available if `updateExistingContacts` set to true **)
      Returns:
      emptyContactsAttributes

    • setEmptyContactsAttributes

      public void setEmptyContactsAttributes(Boolean emptyContactsAttributes)

    • 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