@iblai/iblai-api 3.34.5-core

package/src/models/TimeDetailChild.ts

@@ -0,0 +1,31 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type TimeDetailChild = {
+    /**
+     * Average time spent
+     */
+    average_time: number;
+    /**
+     * Subsection Display name
+     */
+    display_name: string;
+    /**
+     * Subsection HTML id
+     */
+    id: string;
+    /**
+     * Subsection block id
+     */
+    block_id: string;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+    /**
+     * Total users who accessed the subsection
+     */
+    total_users?: number;
+};
+

package/src/models/TimeDetailData.ts

@@ -0,0 +1,29 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { TimeDetailChild } from './TimeDetailChild';
+export type TimeDetailData = {
+    /**
+     * Average time spent
+     */
+    average_time: number;
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    children?: Array<TimeDetailChild>;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+    /**
+     * Total users who accessed the chapter
+     */
+    total_users?: number;
+};
+

package/src/models/TimeSpentByUsersInCourse.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Pagination } from './Pagination';
+import type { TimeSpentByUsersInCourseData } from './TimeSpentByUsersInCourseData';
+export type TimeSpentByUsersInCourse = {
+    data?: Array<TimeSpentByUsersInCourseData>;
+    pagination: Pagination;
+};
+

package/src/models/TimeSpentByUsersInCourseData.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type TimeSpentByUsersInCourseData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner Name
+     */
+    full_name: string;
+    /**
+     * learner email
+     */
+    email: string;
+    /**
+     * Total assessments
+     */
+    assessments: number;
+    /**
+     * Time spent formatted in seconds
+     */
+    time_spent: string;
+};
+

package/src/models/TimeSpentPerCourse.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Pagination } from './Pagination';
+import type { TimeSpentPerCourseData } from './TimeSpentPerCourseData';
+export type TimeSpentPerCourse = {
+    data?: Array<TimeSpentPerCourseData>;
+    pagination: Pagination;
+};
+

package/src/models/TimeSpentPerCourseData.ts

@@ -0,0 +1,31 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type TimeSpentPerCourseData = {
+    /**
+     * Course name
+     */
+    name: string;
+    /**
+     * Edx Course Id
+     */
+    course_id: string;
+    /**
+     * Total time spent
+     */
+    time_spent: number;
+    /**
+     * Course Start
+     */
+    course_start: string;
+    /**
+     * Course End
+     */
+    course_end: string;
+    /**
+     * Average time spent
+     */
+    average_time: number;
+};
+

package/src/models/TimeSpentPerUserResponse.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type TimeSpentPerUserResponse = {
+    total_seconds: number;
+};
+

package/src/models/TimeSpentUpdateRequest.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type TimeSpentUpdateRequest = {
+    /**
+     * Time when the event occurred, ensure it is UTC (ISO 8601 format)
+     */
+    timestamp: string;
+    course_id?: string;
+    block_id?: string;
+    count: number;
+    url: string;
+    metadata?: any;
+};
+

package/src/models/TimeSpentUpdateResponse.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type TimeSpentUpdateResponse = {
+    success?: boolean;
+    message?: any;
+};
+

package/src/models/TypeEnum.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `email` - email
+ * * `username` - username
+ * * `platform` - platform
+ * * `csv` - csv
+ * * `department` - department
+ * * `pathway` - pathway
+ * * `program` - program
+ */
+export enum TypeEnum {
+    EMAIL = 'email',
+    USERNAME = 'username',
+    PLATFORM = 'platform',
+    CSV = 'csv',
+    DEPARTMENT = 'department',
+    PATHWAY = 'pathway',
+    PROGRAM = 'program',
+}

package/src/models/UploadedImage.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type UploadedImage = {
+    readonly id: number;
+    name?: string | null;
+    readonly image: string;
+};
+

package/src/models/UserInfo.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type UserInfo = {
+    /**
+     * edX user ID
+     */
+    id: number;
+    /**
+     * edX username
+     */
+    username?: string | null;
+    email: string;
+    active: boolean;
+    edx_data: any;
+};
+

