Package io.voucherify.client.model

Class CustomersGetResponseBody

java.lang.Object

io.voucherify.client.model.CustomersGetResponseBody

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

Response body schema for **GET** `v1/customers/{customerId}`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomersGetResponseBody.CustomTypeAdapterFactory
static enum	CustomersGetResponseBody.ObjectEnum	The type of the object represented by JSON.

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_ASSETS
static final String	SERIALIZED_NAME_BIRTHDATE
static final String	SERIALIZED_NAME_BIRTHDAY
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_EMAIL
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_LOYALTY
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_PHONE
static final String	SERIALIZED_NAME_REFERRALS
static final String	SERIALIZED_NAME_SOURCE_ID
static final String	SERIALIZED_NAME_SUMMARY
static final String	SERIALIZED_NAME_SYSTEM_METADATA
static final String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
CustomersGetResponseBody()

Method Summary

Modifier and Type	Method	Description
CustomersGetResponseBody	_object(CustomersGetResponseBody.ObjectEnum _object)
CustomersGetResponseBody	address(CustomersGetResponseBodyAddress address)
CustomersGetResponseBody	assets(CustomersGetResponseBodyAssets assets)
CustomersGetResponseBody	birthdate(LocalDate birthdate)
CustomersGetResponseBody	birthday(LocalDate birthday)
CustomersGetResponseBody	createdAt(OffsetDateTime createdAt)
CustomersGetResponseBody	description(String description)
CustomersGetResponseBody	email(String email)
boolean	equals(Object o)
static CustomersGetResponseBody	fromJson(String jsonString)	Create an instance of CustomersGetResponseBody given an JSON string
CustomersGetResponseBodyAddress	getAddress()	Get address
CustomersGetResponseBodyAssets	getAssets()	Get assets
LocalDate	getBirthdate()	Customer's birthdate; format YYYY-MM-DD.
LocalDate	getBirthday()	`Deprecated`.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the customer was created.
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 that will be linked to redemption in this request.
CustomerLoyalty	getLoyalty()	Get loyalty
Object	getMetadata()	A set of custom key/value pairs that you can attach to a customer.
String	getName()	Customer's first and last name.
CustomersGetResponseBody.ObjectEnum	getObject()	The type of the object represented by JSON.
String	getPhone()	Customer's phone number.
CustomerReferrals	getReferrals()	Get referrals
String	getSourceId()	A unique identifier of the customer who validates a voucher.
CustomerSummary	getSummary()	Get summary
Object	getSystemMetadata()	Object used to store system metadata information.
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the customer was updated.
int	hashCode()
CustomersGetResponseBody	id(String id)
CustomersGetResponseBody	loyalty(CustomerLoyalty loyalty)
CustomersGetResponseBody	metadata(Object metadata)
CustomersGetResponseBody	name(String name)
CustomersGetResponseBody	phone(String phone)
CustomersGetResponseBody	referrals(CustomerReferrals referrals)
void	setAddress(CustomersGetResponseBodyAddress address)
void	setAssets(CustomersGetResponseBodyAssets assets)
void	setBirthdate(LocalDate birthdate)
void	setBirthday(LocalDate birthday)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDescription(String description)
void	setEmail(String email)
void	setId(String id)
void	setLoyalty(CustomerLoyalty loyalty)
void	setMetadata(Object metadata)
void	setName(String name)
void	setObject(CustomersGetResponseBody.ObjectEnum _object)
void	setPhone(String phone)
void	setReferrals(CustomerReferrals referrals)
void	setSourceId(String sourceId)
void	setSummary(CustomerSummary summary)
void	setSystemMetadata(Object systemMetadata)
void	setUpdatedAt(OffsetDateTime updatedAt)
CustomersGetResponseBody	sourceId(String sourceId)
CustomersGetResponseBody	summary(CustomerSummary summary)
CustomersGetResponseBody	systemMetadata(Object systemMetadata)
String	toJson()	Convert an instance of CustomersGetResponseBody to an JSON string
String	toString()
CustomersGetResponseBody	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_SOURCE_ID

