\n\t
\n\tA Node.js and Deno wrapper for getting information from the Classcharts API.\n\t
\n\n\n\tSource\n\t • \n\tIssues\n\t • \n\tNPM\n • \n\tDeno\n\t • \n\tDiscord\n • \n\tLibrary Docs\n\t • \n\tAPI Docs\n
\n\n# Introduction\n\nThe ClassCharts API is a typescript wrapper around the ClassCharts API. It\nallows you to easily make requests to the ClassCharts API without having to\nworry about the underlying implementation of making requests.\n\n## Help\n\nFor any help with the library, please join the\n[discord](https://discord.gg/DTcwugcgZ2) where you can ask questions and get\nhelp from the community.\n\n# Contributing\n\nContributions are welcome! There are lots of API endpoints which we simply do\nnot have access to to implement, so if you have access to them, please consider\ncontributing! If you have any questions, feel free to ask in the\n[discord](https://discord.gg/DTcwugcgZ2).\n\n# Installation\n\n## Requirements\n\n- Node.js 20 or newer\\\n OR\n- Deno\n\n## NPM\n\n```bash\nnpm install classcharts-api\n```\n\n## Deno\n\nThe imports in the examples are for Node.js, but can easily be substituted for\nDeno.\n\n```typescript\nimport {\n ParentClient,\n StudentClient,\n} from \"https://deno.land/x/classcharts_api/mod.ts\";\n```\n\n# Logging In\n\nBefore making any requests, you must login to the client. This will get you a\nsession ID which will be used for all requests.\n\n## Student Client\n\n```typescript\nimport { StudentClient } from \"classcharts-api\";\n\n// Date of birth MUST in the format DD/MM/YYYY\nconst client = new StudentClient(\"classchartsCode\", \"01/01/2000\");\nawait client.login();\n```\n\n## Parent Client\n\n?> The parent client is not tested, as I do not have access to a parent account.\nIf you experience any issues, please open an issue or PR.\n\n```typescript\nimport { ParentClient } from \"classcharts-api\";\n\nconst client = new ParentClient(\"username\", \"password\");\nawait client.login();\n```\n\n# Universal Methods\n\nAll the following methods can be used on both the student and parent client.\nEach example expects the client to be already logged in.\n\n## `.getStudentInfo`\n\n```typescript\nconst studentInfo = await client.getStudentInfo();\nconsole.log(studentInfo);\n/**\n{\n success: 1,\n data: {\n user: {\n id: 2339528,\n ...\n }\n },\n meta: {\n session_id: '5vf2v7n5uk9jftrxaarrik39vk6yjm48',\n ...\n }\n}\n*/\n```\n\n## `.getActivity`\n\n```typescript\n// Dates must be in format YYYY-MM-DD\nconst activity = await client.getActivity({\n from: \"2023-04-01\",\n to: \"2023-05-10\",\n last_id: \"12\",\n});\nconsole.log(activity);\n```\n\n## `.getFullActivity`\n\n```typescript\n// Dates must be in format YYYY-MM-DD\nconst activity = await client.getFullActivity({\n from: \"2023-04-01\",\n to: \"2023-05-10\",\n});\nconsole.log(activity);\n```\n\n## `.getBehaviour`\n\nGets behaviour for a given date range.\n\n```typescript\n// Dates must be in format YYYY-MM-DD\nconst behaviour = await client.getBehaviour({\n from: \"2023-04-01\",\n to: \"2023-05-10\",\n});\nconsole.log(behaviour);\n\n/**\n{\n \"success\": 1,\n \"data\": {\n \"timeline\": [\n {\n \"positive\": 426,\n ...\n },\n ],\n\t...\n \"meta\": {\n \"start_date\": \"2023-04-01T00:00:00+00:00\",\n ...\n }\n}\n*/\n```\n\n## `.getHomeworks`\n\nGets homeworks for a given date range.\n\n```typescript\n// Dates must be in format YYYY-MM-DD\nconst homeworks = await client.getHomeworks({\n from: \"2023-04-01\",\n to: \"2023-05-10\",\n\tdisplayDate: 'issue_date' // Can be 'due_date' or 'issue_date'\n});\nconsole.log(homeworks);\n\n/**\n{\n success: 1,\n data: [\n {\n lesson: '7A/Pe1',\n\t\t\t...\n\t\t},\n ],\n meta: {\n start_date: '2023-04-01T00:00:00+00:00',\n\t\t...\n }\n}\n```\n\n## `.getLessons`\n\nGets lessons for a specific date.\n\n```typescript\n// Dates must be in format YYYY-MM-DD\nconst lessons = await client.getLessons({\n date: \"2023-04-01\",\n});\nconsole.log(lessons);\n\n/**\n{\n \"success\": 1,\n \"data\": [\n {\n \"teacher_name\": \"Mr J Doe\",\n ...\n\t\t}\n\t\t...\n ],\n \"meta\": {\n \"dates\": [\n \"2023-05-04\"\n ],\n ...\n }\n}\n*/\n```\n\n## `.getBadges`\n\nGets all earned badges.\n\n```typescript\nconst badges = await client.getBadges();\nconsole.log(badges);\n\n/**\n{\n success: 1,\n data: [\n {\n id: 123,\n\t\t\tname: 'Big Badge',\n\t\t\t...\n },\n\t\t...\n ],\n meta: []\n}\n*/\n```\n\n## `.getAnnouncements`\n\nGets all announcements.\n\n```typescript\nconst announcements = await client.getAnnouncements();\nconsole.log(announcements);\n\n/**\n {\n success: 1,\n data: [\n {\n id: 321453,\n title: \"A big announcement\",\n description: \"School will be closing early today!
\",\n ...\n }\n ],\n meta: []\n}\n*/\n```\n\n## `.getDetentions`\n\n?> This method does not include `meta` in the response, since I do not have\naccess to this endpoint to test it. If you have access to this endpoint, please\nopen a PR to add the `meta` response. Thanks!\n\nGets all detentions.\n\n```typescript\nconst detentions = await client.getDetentions();\nconsole.log(detentions);\n\n/**\n {\n \"success\": 1,\n \"data\": [\n {\n \"id\": 12345678,\n \"attended\": \"no\",\n \"date\": \"2024-03-28T00:00:00+00:00\",\n ...\n }\n ],\n \"meta\": {\n \"detention_alias_plural\": \"detentions\"\n }\n}\n*/\n```\n\n## `.getAttendance`\n\n?> This method does not include `meta` in the response, since I do not have\naccess to this endpoint to test it. If you have access to this endpoint, please\nopen a PR to add the `meta` response. Thanks!\n\nGets attendance.\n\n```typescript\nconst attendance = await client.getAttendance();\nconsole.log(attendance);\n```\n\n# Parent Specific Methods\n\n## `.getPupils`\n\nGets a list of all pupils the parent has access to.\n\n```typescript\nconst pupils = await client.getPupils();\nconsole.log(pupils);\n/**\n[\n\t{\n\t\tid: 123,\n\t\tname: 'John Doe',\n\t\t...\n\t},\n\t...\n]\n*/\n```\n\n## `.selectPupil`\n\nSelects a pupil to make subsequent requests for.\n\n```typescript\nawait client.selectPupil(123);\n```\n\n## `.changePassword`\n\nChanges the parent's password.\n\n```typescript\nawait client.changePassword(\"oldPassword\", \"newPassword\");\n```\n","readmeFilename":"README.md"}