package/src/models/UserSkill.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CoursePoint } from './CoursePoint';
+import type { ResourcePoint } from './ResourcePoint';
+import type { Skill } from './Skill';
+export type UserSkill = {
+    skill: Skill;
+    /**
+     * Courses with skill and associated points
+     */
+    courses: Array<CoursePoint>;
+    /**
+     * Resources with skill and associated points
+     */
+    resources: Array<ResourcePoint>;
+    /**
+     * Total points for skill
+     */
+    readonly total_points: number;
+    /**
+     * Percentile of points for user.
+     */
+    percentile?: number;
+};
+

package/src/models/UserSkillPointsPercentile.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type UserSkillPointsPercentile = {
+    username: string;
+    total_points: number;
+    /**
+     * Percentile of points for user. If an `org` was provided, this is the percentile of the user relative to users within the org.
+     */
+    percentile: number;
+};
+

package/src/models/ValidateSourceResponse.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Recipient } from './Recipient';
+/**
+ * Response serializer for source validation
+ */
+export type ValidateSourceResponse = {
+    status: string;
+    valid_count: number;
+    invalid_entries: Array<string>;
+    sample_recipients: Array<Recipient>;
+};
+

package/src/models/Value.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ValueData } from './ValueData';
+export type Value = {
+    data: ValueData;
+};
+

package/src/models/ValueData.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ValueData = {
+    /**
+     * value
+     */
+    value: number;
+};
+

package/src/models/VideoBlock.ts

@@ -0,0 +1,19 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type VideoBlock = {
+    /**
+     * Video name
+     */
+    display_name: string;
+    /**
+     * Video Id
+     */
+    id: string;
+    /**
+     * Total users who have watched the video
+     */
+    total_users?: number;
+};
+

package/src/models/VideoEngagementPerCourse.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Pagination } from './Pagination';
+import type { VideoEngagementPerCourseData } from './VideoEngagementPerCourseData';
+export type VideoEngagementPerCourse = {
+    data?: Array<VideoEngagementPerCourseData>;
+    pagination: Pagination;
+};
+

package/src/models/VideoEngagementPerCourseData.ts

@@ -0,0 +1,35 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type VideoEngagementPerCourseData = {
+    /**
+     * Course name
+     */
+    name: string;
+    /**
+     * edx Course Id
+     */
+    course_id: string;
+    /**
+     * Number of videos in course
+     */
+    num_vids: number;
+    /**
+     * Number of videos watched
+     */
+    num_watched: number;
+    /**
+     * Total time spent by all users watching videos
+     */
+    time_watched: number;
+    /**
+     * Average percentage of videos watched per user per course
+     */
+    avg_percent_watched: number;
+    /**
+     * Average time spent per learner
+     */
+    avg_time_watched: number;
+};
+

package/src/models/VideosCount.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { VideosCountData } from './VideosCountData';
+export type VideosCount = {
+    data?: VideosCountData;
+};
+

package/src/models/VideosCountData.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type VideosCountData = {
+    /**
+     * Total videos (videos watched / Total Course Videos)
+     */
+    count: string;
+};
+

package/src/models/VideosInCourseSummary.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { VideosInCourseSummaryData } from './VideosInCourseSummaryData';
+export type VideosInCourseSummary = {
+    data?: Array<VideosInCourseSummaryData>;
+};
+

package/src/models/VideosInCourseSummaryData.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { VideosWatchedSubSection } from './VideosWatchedSubSection';
+export type VideosInCourseSummaryData = {
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    subsections?: Array<VideosWatchedSubSection>;
+};
+

package/src/models/VideosSpecificCourse.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { VideosSpecificCourseData } from './VideosSpecificCourseData';
+export type VideosSpecificCourse = {
+    data?: Array<VideosSpecificCourseData>;
+};
+

package/src/models/VideosSpecificCourseData.ts

@@ -0,0 +1,31 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type VideosSpecificCourseData = {
+    /**
+     * Course name
+     */
+    display_name: string;
+    /**
+     * Video Id
+     */
+    id: string;
+    /**
+     * Video duration
+     */
+    duration: number;
+    /**
+     * Total time spent by users watching
+     */
+    total_time: number;
+    /**
+     * Total users who have watched this video
+     */
+    total_users: number;
+    /**
+     * Average time spent per learner
+     */
+    average_time: number;
+};
+

