rebased from master and updated missing annotations for arguments

Author: bandophahita

atlassian/jira.py

@@ -251,7 +251,7 @@ def get_attachment(self, attachment_id: T_id) -> T_resp_json:
         url = f"{base_url}/{attachment_id}"
         return self.get(url)
 
-    def download_issue_attachments(self, issue, path=None):
+    def download_issue_attachments(self, issue: T_id, path: Optional[str] = None) -> Optional[str]:
         """
         Downloads all attachments from a Jira issue.
         :param issue: The issue-key of the Jira issue
@@ -757,7 +757,7 @@ def add_custom_field_option(self, field_id: T_id, context_id: T_id, options: lis
     Reference: https://docs.atlassian.com/software/jira/docs/api/REST/8.5.0/#api/2/dashboard
     """
 
-    def get_dashboards(self, filter: str = "", start: int = 0, limit: int = 10):
+    def get_dashboards(self, filter: str = "", start: int = 0, limit: int = 10) -> Optional[dict]:
         """
         Returns a list of all dashboards, optionally filtering them.
         :param filter: OPTIONAL: an optional filter that is applied to the list of dashboards.
@@ -782,7 +782,7 @@ def get_dashboards(self, filter: str = "", start: int = 0, limit: int = 10):
         url = self.resource_url("dashboard")
         return self.get(url, params=params)
 
-    def get_dashboard(self, dashboard_id: T_id):
+    def get_dashboard(self, dashboard_id: T_id) -> Optional[dict]:
         """
         Returns a single dashboard
 
@@ -1568,7 +1568,7 @@ def issue_add_watcher(self, issue_key: str, user: str):
             data=data,
         )
 
-    def issue_delete_watcher(self, issue_key, user=None, account_id=None):
+    def issue_delete_watcher(self, issue_key: str, user: Optional[str] = None, account_id: Optional[str] = None):
         """
         Stop watching issue
         :param issue_key:
@@ -3474,11 +3474,11 @@ def jql(
 
     def enhanced_jql(
         self,
-        jql,
-        fields="*all",
-        nextPageToken=None,
-        limit=None,
-        expand=None,
+        jql: str,
+        fields: Union[str, List[str]] = "*all",
+        nextPageToken: Optional[str] = None,
+        limit: Optional[int] = None,
+        expand: Optional[str] = None,
     ):
         """
         Get issues from jql search result with all related fields
@@ -3493,7 +3493,8 @@ def enhanced_jql(
 
         if not self.cloud:
             raise ValueError("``enhanced_jql`` method is only available for Jira Cloud platform")
-        params = {}
+        params: dict = {}
+        
         if nextPageToken is not None:
             params["nextPageToken"] = str(nextPageToken)
         if limit is not None:
@@ -3511,7 +3512,7 @@ def enhanced_jql(
 
     def approximate_issue_count(
         self,
-        jql,
+        jql: str,
     ):
         """
         Get an approximate count of issues matching a JQL search string.
@@ -3595,10 +3596,10 @@ def jql_get_list_of_tickets(
 
     def enhanced_jql_get_list_of_tickets(
         self,
-        jql,
-        fields="*all",
-        limit=None,
-        expand=None,
+        jql: str,
+        fields: Union[str, dict] = "*all",
+        limit: Optional[int] = None,
+        expand: Optional[str] = None,
     ):
         """
         Get issues from JQL search result with all related fields using nextPageToken pagination.
@@ -3616,7 +3617,7 @@ def enhanced_jql_get_list_of_tickets(
         if not self.cloud:
             raise ValueError("``enhanced_jql_get_list_of_tickets`` is only available for Jira Cloud.")
 
-        params = {}
+        params: dict = {}
         if limit is not None:
             params["maxResults"] = int(limit)
         if fields is not None:
@@ -3968,7 +3969,15 @@ def set_permissionscheme_grant(self, permission_id: T_id, new_permission: str) -
         url = f"{base_url}/{permission_id}/permission"
         return self.post(url, data=new_permission)
 
-    def update_permissionscheme(self, permission_id, name, description=None, permissions=None, scope=None, expand=None):
+    def update_permissionscheme(
+        self,
+        permission_id: str,
+        name: str,
+        description: Optional[str] = None,
+        permissions: Optional[list[dict]] = None,
+        scope: Optional[str] = None,
+        expand: Optional[str] = None,
+    ):
         """
         Updates a permission scheme. Below are some important things to note when using this resource:
         - If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
@@ -4001,7 +4010,7 @@ def update_permissionscheme(self, permission_id, name, description=None, permiss
         """
         base_url = self.resource_url("permissionscheme")
         url = f"{base_url}/{permission_id}"
-        data = {"name": name}
+        data: dict = {"name": name}
         if description is not None:
             data["description"] = description
         if permissions is not None: