Package com.commercetools.api.models.message

Interface CustomerPasswordUpdatedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface CustomerPasswordUpdatedMessagePayload
extends MessagePayload

Generated after a successful Reset Customer's Password, Reset Customer's Password in a Store, Change Customer's Password, or Change Customer's Password in a Store request. This Message is also produced during equivalent requests to the My Customer Profile endpoint.

Example to create an instance using the builder pattern

     CustomerPasswordUpdatedMessagePayload customerPasswordUpdatedMessagePayload = CustomerPasswordUpdatedMessagePayload.builder()
             .reset(true)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOMER_PASSWORD_UPDATED	discriminator value for CustomerPasswordUpdatedMessagePayload

Method Summary

Modifier and Type	Method	Description
static CustomerPasswordUpdatedMessagePayloadBuilder	builder()	builder factory method for CustomerPasswordUpdatedMessagePayload
static CustomerPasswordUpdatedMessagePayloadBuilder	builder(CustomerPasswordUpdatedMessagePayload template)	create builder for CustomerPasswordUpdatedMessagePayload instance
CustomerPasswordUpdatedMessagePayload	copyDeep()
static CustomerPasswordUpdatedMessagePayload	deepCopy(CustomerPasswordUpdatedMessagePayload template)	factory method to create a deep copy of CustomerPasswordUpdatedMessagePayload
@NotNull Boolean	getReset()	Whether the Customer's password was updated during the Reset password or Change password flow.
static CustomerPasswordUpdatedMessagePayload	of()	factory method
static CustomerPasswordUpdatedMessagePayload	of(CustomerPasswordUpdatedMessagePayload template)	factory method to create a shallow copy CustomerPasswordUpdatedMessagePayload
void	setReset(Boolean reset)	Whether the Customer's password was updated during the Reset password or Change password flow.
static com.fasterxml.jackson.core.type.TypeReference<CustomerPasswordUpdatedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerPasswordUpdatedMessagePayload(Function<CustomerPasswordUpdatedMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Field Details

CUSTOMER_PASSWORD_UPDATED

static final String CUSTOMER_PASSWORD_UPDATED

discriminator value for CustomerPasswordUpdatedMessagePayload

See Also:

• Constant Field Values

Method Details

getReset

@NotNull
@NotNull Boolean getReset()

Whether the Customer's password was updated during the Reset password or Change password flow.

Returns:

reset

setReset

void setReset(Boolean reset)

Whether the Customer's password was updated during the Reset password or Change password flow.

Parameters:

reset - value to be set

of

static CustomerPasswordUpdatedMessagePayload of()

factory method

Returns:

instance of CustomerPasswordUpdatedMessagePayload

of

static CustomerPasswordUpdatedMessagePayload of(CustomerPasswordUpdatedMessagePayload template)

factory method to create a shallow copy CustomerPasswordUpdatedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerPasswordUpdatedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static CustomerPasswordUpdatedMessagePayload deepCopy(@Nullable
 CustomerPasswordUpdatedMessagePayload template)

factory method to create a deep copy of CustomerPasswordUpdatedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerPasswordUpdatedMessagePayloadBuilder builder()

builder factory method for CustomerPasswordUpdatedMessagePayload

Returns:

builder

builder

static CustomerPasswordUpdatedMessagePayloadBuilder builder(CustomerPasswordUpdatedMessagePayload template)

create builder for CustomerPasswordUpdatedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerPasswordUpdatedMessagePayload

default <T> T withCustomerPasswordUpdatedMessagePayload(Function<CustomerPasswordUpdatedMessagePayload,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<CustomerPasswordUpdatedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference