@iblai/iblai-api 3.34.5-core

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

@@ -0,0 +1,142 @@
+import type { ReportCreate } from '../models/ReportCreate';
+import type { ReportDetail } from '../models/ReportDetail';
+import type { ReportList } from '../models/ReportList';
+import type { ReportRequest } from '../models/ReportRequest';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ReportsService {
+    /**
+     * Lists all available reports in the system.
+     *
+     * This endpoint returns a list of all reports available to the user, including:
+     * - Report metadata (name, description, icon)
+     * - Available query parameters for each report
+     * - Result columns that will be returned
+     * - Current status of any previously requested reports
+     *
+     * If a report has been previously requested by the user, its status will be included
+     * in the response. Expired reports are automatically cleaned up.
+     *
+     * Returns:
+     * A list of report objects with their metadata and status information.
+     * @param org
+     * @returns ReportList
+     * @throws ApiError
+     */
+    static reportsOrgsRetrieve(org: string): CancelablePromise<ReportList>;
+    /**
+     * Retrieves detailed information about a specific report type.
+     *
+     * This endpoint provides:
+     * - Metadata about the report (name, description, icon)
+     * - Available query parameters for the report
+     * - Result columns that will be returned
+     * - Current status of the most recent report of this type requested by the user
+     *
+     * Path Parameters:
+     * report_name (str): The identifier of the report to retrieve details for
+     *
+     * Returns:
+     * Detailed information about the report type and its current status if previously requested.
+     *
+     * Error Responses:
+     * 404 Not Found: If the specified report type doesn't exist
+     * @param org
+     * @param reportName
+     * @returns ReportDetail
+     * @throws ApiError
+     */
+    static reportsOrgsRetrieve2(org: string, reportName: string): CancelablePromise<ReportDetail>;
+    /**
+     * Creates and manages report generation requests.
+     *
+     * This endpoint allows users to:
+     * 1. Request a new report generation
+     * 2. Check the status of a previously requested report
+     * 3. Force regeneration of an existing report
+     *
+     * Reports expire after a configured time period (default is typically 24-48 hours).
+     *
+     * Request Parameters:
+     * report_name (str): The identifier of the report to generate
+     * owner (str): The username of the report owner (usually the current user)
+     * learner_id (str, optional): Filter by specific learner
+     * course_id (str, optional): Filter by specific course
+     * start_date (str, optional): Start date for report data (ISO format)
+     * end_date (str, optional): End date for report data (ISO format)
+     * filters (dict, optional): Additional filters specific to the report type
+     * force (bool, optional): Force regeneration even if a valid report exists
+     *
+     * Returns:
+     * For new reports:
+     * - report_id: The unique identifier for the report task
+     * - state: The current state of the report (PENDING, RUNNING, etc.)
+     *
+     * For completed reports:
+     * - report_id: The unique identifier for the report task
+     * - report_name: The name of the report
+     * - url: Download URL for the report
+     * - state: COMPLETED
+     * - expires: Expiration timestamp for the report
+     *
+     * For in-progress reports:
+     * - report_id: The unique identifier for the report task
+     * - state: Current state (PENDING, RUNNING)
+     * - started_on: When the report generation started
+     * - owner: Username of the report owner
+     *
+     * Error Responses:
+     * 400 Bad Request: Invalid parameters or report configuration
+     * 404 Not Found: Report type not found
+     * 403 Forbidden: User doesn't have permission for the requested report
+     * @param org
+     * @param requestBody
+     * @returns ReportCreate
+     * @throws ApiError
+     */
+    static reportsOrgsNewCreate(org: string, requestBody?: ReportRequest): CancelablePromise<ReportCreate>;
+    /**
+     * Returns a list of reports available in the system.
+     *
+     * For each report, it includes:
+     * - display_name: Human-readable name of the report
+     * - description: Description of what the report contains
+     * - icon: URL to an icon representing the report
+     * - report_name: Unique identifier for the report
+     * - extra_query_params: Additional parameters that can be passed when creating the report
+     * - result_columns: Columns that will be included in the report results
+     * - status: Current status of the report if it has been previously requested
+     *
+     * The status will include details like the report ID, state, and download URL if completed.
+     * @param key
+     * @returns ReportList
+     * @throws ApiError
+     */
+    static reportsPlatformsRetrieve(key: string): CancelablePromise<ReportList>;
+    /**
+     * Returns details of a specific report type including its status if previously requested.
+     * @param key
+     * @param reportName
+     * @returns ReportDetail
+     * @throws ApiError
+     */
+    static reportsPlatformsRetrieve2(key: string, reportName: string): CancelablePromise<ReportDetail>;
+    /**
+     * Triggers a new report generation.
+     *
+     * If the report has been previously requested, it returns the status of the report.
+     * Reports expire after a configured duration.
+     *
+     * The request body should include:
+     * - report_name: Name of the report to generate
+     * - learner_id: (optional) ID of the learner to filter by
+     * - course_id: (optional) ID of the course to filter by
+     * - force: (optional) Force generation of a new report even if one exists
+     * - filters: (optional) Additional filters for the report
+     * - departments: (optional) Department IDs to filter by
+     * @param key
+     * @param requestBody
+     * @returns ReportCreate
+     * @throws ApiError
+     */
+    static reportsPlatformsNewCreate(key: string, requestBody?: ReportRequest): CancelablePromise<ReportCreate>;
+}

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

