Package com.commercetools.api.models.message

Interface CustomerEmailTokenCreatedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface CustomerEmailTokenCreatedMessagePayload extends MessagePayload

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

Example to create an instance using the builder pattern 

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

  • Field Details

    • CUSTOMER_EMAIL_TOKEN_CREATED

      static final String CUSTOMER_EMAIL_TOKEN_CREATED
      discriminator value for CustomerEmailTokenCreatedMessagePayload
      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 email 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 email 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 email 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 email tokens issued previously for the Customer are invalidated.

      Parameters:
      invalidateOlderTokens - value to be set

    • of

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

    • of

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

    • copyDeep

      CustomerEmailTokenCreatedMessagePayload copyDeep()
      Specified by:
      copyDeep in interface MessagePayload

    • deepCopy

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

    • builder

      static CustomerEmailTokenCreatedMessagePayloadBuilder builder()
      builder factory method for CustomerEmailTokenCreatedMessagePayload
      Returns:
      builder

    • builder

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

    • withCustomerEmailTokenCreatedMessagePayload

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