Package io.voucherify.client.model

Class ManagementProject

java.lang.Object

io.voucherify.client.model.ManagementProject

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

ManagementProject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ManagementProject.ApiVersionEnum	The API version used in the project.
static class	ManagementProject.CustomTypeAdapterFactory
static enum	ManagementProject.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_DEFAULT_CODE_CONFIG
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_DIAL_CODE
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_IS_SANDBOX
static final String	SERIALIZED_NAME_LIMITS
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_TIMEZONE
static final String	SERIALIZED_NAME_WEBHOOK_TOKEN
static final String	SERIALIZED_NAME_WEBHOOK_VERSION
static final String	SERIALIZED_NAME_WEBHOOKS_CALLOUT_NOTIFICATIONS

Constructor Summary

Constructors

Constructor	Description
ManagementProject()

Method Summary

Modifier and Type	Method	Description
ManagementProject	addClientTrustedDomainsItem(String clientTrustedDomainsItem)
ManagementProject	apiUsageNotifications(ManagementProjectApiUsageNotifications apiUsageNotifications)
ManagementProject	apiVersion(ManagementProject.ApiVersionEnum apiVersion)
ManagementProject	caseSensitiveCodes(Boolean caseSensitiveCodes)
ManagementProject	clientCreateCustomerEnabled(Boolean clientCreateCustomerEnabled)
ManagementProject	clientListVouchersEnabled(Boolean clientListVouchersEnabled)
ManagementProject	clientLoyaltyEventsEnabled(Boolean clientLoyaltyEventsEnabled)
ManagementProject	clientPublishEnabled(Boolean clientPublishEnabled)
ManagementProject	clientRedeemEnabled(Boolean clientRedeemEnabled)
ManagementProject	clientSetVoucherExpirationDateEnabled(Boolean clientSetVoucherExpirationDateEnabled)
ManagementProject	clientTrustedDomains(List<String> clientTrustedDomains)
ManagementProject	clusterId(String clusterId)
ManagementProject	currency(String currency)
ManagementProject	defaultCodeConfig(ManagementProjectDefaultCodeConfig defaultCodeConfig)
ManagementProject	description(String description)
ManagementProject	dialCode(String dialCode)
boolean	equals(Object o)
static ManagementProject	fromJson(String jsonString)	Create an instance of ManagementProject given an JSON string
ManagementProjectApiUsageNotifications	getApiUsageNotifications()	Get apiUsageNotifications
ManagementProject.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`), - 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.
ManagementProjectDefaultCodeConfig	getDefaultCodeConfig()	Get defaultCodeConfig
String	getDescription()	A user-defined description of the project, e.g.
String	getDialCode()	The country dial code for the project.
String	getId()	Unique identifier of the project.
Boolean	getIsSandbox()	Determines if the project is a sandbox project.
ManagementProjectLimits	getLimits()	Get limits
String	getName()	The name of the project.
String	getTimezone()	The time zone in which the project is established.
ManagementProjectWebhooksCalloutNotifications	getWebhooksCalloutNotifications()	Get webhooksCalloutNotifications
String	getWebhookToken()	Webhook token used for authentication.
ManagementProject.WebhookVersionEnum	getWebhookVersion()	The webhook version used in the project.
int	hashCode()
ManagementProject	id(String id)
ManagementProject	isSandbox(Boolean isSandbox)
ManagementProject	limits(ManagementProjectLimits limits)
ManagementProject	name(String name)
void	setApiUsageNotifications(ManagementProjectApiUsageNotifications apiUsageNotifications)
void	setApiVersion(ManagementProject.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	setDefaultCodeConfig(ManagementProjectDefaultCodeConfig defaultCodeConfig)
void	setDescription(String description)
void	setDialCode(String dialCode)
void	setId(String id)
void	setIsSandbox(Boolean isSandbox)
void	setLimits(ManagementProjectLimits limits)
void	setName(String name)
void	setTimezone(String timezone)
void	setWebhooksCalloutNotifications(ManagementProjectWebhooksCalloutNotifications webhooksCalloutNotifications)
void	setWebhookToken(String webhookToken)
void	setWebhookVersion(ManagementProject.WebhookVersionEnum webhookVersion)
ManagementProject	timezone(String timezone)
String	toJson()	Convert an instance of ManagementProject to an JSON string
String	toString()
ManagementProject	webhooksCalloutNotifications(ManagementProjectWebhooksCalloutNotifications webhooksCalloutNotifications)
ManagementProject	webhookToken(String webhookToken)
ManagementProject	webhookVersion(ManagementProject.WebhookVersionEnum webhookVersion)

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_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_CASE_SENSITIVE_CODES

public static final String SERIALIZED_NAME_CASE_SENSITIVE_CODES

See Also:

• Constant Field Values

SERIALIZED_NAME_API_VERSION

public static final String SERIALIZED_NAME_API_VERSION

See Also:

• Constant Field Values

SERIALIZED_NAME_IS_SANDBOX

public static final String SERIALIZED_NAME_IS_SANDBOX

See Also:

• Constant Field Values

SERIALIZED_NAME_WEBHOOK_TOKEN

public static final String SERIALIZED_NAME_WEBHOOK_TOKEN

See Also:

• Constant Field Values

SERIALIZED_NAME_DEFAULT_CODE_CONFIG

public static final String SERIALIZED_NAME_DEFAULT_CODE_CONFIG

See Also:

• Constant Field Values

SERIALIZED_NAME_LIMITS

public static final String SERIALIZED_NAME_LIMITS

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

ManagementProject

public ManagementProject()

Method Details

id

public ManagementProject id(String id)

getId

@Nullable
public String getId()

Unique identifier of the project.

Returns:

id

setId

public void setId(String id)

name

public ManagementProject name(String name)

getName

@Nullable
public String getName()

The name of the project.

Returns:

name

setName

public void setName(String name)

description

public ManagementProject 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 ManagementProject 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 ManagementProject 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 ManagementProject 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 ManagementProject webhookVersion(ManagementProject.WebhookVersionEnum webhookVersion)

getWebhookVersion

@Nullable
public ManagementProject.WebhookVersionEnum getWebhookVersion()

The webhook version used in the project.

Returns:

webhookVersion

setWebhookVersion

public void setWebhookVersion(ManagementProject.WebhookVersionEnum webhookVersion)

clientTrustedDomains

public ManagementProject clientTrustedDomains(List<String> clientTrustedDomains)

addClientTrustedDomainsItem

public ManagementProject 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 ManagementProject clientRedeemEnabled(Boolean clientRedeemEnabled)

getClientRedeemEnabled

@Nullable
public Boolean getClientRedeemEnabled()

Enables client-side redemption.

Returns:

clientRedeemEnabled

setClientRedeemEnabled

public void setClientRedeemEnabled(Boolean clientRedeemEnabled)

clientPublishEnabled

public ManagementProject clientPublishEnabled(Boolean clientPublishEnabled)

getClientPublishEnabled

@Nullable
public Boolean getClientPublishEnabled()

Enables client-side publication.

Returns:

clientPublishEnabled

setClientPublishEnabled

public void setClientPublishEnabled(Boolean clientPublishEnabled)

clientListVouchersEnabled

public ManagementProject clientListVouchersEnabled(Boolean clientListVouchersEnabled)

getClientListVouchersEnabled

@Nullable
public Boolean getClientListVouchersEnabled()

Enables client-side listing of vouchers.

Returns:

clientListVouchersEnabled

setClientListVouchersEnabled

public void setClientListVouchersEnabled(Boolean clientListVouchersEnabled)

clientCreateCustomerEnabled

public ManagementProject clientCreateCustomerEnabled(Boolean clientCreateCustomerEnabled)

getClientCreateCustomerEnabled

@Nullable
public Boolean getClientCreateCustomerEnabled()

Enables client-side creation of customers.

Returns:

clientCreateCustomerEnabled

setClientCreateCustomerEnabled

public void setClientCreateCustomerEnabled(Boolean clientCreateCustomerEnabled)

clientLoyaltyEventsEnabled

public ManagementProject 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 ManagementProject 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 ManagementProject webhooksCalloutNotifications(ManagementProjectWebhooksCalloutNotifications webhooksCalloutNotifications)

getWebhooksCalloutNotifications

@Nullable
public ManagementProjectWebhooksCalloutNotifications getWebhooksCalloutNotifications()

Get webhooksCalloutNotifications

Returns:

webhooksCalloutNotifications

setWebhooksCalloutNotifications

public void setWebhooksCalloutNotifications(ManagementProjectWebhooksCalloutNotifications webhooksCalloutNotifications)

apiUsageNotifications

public ManagementProject apiUsageNotifications(ManagementProjectApiUsageNotifications apiUsageNotifications)

getApiUsageNotifications

@Nullable
public ManagementProjectApiUsageNotifications getApiUsageNotifications()

Get apiUsageNotifications

Returns:

apiUsageNotifications

setApiUsageNotifications

public void setApiUsageNotifications(ManagementProjectApiUsageNotifications apiUsageNotifications)

clusterId

public ManagementProject clusterId(String clusterId)

getClusterId

@Nullable
public String getClusterId()

The identifier of the cluster where the project will be created.

Returns:

clusterId

setClusterId

public void setClusterId(String clusterId)

caseSensitiveCodes

public ManagementProject 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`), - case insensitive - if `false`, `C0dE-cfV` is equal to `c0de-cfv`.

