@iblai/iblai-api 3.58.0-core → 3.59.0-ai-plus

package/src/services/OverviewService.ts

@@ -1,423 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { Average } from '../models/Average';
-import type { CourseCompletionSummaryOvertime } from '../models/CourseCompletionSummaryOvertime';
-import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
-import type { PerlearnerUserList } from '../models/PerlearnerUserList';
-import type { TimeSpentPerCourse } from '../models/TimeSpentPerCourse';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class OverviewService {
-    /**
-     * Get active user counts over time.
-     *
-     * This endpoint provides daily counts of active users (users with known activity)
-     * over a specified time period.
-     *
-     * Query Parameters:
-     * start_date (str, optional): Start date for the time range (ISO format)
-     * end_date (str, optional): End date for the time range (ISO format)
-     *
-     * Returns:
-     * Daily active user counts over the specified time period, with change metrics
-     * compared to previous periods.
-     *
-     * Default time range is the last 7 days if no dates are specified.
-     *
-     * An active user is defined as a user with any activity within the past 30 days.
-     * @returns OvertimeWithChangeInfo
-     * @throws ApiError
-     */
-    public static overviewOrgsActiveUsersRetrieve({
-        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
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<OvertimeWithChangeInfo> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/overview/orgs/{org}/active-users',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * Get average grade value for platform, course, or user.
-     *
-     * This endpoint returns the average grade at different levels:
-     * - Platform level: Average grade across all courses
-     * - Course level: Average grade for a specific course
-     * - Learner level: Average grade for a specific learner
-     * - Course-learner level: Grade for a specific learner in a specific course
-     *
-     * Query Parameters:
-     * course_id (str, optional): Filter by course ID
-     * learner_id (str, optional): Filter by username or email
-     *
-     * Returns:
-     * The average grade value based on the specified filters.
-     *
-     * Access Control:
-     * - Platform admins can access any grade data
-     * - Learners can access their own grade data
-     * @returns Average
-     * @throws ApiError
-     */
-    public static overviewOrgsAverageGradeRetrieve({
-        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
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-    }): CancelablePromise<Average> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/overview/orgs/{org}/average-grade',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-            },
-        });
-    }
-    /**
-     * Get course completion summary metrics over time.
-     *
-     * This endpoint provides completion statistics across the platform over a
-     * specified time period, including daily completion counts and overall metrics.
-     *
-     * Query Parameters:
-     * start_date (str): Start date for the time range (ISO format)
-     * end_date (str): End date for the time range (ISO format)
-     *
-     * Returns:
-     * Completion data including:
-     * - Daily completion counts over time
-     * - Total unique user count
-     * - Total completion count
-     * - Completion percentage
-     * - Change metrics compared to previous periods
-     *
-     * Default time range is the last 7 days if no dates are specified.
-     * @returns CourseCompletionSummaryOvertime
-     * @throws ApiError
-     */
-    public static overviewOrgsCoursesCompletionsRetrieve({
-        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
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<CourseCompletionSummaryOvertime> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/overview/orgs/{org}/courses/completions',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * List all learners on the platform with aggregated metrics.
-     *
-     * This endpoint returns a paginated list of all learners with key metrics including:
-     * - Enrollment counts
-     * - Completion counts
-     * - Time spent on platform
-     *
-     * Query Parameters:
-     * page (int): Page number for pagination
-     * length (int): Number of items per page
-     * search (str): Filter learners by username, email, or name
-     *
-     * Returns:
-     * A paginated list of learners with their associated metrics.
-     * @returns PerlearnerUserList
-     * @throws ApiError
-     */
-    public static overviewOrgsLearnersRetrieve({
-        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
-         */
-        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> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/overview/orgs/{org}/learners',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'length': length,
-                'page': page,
-                'search': search,
-            },
-        });
-    }
-    /**
-     * Get time spent statistics on a per-course basis.
-     *
-     * This endpoint provides a paginated list of courses with the total time
-     * spent by users in each course.
-     *
-     * Query Parameters:
-     * start_date (str, optional): Start date for filtering (ISO format)
-     * end_date (str, optional): End date for filtering (ISO format)
-     * page (int, optional): Page number for pagination
-     * length (int, optional): Number of items per page
-     *
-     * Returns:
-     * A paginated list of courses with:
-     * - Course identification (ID and name)
-     * - Total time spent (in seconds)
-     * - Formatted time spent (human-readable)
-     * - Percentage of total platform time
-     * @returns TimeSpentPerCourse
-     * @throws ApiError
-     */
-    public static overviewOrgsMostActiveCoursesRetrieve({
-        org,
-        departmentId,
-        endDate,
-        format = 'json',
-        includeMainPlatform = true,
-        length,
-        page,
-        startDate,
-    }: {
-        org: string,
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number,
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string,
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * Size of data to return
-         */
-        length?: number,
-        /**
-         * Page offset
-         */
-        page?: number,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<TimeSpentPerCourse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/overview/orgs/{org}/most-active-courses',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'length': length,
-                'page': page,
-                'start_date': startDate,
-            },
-        });
-    }
-    /**
-     * Get registered user counts over time.
-     *
-     * This endpoint provides daily counts of new user registrations over a
-     * specified time period.
-     *
-     * Query Parameters:
-     * start_date (str, optional): Start date for the time range (ISO format)
-     * end_date (str, optional): End date for the time range (ISO format)
-     *
-     * Returns:
-     * Daily registration counts over the specified time period, with change metrics
-     * compared to previous periods.
-     *
-     * Default time range is the last 7 days if no dates are specified.
-     * @returns OvertimeWithChangeInfo
-     * @throws ApiError
-     */
-    public static overviewOrgsRegisteredUsersRetrieve({
-        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
-         */
-        format?: 'json',
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean,
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string,
-    }): CancelablePromise<OvertimeWithChangeInfo> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/api/overview/orgs/{org}/registered-users',
-            path: {
-                'org': org,
-            },
-            query: {
-                'department_id': departmentId,
-                'end_date': endDate,
-                'format': format,
-                'include_main_platform': includeMainPlatform,
-                'start_date': startDate,
-            },
-        });
-    }
-}