@iblai/iblai-api 3.58.0-core → 3.59.0-ai-plus

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

@@ -1,715 +0,0 @@
-import type { ActivityAPI } from '../models/ActivityAPI';
-import type { Average } from '../models/Average';
-import type { DetailedGradeView } from '../models/DetailedGradeView';
-import type { LearnerInformationAPI } from '../models/LearnerInformationAPI';
-import type { NewPerLearnerList } from '../models/NewPerLearnerList';
-import type { OverTimeWithTotal } from '../models/OverTimeWithTotal';
-import type { PerLearnerCourseVideosWatched } from '../models/PerLearnerCourseVideosWatched';
-import type { PerlearnerEngagementVideosWatchedPerCourse } from '../models/PerlearnerEngagementVideosWatchedPerCourse';
-import type { PerlearnerGradeSummary } from '../models/PerlearnerGradeSummary';
-import type { PerlearnerGradeWithCutOff } from '../models/PerlearnerGradeWithCutOff';
-import type { PerlearnerGradingPerCourseAPI } from '../models/PerlearnerGradingPerCourseAPI';
-import type { PerLearnerLastAccess } from '../models/PerLearnerLastAccess';
-import type { PerlearnerUserList } from '../models/PerlearnerUserList';
-import type { Value } from '../models/Value';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class PerlearnerService {
-    /**
-     * Enhanced API endpoint for listing learners with comprehensive filtering.
-     *
-     * This endpoint provides a paginated list of learners with detailed metrics
-     * and supports advanced filtering options. It uses DM token authentication
-     * and respects department-based access controls.
-     *
-     * Query Parameters:
-     * page (int): Page number for pagination
-     * length (int): Number of items per page
-     * search (str): Filter by username, email, or full name
-     * program (str): Filter by program
-     * location (str): Filter by location
-     * is_enrolled (bool): Filter for users with enrollments
-     * platform (str): Filter by platform
-     * start_date (date): Filter by join date (start range)
-     * end_date (date): Filter by join date (end range)
-     *
-     * Returns:
-     * A paginated list of learners with comprehensive metrics including:
-     * - Course enrollments and completions
-     * - Time spent on platform
-     * - Pathway progress
-     * - Certificate and skill information
-     * - Location data
-     *
-     * Access Control:
-     * - Platform admins can see all learners
-     * - Department admins can only see learners in their departments
-     * @returns NewPerLearnerList
-     * @throws ApiError
-     */
-    static perlearnerOrgsLearnersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, isEnrolled, length, location, page, platform, program, search, 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;
-        /**
-         * Learner date_joined end date. ISO 8601
-         */
-        endDate?: string;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * Filter for users who have at least an enrollment
-         */
-        isEnrolled?: boolean | null;
-        /**
-         * Size of data to return
-         */
-        length?: number;
-        /**
-         * Location search string
-         */
-        location?: string;
-        /**
-         * Page offset
-         */
-        page?: number;
-        /**
-         * Platform search string
-         */
-        platform?: string;
-        /**
-         * Program search string
-         */
-        program?: string;
-        /**
-         * Search string for learner. email, username or full name
-         */
-        search?: string;
-        /**
-         * Learner date_joined start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<NewPerLearnerList>;
-    /**
-     * 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.
-     * @returns PerlearnerUserList
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersRetrieve({ 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>;
-    /**
-     * Provides information on user enrollments
-     *
-     * Params
-     * user_id e.g developer@ibleducation.com| developer
-     * @returns ActivityAPI
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersActivityRetrieve({ org, userId, 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<ActivityAPI>;
-    /**
-     * Provides about a learner current grade in a course with the course cut
-     * Kwargs
-     * 1. course_id e.g course-v1:Org+Course4+Run
-     * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @returns PerlearnerGradeWithCutOff
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersCoursesGradingCutoffsRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        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; /**
-         * end date. ISO 8601
-         */
-        endDate?: string; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean; /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<PerlearnerGradeWithCutOff>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @returns DetailedGradeView
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersCoursesGradingDetailRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        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; /**
-         * end date. ISO 8601
-         */
-        endDate?: string; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean; /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<DetailedGradeView>;
-    /**
-     * Query Params
-     * 1. course_id e.g course-v1:Org+Course4+Run
-     * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @returns PerlearnerGradeSummary
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersCoursesGradingSummaryRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        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; /**
-         * end date. ISO 8601
-         */
-        endDate?: string; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean; /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<PerlearnerGradeSummary>;
-    /**
-     * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
-     * @returns Value
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve({ courseId, org, userId, }: {
-        courseId: string;
-        org: string;
-    }): CancelablePromise<Value>;
-    /**
-     * Provides about a learner current grade in a course with the course cut
-     * Kwargs
-     * 1. course_id e.g course-v1:Org+Course4+Run
-     * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @returns PerlearnerGradeWithCutOff
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersCoursesOverviewGradeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        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; /**
-         * end date. ISO 8601
-         */
-        endDate?: string; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean; /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<PerlearnerGradeWithCutOff>;
-    /**
-     * Evaluates performance index for platform, per course, per user and per user-per course
-     *
-     * Query Params
-     * course_id <optional>
-     * learner_id <optional>
-     * @returns Value
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        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; /**
-         * end date. ISO 8601
-         */
-        endDate?: string; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean; /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<Value>;
-    /**
-     * Time spent within a course in secs on a per-day basis
-     *
-     * Kwargs
-     * 1. course_id  e.g course-v1:Org+Course4+Run
-     * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * Query Params
-     * 3. start_date e.g 2020-10-01
-     * 4. end_date e.g 2020-10-10
-     *
-     * Default result when no query param is added is last_7_days (today inclusive)
-     * @returns OverTimeWithTotal
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        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; /**
-         * end date. ISO 8601
-         */
-        endDate?: string; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean; /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<OverTimeWithTotal>;
-    /**
-     * List of videos within a course a learner has watched
-     *
-     * Kwargs
-     * 1. course_id e.g course-v1:Org+Course4+Run
-     * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     *
-     * Default result when no query param is added is [], 0
-     * @returns PerLearnerCourseVideosWatched
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersCoursesVideosRetrieve({ courseId, org, userId, 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<PerLearnerCourseVideosWatched>;
-    /**
-     * Get video watch counts over time.
-     *
-     * This endpoint provides daily counts of videos watched over a specified time period,
-     * with options to filter by course or user.
-     *
-     * 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)
-     * course_id (str, optional): Filter by course ID
-     * user_id (str, optional): Filter by username or email
-     *
-     * Returns:
-     * Daily video watch counts over the specified time period.
-     *
-     * Default time range is the last 7 days if no dates are specified.
-     *
-     * Access Control:
-     * - Platform admins can access any video watch data
-     * - Learners can access their own video watch data
-     * @returns OverTimeWithTotal
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersCoursesVideosOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        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; /**
-         * end date. ISO 8601
-         */
-        endDate?: string; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean; /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<OverTimeWithTotal>;
-    /**
-     * Summary Grading Information for a learner on a per-enrollment basis
-     *
-     * Query Params
-     * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @returns PerlearnerGradingPerCourseAPI
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersGradesPerCourseRetrieve({ org, userId, 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<PerlearnerGradingPerCourseAPI>;
-    /**
-     * Retrieve detailed information about a specific learner.
-     *
-     * This endpoint returns personal and activity information about a learner,
-     * including profile data, activity metrics, and location information.
-     *
-     * Path Parameters:
-     * user_id (str): The username or email of the learner
-     *
-     * Query Parameters:
-     * meta (bool): Include additional analytics information when true
-     *
-     * Returns:
-     * Detailed learner information including:
-     * - Profile data (username, name, email)
-     * - Registration and activity dates
-     * - Activity metrics (assessments, time spent, videos watched)
-     * - Location and browser information (when available)
-     *
-     * Access Control:
-     * - Platform admins can access any learner
-     * - Learners can access their own information
-     * - Department admins can access learners in their departments
-     * @returns LearnerInformationAPI
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersInfoRetrieve({ org, userId, departmentId, format, includeMainPlatform, meta, 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; /**
-         * Include extra analytics information?
-         *
-         * * `y` - y
-         * * `yes` - yes
-         * * `true` - true
-         * * `True` - True
-         * * `n` - n
-         * * `no` - no
-         * * `false` - false
-         * * `False` - False
-         */
-        meta?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
-        search?: string;
-    }): CancelablePromise<LearnerInformationAPI>;
-    /**
-     * Last course accessed by a learner, includes upto unit information as well
-     * @returns PerLearnerLastAccess
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersLastAccessRetrieve({ org, userId, 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<PerLearnerLastAccess>;
-    /**
-     * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
-     * @returns Value
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersOverviewEngagementIndexRetrieve({ org, userId, 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<Value>;
-    /**
-     * 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
-     * @returns Average
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersOverviewGradesAverageRetrieve({ org, userId, 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>;
-    /**
-     * Evaluates performance index for platform, per course, per user and per user-per course
-     *
-     * Query Params
-     * course_id <optional>
-     * learner_id <optional>
-     * @returns Value
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersOverviewPerformanceIndexRetrieve({ org, userId, 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<Value>;
-    /**
-     * Time spent in secs on a per-day basis
-     *
-     * Query Params
-     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
-     * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
-     * 3. start_date e.g 2020-10-01
-     * 4. end_date e.g 2020-10-10
-     *
-     * Default result when no query param is added is last_7_days (today inclusive)
-     * @returns OverTimeWithTotal
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersOverviewTimeOverTimeRetrieve({ org, userId, 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<OverTimeWithTotal>;
-    /**
-     * Get video watch counts over time.
-     *
-     * This endpoint provides daily counts of videos watched over a specified time period,
-     * with options to filter by course or user.
-     *
-     * 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)
-     * course_id (str, optional): Filter by course ID
-     * user_id (str, optional): Filter by username or email
-     *
-     * Returns:
-     * Daily video watch counts over the specified time period.
-     *
-     * Default time range is the last 7 days if no dates are specified.
-     *
-     * Access Control:
-     * - Platform admins can access any video watch data
-     * - Learners can access their own video watch data
-     * @returns OverTimeWithTotal
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersVideosOverTimeRetrieve({ org, userId, 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<OverTimeWithTotal>;
-    /**
-     * Summary Videos watched data for a learner per enrollment
-     *
-     * Query Params
-     * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @returns PerlearnerEngagementVideosWatchedPerCourse
-     * @throws ApiError
-     */
-    static perlearnerOrgsUsersVideosPerCourseRetrieve({ org, userId, 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<PerlearnerEngagementVideosWatchedPerCourse>;
-}