Package io.voucherify.client.model

Class ManagementProjectsCreateRequestBody

java.lang.Object

io.voucherify.client.model.ManagementProjectsCreateRequestBody

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

Request body schema for **POST** `/management/v1/projects`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ManagementProjectsCreateRequestBody.ApiVersionEnum	The API version used in the project.
static class	ManagementProjectsCreateRequestBody.CustomTypeAdapterFactory
static enum	ManagementProjectsCreateRequestBody.WebhookVersionEnum	The webhook version used in the project.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_API_USAGE_NOTIFICATIONS
static final String	SERIALIZED_NAME_API_VERSION
static final String	SERIALIZED_NAME_CASE_SENSITIVE_CODES
static final String	SERIALIZED_NAME_CLIENT_CREATE_CUSTOMER_ENABLED
static final String	SERIALIZED_NAME_CLIENT_LIST_VOUCHERS_ENABLED
static final String	SERIALIZED_NAME_CLIENT_LOYALTY_EVENTS_ENABLED
static final String	SERIALIZED_NAME_CLIENT_PUBLISH_ENABLED
static final String	SERIALIZED_NAME_CLIENT_REDEEM_ENABLED
static final String	SERIALIZED_NAME_CLIENT_SET_VOUCHER_EXPIRATION_DATE_ENABLED
static final String	SERIALIZED_NAME_CLIENT_TRUSTED_DOMAINS
static final String	SERIALIZED_NAME_CLUSTER_ID
static final String	SERIALIZED_NAME_CURRENCY
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_DIAL_CODE
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_TIMEZONE
static final String	SERIALIZED_NAME_USERS
static final String	SERIALIZED_NAME_WEBHOOK_VERSION
static final String	SERIALIZED_NAME_WEBHOOKS_CALLOUT_NOTIFICATIONS

Constructor Summary

Constructors

Constructor	Description
ManagementProjectsCreateRequestBody()

Method Summary

