Package io.voucherify.client.model

Class AccessSettingsCampaignAssignmentsList

java.lang.Object

io.voucherify.client.model.AccessSettingsCampaignAssignmentsList

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

Lists all assignments of the campaign to areas and stores. For [GET List Campaigns](ref:list-campaigns), this is returned if the `expand=access_settings_assignments` query parameter is passed in the request. **NOTE**: This object is returned only if the Areas and Stores enterprise feature is enabled. Contact [Voucherify Sales](https://www.voucherify.io/contact-sales) to learn more.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccessSettingsCampaignAssignmentsList.CustomTypeAdapterFactory
static enum	AccessSettingsCampaignAssignmentsList.DataRefEnum	Identifies the name of the attribute that contains the array of campaign assignments.
static enum	AccessSettingsCampaignAssignmentsList.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_OBJECT
static final String	SERIALIZED_NAME_TOTAL

Constructor Summary

Constructors

Constructor	Description
AccessSettingsCampaignAssignmentsList()

Method Summary

Modifier and Type	Method	Description
AccessSettingsCampaignAssignmentsList	_object(AccessSettingsCampaignAssignmentsList.ObjectEnum _object)
AccessSettingsCampaignAssignmentsList	addDataItem(AreaStoreCampaignAssignment dataItem)
AccessSettingsCampaignAssignmentsList	data(List<AreaStoreCampaignAssignment> data)
AccessSettingsCampaignAssignmentsList	dataRef(AccessSettingsCampaignAssignmentsList.DataRefEnum dataRef)
boolean	equals(Object o)
static AccessSettingsCampaignAssignmentsList	fromJson(String jsonString)	Create an instance of AccessSettingsCampaignAssignmentsList given an JSON string
List<AreaStoreCampaignAssignment>	getData()	Contains an array of campaign assignments.
AccessSettingsCampaignAssignmentsList.DataRefEnum	getDataRef()	Identifies the name of the attribute that contains the array of campaign assignments.
AccessSettingsCampaignAssignmentsList.ObjectEnum	getObject()	The type of the object represented by JSON.
Integer	getTotal()	Total number of areas and stores to which the campaign is assigned.
int	hashCode()
void	setData(List<AreaStoreCampaignAssignment> data)
void	setDataRef(AccessSettingsCampaignAssignmentsList.DataRefEnum dataRef)
void	setObject(AccessSettingsCampaignAssignmentsList.ObjectEnum _object)
void	setTotal(Integer total)
String	toJson()	Convert an instance of AccessSettingsCampaignAssignmentsList to an JSON string
String	toString()
AccessSettingsCampaignAssignmentsList	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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

AccessSettingsCampaignAssignmentsList

public AccessSettingsCampaignAssignmentsList()

Method Details

_object

public AccessSettingsCampaignAssignmentsList _object(AccessSettingsCampaignAssignmentsList.ObjectEnum _object)

getObject

@Nullable
public AccessSettingsCampaignAssignmentsList.ObjectEnum getObject()

The type of the object represented by JSON. Default is `list`. This object stores information about campaign assignments to areas and stores

Returns:

_object

setObject

public void setObject(AccessSettingsCampaignAssignmentsList.ObjectEnum _object)

dataRef

public AccessSettingsCampaignAssignmentsList dataRef(AccessSettingsCampaignAssignmentsList.DataRefEnum dataRef)

getDataRef

@Nullable
public AccessSettingsCampaignAssignmentsList.DataRefEnum getDataRef()

Identifies the name of the attribute that contains the array of campaign assignments.

Returns:

dataRef

setDataRef

public void setDataRef(AccessSettingsCampaignAssignmentsList.DataRefEnum dataRef)

data

public AccessSettingsCampaignAssignmentsList data(List<AreaStoreCampaignAssignment> data)

addDataItem

public AccessSettingsCampaignAssignmentsList addDataItem(AreaStoreCampaignAssignment dataItem)

getData

@Nullable
public List<AreaStoreCampaignAssignment> getData()

Contains an array of campaign assignments.

Returns:

data

setData

public void setData(List<AreaStoreCampaignAssignment> data)

total

public AccessSettingsCampaignAssignmentsList total(Integer total)

getTotal

@Nullable
public Integer getTotal()

Total number of areas and stores to which the campaign is assigned. minimum: 0

Returns:

total

setTotal

public void setTotal(Integer total)

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 AccessSettingsCampaignAssignmentsList fromJson(String jsonString)
                                                      throws IOException

Create an instance of AccessSettingsCampaignAssignmentsList given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of AccessSettingsCampaignAssignmentsList

Throws:

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

toJson

public String toJson()

Convert an instance of AccessSettingsCampaignAssignmentsList to an JSON string

Returns:

JSON string