Package io.voucherify.client.model

Class ExportsGetResponseBody

java.lang.Object

io.voucherify.client.model.ExportsGetResponseBody

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

Response body schema for **GET** `v1/exports/{exportId}`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExportsGetResponseBody.CustomTypeAdapterFactory
static enum	ExportsGetResponseBody.ExportedObjectEnum	Gets or Sets exportedObject
static enum	ExportsGetResponseBody.ObjectEnum	The type of object being represented.
static enum	ExportsGetResponseBody.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
ExportsGetResponseBody()

Method Summary

Modifier and Type	Method	Description
ExportsGetResponseBody	_object(ExportsGetResponseBody.ObjectEnum _object)
ExportsGetResponseBody	channel(String channel)
ExportsGetResponseBody	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
ExportsGetResponseBody	exportedObject(ExportsGetResponseBody.ExportedObjectEnum exportedObject)
static ExportsGetResponseBody	fromJson(String jsonString)	Create an instance of ExportsGetResponseBody 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.
ExportsGetResponseBody.ExportedObjectEnum	getExportedObject()	Get exportedObject
String	getId()	Unique export ID.
ExportsGetResponseBody.ObjectEnum	getObject()	The type of object being represented.
ExportsGetResponseBodyParameters	getParameters()	Get parameters
ExportsGetResponseBodyResult	getResult()	Get result
ExportsGetResponseBody.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()
ExportsGetResponseBody	id(String id)
ExportsGetResponseBody	parameters(ExportsGetResponseBodyParameters parameters)
ExportsGetResponseBody	result(ExportsGetResponseBodyResult result)
void	setChannel(String channel)
void	setCreatedAt(OffsetDateTime createdAt)
void	setExportedObject(ExportsGetResponseBody.ExportedObjectEnum exportedObject)
void	setId(String id)
void	setObject(ExportsGetResponseBody.ObjectEnum _object)
void	setParameters(ExportsGetResponseBodyParameters parameters)
void	setResult(ExportsGetResponseBodyResult result)
void	setStatus(ExportsGetResponseBody.StatusEnum status)
void	setUserId(String userId)
ExportsGetResponseBody	status(ExportsGetResponseBody.StatusEnum status)
String	toJson()	Convert an instance of ExportsGetResponseBody to an JSON string
String	toString()
ExportsGetResponseBody	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_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

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

ExportsGetResponseBody

public ExportsGetResponseBody()

Method Details

id

public ExportsGetResponseBody id(String id)

getId

@Nullable
public String getId()

Unique export ID.

Returns:

id

setId

public void setId(String id)

_object

public ExportsGetResponseBody _object(ExportsGetResponseBody.ObjectEnum _object)

getObject

@Nullable
public ExportsGetResponseBody.ObjectEnum getObject()

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

Returns:

_object

setObject

public void setObject(ExportsGetResponseBody.ObjectEnum _object)

createdAt

public ExportsGetResponseBody 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 ExportsGetResponseBody status(ExportsGetResponseBody.StatusEnum status)

getStatus

@Nullable
public ExportsGetResponseBody.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(ExportsGetResponseBody.StatusEnum status)

channel

public ExportsGetResponseBody channel(String channel)

getChannel

@Nullable
public String getChannel()

The channel through which the export was triggered.

Returns:

channel

setChannel

public void setChannel(String channel)

result

public ExportsGetResponseBody result(ExportsGetResponseBodyResult result)

getResult

@Nullable
public ExportsGetResponseBodyResult getResult()

Get result

Returns:

result

setResult

public void setResult(ExportsGetResponseBodyResult result)

userId

public ExportsGetResponseBody 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)

exportedObject

public ExportsGetResponseBody exportedObject(ExportsGetResponseBody.ExportedObjectEnum exportedObject)

getExportedObject

@Nullable
public ExportsGetResponseBody.ExportedObjectEnum getExportedObject()

Get exportedObject

Returns:

exportedObject

setExportedObject

public void setExportedObject(ExportsGetResponseBody.ExportedObjectEnum exportedObject)

parameters

public ExportsGetResponseBody parameters(ExportsGetResponseBodyParameters parameters)

getParameters

@Nullable
public ExportsGetResponseBodyParameters getParameters()

Get parameters

Returns:

parameters

setParameters

public void setParameters(ExportsGetResponseBodyParameters parameters)

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

Create an instance of ExportsGetResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ExportsGetResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of ExportsGetResponseBody to an JSON string

Returns:

JSON string