CustomerService

All Known Implementing Classes:

CustomerServiceImpl
```
public interface CustomerService
```
Sphere HTTP API for working with customers in a given project.

Method Summary

Methods
Modifier and Type	Method and Description
`QueryRequest<Customer>`	`all()` Deprecated. since 0.49.0. Use `query()` instead.
`FetchRequest<Customer>`	`byId(java.lang.String id)` Finds a customer by id.
`FetchRequest<Customer>`	`byToken(java.lang.String token)` Finds a customer by a token value.
`CommandRequest<Customer>`	`changePassword(VersionedId customerId, java.lang.String currentPassword, java.lang.String newPassword)` Sets a new password for a customer.
`CommandRequest<Customer>`	`confirmEmail(VersionedId customerId, java.lang.String token)` Sets `Customer.isEmailVerified` to true.
`CommandRequest<CustomerToken>`	`createEmailVerificationToken(VersionedId customerId, int ttlMinutes)` Creates a token used to verify customer's email.
`CommandRequest<CustomerToken>`	`createPasswordResetToken(java.lang.String email)` Creates a password reset token for the customer with the given email.
`CommandRequest<CustomerToken>`	`createPasswordResetToken(java.lang.String email, int ttlMinutes)`
`QueryRequest<Customer>`	`query()` Queries customers.
`CommandRequest<Customer>`	`resetPassword(VersionedId customerId, java.lang.String token, java.lang.String newPassword)` Sets a new password for a customer.
`CommandRequest<SignInResult>`	`signIn(java.lang.String email, java.lang.String password)` Signs in a customer.
`CommandRequest<SignInResult>`	`signIn(java.lang.String email, java.lang.String password, java.lang.String anonymousCartId)` Signs in a customer and associates an existing anonymous cart to the customer.
`CommandRequest<SignInResult>`	`signUp(SignUpBuilder builder)` Creates a new customer.
`CommandRequest<SignInResult>`	`signUp(java.lang.String email, java.lang.String password, CustomerName name)` Creates a new customer.
`CommandRequest<SignInResult>`	`signUp(java.lang.String email, java.lang.String password, CustomerName customerName, java.lang.String anonymousCartId)` Creates a new customer and associates an existing anonymous cart to the customer.
`CommandRequest<Customer>`	`update(VersionedId customerId, CustomerUpdate customerUpdate)` Updates a customer.

- Method Detail
  - byId
```
FetchRequest<Customer> byId(java.lang.String id)
```
    Finds a customer by id.
  - byToken
```
FetchRequest<Customer> byToken(java.lang.String token)
```
    Finds a customer by a token value. If the customer is not found, it means the token is invalid or expired.
  - all
```
@Deprecated
QueryRequest<Customer> all()
```
    Deprecated. since 0.49.0. Use query() instead.
    
    Queries all customers.
  - query
```
QueryRequest<Customer> query()
```
    Queries customers.
  - signUp
```
CommandRequest<SignInResult> signUp(java.lang.String email,
                                  java.lang.String password,
                                  CustomerName name)
```
    Creates a new customer.
    Returns:
    A command request which can fail with the following exceptions:
    
    EmailAlreadyInUseException if the email is already taken.
  - signUp
```
CommandRequest<SignInResult> signUp(java.lang.String email,
                                  java.lang.String password,
                                  CustomerName customerName,
                                  java.lang.String anonymousCartId)
```
    Creates a new customer and associates an existing anonymous cart to the customer.
    If the customer already had a cart, the given anonymous cart is merged with customer's cart. If no cart existed for the customer, the anonymous cart becomes customer's cart.
    Parameters:
    anonymousCartId - The id of the anonymous cart that should be merged / associated to the customer. Can't be empty.
    
    Returns:
    A command request which can fail with the following exceptions:
    
    EmailAlreadyInUseException if the email is already taken.
  - signUp
```
CommandRequest<SignInResult> signUp(SignUpBuilder builder)
```
    Creates a new customer.
    If the customer already had a cart, the given anonymous cart is merged with customer's cart. If no cart existed for the customer, the anonymous cart becomes customer's cart.
    Returns:
    A command request which can fail with the following exceptions:
    
    EmailAlreadyInUseException if the email is already taken.
  - signIn
