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

package/src/services/PerlearnerService.ts

@@ -49,39 +49,76 @@ export 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
      */
-    public static perlearnerOrgsLearnersRetrieve(
+    public static perlearnerOrgsLearnersRetrieve({
+        org,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        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',
-        includeMainPlatform: boolean = true,
+        /**
+         * 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> {
+    }): CancelablePromise<NewPerLearnerList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/learners',
@@ -119,27 +156,46 @@ export 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
      */
-    public static perlearnerOrgsUsersRetrieve(
+    public static perlearnerOrgsUsersRetrieve({
+        org,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+        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',
-        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,
+        /**
+         * Search string for learner
+         */
         search?: string,
-    ): CancelablePromise<PerlearnerUserList> {
+    }): CancelablePromise<PerlearnerUserList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users',
@@ -161,23 +217,33 @@ export class PerlearnerService {
      *
      * Params
      * user_id e.g developer@ibleducation.com| developer
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns ActivityAPI
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersActivityRetrieve(
+    public static perlearnerOrgsUsersActivityRetrieve({
+        org,
+        userId,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+    }: {
         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,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<ActivityAPI> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<ActivityAPI> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/activity/',
@@ -197,29 +263,45 @@ export class PerlearnerService {
      * Kwargs
      * 1. course_id e.g course-v1:Org+Course4+Run
      * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns PerlearnerGradeWithCutOff
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersCoursesGradingCutoffsRetrieve(
+    public static perlearnerOrgsUsersCoursesGradingCutoffsRetrieve({
+        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<PerlearnerGradeWithCutOff> {
+    }): CancelablePromise<PerlearnerGradeWithCutOff> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/cutoffs',
@@ -239,29 +321,45 @@ export class PerlearnerService {
     }
     /**
      * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns DetailedGradeView
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersCoursesGradingDetailRetrieve(
+    public static perlearnerOrgsUsersCoursesGradingDetailRetrieve({
+        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<DetailedGradeView> {
+    }): CancelablePromise<DetailedGradeView> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/detail',
@@ -283,29 +381,45 @@ export class PerlearnerService {
      * Query Params
      * 1. course_id e.g course-v1:Org+Course4+Run
      * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns PerlearnerGradeSummary
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersCoursesGradingSummaryRetrieve(
+    public static perlearnerOrgsUsersCoursesGradingSummaryRetrieve({
+        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<PerlearnerGradeSummary> {
+    }): CancelablePromise<PerlearnerGradeSummary> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/grading/summary',
@@ -325,17 +439,18 @@ export class PerlearnerService {
     }
     /**
      * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
-     * @param courseId
-     * @param org
-     * @param userId
      * @returns Value
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve(
+    public static perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve({
+        courseId,
+        org,
+        userId,
+    }: {
         courseId: string,
         org: string,
         userId: string,
-    ): CancelablePromise<Value> {
+    }): CancelablePromise<Value> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/engagement-index',
@@ -351,29 +466,45 @@ export class PerlearnerService {
      * Kwargs
      * 1. course_id e.g course-v1:Org+Course4+Run
      * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns PerlearnerGradeWithCutOff
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersCoursesOverviewGradeRetrieve(
+    public static perlearnerOrgsUsersCoursesOverviewGradeRetrieve({
+        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<PerlearnerGradeWithCutOff> {
+    }): CancelablePromise<PerlearnerGradeWithCutOff> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/grade',
@@ -397,29 +528,45 @@ export class PerlearnerService {
      * Query Params
      * course_id <optional>
      * learner_id <optional>
-     * @param courseId
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns Value
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve(
+    public static perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve({
+        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<Value> {
+    }): CancelablePromise<Value> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/performance-index',
@@ -448,29 +595,45 @@ export 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
      */
-    public static perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve(
+    public static perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve({
+        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/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/overview/time/over-time',
@@ -496,25 +659,35 @@ export 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
      */
-    public static perlearnerOrgsUsersCoursesVideosRetrieve(
+    public static perlearnerOrgsUsersCoursesVideosRetrieve({
+        courseId,
+        org,
+        userId,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+    }: {
         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,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<PerLearnerCourseVideosWatched> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<PerLearnerCourseVideosWatched> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/videos',
@@ -550,29 +723,45 @@ export 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
      */
-    public static perlearnerOrgsUsersCoursesVideosOverTimeRetrieve(
+    public static perlearnerOrgsUsersCoursesVideosOverTimeRetrieve({
+        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/perlearner/orgs/{org}/users/{user_id}/courses/{course_id}/videos/over-time',
@@ -595,23 +784,33 @@ export class PerlearnerService {
      *
      * Query Params
      * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns PerlearnerGradingPerCourseAPI
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersGradesPerCourseRetrieve(
+    public static perlearnerOrgsUsersGradesPerCourseRetrieve({
+        org,
+        userId,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+    }: {
         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,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<PerlearnerGradingPerCourseAPI> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<PerlearnerGradingPerCourseAPI> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/grades/per-course',
@@ -649,36 +848,49 @@ export 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
      */
-    public static perlearnerOrgsUsersInfoRetrieve(
+    public static perlearnerOrgsUsersInfoRetrieve({
+        org,
+        userId,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+        meta = 'n',
+        search,
+    }: {
         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,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
-        meta: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'n',
+        /**
+         * 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> {
+    }): CancelablePromise<LearnerInformationAPI> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/info',
@@ -697,23 +909,33 @@ export class PerlearnerService {
     }
     /**
      * Last course accessed by a learner, includes upto unit information as well
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
      * @returns PerLearnerLastAccess
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersLastAccessRetrieve(
+    public static perlearnerOrgsUsersLastAccessRetrieve({
+        org,
+        userId,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+    }: {
         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,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<PerLearnerLastAccess> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<PerLearnerLastAccess> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/last-access',
@@ -730,27 +952,43 @@ export class PerlearnerService {
     }
     /**
      * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns Value
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersOverviewEngagementIndexRetrieve(
+    public static perlearnerOrgsUsersOverviewEngagementIndexRetrieve({
+        org,
+        userId,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         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<Value> {
+    }): CancelablePromise<Value> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/overview/engagement-index',
@@ -786,23 +1024,33 @@ export 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
      */
-    public static perlearnerOrgsUsersOverviewGradesAverageRetrieve(
+    public static perlearnerOrgsUsersOverviewGradesAverageRetrieve({
+        org,
+        userId,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+    }: {
         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,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
-    ): CancelablePromise<Average> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<Average> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/overview/grades/average',
@@ -823,27 +1071,43 @@ export class PerlearnerService {
      * Query Params
      * course_id <optional>
      * learner_id <optional>
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns Value
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersOverviewPerformanceIndexRetrieve(
+    public static perlearnerOrgsUsersOverviewPerformanceIndexRetrieve({
+        org,
+        userId,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         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<Value> {
+    }): CancelablePromise<Value> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/overview/performance-index',
@@ -870,27 +1134,43 @@ export 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
      */
-    public static perlearnerOrgsUsersOverviewTimeOverTimeRetrieve(
+    public static perlearnerOrgsUsersOverviewTimeOverTimeRetrieve({
+        org,
+        userId,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         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/perlearner/orgs/{org}/users/{user_id}/overview/time/over-time',
@@ -927,27 +1207,43 @@ export 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
      */
-    public static perlearnerOrgsUsersVideosOverTimeRetrieve(
+    public static perlearnerOrgsUsersVideosOverTimeRetrieve({
+        org,
+        userId,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         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/perlearner/orgs/{org}/users/{user_id}/videos/over-time',
@@ -969,27 +1265,43 @@ export class PerlearnerService {
      *
      * Query Params
      * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
-     * @param org
-     * @param userId
-     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-     * @param endDate end date. ISO 8601
-     * @param format Format
-     *
-     * * `json` - json
-     * @param includeMainPlatform Include main platform data
-     * @param startDate start date. ISO 8601
      * @returns PerlearnerEngagementVideosWatchedPerCourse
      * @throws ApiError
      */
-    public static perlearnerOrgsUsersVideosPerCourseRetrieve(
+    public static perlearnerOrgsUsersVideosPerCourseRetrieve({
+        org,
+        userId,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         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<PerlearnerEngagementVideosWatchedPerCourse> {
+    }): CancelablePromise<PerlearnerEngagementVideosWatchedPerCourse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/perlearner/orgs/{org}/users/{user_id}/videos/per-course',