From 9a982ff8d9592a02d78f24295efd756dc0c69fa8 Mon Sep 17 00:00:00 2001 From: Ben <88249114+BenjammingKirby@users.noreply.github.com> Date: Sun, 9 Jan 2022 11:30:26 -0700 Subject: [PATCH] feat(RESTPatchAPIGuildMember): add modify current member and deprecate nick route (#262) Co-authored-by: Suneet Tipirneni <77477100+suneettipirneni@users.noreply.github.com> --- deno/rest/v8/guild.ts | 16 ++++++++++++++++ deno/rest/v8/mod.ts | 4 +++- deno/rest/v9/guild.ts | 16 ++++++++++++++++ deno/rest/v9/mod.ts | 4 +++- rest/v8/guild.ts | 16 ++++++++++++++++ rest/v8/index.ts | 4 +++- rest/v9/guild.ts | 16 ++++++++++++++++ rest/v9/index.ts | 4 +++- 8 files changed, 76 insertions(+), 4 deletions(-) diff --git a/deno/rest/v8/guild.ts b/deno/rest/v8/guild.ts index 69c6585ef..83d577f86 100644 --- a/deno/rest/v8/guild.ts +++ b/deno/rest/v8/guild.ts @@ -448,6 +448,8 @@ export type RESTPatchAPIGuildMemberResult = APIGuildMember; /** * https://discord.com/developers/docs/resources/guild#modify-current-user-nick + * + * @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead. */ export type RESTPatchAPICurrentGuildMemberNicknameJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{ /** @@ -458,8 +460,22 @@ export type RESTPatchAPICurrentGuildMemberNicknameJSONBody = AddUndefinedToPossi nick?: string | null; }>; +/** + * https://discord.com/developers/docs/resources/guild#modify-current-member + */ +export type RESTPatchAPICurrentGuildMemberJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{ + /** + * Value to set users nickname to + * + * Requires `CHANGE_NICKNAME` permission + */ + nick?: string | null; +}>; + /** * https://discord.com/developers/docs/resources/guild#modify-current-user-nick + * + * @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead. */ export type RESTPatchAPICurrentGuildMemberNicknameResult = StrictRequired; diff --git a/deno/rest/v8/mod.ts b/deno/rest/v8/mod.ts index 4030bbb75..197f6b16e 100644 --- a/deno/rest/v8/mod.ts +++ b/deno/rest/v8/mod.ts @@ -233,10 +233,11 @@ export const Routes = { * Route for: * - GET `/guilds/{guild.id}/members/{user.id}` * - PUT `/guilds/{guild.id}/members/{user.id}` + * - PATCH `/guilds/{guild.id}/members/@me` * - PATCH `/guilds/{guild.id}/members/{user.id}` * - DELETE `/guilds/{guild.id}/members/{user.id}` */ - guildMember(guildId: Snowflake, userId: Snowflake) { + guildMember(guildId: Snowflake, userId: Snowflake | '@me' = '@me') { return `/guilds/${guildId}/members/${userId}` as const; }, @@ -259,6 +260,7 @@ export const Routes = { /** * Route for: * - PATCH `/guilds/{guild.id}/members/@me/nick` + * @deprecated Use {@link Routes.guildMember} instead. */ guildCurrentMemberNickname(guildId: Snowflake) { return `/guilds/${guildId}/members/@me/nick` as const; diff --git a/deno/rest/v9/guild.ts b/deno/rest/v9/guild.ts index 95d2e5d38..81645aea9 100644 --- a/deno/rest/v9/guild.ts +++ b/deno/rest/v9/guild.ts @@ -454,6 +454,8 @@ export type RESTPatchAPIGuildMemberResult = APIGuildMember; /** * https://discord.com/developers/docs/resources/guild#modify-current-user-nick + * + * @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead. */ export type RESTPatchAPICurrentGuildMemberNicknameJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{ /** @@ -464,8 +466,22 @@ export type RESTPatchAPICurrentGuildMemberNicknameJSONBody = AddUndefinedToPossi nick?: string | null; }>; +/** + * https://discord.com/developers/docs/resources/guild#modify-current-member + */ +export type RESTPatchAPICurrentGuildMemberJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{ + /** + * Value to set users nickname to + * + * Requires `CHANGE_NICKNAME` permission + */ + nick?: string | null; +}>; + /** * https://discord.com/developers/docs/resources/guild#modify-current-user-nick + * + * @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead. */ export type RESTPatchAPICurrentGuildMemberNicknameResult = StrictRequired; diff --git a/deno/rest/v9/mod.ts b/deno/rest/v9/mod.ts index 802e3cfcc..e42d96772 100644 --- a/deno/rest/v9/mod.ts +++ b/deno/rest/v9/mod.ts @@ -233,10 +233,11 @@ export const Routes = { * Route for: * - GET `/guilds/{guild.id}/members/{user.id}` * - PUT `/guilds/{guild.id}/members/{user.id}` + * - PATCH `/guilds/{guild.id}/members/@me` * - PATCH `/guilds/{guild.id}/members/{user.id}` * - DELETE `/guilds/{guild.id}/members/{user.id}` */ - guildMember(guildId: Snowflake, userId: Snowflake) { + guildMember(guildId: Snowflake, userId: Snowflake | '@me' = '@me') { return `/guilds/${guildId}/members/${userId}` as const; }, @@ -259,6 +260,7 @@ export const Routes = { /** * Route for: * - PATCH `/guilds/{guild.id}/members/@me/nick` + * @deprecated Use {@link Routes.guildMember} instead. */ guildCurrentMemberNickname(guildId: Snowflake) { return `/guilds/${guildId}/members/@me/nick` as const; diff --git a/rest/v8/guild.ts b/rest/v8/guild.ts index b9f898b0e..fdf8f381b 100644 --- a/rest/v8/guild.ts +++ b/rest/v8/guild.ts @@ -448,6 +448,8 @@ export type RESTPatchAPIGuildMemberResult = APIGuildMember; /** * https://discord.com/developers/docs/resources/guild#modify-current-user-nick + * + * @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead. */ export type RESTPatchAPICurrentGuildMemberNicknameJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{ /** @@ -458,8 +460,22 @@ export type RESTPatchAPICurrentGuildMemberNicknameJSONBody = AddUndefinedToPossi nick?: string | null; }>; +/** + * https://discord.com/developers/docs/resources/guild#modify-current-member + */ +export type RESTPatchAPICurrentGuildMemberJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{ + /** + * Value to set users nickname to + * + * Requires `CHANGE_NICKNAME` permission + */ + nick?: string | null; +}>; + /** * https://discord.com/developers/docs/resources/guild#modify-current-user-nick + * + * @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead. */ export type RESTPatchAPICurrentGuildMemberNicknameResult = StrictRequired; diff --git a/rest/v8/index.ts b/rest/v8/index.ts index 64b285718..eccc26943 100644 --- a/rest/v8/index.ts +++ b/rest/v8/index.ts @@ -233,10 +233,11 @@ export const Routes = { * Route for: * - GET `/guilds/{guild.id}/members/{user.id}` * - PUT `/guilds/{guild.id}/members/{user.id}` + * - PATCH `/guilds/{guild.id}/members/@me` * - PATCH `/guilds/{guild.id}/members/{user.id}` * - DELETE `/guilds/{guild.id}/members/{user.id}` */ - guildMember(guildId: Snowflake, userId: Snowflake) { + guildMember(guildId: Snowflake, userId: Snowflake | '@me' = '@me') { return `/guilds/${guildId}/members/${userId}` as const; }, @@ -259,6 +260,7 @@ export const Routes = { /** * Route for: * - PATCH `/guilds/{guild.id}/members/@me/nick` + * @deprecated Use {@link Routes.guildMember} instead. */ guildCurrentMemberNickname(guildId: Snowflake) { return `/guilds/${guildId}/members/@me/nick` as const; diff --git a/rest/v9/guild.ts b/rest/v9/guild.ts index eae103991..e95ef2ebc 100644 --- a/rest/v9/guild.ts +++ b/rest/v9/guild.ts @@ -454,6 +454,8 @@ export type RESTPatchAPIGuildMemberResult = APIGuildMember; /** * https://discord.com/developers/docs/resources/guild#modify-current-user-nick + * + * @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead. */ export type RESTPatchAPICurrentGuildMemberNicknameJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{ /** @@ -464,8 +466,22 @@ export type RESTPatchAPICurrentGuildMemberNicknameJSONBody = AddUndefinedToPossi nick?: string | null; }>; +/** + * https://discord.com/developers/docs/resources/guild#modify-current-member + */ +export type RESTPatchAPICurrentGuildMemberJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<{ + /** + * Value to set users nickname to + * + * Requires `CHANGE_NICKNAME` permission + */ + nick?: string | null; +}>; + /** * https://discord.com/developers/docs/resources/guild#modify-current-user-nick + * + * @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead. */ export type RESTPatchAPICurrentGuildMemberNicknameResult = StrictRequired; diff --git a/rest/v9/index.ts b/rest/v9/index.ts index 40289f628..af62372e3 100644 --- a/rest/v9/index.ts +++ b/rest/v9/index.ts @@ -233,10 +233,11 @@ export const Routes = { * Route for: * - GET `/guilds/{guild.id}/members/{user.id}` * - PUT `/guilds/{guild.id}/members/{user.id}` + * - PATCH `/guilds/{guild.id}/members/@me` * - PATCH `/guilds/{guild.id}/members/{user.id}` * - DELETE `/guilds/{guild.id}/members/{user.id}` */ - guildMember(guildId: Snowflake, userId: Snowflake) { + guildMember(guildId: Snowflake, userId: Snowflake | '@me' = '@me') { return `/guilds/${guildId}/members/${userId}` as const; }, @@ -259,6 +260,7 @@ export const Routes = { /** * Route for: * - PATCH `/guilds/{guild.id}/members/@me/nick` + * @deprecated Use {@link Routes.guildMember} instead. */ guildCurrentMemberNickname(guildId: Snowflake) { return `/guilds/${guildId}/members/@me/nick` as const;