SDK package structure

SDK structure

The SDK is organized into two main sub-packages: client, and methods. The client package contains the RequestContext class as well as the helper methods used to make API calls to Canvas - get, put, post, and delete. The methods package is organized to resemble the Canvas REST API structure, with modules that correspond to the various resource endpoints. The list of API resources that Canvas provides can be found here. There is also a 'utils' module at the root of the sdk package that provides some useful functions like masquerading, retrieving all results for paged responses, and getting a result count.

For the most part, users are expected to interact with the API by making calls to one or more of the method module functions. The doc contains examples of making calls with some of these modules, including sections and enrollments.