public static final String SERIALIZED_NAME_SOURCE_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_SUMMARY

public static final String SERIALIZED_NAME_SUMMARY

See Also:

• Constant Field Values

SERIALIZED_NAME_LOYALTY

public static final String SERIALIZED_NAME_LOYALTY

See Also:

• Constant Field Values

SERIALIZED_NAME_REFERRALS

public static final String SERIALIZED_NAME_REFERRALS

See Also:

• Constant Field Values

SERIALIZED_NAME_SYSTEM_METADATA

public static final String SERIALIZED_NAME_SYSTEM_METADATA

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_ASSETS

public static final String SERIALIZED_NAME_ASSETS

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

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

CustomersGetResponseBody

public CustomersGetResponseBody()

Method Details

id

public CustomersGetResponseBody id(String id)

getId

@Nullable
public String getId()

The ID of an existing customer that will be linked to redemption in this request.

Returns:

id

setId

public void setId(String id)

sourceId

public CustomersGetResponseBody 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)

summary

public CustomersGetResponseBody summary(CustomerSummary summary)

getSummary

@Nullable
public CustomerSummary getSummary()

Get summary

Returns:

summary

setSummary

public void setSummary(CustomerSummary summary)

loyalty

public CustomersGetResponseBody loyalty(CustomerLoyalty loyalty)

getLoyalty

@Nullable
public CustomerLoyalty getLoyalty()

Get loyalty

Returns:

loyalty

setLoyalty

public void setLoyalty(CustomerLoyalty loyalty)

referrals

public CustomersGetResponseBody referrals(CustomerReferrals referrals)

getReferrals

@Nullable
public CustomerReferrals getReferrals()

Get referrals

Returns:

referrals

setReferrals

public void setReferrals(CustomerReferrals referrals)

systemMetadata

public CustomersGetResponseBody systemMetadata(Object systemMetadata)

getSystemMetadata

@Nullable
public Object getSystemMetadata()

Object used to store system metadata information.

Returns:

systemMetadata

setSystemMetadata

public void setSystemMetadata(Object systemMetadata)

createdAt

public CustomersGetResponseBody createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public CustomersGetResponseBody updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp representing the date and time when the customer was updated. The value is shown in the ISO 8601 format.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

assets

public CustomersGetResponseBody assets(CustomersGetResponseBodyAssets assets)

getAssets

@Nullable
public CustomersGetResponseBodyAssets getAssets()

Get assets

Returns:

assets

setAssets

public void setAssets(CustomersGetResponseBodyAssets assets)

_object

public CustomersGetResponseBody _object(CustomersGetResponseBody.ObjectEnum _object)

getObject

@Nullable
public CustomersGetResponseBody.ObjectEnum getObject()

The type of the object represented by JSON.

Returns:

_object

setObject

public void setObject(CustomersGetResponseBody.ObjectEnum _object)

name

public CustomersGetResponseBody name(String name)

getName

@Nullable
public String getName()

Customer's first and last name.

Returns:

name

setName

public void setName(String name)

description

public CustomersGetResponseBody 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 CustomersGetResponseBody email(String email)

getEmail

@Nullable
public String getEmail()

Customer's email address.

Returns:

email

setEmail

public void setEmail(String email)

phone

public CustomersGetResponseBody 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 CustomersGetResponseBody 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 CustomersGetResponseBody 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 CustomersGetResponseBody address(CustomersGetResponseBodyAddress address)

getAddress

@Nullable
public CustomersGetResponseBodyAddress getAddress()

Get address

Returns:

address

setAddress

public void setAddress(CustomersGetResponseBodyAddress address)

metadata

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

Create an instance of CustomersGetResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CustomersGetResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of CustomersGetResponseBody to an JSON string

Returns:

JSON string