Add bulk data API

Author: Gonkers

src/ScryfallApi.Client/Apis/BulkData.cs

@@ -0,0 +1,57 @@
+using ScryfallApi.Client.Models;
+
+namespace ScryfallApi.Client.Apis;
+
+///<inheritdoc cref="IBulkData"/>
+public class BulkData : IBulkData
+{
+    private readonly BaseRestService _restService;
+
+    internal BulkData(BaseRestService restService)
+    {
+        _restService = restService;
+    }
+
+    public Task<ResultList<BulkDataItem>> Get() => _restService.GetAsync<ResultList<BulkDataItem>>("/bulk-data", false);
+
+    public async Task<ICollection<BulkDataItem>> Get(DateTimeOffset updatedSince)
+    {
+        var bulkData = await Get();
+        return bulkData.Data.Where(d => d.LastUpdated >= updatedSince).ToList();
+    }
+
+    public async Task<BulkDataItem> Get(DateTimeOffset updatedSince, string bulkDataType) => 
+        (await Get(updatedSince)).FirstOrDefault(d => d.Type.Equals(bulkDataType, StringComparison.OrdinalIgnoreCase));
+
+    public static class Types
+    {
+        /// <summary>
+        /// A JSON file containing one Scryfall card object for each Oracle ID on Scryfall. The 
+        /// chosen sets for the cards are an attempt to return the most up-to-date recognizable 
+        /// version of the card.
+        /// </summary>
+        public static string OracleCards  => "oracle_cards";
+
+        /// <summary>
+        /// A JSON file of Scryfall card objects that together contain all unique artworks. The 
+        /// chosen cards promote the best image scans.
+        /// </summary>
+        public static string UniqueArtwork  => "unique_artwork";
+
+        /// <summary>
+        /// A JSON file containing every card object on Scryfall in English or the printed 
+        /// language if the card is only available in one language.
+        /// </summary>
+        public static string DefaultCards => "default_cards";
+
+        /// <summary>
+        /// A JSON file containing every card object on Scryfall in every language.
+        /// </summary>
+        public static string AllCards  => "all_cards";
+
+        /// <summary>
+        /// A JSON file containing all Rulings on Scryfall. Each ruling refers to cards via an `oracle_id`.
+        /// </summary>
+        public static string Rulings => "rulings";
+    }
+}

src/ScryfallApi.Client/Apis/IBulkData.cs

@@ -0,0 +1,28 @@
+using ScryfallApi.Client.Models;
+
+namespace ScryfallApi.Client.Apis;
+
+/// <summary>Bulk Data API</summary>
+public interface IBulkData
+{
+    /// <summary>
+    /// Get information on bulk data collections and download links
+    /// </summary>
+    /// <returns></returns>
+    Task<ResultList<BulkDataItem>> Get();
+
+    /// <summary>
+    /// Return just the items that have been updated since the date and time provided
+    /// </summary>
+    /// <param name="updatedSince"></param>
+    /// <returns></returns>
+    Task<ICollection<BulkDataItem>> Get(DateTimeOffset updatedSince);
+
+    /// <summary>
+    /// Return just the item type specified that has been updated since the date and time provided
+    /// </summary>
+    /// <param name="updatedSince"></param>
+    /// <param name="bulkDataType"></param>
+    /// <returns></returns>
+    Task<BulkDataItem> Get(DateTimeOffset updatedSince, string bulkDataType);
+}

src/ScryfallApi.Client/Models/BulkDataItem.cs

@@ -0,0 +1,46 @@
+using System.Text.Json.Serialization;
+
+namespace ScryfallApi.Client.Models;
+
+public class BulkDataItem : BaseItem
+{
+    /// <summary>The Content-Encoding encoding that will be used to transmit this file when you download it.</summary>
+    [JsonPropertyName("content_encoding")]
+    public string ContentEncoding { get; set; }
+
+    /// <summary>The MIME type of this file.</summary>
+    [JsonPropertyName("content_type")]
+    public string ContentType { get; set; }
+
+    /// <summary>A human-readable description for this file.</summary>
+    [JsonPropertyName("description")]
+    public string Description { get; set; }
+
+    /// <summary>The URI that hosts this bulk file for fetching.</summary>
+    [JsonPropertyName("download_uri")]
+    public Uri DownloadUri { get; set; }
+
+    /// <summary>The size of this file in integer bytes.</summary>
+    [JsonPropertyName("compressed_size")]
+    public long FileSizeInBytes { get; set; }
+
+    /// <summary>A unique ID for this bulk item.</summary>
+    [JsonPropertyName("id")]
+    public Guid Id { get; set; }
+
+    /// <summary>The time when this file was last updated.</summary>
+    [JsonPropertyName("updated_at")]
+    public DateTimeOffset LastUpdated { get; set; }
+
+    /// <summary>A human-readable name for this file.</summary>
+    [JsonPropertyName("name")]
+    public string Name { get; set; }
+
+    /// <summary>A computer-readable string for the kind of bulk item.</summary>
+    [JsonPropertyName("type")]
+    public string Type { get; set; }
+
+    /// <summary>The Scryfall API URI for this file.</summary>
+    [JsonPropertyName("uri")]
+    public Uri Uri { get; set; }
+}

src/ScryfallApi.Client/ScryfallApiClient.cs

@@ -22,6 +22,11 @@ public class ScryfallApiClient : IScryfallApiClient
     ///<inheritdoc cref="ISymbology"/>
     public ISymbology Symbology => _symbology.Value;
 
+    private readonly Lazy<IBulkData> _bulkData;
+    ///<inheritdoc cref="IBulkData"/>
+    public IBulkData BulkData => _bulkData.Value;
+
+
     /// <summary>
     /// Instantiate a new Scryfall API client.
     /// </summary>
@@ -41,5 +46,6 @@ public ScryfallApiClient(HttpClient httpClient, ScryfallApiClientConfig clientCo
         _catalogs = new Lazy<ICatalogs>(() => new Catalogs(restService));
         _sets = new Lazy<ISets>(() => new Sets(restService));
         _symbology = new Lazy<ISymbology>(() => new Symbology(restService));
+        _bulkData = new Lazy<IBulkData>(() => new BulkData(restService));
     }
 }