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

package/src/services/EngagementService.ts

@@ -1,1199 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { AverageOvertime } from '../models/AverageOvertime';
-import type { CourseCompletionPerCourse } from '../models/CourseCompletionPerCourse';
-import type { EngagementPerCourse } from '../models/EngagementPerCourse';
-import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
-import type { OverTimeWithTotal } from '../models/OverTimeWithTotal';
-import type { PerLearnerTimeSpentInCourseTree } from '../models/PerLearnerTimeSpentInCourseTree';
-import type { TimeDetail } from '../models/TimeDetail';
-import type { TimeSpentByUsersInCourse } from '../models/TimeSpentByUsersInCourse';
-import type { TimeSpentPerCourse } from '../models/TimeSpentPerCourse';
-import type { VideoEngagementPerCourse } from '../models/VideoEngagementPerCourse';
-import type { VideosInCourseSummary } from '../models/VideosInCourseSummary';
-import type { VideosSpecificCourse } from '../models/VideosSpecificCourse';
-import type { WatchedVideosPerUser } from '../models/WatchedVideosPerUser';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class EngagementService {
-    /**
-     * Get engagement metrics on a per-course basis.
-     *
-     * This endpoint provides a paginated list of courses with engagement metrics
-     * including activity counts, time spent, and interaction data.
-     *
-     * Query Parameters:
-     * page (int, optional): Page number for pagination
-     * length (int, optional): Number of items per page
-     *
-     * Returns:
-     * A paginated list of courses with their engagement metrics.
-     * @returns EngagementPerCourse
-     * @throws ApiError
-     */
-    public static engagementOrgsActivityRetrieve({
-        org,
-        departmentId,
-        format = 'json',
-        includeMainPlatform = true,
-        length,
-        page,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * Size of data to return
-         */
-        length?: number,
-        /**
-         * Page offset
-         */
-        page?: number,
-    }): CancelablePromise<EngagementPerCourse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/activity',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'length': length,
-                'page': page,
-            },
-        });
-    }
-    /**
-     * Completion count per user per course across the platform
-     *
-     * Query Params
-     * 1. start_date e.g 2020-10-01
-     * 2. end_date e.g 2020-10-10
-     *
-     * Default result when no query param is added is last_7_days (today inclusive)
-     * @returns OvertimeWithChangeInfo
-     * @throws ApiError
-     */
-    public static engagementOrgsCourseCompletionOverTimeRetrieve({
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        startDate,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<OvertimeWithChangeInfo> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/course_completion/over-time',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * List course completion metrics on a per-course basis.
-     *
-     * This endpoint provides a paginated table of courses with enrollment and
-     * completion statistics for each course.
-     *
-     * Returns:
-     * A paginated list of courses with:
-     * - Course identification (ID and name)
-     * - Enrollment count
-     * - Completion count
-     * - Average completion rate
-     * @returns CourseCompletionPerCourse
-     * @throws ApiError
-     */
-    public static engagementOrgsCourseCompletionPerCourseRetrieve({
-        org,
-        departmentId,
-        format = 'json',
-        includeMainPlatform = true,
-        length,
-        page,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * Size of data to return
-         */
-        length?: number,
-        /**
-         * Page offset
-         */
-        page?: number,
-    }): CancelablePromise<CourseCompletionPerCourse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/course_completion/per-course',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'length': length,
-                'page': page,
-            },
-        });
-    }
-    /**
-     * Average time spent in secs on a per-day basis
-     *
-     * Query Params
-     * 1. start_date e.g 2020-10-01
-     * 2. end_date e.g 2020-10-10
-     * 3. course_id <optional>
-     *
-     * Default result when no query param is added is last_7_days (today inclusive)
-     * @returns AverageOvertime
-     * @throws ApiError
-     */
-    public static engagementOrgsCoursesTimeAverageRetrieve({
-        courseId,
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        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<AverageOvertime> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/time/average',
-            path: {
-                'course_id': courseId,
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * Time spent per course in secs in a tree like form
-     *
-     * Kwargs
-     * course_id e.g course-v1:Org+Course4+Run
-     *
-     * Query Params
-     * 1. start_date <optional> e.g 2020-10-01
-     * 2. end_date <optional> e.g 2020-10-10
-     * @returns TimeDetail
-     * @throws ApiError
-     */
-    public static engagementOrgsCoursesTimeDetailRetrieve({
-        courseId,
-        org,
-        departmentId,
-        format = 'json',
-        includeMainPlatform = true,
-    }: {
-        courseId: string,
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-    }): CancelablePromise<TimeDetail> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/time/detail',
-            path: {
-                'course_id': courseId,
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-            },
-        });
-    }
-    /**
-     * Time spent per course in secs on a per-day basis
-     *
-     * Query Params
-     * 1. start_date e.g 2020-10-01
-     * 2. end_date e.g 2020-10-10
-     * Kwargs
-     * 3. course_id
-     *
-     * Default result when no query param is added is last_7_days (today inclusive)
-     * @returns OverTimeWithTotal
-     * @throws ApiError
-     */
-    public static engagementOrgsCoursesTimeOverTimeRetrieve({
-        courseId,
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        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> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/time/over-time',
-            path: {
-                'course_id': courseId,
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * Time spent by users in a course
-     *
-     * Query Params
-     * course_id  e.g course-v1:Org+Course4+Run
-     * @returns TimeSpentByUsersInCourse
-     * @throws ApiError
-     */
-    public static engagementOrgsCoursesTimeUsersRetrieve({
-        courseId,
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        length,
-        page,
-        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,
-        /**
-         * Size of data to return
-         */
-        length?: number,
-        /**
-         * Page offset
-         */
-        page?: number,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<TimeSpentByUsersInCourse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/time/users',
-            path: {
-                'course_id': courseId,
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'length': length,
-                'page': page,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * Time spent within a course in ordered hierarchical format
-     *
-     * 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 <optional> e.g 2020-10-01
-     * 4. end_date <optional> e.g 2020-10-10
-     * @returns PerLearnerTimeSpentInCourseTree
-     * @throws ApiError
-     */
-    public static engagementOrgsCoursesTimeUsersDetailRetrieve({
-        courseId,
-        org,
-        userId,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        startDate,
-    }: {
-        courseId: string,
-        org: string,
-        userId: 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<PerLearnerTimeSpentInCourseTree> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/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,
-            },
-        });
-    }
-    /**
-     * 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
-     */
-    public static engagementOrgsCoursesTimeUsersOverTimeRetrieve({
-        courseId,
-        org,
-        userId,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        startDate,
-    }: {
-        courseId: string,
-        org: string,
-        userId: 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> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/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,
-            },
-        });
-    }
-    /**
-     * Get video engagement metrics for a specific course.
-     *
-     * This endpoint provides detailed video engagement statistics for a single course,
-     * including view counts, completion rates, and time spent on videos.
-     *
-     * Query Parameters:
-     * course_id (str): The course ID to get video engagement data for
-     *
-     * Returns:
-     * Detailed video engagement metrics for the specified course.
-     * @returns VideosSpecificCourse
-     * @throws ApiError
-     */
-    public static engagementOrgsCoursesVideosRetrieve({
-        courseId,
-        org,
-        departmentId,
-        format = 'json',
-        includeMainPlatform = true,
-    }: {
-        courseId: string,
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-    }): CancelablePromise<VideosSpecificCourse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/videos/',
-            path: {
-                'course_id': courseId,
-                'org': org,
-            },
-            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
-     * @returns OverTimeWithTotal
-     * @throws ApiError
-     */
-    public static engagementOrgsCoursesVideosOverTimeRetrieve({
-        courseId,
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        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> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/videos/over-time',
-            path: {
-                'course_id': courseId,
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * Get a summary of video watch statistics for a specific course.
-     *
-     * This endpoint provides a structured summary of video watch data for a course,
-     * organized in a tree-like format by course sections and subsections.
-     *
-     * Query Parameters:
-     * course_id (str): The course ID to get video summary for
-     *
-     * Returns:
-     * A hierarchical structure of video watch data for the course, including:
-     * - Section and subsection organization
-     * - Video identification and metadata
-     * - Watch counts and completion rates
-     * @returns VideosInCourseSummary
-     * @throws ApiError
-     */
-    public static engagementOrgsCoursesVideosSummaryRetrieve({
-        courseId,
-        org,
-        departmentId,
-        format = 'json',
-        includeMainPlatform = true,
-    }: {
-        courseId: string,
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-    }): CancelablePromise<VideosInCourseSummary> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/videos/summary',
-            path: {
-                'course_id': courseId,
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-            },
-        });
-    }
-    /**
-     * List of users' videos completed records for a specific course
-     *
-     * Kwargs
-     * course_id  e.g course-v1:Org+Course4+Run
-     * @returns WatchedVideosPerUser
-     * @throws ApiError
-     */
-    public static engagementOrgsCoursesVideosUsersRetrieve({
-        courseId,
-        org,
-        departmentId,
-        format = 'json',
-        includeMainPlatform = true,
-    }: {
-        courseId: string,
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-    }): CancelablePromise<WatchedVideosPerUser> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/courses/{course_id}/videos/users',
-            path: {
-                'course_id': courseId,
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-            },
-        });
-    }
-    /**
-     * Average time spent by a learner in enrolled courses. Gives a rough estimate of whats the average time
-     * that would be spent by a learner in a course
-     *
-     * Query Params
-     * 1. start_date e.g 2020-10-01
-     * 2. end_date e.g 2020-10-10
-     * @returns AverageOvertime
-     * @throws ApiError
-     */
-    public static engagementOrgsTimeAveragePerlearnerPercourseRetrieve({
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        startDate,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<AverageOvertime> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/time/average-perlearner-percourse',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * Average time spent in secs on a per-day basis
-     *
-     * Query Params
-     * 1. start_date e.g 2020-10-01
-     * 2. end_date e.g 2020-10-10
-     * 3. course_id <optional>
-     *
-     * Default result when no query param is added is last_7_days (today inclusive)
-     * @returns AverageOvertime
-     * @throws ApiError
-     */
-    public static engagementOrgsTimeAverageWithOverTimeRetrieve({
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        startDate,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<AverageOvertime> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/time/average-with-over-time',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * Get time spent on the platform over time.
-     *
-     * This endpoint provides daily time spent values (in seconds) across the
-     * platform 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 time spent values 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.
-     * @returns OvertimeWithChangeInfo
-     * @throws ApiError
-     */
-    public static engagementOrgsTimeOverTimeRetrieve({
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        startDate,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<OvertimeWithChangeInfo> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/time/over-time',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * 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
-     * @returns TimeSpentPerCourse
-     * @throws ApiError
-     */
-    public static engagementOrgsTimePerCourseRetrieve({
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        length,
-        page,
-        startDate,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        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> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/time/per-course',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'length': length,
-                'page': page,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * Get video engagement metrics on a per-course basis.
-     *
-     * This endpoint provides a paginated list of courses with video engagement metrics
-     * including view counts, completion rates, and time spent on videos.
-     *
-     * Query Parameters:
-     * page (int, optional): Page number for pagination
-     * length (int, optional): Number of items per page
-     *
-     * Returns:
-     * A paginated list of courses with their video engagement metrics.
-     * @returns VideoEngagementPerCourse
-     * @throws ApiError
-     */
-    public static engagementOrgsVideosRetrieve({
-        org,
-        departmentId,
-        format = 'json',
-        includeMainPlatform = true,
-        length,
-        page,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * Size of data to return
-         */
-        length?: number,
-        /**
-         * Page offset
-         */
-        page?: number,
-    }): CancelablePromise<VideoEngagementPerCourse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/videos/',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'length': length,
-                'page': page,
-            },
-        });
-    }
-    /**
-     * 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
-     */
-    public static engagementOrgsVideosOverTimeRetrieve({
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        startDate,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<OverTimeWithTotal> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/engagement/orgs/{org}/videos/over-time',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-}