Package io.voucherify.client.model

Class VoucherTransactionsExportParameters

java.lang.Object

io.voucherify.client.model.VoucherTransactionsExportParameters

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

List of available fields and filters that can be exported with a gift card or loyalty card transactions export along with the sorting order of the returned data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VoucherTransactionsExportParameters.CustomTypeAdapterFactory
static enum	VoucherTransactionsExportParameters.FieldsEnum	Gets or Sets fields
static enum	VoucherTransactionsExportParameters.OrderEnum	How the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_FIELDS
static final String	SERIALIZED_NAME_ORDER

Constructor Summary

Constructors

Constructor	Description
VoucherTransactionsExportParameters()

Method Summary

Modifier and Type	Method	Description
VoucherTransactionsExportParameters	addFieldsItem(VoucherTransactionsExportParameters.FieldsEnum fieldsItem)
boolean	equals(Object o)
VoucherTransactionsExportParameters	fields(List<VoucherTransactionsExportParameters.FieldsEnum> fields)
static VoucherTransactionsExportParameters	fromJson(String jsonString)	Create an instance of VoucherTransactionsExportParameters given an JSON string
List<VoucherTransactionsExportParameters.FieldsEnum>	getFields()	Array of strings containing the data in the export.
VoucherTransactionsExportParameters.OrderEnum	getOrder()	How the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order.
int	hashCode()
VoucherTransactionsExportParameters	order(VoucherTransactionsExportParameters.OrderEnum order)
void	setFields(List<VoucherTransactionsExportParameters.FieldsEnum> fields)
void	setOrder(VoucherTransactionsExportParameters.OrderEnum order)
String	toJson()	Convert an instance of VoucherTransactionsExportParameters to an JSON string
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ORDER

public static final String SERIALIZED_NAME_ORDER

See Also:

• Constant Field Values

SERIALIZED_NAME_FIELDS

public static final String SERIALIZED_NAME_FIELDS

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

VoucherTransactionsExportParameters

public VoucherTransactionsExportParameters()

Method Details

order

public VoucherTransactionsExportParameters order(VoucherTransactionsExportParameters.OrderEnum order)

getOrder

@Nullable
public VoucherTransactionsExportParameters.OrderEnum getOrder()

How the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order.

Returns:

order

setOrder

public void setOrder(VoucherTransactionsExportParameters.OrderEnum order)

fields

public VoucherTransactionsExportParameters fields(List<VoucherTransactionsExportParameters.FieldsEnum> fields)

addFieldsItem

public VoucherTransactionsExportParameters addFieldsItem(VoucherTransactionsExportParameters.FieldsEnum fieldsItem)

getFields

@Nullable
public List<VoucherTransactionsExportParameters.FieldsEnum> getFields()

Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: | **Field** | **Definition** | **Example Export** | |:---|:---|:---| | id | Unique transaction ID. | vtx_0cb7811f1c07765800 | | type | Transaction type. | - `CREDITS_REMOVAL` <br> - `CREDITS_ADDITION` <br> - `CREDITS_REFUND` <br> - `CREDITS_REDEMPTION` <br> - `POINTS_ACCRUAL` <br> - `POINTS_REDEMPTION`<br> - `POINTS_REFUND`<br> - `POINTS_ADDITION`<br> - `POINTS_REMOVAL`<br> - `POINTS_EXPIRATION`<br> - `POINTS_TRANSFER_IN`<br> - `POINTS_TRANSFER_OUT` | | source_id | Unique transaction source ID. | 8638 | | reason | Contains the reason for the transaction if one was included originally. | | | balance | The gift card or loyalty card balance after the transaction. | | | amount | The amount of gift card or loyalty card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | | | created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z | | voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp | | campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV | | source| Channel through which the transaction was initiated. | API | | details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. | | related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 |

Returns:

fields

setFields

public void setFields(List<VoucherTransactionsExportParameters.FieldsEnum> fields)

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

Create an instance of VoucherTransactionsExportParameters given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VoucherTransactionsExportParameters

Throws:

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

toJson

public String toJson()

Convert an instance of VoucherTransactionsExportParameters to an JSON string

Returns:

JSON string