Package com.commercetools.api.models.customer

Interface CustomerSignin

public interface CustomerSignin
CustomerSignin
Example to create an instance using the builder pattern 

     CustomerSignin customerSignin = CustomerSignin.builder()
             .email("{email}")
             .password("{password}")
             .build()

  • Method Details

    • getEmail

      @NotNull @NotNull String getEmail()

      Email address of the Customer treated as case-insensitive.

      Returns:
      email

    • getPassword

      @NotNull @NotNull String getPassword()

      Password of the Customer.

      Returns:
      password

    • getAnonymousCartId

      @Deprecated String getAnonymousCartId()
      Deprecated.

      Deprecated since it is now possible to identify an anonymous cart by using its id or external key.

      Returns:
      anonymousCartId

    • getAnonymousCart

      @Valid @Valid CartResourceIdentifier getAnonymousCart()

      Identifies a Cart that will be assigned to the Customer.

      Returns:
      anonymousCart

    • getAnonymousCartSignInMode

      AnonymousCartSignInMode getAnonymousCartSignInMode()
      • Set to MergeWithExistingCustomerCart if LineItems of the anonymous Cart should be merged with the active Customer Cart that has been modified most recently.
      • Set to UseAsNewActiveCustomerCart if the anonymous Cart should be used as the new active Customer Cart and no LineItems are to be merged.
      Returns:
      anonymousCartSignInMode

    • getAnonymousId

      String getAnonymousId()

      If both anonymousCart and anonymousId are provided, the anonymousId on the CustomerSignin must match that of the anonymous Cart. Otherwise a 400 Bad Request Invalid Operation error is returned with the message: "Cart with the ID cart-id does not have the expected anonymousId.".

      Returns:
      anonymousId

    • getUpdateProductData

      Boolean getUpdateProductData()
      • If true, the LineItem Product data (name, variant, and productType) of the returned Cart will be updated.
      • If false, only the prices, discounts, and tax rates will be updated.
      Returns:
      updateProductData

    • setEmail

      void setEmail(String email)

      Email address of the Customer treated as case-insensitive.

      Parameters:
      email - value to be set

    • setPassword

      void setPassword(String password)

      Password of the Customer.

      Parameters:
      password - value to be set

    • setAnonymousCartId

      @Deprecated void setAnonymousCartId(String anonymousCartId)
      Deprecated.

      Deprecated since it is now possible to identify an anonymous cart by using its id or external key.

      Parameters:
      anonymousCartId - value to be set

    • setAnonymousCart

      void setAnonymousCart(CartResourceIdentifier anonymousCart)

      Identifies a Cart that will be assigned to the Customer.

      Parameters:
      anonymousCart - value to be set

    • setAnonymousCartSignInMode

      void setAnonymousCartSignInMode(AnonymousCartSignInMode anonymousCartSignInMode)
      • Set to MergeWithExistingCustomerCart if LineItems of the anonymous Cart should be merged with the active Customer Cart that has been modified most recently.
      • Set to UseAsNewActiveCustomerCart if the anonymous Cart should be used as the new active Customer Cart and no LineItems are to be merged.
      Parameters:
      anonymousCartSignInMode - value to be set

    • setAnonymousId

      void setAnonymousId(String anonymousId)

      If both anonymousCart and anonymousId are provided, the anonymousId on the CustomerSignin must match that of the anonymous Cart. Otherwise a 400 Bad Request Invalid Operation error is returned with the message: "Cart with the ID cart-id does not have the expected anonymousId.".

      Parameters:
      anonymousId - value to be set

    • setUpdateProductData

      void setUpdateProductData(Boolean updateProductData)
      • If true, the LineItem Product data (name, variant, and productType) of the returned Cart will be updated.
      • If false, only the prices, discounts, and tax rates will be updated.
      Parameters:
      updateProductData - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static CustomerSigninBuilder builder()
      builder factory method for CustomerSignin
      Returns:
      builder

    • builder

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

    • withCustomerSignin

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