@iblai/iblai-api 1.0.0-add-mcp-server-test-mount-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/RolesService.d.ts

@@ -0,0 +1,57 @@
+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
+     * @param org
+     * @param username
+     * @returns DesiredRole
+     * @throws ApiError
+     */
+    static rolesPlatformOrgsRolesUsersDesiredRolesRetrieve(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
+     * @param org
+     * @param username
+     * @returns ReportedRole
+     * @throws ApiError
+     */
+    static rolesPlatformOrgsRolesUsersReportedRolesRetrieve(org: string, username: string): CancelablePromise<ReportedRole>;
+}

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

@@ -0,0 +1,172 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class SearchService {
+    /**
+     * Search and filter content across the learning catalog
+     * @param allowSkillSearch Enable skill-based search
+     * @param alphabetical Sort alphabetically by name
+     * @param certificate Filter by certificate type
+     * @param content Content types to include in results
+     * @param courseId Filter by specific course ID
+     * @param duration Filter by course duration range
+     * @param language Filter by content language
+     * @param level Filter by difficulty level
+     * @param limit Number of results per page
+     * @param offset Starting position for pagination
+     * @param orderAscending Sort direction
+     * @param orderBy Field to sort results by
+     * @param pathwayId Filter by specific pathway ID
+     * @param price Filter by price/audit status
+     * @param programId Filter by specific program ID
+     * @param programType Filter by program type
+     * @param promotion Filter by promotion status
+     * @param query Search term to filter content by name or description
+     * @param resourceType Filter by resource type
+     * @param returnFacet Include facet data in response
+     * @param returnItems Include items in programs/pathways
+     * @param selfPaced Filter by course format
+     * @param skillId Filter by specific skill ID
+     * @param skills Filter by skills
+     * @param subject Filter by subject areas
+     * @param tags Filter by tags
+     * @param tenant Filter by tenant/organization
+     * @param topics Filter by topic areas
+     * @param updateFacet Force facet update
+     * @returns any
+     * @throws ApiError
+     */
+    static searchCatalogRetrieve(allowSkillSearch?: boolean, alphabetical?: boolean, certificate?: Array<string>, content?: Array<string>, courseId?: string, duration?: Array<string>, language?: Array<string>, level?: Array<string>, limit?: number, offset?: number, orderAscending?: boolean, orderBy?: string, pathwayId?: string, price?: string, programId?: string, programType?: Array<string>, promotion?: Array<string>, query?: string, resourceType?: Array<string>, returnFacet?: boolean, returnItems?: boolean, selfPaced?: Array<string>, skillId?: string, skills?: Array<string>, subject?: Array<string>, tags?: Array<string>, tenant?: Array<string>, topics?: Array<string>, updateFacet?: string): CancelablePromise<Record<string, any>>;
+    /**
+     * Get personalized content for a specific user
+     * @param username
+     * @param allowSkillSearch Enable skill-based search
+     * @param alphabetical Sort alphabetically by name
+     * @param certificate Filter by certificate type
+     * @param content Content types to include in results
+     * @param courseId Retrieve a specific course by ID
+     * @param duration Filter by course duration range
+     * @param language Filter by content language
+     * @param level Filter by difficulty level
+     * @param limit Number of results per page
+     * @param offset Starting position for pagination
+     * @param orderAscending Sort direction
+     * @param orderBy Field to sort results by
+     * @param pathwayId Retrieve a specific pathway by ID
+     * @param price Filter by price/audit status
+     * @param programId Retrieve a specific program by ID
+     * @param programType Filter by program type
+     * @param promotion Filter by promotion status
+     * @param query Search term to filter content by name or description
+     * @param recommended Show only recommended content
+     * @param resourceId Retrieve a specific resource by ID
+     * @param resourceType Filter by resource type
+     * @param returnFacet Include facet data in response
+     * @param returnItems Include items in programs/pathways
+     * @param roleId Retrieve a specific role by ID
+     * @param selfPaced Filter by course format
+     * @param skillId Retrieve a specific skill by ID
+     * @param skills Filter by skills
+     * @param subject Filter by subject areas
+     * @param tags Filter by tags
+     * @param tenant Filter by tenant/organization
+     * @param topics Filter by topic areas
+     * @param updateFacet Force facet update
+     * @returns any
+     * @throws ApiError
+     */
+    static searchPersonalizedCatalogRetrieve(username: string, allowSkillSearch?: boolean, alphabetical?: boolean, certificate?: Array<string>, content?: Array<string>, courseId?: string, duration?: Array<string>, language?: Array<string>, level?: Array<string>, limit?: number, offset?: number, orderAscending?: boolean, orderBy?: string, pathwayId?: string, price?: string, programId?: string, programType?: Array<string>, promotion?: Array<string>, query?: string, recommended?: boolean, resourceId?: string, resourceType?: Array<string>, returnFacet?: boolean, returnItems?: boolean, roleId?: string, selfPaced?: Array<string>, skillId?: string, skills?: Array<string>, subject?: Array<string>, tags?: Array<string>, tenant?: Array<string>, topics?: Array<string>, updateFacet?: string): CancelablePromise<Record<string, 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>;
+}

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