Modifier and Type	Method	Description
ManagementProjectsCreateRequestBody	addClientTrustedDomainsItem(String clientTrustedDomainsItem)
ManagementProjectsCreateRequestBody	addUsersItem(ManagementProjectsCreateRequestBodyUsersItem usersItem)
ManagementProjectsCreateRequestBody	apiUsageNotifications(ManagementProjectsCreateRequestBodyApiUsageNotifications apiUsageNotifications)
ManagementProjectsCreateRequestBody	apiVersion(ManagementProjectsCreateRequestBody.ApiVersionEnum apiVersion)
ManagementProjectsCreateRequestBody	caseSensitiveCodes(Boolean caseSensitiveCodes)
ManagementProjectsCreateRequestBody	clientCreateCustomerEnabled(Boolean clientCreateCustomerEnabled)
ManagementProjectsCreateRequestBody	clientListVouchersEnabled(Boolean clientListVouchersEnabled)
ManagementProjectsCreateRequestBody	clientLoyaltyEventsEnabled(Boolean clientLoyaltyEventsEnabled)
ManagementProjectsCreateRequestBody	clientPublishEnabled(Boolean clientPublishEnabled)
ManagementProjectsCreateRequestBody	clientRedeemEnabled(Boolean clientRedeemEnabled)
ManagementProjectsCreateRequestBody	clientSetVoucherExpirationDateEnabled(Boolean clientSetVoucherExpirationDateEnabled)
ManagementProjectsCreateRequestBody	clientTrustedDomains(List<String> clientTrustedDomains)
ManagementProjectsCreateRequestBody	clusterId(String clusterId)
ManagementProjectsCreateRequestBody	currency(String currency)
ManagementProjectsCreateRequestBody	description(String description)
ManagementProjectsCreateRequestBody	dialCode(String dialCode)
boolean	equals(Object o)
static ManagementProjectsCreateRequestBody	fromJson(String jsonString)	Create an instance of ManagementProjectsCreateRequestBody given an JSON string
ManagementProjectsCreateRequestBodyApiUsageNotifications	getApiUsageNotifications()	Get apiUsageNotifications
ManagementProjectsCreateRequestBody.ApiVersionEnum	getApiVersion()	The API version used in the project.
Boolean	getCaseSensitiveCodes()	Determines if the vouchers in the project will be case sensitive (if `true`, `C0dE-cfV` is not equal to `c0de-cfv`) or case insensitive (if false, `C0dE-cfV` is equal to `c0de-cfv`).
Boolean	getClientCreateCustomerEnabled()	Enables client-side creation of customers.
Boolean	getClientListVouchersEnabled()	Enables client-side listing of vouchers.
Boolean	getClientLoyaltyEventsEnabled()	Enables client-side events for loyalty and referral programs.
Boolean	getClientPublishEnabled()	Enables client-side publication.
Boolean	getClientRedeemEnabled()	Enables client-side redemption.
Boolean	getClientSetVoucherExpirationDateEnabled()	Enables client-side setting of voucher expiration date.
List<String>	getClientTrustedDomains()	An array of URL addresses that allow client requests.
String	getClusterId()	The identifier of the cluster where the project will be created.
String	getCurrency()	The currency used in the project.
String	getDescription()	A user-defined description of the project, e.g.
String	getDialCode()	The country dial code for the project.
String	getName()	The name of the project.
String	getTimezone()	The time zone in which the project is established.
List<ManagementProjectsCreateRequestBodyUsersItem>	getUsers()	The users (their identifiers, logins, and roles) who will be assigned to the project.
ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications	getWebhooksCalloutNotifications()	Get webhooksCalloutNotifications
ManagementProjectsCreateRequestBody.WebhookVersionEnum	getWebhookVersion()	The webhook version used in the project.
int	hashCode()
ManagementProjectsCreateRequestBody	name(String name)
void	setApiUsageNotifications(ManagementProjectsCreateRequestBodyApiUsageNotifications apiUsageNotifications)
void	setApiVersion(ManagementProjectsCreateRequestBody.ApiVersionEnum apiVersion)
void	setCaseSensitiveCodes(Boolean caseSensitiveCodes)
void	setClientCreateCustomerEnabled(Boolean clientCreateCustomerEnabled)
void	setClientListVouchersEnabled(Boolean clientListVouchersEnabled)
void	setClientLoyaltyEventsEnabled(Boolean clientLoyaltyEventsEnabled)
void	setClientPublishEnabled(Boolean clientPublishEnabled)
void	setClientRedeemEnabled(Boolean clientRedeemEnabled)
void	setClientSetVoucherExpirationDateEnabled(Boolean clientSetVoucherExpirationDateEnabled)
void	setClientTrustedDomains(List<String> clientTrustedDomains)
void	setClusterId(String clusterId)
void	setCurrency(String currency)
void	setDescription(String description)
void	setDialCode(String dialCode)
void	setName(String name)
void	setTimezone(String timezone)
void	setUsers(List<ManagementProjectsCreateRequestBodyUsersItem> users)
void	setWebhooksCalloutNotifications(ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications webhooksCalloutNotifications)
void	setWebhookVersion(ManagementProjectsCreateRequestBody.WebhookVersionEnum webhookVersion)
ManagementProjectsCreateRequestBody	timezone(String timezone)
String	toJson()	Convert an instance of ManagementProjectsCreateRequestBody to an JSON string
String	toString()
ManagementProjectsCreateRequestBody	users(List<ManagementProjectsCreateRequestBodyUsersItem> users)
ManagementProjectsCreateRequestBody	webhooksCalloutNotifications(ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications webhooksCalloutNotifications)
ManagementProjectsCreateRequestBody	webhookVersion(ManagementProjectsCreateRequestBody.WebhookVersionEnum webhookVersion)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_CASE_SENSITIVE_CODES

public static final String SERIALIZED_NAME_CASE_SENSITIVE_CODES

See Also:

• Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_TIMEZONE

public static final String SERIALIZED_NAME_TIMEZONE

See Also:

• Constant Field Values

SERIALIZED_NAME_CURRENCY

public static final String SERIALIZED_NAME_CURRENCY

See Also:

• Constant Field Values

SERIALIZED_NAME_DIAL_CODE

public static final String SERIALIZED_NAME_DIAL_CODE

See Also:

• Constant Field Values

SERIALIZED_NAME_WEBHOOK_VERSION

public static final String SERIALIZED_NAME_WEBHOOK_VERSION

See Also:

• Constant Field Values

SERIALIZED_NAME_CLIENT_TRUSTED_DOMAINS

public static final String SERIALIZED_NAME_CLIENT_TRUSTED_DOMAINS

See Also:

• Constant Field Values

SERIALIZED_NAME_CLIENT_REDEEM_ENABLED

public static final String SERIALIZED_NAME_CLIENT_REDEEM_ENABLED

See Also:

• Constant Field Values

SERIALIZED_NAME_CLIENT_PUBLISH_ENABLED

public static final String SERIALIZED_NAME_CLIENT_PUBLISH_ENABLED

See Also:

• Constant Field Values

SERIALIZED_NAME_CLIENT_LIST_VOUCHERS_ENABLED

public static final String SERIALIZED_NAME_CLIENT_LIST_VOUCHERS_ENABLED

See Also:

• Constant Field Values

SERIALIZED_NAME_CLIENT_CREATE_CUSTOMER_ENABLED

public static final String SERIALIZED_NAME_CLIENT_CREATE_CUSTOMER_ENABLED

See Also:

• Constant Field Values

SERIALIZED_NAME_CLIENT_LOYALTY_EVENTS_ENABLED

