From 848777b65b4bbc0523c67eb6395643d83e1202e4 Mon Sep 17 00:00:00 2001 From: acatia Date: Sun, 7 Jan 2024 20:18:33 +0000 Subject: [PATCH] Add new methods to docs --- docs/api.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/api.md b/docs/api.md index e5adc83..4dab84b 100644 --- a/docs/api.md +++ b/docs/api.md @@ -19,6 +19,7 @@ The base class for all Bloxlink API interactions. **Parameters:** * **discord_id (int)**: the Roblox ID of the user you want to find the Discord ID of. * **server_id (int)**: the ID of the server you want to search in. + \**if you intend on doing a global search (which required approval), do not include this argument. Otherwise, you must provide this argument.* @@ -30,6 +31,7 @@ The base class for all Bloxlink API interactions. **Parameters:** * **roblox_id (int)**: the ID of the Discord user you want to find the Roblox ID of. * **server_id (int)***: the ID of the server you want to search in. + \**if you intend on doing a global search (which required approval), do not include this argument. Otherwise, you must provide this argument.* @@ -84,6 +86,22 @@ This information is only retrieved if you have Bloxlink Premium. * **has_verified_badge (Optional[str])**: Whether the user has a verified badge. * **groups2 (Optional[str])**: The Roblox users' groups. (this lists the groups in a dictionary using the group ID as the key as opposed to a list) +**Methods:** +* **await get_avatar_headshot_url()** + + Makes a request to Roblox's API for the avatar headshot image URL. + Returns None if avatar can't be retrieved. + +* **await get_avatar_bust_url()** + + Makes a request to Roblox's API for the avatar bust image URL. + Returns None if avatar can't be retrieved. + +* **await get_avatar_fullbody_url()** + + Makes a request to Roblox's API for the avatar full body image URL. + Returns None if avatar can't be retrieved. + ## Responses `class bloxlink.RobloxUserResponse`