delete course

README.md

@@ -12,8 +12,8 @@ API keys.
 - zstd
 
 ## How to build
-- Run `yarn`
-- Run `yarn build`
+- Run `npm install`
+- Run `npm run build`
 
 
 ## Authentication
@@ -525,6 +525,12 @@ Returns `Date` of archivation
 await codio.course.archive(<courseId>)
 ```
 
+#### Delete course
+
+```
+await codio.course.deleteCourse({id: <courseId>, removeOutdatedStudents: <boolean>})
+```
+
 #### Filter Learners For Mentors
 
 Specify mentors for LTI-base course

examples/course/deleteCourse.js

@@ -0,0 +1,13 @@
+const { codio, auth } = require('../auth.js')
+
+async function main() {
+  await auth
+  try {
+    await codio.course.deleteCourse({id: "your course id", removeOutdatedStudents: false})
+    console.log("Course deleted successfully.")
+  } catch (error) {
+    console.error("Error deleting course:", error)
+  }
+}
+
+main()

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codio-api-js",
-  "version": "0.18.0",
+  "version": "0.19.1",
   "description": "JS client to Codio API",
   "repository": {
     "type": "git",

src/lib/course.ts

@@ -636,6 +636,26 @@ export async function createModule(courseId: string, moduleName: string): Promis
   }
 }
 
+export type DeleteCourseRequest = {
+  id: string,
+  removeOutdatedStudents?: boolean
+}
+
+export async function deleteCourse(data: DeleteCourseRequest): Promise<void> {
+  const api = bent(getApiV1Url(), 'DELETE', 'json', 200)
+  try {
+    const paramString = data.removeOutdatedStudents ? `?removeOutdatedStudents=${data.removeOutdatedStudents}` : ''
+    await api(`/courses/${data.id}${paramString}`, data, getBearer())
+    return
+  } catch (error: any) {
+    if (error.json) {
+      const message = JSON.stringify(await error.json())
+      throw new Error(message)
+    }
+    throw error
+  }
+}
+
 export async function addTeacher(courseId: string, userId: string, readOnly = false): Promise<boolean> {
   const api = bent(getApiV1Url(), 'POST', 'json', 200)
   try {
@@ -685,7 +705,8 @@ const course = {
   filterLearnersForMentors,
   createCourse,
   createModule,
-  addTeacher
+  addTeacher,
+  deleteCourse
 }
 
 export default course