universal-mcp-applications 0.1.30__py3-none-any.whl → 0.1.36rc1__py3-none-any.whl

universal_mcp/applications/canva/app.py

@@ -1,5 +1,4 @@
 from typing import Any
-
 from universal_mcp.applications.application import APIApplication
 from universal_mcp.integrations import Integration
 
@@ -9,7 +8,7 @@ class CanvaApp(APIApplication):
         super().__init__(name="canva", integration=integration, **kwargs)
         self.base_url = "https://api.canva.com/rest"
 
-    def get_app_jwks(self, appId) -> dict[str, Any]:
+    async def get_app_jwks(self, appId) -> dict[str, Any]:
         """
         Retrieves the JSON Web Key Set (JWKS) for a given application ID. The JWKS contains public keys essential for verifying the authenticity of JSON Web Tokens (JWTs) issued by the application, ensuring secure communication.
 
@@ -30,7 +29,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_asset(self, assetId) -> dict[str, Any]:
+    async def get_asset(self, assetId) -> dict[str, Any]:
         """
         Fetches the details of a specific asset using its unique identifier. This function performs a GET request to retrieve asset data, distinguishing it from other functions that update (`v1_assets_assetid2`, `v1_assets_assetid3`) or delete (`v1_assets_assetid`) assets at the same endpoint.
 
@@ -51,7 +50,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def post_update_asset(self, assetId, name=None, tags=None) -> dict[str, Any]:
+    async def post_update_asset(self, assetId, name=None, tags=None) -> dict[str, Any]:
         """
         Updates an asset's name and tags by its ID using an HTTP POST request. This method is distinct from the PATCH-based update function (`v1_assets_assetid2`), which performs a similar action on the same `/v1/assets/{assetId}` endpoint.
 
@@ -78,10 +77,7 @@ class CanvaApp(APIApplication):
         """
         if assetId is None:
             raise ValueError("Missing required parameter 'assetId'")
-        request_body = {
-            "name": name,
-            "tags": tags,
-        }
+        request_body = {"name": name, "tags": tags}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/assets/{assetId}"
         query_params = {}
@@ -89,7 +85,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def delete_asset(self, assetId) -> Any:
+    async def delete_asset(self, assetId) -> Any:
         """
         Deletes a specific Canva asset identified by its unique ID. This function sends an HTTP DELETE request to the `/v1/assets/{assetId}` endpoint to permanently remove the resource, returning the API's confirmation response upon successful completion.
 
@@ -110,7 +106,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def patch_asset(self, assetId, name=None, tags=None) -> dict[str, Any]:
+    async def patch_asset(self, assetId, name=None, tags=None) -> dict[str, Any]:
         """
         Partially updates an asset by its ID using an HTTP PATCH request to modify specific fields like name or tags. Unlike `v1_assets_assetid3` which uses POST, this method applies incremental changes, returning the updated asset data upon completion.
 
@@ -137,10 +133,7 @@ class CanvaApp(APIApplication):
         """
         if assetId is None:
             raise ValueError("Missing required parameter 'assetId'")
-        request_body = {
-            "name": name,
-            "tags": tags,
-        }
+        request_body = {"name": name, "tags": tags}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/assets/{assetId}"
         query_params = {}
@@ -148,7 +141,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def upload_asset(self, request_body=None) -> dict[str, Any]:
+    async def upload_asset(self, request_body=None) -> dict[str, Any]:
         """
         Uploads an asset by sending its data to the `/v1/assets/upload` endpoint. This function performs a direct, synchronous upload, returning a confirmation. It differs from `v1_asset_uploads`, which initiates an asynchronous upload job tracked by an ID.
 
@@ -167,7 +160,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def create_asset_upload_job(self, request_body=None) -> dict[str, Any]:
+    async def create_asset_upload_job(self, request_body=None) -> dict[str, Any]:
         """
         Initiates an asynchronous asset upload by creating an upload job. This method returns details, like a job ID, for subsequent steps. It differs from `v1_assets_upload`, which targets a direct, synchronous upload endpoint.
 
@@ -186,7 +179,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_asset_upload_job_status(self, jobId) -> dict[str, Any]:
+    async def get_asset_upload_job_status(self, jobId) -> dict[str, Any]:
         """
         Retrieves the status and results of an asynchronous asset upload job using its unique job ID. This allows for checking the outcome of an upload initiated by `v1_asset_uploads`, returning details on its completion and any resulting asset information.
 
