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

package/src/services/PlatformService.ts

@@ -19,13 +19,14 @@ export class PlatformService {
      *
      * Returns:
      * A list of registered users with their profile information.
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsRetrieve(
+    public static platformOrgsRetrieve({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/',
@@ -42,15 +43,16 @@ export class PlatformService {
      * Query Params
      * course_id <required>
      * user_id <optional>
-     * @param courseId
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesProgressRetrieve(
+    public static platformOrgsCoursesProgressRetrieve({
+        courseId,
+        org,
+    }: {
         courseId: string,
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/progress/',
@@ -65,15 +67,16 @@ export class PlatformService {
      *
      * Query Params
      * 1. course_id <optional> e.g course-v1:Org+Course4+Run
-     * @param courseId
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesProgressAverageDaysToCompleteRetrieve(
+    public static platformOrgsCoursesProgressAverageDaysToCompleteRetrieve({
+        courseId,
+        org,
+    }: {
         courseId: string,
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/progress/average-days-to-complete',
@@ -88,15 +91,16 @@ export class PlatformService {
      *
      * Query Params
      * 1. course_id <optional> e.g course-v1:Org+Course4+Run
-     * @param courseId
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesProgressAverageTimeToCompleteRetrieve(
+    public static platformOrgsCoursesProgressAverageTimeToCompleteRetrieve({
+        courseId,
+        org,
+    }: {
         courseId: string,
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/progress/average-time-to-complete',
@@ -120,15 +124,16 @@ export class PlatformService {
      *
      * Returns:
      * A count of completions based on the specified filters.
-     * @param courseId
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesProgressCompletedRetrieve(
+    public static platformOrgsCoursesProgressCompletedRetrieve({
+        courseId,
+        org,
+    }: {
         courseId: string,
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/progress/completed',
@@ -140,15 +145,16 @@ export class PlatformService {
     }
     /**
      * Average of total completed units
-     * @param courseId
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesProgressCompletionRateRetrieve(
+    public static platformOrgsCoursesProgressCompletionRateRetrieve({
+        courseId,
+        org,
+    }: {
         courseId: string,
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/progress/completion-rate',
@@ -168,15 +174,16 @@ export class PlatformService {
      * Query Params
      * 1. course_id <optional> e.g course-v1:Org+Course4+Run
      * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
-     * @param courseId
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesProgressInProgressRetrieve(
+    public static platformOrgsCoursesProgressInProgressRetrieve({
+        courseId,
+        org,
+    }: {
         courseId: string,
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/progress/in-progress',
@@ -196,15 +203,16 @@ export class PlatformService {
      * Query Params
      * 1. course_id <optional> e.g course-v1:Org+Course4+Run
      * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
-     * @param courseId
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesProgressStartedRetrieve(
+    public static platformOrgsCoursesProgressStartedRetrieve({
+        courseId,
+        org,
+    }: {
         courseId: string,
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/progress/started',
@@ -222,17 +230,18 @@ export class PlatformService {
      *
      * Attributes:
      * value_key: The key used in the response for the count value
-     * @param courseId
-     * @param org
-     * @param userId
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesUsersGradesPassedRetrieve(
+    public static platformOrgsCoursesUsersGradesPassedRetrieve({
+        courseId,
+        org,
+        userId,
+    }: {
         courseId: string,
         org: string,
         userId: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/grades/passed',
@@ -245,25 +254,35 @@ export class PlatformService {
     }
     /**
      * Gives Percentage of units completed in course for a specific learner
-     * @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 PerlearnerCourseProgress
      * @throws ApiError
      */
-    public static platformOrgsCoursesUsersProgressRetrieve(
+    public static platformOrgsCoursesUsersProgressRetrieve({
+        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<PerlearnerCourseProgress> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<PerlearnerCourseProgress> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress',
@@ -284,17 +303,18 @@ export class PlatformService {
      *
      * Query Params
      * 1. course_id <optional> e.g course-v1:Org+Course4+Run
-     * @param courseId
-     * @param org
-     * @param userId
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesUsersProgressDaysToCompleteRetrieve(
+    public static platformOrgsCoursesUsersProgressDaysToCompleteRetrieve({
+        courseId,
+        org,
+        userId,
+    }: {
         courseId: string,
         org: string,
         userId: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress/days-to-complete',
@@ -307,29 +327,45 @@ export class PlatformService {
     }
     /**
      * Time spent count in seconds within a course by a learner
-     * @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 Count
      * @throws ApiError
      */
-    public static platformOrgsCoursesUsersTimeCountRetrieve(
+    public static platformOrgsCoursesUsersTimeCountRetrieve({
+        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<Count> {
+    }): CancelablePromise<Count> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/time/count',
@@ -349,25 +385,35 @@ export class PlatformService {
     }
     /**
      * (Total videos watched / Total Course Videos) or Total Videos watched in a course by a learner
-     * @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 VideosCount
      * @throws ApiError
      */
-    public static platformOrgsCoursesUsersVideosCountRetrieve(
+    public static platformOrgsCoursesUsersVideosCountRetrieve({
+        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<VideosCount> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<VideosCount> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/videos/count',
@@ -388,15 +434,16 @@ export class PlatformService {
      *
      * Query Params
      * course_id  e.g course-v1:Org+Course4+Run
-     * @param courseId
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesVideosRetrieve2(
+    public static platformOrgsCoursesVideosRetrieve2({
+        courseId,
+        org,
+    }: {
         courseId: string,
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/{course_id}/videos/',
@@ -413,21 +460,31 @@ export class PlatformService {
      *
      * Returns:
      * The total count of courses on the platform.
-     * @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 Count
      * @throws ApiError
      */
-    public static platformOrgsCoursesCountRetrieve(
+    public static platformOrgsCoursesCountRetrieve({
+        org,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+    }: {
         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<Count> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<Count> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/count',
@@ -449,13 +506,14 @@ export class PlatformService {
      *
      * Returns:
      * A list of courses with their associated grading metrics.
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsCoursesGradesRetrieve(
+    public static platformOrgsCoursesGradesRetrieve({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/grades',
@@ -475,21 +533,31 @@ export class PlatformService {
      * - Course identification (ID and name)
      * - Video watch count
      * - Percentage of total videos watched
-     * @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 WatchedVideosPerCourse
      * @throws ApiError
      */
-    public static platformOrgsCoursesVideosRetrieve(
+    public static platformOrgsCoursesVideosRetrieve({
+        org,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+    }: {
         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<WatchedVideosPerCourse> {
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+    }): CancelablePromise<WatchedVideosPerCourse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/courses/videos',
@@ -517,13 +585,14 @@ export class PlatformService {
      *
      * Returns:
      * A count of completions based on the specified filters.
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsProgressCompletedRetrieve(
+    public static platformOrgsProgressCompletedRetrieve({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/progress/completed',
@@ -534,13 +603,14 @@ export class PlatformService {
     }
     /**
      * Average of total completed units
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsProgressCompletionRateRetrieve(
+    public static platformOrgsProgressCompletionRateRetrieve({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/progress/completion-rate',
@@ -559,13 +629,14 @@ export class PlatformService {
      * Query Params
      * 1. course_id <optional> e.g course-v1:Org+Course4+Run
      * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsProgressInProgressRetrieve(
+    public static platformOrgsProgressInProgressRetrieve({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/progress/in-progress',
@@ -584,13 +655,14 @@ export class PlatformService {
      * Query Params
      * 1. course_id <optional> e.g course-v1:Org+Course4+Run
      * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsProgressStartedRetrieve(
+    public static platformOrgsProgressStartedRetrieve({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/progress/started',
@@ -607,13 +679,14 @@ export class PlatformService {
      * 2. end_date e.g 2020-10-10
      *
      * Default result is all time
-     * @param org
      * @returns any No response body
      * @throws ApiError
      */
-    public static platformOrgsTimeCountRetrieve(
+    public static platformOrgsTimeCountRetrieve({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<any> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/platform/orgs/{org}/time/count',
@@ -636,25 +709,41 @@ export class PlatformService {
      * The count of active users and change metrics compared to previous periods.
      *
      * Default behavior returns the count for all time if no date range is 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 OverTimeWithTotal
      * @throws ApiError
      */
-    public static platformOrgsUsersActiveCountRetrieve(
+    public static platformOrgsUsersActiveCountRetrieve({
+        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/platform/orgs/{org}/users/active/count',
@@ -684,25 +773,41 @@ export class PlatformService {
      * The count of registered users and change metrics compared to previous periods.
      *
      * Default behavior returns the count for all time if no date range is 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 OverTimeWithTotal
      * @throws ApiError
      */
-    public static platformOrgsUsersCountRetrieve(
+    public static platformOrgsUsersCountRetrieve({
+        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/platform/orgs/{org}/users/count',
@@ -726,25 +831,41 @@ export class PlatformService {
      * 2. end_date e.g 2020-10-10
      *
      * Default is all 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 startDate start date. ISO 8601
      * @returns OverTimeWithTotal
      * @throws ApiError
      */
-    public static platformOrgsUsersCoursesCompletedCountRetrieve(
+    public static platformOrgsUsersCoursesCompletedCountRetrieve({
+        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/platform/orgs/{org}/users/courses-completed/count',