@@ -0,0 +1,276 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class SearchService {
+    /**
+     * Search and filter content across the learning catalog.
+     *
+     * This endpoint provides a powerful search interface for discovering content across
+     * multiple content types (courses, programs, pathways, skills, roles, resources).
+     * It supports full-text search, faceted filtering, and pagination.
+     *
+     * Query Parameters:
+     * query (str, optional): Search term to filter content by name or description
+     * content (list, optional): Content types to include in results
+     * (courses, programs, pathways, skills, roles, resources)
+     * Default: ["programs", "courses", "pathways", "skills"]
+     *
+     * # Filtering parameters
+     * course_id (str, optional): Filter by specific course ID
+     * program_id (str, optional): Filter by specific program ID
+     * pathway_id (str, optional): Filter by specific pathway ID
+     * skill_id (str, optional): Filter by specific skill ID
+     * subject (list, optional): Filter by subject areas
+     * tenant (list, optional): Filter by tenant/organization
+     * topics (list, optional): Filter by topic areas
+     * tags (list, optional): Filter by tags
+     * level (list, optional): Filter by difficulty level
+     * self_paced (list, optional): Filter by course format (self-paced, instructor-led)
+     * promotion (list, optional): Filter by promotion status
+     * language (list, optional): Filter by content language
+     * certificate (list, optional): Filter by certificate type
+     * program_type (list, optional): Filter by program type
+     * duration (list, optional): Filter by course duration range
+     * price (str, optional): Filter by price/audit status
+     * resource_type (list, optional): Filter by resource type
+     * skills (list, optional): Filter by skills
+     *
+     * # Sorting and pagination
+     * order_by (str, optional): Field to sort results by
+     * order_ascending (bool, optional): Sort direction (default: false)
+     * alphabetical (bool, optional): Sort alphabetically by name (default: false)
+     * limit (int, optional): Number of results per page (default: 12, max: 100)
+     * offset (int, optional): Starting position for pagination
+     *
+     * # Response options
+     * return_facet (bool, optional): Include facet data in response (default: true)
+     * return_items (bool, optional): Include items in programs/pathways (default: false)
+     * allow_skill_search (bool, optional): Enable skill-based search (default: false)
+     * update_facet (str, optional): Force facet update
+     *
+     * Returns:
+     * A JSON response containing:
+     * - results: List of content items with metadata
+     * - count: Total number of matching items
+     * - next: URL for the next page of results (if available)
+     * - previous: URL for the previous page of results (if available)
+     * - current_page: Current page number
+     * - total_pages: Total number of pages
+     * - facets: Aggregated counts for each filter category (if requested)
+     *
+     * Each content item contains type-specific fields:
+     * - Courses:
+     * {
+         * "id": 123,
+         * "type": "course",
+         * "course_id": "CS101",
+         * "name": "Introduction to Computer Science",
+         * "description": "Learn the fundamentals of computer science",
+         * "short_description": "CS fundamentals",
+         * "image_url": "https://example.com/images/cs101.jpg",
+         * "level": "Beginner",
+         * "subject": "Computer Science",
+         * "topics": ["Programming", "Algorithms"],
+         * "tags": ["python", "coding"],
+         * "language": "English",
+         * "tenant": "example-university",
+         * "self_paced": true,
+         * "duration": "6 weeks",
+         * "certificate": "Professional Certificate",
+         * "price": "Free",
+         * "skills": [
+             * {"id": 1, "name": "Python Programming"},
+             * {"id": 2, "name": "Algorithms"}
+             * ],
+             * "url": "https://example.com/courses/cs101"
+             * }
+             *
+             * - Programs:
+             * {
+                 * "id": 456,
+                 * "type": "program",
+                 * "program_id": "PROG123",
+                 * "name": "Data Science Program",
+                 * "description": "Comprehensive data science curriculum",
+                 * "short_description": "Learn data science",
+                 * "image_url": "https://example.com/images/datascience.jpg",
+                 * "level": "Intermediate",
+                 * "subject": "Data Science",
+                 * "topics": ["Machine Learning", "Statistics"],
+                 * "program_type": "Professional Certificate",
+                 * "courses": [
+                     * {"id": 123, "name": "Introduction to Python"},
+                     * {"id": 124, "name": "Statistics for Data Science"}
+                     * ],
+                     * "url": "https://example.com/programs/prog123"
+                     * }
+                     *
+                     * - Pathways:
+                     * {
+                         * "id": 789,
+                         * "type": "pathway",
+                         * "pathway_id": "PATH456",
+                         * "name": "Software Engineering Career Path",
+                         * "description": "Complete pathway to become a software engineer",
+                         * "image_url": "https://example.com/images/swe-path.jpg",
+                         * "programs": [
+                             * {"id": 456, "name": "Programming Fundamentals"},
+                             * {"id": 457, "name": "Web Development"}
+                             * ],
+                             * "url": "https://example.com/pathways/path456"
+                             * }
+                             *
+                             * - Skills:
+                             * {
+                                 * "id": 321,
+                                 * "type": "skill",
+                                 * "name": "Machine Learning",
+                                 * "description": "Building systems that learn from data",
+                                 * "courses": [
+                                     * {"id": 125, "name": "Machine Learning Fundamentals"}
+                                     * ],
+                                     * "related_skills": [
+                                         * {"id": 322, "name": "Deep Learning"}
+                                         * ]
+                                         * }
+                                         *
+                                         * - Roles:
+                                         * {
+                                             * "id": 654,
+                                             * "type": "role",
+                                             * "name": "Data Scientist",
+                                             * "description": "Professional who analyzes and interprets complex data",
+                                             * "skills": [
+                                                 * {"id": 321, "name": "Machine Learning"},
+                                                 * {"id": 323, "name": "Data Analysis"}
+                                                 * ],
+                                                 * "recommended_courses": [
+                                                     * {"id": 125, "name": "Machine Learning Fundamentals"}
+                                                     * ]
+                                                     * }
+                                                     *
+                                                     * - Resources:
+                                                     * {
+                                                         * "id": 987,
+                                                         * "type": "resource",
+                                                         * "name": "Python Cheat Sheet",
+                                                         * "description": "Quick reference guide for Python",
+                                                         * "resource_type": "PDF",
+                                                         * "url": "https://example.com/resources/python-cheatsheet.pdf",
+                                                         * "topics": ["Programming", "Python"]
+                                                         * }
+                                                         *
+                                                         * Error Responses:
+                                                         * 500 Internal Server Error: If an unexpected error occurs during processing
+                                                         *
+                                                         * Notes:
+                                                         * - Results are cached for performance
+                                                         * - The 'resources' content type is only included by default if IBL_ENABLE_RESOURCES_IN_FACET is true
+                                                         * - For debugging, add ?debug=true to see detailed information about skill matching
+                                                         * @returns any No response body
+                                                         * @throws ApiError
+                                                         */
+    static searchCatalogRetrieve(): CancelablePromise<any>;
+    /**
+     * Determine whether to serve a detail view or a list view.
+     * If any detail-identifying parameters are present (course_id, program_id, etc.)
+     * the detail view is returned; otherwise the aggregated list view is returned.
+     * @param username
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static searchPersonalizedCatalogRetrieve(username: string): CancelablePromise<any>;
+    /**
+     * Search and filter users within a specific organization/tenant.
+     *
+     * This endpoint provides a search interface for discovering users within an organization,
+     * with support for filtering by departments, pagination, and faceted filtering.
+     *
+     * Path Parameters:
+     * org (str): The organization/tenant identifier
+     * username (str): The username of the user making the request
+     *
+     * Query Parameters:
+     * # Search parameters
+     * query (str, optional): Search term to filter users by name, username, or email
+     *
+     * # Department filtering
+     * department_mode (bool, optional): Enable department-based filtering (default: false)
+     * user_department (bool, optional): Legacy parameter for department_mode (default: false)
+     * department (list, optional): Filter by specific departments
+     *
+     * # Additional filters
+     * role (list, optional): Filter by user role
+     * status (list, optional): Filter by user status (active, inactive)
+     * joined_date (list, optional): Filter by join date range
+     * last_login (list, optional): Filter by last login date range
+     *
+     * # Pagination
+     * limit (int, optional): Number of results per page (default: 10)
+     * offset (int, optional): Starting position for pagination
+     *
+     * Returns:
+     * A JSON response containing:
+     * ```
+     * {
+         * "results": [
+             * {
+                 * "id": 123,
+                 * "username": "john.doe",
+                 * "email": "john.doe@example.com",
+                 * "first_name": "John",
+                 * "last_name": "Doe",
+                 * "full_name": "John Doe",
+                 * "profile_image": "https://example.com/profiles/john-doe.jpg",
+                 * "role": "Student",
+                 * "departments": ["Computer Science", "Data Science"],
+                 * "status": "active",
+                 * "joined_date": "2023-01-15T12:00:00Z",
+                 * "last_login": "2023-06-20T15:30:00Z",
+                 * "metadata": {
+                     * "location": "New York",
+                     * "title": "Software Engineer",
+                     * "bio": "Experienced software engineer with a passion for education"
+                     * }
+                     * },
+                     * // Additional user objects...
+                     * ],
+                     * "count": 50,
+                     * "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
+                     * "previous": null,
+                     * "current_page": 1,
+                     * "total_pages": 5,
+                     * "facets": {
+                         * "role": [
+                             * {"key": "Student", "doc_count": 30},
+                             * {"key": "Instructor", "doc_count": 15},
+                             * {"key": "Admin", "doc_count": 5}
+                             * ],
+                             * "department": [
+                                 * {"key": "Computer Science", "doc_count": 20},
+                                 * {"key": "Data Science", "doc_count": 15},
+                                 * {"key": "Business", "doc_count": 10},
+                                 * {"key": "Engineering", "doc_count": 5}
+                                 * ],
+                                 * "status": [
+                                     * {"key": "active", "doc_count": 45},
+                                     * {"key": "inactive", "doc_count": 5}
+                                     * ]
+                                     * }
+                                     * }
+                                     * ```
+                                     * Error Responses:
+                                     * 400 Bad Request: If the request parameters are invalid
+                                     * 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
+                                     * 404 Not Found: If the user or organization doesn't exist
+                                     * 500 Internal Server Error: If an unexpected error occurs
+                                     *
+                                     * Access Control:
+                                     * - The requesting user must have an active account in the specified organization
+                                     * - When department_mode is enabled, the user must be an admin of at least one department
+                                     * - Department filtering restricts results to users in departments where the requesting user is an admin
+                                     * @param org
+                                     * @param username
+                                     * @returns any No response body
+                                     * @throws ApiError
+                                     */
+    static searchUsersOrgsUsersRetrieve(org: string, username: string): CancelablePromise<any>;
+}