Package io.voucherify.client.model

Class RedeemableHolder

java.lang.Object

io.voucherify.client.model.RedeemableHolder

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

Single customer's redeemable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RedeemableHolder.CampaignTypeEnum	Defines the type of the campaign.
static class	RedeemableHolder.CustomTypeAdapterFactory
static enum	RedeemableHolder.HolderRoleEnum	Role of the holder.
static enum	RedeemableHolder.ObjectEnum	The type of the object represented by JSON.
static enum	RedeemableHolder.VoucherTypeEnum	Defines the type of the voucher.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_CAMPAIGN_ID
static final String	SERIALIZED_NAME_CAMPAIGN_TYPE
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_CUSTOMER_ID
static final String	SERIALIZED_NAME_HOLDER_ROLE
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_REDEEMABLE_ID
static final String	SERIALIZED_NAME_REDEEMABLE_OBJECT
static final String	SERIALIZED_NAME_VOUCHER_TYPE

Constructor Summary

Constructors

Constructor	Description
RedeemableHolder()

Method Summary

Modifier and Type	Method	Description
RedeemableHolder	_object(RedeemableHolder.ObjectEnum _object)
RedeemableHolder	campaignId(String campaignId)
RedeemableHolder	campaignType(RedeemableHolder.CampaignTypeEnum campaignType)
RedeemableHolder	createdAt(OffsetDateTime createdAt)
RedeemableHolder	customerId(String customerId)
boolean	equals(Object o)
static RedeemableHolder	fromJson(String jsonString)	Create an instance of RedeemableHolder given an JSON string
String	getCampaignId()	Unique identifier of the campaign as assigned by Voucherify.
RedeemableHolder.CampaignTypeEnum	getCampaignType()	Defines the type of the campaign.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the redeemable was assigned.
String	getCustomerId()	Unique identifier of the customer.
RedeemableHolder.HolderRoleEnum	getHolderRole()	Role of the holder.
String	getId()	Unique identifier of the redeemable holder.
Object	getMetadata()	A set of custom key/value pairs that you can attach to a redeemable holder.
RedeemableHolder.ObjectEnum	getObject()	The type of the object represented by JSON.
String	getRedeemableId()	Identifier of the redeemable item.
String	getRedeemableObject()	Type of the redeemable.
RedeemableHolder.VoucherTypeEnum	getVoucherType()	Defines the type of the voucher.
int	hashCode()
RedeemableHolder	holderRole(RedeemableHolder.HolderRoleEnum holderRole)
RedeemableHolder	id(String id)
RedeemableHolder	metadata(Object metadata)
RedeemableHolder	redeemableId(String redeemableId)
RedeemableHolder	redeemableObject(String redeemableObject)
void	setCampaignId(String campaignId)
void	setCampaignType(RedeemableHolder.CampaignTypeEnum campaignType)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCustomerId(String customerId)
void	setHolderRole(RedeemableHolder.HolderRoleEnum holderRole)
void	setId(String id)
void	setMetadata(Object metadata)
void	setObject(RedeemableHolder.ObjectEnum _object)
void	setRedeemableId(String redeemableId)
void	setRedeemableObject(String redeemableObject)
void	setVoucherType(RedeemableHolder.VoucherTypeEnum voucherType)
String	toJson()	Convert an instance of RedeemableHolder to an JSON string
String	toString()
RedeemableHolder	voucherType(RedeemableHolder.VoucherTypeEnum voucherType)

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_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEEMABLE_ID

public static final String SERIALIZED_NAME_REDEEMABLE_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEEMABLE_OBJECT

public static final String SERIALIZED_NAME_REDEEMABLE_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_CUSTOMER_ID

public static final String SERIALIZED_NAME_CUSTOMER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_HOLDER_ROLE

public static final String SERIALIZED_NAME_HOLDER_ROLE

See Also:

• Constant Field Values

SERIALIZED_NAME_CAMPAIGN_ID

public static final String SERIALIZED_NAME_CAMPAIGN_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CAMPAIGN_TYPE

public static final String SERIALIZED_NAME_CAMPAIGN_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_VOUCHER_TYPE

public static final String SERIALIZED_NAME_VOUCHER_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

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

RedeemableHolder

public RedeemableHolder()

Method Details

id

public RedeemableHolder id(String id)

getId

@Nullable
public String getId()

Unique identifier of the redeemable holder.

Returns:

id

setId

public void setId(String id)

createdAt

public RedeemableHolder createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

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

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

redeemableId

public RedeemableHolder redeemableId(String redeemableId)

getRedeemableId

@Nullable
public String getRedeemableId()

Identifier of the redeemable item.

Returns:

redeemableId

setRedeemableId

public void setRedeemableId(String redeemableId)

redeemableObject

public RedeemableHolder redeemableObject(String redeemableObject)

getRedeemableObject

@Nullable
public String getRedeemableObject()

Type of the redeemable.

Returns:

redeemableObject

setRedeemableObject

public void setRedeemableObject(String redeemableObject)

customerId

public RedeemableHolder customerId(String customerId)

getCustomerId

@Nullable
public String getCustomerId()

Unique identifier of the customer.

Returns:

customerId

setCustomerId

public void setCustomerId(String customerId)

holderRole

public RedeemableHolder holderRole(RedeemableHolder.HolderRoleEnum holderRole)

getHolderRole

@Nullable
public RedeemableHolder.HolderRoleEnum getHolderRole()

Role of the holder.

Returns:

holderRole

setHolderRole

public void setHolderRole(RedeemableHolder.HolderRoleEnum holderRole)

campaignId

public RedeemableHolder campaignId(String campaignId)

getCampaignId

@Nullable
public String getCampaignId()

Unique identifier of the campaign as assigned by Voucherify.

Returns:

campaignId

setCampaignId

public void setCampaignId(String campaignId)

campaignType

public RedeemableHolder campaignType(RedeemableHolder.CampaignTypeEnum campaignType)

getCampaignType

@Nullable
public RedeemableHolder.CampaignTypeEnum getCampaignType()

Defines the type of the campaign.

Returns:

campaignType

setCampaignType

public void setCampaignType(RedeemableHolder.CampaignTypeEnum campaignType)

voucherType

public RedeemableHolder voucherType(RedeemableHolder.VoucherTypeEnum voucherType)

getVoucherType

@Nullable
public RedeemableHolder.VoucherTypeEnum getVoucherType()

Defines the type of the voucher.

Returns:

voucherType

setVoucherType

public void setVoucherType(RedeemableHolder.VoucherTypeEnum voucherType)

metadata

public RedeemableHolder metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

A set of custom key/value pairs that you can attach to a redeemable holder. The metadata object stores all custom attributes assigned to the `redeemable_holder` object.

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

_object

public RedeemableHolder _object(RedeemableHolder.ObjectEnum _object)

getObject

@Nullable
public RedeemableHolder.ObjectEnum getObject()

The type of the object represented by JSON.

Returns:

_object

setObject

public void setObject(RedeemableHolder.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 RedeemableHolder fromJson(String jsonString)
                                 throws IOException

Create an instance of RedeemableHolder given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RedeemableHolder

Throws:

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

toJson

public String toJson()

Convert an instance of RedeemableHolder to an JSON string

Returns:

JSON string