@iblai/iblai-api 3.48.3-ai-plus → 3.48.4-ai

package/dist/types/services/OverviewService.d.ts

@@ -22,18 +22,34 @@ export declare 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
      */
-    static overviewOrgsActiveUsersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    static overviewOrgsActiveUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, 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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OvertimeWithChangeInfo>;
     /**
      * Get average grade value for platform, course, or user.
      *
@@ -53,16 +69,26 @@ export declare 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
      */
-    static overviewOrgsAverageGradeRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
+    static overviewOrgsAverageGradeRetrieve({ org, departmentId, format, includeMainPlatform, }: {
+        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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<Average>;
     /**
      * Get course completion summary metrics over time.
      *
@@ -82,18 +108,34 @@ export declare 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
      */
-    static overviewOrgsCoursesCompletionsRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<CourseCompletionSummaryOvertime>;
+    static overviewOrgsCoursesCompletionsRetrieve({ org, departmentId, endDate, format, includeMainPlatform, 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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<CourseCompletionSummaryOvertime>;
     /**
      * List all learners on the platform with aggregated metrics.
      *
@@ -109,19 +151,38 @@ export declare 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
      */
-    static overviewOrgsLearnersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, search?: string): CancelablePromise<PerlearnerUserList>;
+    static overviewOrgsLearnersRetrieve({ org, departmentId, format, includeMainPlatform, 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
+         */
+        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>;
     /**
      * Get time spent statistics on a per-course basis.
      *
@@ -140,20 +201,42 @@ export declare 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
      */
-    static overviewOrgsMostActiveCoursesRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<TimeSpentPerCourse>;
+    static overviewOrgsMostActiveCoursesRetrieve({ org, departmentId, endDate, format, includeMainPlatform, 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
+         */
+        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>;
     /**
      * Get registered user counts over time.
      *
@@ -169,16 +252,32 @@ export declare 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
      */
-    static overviewOrgsRegisteredUsersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    static overviewOrgsRegisteredUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, 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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OvertimeWithChangeInfo>;
 }

package/dist/types/services/PerformanceService.d.ts

@@ -25,17 +25,27 @@ export declare 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
      */
-    static performanceOrgsCoursesGradingAverageRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
+    static performanceOrgsCoursesGradingAverageRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
+        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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<Average>;
     /**
      * Returns average course grade and grade cuttoff
      *
@@ -55,49 +65,79 @@ export declare 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
                  */
-    static performanceOrgsCoursesGradingAverageWithCutoffRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<AvgCourseGradeWithCutoff>;
+    static performanceOrgsCoursesGradingAverageWithCutoffRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
+        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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<AvgCourseGradeWithCutoff>;
     /**
      * Grading summary for the entire course overview in a tree-like format
      *
      * 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
      */
-    static performanceOrgsCoursesGradingDetailRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<CourseGradingDetail>;
+    static performanceOrgsCoursesGradingDetailRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
+        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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<CourseGradingDetail>;
     /**
      * Grading information per enrolled user in a course
      *
      * 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
      */
-    static performanceOrgsCoursesGradingPerLearnerRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<GradingPerUser>;
+    static performanceOrgsCoursesGradingPerLearnerRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
+        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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<GradingPerUser>;
     /**
      * Returns average grades across various assignment types in a course
      *
@@ -116,17 +156,27 @@ export declare 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
                  */
-    static performanceOrgsCoursesGradingSummaryRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<CourseGradeSummary>;
+    static performanceOrgsCoursesGradingSummaryRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
+        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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<CourseGradeSummary>;
     /**
      * Get average grade value for platform, course, or user.
      *
@@ -146,16 +196,26 @@ export declare 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
      */
-    static performanceOrgsGradingAverageRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
+    static performanceOrgsGradingAverageRetrieve({ org, departmentId, format, includeMainPlatform, }: {
+        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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<Average>;
     /**
      * List grade-related performance data for all courses.
      *
@@ -168,16 +228,32 @@ export declare 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
      */
-    static performanceOrgsGradingPerCourseRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<PerformanceGradesPerCourse>;
+    static performanceOrgsGradingPerCourseRetrieve({ org, departmentId, format, includeMainPlatform, 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
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * Size of data to return
+         */
+        length?: number;
+        /**
+         * Page offset
+         */
+        page?: number;
+    }): CancelablePromise<PerformanceGradesPerCourse>;
 }