Package io.voucherify.client.model

Class OrdersExportCreateResponseBody

java.lang.Object

io.voucherify.client.model.OrdersExportCreateResponseBody

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

Response body schema for **POST** `v1/orders/export`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OrdersExportCreateResponseBody.CustomTypeAdapterFactory
static enum	OrdersExportCreateResponseBody.ExportedObjectEnum	The type of object to be exported.
static enum	OrdersExportCreateResponseBody.ObjectEnum	The type of object being represented.
static enum	OrdersExportCreateResponseBody.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
OrdersExportCreateResponseBody()

Method Summary

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

OrdersExportCreateResponseBody

public OrdersExportCreateResponseBody()

Method Details

id

public OrdersExportCreateResponseBody id(String id)

getId

@Nullable
public String getId()

Unique export ID.

Returns:

id

setId

public void setId(String id)

_object

public OrdersExportCreateResponseBody _object(OrdersExportCreateResponseBody.ObjectEnum _object)

getObject

@Nullable
public OrdersExportCreateResponseBody.ObjectEnum getObject()

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

Returns:

_object

setObject

public void setObject(OrdersExportCreateResponseBody.ObjectEnum _object)

createdAt

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

getStatus

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

channel

public OrdersExportCreateResponseBody 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 OrdersExportCreateResponseBody result(Object result)

getResult

@Nullable
public Object getResult()

Contains the URL of the CSV file.

Returns:

result

setResult

public void setResult(Object result)

userId

public OrdersExportCreateResponseBody 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 OrdersExportCreateResponseBody exportedObject(OrdersExportCreateResponseBody.ExportedObjectEnum exportedObject)

getExportedObject

@Nullable
public OrdersExportCreateResponseBody.ExportedObjectEnum getExportedObject()

The type of object to be exported.

Returns:

exportedObject

setExportedObject

public void setExportedObject(OrdersExportCreateResponseBody.ExportedObjectEnum exportedObject)

parameters

public OrdersExportCreateResponseBody parameters(OrdersExportCreateResponseBodyParameters parameters)

getParameters

@Nullable
public OrdersExportCreateResponseBodyParameters getParameters()

Get parameters

Returns:

parameters

setParameters

public void setParameters(OrdersExportCreateResponseBodyParameters 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 OrdersExportCreateResponseBody fromJson(String jsonString)
                                               throws IOException

Create an instance of OrdersExportCreateResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of OrdersExportCreateResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of OrdersExportCreateResponseBody to an JSON string

Returns:

JSON string