Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(RESTPatchAPIGuildMember): add modify current member and deprecate nick route #262

Merged
merged 8 commits into from
Jan 9, 2022
Merged

feat(RESTPatchAPIGuildMember): add modify current member and deprecate nick route #262

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4afbdb8
feat(guildmember): add modify current member
BenjammingKirby Dec 9, 2021
69dd72c
feat(guildmember): deprecate modify user nick (v8)
BenjammingKirby Dec 9, 2021
11f230f
feat(member): depracate modify current user nick
BenjammingKirby Dec 9, 2021
73bf2d9
feat(member): add modify current member link
BenjammingKirby Dec 13, 2021
3d1f991
feat(member): link to Routes.guildMember
BenjammingKirby Dec 16, 2021
f65febd
feat(member): link to Routes.guildMember
BenjammingKirby Dec 16, 2021
6d0e494
Merge branch 'discordjs:main' into main
BenjammingKirby Jan 6, 2022
d65a1d6
feat(member): make interfaces consistent
BenjammingKirby Jan 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 12 additions & 0 deletions deno/rest/v8/guild.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,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 interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
/**
Expand All @@ -445,9 +447,19 @@ export interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
*/
nick?: string | null;
}
export interface RESTPatchAPICurrentGuildMemberJSONBody {
vladfrangu marked this conversation as resolved.
Show resolved Hide resolved
/**
* 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.
BenjammingKirby marked this conversation as resolved.
Show resolved Hide resolved
*/
export type RESTPatchAPICurrentGuildMemberNicknameResult = Required<RESTPatchAPICurrentGuildMemberNicknameJSONBody>;

Expand Down
4 changes: 3 additions & 1 deletion deno/rest/v8/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
},

Expand All @@ -259,6 +260,7 @@ export const Routes = {
/**
* Route for:
* - PATCH `/guilds/{guild.id}/members/@me/nick`
* @deprecated Use guildMember instead.
*/
guildCurrentMemberNickname(guildId: Snowflake) {
return `/guilds/${guildId}/members/@me/nick` as const;
Expand Down
13 changes: 12 additions & 1 deletion deno/rest/v9/guild.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,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 interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
/**
Expand All @@ -451,9 +453,18 @@ export interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
*/
nick?: string | null;
}

export interface RESTPatchAPICurrentGuildMemberJSONBody {
/**
* 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 = Required<RESTPatchAPICurrentGuildMemberNicknameJSONBody>;

Expand Down
4 changes: 3 additions & 1 deletion deno/rest/v9/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
},

Expand All @@ -259,6 +260,7 @@ export const Routes = {
/**
* Route for:
* - PATCH `/guilds/{guild.id}/members/@me/nick`
* @deprecated Use guildMember instead.
BenjammingKirby marked this conversation as resolved.
Show resolved Hide resolved
*/
guildCurrentMemberNickname(guildId: Snowflake) {
return `/guilds/${guildId}/members/@me/nick` as const;
Expand Down
12 changes: 12 additions & 0 deletions rest/v8/guild.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,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 interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
/**
Expand All @@ -445,9 +447,19 @@ export interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
*/
nick?: string | null;
}
export interface RESTPatchAPICurrentGuildMemberJSONBody {
BenjammingKirby marked this conversation as resolved.
Show resolved Hide resolved
/**
* 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 = Required<RESTPatchAPICurrentGuildMemberNicknameJSONBody>;

Expand Down
4 changes: 3 additions & 1 deletion rest/v8/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
},

Expand All @@ -259,6 +260,7 @@ export const Routes = {
/**
* Route for:
* - PATCH `/guilds/{guild.id}/members/@me/nick`
* @deprecated Use guildMember instead.
*/
guildCurrentMemberNickname(guildId: Snowflake) {
return `/guilds/${guildId}/members/@me/nick` as const;
Expand Down
13 changes: 12 additions & 1 deletion rest/v9/guild.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,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 interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
/**
Expand All @@ -451,9 +453,18 @@ export interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
*/
nick?: string | null;
}

export interface RESTPatchAPICurrentGuildMemberJSONBody {
BenjammingKirby marked this conversation as resolved.
Show resolved Hide resolved
/**
* 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 = Required<RESTPatchAPICurrentGuildMemberNicknameJSONBody>;

Expand Down
4 changes: 3 additions & 1 deletion rest/v9/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
},

Expand All @@ -259,6 +260,7 @@ export const Routes = {
/**
* Route for:
* - PATCH `/guilds/{guild.id}/members/@me/nick`
* @deprecated Use guildMember instead.
*/
guildCurrentMemberNickname(guildId: Snowflake) {
return `/guilds/${guildId}/members/@me/nick` as const;
Expand Down