deno.land / x / gesso@v0.1.2 / src / Modules.ts
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321import { BaseApi } from "./BaseApi.ts";import { Configuration } from "./Configuration.ts";import { Assignment, Module, Scope } from "../types/models.ts";import { CreateModuleItemParams, CreateModuleParams, GetModuleItemSequenceParams, ListModuleItemsParams, ListModulesParams, SelectMasteryPathParams, ShowModuleItemParams, ShowModuleParams, UpdateModuleItemParams, UpdateModuleParams,} from "../types/params.ts";
export class Modules extends BaseApi { constructor(config: Configuration) { super(config); }
public async listModules( course_id: string, params?: ListModulesParams, body?: unknown, ): Promise<Module[]> { const endpoint = `/api/v1/courses/${course_id}/modules`; 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 Module[]; }
return Promise.reject(response); }
public async showModule( course_id: string, id: string, params?: ShowModuleParams, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/modules/${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 Module; }
return Promise.reject(response); }
public async createModule( course_id: string, params?: CreateModuleParams, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/modules`; 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 Module; }
return Promise.reject(response); }
public async updateModule( course_id: string, id: string, params?: UpdateModuleParams, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/modules/${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 Module; }
return Promise.reject(response); }
public async deleteModule( course_id: string, id: string, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/modules/${id}`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.delete(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Module; }
return Promise.reject(response); }
public async relockModuleProgressions( course_id: string, id: string, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/modules/${id}/relock`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Module; }
return Promise.reject(response); }
public async listModuleItems( course_id: string, module_id: string, params?: ListModuleItemsParams, body?: unknown, ): Promise<Module[]> { const endpoint = `/api/v1/courses/${course_id}/modules/${module_id}/items`; 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 Module[]; }
return Promise.reject(response); }
public async showModuleItem( course_id: string, module_id: string, id: string, params?: ShowModuleItemParams, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/modules/${module_id}/items/${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 Module; }
return Promise.reject(response); }
public async createModuleItem( course_id: string, module_id: string, params?: CreateModuleItemParams, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/modules/${module_id}/items`; 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 Module; }
return Promise.reject(response); }
public async updateModuleItem( course_id: string, module_id: string, id: string, params?: UpdateModuleItemParams, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/modules/${module_id}/items/${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 Module; }
return Promise.reject(response); }
public async selectMasteryPath( course_id: string, module_id: string, id: string, params?: SelectMasteryPathParams, body?: unknown, ): Promise<Assignment> { const endpoint = `/api/v1/courses/${course_id}/modules/${module_id}/items/${id}/select_mastery_path`; 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 Assignment; }
return Promise.reject(response); }
public async deleteModuleItem( course_id: string, module_id: string, id: string, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/modules/${module_id}/items/${id}`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.delete(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Module; }
return Promise.reject(response); }
public async markModuleItemAsDoneDone( course_id: string, module_id: string, id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/modules/${module_id}/items/${id}/done`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async getModuleItemSequence( course_id: string, params?: GetModuleItemSequenceParams, body?: unknown, ): Promise<Module> { const endpoint = `/api/v1/courses/${course_id}/module_item_sequence`; 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 Module; }
return Promise.reject(response); }
public async markModuleItemRead( course_id: string, module_id: string, id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/modules/${module_id}/items/${id}/mark_read`; 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); }}
Version Info