@iblai/iblai-api 4.434.0-core → 4.435.0-ai

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

@@ -0,0 +1,45 @@
+import type { LLMResponse } from '../models/LLMResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class V1LlmsService {
+    /**
+     * Retrieve available LLMs for a user
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Retrieve available LLMs for a user.
+     * @returns LLMResponse
+     * @throws ApiError
+     */
+    static v1LlmsList({ allowMixingTools, includeGlobal, isMultimodal, mentorId, mentorUniqueId, minContextWindow, provider, search, supportsFunctionCalling, view, }: {
+        allowMixingTools?: boolean | null;
+        /**
+         * Include platform-scoped resources when filtering by mentor (only relevant with mentor_unique_id)
+         */
+        includeGlobal?: boolean;
+        isMultimodal?: boolean | null;
+        mentorId?: string;
+        /**
+         * Optional mentor unique ID to check permissions in mentor context
+         */
+        mentorUniqueId?: string;
+        /**
+         * Minimum context window in tokens
+         */
+        minContextWindow?: number | null;
+        /**
+         * Restrict the response to a single provider
+         */
+        provider?: string;
+        /**
+         * Case-insensitive match on model name, display name, description, or the provider that authored the model
+         */
+        search?: string;
+        supportsFunctionCalling?: boolean | null;
+        /**
+         * 'grid' groups models under their provider (the default, unchanged). 'table' returns one paginated row per model for a searchable table.
+         *
+         * * `grid` - grid
+         * * `table` - table
+         */
+        view?: 'grid' | 'table';
+    }): CancelablePromise<Array<LLMResponse>>;
+}

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

@@ -0,0 +1,15 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class V1MemsearchStatusService {
+    /**
+     * GET /orgs/{org}/users/{user_id}/memsearch-status/
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * GET /orgs/{org}/users/{user_id}/memsearch-status/
+     *
+     * Returns whether memsearch is enabled for the tenant.
+     * Accessible by students and admins.
+     * @returns any Tenant memsearch status
+     * @throws ApiError
+     */
+    static v1MemsearchStatusRetrieve(): CancelablePromise<any>;
+}

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

@@ -0,0 +1,81 @@
+import type { Notification } from '../models/Notification';
+import type { NotificationCount } from '../models/NotificationCount';
+import type { NotificationsUpdate } from '../models/NotificationsUpdate';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class V1NotificationsService {
+    /**
+     * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
+     * @returns Notification
+     * @throws ApiError
+     */
+    static v1NotificationsRetrieve({ channel, endDate, excludeChannel, startDate, status, tags, iblaiUser, }: {
+        /**
+         * Filter by delivery channel
+         */
+        channel?: string;
+        /**
+         * Filter notifications until this date
+         */
+        endDate?: string;
+        /**
+         * Exclude notifications from this channel
+         */
+        excludeChannel?: string;
+        /**
+         * Filter notifications from this date
+         */
+        startDate?: string;
+        /**
+         * Filter by notification status
+         */
+        status?: string;
+        /**
+         * Comma-separated tags to filter by (e.g. 'learning,activity'). Returns notifications whose template matches ANY of the given tags.
+         */
+        tags?: string;
+        /**
+         * Acting user. Sent by default on the client; pass it explicitly to select the user-scoped resource, or omit it for the org-scoped one.
+         */
+        iblaiUser?: string;
+    }): CancelablePromise<Notification>;
+    /**
+     * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
+     * @returns Notification
+     * @throws ApiError
+     */
+    static v1NotificationsUpdate({ requestBody, iblaiUser, }: {
+        requestBody: NotificationsUpdate;
+        /**
+         * Acting user. Sent by default on the client; pass it explicitly to select the user-scoped resource, or omit it for the org-scoped one.
+         */
+        iblaiUser?: string;
+    }): CancelablePromise<Notification>;
+    /**
+     * Get notifications count for a user. Requires: Ibl.Notifications/Notification/list
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Get notifications count for a user. Requires: Ibl.Notifications/Notification/list
+     * @returns NotificationCount
+     * @throws ApiError
+     */
+    static v1NotificationsCountRetrieve({ channel, status, }: {
+        /**
+         * Filter count by delivery channel
+         */
+        channel?: string;
+        /**
+         * Filter count by notification status
+         *
+         * * `READ` - Read
+         * * `UNREAD` - Unread
+         * * `CANCELLED` - Cancelled
+         */
+        status?: 'READ' | 'UNREAD' | 'CANCELLED';
+    }): CancelablePromise<NotificationCount>;
+}

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

