@easyedu/js-lsm-api 1.32.0 → 1.34.0

package/src/apis/ReportingApi.ts

@@ -103,9 +103,9 @@ export interface GetPortalStudentReportingRequest {
 export class ReportingApi extends runtime.BaseAPI {
 
     /**
-     * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
+     * Creates request options for getContentGradeDetail without sending the request
      */
-    async getContentGradeDetailRaw(requestParameters: GetContentGradeDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentGradeDetail>> {
+    async getContentGradeDetailRequestOpts(requestParameters: GetContentGradeDetailRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['courseId'] == null) {
             throw new runtime.RequiredError(
                 'courseId',
@@ -145,12 +145,20 @@ export class ReportingApi extends runtime.BaseAPI {
         urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
         urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get detailed grade information for a specific student and content (can use \'current\' for studentId)
+     */
+    async getContentGradeDetailRaw(requestParameters: GetContentGradeDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentGradeDetail>> {
+        const requestOptions = await this.getContentGradeDetailRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetContentGradeDetailFromJSON(jsonValue));
     }
@@ -164,9 +172,9 @@ export class ReportingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get grades for all students enrolled in course for specific content
+     * Creates request options for getContentGrades without sending the request
      */
-    async getContentGradesRaw(requestParameters: GetContentGradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentGrades>> {
+    async getContentGradesRequestOpts(requestParameters: GetContentGradesRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['courseId'] == null) {
             throw new runtime.RequiredError(
                 'courseId',
@@ -210,12 +218,20 @@ export class ReportingApi extends runtime.BaseAPI {
         urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
         urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get grades for all students enrolled in course for specific content
+     */
+    async getContentGradesRaw(requestParameters: GetContentGradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentGrades>> {
+        const requestOptions = await this.getContentGradesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetContentGradesFromJSON(jsonValue));
     }
@@ -229,9 +245,9 @@ export class ReportingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get basic instructor reporting for content
+     * Creates request options for getContentInstructorBasicReporting without sending the request
      */
-    async getContentInstructorBasicReportingRaw(requestParameters: GetContentInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentInstructorBasicReporting>> {
+    async getContentInstructorBasicReportingRequestOpts(requestParameters: GetContentInstructorBasicReportingRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['courseId'] == null) {
             throw new runtime.RequiredError(
                 'courseId',
@@ -263,12 +279,20 @@ export class ReportingApi extends runtime.BaseAPI {
         urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
         urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get basic instructor reporting for content
+     */
+    async getContentInstructorBasicReportingRaw(requestParameters: GetContentInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentInstructorBasicReporting>> {
+        const requestOptions = await this.getContentInstructorBasicReportingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetContentInstructorBasicReportingFromJSON(jsonValue));
     }
@@ -282,9 +306,9 @@ export class ReportingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get basic course reporting data for instructors
+     * Creates request options for getCourseInstructorReportingBasic without sending the request
      */
-    async getCourseInstructorReportingBasicRaw(requestParameters: GetCourseInstructorReportingBasicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseReportingBasic>> {
+    async getCourseInstructorReportingBasicRequestOpts(requestParameters: GetCourseInstructorReportingBasicRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['courseId'] == null) {
             throw new runtime.RequiredError(
                 'courseId',
@@ -300,12 +324,20 @@ export class ReportingApi extends runtime.BaseAPI {
         let urlPath = `/courses/{courseId}/reporting/instructor/basic`;
         urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get basic course reporting data for instructors
+     */
+    async getCourseInstructorReportingBasicRaw(requestParameters: GetCourseInstructorReportingBasicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseReportingBasic>> {
+        const requestOptions = await this.getCourseInstructorReportingBasicRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseReportingBasicFromJSON(jsonValue));
     }
@@ -319,9 +351,9 @@ export class ReportingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get student-specific reporting for a course (can use \'current\' for studentId)
+     * Creates request options for getCourseStudentReporting without sending the request
      */
-    async getCourseStudentReportingRaw(requestParameters: GetCourseStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseStudentReporting>> {
+    async getCourseStudentReportingRequestOpts(requestParameters: GetCourseStudentReportingRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['courseId'] == null) {
             throw new runtime.RequiredError(
                 'courseId',
@@ -345,12 +377,20 @@ export class ReportingApi extends runtime.BaseAPI {
         urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
         urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get student-specific reporting for a course (can use \'current\' for studentId)
+     */
+    async getCourseStudentReportingRaw(requestParameters: GetCourseStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseStudentReporting>> {
+        const requestOptions = await this.getCourseStudentReportingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseStudentReportingFromJSON(jsonValue));
     }
@@ -364,9 +404,9 @@ export class ReportingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get basic instructor reporting for a module
+     * Creates request options for getModuleInstructorBasicReporting without sending the request
      */
-    async getModuleInstructorBasicReportingRaw(requestParameters: GetModuleInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModuleInstructorBasicReporting>> {
+    async getModuleInstructorBasicReportingRequestOpts(requestParameters: GetModuleInstructorBasicReportingRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['courseId'] == null) {
             throw new runtime.RequiredError(
                 'courseId',
@@ -390,12 +430,20 @@ export class ReportingApi extends runtime.BaseAPI {
         urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
         urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get basic instructor reporting for a module
+     */
+    async getModuleInstructorBasicReportingRaw(requestParameters: GetModuleInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModuleInstructorBasicReporting>> {
+        const requestOptions = await this.getModuleInstructorBasicReportingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleInstructorBasicReportingFromJSON(jsonValue));
     }
@@ -409,9 +457,9 @@ export class ReportingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get student-specific reporting for a module (can use \'current\' for studentId)
+     * Creates request options for getModuleStudentReporting without sending the request
      */
-    async getModuleStudentReportingRaw(requestParameters: GetModuleStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModuleStudentReporting>> {
+    async getModuleStudentReportingRequestOpts(requestParameters: GetModuleStudentReportingRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['courseId'] == null) {
             throw new runtime.RequiredError(
                 'courseId',
@@ -443,12 +491,20 @@ export class ReportingApi extends runtime.BaseAPI {
         urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
         urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get student-specific reporting for a module (can use \'current\' for studentId)
+     */
+    async getModuleStudentReportingRaw(requestParameters: GetModuleStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModuleStudentReporting>> {
+        const requestOptions = await this.getModuleStudentReportingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleStudentReportingFromJSON(jsonValue));
     }
@@ -462,9 +518,9 @@ export class ReportingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get basic reporting for a portal (can use \'current\' for portalId)
+     * Creates request options for getPortalBasicReporting without sending the request
      */
-    async getPortalBasicReportingRaw(requestParameters: GetPortalBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalBasicReporting>> {
+    async getPortalBasicReportingRequestOpts(requestParameters: GetPortalBasicReportingRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['portalId'] == null) {
             throw new runtime.RequiredError(
                 'portalId',
@@ -480,12 +536,20 @@ export class ReportingApi extends runtime.BaseAPI {
         let urlPath = `/portals/{portalId}/reporting/basic`;
         urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get basic reporting for a portal (can use \'current\' for portalId)
+     */
+    async getPortalBasicReportingRaw(requestParameters: GetPortalBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalBasicReporting>> {
+        const requestOptions = await this.getPortalBasicReportingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalBasicReportingFromJSON(jsonValue));
     }
@@ -499,9 +563,9 @@ export class ReportingApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get student reporting for a portal (can use \'current\' for portalId and studentId)
+     * Creates request options for getPortalStudentReporting without sending the request
      */
-    async getPortalStudentReportingRaw(requestParameters: GetPortalStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalStudentReporting>> {
+    async getPortalStudentReportingRequestOpts(requestParameters: GetPortalStudentReportingRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['portalId'] == null) {
             throw new runtime.RequiredError(
                 'portalId',
@@ -525,12 +589,20 @@ export class ReportingApi extends runtime.BaseAPI {
         urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
         urlPath = urlPath.replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get student reporting for a portal (can use \'current\' for portalId and studentId)
+     */
+    async getPortalStudentReportingRaw(requestParameters: GetPortalStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalStudentReporting>> {
+        const requestOptions = await this.getPortalStudentReportingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalStudentReportingFromJSON(jsonValue));
     }