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

package/src/services/EngagementService.ts

@@ -31,25 +31,41 @@ export 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
      */
-    public static engagementOrgsActivityRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * Size of data to return
+         */
         length?: number,
+        /**
+         * Page offset
+         */
         page?: number,
-    ): CancelablePromise<EngagementPerCourse> {
+    }): CancelablePromise<EngagementPerCourse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/activity',
@@ -73,25 +89,41 @@ export 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
      */
-    public static engagementOrgsCourseCompletionOverTimeRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OvertimeWithChangeInfo> {
+    }): CancelablePromise<OvertimeWithChangeInfo> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/course_completion/over-time',
@@ -119,25 +151,41 @@ export 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
      */
-    public static engagementOrgsCourseCompletionPerCourseRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * Size of data to return
+         */
         length?: number,
+        /**
+         * Page offset
+         */
         page?: number,
-    ): CancelablePromise<CourseCompletionPerCourse> {
+    }): CancelablePromise<CourseCompletionPerCourse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/course_completion/per-course',
@@ -162,27 +210,43 @@ export 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
      */
-    public static engagementOrgsCoursesTimeAverageRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<AverageOvertime> {
+    }): CancelablePromise<AverageOvertime> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/courses/{course_id}/time/average',
@@ -208,23 +272,33 @@ export 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
      */
-    public static engagementOrgsCoursesTimeDetailRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<TimeDetail> {
+        /**
+         * 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',
@@ -249,27 +323,43 @@ export 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
      */
-    public static engagementOrgsCoursesTimeOverTimeRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OverTimeWithTotal> {
+    }): CancelablePromise<OverTimeWithTotal> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/courses/{course_id}/time/over-time',
@@ -291,31 +381,53 @@ export class EngagementService {
      *
      * 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
      */
-    public static engagementOrgsCoursesTimeUsersRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * 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> {
+    }): CancelablePromise<TimeSpentByUsersInCourse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/courses/{course_id}/time/users',
@@ -343,29 +455,45 @@ export 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
      */
-    public static engagementOrgsCoursesTimeUsersDetailRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<PerLearnerTimeSpentInCourseTree> {
+    }): CancelablePromise<PerLearnerTimeSpentInCourseTree> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/detail',
@@ -393,29 +521,45 @@ export 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
      */
-    public static engagementOrgsCoursesTimeUsersOverTimeRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OverTimeWithTotal> {
+    }): CancelablePromise<OverTimeWithTotal> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/over-time',
@@ -444,23 +588,33 @@ export 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
      */
-    public static engagementOrgsCoursesVideosRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<VideosSpecificCourse> {
+        /**
+         * 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/',
@@ -495,27 +649,43 @@ export 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
      */
-    public static engagementOrgsCoursesVideosOverTimeRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OverTimeWithTotal> {
+    }): CancelablePromise<OverTimeWithTotal> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/courses/{course_id}/videos/over-time',
@@ -546,23 +716,33 @@ export 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
      */
-    public static engagementOrgsCoursesVideosSummaryRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<VideosInCourseSummary> {
+        /**
+         * 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',
@@ -582,23 +762,33 @@ export class EngagementService {
      *
      * 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
      */
-    public static engagementOrgsCoursesVideosUsersRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<WatchedVideosPerUser> {
+        /**
+         * 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',
@@ -620,25 +810,41 @@ export 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
      */
-    public static engagementOrgsTimeAveragePerlearnerPercourseRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<AverageOvertime> {
+    }): CancelablePromise<AverageOvertime> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/time/average-perlearner-percourse',
@@ -663,25 +869,41 @@ export 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
      */
-    public static engagementOrgsTimeAverageWithOverTimeRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<AverageOvertime> {
+    }): CancelablePromise<AverageOvertime> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/time/average-with-over-time',
@@ -712,25 +934,41 @@ export 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
      */
-    public static engagementOrgsTimeOverTimeRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OvertimeWithChangeInfo> {
+    }): CancelablePromise<OvertimeWithChangeInfo> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/time/over-time',
@@ -764,29 +1002,51 @@ export 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
      */
-    public static engagementOrgsTimePerCourseRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * 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> {
+    }): CancelablePromise<TimeSpentPerCourse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/time/per-course',
@@ -816,25 +1076,41 @@ export 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
      */
-    public static engagementOrgsVideosRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * Size of data to return
+         */
         length?: number,
+        /**
+         * Page offset
+         */
         page?: number,
-    ): CancelablePromise<VideoEngagementPerCourse> {
+    }): CancelablePromise<VideoEngagementPerCourse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/videos/',
@@ -870,25 +1146,41 @@ export 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
      */
-    public static engagementOrgsVideosOverTimeRetrieve(
+    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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OverTimeWithTotal> {
+    }): CancelablePromise<OverTimeWithTotal> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/engagement/orgs/{org}/videos/over-time',