Package io.voucherify.client.model

Class RewardsCreateResponseBody

java.lang.Object

io.voucherify.client.model.RewardsCreateResponseBody

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

Response body schema for **POST** `v1/rewards`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RewardsCreateResponseBody.CustomTypeAdapterFactory
static enum	RewardsCreateResponseBody.ObjectEnum	The type of the object represented by the JSON.
static enum	RewardsCreateResponseBody.TypeEnum	Reward type.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ATTRIBUTES
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_PARAMETERS
static final String	SERIALIZED_NAME_REDEEMED
static final String	SERIALIZED_NAME_STOCK
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
RewardsCreateResponseBody()

Method Summary

Modifier and Type	Method	Description
RewardsCreateResponseBody	_object(RewardsCreateResponseBody.ObjectEnum _object)
RewardsCreateResponseBody	attributes(RewardsCreateResponseBodyAttributes attributes)
RewardsCreateResponseBody	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
static RewardsCreateResponseBody	fromJson(String jsonString)	Create an instance of RewardsCreateResponseBody given an JSON string
RewardsCreateResponseBodyAttributes	getAttributes()	Get attributes
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the reward was created.
String	getId()	Unique reward ID, assigned by Voucherify.
Object	getMetadata()	The metadata object stores all custom attributes assigned to the reward.
String	getName()	Reward name.
RewardsCreateResponseBody.ObjectEnum	getObject()	The type of the object represented by the JSON.
RewardType	getParameters()	Get parameters
Integer	getRedeemed()	Defines the number of already invoked (successful) reward redemptions.
Integer	getStock()	Configurable for **material rewards**.
RewardsCreateResponseBody.TypeEnum	getType()	Reward type.
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the reward was updated.
int	hashCode()
RewardsCreateResponseBody	id(String id)
RewardsCreateResponseBody	metadata(Object metadata)
RewardsCreateResponseBody	name(String name)
RewardsCreateResponseBody	parameters(RewardType parameters)
RewardsCreateResponseBody	redeemed(Integer redeemed)
void	setAttributes(RewardsCreateResponseBodyAttributes attributes)
void	setCreatedAt(OffsetDateTime createdAt)
void	setId(String id)
void	setMetadata(Object metadata)
void	setName(String name)
void	setObject(RewardsCreateResponseBody.ObjectEnum _object)
void	setParameters(RewardType parameters)
void	setRedeemed(Integer redeemed)
void	setStock(Integer stock)
void	setType(RewardsCreateResponseBody.TypeEnum type)
void	setUpdatedAt(OffsetDateTime updatedAt)
RewardsCreateResponseBody	stock(Integer stock)
String	toJson()	Convert an instance of RewardsCreateResponseBody to an JSON string
String	toString()
RewardsCreateResponseBody	type(RewardsCreateResponseBody.TypeEnum type)
RewardsCreateResponseBody	updatedAt(OffsetDateTime updatedAt)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_STOCK

public static final String SERIALIZED_NAME_STOCK

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEEMED

public static final String SERIALIZED_NAME_REDEEMED

See Also:

• Constant Field Values

SERIALIZED_NAME_ATTRIBUTES

public static final String SERIALIZED_NAME_ATTRIBUTES

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_PARAMETERS

public static final String SERIALIZED_NAME_PARAMETERS

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

RewardsCreateResponseBody

public RewardsCreateResponseBody()

Method Details

id

public RewardsCreateResponseBody id(String id)

getId

@Nullable
public String getId()

Unique reward ID, assigned by Voucherify.

Returns:

id

setId

public void setId(String id)

name

public RewardsCreateResponseBody name(String name)

getName

@Nullable
public String getName()

Reward name.

Returns:

name

setName

public void setName(String name)

stock

public RewardsCreateResponseBody stock(Integer stock)

getStock

@Nullable
public Integer getStock()

Configurable for **material rewards**. The number of units of the product that you want to share as reward.

Returns:

stock

setStock

public void setStock(Integer stock)

redeemed

public RewardsCreateResponseBody redeemed(Integer redeemed)

getRedeemed

@Nullable
public Integer getRedeemed()

Defines the number of already invoked (successful) reward redemptions.

Returns:

redeemed

setRedeemed

public void setRedeemed(Integer redeemed)

attributes

public RewardsCreateResponseBody attributes(RewardsCreateResponseBodyAttributes attributes)

getAttributes

@Nullable
public RewardsCreateResponseBodyAttributes getAttributes()

Get attributes

Returns:

attributes

setAttributes

public void setAttributes(RewardsCreateResponseBodyAttributes attributes)

metadata

public RewardsCreateResponseBody metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format.

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

type

public RewardsCreateResponseBody type(RewardsCreateResponseBody.TypeEnum type)

getType

@Nullable
public RewardsCreateResponseBody.TypeEnum getType()

Reward type.

Returns:

type

setType

public void setType(RewardsCreateResponseBody.TypeEnum type)

parameters

public RewardsCreateResponseBody parameters(RewardType parameters)

getParameters

@Nullable
public RewardType getParameters()

Get parameters

Returns:

parameters

setParameters

public void setParameters(RewardType parameters)

createdAt

public RewardsCreateResponseBody createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public RewardsCreateResponseBody updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

_object

public RewardsCreateResponseBody _object(RewardsCreateResponseBody.ObjectEnum _object)

getObject

@Nonnull
public RewardsCreateResponseBody.ObjectEnum getObject()

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

Returns:

_object

setObject

public void setObject(RewardsCreateResponseBody.ObjectEnum _object)

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

Create an instance of RewardsCreateResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RewardsCreateResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of RewardsCreateResponseBody to an JSON string

Returns:

JSON string