From 5e0c6dabba48a6dabe535304a5eea25391e0ea30 Mon Sep 17 00:00:00 2001
From: Linus E <75929322+Rripped@users.noreply.github.com>
Date: Tue, 10 May 2022 09:55:41 +0200
Subject: [PATCH] added missing docstring part

---
 telegram_bot/api_handling/api_handler.py | 45 ++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/telegram_bot/api_handling/api_handler.py b/telegram_bot/api_handling/api_handler.py
index 6d637d7..7e1110e 100644
--- a/telegram_bot/api_handling/api_handler.py
+++ b/telegram_bot/api_handling/api_handler.py
@@ -70,6 +70,12 @@ class API_Handler:
         Args:
             email (string): email of the user
             password (string): password of the user
+
+        Returns:
+            token (string): new token or None if not 200
+
+        Raises:
+            None
         """
         payload = {'email': email, 'password': password}
         with r.Session() as s:
@@ -91,6 +97,9 @@ class API_Handler:
 
         Returns:
             json: json of user infos
+        
+        Raises:
+            None
         """
         if max_retries <= 0:
             return None
@@ -113,6 +122,9 @@ class API_Handler:
 
         Returns:
             list: list of users
+        
+        Raises:
+            None
         """
         if max_retries <= 0:
             return None
@@ -136,6 +148,9 @@ class API_Handler:
 
         Returns:
             list: list of keywords
+        
+        Raises:
+            None
         """
         if max_retries <= 0:
             return None
@@ -165,6 +180,9 @@ class API_Handler:
 
         Returns:
             int: status code
+
+        Raises:
+            None
         """
         with r.Session() as s:
             headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)}
@@ -182,6 +200,9 @@ class API_Handler:
 
         Returns:
             int: status code
+
+        Raises:
+            None
         """
         with r.Session() as s:
             headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)}
@@ -199,6 +220,9 @@ class API_Handler:
 
         Returns:
             list: list of shares
+
+        Raises:
+            None
         """
         if max_retries <= 0:
             return None
@@ -228,6 +252,9 @@ class API_Handler:
         
         Returns:
             int: status code
+
+        Raises:
+            None
         """
         with r.Session() as s:
             headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)}
@@ -244,6 +271,9 @@ class API_Handler:
         
         Returns:
             int: status code
+
+        Raises:
+            None
         """
         with r.Session() as s:
             headers = {'Authorization': 'Bearer ' + self.token + ":" + str(user_id)}
@@ -260,6 +290,9 @@ class API_Handler:
         
         Returns:
             dict: dictionary of transactions
+        
+        Raises:
+            None
         """
         if max_retries <= 0:
             return None
@@ -288,6 +321,9 @@ class API_Handler:
         
         Returns:
             int: status code
+        
+        Raises:
+            None
         """
         with r.Session() as s:
             time = time[:-3] + "Z" # remove last character and add Z to make it a valid date for db
@@ -306,6 +342,9 @@ class API_Handler:
         
         Returns:
             dict: dictionary of portfolio
+        
+        Raises:
+            None
         """
         if max_retries <= 0:
             return None
@@ -328,6 +367,9 @@ class API_Handler:
         
         Returns:
             int: status code
+        
+        Raises:
+            None
         """
         if not croniter.is_valid(cron_interval): # check if cron_interval is in valid format
             print("Error: Invalid cron format")
@@ -348,6 +390,9 @@ class API_Handler:
         
         Returns:
             int: status code
+        
+        Raises:
+            None
         """
         with r.Session() as s:
             headers = {'Authorization': 'Bearer ' + self.token} # only bot token is needed, user is chosen by email