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

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

@@ -43,25 +43,62 @@ export declare class PerlearnerService {
      * Access Control:
      * - Platform admins can see all learners
      * - Department admins can only see learners in their departments
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate Learner date_joined end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param isEnrolled Filter for users who have at least an enrollment
-     * @param length Size of data to return
-     * @param location Location search string
-     * @param page Page offset
-     * @param platform Platform search string
-     * @param program Program search string
-     * @param search Search string for learner. email, username or full name
-     * @param startDate Learner date_joined start date. ISO 8601
      * @returns NewPerLearnerList
      * @throws ApiError
      */
-    static perlearnerOrgsLearnersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, isEnrolled?: boolean | null, length?: number, location?: string, page?: number, platform?: string, program?: string, search?: string, startDate?: string): CancelablePromise<NewPerLearnerList>;
+    static perlearnerOrgsLearnersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, isEnrolled, length, location, page, platform, program, search, startDate, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Learner date_joined end date. ISO 8601
+         */
+        endDate?: string;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * Filter for users who have at least an enrollment
+         */
+        isEnrolled?: boolean | null;
+        /**
+         * Size of data to return
+         */
+        length?: number;
+        /**
+         * Location search string
+         */
+        location?: string;
+        /**
+         * Page offset
+         */
+        page?: number;
+        /**
+         * Platform search string
+         */
+        platform?: string;
+        /**
+         * Program search string
+         */
+        program?: string;
+        /**
+         * Search string for learner. email, username or full name
+         */
+        search?: string;
+        /**
+         * Learner date_joined start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<NewPerLearnerList>;
     /**
      * List all learners on the platform with aggregated metrics.
      *
@@ -77,136 +114,211 @@ export declare class PerlearnerService {
      *
      * Returns:
      * A paginated list of learners with their associated metrics.
-     * @param org
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param length Size of data to return
-     * @param page Page offset
-     * @param search Search string for learner
      * @returns PerlearnerUserList
      * @throws ApiError
      */
-    static perlearnerOrgsUsersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, search?: string): CancelablePromise<PerlearnerUserList>;
+    static perlearnerOrgsUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
+        org: string;
+        /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number;
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json';
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+        /**
+         * Size of data to return
+         */
+        length?: number;
+        /**
+         * Page offset
+         */
+        page?: number;
+        /**
+         * Search string for learner
+         */
+        search?: string;
+    }): CancelablePromise<PerlearnerUserList>;
     /**
      * Provides information on user enrollments
      *
      * Params
      * user_id e.g developer@ibleducation.com| developer
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns ActivityAPI
      * @throws ApiError
      */
-    static perlearnerOrgsUsersActivityRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<ActivityAPI>;
+    static perlearnerOrgsUsersActivityRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<ActivityAPI>;
     /**
      * Provides about a learner current grade in a course with the course cut
      * Kwargs
      * 1. course_id e.g course-v1:Org+Course4+Run
      * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns PerlearnerGradeWithCutOff
      * @throws ApiError
      */
-    static perlearnerOrgsUsersCoursesGradingCutoffsRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerGradeWithCutOff>;
+    static perlearnerOrgsUsersCoursesGradingCutoffsRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        courseId: string;
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<PerlearnerGradeWithCutOff>;
     /**
      * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns DetailedGradeView
      * @throws ApiError
      */
-    static perlearnerOrgsUsersCoursesGradingDetailRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<DetailedGradeView>;
+    static perlearnerOrgsUsersCoursesGradingDetailRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        courseId: string;
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<DetailedGradeView>;
     /**
      * Query Params
      * 1. course_id e.g course-v1:Org+Course4+Run
      * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns PerlearnerGradeSummary
      * @throws ApiError
      */
-    static perlearnerOrgsUsersCoursesGradingSummaryRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerGradeSummary>;
+    static perlearnerOrgsUsersCoursesGradingSummaryRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        courseId: string;
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<PerlearnerGradeSummary>;
     /**
      * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
-     * @param courseId
-     * @param org
-     * @param userId
      * @returns Value
      * @throws ApiError
      */
-    static perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve(courseId: string, org: string, userId: string): CancelablePromise<Value>;
+    static perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve({ courseId, org, userId, }: {
+        courseId: string;
+        org: string;
+    }): CancelablePromise<Value>;
     /**
      * Provides about a learner current grade in a course with the course cut
      * Kwargs
      * 1. course_id e.g course-v1:Org+Course4+Run
      * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns PerlearnerGradeWithCutOff
      * @throws ApiError
      */
-    static perlearnerOrgsUsersCoursesOverviewGradeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerGradeWithCutOff>;
+    static perlearnerOrgsUsersCoursesOverviewGradeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        courseId: string;
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<PerlearnerGradeWithCutOff>;
     /**
      * Evaluates performance index for platform, per course, per user and per user-per course
      *
      * Query Params
      * course_id <optional>
      * learner_id <optional>
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns Value
      * @throws ApiError
      */
-    static perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Value>;
+    static perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        courseId: string;
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<Value>;
     /**
      * Time spent within a course in secs on a per-day basis
      *
@@ -218,20 +330,30 @@ export declare class PerlearnerService {
      * 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 perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    static perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        courseId: string;
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OverTimeWithTotal>;
     /**
      * List of videos within a course a learner has watched
      *
@@ -240,18 +362,24 @@ export declare class PerlearnerService {
      * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
      *
      * Default result when no query param is added is [], 0
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns PerLearnerCourseVideosWatched
      * @throws ApiError
      */
