james/classcharts-api-js
1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-14 03:56:59 +00:00
Code Activity

docs: update announcements docs

Browse source
This commit is contained in:
James Cook 2023-09-14 19:54:48 +01:00
parent 7529b572a0
commit 687c36f326
1 changed files with 15 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -257,15 +257,26 @@ console.log(badges);
## `.getAnnouncements`
?> This method does not include `meta` in the response, since I do not have
access to this endpoint to test it. If you have access to this endpoint, please
open a PR to add the `meta` response. Thanks!
Gets all announcements.
```typescript
const announcements = await client.getAnnouncements();
console.log(announcements);
/**
{
success: 1,
data: [
{
id: 321453,
title: "A big announcement",
description: "<p>School will be closing early today!</p>",
...
}
],
meta: []
}
*/
```
## `.getDetentions`