Returns:

caseSensitiveCodes

setCaseSensitiveCodes

public void setCaseSensitiveCodes(Boolean caseSensitiveCodes)

apiVersion

public ManagementProject apiVersion(ManagementProject.ApiVersionEnum apiVersion)

getApiVersion

@Nullable
public ManagementProject.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(ManagementProject.ApiVersionEnum apiVersion)

isSandbox

public ManagementProject isSandbox(Boolean isSandbox)

getIsSandbox

@Nullable
public Boolean getIsSandbox()

Determines if the project is a sandbox project.

Returns:

isSandbox

setIsSandbox

public void setIsSandbox(Boolean isSandbox)

webhookToken

public ManagementProject webhookToken(String webhookToken)

getWebhookToken

@Nullable
public String getWebhookToken()

Webhook token used for authentication.

Returns:

webhookToken

setWebhookToken

public void setWebhookToken(String webhookToken)

defaultCodeConfig

public ManagementProject defaultCodeConfig(ManagementProjectDefaultCodeConfig defaultCodeConfig)

getDefaultCodeConfig

@Nullable
public ManagementProjectDefaultCodeConfig getDefaultCodeConfig()

Get defaultCodeConfig

Returns:

defaultCodeConfig

setDefaultCodeConfig

public void setDefaultCodeConfig(ManagementProjectDefaultCodeConfig defaultCodeConfig)

limits

public ManagementProject limits(ManagementProjectLimits limits)

getLimits

@Nullable
public ManagementProjectLimits getLimits()

Get limits

Returns:

limits

setLimits

public void setLimits(ManagementProjectLimits limits)

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

Create an instance of ManagementProject given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ManagementProject

Throws:

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

toJson

public String toJson()

Convert an instance of ManagementProject to an JSON string

Returns:

JSON string