@@ -0,0 +1,170 @@
+import type { StripeCheckoutSessionRequest } from '../models/StripeCheckoutSessionRequest';
+import type { StripeCheckoutSessionResponse } from '../models/StripeCheckoutSessionResponse';
+import type { StripeCustomerPortalRequest } from '../models/StripeCustomerPortalRequest';
+import type { StripeCustomerPortalResponse } from '../models/StripeCustomerPortalResponse';
+import type { StripeLocalProduct } from '../models/StripeLocalProduct';
+import type { StripeSubscriptionRenewalRequest } from '../models/StripeSubscriptionRenewalRequest';
+import type { StripeSubscriptionRenewalResponse } from '../models/StripeSubscriptionRenewalResponse';
+import type { TenantLaunchRequest } from '../models/TenantLaunchRequest';
+import type { TenantLaunchResponse } from '../models/TenantLaunchResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ServiceService {
+    /**
+     * User/tenant creation API
+     *
+     * To create using any payment provider, ensure you use the StudentToken Authentication Mechanism
+     * and also include the correct `provider_key` in the request body:
+     *
+     * ```
+     * apple_transaction_id: str
+     * stripe_checkout_id: str
+     * x_gcp_marketplace_token: str
+     * aws_transaction_id: str
+     * google_pay_transaction_id: str
+     * ```
+     *
+     * To create a tenant without a payment provider, call the API without ny of the above provider keys in the request body
+     * @param requestBody
+     * @returns TenantLaunchResponse
+     * @throws ApiError
+     */
+    static serviceLaunchTenantCreate(requestBody: TenantLaunchRequest): CancelablePromise<TenantLaunchResponse>;
+    /**
+     * User creation flow
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceManageUserCreate(): CancelablePromise<any>;
+    /**
+     * Make user tenant admin
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceManageUserRoleCreate(): CancelablePromise<any>;
+    /**
+     * Stripe checkout session API View for user upgrade
+     *
+     * Request the following fields:
+     *
+     * - tenant
+     * - sku
+     * - mode
+     * - success_url
+     * - cancel_url
+     *
+     * Response:
+     * {
+         * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
+         * }
+         * @param org
+         * @param userId
+         * @param requestBody
+         * @returns StripeCheckoutSessionResponse
+         * @throws ApiError
+         */
+    static serviceOrgsUsersStripeCheckoutSessionCreate(org: string, userId: string, requestBody: StripeCheckoutSessionRequest): CancelablePromise<StripeCheckoutSessionResponse>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns StripeCustomerPortalResponse
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeCustomerPortalCreate(org: string, userId: string, requestBody: StripeCustomerPortalRequest): CancelablePromise<StripeCustomerPortalResponse>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @returns StripeLocalProduct
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeProductsRetrieve(org: string, userId: string): CancelablePromise<StripeLocalProduct>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @param org
+     * @param userId
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeProductsManageCreate(org: string, userId: string): CancelablePromise<any>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns StripeSubscriptionRenewalResponse
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeSubscriptionRenewalCreate(org: string, userId: string, requestBody: StripeSubscriptionRenewalRequest): CancelablePromise<StripeSubscriptionRenewalResponse>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceOrgsUsersStripeSubscriptionsRetrieve(org: string, userId: string): CancelablePromise<any>;
+    /**
+     * Handle course payment callback after successful Stripe checkout.
+     * Enrolls the user in the purchased course.
+     *
+     * URL Parameters:
+     * - stripe_checkout_id: The local Checkout Session UUID
+     *
+     * Response:
+     * - Redirect: Successfully processed course enrollment
+     * - 404: Checkout session not found
+     * - 400: Invalid checkout session or product
+     * - 500: Server error during processing
+     * @param platformKey
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceOrgsStripeCoursePaymentCallbackRetrieve(platformKey: string): CancelablePromise<any>;
+    /**
+     * @param checkoutUuid
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceStripeCheckoutRetrieve(checkoutUuid: string): CancelablePromise<any>;
+    /**
+     * Stripe free trial checkout session. No user auth
+     *
+     * Request the following fields:
+     *
+     * - success_url
+     * - cancel_url
+     * - product
+     *
+     * Response:
+     * {
+         * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
+         * }
+         * @param requestBody
+         * @returns StripeCheckoutSessionResponse
+         * @throws ApiError
+         */
+    static serviceStripeCheckoutFreeTrialCreate(requestBody: StripeCheckoutSessionResponse): CancelablePromise<StripeCheckoutSessionResponse>;
+    /**
+     * Check if tenant exists or not
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceTenantValidationCreate(): CancelablePromise<any>;
+    /**
+     * GET
+     * Gets site hash_key from
+     * or
+     * Gets site_id form hash_key
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceTokenRetrieve(): CancelablePromise<any>;
+    /**
+     * Check if tenant exists or not
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static serviceUserValidationCreate(): CancelablePromise<any>;
+}