@@ -207,9 +200,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def create_autofill_job(
-        self, brand_template_id=None, data=None, preview=None, title=None
-    ) -> dict[str, Any]:
+    async def create_autofill_job(self, brand_template_id=None, data=None, preview=None, title=None) -> dict[str, Any]:
         """
         Initiates an autofill job to create a new design by populating a brand template with provided data. It sends a POST request with the template ID, data, and title, returning the details of the newly created job.
 
@@ -243,12 +234,7 @@ class CanvaApp(APIApplication):
         Tags:
             autofill
         """
-        request_body = {
-            "brand_template_id": brand_template_id,
-            "data": data,
-            "preview": preview,
-            "title": title,
-        }
+        request_body = {"brand_template_id": brand_template_id, "data": data, "preview": preview, "title": title}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/autofills"
         query_params = {}
@@ -256,7 +242,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_autofill_job_status(self, jobId) -> dict[str, Any]:
+    async def get_autofill_job_status(self, jobId) -> dict[str, Any]:
         """
         Retrieves the status and results of an asynchronous autofill job by its unique `jobId`. This function is used to check the outcome of a template population operation initiated by the `v1_autofills` method.
 
@@ -277,9 +263,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def list_brand_templates(
-        self, query=None, continuation=None, ownership=None, sort_by=None
-    ) -> dict[str, Any]:
+    async def list_brand_templates(self, query=None, continuation=None, ownership=None, sort_by=None) -> dict[str, Any]:
         """
         Searches for and retrieves a paginated list of brand templates. Results can be filtered by ownership and sorted by relevance, modification date, or title. A continuation token can be used to fetch subsequent pages of templates.
 
@@ -311,19 +295,14 @@ class CanvaApp(APIApplication):
         url = f"{self.base_url}/v1/brand-templates"
         query_params = {
             k: v
-            for k, v in [
-                ("query", query),
-                ("continuation", continuation),
-                ("ownership", ownership),
-                ("sort_by", sort_by),
-            ]
+            for k, v in [("query", query), ("continuation", continuation), ("ownership", ownership), ("sort_by", sort_by)]
             if v is not None
         }
         response = self._get(url, params=query_params)
         response.raise_for_status()
         return response.json()
 
-    def get_brand_template_by_id(self, brandTemplateId) -> dict[str, Any]:
+    async def get_brand_template_by_id(self, brandTemplateId) -> dict[str, Any]:
         """
         Retrieves the complete metadata for a specific brand template using its unique identifier. This is distinct from `v1_brand_templates`, which lists multiple templates, and `v1_brand_templates_brandtemplateid_dataset`, which gets only a template's dataset.
 
@@ -344,7 +323,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_brand_template_dataset(self, brandTemplateId) -> dict[str, Any]:
+    async def get_brand_template_dataset(self, brandTemplateId) -> dict[str, Any]:
         """
         Retrieves the dataset for a specific brand template by its ID. The dataset defines the names and types of autofillable fields, which is essential for programmatically populating the template with data.
 
@@ -365,9 +344,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def create_comment(
-        self, assignee_id=None, attached_to=None, message=None
-    ) -> dict[str, Any]:
+    async def create_comment(self, assignee_id=None, attached_to=None, message=None) -> dict[str, Any]:
         """
         Creates a new top-level comment attached to a specific resource, such as a design. It allows for an optional assignee and a message body, sending a POST request to the `/v1/comments` endpoint and returning the details of the newly created comment.
 
@@ -393,11 +370,7 @@ class CanvaApp(APIApplication):
         Tags:
             comment
         """
-        request_body = {
-            "assignee_id": assignee_id,
-            "attached_to": attached_to,
-            "message": message,
-        }
+        request_body = {"assignee_id": assignee_id, "attached_to": attached_to, "message": message}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/comments"
         query_params = {}
@@ -405,9 +378,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def create_comment_reply(
-        self, commentId, attached_to=None, message=None
-    ) -> dict[str, Any]:
+    async def create_comment_reply(self, commentId, attached_to=None, message=None) -> dict[str, Any]:
         """
         Creates a reply to a specific comment, identified by `commentId`. It sends a POST request with the reply's message and attachment details to the `/v1/comments/{commentId}/replies` endpoint, adding a threaded response to an existing comment.
 
@@ -434,10 +405,7 @@ class CanvaApp(APIApplication):
         """
         if commentId is None:
             raise ValueError("Missing required parameter 'commentId'")
-        request_body = {
-            "attached_to": attached_to,
-            "message": message,
-        }
+        request_body = {"attached_to": attached_to, "message": message}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/comments/{commentId}/replies"
         query_params = {}
