ITransaction.cs

using System;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;

namespace Todoist.Net.Services
{
    /// <summary>
    /// Represents a Transaction
    /// </summary>
    public interface ITransaction
    {
        /// <summary>
        /// Gets or sets the filters.
        /// </summary>
        /// <value>The filters.</value>
        /// <remarks>Filters are only available for Todoist Premium users.</remarks>
        IFiltersCommandService Filters { get; set; }

        /// <summary>
        /// Gets the items service.
        /// </summary>
        /// <value>The items service.</value>
        IItemsCommandService Items { get; }

        /// <summary>
        /// Gets the labels service.
        /// </summary>
        /// <value>The labels service.</value>
        ILabelsCommandService Labels { get; }

        /// <summary>
        /// Gets the notes service.
        /// </summary>
        /// <value>The notes service.</value>
        INotesCommandServices Notes { get; }

        /// <summary>
        /// Gets the notifications service.
        /// </summary>
        /// <value>The notifications service.</value>
        INotificationsCommandService Notifications { get; }

        /// <summary>
        /// Gets the project.
        /// </summary>
        /// <value>The project.</value>
        IProjectCommandService Project { get; }

        /// <summary>
        /// Gets the reminders.
        /// </summary>
        /// <value>The reminders.</value>
        /// <remarks>Reminders are only available for Todoist Premium users.</remarks>
        IRemindersCommandService Reminders { get; }

        /// <summary>
        /// Gets the sharing.
        /// </summary>
        /// <value>
        /// The sharing.
        /// </value>
        ISharingCommandService Sharing { get; }

        /// <summary>
        /// Gets the users.
        /// </summary>
        /// <value>The users.</value>
        IUsersCommandService Users { get; }

        /// <summary>
        /// Commits the transaction asynchronous.
        /// </summary>
        /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
        /// <returns>
        /// Returns <see cref="Task{TResult}" />. The task object representing the asynchronous operation
        /// that at completion returns the transaction sync_token.
        /// </returns>
        /// <exception cref="AggregateException">Command execution exception.</exception>
        /// <exception cref="HttpRequestException">API exception.</exception>
        Task<string> CommitAsync(CancellationToken cancellationToken = default);
    }
}