deno.land / x / gesso@v0.1.2 / src / Submissions.ts
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409import { BaseApi } from "./BaseApi.ts";import { Configuration } from "./Configuration.ts";import { Account, Progress, Scope, Submission, UserDisplay,} from "../types/models.ts";import { GetSingleSubmissionByAnonymousIdParams, GetSingleSubmissionParams, GradeOrCommentOnMultipleSubmissionsParams, GradeOrCommentOnSubmissionByAnonymousIdParams, GradeOrCommentOnSubmissionParams, ListAssignmentSubmissionsParams, ListMultipleAssignmentsGradeableStudentsParams, ListSubmissionsForMultipleAssignmentsParams, SubmissionSummaryParams, SubmitAnAssignmentParams,} from "../types/params.ts";
export class Submissions extends BaseApi { constructor(config: Configuration) { super(config); }
public async submitAnAssignment( course_id: string, assignment_id: string, params?: SubmitAnAssignmentParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions`; 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 listAssignmentSubmissions( course_id: string, assignment_id: string, params?: ListAssignmentSubmissionsParams, body?: unknown, ): Promise<Submission[]> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions`; 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 Submission[]; }
return Promise.reject(response); }
public async listSubmissionsForMultipleAssignments( course_id: string, params?: ListSubmissionsForMultipleAssignmentsParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/students/submissions`; 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 Scope; }
return Promise.reject(response); }
public async getSingleSubmission( course_id: string, assignment_id: string, user_id: string, params?: GetSingleSubmissionParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_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 Scope; }
return Promise.reject(response); }
public async getSingleSubmissionByAnonymousId( course_id: string, assignment_id: string, anonymous_id: string, params?: GetSingleSubmissionByAnonymousIdParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/anonymous_submissions/${anonymous_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 Scope; }
return Promise.reject(response); }
public async uploadFile( course_id: string, assignment_id: string, user_id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_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 gradeOrCommentOnSubmission( course_id: string, assignment_id: string, user_id: string, params?: GradeOrCommentOnSubmissionParams, body?: unknown, ): Promise<Account> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_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 Account; }
return Promise.reject(response); }
public async gradeOrCommentOnSubmissionByAnonymousId( course_id: string, assignment_id: string, anonymous_id: string, params?: GradeOrCommentOnSubmissionByAnonymousIdParams, body?: unknown, ): Promise<Account> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/anonymous_submissions/${anonymous_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 Account; }
return Promise.reject(response); }
public async listGradeableStudents( course_id: string, assignment_id: string, body?: unknown, ): Promise<UserDisplay[]> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/gradeable_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 UserDisplay[]; }
return Promise.reject(response); }
public async listMultipleAssignmentsGradeableStudents( course_id: string, params?: ListMultipleAssignmentsGradeableStudentsParams, body?: unknown, ): Promise<Scope[]> { const endpoint = `/api/v1/courses/${course_id}/assignments/gradeable_students`; 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 Scope[]; }
return Promise.reject(response); }
public async gradeOrCommentOnMultipleSubmissions( course_id: string, params?: GradeOrCommentOnMultipleSubmissionsParams, body?: unknown, ): Promise<Progress> { const endpoint = `/api/v1/courses/${course_id}/submissions/update_grades`; 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 Progress; }
return Promise.reject(response); }
public async markSubmissionAsRead( course_id: string, assignment_id: string, user_id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_id}/read`; 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 markSubmissionAsUnread( course_id: string, assignment_id: string, user_id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_id}/read`; 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 Scope; }
return Promise.reject(response); }
public async markSubmissionItemAsRead( course_id: string, assignment_id: string, user_id: string, item: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_id}/read/${item}`; 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 getRubricAssessmentsReadState( course_id: string, assignment_id: string, user_id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_id}/rubric_comments/read`; 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 markRubricAssessmentsAsRead( course_id: string, assignment_id: string, user_id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_id}/rubric_comments/read`; 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 getDocumentAnnotationsReadState( course_id: string, assignment_id: string, user_id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_id}/document_annotations/read`; 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 markDocumentAnnotationsAsRead( course_id: string, assignment_id: string, user_id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submissions/${user_id}/document_annotations/read`; 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 submissionSummary( course_id: string, assignment_id: string, params?: SubmissionSummaryParams, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/courses/${course_id}/assignments/${assignment_id}/submission_summary`; 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); }}
Version Info