Package software.xdev.brevo.model

Class MainGetContactRewardsPayload

java.lang.Object

software.xdev.brevo.model.MainGetContactRewardsPayload

public class MainGetContactRewardsPayload
extends Object

MainGetContactRewardsPayload

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MainGetContactRewardsPayload.SortEnum	Sort the documents in ascending or descending order
static enum	MainGetContactRewardsPayload.SortFieldEnum	Sort documents by field

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CONTACT_ID
static final String	JSON_PROPERTY_LIMIT
static final String	JSON_PROPERTY_METADATA
static final String	JSON_PROPERTY_OFFSET
static final String	JSON_PROPERTY_REWARD_ID
static final String	JSON_PROPERTY_SORT
static final String	JSON_PROPERTY_SORT_FIELD

Constructor Summary

Constructors

Constructor	Description
MainGetContactRewardsPayload()

Method Summary

Modifier and Type	Method	Description
MainGetContactRewardsPayload	addMetadataItem(MainFilter metadataItem)
MainGetContactRewardsPayload	contactId(Integer contactId)
boolean	equals(Object o)
Integer	getContactId()	Contact to attribute the reward minimum: 1
Integer	getLimit()	Number of documents per page minimum: 1 maximum: 500
List<MainFilter>	getMetadata()	Data to define the reward for that particular contact
Integer	getOffset()	Index of the first document in the page minimum: 0
String	getRewardId()	Unique identifier of the associated reward
MainGetContactRewardsPayload.SortEnum	getSort()	Sort the documents in ascending or descending order
MainGetContactRewardsPayload.SortFieldEnum	getSortField()	Sort documents by field
int	hashCode()
MainGetContactRewardsPayload	limit(Integer limit)
MainGetContactRewardsPayload	metadata(List<MainFilter> metadata)
MainGetContactRewardsPayload	offset(Integer offset)
MainGetContactRewardsPayload	rewardId(String rewardId)
void	setContactId(Integer contactId)
void	setLimit(Integer limit)
void	setMetadata(List<MainFilter> metadata)
void	setOffset(Integer offset)
void	setRewardId(String rewardId)
void	setSort(MainGetContactRewardsPayload.SortEnum sort)
void	setSortField(MainGetContactRewardsPayload.SortFieldEnum sortField)
MainGetContactRewardsPayload	sort(MainGetContactRewardsPayload.SortEnum sort)
MainGetContactRewardsPayload	sortField(MainGetContactRewardsPayload.SortFieldEnum sortField)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_CONTACT_ID

public static final String JSON_PROPERTY_CONTACT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_LIMIT

public static final String JSON_PROPERTY_LIMIT

See Also:

• Constant Field Values

JSON_PROPERTY_METADATA

public static final String JSON_PROPERTY_METADATA

See Also:

• Constant Field Values

JSON_PROPERTY_OFFSET

public static final String JSON_PROPERTY_OFFSET

See Also:

• Constant Field Values

JSON_PROPERTY_REWARD_ID

public static final String JSON_PROPERTY_REWARD_ID

See Also:

• Constant Field Values

JSON_PROPERTY_SORT

public static final String JSON_PROPERTY_SORT

See Also:

• Constant Field Values

JSON_PROPERTY_SORT_FIELD

public static final String JSON_PROPERTY_SORT_FIELD

See Also:

• Constant Field Values

Constructor Details

MainGetContactRewardsPayload

public MainGetContactRewardsPayload()

Method Details

contactId

public MainGetContactRewardsPayload contactId(@Nonnull
 Integer contactId)

getContactId

@Nonnull
public Integer getContactId()

Contact to attribute the reward minimum: 1

Returns:

contactId

setContactId

public void setContactId(@Nonnull
 Integer contactId)

limit

public MainGetContactRewardsPayload limit(@Nullable
 Integer limit)

getLimit

@Nullable
public Integer getLimit()

Number of documents per page minimum: 1 maximum: 500

Returns:

limit

setLimit

public void setLimit(@Nullable
 Integer limit)

metadata

public MainGetContactRewardsPayload metadata(@Nullable
 List<MainFilter> metadata)

addMetadataItem

public MainGetContactRewardsPayload addMetadataItem(MainFilter metadataItem)

getMetadata

@Nullable
public List<MainFilter> getMetadata()

Data to define the reward for that particular contact

Returns:

metadata

setMetadata

public void setMetadata(@Nullable
 List<MainFilter> metadata)

offset

public MainGetContactRewardsPayload offset(@Nullable
 Integer offset)

getOffset

@Nullable
public Integer getOffset()

Index of the first document in the page minimum: 0

Returns:

offset

setOffset

public void setOffset(@Nullable
 Integer offset)

rewardId

public MainGetContactRewardsPayload rewardId(@Nullable
 String rewardId)

getRewardId

@Nullable
public String getRewardId()

Unique identifier of the associated reward

Returns:

rewardId

setRewardId

public void setRewardId(@Nullable
 String rewardId)

sort

public MainGetContactRewardsPayload sort(@Nullable
 MainGetContactRewardsPayload.SortEnum sort)

getSort

@Nullable
public MainGetContactRewardsPayload.SortEnum getSort()

Sort the documents in ascending or descending order

Returns:

sort

setSort

public void setSort(@Nullable
 MainGetContactRewardsPayload.SortEnum sort)

sortField

public MainGetContactRewardsPayload sortField(@Nullable
 MainGetContactRewardsPayload.SortFieldEnum sortField)

getSortField

@Nullable
public MainGetContactRewardsPayload.SortFieldEnum getSortField()

Sort documents by field

Returns:

sortField

setSortField

public void setSortField(@Nullable
 MainGetContactRewardsPayload.SortFieldEnum sortField)

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