@iblai/iblai-api 3.48.3-core → 3.48.4-core

package/src/services/OverviewService.ts

@@ -28,25 +28,41 @@ export class OverviewService {
      * Default time range is the last 7 days if no dates are specified.
      *
      * An active user is defined as a user with any activity within the past 30 days.
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OvertimeWithChangeInfo
      * @throws ApiError
      */
-    public static overviewOrgsActiveUsersRetrieve(
+    public static overviewOrgsActiveUsersRetrieve({
+        org,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         org: string,
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
         departmentId?: number,
+        /**
+         * end date. ISO 8601
+         */
         endDate?: string,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OvertimeWithChangeInfo> {
+    }): CancelablePromise<OvertimeWithChangeInfo> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/overview/orgs/{org}/active-users',
@@ -81,21 +97,31 @@ export class OverviewService {
      * Access Control:
      * - Platform admins can access any grade data
      * - Learners can access their own grade data
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns Average
      * @throws ApiError
      */
-    public static overviewOrgsAverageGradeRetrieve(
+    public static overviewOrgsAverageGradeRetrieve({
+        org,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+    }: {
         org: string,
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
         departmentId?: number,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<Average> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<Average> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/overview/orgs/{org}/average-grade',
@@ -128,25 +154,41 @@ export class OverviewService {
      * - Change metrics compared to previous periods
      *
      * Default time range is the last 7 days if no dates are specified.
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns CourseCompletionSummaryOvertime
      * @throws ApiError
      */
-    public static overviewOrgsCoursesCompletionsRetrieve(
+    public static overviewOrgsCoursesCompletionsRetrieve({
+        org,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         org: string,
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
         departmentId?: number,
+        /**
+         * end date. ISO 8601
+         */
         endDate?: string,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<CourseCompletionSummaryOvertime> {
+    }): CancelablePromise<CourseCompletionSummaryOvertime> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/overview/orgs/{org}/courses/completions',
@@ -177,27 +219,46 @@ export class OverviewService {
      *
      * Returns:
      * A paginated list of learners with their associated metrics.
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param length Size of data to return
-     * @param page Page offset
-     * @param search Search string for learner
      * @returns PerlearnerUserList
      * @throws ApiError
      */
-    public static overviewOrgsLearnersRetrieve(
+    public static overviewOrgsLearnersRetrieve({
+        org,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+        length,
+        page,
+        search,
+    }: {
         org: string,
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
         departmentId?: number,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * Size of data to return
+         */
         length?: number,
+        /**
+         * Page offset
+         */
         page?: number,
+        /**
+         * Search string for learner
+         */
         search?: string,
-    ): CancelablePromise<PerlearnerUserList> {
+    }): CancelablePromise<PerlearnerUserList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/overview/orgs/{org}/learners',
@@ -232,29 +293,51 @@ export class OverviewService {
      * - Total time spent (in seconds)
      * - Formatted time spent (human-readable)
      * - Percentage of total platform time
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param length Size of data to return
-     * @param page Page offset
-     * @param startDate start date. ISO 8601
      * @returns TimeSpentPerCourse
      * @throws ApiError
      */
-    public static overviewOrgsMostActiveCoursesRetrieve(
+    public static overviewOrgsMostActiveCoursesRetrieve({
+        org,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        length,
+        page,
+        startDate,
+    }: {
         org: string,
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
         departmentId?: number,
+        /**
+         * end date. ISO 8601
+         */
         endDate?: string,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * Size of data to return
+         */
         length?: number,
+        /**
+         * Page offset
+         */
         page?: number,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<TimeSpentPerCourse> {
+    }): CancelablePromise<TimeSpentPerCourse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/overview/orgs/{org}/most-active-courses',
@@ -287,25 +370,41 @@ export class OverviewService {
      * compared to previous periods.
      *
      * Default time range is the last 7 days if no dates are specified.
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OvertimeWithChangeInfo
      * @throws ApiError
      */
-    public static overviewOrgsRegisteredUsersRetrieve(
+    public static overviewOrgsRegisteredUsersRetrieve({
+        org,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         org: string,
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
         departmentId?: number,
+        /**
+         * end date. ISO 8601
+         */
         endDate?: string,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OvertimeWithChangeInfo> {
+    }): CancelablePromise<OvertimeWithChangeInfo> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/overview/orgs/{org}/registered-users',

package/src/services/PerformanceService.ts

@@ -31,23 +31,33 @@ export class PerformanceService {
      * Access Control:
      * - Platform admins can access any grade data
      * - Learners can access their own grade data
-     * @param courseId
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns Average
      * @throws ApiError
      */
-    public static performanceOrgsCoursesGradingAverageRetrieve(
+    public static performanceOrgsCoursesGradingAverageRetrieve({
+        courseId,
+        org,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+    }: {
         courseId: string,
         org: string,
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
         departmentId?: number,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<Average> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<Average> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/performance/orgs/{org}/courses/{course_id}/grading/average',
@@ -81,23 +91,33 @@ export class PerformanceService {
                  *
                  * Kwargs
                  * course_id
-                 * @param courseId
-                 * @param org
-                 * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-                 * @param format Format
-                 *
-                 * * `json` - json
-                 * @param includeMainPlatform Include main platform data
                  * @returns AvgCourseGradeWithCutoff
                  * @throws ApiError
                  */
-                public static performanceOrgsCoursesGradingAverageWithCutoffRetrieve(
+                public static performanceOrgsCoursesGradingAverageWithCutoffRetrieve({
+                    courseId,
+                    org,
+                    departmentId,
+                    format = 'json',
+                    includeMainPlatform = true,
+                }: {
                     courseId: string,
                     org: string,
+                    /**
+                     * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+                     */
                     departmentId?: number,
-                    format: 'json' = 'json',
-                    includeMainPlatform: boolean = true,
-                ): CancelablePromise<AvgCourseGradeWithCutoff> {
+                    /**
+                     * Format
+                     *
+                     * * `json` - json
+                     */
+                    format?: 'json',
+                    /**
+                     * Include main platform data
+                     */
+                    includeMainPlatform?: boolean,
+                }): CancelablePromise<AvgCourseGradeWithCutoff> {
                     return __request(OpenAPI, {
                         method: 'GET',
                         url: '/api/performance/orgs/{org}/courses/{course_id}/grading/average-with-cutoff',
@@ -117,23 +137,33 @@ export class PerformanceService {
                  *
                  * Kwargs
                  * course_id <required>
-                 * @param courseId
-                 * @param org
-                 * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-                 * @param format Format
-                 *
-                 * * `json` - json
-                 * @param includeMainPlatform Include main platform data
                  * @returns CourseGradingDetail
                  * @throws ApiError
                  */
-                public static performanceOrgsCoursesGradingDetailRetrieve(
+                public static performanceOrgsCoursesGradingDetailRetrieve({
+                    courseId,
+                    org,
+                    departmentId,
+                    format = 'json',
+                    includeMainPlatform = true,
+                }: {
                     courseId: string,
                     org: string,
+                    /**
+                     * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+                     */
                     departmentId?: number,
-                    format: 'json' = 'json',
-                    includeMainPlatform: boolean = true,
-                ): CancelablePromise<CourseGradingDetail> {
+                    /**
+                     * Format
+                     *
+                     * * `json` - json
+                     */
+                    format?: 'json',
+                    /**
+                     * Include main platform data
+                     */
+                    includeMainPlatform?: boolean,
+                }): CancelablePromise<CourseGradingDetail> {
                     return __request(OpenAPI, {
                         method: 'GET',
                         url: '/api/performance/orgs/{org}/courses/{course_id}/grading/detail',
@@ -153,23 +183,33 @@ export class PerformanceService {
                  *
                  * Kwargs
                  * course_id <required>
-                 * @param courseId
-                 * @param org
-                 * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-                 * @param format Format
-                 *
-                 * * `json` - json
-                 * @param includeMainPlatform Include main platform data
                  * @returns GradingPerUser
                  * @throws ApiError
                  */
-                public static performanceOrgsCoursesGradingPerLearnerRetrieve(
+                public static performanceOrgsCoursesGradingPerLearnerRetrieve({
+                    courseId,
+                    org,
+                    departmentId,
+                    format = 'json',
+                    includeMainPlatform = true,
+                }: {
                     courseId: string,
                     org: string,
+                    /**
+                     * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+                     */
                     departmentId?: number,
-                    format: 'json' = 'json',
-                    includeMainPlatform: boolean = true,
-                ): CancelablePromise<GradingPerUser> {
+                    /**
+                     * Format
+                     *
+                     * * `json` - json
+                     */
+                    format?: 'json',
+                    /**
+                     * Include main platform data
+                     */
+                    includeMainPlatform?: boolean,
+                }): CancelablePromise<GradingPerUser> {
                     return __request(OpenAPI, {
                         method: 'GET',
                         url: '/api/performance/orgs/{org}/courses/{course_id}/grading/per-learner',
@@ -202,23 +242,33 @@ export class PerformanceService {
                              * }, ...
                              * ]
                              * }
-                             * @param courseId
-                             * @param org
-                             * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-                             * @param format Format
-                             *
-                             * * `json` - json
-                             * @param includeMainPlatform Include main platform data
                              * @returns CourseGradeSummary
                              * @throws ApiError
                              */
-                            public static performanceOrgsCoursesGradingSummaryRetrieve(
+                            public static performanceOrgsCoursesGradingSummaryRetrieve({
+                                courseId,
+                                org,
+                                departmentId,
+                                format = 'json',
+                                includeMainPlatform = true,
+                            }: {
                                 courseId: string,
                                 org: string,
+                                /**
+                                 * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+                                 */
                                 departmentId?: number,
-                                format: 'json' = 'json',
-                                includeMainPlatform: boolean = true,
-                            ): CancelablePromise<CourseGradeSummary> {
+                                /**
+                                 * Format
+                                 *
+                                 * * `json` - json
+                                 */
+                                format?: 'json',
+                                /**
+                                 * Include main platform data
+                                 */
+                                includeMainPlatform?: boolean,
+                            }): CancelablePromise<CourseGradeSummary> {
                                 return __request(OpenAPI, {
                                     method: 'GET',
                                     url: '/api/performance/orgs/{org}/courses/{course_id}/grading/summary',
@@ -252,21 +302,31 @@ export class PerformanceService {
                              * Access Control:
                              * - Platform admins can access any grade data
                              * - Learners can access their own grade data
-                             * @param org
-                             * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-                             * @param format Format
-                             *
-                             * * `json` - json
-                             * @param includeMainPlatform Include main platform data
                              * @returns Average
                              * @throws ApiError
                              */
-                            public static performanceOrgsGradingAverageRetrieve(
+                            public static performanceOrgsGradingAverageRetrieve({
+                                org,
+                                departmentId,
+                                format = 'json',
+                                includeMainPlatform = true,
+                            }: {
                                 org: string,
+                                /**
+                                 * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+                                 */
                                 departmentId?: number,
-                                format: 'json' = 'json',
-                                includeMainPlatform: boolean = true,
-                            ): CancelablePromise<Average> {
+                                /**
+                                 * Format
+                                 *
+                                 * * `json` - json
+                                 */
+                                format?: 'json',
+                                /**
+                                 * Include main platform data
+                                 */
+                                includeMainPlatform?: boolean,
+                            }): CancelablePromise<Average> {
                                 return __request(OpenAPI, {
                                     method: 'GET',
                                     url: '/api/performance/orgs/{org}/grading/average',
@@ -292,25 +352,41 @@ export class PerformanceService {
                              * - Enrollment count
                              * - Number of students who passed
                              * - Average grade
-                             * @param org
-                             * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-                             * @param format Format
-                             *
-                             * * `json` - json
-                             * @param includeMainPlatform Include main platform data
-                             * @param length Size of data to return
-                             * @param page Page offset
                              * @returns PerformanceGradesPerCourse
                              * @throws ApiError
                              */
-                            public static performanceOrgsGradingPerCourseRetrieve(
+                            public static performanceOrgsGradingPerCourseRetrieve({
+                                org,
+                                departmentId,
+                                format = 'json',
+                                includeMainPlatform = true,
+                                length,
+                                page,
+                            }: {
                                 org: string,
+                                /**
+                                 * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+                                 */
                                 departmentId?: number,
-                                format: 'json' = 'json',
-                                includeMainPlatform: boolean = true,
+                                /**
+                                 * Format
+                                 *
+                                 * * `json` - json
+                                 */
+                                format?: 'json',
+                                /**
+                                 * Include main platform data
+                                 */
+                                includeMainPlatform?: boolean,
+                                /**
+                                 * Size of data to return
+                                 */
                                 length?: number,
+                                /**
+                                 * Page offset
+                                 */
                                 page?: number,
-                            ): CancelablePromise<PerformanceGradesPerCourse> {
+                            }): CancelablePromise<PerformanceGradesPerCourse> {
                                 return __request(OpenAPI, {
                                     method: 'GET',
                                     url: '/api/performance/orgs/{org}/grading/per-course',