Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

caccl-api

harvard-edtech1.6kMIT2.3.3TypeScript support: included

A class that defines a set of smart Canvas endpoints that actually behave how you'd expect them to.

Canvas, API, endpoints, smart, CACCL

readme

caccl-api

A class that defines a set of Canvas endpoints that can be easily accessed. Each endpoint is equipped with the appropriate pre- and post-processing steps to make the Canvas endpoints "behave". For instance, getSubmissions() fetches student submissions and removes the test student's submission in post-processing.

Quickstart and Documentation

Visit the caccl-api docs for quickstart guides and docs.

Part of the CACCL library

C*anvas
*
A
pp
C*omplete
*
C
onnection
Library

Special Thanks

Special thanks to Yuen Ler Chow for his great work on various endpoints, specifically the course content migration endpoint.

changelog

Changelog

All notable changes to this project will be documented in this file.

[1.0.62] - 06/26/20

Added graphQL request support.

[1.0.56] - 04/01/20

Added new docs, account.listCourses and account.enrollmentTerm functions.

[1.0.53] - 12/19/19

Added information on scopes.

[1.0.45] - 10/22/19

Added support for using non-overridden dates for assignments.

[1.0.44] - 10/15/19

Added support for listing students in sections

[1.0.42] - 09/28/19

Added support for authenticity tokens (for requests sent directly from Canvas pages)

[1.0.39] - 09/27/19

Fixed batch Gradebook Column entry update endpoint.

[1.0.36] - 09/03/19

Added ability to use an LTI as an assignment submission type

[1.0.22] - 04/20/19

Added

  • Ability to call other endpoints via api.other.endpoint

Changed

  • Updated docs to include a table of contents for the list of endpoints