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

package/dist/types/services/RolesService.d.ts

@@ -1,59 +0,0 @@
-import type { DesiredRole } from '../models/DesiredRole';
-import type { ReportedRole } from '../models/ReportedRole';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class RolesService {
-    /**
-     * Retrieve a user's desired role information.
-     *
-     * This endpoint returns the role and skills that a user has indicated
-     * they want to develop or acquire. This represents the user's career
-     * goals and learning objectives.
-     *
-     * Path Parameters:
-     * org (str): The platform/organization identifier
-     * username (str): The username of the user to retrieve role information for
-     *
-     * Returns:
-     * The user's desired role information including:
-     * - Target role title
-     * - Skills needed for the role
-     * - Current progress toward skill acquisition
-     *
-     * Error Responses:
-     * 400 Bad Request: If the user doesn't exist in the platform or has no desired role
-     * 404 Not Found: If the specified platform doesn't exist
-     * @returns DesiredRole
-     * @throws ApiError
-     */
-    static rolesPlatformOrgsRolesUsersDesiredRolesRetrieve({ org, username, }: {
-        org: string;
-        username: string;
-    }): CancelablePromise<DesiredRole>;
-    /**
-     * Retrieve a user's reported role information.
-     *
-     * This endpoint returns the role and skills that a user has reported
-     * having in their profile. This represents the user's current skills
-     * and professional role.
-     *
-     * Path Parameters:
-     * org (str): The platform/organization identifier
-     * username (str): The username of the user to retrieve role information for
-     *
-     * Returns:
-     * The user's reported role information including:
-     * - Role title
-     * - Skills associated with the role
-     * - Experience level
-     *
-     * Error Responses:
-     * 400 Bad Request: If the user doesn't exist in the platform or has no reported role
-     * 404 Not Found: If the specified platform doesn't exist
-     * @returns ReportedRole
-     * @throws ApiError
-     */
-    static rolesPlatformOrgsRolesUsersReportedRolesRetrieve({ org, username, }: {
-        org: string;
-        username: string;
-    }): CancelablePromise<ReportedRole>;
-}

package/dist/types/services/UserGroupsService.d.ts