-    static perlearnerOrgsUsersCoursesVideosRetrieve(courseId: string, org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerLearnerCourseVideosWatched>;
+    static perlearnerOrgsUsersCoursesVideosRetrieve({ courseId, org, userId, departmentId, format, includeMainPlatform, }: {
+        courseId: string;
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<PerLearnerCourseVideosWatched>;
     /**
      * Get video watch counts over time.
      *
@@ -272,36 +400,52 @@ export declare class PerlearnerService {
      * Access Control:
      * - Platform admins can access any video watch data
      * - Learners can access their own video watch data
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OverTimeWithTotal
      * @throws ApiError
      */
-    static perlearnerOrgsUsersCoursesVideosOverTimeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    static perlearnerOrgsUsersCoursesVideosOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        courseId: string;
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OverTimeWithTotal>;
     /**
      * Summary Grading Information for a learner on a per-enrollment basis
      *
      * Query Params
      * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns PerlearnerGradingPerCourseAPI
      * @throws ApiError
      */
-    static perlearnerOrgsUsersGradesPerCourseRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerlearnerGradingPerCourseAPI>;
+    static perlearnerOrgsUsersGradesPerCourseRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<PerlearnerGradingPerCourseAPI>;
     /**
      * Retrieve detailed information about a specific learner.
      *
@@ -325,56 +469,80 @@ export declare class PerlearnerService {
      * - Platform admins can access any learner
      * - Learners can access their own information
      * - Department admins can access learners in their departments
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param meta Include extra analytics information?
-     *
-     * * `y` - y
-     * * `yes` - yes
-     * * `true` - true
-     * * `True` - True
-     * * `n` - n
-     * * `no` - no
-     * * `false` - false
-     * * `False` - False
-     * @param search
      * @returns LearnerInformationAPI
      * @throws ApiError
      */
-    static perlearnerOrgsUsersInfoRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, meta?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', search?: string): CancelablePromise<LearnerInformationAPI>;
+    static perlearnerOrgsUsersInfoRetrieve({ org, userId, departmentId, format, includeMainPlatform, meta, search, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * Include extra analytics information?
+         *
+         * * `y` - y
+         * * `yes` - yes
+         * * `true` - true
+         * * `True` - True
+         * * `n` - n
+         * * `no` - no
+         * * `false` - false
+         * * `False` - False
+         */
+        meta?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
+        search?: string;
+    }): CancelablePromise<LearnerInformationAPI>;
     /**
      * Last course accessed by a learner, includes upto unit information as well
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns PerLearnerLastAccess
      * @throws ApiError
      */
-    static perlearnerOrgsUsersLastAccessRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerLearnerLastAccess>;
+    static perlearnerOrgsUsersLastAccessRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<PerLearnerLastAccess>;
     /**
      * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns Value
      * @throws ApiError
      */
-    static perlearnerOrgsUsersOverviewEngagementIndexRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Value>;
+    static perlearnerOrgsUsersOverviewEngagementIndexRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<Value>;
     /**
      * Get average grade value for platform, course, or user.
      *
@@ -394,36 +562,52 @@ export declare class PerlearnerService {
      * Access Control:
      * - Platform admins can access any grade data
      * - Learners can access their own grade data
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns Average
      * @throws ApiError
      */
-    static perlearnerOrgsUsersOverviewGradesAverageRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
+    static perlearnerOrgsUsersOverviewGradesAverageRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean;
+    }): CancelablePromise<Average>;
     /**
      * Evaluates performance index for platform, per course, per user and per user-per course
      *
      * Query Params
      * course_id <optional>
      * learner_id <optional>
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns Value
      * @throws ApiError
      */
-    static perlearnerOrgsUsersOverviewPerformanceIndexRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Value>;
+    static perlearnerOrgsUsersOverviewPerformanceIndexRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<Value>;
     /**
      * Time spent in secs on a per-day basis
      *
@@ -434,19 +618,29 @@ export declare class PerlearnerService {
      * 4. end_date e.g 2020-10-10
      *
      * Default result when no query param is added is last_7_days (today inclusive)
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OverTimeWithTotal
      * @throws ApiError
      */
-    static perlearnerOrgsUsersOverviewTimeOverTimeRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    static perlearnerOrgsUsersOverviewTimeOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OverTimeWithTotal>;
     /**
      * Get video watch counts over time.
      *
@@ -467,35 +661,55 @@ export declare class PerlearnerService {
      * Access Control:
      * - Platform admins can access any video watch data
      * - Learners can access their own video watch data
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns OverTimeWithTotal
      * @throws ApiError
      */
-    static perlearnerOrgsUsersVideosOverTimeRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    static perlearnerOrgsUsersVideosOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<OverTimeWithTotal>;
     /**
      * Summary Videos watched data for a learner per enrollment
      *
      * Query Params
      * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns PerlearnerEngagementVideosWatchedPerCourse
      * @throws ApiError
      */
-    static perlearnerOrgsUsersVideosPerCourseRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerEngagementVideosWatchedPerCourse>;
+    static perlearnerOrgsUsersVideosPerCourseRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string; /**
+         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+         */
+        departmentId?: number; /**
+         * end date. ISO 8601
+         */
+        endDate?: string; /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json'; /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean; /**
+         * start date. ISO 8601
+         */
+        startDate?: string;
+    }): CancelablePromise<PerlearnerEngagementVideosWatchedPerCourse>;
 }