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

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

@@ -25,18 +25,34 @@ export declare class EngagementService {
      *
      * Returns:
      * A paginated list of courses with their engagement 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
      * @returns EngagementPerCourse
      * @throws ApiError
      */
-    static engagementOrgsActivityRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<EngagementPerCourse>;
+    static engagementOrgsActivityRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * Size of data to return
+         */
+        length?: number;
+        /**
+         * Page offset
+         */
+        page?: number;
+    }): CancelablePromise<EngagementPerCourse>;
     /**
      * Completion count per user per course across the platform
      *
@@ -45,18 +61,34 @@ export declare class EngagementService {
      * 2. end_date e.g 2020-10-10
      *
      * Default result when no query param is added is last_7_days (today inclusive)
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OvertimeWithChangeInfo
      * @throws ApiError
      */
-    static engagementOrgsCourseCompletionOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    static engagementOrgsCourseCompletionOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * end date. ISO 8601
+         */
+        endDate?: string;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OvertimeWithChangeInfo>;
     /**
      * List course completion metrics on a per-course basis.
      *
@@ -69,18 +101,34 @@ export declare class EngagementService {
      * - Enrollment count
      * - Completion count
      * - Average completion rate
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param length Size of data to return
-     * @param page Page offset
      * @returns CourseCompletionPerCourse
      * @throws ApiError
      */
-    static engagementOrgsCourseCompletionPerCourseRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<CourseCompletionPerCourse>;
+    static engagementOrgsCourseCompletionPerCourseRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * Size of data to return
+         */
+        length?: number;
+        /**
+         * Page offset
+         */
+        page?: number;
+    }): CancelablePromise<CourseCompletionPerCourse>;
     /**
      * Average time spent in secs on a per-day basis
      *
@@ -90,19 +138,35 @@ export declare class EngagementService {
      * 3. course_id <optional>
      *
      * Default result when no query param is added is last_7_days (today inclusive)
-     * @param courseId
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns AverageOvertime
      * @throws ApiError
      */
-    static engagementOrgsCoursesTimeAverageRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<AverageOvertime>;
+    static engagementOrgsCoursesTimeAverageRetrieve({ courseId, org, 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<AverageOvertime>;
     /**
      * Time spent per course in secs in a tree like form
      *
@@ -112,17 +176,27 @@ export declare class EngagementService {
      * Query Params
      * 1. start_date <optional> e.g 2020-10-01
      * 2. end_date <optional> e.g 2020-10-10
-     * @param courseId
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns TimeDetail
      * @throws ApiError
      */
-    static engagementOrgsCoursesTimeDetailRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<TimeDetail>;
+    static engagementOrgsCoursesTimeDetailRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
+        courseId: string;
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<TimeDetail>;
     /**
      * Time spent per course in secs on a per-day basis
      *
@@ -133,39 +207,77 @@ export declare class EngagementService {
      * 3. course_id
      *
      * Default result when no query param is added is last_7_days (today inclusive)
-     * @param courseId
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param 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
      */
-    static engagementOrgsCoursesTimeOverTimeRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    static engagementOrgsCoursesTimeOverTimeRetrieve({ courseId, org, 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>;
     /**
      * Time spent by users in a course
      *
      * Query Params
      * course_id  e.g course-v1:Org+Course4+Run
-     * @param courseId
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param length Size of data to return
-     * @param page Page offset
-     * @param startDate start date. ISO 8601
      * @returns TimeSpentByUsersInCourse
      * @throws ApiError
      */
-    static engagementOrgsCoursesTimeUsersRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<TimeSpentByUsersInCourse>;
+    static engagementOrgsCoursesTimeUsersRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, 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>;
     /**
      * Time spent within a course in ordered hierarchical format
      *
@@ -175,20 +287,30 @@ export declare class EngagementService {
      * Query Params
      * 3. start_date <optional> e.g 2020-10-01
      * 4. end_date <optional> e.g 2020-10-10
-     * @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 PerLearnerTimeSpentInCourseTree
      * @throws ApiError
      */
-    static engagementOrgsCoursesTimeUsersDetailRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerLearnerTimeSpentInCourseTree>;
+    static engagementOrgsCoursesTimeUsersDetailRetrieve({ 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<PerLearnerTimeSpentInCourseTree>;
     /**
      * Time spent in secs on a per-day basis
      *
@@ -199,20 +321,30 @@ export declare class EngagementService {
      * 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
      */
-    static engagementOrgsCoursesTimeUsersOverTimeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    static engagementOrgsCoursesTimeUsersOverTimeRetrieve({ 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>;
     /**
      * Get video engagement metrics for a specific course.
      *
@@ -224,17 +356,27 @@ export declare class EngagementService {
      *
      * Returns:
      * Detailed video engagement metrics for the specified course.
-     * @param courseId
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns VideosSpecificCourse
      * @throws ApiError
      */
-    static engagementOrgsCoursesVideosRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<VideosSpecificCourse>;
+    static engagementOrgsCoursesVideosRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
+        courseId: string;
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<VideosSpecificCourse>;
     /**
      * Get video watch counts over time.
      *
@@ -255,19 +397,35 @@ export declare class EngagementService {
      * Access Control:
      * - Platform admins can access any video watch data
      * - Learners can access their own video watch data
-     * @param courseId
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param 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
      */
-    static engagementOrgsCoursesVideosOverTimeRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    static engagementOrgsCoursesVideosOverTimeRetrieve({ courseId, org, 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>;
     /**
      * Get a summary of video watch statistics for a specific course.
      *
@@ -282,33 +440,53 @@ export declare class EngagementService {
      * - Section and subsection organization
      * - Video identification and metadata
      * - Watch counts and completion rates
-     * @param courseId
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns VideosInCourseSummary
      * @throws ApiError
      */
-    static engagementOrgsCoursesVideosSummaryRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<VideosInCourseSummary>;
+    static engagementOrgsCoursesVideosSummaryRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
+        courseId: string;
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<VideosInCourseSummary>;
     /**
      * List of users' videos completed records for a specific course
      *
      * Kwargs
      * course_id  e.g course-v1:Org+Course4+Run
-     * @param courseId
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns WatchedVideosPerUser
      * @throws ApiError
      */
-    static engagementOrgsCoursesVideosUsersRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<WatchedVideosPerUser>;
+    static engagementOrgsCoursesVideosUsersRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
+        courseId: string;
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<WatchedVideosPerUser>;
     /**
      * 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
@@ -316,18 +494,34 @@ export declare class EngagementService {
      * Query Params
      * 1. start_date e.g 2020-10-01
      * 2. end_date e.g 2020-10-10
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns AverageOvertime
      * @throws ApiError
      */
-    static engagementOrgsTimeAveragePerlearnerPercourseRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<AverageOvertime>;
+    static engagementOrgsTimeAveragePerlearnerPercourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * end date. ISO 8601
+         */
+        endDate?: string;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<AverageOvertime>;
     /**
      * Average time spent in secs on a per-day basis
      *
@@ -337,18 +531,34 @@ export declare class EngagementService {
      * 3. course_id <optional>
      *
      * Default result when no query param is added is last_7_days (today inclusive)
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns AverageOvertime
      * @throws ApiError
      */
-    static engagementOrgsTimeAverageWithOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<AverageOvertime>;
+    static engagementOrgsTimeAverageWithOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * end date. ISO 8601
+         */
+        endDate?: string;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<AverageOvertime>;
     /**
      * Get time spent on the platform over time.
      *
@@ -364,18 +574,34 @@ export declare class EngagementService {
      * compared to previous periods.
      *
      * Default time range is the last 7 days if no dates are specified.
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OvertimeWithChangeInfo
      * @throws ApiError
      */
-    static engagementOrgsTimeOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    static engagementOrgsTimeOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * end date. ISO 8601
+         */
+        endDate?: string;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OvertimeWithChangeInfo>;
     /**
      * Get time spent statistics on a per-course basis.
      *
@@ -394,20 +620,42 @@ export declare class EngagementService {
      * - Total time spent (in seconds)
      * - Formatted time spent (human-readable)
      * - Percentage of total platform time
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param length Size of data to return
-     * @param page Page offset
-     * @param startDate start date. ISO 8601
      * @returns TimeSpentPerCourse
      * @throws ApiError
      */
-    static engagementOrgsTimePerCourseRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<TimeSpentPerCourse>;
+    static engagementOrgsTimePerCourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * end date. ISO 8601
+         */
+        endDate?: string;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * Size of data to return
+         */
+        length?: number;
+        /**
+         * Page offset
+         */
+        page?: number;
+        /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<TimeSpentPerCourse>;
     /**
      * Get video engagement metrics on a per-course basis.
      *
@@ -420,18 +668,34 @@ export declare class EngagementService {
      *
      * Returns:
      * A paginated list of courses with their video engagement 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
      * @returns VideoEngagementPerCourse
      * @throws ApiError
      */
-    static engagementOrgsVideosRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<VideoEngagementPerCourse>;
+    static engagementOrgsVideosRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * Size of data to return
+         */
+        length?: number;
+        /**
+         * Page offset
+         */
+        page?: number;
+    }): CancelablePromise<VideoEngagementPerCourse>;
     /**
      * Get video watch counts over time.
      *
@@ -452,16 +716,32 @@ export declare class EngagementService {
      * Access Control:
      * - Platform admins can access any video watch data
      * - Learners can access their own video watch data
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param 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
      */
-    static engagementOrgsVideosOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    static engagementOrgsVideosOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * end date. ISO 8601
+         */
+        endDate?: string;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OverTimeWithTotal>;
 }