/*
 * Copyright 2022 Red Hat, Inc. and/or its affiliates.
 *
 * 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 org.acme.newsletter.subscription.service;

import java.util.List;
import java.util.Optional;

public interface SubscriptionService {

    /**
     * Confirms the email subscription
     */
    Subscription confirm(Subscription subscription);

    /**
     * Verify if the given email is already in the database
     */
    boolean checkEmail(String email);

    /**
     * Subscribes the given email
     */
    Subscription subscribe(Subscription subscription);

    /**
     * Deletes a subscription by id.
     */
    void delete(String id);

    /**
     * Fetch the subscription by email
     */
    Optional<Subscription> fetch(String email);

    List<Subscription> list(boolean verified);

}
