@iblai/iblai-api 0.0.1-core

package/src/services/PlatformService.ts

@@ -0,0 +1,763 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Count } from '../models/Count';
+import type { OverTimeWithTotal } from '../models/OverTimeWithTotal';
+import type { PerlearnerCourseProgress } from '../models/PerlearnerCourseProgress';
+import type { VideosCount } from '../models/VideosCount';
+import type { WatchedVideosPerCourse } from '../models/WatchedVideosPerCourse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class PlatformService {
+    /**
+     * Get a list of registered users on the platform.
+     *
+     * This endpoint provides a list of all registered users with basic profile
+     * information including username, name, email, and registration date.
+     *
+     * Returns:
+     * A list of registered users with their profile information.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static platformOrgsRetrieve(
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Completion information per enrolled user
+     *
+     * Gives Percentage of units completed in course
+     *
+     * Query Params
+     * course_id <required>
+     * user_id <optional>
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static platformOrgsCoursesProgressRetrieve(
+        courseId: string,
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/progress/',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Average days used to complete a course
+     *
+     * 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(
+        courseId: string,
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/progress/average-days-to-complete',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Average time used to complete a course in secs
+     *
+     * 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(
+        courseId: string,
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/progress/average-time-to-complete',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Get completion count statistics.
+     *
+     * This endpoint returns completion counts at different levels:
+     * - Platform level: Total users who have completed at least one course
+     * - Course level: Total completions for a specific course
+     * - Learner level: Total courses completed by a specific learner
+     *
+     * Query Parameters:
+     * course_id (str, optional): Filter by course ID
+     * user_id (str, optional): Filter by username or email
+     *
+     * Returns:
+     * A count of completions based on the specified filters.
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static platformOrgsCoursesProgressCompletedRetrieve(
+        courseId: string,
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/progress/completed',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Average of total completed units
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static platformOrgsCoursesProgressCompletionRateRetrieve(
+        courseId: string,
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/progress/completion-rate',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+        });
+    }
+    /**
+     * In Progress means any unit completion in the past 30 days
+     *
+     * For platform :  Total users who have atleast a course in_progress on the platform
+     * For course : Total users
+     * For learner : Total courses in progress
+     *
+     * 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(
+        courseId: string,
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/progress/in-progress',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Started means an enrollment
+     *
+     * For platform :  Total users who have atleast an enrollment
+     * For course : Total users enrolled
+     * For learner : Total courses in progress
+     *
+     * 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(
+        courseId: string,
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/progress/started',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Base class for API views that return a single count value.
+     *
+     * This class formats the response as {"data": {value_key: count}} where
+     * value_key is configurable (defaults to "count").
+     *
+     * 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(
+        courseId: string,
+        org: string,
+        userId: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/grades/passed',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+        });
+    }
+    /**
+     * 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(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+    ): CancelablePromise<PerlearnerCourseProgress> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+            },
+        });
+    }
+    /**
+     * Average days used to complete a course
+     *
+     * 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(
+        courseId: string,
+        org: string,
+        userId: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress/days-to-complete',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+        });
+    }
+    /**
+     * 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(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<Count> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/time/count',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * (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(
+        courseId: string,
+        org: string,
+        userId: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+    ): CancelablePromise<VideosCount> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/videos/count',
+            path: {
+                'course_id': courseId,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+            },
+        });
+    }
+    /**
+     * Count of total videos in a course
+     *
+     * 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(
+        courseId: string,
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/{course_id}/videos/',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Get total count of courses on the platform.
+     *
+     * This endpoint returns the total number of courses available on the platform.
+     *
+     * 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(
+        org: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+    ): CancelablePromise<Count> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/count',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+            },
+        });
+    }
+    /**
+     * List grading information on a per-course basis.
+     *
+     * This endpoint provides grading statistics for all courses, including
+     * average grades and completion rates.
+     *
+     * Returns:
+     * A list of courses with their associated grading metrics.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static platformOrgsCoursesGradesRetrieve(
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/grades',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Get video watch statistics on a per-course basis.
+     *
+     * This endpoint provides a list of courses with aggregated video watch metrics,
+     * including total views and completion percentages.
+     *
+     * Returns:
+     * A list of courses with:
+     * - 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(
+        org: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+    ): CancelablePromise<WatchedVideosPerCourse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/courses/videos',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+            },
+        });
+    }
+    /**
+     * Get completion count statistics.
+     *
+     * This endpoint returns completion counts at different levels:
+     * - Platform level: Total users who have completed at least one course
+     * - Course level: Total completions for a specific course
+     * - Learner level: Total courses completed by a specific learner
+     *
+     * Query Parameters:
+     * course_id (str, optional): Filter by course ID
+     * user_id (str, optional): Filter by username or email
+     *
+     * Returns:
+     * A count of completions based on the specified filters.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static platformOrgsProgressCompletedRetrieve(
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/progress/completed',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Average of total completed units
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static platformOrgsProgressCompletionRateRetrieve(
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/progress/completion-rate',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * In Progress means any unit completion in the past 30 days
+     *
+     * For platform :  Total users who have atleast a course in_progress on the platform
+     * For course : Total users
+     * For learner : Total courses in progress
+     *
+     * 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(
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/progress/in-progress',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Started means an enrollment
+     *
+     * For platform :  Total users who have atleast an enrollment
+     * For course : Total users enrolled
+     * For learner : Total courses in progress
+     *
+     * 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(
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/progress/started',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Total time spent count on the platform within specified range or all time
+     *
+     * Query Params
+     * 1. start_date e.g 2020-10-01
+     * 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(
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/time/count',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Get count of active users on the platform.
+     *
+     * This endpoint returns the number of users who have had activity on the platform,
+     * either for all time or within a specified date range.
+     *
+     * Query Parameters:
+     * start_date (str, optional): Start date for filtering (ISO format)
+     * end_date (str, optional): End date for filtering (ISO format)
+     *
+     * Returns:
+     * 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(
+        org: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OverTimeWithTotal> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/users/active/count',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Get count of registered users on the platform.
+     *
+     * This endpoint returns the number of users registered on the platform,
+     * either for all time or within a specified date range.
+     *
+     * Query Parameters:
+     * start_date (str, optional): Start date for filtering (ISO format)
+     * end_date (str, optional): End date for filtering (ISO format)
+     *
+     * Returns:
+     * 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(
+        org: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OverTimeWithTotal> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/users/count',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Count of users who have completed a course on the platform within specified range or all time
+     *
+     * Query Params
+     * 1. start_date e.g 2020-10-01
+     * 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(
+        org: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OverTimeWithTotal> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/platform/orgs/{org}/users/courses-completed/count',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+}