Package io.voucherify.client.model

Class TemplatesCampaignsListResponseBody

java.lang.Object

io.voucherify.client.model.TemplatesCampaignsListResponseBody

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class TemplatesCampaignsListResponseBody
extends Object

Response body schema for **GET** `/v1/templates/campaign`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplatesCampaignsListResponseBody.CustomTypeAdapterFactory
static enum	TemplatesCampaignsListResponseBody.DataRefEnum	Identifies the name of the JSON property that contains the array of campaign templates.
static enum	TemplatesCampaignsListResponseBody.ObjectEnum	The type of the object represented by JSON.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_DATA
static final String	SERIALIZED_NAME_DATA_REF
static final String	SERIALIZED_NAME_HAS_MORE
static final String	SERIALIZED_NAME_MORE_STARTING_AFTER
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_TOTAL

Constructor Summary

Constructors

Constructor	Description
TemplatesCampaignsListResponseBody()

Method Summary

Modifier and Type	Method	Description
TemplatesCampaignsListResponseBody	_object(TemplatesCampaignsListResponseBody.ObjectEnum _object)
TemplatesCampaignsListResponseBody	addDataItem(CampaignTemplate dataItem)
TemplatesCampaignsListResponseBody	data(List<CampaignTemplate> data)
TemplatesCampaignsListResponseBody	dataRef(TemplatesCampaignsListResponseBody.DataRefEnum dataRef)
boolean	equals(Object o)
static TemplatesCampaignsListResponseBody	fromJson(String jsonString)	Create an instance of TemplatesCampaignsListResponseBody given an JSON string
List<CampaignTemplate>	getData()	Dictionary that contains an array of campaign templates.
TemplatesCampaignsListResponseBody.DataRefEnum	getDataRef()	Identifies the name of the JSON property that contains the array of campaign templates.
Boolean	getHasMore()	As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters.
String	getMoreStartingAfter()	Returns an ID that can be used to return another page of results.
TemplatesCampaignsListResponseBody.ObjectEnum	getObject()	The type of the object represented by JSON.
Integer	getTotal()	Total number of templates, regardless of the applied query parameters.
int	hashCode()
TemplatesCampaignsListResponseBody	hasMore(Boolean hasMore)
TemplatesCampaignsListResponseBody	moreStartingAfter(String moreStartingAfter)
void	setData(List<CampaignTemplate> data)
void	setDataRef(TemplatesCampaignsListResponseBody.DataRefEnum dataRef)
void	setHasMore(Boolean hasMore)
void	setMoreStartingAfter(String moreStartingAfter)
void	setObject(TemplatesCampaignsListResponseBody.ObjectEnum _object)
void	setTotal(Integer total)
String	toJson()	Convert an instance of TemplatesCampaignsListResponseBody to an JSON string
String	toString()
TemplatesCampaignsListResponseBody	total(Integer total)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_DATA_REF

public static final String SERIALIZED_NAME_DATA_REF

See Also:

• Constant Field Values

SERIALIZED_NAME_DATA

public static final String SERIALIZED_NAME_DATA

See Also:

• Constant Field Values

SERIALIZED_NAME_TOTAL

public static final String SERIALIZED_NAME_TOTAL

See Also:

• Constant Field Values

SERIALIZED_NAME_HAS_MORE

public static final String SERIALIZED_NAME_HAS_MORE

See Also:

• Constant Field Values

SERIALIZED_NAME_MORE_STARTING_AFTER

public static final String SERIALIZED_NAME_MORE_STARTING_AFTER

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

TemplatesCampaignsListResponseBody

public TemplatesCampaignsListResponseBody()

Method Details

_object

public TemplatesCampaignsListResponseBody _object(TemplatesCampaignsListResponseBody.ObjectEnum _object)

getObject

@Nullable
public TemplatesCampaignsListResponseBody.ObjectEnum getObject()

The type of the object represented by JSON. This object stores information about campaign templates.

Returns:

_object

setObject

public void setObject(TemplatesCampaignsListResponseBody.ObjectEnum _object)

dataRef

public TemplatesCampaignsListResponseBody dataRef(TemplatesCampaignsListResponseBody.DataRefEnum dataRef)

getDataRef

@Nullable
public TemplatesCampaignsListResponseBody.DataRefEnum getDataRef()

Identifies the name of the JSON property that contains the array of campaign templates.

Returns:

dataRef

setDataRef

public void setDataRef(TemplatesCampaignsListResponseBody.DataRefEnum dataRef)

data

public TemplatesCampaignsListResponseBody data(List<CampaignTemplate> data)

addDataItem

public TemplatesCampaignsListResponseBody addDataItem(CampaignTemplate dataItem)

getData

@Nullable
public List<CampaignTemplate> getData()

Dictionary that contains an array of campaign templates.

Returns:

data

setData

public void setData(List<CampaignTemplate> data)

total

public TemplatesCampaignsListResponseBody total(Integer total)

getTotal

@Nullable
public Integer getTotal()

Total number of templates, regardless of the applied query parameters. Displayed only if the `include_total` query paremeter is set to `true`.

Returns:

total

setTotal

public void setTotal(Integer total)

hasMore

public TemplatesCampaignsListResponseBody hasMore(Boolean hasMore)

getHasMore

@Nullable
public Boolean getHasMore()

As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results.

Returns:

hasMore

setHasMore

public void setHasMore(Boolean hasMore)

moreStartingAfter

public TemplatesCampaignsListResponseBody moreStartingAfter(String moreStartingAfter)

getMoreStartingAfter

@Nullable
public String getMoreStartingAfter()

Returns an ID that can be used to return another page of results. Use the template ID in the `starting_after_id` query parameter to display another page of the results starting after the template with that ID.

Returns:

moreStartingAfter

setMoreStartingAfter

public void setMoreStartingAfter(String moreStartingAfter)

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

fromJson

public static TemplatesCampaignsListResponseBody fromJson(String jsonString)
                                                   throws IOException

Create an instance of TemplatesCampaignsListResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of TemplatesCampaignsListResponseBody

Throws:

IOException - if the JSON string is invalid with respect to TemplatesCampaignsListResponseBody

toJson

public String toJson()

Convert an instance of TemplatesCampaignsListResponseBody to an JSON string

Returns:

JSON string