using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;

namespace xServices.TermsConditions.Interfaces
{
    public interface IXTermsConditionsControllerActions
    {
        /// <summary>
        /// Terms and Conditions Provider ...
        /// </summary>
        IXTermsComditionsProvider TermsProvider { get; }
        
        /// <summary>
        /// Retrieved all Exists Languages Terms and Conditions ...
        /// </summary>
        /// <returns></returns>
        Task<ActionResult<IEnumerable<string>>> TermsLanguages();

        /// <summary>
        /// Check Has Terms and Conditions based on Specified Language ...
        /// </summary>
        /// <param name="language">if null, used Default Language ...</param>
        /// <returns></returns>
        Task<ActionResult<bool>> HasTerms(
            [FromRoute] string language = null
        );

        /// <summary>
        /// Retrieve Terms and Conditions for Specified Language ...
        /// </summary>
        /// <param name="language">if null, used Default Language ...</param>
        /// <returns></returns>
        Task<ActionResult<string>> GetTerms(
            [FromRoute] string language = null
        );

        /// <summary>
        /// Add Terms and Conditions for Specified Language ...
        /// </summary>
        /// <param name="language"></param>
        /// <param name="terms"></param>
        /// <returns></returns>
        Task<ActionResult<string>> AddTerms(
            [FromRoute] string language,
            [FromQuery] string terms
        );

        /// <summary>
        /// Remove Terms and Conditions of Specified Language ...
        /// </summary>
        /// <param name="language"></param>
        /// <returns></returns>
        Task<ActionResult<bool>> RemoveTerms(
            [FromRoute] string language
        );

        /// <summary>
        /// Update Terms and Conditions of Specified Language ...
        /// </summary>
        /// <param name="language"></param>
        /// <param name="terms"></param>
        /// <returns></returns>
        Task<ActionResult<bool>> UpdateTerms(
            [FromRoute] string language,
            [FromQuery] string terms
        );
    }
}