[clans] Adds documentation for user clan information

discord · May 2, 2024 · 90296f0 · 90296f0
1 parent 0a7d731
commit 90296f0
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/docs/Reference.md b/docs/Reference.md
@@ -344,6 +344,7 @@ Discord uses ids and hashes to render images in the client. These hashes can be
 | Role Icon                   | role-icons/[role_id](#DOCS_TOPICS_PERMISSIONS/role-object)/[role_icon](#DOCS_TOPICS_PERMISSIONS/role-object).png                                                                                                                                                  | PNG, JPEG, WebP      |
 | Guild Scheduled Event Cover | guild-events/[scheduled_event_id](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object)/[scheduled_event_cover_image](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object).png                                                       | PNG, JPEG, WebP      |
 | Guild Member Banner         | guilds/[guild_id](#DOCS_RESOURCES_GUILD/guild-object)/users/[user_id](#DOCS_RESOURCES_USER/user-object)/banners/[member_banner](#DOCS_RESOURCES_GUILD/guild-member-object).png \*                                                                                 | PNG, JPEG, WebP, GIF |
+| Clan Badge                  | clan-badges/[guild_id](#DOCS_RESOURCES_GUILD/guild-object)/[badge_hash](#DOCS_RESOURCES_USER/user-object-user-clan).png \*                                                                                                                                        | PNG, JPEG, WebP, GIF |
 
 \* In the case of endpoints that support GIFs, the hash will begin with `a_` if it is available in GIF format. (example: `a_1269e74af4df7417b13759eae50c83dc`)
 

diff --git a/docs/resources/User.md b/docs/resources/User.md
@@ -43,6 +43,7 @@ There are other rules and restrictions not shared here for the sake of spam and
 | premium_type?      | integer   | the [type of Nitro subscription](#DOCS_RESOURCES_USER/user-object-premium-types) on a user's account | identify              |
 | public_flags?      | integer   | the public [flags](#DOCS_RESOURCES_USER/user-object-user-flags) on a user's account                  | identify              |
 | avatar_decoration? | ?string   | the user's [avatar decoration hash](#DOCS_REFERENCE/image-formatting)                                | identify              |
+| clan?              | ?UserClan | the user's [clan data](#DOCS_RESOURCES_USER/user-object-user-clan)                                   | identify              |
 
 ###### Example User
 
@@ -59,6 +60,12 @@ There are other rules and restrictions not shared here for the sake of spam and
   "accent_color": 16711680,
   "premium_type": 1,
   "public_flags": 64
+  "clan": {
+    "identity_guild_id": "1234647491267808778",
+    "identity_enabled": true,
+    "tag": "DISC",
+    "badge": "7d1734ae5a615e82bc7a4033b98fade8"
+  },
 }
 ```
 
@@ -93,6 +100,15 @@ Premium types denote the level of premium a user has. Visit the [Nitro](https://
 | 2     | Nitro         |
 | 3     | Nitro Basic   |
 
+###### User Flags
+
+| Field             | Type      | Description                                              |
+|-------------------|-----------|----------------------------------------------------------|
+| identity_guild_id | snowflake | the id of the user's primary clan                        |
+| identity_enabled  | boolean   | whether the user is displaying their clan tag            |
+| tag               | string    | the text of the user's clan tag. Limited to 4 characters |
+| badge             | string    | the [clan badge hash](#DOCS_REFERENCE/image-formatting)  |
+
 ### Connection Object
 
 The connection object that the user has attached.