Spotify.NET/SpotifyAPI/Web/IClient.cs

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using SpotifyAPI.Web.Models;

namespace SpotifyAPI.Web
{
    public interface IClient : IDisposable
    {
        JsonSerializerSettings JsonSettings { get; set; }

        /// <summary>
        ///     Downloads data from an URL and returns it
        /// </summary>
        /// <param name="url">An URL</param>
        /// <returns></returns>
        Tuple<ResponseInfo, string> Download(string url);

        /// <summary>
        ///     Downloads data async from an URL and returns it
        /// </summary>
        /// <param name="url"></param>
        /// <returns></returns>
        Task<Tuple<ResponseInfo, string>> DownloadAsync(string url);

        /// <summary>
        ///     Downloads data from an URL and returns it
        /// </summary>
        /// <param name="url">An URL</param>
        /// <returns></returns>
        Tuple<ResponseInfo, byte[]> DownloadRaw(string url);

        /// <summary>
        ///     Downloads data async from an URL and returns it
        /// </summary>
        /// <param name="url"></param>
        /// <returns></returns>
        Task<Tuple<ResponseInfo, byte[]>> DownloadRawAsync(string url);

        /// <summary>
        ///     Downloads data from an URL and converts it to an object
        /// </summary>
        /// <typeparam name="T">The Type which the object gets converted to</typeparam>
        /// <param name="url">An URL</param>
        /// <returns></returns>
        Tuple<ResponseInfo, T> DownloadJson<T>(string url);

        /// <summary>
        ///     Downloads data async from an URL and converts it to an object
        /// </summary>
        /// <typeparam name="T">The Type which the object gets converted to</typeparam>
        /// <param name="url">An URL</param>
        /// <returns></returns>
        Task<Tuple<ResponseInfo, T>> DownloadJsonAsync<T>(string url);

        /// <summary>
        ///     Uploads data from an URL and returns the response
        /// </summary>
        /// <param name="url">An URL</param>
        /// <param name="body">The Body-Data (most likely a JSON String)</param>
        /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
        /// <returns></returns>
        Tuple<ResponseInfo, string> Upload(string url, string body, string method);

        /// <summary>
        ///     Uploads data async from an URL and returns the response
        /// </summary>
        /// <param name="url">An URL</param>
        /// <param name="body">The Body-Data (most likely a JSON String)</param>
        /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
        /// <returns></returns>
        Task<Tuple<ResponseInfo, string>> UploadAsync(string url, string body, string method);

        /// <summary>
        ///     Uploads data from an URL and returns the response
        /// </summary>
        /// <param name="url">An URL</param>
        /// <param name="body">The Body-Data (most likely a JSON String)</param>
        /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
        /// <returns></returns>
        Tuple<ResponseInfo, byte[]> UploadRaw(string url, string body, string method);

        /// <summary>
        ///     Uploads data async from an URL and returns the response
        /// </summary>
        /// <param name="url">An URL</param>
        /// <param name="body">The Body-Data (most likely a JSON String)</param>
        /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
        /// <returns></returns>
        Task<Tuple<ResponseInfo, byte[]>> UploadRawAsync(string url, string body, string method);

        /// <summary>
        ///     Uploads data from an URL and converts the response to an object
        /// </summary>
        /// <typeparam name="T">The Type which the object gets converted to</typeparam>
        /// <param name="url">An URL</param>
        /// <param name="body">The Body-Data (most likely a JSON String)</param>
        /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
        /// <returns></returns>
        Tuple<ResponseInfo, T> UploadJson<T>(string url, string body, string method);

        /// <summary>
        ///     Uploads data async from an URL and converts the response to an object
        /// </summary>
        /// <typeparam name="T">The Type which the object gets converted to</typeparam>
        /// <param name="url">An URL</param>
        /// <param name="body">The Body-Data (most likely a JSON String)</param>
        /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
        /// <returns></returns>
        Task<Tuple<ResponseInfo, T>> UploadJsonAsync<T>(string url, string body, string method);

        /// <summary>
        ///     Sets a specific Header
        /// </summary>
        /// <param name="header">Header name</param>
        /// <param name="value">Header value</param>
        void SetHeader(string header, string value);

        /// <summary>
        ///     Removes a specific Header
        /// </summary>
        /// <param name="header">Header name</param>
        void RemoveHeader(string header);

        /// <summary>
        ///     Gets all current Headers
        /// </summary>
        /// <returns>A collection of Header KeyValue Pairs</returns>
        List<KeyValuePair<string, string>> GetHeaders();
    }
}