Package software.xdev.brevo.model

Class ExportWebhooksHistoryRequest

java.lang.Object

software.xdev.brevo.model.ExportWebhooksHistoryRequest

public class ExportWebhooksHistoryRequest
extends Object

ExportWebhooksHistoryRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExportWebhooksHistoryRequest.EventEnum	Filter the history for a specific event type
static enum	ExportWebhooksHistoryRequest.TypeEnum	Filter the history based on webhook type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DAYS
static final String	JSON_PROPERTY_EMAIL
static final String	JSON_PROPERTY_END_DATE
static final String	JSON_PROPERTY_EVENT
static final String	JSON_PROPERTY_MESSAGE_ID
static final String	JSON_PROPERTY_NOTIFY_U_R_L
static final String	JSON_PROPERTY_SORT
static final String	JSON_PROPERTY_START_DATE
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_WEBHOOK_ID

Constructor Summary

Constructors

Constructor	Description
ExportWebhooksHistoryRequest()

Method Summary

Modifier and Type	Method	Description
ExportWebhooksHistoryRequest	days(Integer days)
ExportWebhooksHistoryRequest	email(String email)
ExportWebhooksHistoryRequest	endDate(String endDate)
boolean	equals(Object o)
ExportWebhooksHistoryRequest	event(ExportWebhooksHistoryRequest.EventEnum event)
Integer	getDays()	Number of days in the past including today (positive integer).
String	getEmail()	Filter the history for a specific email
String	getEndDate()	Mandatory if startDate is used.
ExportWebhooksHistoryRequest.EventEnum	getEvent()	Filter the history for a specific event type
Integer	getMessageId()	Filter the history for a specific message id.
String	getNotifyURL()	Webhook URL to receive CSV file link
String	getSort()	Sorting order of records (asc or desc)
String	getStartDate()	Mandatory if endDate is used.
ExportWebhooksHistoryRequest.TypeEnum	getType()	Filter the history based on webhook type
Integer	getWebhookId()	Filter the history for a specific webhook id
int	hashCode()
ExportWebhooksHistoryRequest	messageId(Integer messageId)
ExportWebhooksHistoryRequest	notifyURL(String notifyURL)
void	setDays(Integer days)
void	setEmail(String email)
void	setEndDate(String endDate)
void	setEvent(ExportWebhooksHistoryRequest.EventEnum event)
void	setMessageId(Integer messageId)
void	setNotifyURL(String notifyURL)
void	setSort(String sort)
void	setStartDate(String startDate)
void	setType(ExportWebhooksHistoryRequest.TypeEnum type)
void	setWebhookId(Integer webhookId)
ExportWebhooksHistoryRequest	sort(String sort)
ExportWebhooksHistoryRequest	startDate(String startDate)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
ExportWebhooksHistoryRequest	type(ExportWebhooksHistoryRequest.TypeEnum type)
ExportWebhooksHistoryRequest	webhookId(Integer webhookId)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_DAYS

public static final String JSON_PROPERTY_DAYS

See Also:

• Constant Field Values

JSON_PROPERTY_START_DATE

public static final String JSON_PROPERTY_START_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_END_DATE

public static final String JSON_PROPERTY_END_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_SORT

public static final String JSON_PROPERTY_SORT

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_EVENT

public static final String JSON_PROPERTY_EVENT

See Also:

• Constant Field Values

JSON_PROPERTY_NOTIFY_U_R_L

public static final String JSON_PROPERTY_NOTIFY_U_R_L

See Also:

• Constant Field Values

JSON_PROPERTY_WEBHOOK_ID

public static final String JSON_PROPERTY_WEBHOOK_ID

See Also:

• Constant Field Values

JSON_PROPERTY_EMAIL

public static final String JSON_PROPERTY_EMAIL

See Also:

• Constant Field Values

JSON_PROPERTY_MESSAGE_ID

public static final String JSON_PROPERTY_MESSAGE_ID

See Also:

• Constant Field Values

Constructor Details

ExportWebhooksHistoryRequest

public ExportWebhooksHistoryRequest()

Method Details

days

public ExportWebhooksHistoryRequest days(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(Integer days)

startDate

public ExportWebhooksHistoryRequest startDate(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(String startDate)

endDate

public ExportWebhooksHistoryRequest endDate(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(String endDate)

sort

public ExportWebhooksHistoryRequest sort(String sort)

getSort

@Nullable
public String getSort()

Sorting order of records (asc or desc)

Returns:

sort

setSort

public void setSort(String sort)

type

public ExportWebhooksHistoryRequest type(ExportWebhooksHistoryRequest.TypeEnum type)

getType

@Nonnull
public ExportWebhooksHistoryRequest.TypeEnum getType()

Filter the history based on webhook type

Returns:

type

setType

public void setType(ExportWebhooksHistoryRequest.TypeEnum type)

event

public ExportWebhooksHistoryRequest event(ExportWebhooksHistoryRequest.EventEnum event)

getEvent

@Nonnull
public ExportWebhooksHistoryRequest.EventEnum getEvent()

Filter the history for a specific event type

Returns:

event

setEvent

public void setEvent(ExportWebhooksHistoryRequest.EventEnum event)

notifyURL

public ExportWebhooksHistoryRequest notifyURL(String notifyURL)

getNotifyURL

@Nonnull
public String getNotifyURL()

Webhook URL to receive CSV file link

Returns:

notifyURL

setNotifyURL

public void setNotifyURL(String notifyURL)

webhookId

public ExportWebhooksHistoryRequest webhookId(Integer webhookId)

getWebhookId

@Nullable
public Integer getWebhookId()

Filter the history for a specific webhook id

Returns:

webhookId

setWebhookId

public void setWebhookId(Integer webhookId)

email

public ExportWebhooksHistoryRequest email(String email)

getEmail

@Nullable
public String getEmail()

Filter the history for a specific email

Returns:

email

setEmail

public void setEmail(String email)

messageId

public ExportWebhooksHistoryRequest messageId(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(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