Package io.voucherify.client.model

Class CustomersCreateRequestBody

java.lang.Object

io.voucherify.client.model.CustomersCreateRequestBody

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

Request body schema for **POST** `v1/customers`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomersCreateRequestBody.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ADDRESS
static final String	SERIALIZED_NAME_BIRTHDATE
static final String	SERIALIZED_NAME_BIRTHDAY
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_EMAIL
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_PHONE
static final String	SERIALIZED_NAME_SOURCE_ID

Constructor Summary

Constructors

Constructor	Description
CustomersCreateRequestBody()

Method Summary

Modifier and Type	Method	Description
CustomersCreateRequestBody	address(CustomersCreateRequestBodyAddress address)
CustomersCreateRequestBody	birthdate(LocalDate birthdate)
CustomersCreateRequestBody	birthday(LocalDate birthday)
CustomersCreateRequestBody	description(String description)
CustomersCreateRequestBody	email(String email)
boolean	equals(Object o)
static CustomersCreateRequestBody	fromJson(String jsonString)	Create an instance of CustomersCreateRequestBody given an JSON string
CustomersCreateRequestBodyAddress	getAddress()	Get address
LocalDate	getBirthdate()	Customer's birthdate; format YYYY-MM-DD.
LocalDate	getBirthday()	`Deprecated`.
String	getDescription()	An arbitrary string that you can attach to a customer object.
String	getEmail()	Customer's email address.
String	getId()	The ID of an existing customer.
Object	getMetadata()	A set of custom key/value pairs that you can attach to a customer.
String	getName()	Customer's first and last name.
String	getPhone()	Customer's phone number.
String	getSourceId()	A unique identifier of the customer who validates a voucher.
int	hashCode()
CustomersCreateRequestBody	id(String id)
CustomersCreateRequestBody	metadata(Object metadata)
CustomersCreateRequestBody	name(String name)
CustomersCreateRequestBody	phone(String phone)
void	setAddress(CustomersCreateRequestBodyAddress address)
void	setBirthdate(LocalDate birthdate)
void	setBirthday(LocalDate birthday)
void	setDescription(String description)
void	setEmail(String email)
void	setId(String id)
void	setMetadata(Object metadata)
void	setName(String name)
void	setPhone(String phone)
void	setSourceId(String sourceId)
CustomersCreateRequestBody	sourceId(String sourceId)
String	toJson()	Convert an instance of CustomersCreateRequestBody to an JSON string
String	toString()

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_SOURCE_ID

public static final String SERIALIZED_NAME_SOURCE_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_EMAIL

public static final String SERIALIZED_NAME_EMAIL

See Also:

• Constant Field Values

SERIALIZED_NAME_PHONE

public static final String SERIALIZED_NAME_PHONE

See Also:

• Constant Field Values

SERIALIZED_NAME_BIRTHDAY

public static final String SERIALIZED_NAME_BIRTHDAY

See Also:

• Constant Field Values

SERIALIZED_NAME_BIRTHDATE

public static final String SERIALIZED_NAME_BIRTHDATE

See Also:

• Constant Field Values

SERIALIZED_NAME_ADDRESS

public static final String SERIALIZED_NAME_ADDRESS

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

CustomersCreateRequestBody

public CustomersCreateRequestBody()

Method Details

id

public CustomersCreateRequestBody id(String id)

getId

@Nullable
public String getId()

The ID of an existing customer.

Returns:

id

setId

public void setId(String id)

sourceId

public CustomersCreateRequestBody sourceId(String sourceId)

getSourceId

@Nullable
public String getSourceId()

A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored.

Returns:

sourceId

setSourceId

public void setSourceId(String sourceId)

name

public CustomersCreateRequestBody name(String name)

getName

@Nullable
public String getName()

Customer's first and last name.

Returns:

name

setName

public void setName(String name)

description

public CustomersCreateRequestBody description(String description)

getDescription

@Nullable
public String getDescription()

An arbitrary string that you can attach to a customer object.

Returns:

description

setDescription

public void setDescription(String description)

email

public CustomersCreateRequestBody email(String email)

getEmail

@Nullable
public String getEmail()

Customer's email address.

Returns:

email

setEmail

public void setEmail(String email)

phone

public CustomersCreateRequestBody phone(String phone)

getPhone

@Nullable
public String getPhone()

Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.

Returns:

phone

setPhone

public void setPhone(String phone)

birthday

public CustomersCreateRequestBody birthday(LocalDate birthday)

getBirthday

@Nullable
public LocalDate getBirthday()

`Deprecated`. ~~Customer's birthdate; format YYYY-MM-DD~~.

Returns:

birthday

setBirthday

public void setBirthday(LocalDate birthday)

birthdate

public CustomersCreateRequestBody birthdate(LocalDate birthdate)

getBirthdate

@Nullable
public LocalDate getBirthdate()

Customer's birthdate; format YYYY-MM-DD.

Returns:

birthdate

setBirthdate

public void setBirthdate(LocalDate birthdate)

address

public CustomersCreateRequestBody address(CustomersCreateRequestBodyAddress address)

getAddress

@Nullable
public CustomersCreateRequestBodyAddress getAddress()

Get address

Returns:

address

setAddress

public void setAddress(CustomersCreateRequestBodyAddress address)

metadata

public CustomersCreateRequestBody metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

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

Create an instance of CustomersCreateRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CustomersCreateRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of CustomersCreateRequestBody to an JSON string

Returns:

JSON string