@@ -445,7 +413,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_design_comment(self, designId, commentId) -> dict[str, Any]:
+    async def get_design_comment(self, designId, commentId) -> dict[str, Any]:
         """
         Fetches a specific comment from a design using both the design and comment IDs. Unlike other functions that create comments or replies, this method exclusively retrieves the data for a single, existing comment by making a GET request to the API.
 
@@ -469,7 +437,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_connection_keys(self) -> dict[str, Any]:
+    async def get_connection_keys(self) -> dict[str, Any]:
         """
         Fetches a list of connection keys for the authenticated user or application from the `/v1/connect/keys` endpoint. These keys are used for establishing secure connections or integrations with the Canva API.
 
@@ -485,9 +453,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def list_designs(
-        self, query=None, continuation=None, ownership=None, sort_by=None
-    ) -> dict[str, Any]:
+    async def list_designs(self, query=None, continuation=None, ownership=None, sort_by=None) -> dict[str, Any]:
         """
         Retrieves a list of designs available to the user. Results can be filtered by a search query, ownership status, and sort order. It supports pagination for large datasets using a continuation token to fetch multiple designs.
 
@@ -517,21 +483,14 @@ class CanvaApp(APIApplication):
         url = f"{self.base_url}/v1/designs"
         query_params = {
             k: v
-            for k, v in [
-                ("query", query),
-                ("continuation", continuation),
-                ("ownership", ownership),
-                ("sort_by", sort_by),
-            ]
+            for k, v in [("query", query), ("continuation", continuation), ("ownership", ownership), ("sort_by", sort_by)]
             if v is not None
         }
         response = self._get(url, params=query_params)
         response.raise_for_status()
         return response.json()
 
-    def create_design(
-        self, asset_id=None, design_type=None, title=None
-    ) -> dict[str, Any]:
+    async def create_design(self, asset_id=None, design_type=None, title=None) -> dict[str, Any]:
         """
         Creates a new design from an asset. This function sends a POST request to the `/v1/designs` endpoint with the asset ID, design type, and title, returning the data for the newly created design resource.
 
@@ -557,11 +516,7 @@ class CanvaApp(APIApplication):
         Tags:
             design
         """
-        request_body = {
-            "asset_id": asset_id,
-            "design_type": design_type,
-            "title": title,
-        }
+        request_body = {"asset_id": asset_id, "design_type": design_type, "title": title}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/designs"
         query_params = {}
@@ -569,7 +524,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_design(self, designId) -> dict[str, Any]:
+    async def get_design(self, designId) -> dict[str, Any]:
         """
         Fetches the details for a single, specific design using its unique identifier. This function retrieves one design, distinguishing it from `v1_designs` which lists multiple designs and `v1_designs1` which creates a new design.
 
@@ -590,7 +545,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def create_design_import_job(self, request_body=None) -> dict[str, Any]:
+    async def create_design_import_job(self, request_body=None) -> dict[str, Any]:
         """
         Initiates a job to import a file (e.g., PDF, PPTX) for creating a new Canva design. This function sends a POST request to the `/v1/imports` endpoint and returns details of the created import job, including a job ID for status tracking.
 
@@ -609,7 +564,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_design_import_status(self, jobId) -> dict[str, Any]:
+    async def get_design_import_status(self, jobId) -> dict[str, Any]:
         """
         Retrieves the status and results of a specific design import job using its unique `jobId`. This function checks the outcome of an import process initiated by the `v1_imports` method, returning details about the job's progress and final state.
 
@@ -630,7 +585,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def create_design_export(self, design_id=None, format=None) -> dict[str, Any]:
+    async def create_design_export(self, design_id=None, format=None) -> dict[str, Any]:
         """
         Initiates an export job for a specified design based on its ID and format details (e.g., file type, quality). It returns the export job's details, including an ID used to track its status with `v1_exports_exportid`.
 
@@ -659,10 +614,7 @@ class CanvaApp(APIApplication):
         Tags:
             export
         """
-        request_body = {
-            "design_id": design_id,
-            "format": format,
-        }
+        request_body = {"design_id": design_id, "format": format}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/exports"
         query_params = {}
@@ -670,7 +622,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_export_job_status(self, exportId) -> dict[str, Any]:
+    async def get_export_job_status(self, exportId) -> dict[str, Any]:
         """
         Retrieves the status and results of a specific design export job using its unique ID. This is used to check on an export initiated by the `v1_exports` function and to obtain download links for the completed file.
 
@@ -691,7 +643,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_folder_by_id(self, folderId) -> dict[str, Any]:
+    async def get_folder_by_id(self, folderId) -> dict[str, Any]:
         """
         Retrieves detailed information for a specific folder using its unique ID. This GET operation fetches folder metadata, distinguishing it from functions that delete (`v1_folders_folderid`) or update (`v1_folders_folderid2`) the same folder resource.
 
