/*
 * Copyright 2013 Stormpath, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.stormpath.sdk.account;

import com.stormpath.sdk.resource.Resource;
import com.stormpath.sdk.resource.Saveable;

/**
 * @since 0.2
 */
public interface EmailVerificationToken extends Resource, Saveable {

    /**
     * Returns the actual token required to verify the account. For example:
     * <pre>
     *     EmailVerificationToken emailVerificationToken = account.getEmailVerificationToken();
     *     account = client.verifyAccountEmail(emailVerificationToken.getValue());
     *     //at this point the account has been successfully verified.
     * </code>
     * </pre>
     *
     * @return the actual token required to verify the account.
     * @since 1.0.RC4
     */
    String getValue();

}