@@ -0,0 +1,27 @@
+import type { PatchedPlatformPublicMetadata } from '../models/PatchedPlatformPublicMetadata';
+import type { PlatformPublicMetadata } from '../models/PlatformPublicMetadata';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class V1OrganizationService {
+    /**
+     * Requires the `iblai-org` context header.
+     * @returns PlatformPublicMetadata
+     * @throws ApiError
+     */
+    static v1OrganizationMetadataRetrieve(): CancelablePromise<PlatformPublicMetadata>;
+    /**
+     * Requires the `iblai-org` context header.
+     * @returns PlatformPublicMetadata
+     * @throws ApiError
+     */
+    static v1OrganizationMetadataPartialUpdate({ requestBody, }: {
+        requestBody?: PatchedPlatformPublicMetadata;
+    }): CancelablePromise<PlatformPublicMetadata>;
+    /**
+     * Requires the `iblai-org` context header.
+     * @returns PlatformPublicMetadata
+     * @throws ApiError
+     */
+    static v1OrganizationMetadataUpdate({ requestBody, }: {
+        requestBody?: PlatformPublicMetadata;
+    }): CancelablePromise<PlatformPublicMetadata>;
+}

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

@@ -0,0 +1,160 @@
+import type { PaginatedProjectList } from '../models/PaginatedProjectList';
+import type { PatchedProject } from '../models/PatchedProject';
+import type { Project } from '../models/Project';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class V1ProjectsService {
+    /**
+     * List projects
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Retrieve a list of projects with optional filtering and search.
+     * @returns PaginatedProjectList
+     * @throws ApiError
+     */
+    static v1ProjectsList({ ordering, search, shared, sort, username, page, pageSize, iblaiUser, }: {
+        /**
+         * Which field to use when ordering the results.
+         */
+        ordering?: string;
+        /**
+         * Search in project name and description
+         */
+        search?: string;
+        /**
+         * Filter by shared status (true/false)
+         */
+        shared?: boolean;
+        /**
+         * Order by field (prefix with - for descending). Example: name or -created_at
+         */
+        sort?: string;
+        /**
+         * Filter projects by owner's username
+         */
+        username?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+        /**
+         * Acting user. Sent by default on the client; pass it explicitly to select the user-scoped resource, or omit it for the org-scoped one.
+         */
+        iblaiUser?: string;
+    }): CancelablePromise<PaginatedProjectList>;
+    /**
+     * Create a new project
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Create a new project with optional mentors.
+     * @returns Project
+     * @throws ApiError
+     */
+    static v1ProjectsCreate({ requestBody, iblaiUser, }: {
+        requestBody: Project;
+        /**
+         * Acting user. Sent by default on the client; pass it explicitly to select the user-scoped resource, or omit it for the org-scoped one.
+         */
+        iblaiUser?: string;
+    }): CancelablePromise<Project>;
+    /**
+     * Delete a project
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Delete a project permanently.
+     * @returns void
+     * @throws ApiError
+     */
+    static v1ProjectsDestroy({ id, iblaiUser, }: {
+        /**
+         * A unique integer value identifying this Project.
+         */
+        id: number;
+        /**
+         * Acting user. Sent by default on the client; pass it explicitly to select the user-scoped resource, or omit it for the org-scoped one.
+         */
+        iblaiUser?: string;
+    }): CancelablePromise<void>;
+    /**
+     * Retrieve a project
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Get detailed information about a specific project including its mentors.
+     * @returns Project
+     * @throws ApiError
+     */
+    static v1ProjectsRetrieve({ id, iblaiUser, }: {
+        /**
+         * A unique integer value identifying this Project.
+         */
+        id: number;
+        /**
+         * Acting user. Sent by default on the client; pass it explicitly to select the user-scoped resource, or omit it for the org-scoped one.
+         */
+        iblaiUser?: string;
+    }): CancelablePromise<Project>;
+    /**
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * API ViewSet for managing projects.
+     *
+     * Projects are groups of mentors that can be created by anyone (students and tenant admins).
+     * They serve as a way to organize and group related mentors together.
+     *
+     * Projects can be:
+     * - Personal (shared=False): Only visible to their owners
+     * - Shared (shared=True): Visible to platform admins and potentially other users
+     *
+     * Projects are accessed through integrated URLs within the mentor router:
+     * /orgs/<org>/projects/ - All accessible projects in a platform (admin access)
+     * /orgs/<org>/projects/<id>/ - Specific project (admin access)
+     * /orgs/<org>/users/<user_id>/projects/ - User's projects (user access)
+     * /orgs/<org>/users/<user_id>/projects/<id>/ - User's specific project
+     *
+     * Query Parameters:
+     * - username: Filter projects by owner's username (admin routes only)
+     * - shared: Filter by shared status (true/false)
+     * - search: Search in name and description
+     * - sort: Order by field (prefix with - for descending). Example: sort=name or sort=-created_at
+     *
+     * Permissions:
+     * - GET: Accessible to project owners and platform admins (for shared projects)
+     * - POST: Any authenticated user can create projects
+     * - PUT, PATCH, DELETE: Accessible to project owners only
+     * @returns Project
+     * @throws ApiError
+     */
+    static v1ProjectsPartialUpdate({ id, iblaiUser, requestBody, }: {
+        /**
+         * A unique integer value identifying this Project.
+         */
+        id: number;
+        /**
+         * Acting user. Sent by default on the client; pass it explicitly to select the user-scoped resource, or omit it for the org-scoped one.
+         */
+        iblaiUser?: string;
+        requestBody?: PatchedProject;
+    }): CancelablePromise<Project>;
+    /**
+     * Update a project
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Update project information and optionally modify its mentors.
+     * @returns Project
+     * @throws ApiError
+     */
+    static v1ProjectsUpdate({ id, requestBody, iblaiUser, }: {
+        /**
+         * A unique integer value identifying this Project.
+         */
+        id: number;
+        requestBody: Project;
+        /**
+         * Acting user. Sent by default on the client; pass it explicitly to select the user-scoped resource, or omit it for the org-scoped one.
+         */
+        iblaiUser?: string;
+    }): CancelablePromise<Project>;
+}

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

