qus-canvas/src/courses/dtos/course.interface.ts

client api for canvas

/*
 * MIT License
 * 
 * Copyright (c) 2024 Quantum Unit Solutions
 * Author: David Meikle
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

export interface CourseInterface {
    id: string; // Local GUID
    name: string;
    accountId: number;
    remoteUuid: string;
    startAt: string | null;
    gradingStandardId: number | null;
    isPublic: boolean | null;
    remoteCreatedAt: string;
    courseCode: string;
    defaultView: string;
    rootAccountId: number;
    enrollmentTermId: number;
    license: string | null;
    gradePassbackSetting: string | null;
    endAt: string | null;
    publicSyllabus: boolean;
    publicSyllabusToAuth: boolean;
    storageQuotaMb: number;
    isPublicToAuthUsers: boolean;
    homeroomCourse: boolean;
    courseColor: string | null;
    friendlyName: string | null;
    applyAssignmentGroupWeights: boolean;
    calendar: {
        ics: string;
    };
    timeZone: string;
    blueprint: boolean;
    template: boolean;
    sisCourseId: string;
    sisImportId: number;
    integrationId: string | null;
    hideFinalGrades: boolean;
    workflowState: string;
    restrictEnrollmentsToCourseDates: boolean;
    courseNumber: number;
}