/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: MIT-0
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this
 * software and associated documentation files (the "Software"), to deal in the Software
 * without restriction, including without limitation the rights to use, copy, modify,
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

using System.Collections.Generic;
using System.Threading.Tasks;

namespace BasketLambda.Interfaces
{
    public interface IDynamoDBRepository
    {
        /// <summary>
        /// Fetches the dynamoDB documents based on userId.
        /// </summary>
        /// <param name="userId"></param>
        /// <returns>User basket.</returns>
        Task<List<Basket>> GetUserDocuments(string userId);

        /// <summary>
        /// Fetches the dynamoDB documents based on unicornId.
        /// </summary>
        /// <param name="unicornId"></param>
        /// <returns>Baskets with unicorn.</returns>
        Task<List<Basket>> GetUnicornDocuments(string unicornId);

        /// <summary>
        /// Gets the basket item.
        /// </summary>
        /// <param name="userId"></param>
        /// <param name="basketId"></param>
        Task<Basket> GetDocument(string userId, string basketId);

        /// <summary>
        /// Saves the current user basket.
        /// </summary>
        /// <param name="basket"></param>
        Task SaveDocument(Basket basket);

        /// <summary>
        /// Deletes the basket item.
        /// </summary>
        /// <param name="userId"></param>
        /// <param name="basketId"></param>
        Task DeleteDocument(string userId, string basketId);
    }
}