@@ -1,86 +0,0 @@
-import type { GroupList } from '../models/GroupList';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class UserGroupsService {
-    /**
-     * Get a list of user groups with metrics and filtering options.
-     *
-     * This endpoint provides a paginated list of user groups with aggregated metrics
-     * about learner performance, course completions, and skill acquisition.
-     *
-     * This endpoint uses DM token authentication and respects department-based
-     * access controls.
-     *
-     * Query Parameters:
-     * page (int, optional): Page number for pagination
-     * length (int, optional): Number of items per page
-     * program (str, optional): Filter by program
-     * pathway (str, optional): Filter by pathway
-     * groups (list, optional): Filter by group names
-     * location (str, optional): Filter by location
-     * is_enrolled (bool, optional): Filter for groups with enrolled users
-     * start_date (date, optional): Filter by learner join date (start range)
-     * end_date (date, optional): Filter by learner join date (end range)
-     *
-     * Returns:
-     * A paginated list of user groups with comprehensive metrics.
-     *
-     * Access Control:
-     * - Platform admins can see all groups
-     * - Department admins can only see groups in their departments
-     * @returns GroupList
-     * @throws ApiError
-     */
-    static userGroupsOrgsRetrieve({ key, departmentId, endDate, format, groups, includeMainPlatform, isEnrolled, length, location, page, pathway, program, startDate, }: {
-        key: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Filter by learners date_joined. Start date. ISO 8601
-         */
-        endDate?: string;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
-         */
-        groups?: Array<string>;
-        /**
-         * 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;
-        /**
-         * Pathway string
-         */
-        pathway?: string;
-        /**
-         * Program search string
-         */
-        program?: string;
-        /**
-         * Filter by learners date_joined. Start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<GroupList>;
-}

package/src/models/NetRevenueOverTime.ts

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

package/src/models/Order.ts

@@ -1,27 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type Order = {
-    /**
-     * WP Customer ID
-     */
-    customer_id: number;
-    /**
-     * WooCommerce order status
-     */
-    status: string;
-    /**
-     * WooCommerce order date
-     */
-    order_date: string;
-    /**
-     * Total discount by coupons
-     */
-    coupons: string;
-    /**
-     * Net order value
-     */
-    value: string;
-};
-

package/src/models/Product.ts

@@ -1,27 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type Product = {
-    /**
-     * Product Name
-     */
-    name: string;
-    /**
-     * Product type (Course or Program)
-     */
-    type: string;
-    /**
-     * Product slug
-     */
-    slug: string;
-    /**
-     * DateTime product was created
-     */
-    created_on: string;
-    /**
-     * Product cost
-     */
-    price: string;
-};
-

package/src/models/ProductTable.ts

@@ -1,31 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type ProductTable = {
-    /**
-     * Product name
-     */
-    name: string;
-    /**
-     * Product Type (Course or Program)
-     */
-    type: string;
-    /**
-     * Gross sales for product
-     */
-    total_sales: number;
-    /**
-     * Total of all coupons for product
-     */
-    coupons: number;
-    /**
-     * Net sales for product
-     */
-    net_sales: number;
-    /**
-     * Quantity of product purchased
-     */
-    orders: number;
-};
-

package/src/models/RevenueByProduct.ts

@@ -1,11 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { ProductTable } from './ProductTable';
-import type { Summary } from './Summary';
-export type RevenueByProduct = {
-    product_table?: Array<ProductTable>;
-    summary?: Summary;
-};
-

package/src/models/Summary.ts

@@ -1,23 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type Summary = {
-    /**
-     * Total number of products
-     */
-    num_products: number;
-    /**
-     * Total number of items ordered
-     */
-    num_orders: number;
-    /**
-     * Total Net revenue
-     */
-    net_revenue: number;
-    /**
-     * Average Net value per item sold
-     */
-    avg_order_value: number;
-};
-

package/src/services/AnalyticsService.ts

@@ -1,132 +0,0 @@
-/* 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.
-         * @returns TimeSpentUpdateResponse
-         * @throws ApiError
-         */
-        public static analyticsOrgsTimeUpdateCreate({
-            org,
-            requestBody,
-        }: {
-            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, URL, mentor UUID, and session UUID.
-         *
-         * @returns TimeSpentPerUserResponse
-         * @throws ApiError
-         */
-        public static analyticsTimeSpentUserRetrieve({
-            courseId,
-            endDate,
-            includeMainPlatform = true,
-            learnerId,
-            mentorUuid,
-            platform,
-            sessionUuid,
-            startDate,
-            url,
-        }: {
-            /**
-             * Course ID to filter by (can be partial)
-             */
-            courseId?: string,
-            /**
-             * End date for time range (YYYY-MM-DD)
-             */
-            endDate?: string,
-            /**
-             * Whether to include main platform data
-             */
-            includeMainPlatform?: boolean,
-            /**
-             * Username to get data for (admin users only)
-             */
-            learnerId?: string,
-            /**
-             * Mentor UUID to filter by
-             */
-            mentorUuid?: string,
-            /**
-             * Platform name or key to filter by
-             */
-            platform?: string | null,
-            /**
-             * Session UUID to filter by
-             */
-            sessionUuid?: string,
-            /**
-             * Start date for time range (YYYY-MM-DD)
-             */
-            startDate?: string,
-            /**
-             * URL to filter by (can be partial)
-             */
-            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,
-                    'learner_id': learnerId,
-                    'mentor_uuid': mentorUuid,
-                    'platform': platform,
-                    'session_uuid': sessionUuid,
-                    'start_date': startDate,
-                    'url': url,
-                },
-                errors: {
-                    400: `Bad request`,
-                    401: `Unauthorized`,
-                },
-            });
-        }
-    }