From f52afdd1d8b8e5fd8a715906afd4200284465e69 Mon Sep 17 00:00:00 2001 From: Sacul Date: Wed, 20 Aug 2025 16:46:16 +0800 Subject: [PATCH 1/7] Add `with_permissions` query and `is_nickname_changeable` field --- docs/resources/invite.mdx | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index 9a80be8937..c9974eca06 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -17,6 +17,7 @@ Represents a code that when used, adds a user to a guild or group DM channel. | guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for | | channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for | | inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite | +| is_nickname_changeable? | [boolean](/docs/reference#boolean-query-strings) | the members ability to change their nickname by default, returned from the `GET /invites/` endpoint when `?with_permissions` is `true` | | target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite | | target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite | | target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite | @@ -159,10 +160,11 @@ Returns an [invite](/docs/resources/invite#invite-object) object for the given c ###### Query String Params -| Field | Type | Description | -|---------------------------|--------------------------------------------------|-------------------------------------------------------------| -| with_counts? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain approximate member counts | -| guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite | +| Field | Type | Description | +|---------------------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------| +| with_counts? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain approximate member counts | +| guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite | +| with_permissions? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain the `is_nickname_changeable` field | ## Delete Invite /invites/[\{invite.code\}](/docs/resources/invite#invite-object) From 9bd3af1376d2a59a07ebcaae2336860d39fee444 Mon Sep 17 00:00:00 2001 From: Sacul Date: Wed, 20 Aug 2025 16:47:59 +0800 Subject: [PATCH 2/7] change wording --- docs/resources/invite.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index c9974eca06..fffb984dfa 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -17,7 +17,7 @@ Represents a code that when used, adds a user to a guild or group DM channel. | guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for | | channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for | | inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite | -| is_nickname_changeable? | [boolean](/docs/reference#boolean-query-strings) | the members ability to change their nickname by default, returned from the `GET /invites/` endpoint when `?with_permissions` is `true` | +| is_nickname_changeable? | [boolean](/docs/reference#boolean-query-strings) | a member's ability to change their nickname by default, returned from the `GET /invites/` endpoint when `with_permissions` is `true` | | target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite | | target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite | | target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite | From 8b901d21f583c8391a1d503f33e371c298887204 Mon Sep 17 00:00:00 2001 From: Sacul Date: Wed, 20 Aug 2025 16:54:29 +0800 Subject: [PATCH 3/7] Update invite.mdx --- docs/resources/invite.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index fffb984dfa..1c0eb64ade 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -160,11 +160,11 @@ Returns an [invite](/docs/resources/invite#invite-object) object for the given c ###### Query String Params -| Field | Type | Description | -|---------------------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------| -| with_counts? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain approximate member counts | -| guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite | -| with_permissions? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain the `is_nickname_changeable` field | +| Field | Type | Description | +|---------------------------|--------------------------------------------------|----------------------------------------------------------------------| +| with_counts? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain approximate member counts | +| guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite | +| with_permissions? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain the `is_nickname_changeable` field | ## Delete Invite /invites/[\{invite.code\}](/docs/resources/invite#invite-object) From b360c47bca379276b0aed1559cc3c0026004815d Mon Sep 17 00:00:00 2001 From: Sacul Date: Thu, 21 Aug 2025 06:53:13 +0800 Subject: [PATCH 4/7] Update invite.mdx --- docs/resources/invite.mdx | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index 1c0eb64ade..92e7e040dc 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -10,23 +10,24 @@ Represents a code that when used, adds a user to a guild or group DM channel. ###### Invite Structure -| Field | Type | Description | -|-----------------------------|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -| type | integer | the [type of invite](/docs/resources/invite#invite-object-invite-types) | -| code | string | the invite code (unique ID) | -| guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for | -| channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for | -| inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite | +| Field | Type | Description | +| --------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| type | integer | the [type of invite](/docs/resources/invite#invite-object-invite-types) | +| code | string | the invite code (unique ID) | +| guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for | +| channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for | +| inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite | | is_nickname_changeable? | [boolean](/docs/reference#boolean-query-strings) | a member's ability to change their nickname by default, returned from the `GET /invites/` endpoint when `with_permissions` is `true` | -| target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite | -| target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite | -| target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite | -| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | -| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | -| expires_at | ?ISO8601 timestamp | the expiration date of this invite | +| target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite | +| target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite | +| target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite | +| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | +| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | +| expires_at | ?ISO8601 timestamp | the expiration date of this invite | | stage_instance? | [invite stage instance](/docs/resources/invite#invite-stage-instance-object) object | stage instance data if there is a [public Stage instance](/docs/resources/stage-instance) in the Stage channel this invite is for (deprecated) | -| guild_scheduled_event? | [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id | -| flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites | +| guild_scheduled_event? | [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id | +| flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites | + ###### Invite Types From 1f92cc92cb1e69becfa32c0c22173f39a2ad31cc Mon Sep 17 00:00:00 2001 From: Sacul Date: Thu, 21 Aug 2025 07:09:08 +0800 Subject: [PATCH 5/7] revert the change, will fix it later on --- docs/resources/invite.mdx | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index 92e7e040dc..f97d2b82c6 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -10,23 +10,23 @@ Represents a code that when used, adds a user to a guild or group DM channel. ###### Invite Structure -| Field | Type | Description | -| --------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| type | integer | the [type of invite](/docs/resources/invite#invite-object-invite-types) | -| code | string | the invite code (unique ID) | -| guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for | -| channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for | -| inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite | +| Field | Type | Description | +|-----------------------------|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| type | integer | the [type of invite](/docs/resources/invite#invite-object-invite-types) | +| code | string | the invite code (unique ID) | +| guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for | +| channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for | +| inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite | | is_nickname_changeable? | [boolean](/docs/reference#boolean-query-strings) | a member's ability to change their nickname by default, returned from the `GET /invites/` endpoint when `with_permissions` is `true` | -| target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite | -| target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite | -| target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite | -| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | -| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | -| expires_at | ?ISO8601 timestamp | the expiration date of this invite | +| target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite | +| target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite | +| target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite | +| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | +| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | +| expires_at | ?ISO8601 timestamp | the expiration date of this invite | | stage_instance? | [invite stage instance](/docs/resources/invite#invite-stage-instance-object) object | stage instance data if there is a [public Stage instance](/docs/resources/stage-instance) in the Stage channel this invite is for (deprecated) | -| guild_scheduled_event? | [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id | -| flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites | +| guild_scheduled_event? | [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id | +| flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites | ###### Invite Types From 7d69b5991c5d242d17cf27352c2ebaa691f4bddb Mon Sep 17 00:00:00 2001 From: Sacul Date: Thu, 21 Aug 2025 16:10:58 +0800 Subject: [PATCH 6/7] fixed the table --- docs/resources/invite.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index f97d2b82c6..04cff1ab3b 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -17,7 +17,7 @@ Represents a code that when used, adds a user to a guild or group DM channel. | guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for | | channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for | | inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite | -| is_nickname_changeable? | [boolean](/docs/reference#boolean-query-strings) | a member's ability to change their nickname by default, returned from the `GET /invites/` endpoint when `with_permissions` is `true` | +| is_nickname_changeable? | [boolean](/docs/reference#boolean-query-strings) | a member's ability to change their nickname by default, returned from the `GET /invites/` endpoint when `with_permissions` is `true` | | target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite | | target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite | | target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite | From 7a8d800d14bfdc0cf6932f669c5f2cb1bcb8d6a3 Mon Sep 17 00:00:00 2001 From: Sacul Date: Thu, 21 Aug 2025 16:13:26 +0800 Subject: [PATCH 7/7] Update invite.mdx --- docs/resources/invite.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index 04cff1ab3b..ee30c97cd0 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -28,7 +28,6 @@ Represents a code that when used, adds a user to a guild or group DM channel. | guild_scheduled_event? | [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id | | flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites | - ###### Invite Types | Type | Value |