public static final String SERIALIZED_NAME_CLIENT_LOYALTY_EVENTS_ENABLED

See Also:

• Constant Field Values

SERIALIZED_NAME_CLIENT_SET_VOUCHER_EXPIRATION_DATE_ENABLED

public static final String SERIALIZED_NAME_CLIENT_SET_VOUCHER_EXPIRATION_DATE_ENABLED

See Also:

• Constant Field Values

SERIALIZED_NAME_WEBHOOKS_CALLOUT_NOTIFICATIONS

public static final String SERIALIZED_NAME_WEBHOOKS_CALLOUT_NOTIFICATIONS

See Also:

• Constant Field Values

SERIALIZED_NAME_API_USAGE_NOTIFICATIONS

public static final String SERIALIZED_NAME_API_USAGE_NOTIFICATIONS

See Also:

• Constant Field Values

SERIALIZED_NAME_CLUSTER_ID

public static final String SERIALIZED_NAME_CLUSTER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_API_VERSION

public static final String SERIALIZED_NAME_API_VERSION

See Also:

• Constant Field Values

SERIALIZED_NAME_USERS

public static final String SERIALIZED_NAME_USERS

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

ManagementProjectsCreateRequestBody

public ManagementProjectsCreateRequestBody()

Method Details

caseSensitiveCodes

public ManagementProjectsCreateRequestBody caseSensitiveCodes(Boolean caseSensitiveCodes)

getCaseSensitiveCodes

@Nullable
public Boolean getCaseSensitiveCodes()

Determines if the vouchers in the project will be case sensitive (if `true`, `C0dE-cfV` is not equal to `c0de-cfv`) or case insensitive (if false, `C0dE-cfV` is equal to `c0de-cfv`).

Returns:

caseSensitiveCodes

setCaseSensitiveCodes

public void setCaseSensitiveCodes(Boolean caseSensitiveCodes)

name

public ManagementProjectsCreateRequestBody name(String name)

getName

@Nullable
public String getName()

The name of the project.

Returns:

name

setName

public void setName(String name)

description

public ManagementProjectsCreateRequestBody description(String description)

getDescription

@Nullable
public String getDescription()

A user-defined description of the project, e.g. its purpose, scope, region.

Returns:

description

setDescription

public void setDescription(String description)

timezone

public ManagementProjectsCreateRequestBody timezone(String timezone)

getTimezone

@Nullable
public String getTimezone()

The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database.

Returns:

timezone

setTimezone

public void setTimezone(String timezone)

currency

public ManagementProjectsCreateRequestBody currency(String currency)

getCurrency

@Nullable
public String getCurrency()

The currency used in the project. It is equal to a 3-letter ISO 4217 code.

Returns:

currency

setCurrency

public void setCurrency(String currency)

dialCode

public ManagementProjectsCreateRequestBody dialCode(String dialCode)

getDialCode

@Nullable
public String getDialCode()

The country dial code for the project. It is equal to an ITU country code.

Returns:

dialCode

setDialCode

public void setDialCode(String dialCode)

webhookVersion

public ManagementProjectsCreateRequestBody webhookVersion(ManagementProjectsCreateRequestBody.WebhookVersionEnum webhookVersion)

getWebhookVersion

@Nullable
public ManagementProjectsCreateRequestBody.WebhookVersionEnum getWebhookVersion()

The webhook version used in the project.

Returns:

webhookVersion

setWebhookVersion

public void setWebhookVersion(ManagementProjectsCreateRequestBody.WebhookVersionEnum webhookVersion)

clientTrustedDomains

public ManagementProjectsCreateRequestBody clientTrustedDomains(List<String> clientTrustedDomains)

addClientTrustedDomainsItem

public ManagementProjectsCreateRequestBody addClientTrustedDomainsItem(String clientTrustedDomainsItem)

getClientTrustedDomains

@Nullable
public List<String> getClientTrustedDomains()

An array of URL addresses that allow client requests.

Returns:

clientTrustedDomains

setClientTrustedDomains

public void setClientTrustedDomains(List<String> clientTrustedDomains)

clientRedeemEnabled

public ManagementProjectsCreateRequestBody clientRedeemEnabled(Boolean clientRedeemEnabled)

getClientRedeemEnabled

@Nullable
public Boolean getClientRedeemEnabled()

Enables client-side redemption.

Returns:

clientRedeemEnabled

setClientRedeemEnabled

public void setClientRedeemEnabled(Boolean clientRedeemEnabled)

clientPublishEnabled

public ManagementProjectsCreateRequestBody clientPublishEnabled(Boolean clientPublishEnabled)

getClientPublishEnabled

@Nullable
public Boolean getClientPublishEnabled()

Enables client-side publication.

Returns:

clientPublishEnabled

setClientPublishEnabled