package/src/models/VideosWatchedSubSection.ts

@@ -0,0 +1,24 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { VideoBlock } from './VideoBlock';
+export type VideosWatchedSubSection = {
+    /**
+     * Subsection name
+     */
+    display_name: string;
+    /**
+     * Subsection Id
+     */
+    id: string;
+    /**
+     * Total videos watched. N/A if no record found
+     */
+    total_watch: string;
+    /**
+     * Videos
+     */
+    videos?: Array<VideoBlock>;
+};
+

package/src/models/WatchedVideosPerUser.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { WatchedVideosPerUserData } from './WatchedVideosPerUserData';
+export type WatchedVideosPerUser = {
+    data?: Array<WatchedVideosPerUserData>;
+    /**
+     * Total rows
+     */
+    total?: number;
+};
+

package/src/models/WatchedVideosPerUserData.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type WatchedVideosPerUserData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner fullname
+     */
+    full_name: string;
+    /**
+     * Videos watched count
+     */
+    count: number;
+    /**
+     * Percentage ...
+     */
+    percentage: number;
+};
+

package/src/services/AnalyticsService.ts

@@ -0,0 +1,94 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { TimeSpentPerUserResponse } from '../models/TimeSpentPerUserResponse';
+import type { TimeSpentUpdateRequest } from '../models/TimeSpentUpdateRequest';
+import type { TimeSpentUpdateResponse } from '../models/TimeSpentUpdateResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class AnalyticsService {
+    /**
+     * Update time spent tracking data from client-side events.
+     *
+     * This endpoint receives time spent data collected on the client side and
+     * stores it in the analytics database. It requires a valid authentication token.
+     *
+     * Methods:
+     * POST: Submit time spent tracking data
+     *
+     *
+     *
+     * Returns:
+     * A response indicating success or failure:
+     * {
+         * "success": true|false,
+         * "message": "Error message if failed" (optional)
+         * }
+         *
+         * Error Responses:
+         * 400 Bad Request: If the request data is invalid or the API is disabled
+         *
+         * Notes:
+         * This API must be enabled via the ENABLE_TIME_SPENT_UPDATE_API setting.
+         * @param org
+         * @param requestBody
+         * @returns TimeSpentUpdateResponse
+         * @throws ApiError
+         */
+        public static analyticsOrgsTimeUpdateCreate(
+            org: string,
+            requestBody: TimeSpentUpdateRequest,
+        ): CancelablePromise<TimeSpentUpdateResponse> {
+            return __request(OpenAPI, {
+                method: 'POST',
+                url: '/api/analytics/orgs/{org}/time/update/',
+                path: {
+                    'org': org,
+                },
+                body: requestBody,
+                mediaType: 'application/json',
+            });
+        }
+        /**
+         * Get total time spent for current user
+         *
+         * Returns the total time spent (in seconds) for the current authenticated user.
+         * Can be filtered by platform, date range, course ID, and URL.
+         *
+         * @param courseId Course ID to filter by (can be partial)
+         * @param endDate End date for time range (YYYY-MM-DD)
+         * @param includeMainPlatform Whether to include main platform data
+         * @param platform Platform name or key to filter by
+         * @param startDate Start date for time range (YYYY-MM-DD)
+         * @param url URL to filter by (can be partial)
+         * @returns TimeSpentPerUserResponse
+         * @throws ApiError
+         */
+        public static analyticsTimeSpentUserRetrieve(
+            courseId?: string,
+            endDate?: string,
+            includeMainPlatform: boolean = true,
+            platform?: string,
+            startDate?: string,
+            url?: string,
+        ): CancelablePromise<TimeSpentPerUserResponse> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/analytics/time-spent/user/',
+                query: {
+                    'course_id': courseId,
+                    'end_date': endDate,
+                    'include_main_platform': includeMainPlatform,
+                    'platform': platform,
+                    'start_date': startDate,
+                    'url': url,
+                },
+                errors: {
+                    400: `Bad request`,
+                    401: `Unauthorized`,
+                },
+            });
+        }
+    }