feat: New entitlement endpoint behaviour (#1145)

* feat: new entitlement endpoint behaviour * fix: correct `RESTGetAPIEntitlementResult` * docs: update changes
discordjs · Nov 26, 2024 · 079fcd6 · 079fcd6
1 parent 566ae49
commit 079fcd6
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 4 deletions.
diff --git a/deno/rest/v10/mod.ts b/deno/rest/v10/mod.ts
@@ -952,6 +952,7 @@ export const Routes = {
 
 	/**
 	 * Route for:
+	 * - GET `/applications/{application.id}/entitlements/{entitlement.id}`
 	 * - DELETE `/applications/{application.id}/entitlements/{entitlement.id}`
 	 */
 	entitlement(applicationId: Snowflake, entitlementId: Snowflake) {

diff --git a/deno/rest/v10/monetization.ts b/deno/rest/v10/monetization.ts
@@ -33,16 +33,25 @@ export interface RESTGetAPIEntitlementsQuery {
 	 */
 	guild_id?: Snowflake | undefined;
 	/**
-	 * Whether ended entitlements should be omitted
+	 * Whether ended entitlements should be omitted. Defaults to `false`, ended entitlements are included by default
 	 */
 	exclude_ended?: boolean | undefined;
+	/**
+	 * Whether deleted entitlements should be omitted. Defaults to `true`, deleted entitlements are not included by default
+	 */
+	exclude_deleted?: boolean | undefined;
 }
 
 /**
  * https://discord.com/developers/docs/resources/entitlement#list-entitlements
  */
 export type RESTGetAPIEntitlementsResult = APIEntitlement[];
 
+/**
+ * https://discord.com/developers/docs/resources/entitlement#get-entitlement
+ */
+export type RESTGetAPIEntitlementResult = APIEntitlement;
+
 /**
  * https://discord.com/developers/docs/resources/entitlement#create-test-entitlement
  */

diff --git a/deno/rest/v9/mod.ts b/deno/rest/v9/mod.ts
@@ -961,6 +961,7 @@ export const Routes = {
 
 	/**
 	 * Route for:
+	 * - GET `/applications/{application.id}/entitlements/{entitlement.id}`
 	 * - DELETE `/applications/{application.id}/entitlements/{entitlement.id}`
 	 */
 	entitlement(applicationId: Snowflake, entitlementId: Snowflake) {

diff --git a/deno/rest/v9/monetization.ts b/deno/rest/v9/monetization.ts
@@ -33,16 +33,25 @@ export interface RESTGetAPIEntitlementsQuery {
 	 */
 	guild_id?: Snowflake | undefined;
 	/**
-	 * Whether ended entitlements should be omitted
+	 * Whether ended entitlements should be omitted. Defaults to `false`, ended entitlements are included by default
 	 */
 	exclude_ended?: boolean | undefined;
+	/**
+	 * Whether deleted entitlements should be omitted. Defaults to `true`, deleted entitlements are not included by default
+	 */
+	exclude_deleted?: boolean | undefined;
 }
 
 /**
  * https://discord.com/developers/docs/resources/entitlement#list-entitlements
  */
 export type RESTGetAPIEntitlementsResult = APIEntitlement[];
 
+/**
+ * https://discord.com/developers/docs/resources/entitlement#get-entitlement
+ */
+export type RESTGetAPIEntitlementResult = APIEntitlement;
+
 /**
  * https://discord.com/developers/docs/resources/entitlement#create-test-entitlement
  */

diff --git a/rest/v10/index.ts b/rest/v10/index.ts
@@ -952,6 +952,7 @@ export const Routes = {
 
 	/**
 	 * Route for:
+	 * - GET `/applications/{application.id}/entitlements/{entitlement.id}`
 	 * - DELETE `/applications/{application.id}/entitlements/{entitlement.id}`
 	 */
 	entitlement(applicationId: Snowflake, entitlementId: Snowflake) {

diff --git a/rest/v10/monetization.ts b/rest/v10/monetization.ts
@@ -33,16 +33,25 @@ export interface RESTGetAPIEntitlementsQuery {
 	 */
 	guild_id?: Snowflake | undefined;
 	/**
-	 * Whether ended entitlements should be omitted
+	 * Whether ended entitlements should be omitted. Defaults to `false`, ended entitlements are included by default
 	 */
 	exclude_ended?: boolean | undefined;
+	/**
+	 * Whether deleted entitlements should be omitted. Defaults to `true`, deleted entitlements are not included by default
+	 */
+	exclude_deleted?: boolean | undefined;
 }
 
 /**
  * https://discord.com/developers/docs/resources/entitlement#list-entitlements
  */
 export type RESTGetAPIEntitlementsResult = APIEntitlement[];
 
+/**
+ * https://discord.com/developers/docs/resources/entitlement#get-entitlement
+ */
+export type RESTGetAPIEntitlementResult = APIEntitlement;
+
 /**
  * https://discord.com/developers/docs/resources/entitlement#create-test-entitlement
  */

diff --git a/rest/v9/index.ts b/rest/v9/index.ts
@@ -961,6 +961,7 @@ export const Routes = {
 
 	/**
 	 * Route for:
+	 * - GET `/applications/{application.id}/entitlements/{entitlement.id}`
 	 * - DELETE `/applications/{application.id}/entitlements/{entitlement.id}`
 	 */
 	entitlement(applicationId: Snowflake, entitlementId: Snowflake) {

diff --git a/rest/v9/monetization.ts b/rest/v9/monetization.ts
@@ -33,16 +33,25 @@ export interface RESTGetAPIEntitlementsQuery {
 	 */
 	guild_id?: Snowflake | undefined;
 	/**
-	 * Whether ended entitlements should be omitted
+	 * Whether ended entitlements should be omitted. Defaults to `false`, ended entitlements are included by default
 	 */
 	exclude_ended?: boolean | undefined;
+	/**
+	 * Whether deleted entitlements should be omitted. Defaults to `true`, deleted entitlements are not included by default
+	 */
+	exclude_deleted?: boolean | undefined;
 }
 
 /**
  * https://discord.com/developers/docs/resources/entitlement#list-entitlements
  */
 export type RESTGetAPIEntitlementsResult = APIEntitlement[];
 
+/**
+ * https://discord.com/developers/docs/resources/entitlement#get-entitlement
+ */
+export type RESTGetAPIEntitlementResult = APIEntitlement;
+
 /**
  * https://discord.com/developers/docs/resources/entitlement#create-test-entitlement
  */