canvas-client - npm Package Compare versions

Comparing version 1.3.2 to 1.3.3

lib-esm/canvas.d.ts

@@ -1,2 +0,2 @@
-import { CanvasAccount, CanvasCourse, CanvasSection, CanvasEnrollment, CanvasEnrollmentPayload, CanvasCoursePayload, CanvasSectionPayload, CanvasGradingStandard, CanvasID, SpecialUserID, SpecialSectionID, SISSectionID, SISUserID, SpecialCourseID, SISTermID, SpecialTermID, CanvasEnrollmentTerm, CanvasCourseParams, CanvasEnrollmentParams, CanvasCourseSettings, CanvasCourseSettingsUpdate, CanvasUserUpdatePayload, CanvasCourseListFilters, CanvasEnrollmentTermPayload, CanvasEnrollmentTermParams } from './interfaces';
+import { CanvasAccount, CanvasCourse, CanvasSection, CanvasEnrollment, CanvasEnrollmentPayload, CanvasCoursePayload, CanvasSectionPayload, CanvasGradingStandard, CanvasID, SpecialUserID, SpecialSectionID, SISSectionID, SISUserID, SpecialCourseID, SISTermID, SpecialTermID, CanvasEnrollmentTerm, CanvasCourseParams, CanvasEnrollmentParams, CanvasCourseSettings, CanvasCourseSettingsUpdate, CanvasUserUpdatePayload, CanvasCourseListFilters, CanvasEnrollmentTermPayload, CanvasEnrollmentTermParams, CanvasCourseUsersParams } from './interfaces';
 import { ExternalTool, ExternalToolPayload } from './interfaces/externaltool';
@@ -45,2 +45,3 @@ export declare class CanvasConnector {
     concludeCourse(courseId: CanvasID): Promise<any>;
+    getCourseUsers(courseId: CanvasID, params?: CanvasCourseUsersParams): Promise<any[]>;
     getGradingStandards(accountId?: CanvasID): Promise<CanvasGradingStandard[]>;
@@ -47,0 +48,0 @@ courseSections(courseId?: CanvasID): Promise<CanvasSection[]>;

lib-esm/canvas.js

@@ -178,2 +178,5 @@ import { HttpsAgent } from 'agentkeepalive';
     }
+    async getCourseUsers(courseId, params) {
+        return await this.getall(`/api/v1/courses/${courseId}/users`, params);
+    }
     // GRADING STANDARDS
@@ -180,0 +183,0 @@ async getGradingStandards(accountId) {

lib-esm/interfaces/course.d.ts

@@ -146,2 +146,11 @@ import { CanvasEnrollmentShortType, SpecialTermID, CanvasID, SISCourseID, UserDisplay, CanvasEnrollmentDisplay } from '.';
 }
+export interface CanvasCourseUsersParams {
+    search_term?: string;
+    sort?: 'username' | 'last_login' | 'email' | 'sis_id';
+    enrollment_role_id?: number | string;
+    enrollment_type?: CanvasEnrollmentShortType[];
+    include?: ('enrollments' | 'locked' | 'avatar_url' | 'bio' | 'test_student' | 'custom_links' | 'current_grading_period_scores' | 'uuid')[];
+    user_ids?: (string | number)[];
+    enrollment_state?: ('active' | 'invited' | 'rejected' | 'completed' | 'inactive')[];
+}
 export {};

lib/canvas.d.ts

@@ -1,2 +0,2 @@
-import { CanvasAccount, CanvasCourse, CanvasSection, CanvasEnrollment, CanvasEnrollmentPayload, CanvasCoursePayload, CanvasSectionPayload, CanvasGradingStandard, CanvasID, SpecialUserID, SpecialSectionID, SISSectionID, SISUserID, SpecialCourseID, SISTermID, SpecialTermID, CanvasEnrollmentTerm, CanvasCourseParams, CanvasEnrollmentParams, CanvasCourseSettings, CanvasCourseSettingsUpdate, CanvasUserUpdatePayload, CanvasCourseListFilters, CanvasEnrollmentTermPayload, CanvasEnrollmentTermParams } from './interfaces';
+import { CanvasAccount, CanvasCourse, CanvasSection, CanvasEnrollment, CanvasEnrollmentPayload, CanvasCoursePayload, CanvasSectionPayload, CanvasGradingStandard, CanvasID, SpecialUserID, SpecialSectionID, SISSectionID, SISUserID, SpecialCourseID, SISTermID, SpecialTermID, CanvasEnrollmentTerm, CanvasCourseParams, CanvasEnrollmentParams, CanvasCourseSettings, CanvasCourseSettingsUpdate, CanvasUserUpdatePayload, CanvasCourseListFilters, CanvasEnrollmentTermPayload, CanvasEnrollmentTermParams, CanvasCourseUsersParams } from './interfaces';
 import { ExternalTool, ExternalToolPayload } from './interfaces/externaltool';
@@ -45,2 +45,3 @@ export declare class CanvasConnector {
     concludeCourse(courseId: CanvasID): Promise<any>;
+    getCourseUsers(courseId: CanvasID, params?: CanvasCourseUsersParams): Promise<any[]>;
     getGradingStandards(accountId?: CanvasID): Promise<CanvasGradingStandard[]>;
@@ -47,0 +48,0 @@ courseSections(courseId?: CanvasID): Promise<CanvasSection[]>;

lib/canvas.js

@@ -185,2 +185,5 @@ "use strict";
     }
+    async getCourseUsers(courseId, params) {
+        return await this.getall(`/api/v1/courses/${courseId}/users`, params);
+    }
     // GRADING STANDARDS
@@ -187,0 +190,0 @@ async getGradingStandards(accountId) {

lib/interfaces/course.d.ts

@@ -146,2 +146,11 @@ import { CanvasEnrollmentShortType, SpecialTermID, CanvasID, SISCourseID, UserDisplay, CanvasEnrollmentDisplay } from '.';
 }
+export interface CanvasCourseUsersParams {
+    search_term?: string;
+    sort?: 'username' | 'last_login' | 'email' | 'sis_id';
+    enrollment_role_id?: number | string;
+    enrollment_type?: CanvasEnrollmentShortType[];
+    include?: ('enrollments' | 'locked' | 'avatar_url' | 'bio' | 'test_student' | 'custom_links' | 'current_grading_period_scores' | 'uuid')[];
+    user_ids?: (string | number)[];
+    enrollment_state?: ('active' | 'invited' | 'rejected' | 'completed' | 'inactive')[];
+}
 export {};

package.json

 {
   "name": "canvas-client",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "Typescript library to make accessing the Canvas API more convenient.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

No alert changes

Improved metrics

Total package byte prevSize

101320

increased by1.48%

Lines of code

2311

increased by1.14%

No dependency changes