@@ -712,7 +664,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def delete_folder(self, folderId) -> Any:
+    async def delete_folder(self, folderId) -> Any:
         """
         Deletes a folder and all its contents using the folder's unique identifier. This function sends an HTTP DELETE request to the `/v1/folders/{folderId}` endpoint and returns a confirmation status upon successful deletion.
 
@@ -733,7 +685,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def update_folder(self, folderId, name=None) -> dict[str, Any]:
+    async def update_folder(self, folderId, name=None) -> dict[str, Any]:
         """
         Updates a specific folder's properties, such as its name, using its unique ID. This function sends a PATCH request to the `/v1/folders/{folderId}` endpoint to apply partial modifications and returns the updated folder information upon success.
 
@@ -755,9 +707,7 @@ class CanvaApp(APIApplication):
         """
         if folderId is None:
             raise ValueError("Missing required parameter 'folderId'")
-        request_body = {
-            "name": name,
-        }
+        request_body = {"name": name}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/folders/{folderId}"
         query_params = {}
@@ -765,9 +715,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def list_folder_items(
-        self, folderId, continuation=None, item_types=None
-    ) -> dict[str, Any]:
+    async def list_folder_items(self, folderId, continuation=None, item_types=None) -> dict[str, Any]:
         """
         Lists items within a specific folder. Supports optional filtering by item type (asset, design, folder, template) and pagination using a continuation token to navigate through large result sets.
 
@@ -790,18 +738,12 @@ class CanvaApp(APIApplication):
         if folderId is None:
             raise ValueError("Missing required parameter 'folderId'")
         url = f"{self.base_url}/v1/folders/{folderId}/items"
-        query_params = {
-            k: v
-            for k, v in [("continuation", continuation), ("item_types", item_types)]
-            if v is not None
-        }
+        query_params = {k: v for k, v in [("continuation", continuation), ("item_types", item_types)] if v is not None}
         response = self._get(url, params=query_params)
         response.raise_for_status()
         return response.json()
 
-    def move_folder_item(
-        self, from_folder_id=None, item_id=None, to_folder_id=None
-    ) -> Any:
+    async def move_folder_item(self, from_folder_id=None, item_id=None, to_folder_id=None) -> Any:
         """
         Moves an item, such as a design or another folder, from a source folder to a destination folder. It requires the unique IDs for the item, the source folder, and the target folder to perform the relocation, returning a status confirmation upon completion.
 
@@ -824,11 +766,7 @@ class CanvaApp(APIApplication):
         Tags:
             folder
         """
-        request_body = {
-            "from_folder_id": from_folder_id,
-            "item_id": item_id,
-            "to_folder_id": to_folder_id,
-        }
+        request_body = {"from_folder_id": from_folder_id, "item_id": item_id, "to_folder_id": to_folder_id}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/folders/move"
         query_params = {}
@@ -836,7 +774,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def create_folder(self, name=None, parent_folder_id=None) -> dict[str, Any]:
+    async def create_folder(self, name=None, parent_folder_id=None) -> dict[str, Any]:
         """
         Creates a new folder, optionally assigning it a name and placing it within a specified parent folder. This function is distinct from others as it uses a POST request to the base `/v1/folders` endpoint, specifically for creation.
 
@@ -857,10 +795,7 @@ class CanvaApp(APIApplication):
         Tags:
             folder
         """
-        request_body = {
-            "name": name,
-            "parent_folder_id": parent_folder_id,
-        }
+        request_body = {"name": name, "parent_folder_id": parent_folder_id}
         request_body = {k: v for k, v in request_body.items() if v is not None}
         url = f"{self.base_url}/v1/folders"
         query_params = {}
@@ -868,7 +803,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_current_user(self) -> dict[str, Any]:
+    async def get_current_user(self) -> dict[str, Any]:
         """
         Retrieves core information for the currently authenticated user, such as ID and team details. This function is distinct from `v1_users_me_profile`, which fetches more specific profile data like the user's display name and profile picture.
 
@@ -884,7 +819,7 @@ class CanvaApp(APIApplication):
         response.raise_for_status()
         return response.json()
 
-    def get_current_user_profile(self) -> dict[str, Any]:
+    async def get_current_user_profile(self) -> dict[str, Any]:
         """
         Fetches detailed profile information for the currently authenticated user. This method is distinct from `v1_users_me`, which retrieves general user account information rather than specific profile details like display name or avatar.