📝 Update documentation

cern-vc · Aug 31, 2023 · 934306c · 934306c
1 parent 82e7928
commit 934306c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -158,6 +158,7 @@ cern_ms_client = CERNMSApiClient.init_from_dotenv()
 4. update an event using zoom id
 5. delete an event using zoom id
 6. get the zoom id of an event
+7. get current event of a user
 
 You will find useful the `EventParameters` and `PartialEventParameters` classes, which will help you to create the events.
 

diff --git a/ms_python_client/components/events/cern_events_component.py b/ms_python_client/components/events/cern_events_component.py
@@ -40,6 +40,7 @@ def list_events(
         Args:
             user_id (str): The user id
             parameters (dict): Optional parameters for the request
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request
@@ -55,7 +56,9 @@ def get_event_by_zoom_id(
         """Get an event of a user
 
         Args:
+            user_id (str): The user id
             zoom_id (str): The event id
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request
@@ -91,7 +94,9 @@ def get_event_zoom_id(
         """Get the zoom id of an event of a user
 
         Args:
+            user_id (str): The user id
             event_id (str): The event id
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             str: The zoom id of the event
@@ -120,7 +125,9 @@ def create_event(
 
         Args:
             user_id (str): The user id
+            zoom_id (str): The zoom id of the event
             event (EventParameters): The event data
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request
@@ -139,7 +146,9 @@ def update_event_by_zoom_id(
 
         Args:
             user_id (str): The user id
+            zoom_id (str): The zoom id of the event
             event (EventParameters): The event parameters
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request
@@ -161,6 +170,7 @@ def delete_event_by_zoom_id(
         Args:
             user_id (str): The user id
             zoom_id (str): The event id
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request