Merge pull request #28 from shawnCaza/master

picsoung · web-flow · commit 638581fe804c · 2023-01-25T12:26:21.000-08:00
Added support for some theme and image endpoints.
diff --git a/README.md b/README.md
@@ -13,6 +13,8 @@ Python Client wrapper for [Typeform API](https://developer.typeform.com/)
   - [Create Client](#typeformapi_key)
   - [Forms](#forms)
   - [Responses](#responses)
+  - [Themes](#themes)
+  - [Images](#images)
 - [Tests](#tests)
 
 ## Installation
@@ -151,6 +153,53 @@ result: str = responses.delete('abc123' 'token1')
 result: str = responses.delete('abc123' ['token2', 'token3'])
 ```
 
+### Themes
+
+#### `themes.get(uid: str)`
+
+Retrieves a theme by the given theme_id. [See docs](https://developer.typeform.com/create/reference/retrieve-theme/).
+
+```python
+themes = Typeform('<api_key>').themes
+result: dict = themes.get('abc123')
+```
+
+#### `themes.list(page: int = None, pageSize: int = None)`
+
+Retrieves a list of JSON descriptions for all themes in your Typeform account (public and private). Themes are listed in reverse-chronological order based on the date you added them to your account.
+
+```python
+themes = Typeform('<api_key>').themes
+result: dict = themes.get('abc123')
+```
+
+### Images
+
+#### `images.get(uid: str)`
+
+Retrieves an image by the given id. [See docs](https://developer.typeform.com/create/reference/retrieve-image).
+
+```python
+images = Typeform('<api_key>').images
+result: dict = images.get('abc123')
+```
+
+#### `images.list()`
+
+Retrieves a list of JSON descriptions for all images in your Typeform account. Images are listed in reverse-chronological order based on the date you added them to your account.
+
+```python
+images = Typeform('<api_key>').images
+result: dict = images.list()
+```
+
+#### `images.upload(file_name : str, image : str = None, url : str = None)`
+
+Adds an image in your Typeform account.
+
+Specify the URL of your image or send your image in base64 format, which encodes the image data as ASCII text. You can use a tool like Base64 Image Encoder to get the base64 code for the image you want to add.
+
+
 ## Tests
 
 Check typeform/test/fixtures.py to configure test run.
diff --git a/typeform/__init__.py b/typeform/__init__.py
@@ -1,4 +1,6 @@
 from .forms import Forms
+from .themes import Themes
+from .images import Images
 from .responses import Responses
 from .client import Client
 
@@ -12,12 +14,22 @@ def __init__(self, token: str, headers: dict = {}):
         """Constructor for Typeform API client"""
         client = Client(token, headers=headers)
         self.__forms = Forms(client)
+        self.__themes = Themes(client)
+        self.__images = Images(client)
         self.__responses = Responses(client)
 
     @property
     def forms(self) -> Forms:
         return self.__forms
 
+    @property
+    def themes(self) -> Themes:
+        return self.__themes
+
+    @property
+    def images(self) -> Images:
+        return self.__images
+
     @property
     def responses(self) -> Responses:
         return self.__responses
diff --git a/typeform/images.py b/typeform/images.py
@@ -0,0 +1,35 @@
+import typing
+from .client import Client
+
+
+class Images:
+    """Typeform Forms API client"""
+    def __init__(self, client: Client):
+        """Constructor for Typeform Images class"""
+        self.__client = client
+
+    @property
+    def messages(self):
+        return self.__messages
+
+    def get(self, uid: str) -> dict:
+        """Retrieves an image by the given id."""
+
+        return self.__client.request('get', '/images/%s' % uid)
+
+    def list(self) -> dict:
+        """
+        Retrieves a list of JSON descriptions for all images in your Typeform account. Images are listed in reverse-chronological order based on the date you added them to your account.
+        """
+        return self.__client.request('get', '/images')
+
+    def upload(self, file_name : str, image : str = None, url : str = None) -> dict:
+        """
+        Adds an image in your Typeform account.
+
+        Specify the URL of your image or send your image in base64 format, which encodes the image data as ASCII text. You can use a tool like Base64 Image Encoder to get the base64 code for the image you want to add.
+        """
+        return self.__client.request('post', '/images', data={
+            'file_name': file_name,
+            'image': image,
+        })
diff --git a/typeform/themes.py b/typeform/themes.py
@@ -0,0 +1,28 @@
+import typing
+from .client import Client
+
+
+class Themes:
+    """Typeform Forms API client"""
+    def __init__(self, client: Client):
+        """Constructor for Typeform Theme class"""
+        self.__client = client
+
+    @property
+    def messages(self):
+        return self.__messages
+
+    def get(self, uid: str) -> dict:
+        """Retrieves a form by the given form_id. Includes any theme and images attached to the form as references."""
+        return self.__client.request('get', '/themes/%s' % uid)
+
+    def list(self, page: int = None, pageSize: int = None) -> dict:
+        """
+        Retrieves a list of JSON descriptions for all themes in your Typeform account (public and private). Themes are listed in reverse-chronological order based on the date you added them to your account.
+        """
+        return self.__client.request('get', '/themes', params={
+            'page': page,
+            'page_size': pageSize,
+        })
+
+    
