deno.land / x / gesso@v0.1.2 / src / Courses.ts
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520import { BaseApi } from "./BaseApi.ts";import { Configuration } from "./Configuration.ts";import { Account, Course, CourseProgress, Progress, Scope, User,} from "../types/models.ts";import { CopyCourseContentParams, CreateNewCourseParams, DeleteCourseParams, GetEffectiveDueDatesParams, GetSingleCourseParams, ListCoursesForUserParams, ListCoursesParams, ListUsersInCourseParams, PermissionsParams, PreviewProcessedHtmlParams, SearchForContentShareUsersParams, UpdateCourseParams, UpdateCourseSettingsParams, UpdateCoursesParams,} from "../types/params.ts";
export class Courses extends BaseApi { constructor(config: Configuration) { super(config); }
public async listCourses( params?: ListCoursesParams, body?: unknown, ): Promise<Course[]> { const endpoint = "/api/v1/courses"; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Course[]; }
return Promise.reject(response); }
public async listCoursesForUser( user_id: string, params?: ListCoursesForUserParams, body?: unknown, ): Promise<Course[]> { const endpoint = `/api/v1/users/${user_id}/courses`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Course[]; }
return Promise.reject(response); }
public async getUserProgress( course_id: string, user_id: string, body?: unknown, ): Promise<CourseProgress> { const endpoint = `/api/v1/courses/${course_id}/users/${user_id}/progress`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as CourseProgress; }
return Promise.reject(response); }
public async createNewCourse( account_id: string, params?: CreateNewCourseParams, body?: unknown, ): Promise<Course> { const endpoint = `/api/v1/accounts/${account_id}/courses`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Course; }
return Promise.reject(response); }
public async uploadFile(course_id: string, body?: unknown): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/files`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async listStudents( course_id: string, body?: unknown, ): Promise<User[]> { const endpoint = `/api/v1/courses/${course_id}/students`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User[]; }
return Promise.reject(response); }
public async listUsersInCourse( course_id: string, params?: ListUsersInCourseParams, body?: unknown, ): Promise<User[]> { const endpoint = `/api/v1/courses/${course_id}/users`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User[]; }
return Promise.reject(response); }
public async listRecentlyLoggedInStudents( course_id: string, body?: unknown, ): Promise<User[]> { const endpoint = `/api/v1/courses/${course_id}/recent_students`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User[]; }
return Promise.reject(response); }
public async getSingleUser( course_id: string, id: string, body?: unknown, ): Promise<User> { const endpoint = `/api/v1/courses/${course_id}/users/${id}`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User; }
return Promise.reject(response); }
public async searchForContentShareUsers( course_id: string, params?: SearchForContentShareUsersParams, body?: unknown, ): Promise<User[]> { const endpoint = `/api/v1/courses/${course_id}/content_share_users`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User[]; }
return Promise.reject(response); }
public async previewProcessedHtml( course_id: string, params?: PreviewProcessedHtmlParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/preview_html`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async courseActivityStream( course_id: string, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/courses/${course_id}/activity_stream`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async courseActivityStreamSummary( course_id: string, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/courses/${course_id}/activity_stream/summary`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async courseTodoItems( course_id: string, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/courses/${course_id}/todo`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async deleteCourse( id: string, params?: DeleteCourseParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${id}`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.delete(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async getCourseSettings( course_id: string, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/courses/${course_id}/settings`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async updateCourseSettings( course_id: string, params?: UpdateCourseSettingsParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/settings`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async returnTestStudentForCourse( course_id: string, body?: unknown, ): Promise<User> { const endpoint = `/api/v1/courses/${course_id}/student_view_student`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User; }
return Promise.reject(response); }
public async getSingleCourse( id: string, params?: GetSingleCourseParams, body?: unknown, ): Promise<Course> { const endpoint = `/api/v1/courses/${id}`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Course; }
return Promise.reject(response); }
public async updateCourse( id: string, params?: UpdateCourseParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${id}`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async updateCourses( account_id: string, params?: UpdateCoursesParams, body?: unknown, ): Promise<Progress> { const endpoint = `/api/v1/accounts/${account_id}/courses`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Progress; }
return Promise.reject(response); }
public async resetCourse(course_id: string, body?: unknown): Promise<Course> { const endpoint = `/api/v1/courses/${course_id}/reset_content`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Course; }
return Promise.reject(response); }
public async getEffectiveDueDates( course_id: string, params?: GetEffectiveDueDatesParams, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/courses/${course_id}/effective_due_dates`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async permissions( course_id: string, params?: PermissionsParams, body?: unknown, ): Promise<Account> { const endpoint = `/api/v1/courses/${course_id}/permissions`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Account; }
return Promise.reject(response); }
public async getBulkUserProgress( course_id: string, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/courses/${course_id}/bulk_user_progress`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async removeQuizMigrationAlert( id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${id}/dismiss_migration_limitation_message`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async getCourseCopyStatus( course_id: string, id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/course_copy/${id}`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async copyCourseContent( course_id: string, params?: CopyCourseContentParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/course_copy`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }}
Version Info