Package io.voucherify.client.model

Class VoucherTransaction

java.lang.Object

io.voucherify.client.model.VoucherTransaction

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

VoucherTransaction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VoucherTransaction.CustomTypeAdapterFactory

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_CREATED_AT
static final String	SERIALIZED_NAME_DETAILS
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_REASON
static final String	SERIALIZED_NAME_RELATED_TRANSACTION_ID
static final String	SERIALIZED_NAME_SOURCE
static final String	SERIALIZED_NAME_SOURCE_ID
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_VOUCHER_ID

Constructor Summary

Constructors

Constructor	Description
VoucherTransaction()

Method Summary

Modifier and Type	Method	Description
VoucherTransaction	campaignId(String campaignId)
VoucherTransaction	createdAt(OffsetDateTime createdAt)
VoucherTransaction	details(VoucherTransactionDetails details)
boolean	equals(Object o)
static VoucherTransaction	fromJson(String jsonString)	Create an instance of VoucherTransaction given an JSON string
String	getCampaignId()	Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the transaction was created.
VoucherTransactionDetails	getDetails()	Get details
String	getId()	Unique transaction ID.
String	getReason()	Reason why the transaction occurred.
String	getRelatedTransactionId()	The related transaction ID on the receiving card.
String	getSource()	The channel through which the transaction took place, whether through the API or the the Dashboard.
String	getSourceId()	The merchant's transaction ID if it is different from the Voucherify transaction ID.
LoyaltyCardTransactionsType	getType()	Get type
String	getVoucherId()	Unique voucher ID.
int	hashCode()
VoucherTransaction	id(String id)
VoucherTransaction	reason(String reason)
VoucherTransaction	relatedTransactionId(String relatedTransactionId)
void	setCampaignId(String campaignId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDetails(VoucherTransactionDetails details)
void	setId(String id)
void	setReason(String reason)
void	setRelatedTransactionId(String relatedTransactionId)
void	setSource(String source)
void	setSourceId(String sourceId)
void	setType(LoyaltyCardTransactionsType type)
void	setVoucherId(String voucherId)
VoucherTransaction	source(String source)
VoucherTransaction	sourceId(String sourceId)
String	toJson()	Convert an instance of VoucherTransaction to an JSON string
String	toString()
VoucherTransaction	type(LoyaltyCardTransactionsType type)
VoucherTransaction	voucherId(String voucherId)

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_SOURCE_ID

public static final String SERIALIZED_NAME_SOURCE_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_VOUCHER_ID

public static final String SERIALIZED_NAME_VOUCHER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CAMPAIGN_ID

public static final String SERIALIZED_NAME_CAMPAIGN_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_SOURCE

public static final String SERIALIZED_NAME_SOURCE

See Also:

• Constant Field Values

SERIALIZED_NAME_REASON

public static final String SERIALIZED_NAME_REASON

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_DETAILS

public static final String SERIALIZED_NAME_DETAILS

See Also:

• Constant Field Values

SERIALIZED_NAME_RELATED_TRANSACTION_ID

public static final String SERIALIZED_NAME_RELATED_TRANSACTION_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

VoucherTransaction

public VoucherTransaction()

Method Details

id

public VoucherTransaction id(String id)

getId

@Nullable
public String getId()

Unique transaction ID.

Returns:

id

setId

public void setId(String id)

sourceId

public VoucherTransaction sourceId(String sourceId)

getSourceId

@Nullable
public String getSourceId()

The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.

Returns:

sourceId

setSourceId

public void setSourceId(String sourceId)

voucherId

public VoucherTransaction voucherId(String voucherId)

getVoucherId

@Nullable
public String getVoucherId()

Unique voucher ID.

Returns:

voucherId

setVoucherId

public void setVoucherId(String voucherId)

campaignId

public VoucherTransaction campaignId(String campaignId)

getCampaignId

@Nullable
public String getCampaignId()

Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.

Returns:

campaignId

setCampaignId

public void setCampaignId(String campaignId)

source

public VoucherTransaction source(String source)

getSource

@Nullable
public String getSource()

The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.

Returns:

source

setSource

public void setSource(String source)

reason

public VoucherTransaction reason(String reason)

getReason

@Nullable
public String getReason()

Reason why the transaction occurred. In case of a redemption, this value is null.

Returns:

reason

setReason

public void setReason(String reason)

type

public VoucherTransaction type(LoyaltyCardTransactionsType type)

getType

@Nonnull
public LoyaltyCardTransactionsType getType()

Get type

Returns:

type

setType

public void setType(LoyaltyCardTransactionsType type)

details

public VoucherTransaction details(VoucherTransactionDetails details)

getDetails

@Nullable
public VoucherTransactionDetails getDetails()

Get details

Returns:

details

setDetails

public void setDetails(VoucherTransactionDetails details)

relatedTransactionId

public VoucherTransaction relatedTransactionId(String relatedTransactionId)

getRelatedTransactionId

@Nullable
public String getRelatedTransactionId()

The related transaction ID on the receiving card.

Returns:

relatedTransactionId

setRelatedTransactionId

public void setRelatedTransactionId(String relatedTransactionId)

createdAt

public VoucherTransaction createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

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

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

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

Create an instance of VoucherTransaction given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VoucherTransaction

Throws:

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

toJson

public String toJson()

Convert an instance of VoucherTransaction to an JSON string

Returns:

JSON string