other

Source:
Functions for other endpoints

Methods

endpoint(opts, configopt) → {Promise.<any>}

Source:
Author:
  • Gabe Abrams
Send a request to a Canvas endpoint that's not in this library. Note: use this sparingly. Instead, please request that we add the endpoint to caccl.
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
path string the path of the endpoint to call (e.g. /api/v1/courses), just the path: not the host or protocol
method string <optional>
 GET the http method to use
params object <optional>
 {} the get query params or the post/put/delete body params
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
body of Canvas response
Type
Promise.<any>