[Feature] Add excludeDeleted argument to GetEntitlementsAsync (#3074

) * add `excludeDeleted` argument * i love when it still builds locally somehow
discord-net · Mar 1, 2025 · 9c9407b · 9c9407b
1 parent aa66928
commit 9c9407b
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 7 deletions.
diff --git a/src/Discord.Net.Core/IDiscordClient.cs b/src/Discord.Net.Core/IDiscordClient.cs
@@ -343,7 +343,7 @@ public interface IDiscordClient : IDisposable, IAsyncDisposable
         /// </summary>
         IAsyncEnumerable<IReadOnlyCollection<IEntitlement>> GetEntitlementsAsync(int limit = 100,
             ulong? afterId = null, ulong? beforeId = null, bool excludeEnded = false, ulong? guildId = null, ulong? userId = null,
-            ulong[] skuIds = null, RequestOptions options = null);
+            ulong[] skuIds = null, RequestOptions options = null, bool? excludeDeleted = null);
 
         /// <summary>
         ///     Returns all SKUs for a given application. 

diff --git a/src/Discord.Net.Rest/API/Rest/ListEntitlementsParams.cs b/src/Discord.Net.Rest/API/Rest/ListEntitlementsParams.cs
@@ -15,4 +15,6 @@ internal class ListEntitlementsParams
     public Optional<ulong> GuildId { get; set; }
 
     public Optional<bool> ExcludeEnded { get; set; }
+
+    public Optional<bool> ExcludeDeleted { get; set; }
 }
diff --git a/src/Discord.Net.Rest/BaseDiscordClient.cs b/src/Discord.Net.Rest/BaseDiscordClient.cs
@@ -287,7 +287,7 @@ Task IDiscordClient.DeleteTestEntitlementAsync(ulong entitlementId, RequestOptio
         ///     Returns all entitlements for a given app.
         /// </summary>
         IAsyncEnumerable<IReadOnlyCollection<IEntitlement>> IDiscordClient.GetEntitlementsAsync(int limit, ulong? afterId, ulong? beforeId,
-            bool excludeEnded, ulong? guildId, ulong? userId, ulong[] skuIds, RequestOptions options) => AsyncEnumerable.Empty<IReadOnlyCollection<IEntitlement>>();
+            bool excludeEnded, ulong? guildId, ulong? userId, ulong[] skuIds, RequestOptions options, bool? excludeDeleted) => AsyncEnumerable.Empty<IReadOnlyCollection<IEntitlement>>();
 
         /// <summary>
         ///     Gets all SKUs for a given application.

diff --git a/src/Discord.Net.Rest/ClientHelper.cs b/src/Discord.Net.Rest/ClientHelper.cs
@@ -405,7 +405,7 @@ public static async Task<RestEntitlement> CreateTestEntitlementAsync(BaseDiscord
 
         public static IAsyncEnumerable<IReadOnlyCollection<RestEntitlement>> ListEntitlementsAsync(BaseDiscordClient client, int? limit = 100,
             ulong? afterId = null, ulong? beforeId = null, bool excludeEnded = false, ulong? guildId = null, ulong? userId = null,
-             ulong[] skuIds = null, RequestOptions options = null)
+             ulong[] skuIds = null, bool? excludeDeleted = null, RequestOptions options = null)
         {
             return new PagedAsyncEnumerable<RestEntitlement>(
                 DiscordConfig.MaxEntitlementsPerBatch,
@@ -419,6 +419,7 @@ public static IAsyncEnumerable<IReadOnlyCollection<RestEntitlement>> ListEntitle
                         GuildId = guildId ?? Optional<ulong>.Unspecified,
                         UserId = userId ?? Optional<ulong>.Unspecified,
                         SkuIds = skuIds ?? Optional<ulong[]>.Unspecified,
+                        ExcludeDeleted = excludeDeleted ?? Optional<bool>.Unspecified
                     };
                     if (info.Position != null)
                         args.AfterId = info.Position.Value;

diff --git a/src/Discord.Net.Rest/DiscordRestApiClient.cs b/src/Discord.Net.Rest/DiscordRestApiClient.cs
@@ -2842,6 +2842,11 @@ public Task<Entitlement[]> ListEntitlementAsync(ListEntitlementsParams args, Req
                 query += $"&exclude_ended={args.ExcludeEnded.Value}";
             }
 
+            if (args.ExcludeDeleted.IsSpecified)
+            {
+                query += $"&exclude_deleted={args.ExcludeDeleted.Value}";
+            }
+
             return SendAsync<Entitlement[]>("GET", () => $"applications/{CurrentApplicationId}/entitlements{query}", new BucketIds(), options: options);
         }
 

diff --git a/src/Discord.Net.Rest/DiscordRestClient.cs b/src/Discord.Net.Rest/DiscordRestClient.cs
@@ -289,8 +289,8 @@ public Task DeleteTestEntitlementAsync(ulong entitlementId, RequestOptions optio
         /// <inheritdoc cref="IDiscordClient.GetEntitlementsAsync" />
         public IAsyncEnumerable<IReadOnlyCollection<IEntitlement>> GetEntitlementsAsync(int? limit = 100,
             ulong? afterId = null, ulong? beforeId = null, bool excludeEnded = false, ulong? guildId = null, ulong? userId = null,
-            ulong[] skuIds = null, RequestOptions options = null)
-            => ClientHelper.ListEntitlementsAsync(this, limit, afterId, beforeId, excludeEnded, guildId, userId, skuIds, options);
+            ulong[] skuIds = null, RequestOptions options = null, bool? excludeDeleted = null)
+            => ClientHelper.ListEntitlementsAsync(this, limit, afterId, beforeId, excludeEnded, guildId, userId, skuIds, excludeDeleted, options);
 
         /// <inheritdoc />
         public Task<IReadOnlyCollection<SKU>> GetSKUsAsync(RequestOptions options = null)

diff --git a/src/Discord.Net.WebSocket/DiscordSocketClient.cs b/src/Discord.Net.WebSocket/DiscordSocketClient.cs
@@ -442,8 +442,8 @@ public Task DeleteTestEntitlementAsync(ulong entitlementId, RequestOptions optio
         /// <inheritdoc cref="IDiscordClient.GetEntitlementsAsync"/>
         public IAsyncEnumerable<IReadOnlyCollection<IEntitlement>> GetEntitlementsAsync(int? limit = 100,
             ulong? afterId = null, ulong? beforeId = null, bool excludeEnded = false, ulong? guildId = null, ulong? userId = null,
-            ulong[] skuIds = null, RequestOptions options = null)
-            => ClientHelper.ListEntitlementsAsync(this, limit, afterId, beforeId, excludeEnded, guildId, userId, skuIds, options);
+            ulong[] skuIds = null, RequestOptions options = null, bool? excludeDeleted = null)
+            => ClientHelper.ListEntitlementsAsync(this, limit, afterId, beforeId, excludeEnded, guildId, userId, skuIds, excludeDeleted, options);
 
         /// <inheritdoc />
         public Task<IReadOnlyCollection<SKU>> GetSKUsAsync(RequestOptions options = null)