public void setClientPublishEnabled(Boolean clientPublishEnabled)

clientListVouchersEnabled

public ManagementProjectsCreateRequestBody clientListVouchersEnabled(Boolean clientListVouchersEnabled)

getClientListVouchersEnabled

@Nullable
public Boolean getClientListVouchersEnabled()

Enables client-side listing of vouchers.

Returns:

clientListVouchersEnabled

setClientListVouchersEnabled

public void setClientListVouchersEnabled(Boolean clientListVouchersEnabled)

clientCreateCustomerEnabled

public ManagementProjectsCreateRequestBody clientCreateCustomerEnabled(Boolean clientCreateCustomerEnabled)

getClientCreateCustomerEnabled

@Nullable
public Boolean getClientCreateCustomerEnabled()

Enables client-side creation of customers.

Returns:

clientCreateCustomerEnabled

setClientCreateCustomerEnabled

public void setClientCreateCustomerEnabled(Boolean clientCreateCustomerEnabled)

clientLoyaltyEventsEnabled

public ManagementProjectsCreateRequestBody clientLoyaltyEventsEnabled(Boolean clientLoyaltyEventsEnabled)

getClientLoyaltyEventsEnabled

@Nullable
public Boolean getClientLoyaltyEventsEnabled()

Enables client-side events for loyalty and referral programs.

Returns:

clientLoyaltyEventsEnabled

setClientLoyaltyEventsEnabled

public void setClientLoyaltyEventsEnabled(Boolean clientLoyaltyEventsEnabled)

clientSetVoucherExpirationDateEnabled

public ManagementProjectsCreateRequestBody clientSetVoucherExpirationDateEnabled(Boolean clientSetVoucherExpirationDateEnabled)

getClientSetVoucherExpirationDateEnabled

@Nullable
public Boolean getClientSetVoucherExpirationDateEnabled()

Enables client-side setting of voucher expiration date.

Returns:

clientSetVoucherExpirationDateEnabled

setClientSetVoucherExpirationDateEnabled

public void setClientSetVoucherExpirationDateEnabled(Boolean clientSetVoucherExpirationDateEnabled)

webhooksCalloutNotifications

public ManagementProjectsCreateRequestBody webhooksCalloutNotifications(ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications webhooksCalloutNotifications)

getWebhooksCalloutNotifications

@Nullable
public ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications getWebhooksCalloutNotifications()

Get webhooksCalloutNotifications

Returns:

webhooksCalloutNotifications

setWebhooksCalloutNotifications

public void setWebhooksCalloutNotifications(ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications webhooksCalloutNotifications)

apiUsageNotifications

public ManagementProjectsCreateRequestBody apiUsageNotifications(ManagementProjectsCreateRequestBodyApiUsageNotifications apiUsageNotifications)

getApiUsageNotifications

@Nullable
public ManagementProjectsCreateRequestBodyApiUsageNotifications getApiUsageNotifications()

Get apiUsageNotifications

Returns:

apiUsageNotifications

setApiUsageNotifications

public void setApiUsageNotifications(ManagementProjectsCreateRequestBodyApiUsageNotifications apiUsageNotifications)

clusterId

public ManagementProjectsCreateRequestBody clusterId(String clusterId)

getClusterId

@Nullable
public String getClusterId()

The identifier of the cluster where the project will be created. The default cluster is `eu1` unless otherwise configured.

Returns:

clusterId

setClusterId

public void setClusterId(String clusterId)

apiVersion

public ManagementProjectsCreateRequestBody apiVersion(ManagementProjectsCreateRequestBody.ApiVersionEnum apiVersion)

getApiVersion

@Nullable
public ManagementProjectsCreateRequestBody.ApiVersionEnum getApiVersion()

The API version used in the project. Currently, the default and only value is `v2018-08-01`.

Returns:

apiVersion

setApiVersion

public void setApiVersion(ManagementProjectsCreateRequestBody.ApiVersionEnum apiVersion)

users

public ManagementProjectsCreateRequestBody users(List<ManagementProjectsCreateRequestBodyUsersItem> users)

addUsersItem

public ManagementProjectsCreateRequestBody addUsersItem(ManagementProjectsCreateRequestBodyUsersItem usersItem)

getUsers

@Nullable
public List<ManagementProjectsCreateRequestBodyUsersItem> getUsers()

The users (their identifiers, logins, and roles) who will be assigned to the project. You can assign only existing Voucherify users. It must be used either in the following combinations: - `id` and `role`, or - `login` and `role`.

Returns:

users

setUsers

public void setUsers(List<ManagementProjectsCreateRequestBodyUsersItem> users)

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

Create an instance of ManagementProjectsCreateRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ManagementProjectsCreateRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of ManagementProjectsCreateRequestBody to an JSON string

Returns:

JSON string