Skip to content

Commit fa85cc1

Browse files
author
Samuel Guillemet
committed
📖 DOC: Correct typo
1 parent e2c988d commit fa85cc1

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@ setup_logs(log_level=logging.DEBUG)
110110
4. update an event
111111
5. delete an event
112112

113+
### **users**:
114+
115+
1. get all users
116+
113117
## CERN specific usage
114118

115119
Instead of using the `MSApiClient` class, you can use the `CERNMSApiClient` class, which is a subclass of the `MSApiClient` class.
@@ -139,7 +143,7 @@ cern_ms_client = CERNMSApiClient.init_from_dotenv()
139143

140144
You will find useful the `EventParameters` and `PartialEventParameters` classes, which will help you to create the events.
141145

142-
- `ZOOM_ID` is the id of the zoom meeting, which can be found inside the url of a meeting link, is **mandatory** to create an event.
146+
- `ZOOM_ID` is the id of the zoom meeting, which can be found inside the url of a meeting link. This is **mandatory** to create an event.
143147
- `USER_ID` is the email of the Zoom Room.
144148

145149
```python
@@ -149,23 +153,23 @@ from ms_python_client.utils.event_generator import (EventParameters, PartialEven
149153
cern_ms_client = CERNMSApiClient.init_from_dotenv()
150154

151155
USER_ID = os.getenv("USER_ID") # Which is the email of the Zoom Room
152-
ZOOM = os.getenv("ZOOM")
156+
ZOOM_ID = os.getenv("ZOOM_ID")
153157

154158
event_parameters = EventParameters(
155159
subject="Test meeting",
156160
start_time="2021-10-01T12:00:00",
157161
end_time="2021-10-01T13:00:00",
158162
timezone="Europe/Zurich",
159-
zoom_id=ZOOM,
163+
zoom_id=ZOOM_ID,
160164
zoom_url="https://cern.zoom.us/******",
161165
)
162166

163167
partial_event_parameters = PartialEventParameters(
164-
zoom_id=ZOOM,
168+
zoom_id=ZOOM_ID,
165169
end_time="2021-10-01T14:00:00",
166170
) # You can update only the end_time of the event for example
167171

168172
cern_ms_client.events.create_event(USER_ID, event_parameters)
169173
cern_ms_client.events.update_event_by_zoom_id(USER_ID, partial_event_parameters)
170-
cern_ms_client.events.delete_event_by_zoom_id(USER_ID, ZOOM)
174+
cern_ms_client.events.delete_event_by_zoom_id(USER_ID, ZOOM_ID)
171175
```

0 commit comments

Comments
 (0)