Promise driven driver for Cavnas LMS Pages's REST API.

$ npm i https://github.com/redice44/canvas-lms-promise-pages.git

CANVAS_DOMAIN=YOUR_CANVAS_DOMAIN
CANVAS_TOKEN=YOUR_CANVAS_API_TOKEN

• page.create( courseId, page )
• page.del( courseId, page )
• page.frontPage( courseId )
• page.get( courseId, pageUrl )
• page.list( courseId, options )
• page.update( courseId, page )

• courseId <number>
• page <CanvasPageReq>
• return <Promise <CanvasPage> > The created page

• courseId <number>
• page <CanvasPageReq> or <string> The page to delete or url fragment to the page.
• return <Promise <CanvasPage> > The deleted page

• courseId <number>
• return <Promise <CanvasPage> > The front page

• courseId <number>
• pageUrl <string> The url fragment for the page
• return <Promise <CanvasPage> > The requested page

• courseId <number>
• options <ListOptions>
• return <Promise <Array <CanvasPage> > >

• courseId <number>
• page <CanvasPage> The page to update.
• return <Promise <CanvasPage> >

• url <string> URL fragment for the page
• title <string> Title of the page
• created_at <string>
• updated_at <string>
• editing_roles <string>
• last_edited_by <Object>(Optional)
  • id <number>
  • display_name <string>
  • avatar_image_url <string>
  • html_url <string>
• body <string> HTML body of the page
• published <boolean>
• front_page <boolean>
• locked_for_user <boolean>
• lock_info (Optional) <string>
• lock_explanation (Optional) <string>

• title <string> Title of the page
• body (Optional) <string> HTML body of the page
• editing_roles (Optional) <string>
• notify_of_update (Optional) <boolean>
• published (Optional) <boolean>
• front_page (Optional) <boolean>

• per_page <number> number of results to return
• sort title | created_at | updated_at
• order asc | dec
• search_term <string>
• published <boolean>