@iblai/iblai-api 3.34.5-core

package/src/services/PerlearnerService.ts

@@ -0,0 +1,1009 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export 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
+     * @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 Learner date_joined end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param isEnrolled Filter for users who have at least an enrollment
+     * @param length Size of data to return
+     * @param location Location search string
+     * @param page Page offset
+     * @param platform Platform search string
+     * @param program Program search string
+     * @param search Search string for learner. email, username or full name
+     * @param startDate Learner date_joined start date. ISO 8601
+     * @returns NewPerLearnerList
+     * @throws ApiError
+     */
+    public static perlearnerOrgsLearnersRetrieve(
+        org: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        isEnrolled?: boolean | null,
+        length?: number,
+        location?: string,
+        page?: number,
+        platform?: string,
+        program?: string,
+        search?: string,
+        startDate?: string,
+    ): CancelablePromise<NewPerLearnerList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/learners',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'is_enrolled': isEnrolled,
+                'length': length,
+                'location': location,
+                'page': page,
+                'platform': platform,
+                'program': program,
+                'search': search,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static perlearnerOrgsUsersRetrieve(
+        org: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        length?: number,
+        page?: number,
+        search?: string,
+    ): CancelablePromise<PerlearnerUserList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'length': length,
+                'page': page,
+                'search': search,
+            },
+        });
+    }
+    /**
+     * Provides information on user enrollments
+     *
+     * Params
+     * user_id e.g developer@ibleducation.com| developer
+     * @param org
+     * @param userId
+     * @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 ActivityAPI
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersActivityRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+    ): CancelablePromise<ActivityAPI> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/activity/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+            },
+        });
+    }
+    /**
+     * 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)
+     * @param courseId
+     * @param org
+     * @param userId
+     * @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 PerlearnerGradeWithCutOff
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersCoursesGradingCutoffsRetrieve(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<PerlearnerGradeWithCutOff> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/cutoffs',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param courseId
+     * @param org
+     * @param userId
+     * @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 DetailedGradeView
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersCoursesGradingDetailRetrieve(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<DetailedGradeView> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/detail',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Query Params
+     * 1. course_id e.g course-v1:Org+Course4+Run
+     * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
+     * @param courseId
+     * @param org
+     * @param userId
+     * @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 PerlearnerGradeSummary
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersCoursesGradingSummaryRetrieve(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<PerlearnerGradeSummary> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/summary',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
+     * @param courseId
+     * @param org
+     * @param userId
+     * @returns Value
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve(
+        courseId: string,
+        org: string,
+        userId: string,
+    ): CancelablePromise<Value> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/engagement-index',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+        });
+    }
+    /**
+     * 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)
+     * @param courseId
+     * @param org
+     * @param userId
+     * @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 PerlearnerGradeWithCutOff
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersCoursesOverviewGradeRetrieve(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<PerlearnerGradeWithCutOff> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/grade',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Evaluates performance index for platform, per course, per user and per user-per course
+     *
+     * Query Params
+     * course_id <optional>
+     * learner_id <optional>
+     * @param courseId
+     * @param org
+     * @param userId
+     * @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 Value
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<Value> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/performance-index',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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)
+     * @param courseId
+     * @param org
+     * @param userId
+     * @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 OverTimeWithTotal
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OverTimeWithTotal> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/time/over-time',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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
+     * @param courseId
+     * @param org
+     * @param userId
+     * @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 PerLearnerCourseVideosWatched
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersCoursesVideosRetrieve(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+    ): CancelablePromise<PerLearnerCourseVideosWatched> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/videos',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+            },
+        });
+    }
+    /**
+     * 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
+     * @param courseId
+     * @param org
+     * @param userId
+     * @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 OverTimeWithTotal
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersCoursesVideosOverTimeRetrieve(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OverTimeWithTotal> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/videos/over-time',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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)
+     * @param org
+     * @param userId
+     * @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 PerlearnerGradingPerCourseAPI
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersGradesPerCourseRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+    ): CancelablePromise<PerlearnerGradingPerCourseAPI> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/grades/per-course',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+            },
+        });
+    }
+    /**
+     * 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
+     * @param org
+     * @param userId
+     * @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 meta Include extra analytics information?
+     *
+     * * `y` - y
+     * * `yes` - yes
+     * * `true` - true
+     * * `True` - True
+     * * `n` - n
+     * * `no` - no
+     * * `false` - false
+     * * `False` - False
+     * @param search
+     * @returns LearnerInformationAPI
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersInfoRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        meta: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'n',
+        search?: string,
+    ): CancelablePromise<LearnerInformationAPI> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/info',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'meta': meta,
+                'search': search,
+            },
+        });
+    }
+    /**
+     * Last course accessed by a learner, includes upto unit information as well
+     * @param org
+     * @param userId
+     * @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 PerLearnerLastAccess
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersLastAccessRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+    ): CancelablePromise<PerLearnerLastAccess> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/last-access',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+            },
+        });
+    }
+    /**
+     * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
+     * @param org
+     * @param userId
+     * @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 Value
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersOverviewEngagementIndexRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<Value> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/overview/engagement-index',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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 userId
+     * @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 perlearnerOrgsUsersOverviewGradesAverageRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+    ): CancelablePromise<Average> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/overview/grades/average',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+            },
+        });
+    }
+    /**
+     * Evaluates performance index for platform, per course, per user and per user-per course
+     *
+     * Query Params
+     * course_id <optional>
+     * learner_id <optional>
+     * @param org
+     * @param userId
+     * @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 Value
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersOverviewPerformanceIndexRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<Value> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/overview/performance-index',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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)
+     * @param org
+     * @param userId
+     * @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 OverTimeWithTotal
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersOverviewTimeOverTimeRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OverTimeWithTotal> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/overview/time/over-time',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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
+     * @param org
+     * @param userId
+     * @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 OverTimeWithTotal
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersVideosOverTimeRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OverTimeWithTotal> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/videos/over-time',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Summary Videos watched data for a learner per enrollment
+     *
+     * Query Params
+     * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
+     * @param org
+     * @param userId
+     * @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 PerlearnerEngagementVideosWatchedPerCourse
+     * @throws ApiError
+     */
+    public static perlearnerOrgsUsersVideosPerCourseRetrieve(
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<PerlearnerEngagementVideosWatchedPerCourse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/perlearner/orgs/{org}/users/{user_id}/videos/per-course',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+}