using System.Collections.Generic;
using TS.Insightly.API.Contract;

namespace TS.Insightly.API.Interface
{
    /// <summary>
    /// Interface for Organisations access via the API.
    /// </summary>
    internal interface IProjectController
    {
        /// <summary>
        /// Gets the project for the unique organisation ID.
        /// Note that the Id is not the Id shown for the project in the web browser, but
        /// the project Id that is unique to insightly.
        /// </summary>
        /// <param name="projectId">The project unique identifier.</param>
        /// <returns>The project for the given id.</returns>
        Project GetProject(int projectId);

        /// <summary>
        /// Gets projects.
        /// </summary>
        /// <param name="fullDetails">if set to <c>true</c> return full details.</param>
        /// <returns>All projects.</returns>
        List<Project> GetProjects(bool fullDetails);
    }
}