canvas-api-ts/dist/wrapper/course.d.ts

Strongly typed canvas lms api

import * as C from '../api/courseAPITypes';
import { Match } from '../request/requestBuidler';
import { Permission } from '../api/permissionTypes';
export declare function createCourse(accountId: Match<C.CreateNewCourse, "uriParams">, courseInfo: Match<C.CreateNewCourse, "param">): Promise<import("../api/responseTypes").Course>;
export declare function getCourse(courseId: Match<C.GetACourse, "uriParams">["id"], includes: Match<C.GetACourse, "param">["include"], teacherLimit?: number): Promise<import("../api/responseTypes").Course>;
export declare function getCourses(param: Match<C.ListMyCourses, "param">): Promise<import("../api/responseTypes").Course[]>;
export declare function getCoursesByUser(userId: number | "self", param: Match<C.ListCoursesByAUser, "param">): Promise<import("../api/responseTypes").Course[]>;
export declare function getCourseByUser(userId: Match<C.ListCoursesByAUser, "uriParams">["user_id"], config: Match<C.ListCoursesByAUser, "param">): Promise<import("../api/responseTypes").Course[]>;
export declare function getUsersInCourse(courseId: Match<C.ListUserInCourse, "uriParams">["course_id"], config: Match<C.ListUserInCourse, "param">): Promise<import("../api/responseTypes").User[]>;
export declare function getStudentsInCourse(courseId: Match<C.ListStudents, "uriParams">["course_id"]): Promise<import("../api/responseTypes").User[]>;
export declare function getCourseEffectiveDueDates(courseId: Match<C.GetEffectiveDueDates, "uriParams">["course_id"], config: Match<C.GetEffectiveDueDates, "param">): Promise<{
    [assignment_id: string]: {
        [student_id: string]: {
            due_at: string;
            grading_period_id?: number | undefined;
            in_closed_grading_period: boolean;
        };
    };
}>;
export declare function getCoursePermission(courseId: Match<C.GetPermission, "uriParams">["course_id"], permissions: Permission[]): Promise<{
    [permissions: string]: string;
}>;