@@ -1,3 +1,4 @@
+import type { PermissionCheckRequest } from '../models/PermissionCheckRequest';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class V1RbacService {
     /**
@@ -29,4 +30,13 @@ export declare class V1RbacService {
         actions: Array<string>;
         data_actions: Array<string>;
     }>>;
+    /**
+     * Check user permissions
+     * Check user permissions for specified resources
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static v1RbacPermissionsCheckCreate({ requestBody, }: {
+        requestBody: PermissionCheckRequest;
+    }): CancelablePromise<any>;
 }

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

@@ -0,0 +1,265 @@
+import type { ChatHistorySessionId } from '../models/ChatHistorySessionId';
+import type { ChatSessionRequest } from '../models/ChatSessionRequest';
+import type { ChatSessionResponse } from '../models/ChatSessionResponse';
+import type { GuidedPromptsResponse } from '../models/GuidedPromptsResponse';
+import type { MessageView } from '../models/MessageView';
+import type { MessageViewRequest } from '../models/MessageViewRequest';
+import type { MessageViewUpdatResponse } from '../models/MessageViewUpdatResponse';
+import type { PinnedMessageCreate } from '../models/PinnedMessageCreate';
+import type { PinnedMessageRequest } from '../models/PinnedMessageRequest';
+import type { SessionSummary } from '../models/SessionSummary';
+import type { VectorResult } from '../models/VectorResult';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class V1SessionsService {
+    /**
+     * Retrieve user sessions filtered by start date and end date
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Retrieve user sessions filtered by start date and end date.
+     *
+     * Query Parameters:
+     * start_date (optional, ISO format): Start date for filtering sessions.
+     * end_date (optional, ISO format): End date for filtering sessions.
+     *
+     * Returns:
+     * - 200: List of session IDs with insertion timestamps.
+     * - 400: Invalid request parameters.
+     * @returns ChatHistorySessionId
+     * @throws ApiError
+     */
+    static v1SessionsList({ endDate, startDate, }: {
+        endDate?: string;
+        startDate?: string;
+    }): CancelablePromise<Array<ChatHistorySessionId>>;
+    /**
+     * Retrieve or create a chat session with a mentor
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Retrieve or create a chat session with a mentor.
+     *
+     * Passing `null` as `tools` results in using all tools assigned to the mentor.
+     * To specify that no tools be used, pass an empty list.
+     *
+     * Session identity is derived from the request itself, never from user
+     * input: an authenticated caller is attributed via `request.user`
+     * (tenant-scoped to `org`), while an anonymous caller gets no student
+     * linkage and is only permitted on `allow_anonymous` mentors.
+     *
+     * Args:
+     * request: HTTP request containing mentor details.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: JSON object containing the session ID.
+     *
+     * Raises:
+     * Http404: If the mentor is not found.
+     * ValidationError: If the username is invalid.
+     * ValidationError: If one or more tool slugs are invalid.
+     * @returns ChatSessionResponse
+     * @throws ApiError
+     */
+    static v1SessionsCreate({ requestBody, iblaiUser, }: {
+        requestBody: ChatSessionRequest;
+        /**
+         * Acting user. Sent by default on the client; pass it explicitly to select the user-scoped resource, or omit it for the org-scoped one.
+         */
+        iblaiUser?: string;
+    }): CancelablePromise<ChatSessionResponse>;
+    /**
+     * Delete a pinned message for a user
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Delete a pinned message for a user.
+     *
+     * Args:
+     * request: The HTTP request containing session details.
+     * org: Organization key identifier.
+     * user_id: The username of the student.
+     *
+     * Returns:
+     * Response: Status 204 on success.
+     *
+     * Raises:
+     * NotFound: If the student or pinned message does not exist.
+     * ValidationError: If request data is invalid.
+     * @returns void
+     * @throws ApiError
+     */
+    static v1SessionsPinnedDestroy(): CancelablePromise<void>;
+    /**
+     * Retrieve pinned sessions for a user
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Retrieve pinned sessions for a user.
+     *
+     * Returns a lightweight paginated list of pinned sessions containing:
+     * - session_id: UUID of the session
+     * - mentor_unique_id: UUID of the mentor
+     * - mentor: Object with unique_id (for backward compatibility)
+     * - title: AI-generated session title
+     * - messages: Array containing only the first message
+     *
+     * Query Parameters:
+     * mentor: Filter by mentor unique_id, slug, or name (optional)
+     *
+     * Args:
+     * request: The HTTP request.
+     * org: Organization key identifier.
+     * user_id: The username of the student.
+     *
+     * Returns:
+     * Response: Paginated list of pinned sessions.
+     * @returns SessionSummary
+     * @throws ApiError
+     */
+    static v1SessionsPinnedList({ mentor, search, page, pageSize, }: {
+        /**
+         * Filter by mentor unique_id, slug, or name
+         */
+        mentor?: string;
+        /**
+         * Case-insensitive search across the session title and the content of its chat messages (both human and AI).
+         */
+        search?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+    }): CancelablePromise<Array<SessionSummary>>;
+    /**
+     * Create a pinned message for a user session
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Create a pinned message for a user session.
+     *
+     * Args:
+     * request: The HTTP request containing session details.
+     * org: Organization key identifier.
+     * user_id: The username of the student.
+     *
+     * Returns:
+     * Response: Status 201 on success.
+     *
+     * Raises:
+     * NotFound: If the student does not exist.
+     * ValidationError: If request data is invalid.
+     * @returns PinnedMessageCreate
+     * @throws ApiError
+     */
+    static v1SessionsPinnedCreate({ requestBody, }: {
+        requestBody: PinnedMessageRequest;
+    }): CancelablePromise<PinnedMessageCreate>;
+    /**
+     * Get recent chat sessions of a user within an organization
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Get recent chat sessions of a user within an organization.
+     * @returns SessionSummary
+     * @throws ApiError
+     */
+    static v1SessionsRecentList({ mentor, search, page, pageSize, }: {
+        /**
+         * Filter by mentor unique_id, slug, or name
+         */
+        mentor?: string;
+        /**
+         * Case-insensitive search across the session title and the content of its chat messages (both human and AI).
+         */
+        search?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+    }): CancelablePromise<Array<SessionSummary>>;
+    /**
+     * Update the title of a chat session and its tools
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Update the title of a chat session and its tools
+     * @returns MessageViewUpdatResponse
+     * @throws ApiError
+     */
+    static v1SessionsUpdate({ sessionId, requestBody, }: {
+        sessionId: string;
+        requestBody?: MessageViewRequest;
+    }): CancelablePromise<MessageViewUpdatResponse>;
+    /**
+     * Retrieve guided prompts for a chat session
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Fetches AI-generated guided prompts for a given session and organization.
+     * @returns GuidedPromptsResponse
+     * @throws ApiError
+     */
+    static v1SessionsGuidedPromptsRetrieve({ sessionId, count, }: {
+        sessionId: string;
+        count?: number;
+    }): CancelablePromise<GuidedPromptsResponse>;
+    /**
+     * Deletes all messages in a chat session
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Deletes all messages in a chat session.
+     * @returns void
+     * @throws ApiError
+     */
+    static v1SessionsMessagesDestroy({ sessionId, }: {
+        sessionId: string;
+    }): CancelablePromise<void>;
+    /**
+     * Retrieve Chat Messages
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Fetches chat messages for a specific session.
+     * @returns MessageView
+     * @throws ApiError
+     */
+    static v1SessionsMessagesRetrieve({ sessionId, page, pageSize, }: {
+        sessionId: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+    }): CancelablePromise<MessageView>;
+    /**
+     * Retrieve and clean up vector results from a specific session
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * Retrieve and clean up vector results from a specific session.
+     *
+     * This endpoint retrieves the documents last used by the mentor to answer
+     * the most recent query from the user in the specified session, and cleans
+     * them to remove any inappropriate content.
+     *
+     * Args:
+     * request: The HTTP request.
+     * org: The organization/tenant identifier.
+     * user_id: The ID of the user making the request.
+     * session_id: The ID of the session to retrieve vector results from.
+     *
+     * Returns:
+     * Response: The cleaned vector results.
+     *
+     * Raises:
+     * BadRequest: If the API key for the cleaning provider is not found.
+     * NotFound: If no vector results are found for the session.
+     * @returns VectorResult
+     * @throws ApiError
+     */
+    static v1SessionsSourcesList({ sessionId, }: {
+        sessionId: string;
+    }): CancelablePromise<Array<VectorResult>>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/iblai-api",
-  "version": "4.434.0-core",
+  "version": "4.435.0-ai",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "type": "module",