Package io.voucherify.client.model

Class VouchersTransactionsExportCreateResponseBody

java.lang.Object

io.voucherify.client.model.VouchersTransactionsExportCreateResponseBody

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

Response body schema for **POST** `v1/vouchers/{code}/transactions/export`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VouchersTransactionsExportCreateResponseBody.CustomTypeAdapterFactory
static enum	VouchersTransactionsExportCreateResponseBody.ExportedObjectEnum	The type of exported object.
static enum	VouchersTransactionsExportCreateResponseBody.ObjectEnum	The type of object being represented.
static enum	VouchersTransactionsExportCreateResponseBody.StatusEnum	Status of the export.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_CHANNEL
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_EXPORTED_OBJECT
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_PARAMETERS
static final String	SERIALIZED_NAME_RESULT
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_USER_ID

Constructor Summary

Constructors

Constructor	Description
VouchersTransactionsExportCreateResponseBody()

Method Summary

Modifier and Type	Method	Description
VouchersTransactionsExportCreateResponseBody	_object(VouchersTransactionsExportCreateResponseBody.ObjectEnum _object)
VouchersTransactionsExportCreateResponseBody	channel(String channel)
VouchersTransactionsExportCreateResponseBody	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
VouchersTransactionsExportCreateResponseBody	exportedObject(VouchersTransactionsExportCreateResponseBody.ExportedObjectEnum exportedObject)
static VouchersTransactionsExportCreateResponseBody	fromJson(String jsonString)	Create an instance of VouchersTransactionsExportCreateResponseBody given an JSON string
String	getChannel()	The channel through which the export was triggered.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the export was scheduled in ISO 8601 format.
VouchersTransactionsExportCreateResponseBody.ExportedObjectEnum	getExportedObject()	The type of exported object.
String	getId()	Unique export ID.
VouchersTransactionsExportCreateResponseBody.ObjectEnum	getObject()	The type of object being represented.
VoucherTransactionsFilters	getParameters()	Get parameters
VouchersTransactionsExportCreateResponseBodyResult	getResult()	Get result
VouchersTransactionsExportCreateResponseBody.StatusEnum	getStatus()	Status of the export.
String	getUserId()	Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the `channel` value is `WEBSITE`.
int	hashCode()
VouchersTransactionsExportCreateResponseBody	id(String id)
VouchersTransactionsExportCreateResponseBody	parameters(VoucherTransactionsFilters parameters)
VouchersTransactionsExportCreateResponseBody	result(VouchersTransactionsExportCreateResponseBodyResult result)
void	setChannel(String channel)
void	setCreatedAt(OffsetDateTime createdAt)
void	setExportedObject(VouchersTransactionsExportCreateResponseBody.ExportedObjectEnum exportedObject)
void	setId(String id)
void	setObject(VouchersTransactionsExportCreateResponseBody.ObjectEnum _object)
void	setParameters(VoucherTransactionsFilters parameters)
void	setResult(VouchersTransactionsExportCreateResponseBodyResult result)
void	setStatus(VouchersTransactionsExportCreateResponseBody.StatusEnum status)
void	setUserId(String userId)
VouchersTransactionsExportCreateResponseBody	status(VouchersTransactionsExportCreateResponseBody.StatusEnum status)
String	toJson()	Convert an instance of VouchersTransactionsExportCreateResponseBody to an JSON string
String	toString()
VouchersTransactionsExportCreateResponseBody	userId(String userId)

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_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_CHANNEL

public static final String SERIALIZED_NAME_CHANNEL

See Also:

• Constant Field Values

SERIALIZED_NAME_EXPORTED_OBJECT

public static final String SERIALIZED_NAME_EXPORTED_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_PARAMETERS

public static final String SERIALIZED_NAME_PARAMETERS

See Also:

• Constant Field Values

SERIALIZED_NAME_RESULT

public static final String SERIALIZED_NAME_RESULT

See Also:

• Constant Field Values

SERIALIZED_NAME_USER_ID

public static final String SERIALIZED_NAME_USER_ID

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

VouchersTransactionsExportCreateResponseBody

public VouchersTransactionsExportCreateResponseBody()

Method Details

id

public VouchersTransactionsExportCreateResponseBody id(String id)

getId

@Nullable
public String getId()

Unique export ID.

Returns:

id

setId

public void setId(String id)

_object

public VouchersTransactionsExportCreateResponseBody _object(VouchersTransactionsExportCreateResponseBody.ObjectEnum _object)

getObject

@Nullable
public VouchersTransactionsExportCreateResponseBody.ObjectEnum getObject()

The type of object being represented. This object stores information about the `export`.

Returns:

_object

setObject

public void setObject(VouchersTransactionsExportCreateResponseBody.ObjectEnum _object)

createdAt

public VouchersTransactionsExportCreateResponseBody createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the export was scheduled in ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

status

public VouchersTransactionsExportCreateResponseBody status(VouchersTransactionsExportCreateResponseBody.StatusEnum status)

getStatus

@Nullable
public VouchersTransactionsExportCreateResponseBody.StatusEnum getStatus()

Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated.

Returns:

status

setStatus

public void setStatus(VouchersTransactionsExportCreateResponseBody.StatusEnum status)

channel

public VouchersTransactionsExportCreateResponseBody channel(String channel)

getChannel

@Nullable
public String getChannel()

The channel through which the export was triggered.

Returns:

channel

setChannel

public void setChannel(String channel)

exportedObject

public VouchersTransactionsExportCreateResponseBody exportedObject(VouchersTransactionsExportCreateResponseBody.ExportedObjectEnum exportedObject)

getExportedObject

@Nullable
public VouchersTransactionsExportCreateResponseBody.ExportedObjectEnum getExportedObject()

The type of exported object.

Returns:

exportedObject

setExportedObject

public void setExportedObject(VouchersTransactionsExportCreateResponseBody.ExportedObjectEnum exportedObject)

parameters

public VouchersTransactionsExportCreateResponseBody parameters(VoucherTransactionsFilters parameters)

getParameters

@Nonnull
public VoucherTransactionsFilters getParameters()

Get parameters

Returns:

parameters

setParameters

public void setParameters(VoucherTransactionsFilters parameters)

result

public VouchersTransactionsExportCreateResponseBody result(VouchersTransactionsExportCreateResponseBodyResult result)

getResult

@Nullable
public VouchersTransactionsExportCreateResponseBodyResult getResult()

Get result

Returns:

result

setResult

public void setResult(VouchersTransactionsExportCreateResponseBodyResult result)

userId

public VouchersTransactionsExportCreateResponseBody userId(String userId)

getUserId

@Nullable
public String getUserId()

Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the `channel` value is `WEBSITE`.

Returns:

userId

setUserId

public void setUserId(String userId)

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

Create an instance of VouchersTransactionsExportCreateResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VouchersTransactionsExportCreateResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of VouchersTransactionsExportCreateResponseBody to an JSON string

Returns:

JSON string