@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,184 @@
+import type { Average } from '../models/Average';
+import type { CourseCompletionSummaryOvertime } from '../models/CourseCompletionSummaryOvertime';
+import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
+import type { PerlearnerUserList } from '../models/PerlearnerUserList';
+import type { TimeSpentPerCourse } from '../models/TimeSpentPerCourse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class OverviewService {
+    /**
+     * Get active user counts over time.
+     *
+     * This endpoint provides daily counts of active users (users with known activity)
+     * over a specified time period.
+     *
+     * Query Parameters:
+     * start_date (str, optional): Start date for the time range (ISO format)
+     * end_date (str, optional): End date for the time range (ISO format)
+     *
+     * Returns:
+     * Daily active user counts over the specified time period, with change metrics
+     * compared to previous periods.
+     *
+     * 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>;
+    /**
+     * Get average grade value for platform, course, or user.
+     *
+     * This endpoint returns the average grade at different levels:
+     * - Platform level: Average grade across all courses
+     * - Course level: Average grade for a specific course
+     * - Learner level: Average grade for a specific learner
+     * - Course-learner level: Grade for a specific learner in a specific course
+     *
+     * Query Parameters:
+     * course_id (str, optional): Filter by course ID
+     * learner_id (str, optional): Filter by username or email
+     *
+     * Returns:
+     * The average grade value based on the specified filters.
+     *
+     * 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>;
+    /**
+     * Get course completion summary metrics over time.
+     *
+     * This endpoint provides completion statistics across the platform over a
+     * specified time period, including daily completion counts and overall metrics.
+     *
+     * Query Parameters:
+     * start_date (str): Start date for the time range (ISO format)
+     * end_date (str): End date for the time range (ISO format)
+     *
+     * Returns:
+     * Completion data including:
+     * - Daily completion counts over time
+     * - Total unique user count
+     * - Total completion count
+     * - Completion percentage
+     * - 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>;
+    /**
+     * List all learners on the platform with aggregated metrics.
+     *
+     * This endpoint returns a paginated list of all learners with key metrics including:
+     * - Enrollment counts
+     * - Completion counts
+     * - Time spent on platform
+     *
+     * Query Parameters:
+     * page (int): Page number for pagination
+     * length (int): Number of items per page
+     * search (str): Filter learners by username, email, or name
+     *
+     * 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>;
+    /**
+     * Get time spent statistics on a per-course basis.
+     *
+     * This endpoint provides a paginated list of courses with the total time
+     * spent by users in each course.
+     *
+     * Query Parameters:
+     * start_date (str, optional): Start date for filtering (ISO format)
+     * end_date (str, optional): End date for filtering (ISO format)
+     * page (int, optional): Page number for pagination
+     * length (int, optional): Number of items per page
+     *
+     * Returns:
+     * A paginated list of courses with:
+     * - Course identification (ID and name)
+     * - 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>;
+    /**
+     * Get registered user counts over time.
+     *
+     * This endpoint provides daily counts of new user registrations over a
+     * specified time period.
+     *
+     * Query Parameters:
+     * start_date (str, optional): Start date for the time range (ISO format)
+     * end_date (str, optional): End date for the time range (ISO format)
+     *
+     * Returns:
+     * Daily registration counts over the specified time period, with 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 OvertimeWithChangeInfo
+     * @throws ApiError
+     */
+    static overviewOrgsRegisteredUsersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+}

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

@@ -0,0 +1,183 @@
+import type { Average } from '../models/Average';
+import type { AvgCourseGradeWithCutoff } from '../models/AvgCourseGradeWithCutoff';
+import type { CourseGradeSummary } from '../models/CourseGradeSummary';
+import type { CourseGradingDetail } from '../models/CourseGradingDetail';
+import type { GradingPerUser } from '../models/GradingPerUser';
+import type { PerformanceGradesPerCourse } from '../models/PerformanceGradesPerCourse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class PerformanceService {
+    /**
+     * Get average grade value for platform, course, or user.
+     *
+     * This endpoint returns the average grade at different levels:
+     * - Platform level: Average grade across all courses
+     * - Course level: Average grade for a specific course
+     * - Learner level: Average grade for a specific learner
+     * - Course-learner level: Grade for a specific learner in a specific course
+     *
+     * Query Parameters:
+     * course_id (str, optional): Filter by course ID
+     * learner_id (str, optional): Filter by username or email
+     *
+     * Returns:
+     * The average grade value based on the specified filters.
+     *
+     * 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>;
+    /**
+     * Returns average course grade and grade cuttoff
+     *
+     * e.g
+     * ```
+     * {
+         * "data": {
+             * "grade_cutoffs": {
+                 * "A": 90,
+                 * "B": 80,
+                 * "C": 70,
+                 * },
+                 * "average_grade": 50.0,
+                 * }
+                 * }
+                 * ```
+                 *
+                 * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * Returns average grades across various assignment types in a course
+     *
+     * Query Params
+     * course_id
+     *
+     * Returns:
+     * dict
+     * {
+         * "data": [
+             * {
+                 * "assignment_type': <str>,
+                 * "weight": <float>,
+                 * "average_weighted_grade": <float>,
+                 * "average_section_grade": <float>
+                 * }, ...
+                 * ]
+                 * }
+                 * @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>;
+    /**
+     * Get average grade value for platform, course, or user.
+     *
+     * This endpoint returns the average grade at different levels:
+     * - Platform level: Average grade across all courses
+     * - Course level: Average grade for a specific course
+     * - Learner level: Average grade for a specific learner
+     * - Course-learner level: Grade for a specific learner in a specific course
+     *
+     * Query Parameters:
+     * course_id (str, optional): Filter by course ID
+     * learner_id (str, optional): Filter by username or email
+     *
+     * Returns:
+     * The average grade value based on the specified filters.
+     *
+     * 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>;
+    /**
+     * List grade-related performance data for all courses.
+     *
+     * This endpoint provides a comprehensive view of grade performance across
+     * courses, including enrollment counts, pass rates, and average grades.
+     *
+     * Returns:
+     * A paginated list of courses with:
+     * - Course identification (ID and name)
+     * - 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>;
+}