Add support for the new /supreme endpoint. (#11)

alexflipnote/__init__.py

@@ -3,7 +3,7 @@
 from .errors import *
 from .enums import *
 
-__version__ = "4.0.0"
+__version__ = "4.0.1"
 __author__ = "Soheab"
 __license__ = "MPL-2.0"
 __description__ = "An easy to use Python Wrapper for the AlexFlipnote API"

alexflipnote/client.py

@@ -302,6 +302,22 @@ async def scroll(self, text: str) -> Image:
         url = await self.__http.with_image(Endpoint.SCROLL, text=text)
         return Image(url, self.__http._session)  # type: ignore
 
+    async def supreme(self, text: str) -> Image:
+        """Returns a supreme image.
+
+        Parameters
+        ----------
+        text: :class:`str`
+            The text to display on the image.
+
+        Returns
+        -------
+        :class:`.Image`
+            The image object.
+        """
+        url = await self.__http.with_image(Endpoint.SUPREME, text=text)
+        return Image(url, self.__http._session)  # type: ignore
+
     async def did_you_mean(self, top: str, bottom: str) -> Image:
         """Returns a did you mean message.
 

alexflipnote/enums.py

@@ -29,6 +29,7 @@ class Endpoint(_BaseEnum):
     FACTS = "/facts"
     PORNHUB = "/pornhub"
     SCROLL = "/scroll"
+    SUPREME = "/supreme"
 
 
 class WithJsonEndpoint(_BaseEnum):

changelog.md

@@ -3,6 +3,10 @@ See here what changed or broke each version.
 
 ---
 
+### 4.0.1 - February 12, 2023
+
+- Add support for the new `/supreme` endpoint.
+
 ### v4.0.0 - December 8, 2022
 Ayo another major release! A lot of endpoints that were previously removed are now back!!
 

docs/methods.md

@@ -131,6 +131,14 @@ Returns a scroll message.
 
 ---
 
+### await alex_api.supreme(text: [str]) -> [Image]
+Returns a supreme message.
+
+#### Parameters
+- text ([str]) - The text to display on the image.
+
+---
+
 ### await alex_api.sillycat(left_hex: [Optional]\[[str]] = ``None``, right_hex: [Optional]\[[str]] = ``None``, *, random: [bool] = ``True``, seed: [Optional]\[[Any]] = None, return_image: [bool] = ``False``) -> [SillyCat]
 Generates a SillyCat image