```
CommandRequest<SignInResult> signIn(java.lang.String email,
                                  java.lang.String password)
```
    Signs in a customer.
    Returns:
    A command request which can fail with the following exceptions:
    
    InvalidCredentialsException if no customer with given credentials exists.
  - signIn
```
CommandRequest<SignInResult> signIn(java.lang.String email,
                                  java.lang.String password,
                                  java.lang.String anonymousCartId)
```
    Signs in a customer and associates an existing anonymous cart to the customer.
    If the customer already had a cart, the given anonymous cart is merged with customer's cart. If no cart existed for the customer, the anonymous cart becomes customer's cart.
    Parameters:
    anonymousCartId - The id of the anonymous cart that should be merged / associated to the customer. Can't be empty.
    
    Returns:
    A command request which can fail with the following exceptions:
    
    InvalidCredentialsException if no customer with given credentials exists.
  - changePassword
```
CommandRequest<Customer> changePassword(VersionedId customerId,
                                      java.lang.String currentPassword,
                                      java.lang.String newPassword)
```
    Sets a new password for a customer.
    Returns:
    A command request which can fail with the following exceptions:
    
    InvalidPasswordException if the current password is invalid.
  - update
```
CommandRequest<Customer> update(VersionedId customerId,
                              CustomerUpdate customerUpdate)
```
    Updates a customer.
  - resetPassword
```
CommandRequest<Customer> resetPassword(VersionedId customerId,
                                     java.lang.String token,
                                     java.lang.String newPassword)
```
    Sets a new password for a customer. Requires a token that was previously generated using the createPasswordResetToken(String) method.
  - createEmailVerificationToken
```
CommandRequest<CustomerToken> createEmailVerificationToken(VersionedId customerId,
                                                         int ttlMinutes)
```
    Creates a token used to verify customer's email.
    Typically, verification emails are sent as part of the signup process but the decision is when and whether to verify customer emails is up to you.
    The typical workflow is the following:
    1. Create an email verification token using this method.
    2. Send an email containing a link with the token to the customer.
    3. The link points to a page where the customer has to log in (if not already logged in). If the customer is successfully logged in, you can call confirmEmail(io.sphere.client.model.VersionedId, java.lang.String), passing in current customer's id, version and the token, extracted from the URL.
    See also CustomerService.
    Parameters:
    ttlMinutes - Validity of the token in minutes. The maximum allowed value is 43200 (30 days).
  - confirmEmail
```
CommandRequest<Customer> confirmEmail(VersionedId customerId,
                                    java.lang.String token)
```
    Sets Customer.isEmailVerified to true. Requires a token that was previously generated using the createEmailVerificationToken(io.sphere.client.model.VersionedId, int) method.
  - createPasswordResetToken
```
CommandRequest<CustomerToken> createPasswordResetToken(java.lang.String email)
```
    Creates a password reset token for the customer with the given email. The validity of the token is 10 minutes.
    The typical workflow is the following:
    1. Customer enters his or her email in a password reset form and submits.
    2. Create a password reset token using this method.
    3. Send an email containing a link with the token to the customer.
    4. The link points to a form where the customer can enter a new password. The form should load the customer using byToken(java.lang.String) and remember customer's id and version in hidden form fields. If the customer can't be found, the token has expired or is invalid.
    5. When the customer submits the form with the new password, call resetPassword(io.sphere.client.model.VersionedId, java.lang.String, java.lang.String), passing in the customer id and version, the new password and the token (the token is extracted from the URL).
    Parameters:
    email - Email address for which the token should be created.
  - createPasswordResetToken
```
CommandRequest<CustomerToken> createPasswordResetToken(java.lang.String email,
                                                     int ttlMinutes)
```
    Parameters:
    email - Email address for which the token should be created.
    ttlMinutes - A hint for the backend how long the token should be valid. The actual timeout could be shorter.
    See Also:
    createPasswordResetToken(java.lang.String)

Interface CustomerService

Method Summary

Method Detail

byId

byToken

all

query

signUp

signUp

signUp

signIn

signIn

changePassword

update

resetPassword

createEmailVerificationToken

confirmEmail

createPasswordResetToken

createPasswordResetToken