Package io.voucherify.client.model

Class MetadataSchemasGetResponseBody

java.lang.Object

io.voucherify.client.model.MetadataSchemasGetResponseBody

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

Response body schema for **GET** `/v1/metadata-schemas/{resource}`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataSchemasGetResponseBody.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ALLOW_DEFINED_ONLY
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_PROPERTIES
static final String	SERIALIZED_NAME_RELATED_OBJECT
static final String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
MetadataSchemasGetResponseBody()

Method Summary

Modifier and Type	Method	Description
MetadataSchemasGetResponseBody	_object(String _object)
MetadataSchemasGetResponseBody	allowDefinedOnly(Boolean allowDefinedOnly)
MetadataSchemasGetResponseBody	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
static MetadataSchemasGetResponseBody	fromJson(String jsonString)	Create an instance of MetadataSchemasGetResponseBody given an JSON string
Boolean	getAllowDefinedOnly()	Restricts the creation of metadata fields when set to `true`.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the metadata schema was created.
String	getId()	Unique identifier of the metadata schema.
String	getObject()	The type of the object represented by the JSON.
Map<String,MetadataSchemaDefinitionDeprecated>	getProperties()	Contains metadata definitions.
String	getRelatedObject()	The resource type.
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the metadata schema was updated.
int	hashCode()
MetadataSchemasGetResponseBody	id(String id)
MetadataSchemasGetResponseBody	properties(Map<String,MetadataSchemaDefinitionDeprecated> properties)
MetadataSchemasGetResponseBody	putPropertiesItem(String key, MetadataSchemaDefinitionDeprecated propertiesItem)
MetadataSchemasGetResponseBody	relatedObject(String relatedObject)
void	setAllowDefinedOnly(Boolean allowDefinedOnly)
void	setCreatedAt(OffsetDateTime createdAt)
void	setId(String id)
void	setObject(String _object)
void	setProperties(Map<String,MetadataSchemaDefinitionDeprecated> properties)
void	setRelatedObject(String relatedObject)
void	setUpdatedAt(OffsetDateTime updatedAt)
String	toJson()	Convert an instance of MetadataSchemasGetResponseBody to an JSON string
String	toString()
MetadataSchemasGetResponseBody	updatedAt(OffsetDateTime updatedAt)

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_RELATED_OBJECT

public static final String SERIALIZED_NAME_RELATED_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_PROPERTIES

public static final String SERIALIZED_NAME_PROPERTIES

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_DEFINED_ONLY

public static final String SERIALIZED_NAME_ALLOW_DEFINED_ONLY

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

MetadataSchemasGetResponseBody

public MetadataSchemasGetResponseBody()

Method Details

id

public MetadataSchemasGetResponseBody id(String id)

getId

@Nullable
public String getId()

Unique identifier of the metadata schema.

Returns:

id

setId

public void setId(String id)

relatedObject

public MetadataSchemasGetResponseBody relatedObject(String relatedObject)

getRelatedObject

@Nullable
public String getRelatedObject()

The resource type. You can define custom metadata schemas, which have a custom `\"related_object\"` resource type. The standard metadata schemas are: `\"campaign\"`, `\"customer\"`, `\"earning_rule\"`, `\"loyalty_tier\"`, `\"order\"`, `\"order_item\"`, `\"product\"`, `\"promotion_tier\"`, `\"publication\"`, `\"redemption\"`, `\"reward\"`, `\"voucher\"`.

Returns:

relatedObject

setRelatedObject

public void setRelatedObject(String relatedObject)

properties

public MetadataSchemasGetResponseBody properties(Map<String,MetadataSchemaDefinitionDeprecated> properties)

putPropertiesItem

public MetadataSchemasGetResponseBody putPropertiesItem(String key,
 MetadataSchemaDefinitionDeprecated propertiesItem)

getProperties

@Nullable
public Map<String,MetadataSchemaDefinitionDeprecated> getProperties()

Contains metadata definitions.

Returns:

properties

setProperties

public void setProperties(Map<String,MetadataSchemaDefinitionDeprecated> properties)

allowDefinedOnly

public MetadataSchemasGetResponseBody allowDefinedOnly(Boolean allowDefinedOnly)

getAllowDefinedOnly

@Nullable
public Boolean getAllowDefinedOnly()

Restricts the creation of metadata fields when set to `true`. It indicates whether or not you can create new metadata definitions, e.g. in the campaign or publication manager. If set to `true`, then only the defined fields are available for assigning values.

Returns:

allowDefinedOnly

setAllowDefinedOnly

public void setAllowDefinedOnly(Boolean allowDefinedOnly)

createdAt

public MetadataSchemasGetResponseBody createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the metadata schema was created. The value for this parameter is shown in the ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public MetadataSchemasGetResponseBody updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp representing the date and time when the metadata schema was updated. The value for this parameter is shown in the ISO 8601 format.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

_object

public MetadataSchemasGetResponseBody _object(String _object)

getObject

@Nullable
public String getObject()

The type of the object represented by the JSON. This object stores information about the metadata schema.

Returns:

_object

setObject

public void setObject(String _object)

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

Create an instance of MetadataSchemasGetResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of MetadataSchemasGetResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of MetadataSchemasGetResponseBody to an JSON string

Returns:

JSON string