using System.Threading;
using System.Threading.Tasks;

namespace CryptoExchange.Net.SharedApis
{
    /// <summary>
    /// Client for requesting deposit addresses and deposit records
    /// </summary>
    public interface IDepositRestClient : ISharedClient
    {
        /// <summary>
        /// Deposit addresses request options
        /// </summary>
        EndpointOptions<GetDepositAddressesRequest> GetDepositAddressesOptions { get; }

        /// <summary>
        /// Get deposit addresses for an asset
        /// </summary>
        /// <param name="request">Request info</param>
        /// <param name="ct">Cancellation token</param>
        /// <returns></returns>
        Task<ExchangeWebResult<SharedDepositAddress[]>> GetDepositAddressesAsync(GetDepositAddressesRequest request, CancellationToken ct = default);

        /// <summary>
        /// Deposits request options
        /// </summary>
        GetDepositsOptions GetDepositsOptions { get; }

        /// <summary>
        /// Get deposit records
        /// </summary>
        /// <param name="request">Request info</param>
        /// <param name="nextPageToken">The pagination request from the previous request result `NextPageRequest` property to continue pagination</param>
        /// <param name="ct">Cancellation token</param>
        /// <returns></returns>
        Task<ExchangeWebResult<SharedDeposit[]>> GetDepositsAsync(GetDepositsRequest request, PageRequest? nextPageToken = null, CancellationToken ct = default);
    }
}
