Package com.commercetools.api.models.message

Interface CustomerPasswordTokenCreatedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface CustomerPasswordTokenCreatedMessagePayload extends MessagePayload

Generated after a successful Create password reset token for Customer or Create password reset token for Customer in Store request. The resource property of the Message is a CustomerPasswordTokenReference.

Example to create an instance using the builder pattern 

     CustomerPasswordTokenCreatedMessagePayload customerPasswordTokenCreatedMessagePayload = CustomerPasswordTokenCreatedMessagePayload.builder()
             .customerId("{customerId}")
             .expiresAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .invalidateOlderTokens(true)
             .build()

  • Field Details

    • CUSTOMER_PASSWORD_TOKEN_CREATED

      static final String CUSTOMER_PASSWORD_TOKEN_CREATED
      discriminator value for CustomerPasswordTokenCreatedMessagePayload
      See Also:

  • Method Details

    • getCustomerId

      @NotNull @NotNull String getCustomerId()

      Unique identifier of the Customer.

      Returns:
      customerId

    • getExpiresAt

      @NotNull @NotNull ZonedDateTime getExpiresAt()

      Date and time (UTC) the password token expires.

      Returns:
      expiresAt

    • getValue

      String getValue()

      Value of the token, present only if the token's validity is 60 minutes or less.

      Returns:
      value

    • getInvalidateOlderTokens

      @NotNull @NotNull Boolean getInvalidateOlderTokens()

      If true, all password tokens issued previously for the Customer are invalidated.

      Returns:
      invalidateOlderTokens

    • setCustomerId

      void setCustomerId(String customerId)

      Unique identifier of the Customer.

      Parameters:
      customerId - value to be set

    • setExpiresAt

      void setExpiresAt(ZonedDateTime expiresAt)

      Date and time (UTC) the password token expires.

      Parameters:
      expiresAt - value to be set

    • setValue

      void setValue(String value)

      Value of the token, present only if the token's validity is 60 minutes or less.

      Parameters:
      value - value to be set

    • setInvalidateOlderTokens

      void setInvalidateOlderTokens(Boolean invalidateOlderTokens)

      If true, all password tokens issued previously for the Customer are invalidated.

      Parameters:
      invalidateOlderTokens - value to be set

    • of

      static CustomerPasswordTokenCreatedMessagePayload of()
      factory method
      Returns:
      instance of CustomerPasswordTokenCreatedMessagePayload

    • of

      static CustomerPasswordTokenCreatedMessagePayload of(CustomerPasswordTokenCreatedMessagePayload template)
      factory method to create a shallow copy CustomerPasswordTokenCreatedMessagePayload
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      CustomerPasswordTokenCreatedMessagePayload copyDeep()
      Specified by:
      copyDeep in interface MessagePayload

    • deepCopy

      @Nullable static CustomerPasswordTokenCreatedMessagePayload deepCopy(@Nullable CustomerPasswordTokenCreatedMessagePayload template)
      factory method to create a deep copy of CustomerPasswordTokenCreatedMessagePayload
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static CustomerPasswordTokenCreatedMessagePayloadBuilder builder()
      builder factory method for CustomerPasswordTokenCreatedMessagePayload
      Returns:
      builder

    • builder

      static CustomerPasswordTokenCreatedMessagePayloadBuilder builder(CustomerPasswordTokenCreatedMessagePayload template)
      create builder for CustomerPasswordTokenCreatedMessagePayload instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withCustomerPasswordTokenCreatedMessagePayload

      default <T> T withCustomerPasswordTokenCreatedMessagePayload(Function<CustomerPasswordTokenCreatedMessagePayload,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<CustomerPasswordTokenCreatedMessagePayload> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference