@iblai/iblai-api 4.437.0-core → 4.438.0-ai

package/src/services/V1DisclaimersService.ts

@@ -0,0 +1,387 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Disclaimer } from '../models/Disclaimer';
+import type { PaginatedDisclaimerList } from '../models/PaginatedDisclaimerList';
+import type { PatchedDisclaimer } from '../models/PatchedDisclaimer';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class V1DisclaimersService {
+    /**
+     * Requires the `iblai-org` and `iblai-user` context headers.
+     *
+     * ViewSet for managing mentor disclaimers.
+     *
+     * This viewset provides endpoints for creating and managing mentor disclaimers, which are
+     * statements or information that mentors need to share with students.
+     *
+     * Permissions:
+     * - Platform administrators have full CRUD access
+     * - Students have read-only access
+     * - Unauthenticated users have no access
+     *
+     * Endpoints:
+     * - GET /api/orgs/{org}/users/{user_id}/disclaimers/ - List all disclaimers
+     * - POST /api/orgs/{org}/users/{user_id}/disclaimers/ - Create a new disclaimer
+     * - GET /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Retrieve a specific disclaimer
+     * - PUT/PATCH /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Update a disclaimer
+     * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/add_mentor/ - Add mentor to disclaimer
+     * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/remove_mentor/ - Remove mentor from disclaimer
+     *
+     * Query Parameters:
+     * - Supports filtering via DjangoFilterBackend
+     * - See DisclaimerFilterSet for available filters
+     *
+     * Returns:
+     * List endpoint returns paginated results with disclaimer objects:
+     *
+     * ```
+     * {
+         * "count": int,
+         * "next": str,
+         * "previous": str,
+         * "results": [
+             * {
+                 * "id": int,
+                 * "title": str,
+                 * "content": str,
+                 * "mentor": str,
+                 * "platform": str,
+                 * "created_at": datetime,
+                 * "updated_at": datetime
+                 * },
+                 * ...
+                 * ]
+                 * }
+                 * ```
+                 *
+                 * Detail endpoints return a single disclaimer object with the same structure
+                 * @returns PaginatedDisclaimerList
+                 * @throws ApiError
+                 */
+                public static v1DisclaimersList({
+                    active,
+                    mentorId,
+                    ordering,
+                    scope,
+                    search,
+                    page,
+                    pageSize,
+                }: {
+                    active?: boolean,
+                    mentorId?: string,
+                    /**
+                     * Which field to use when ordering the results.
+                     */
+                    ordering?: string,
+                    /**
+                     * * `platform` - Platform
+                     * * `mentor` - Mentor
+                     */
+                    scope?: 'mentor' | 'platform',
+                    /**
+                     * A search term.
+                     */
+                    search?: string,
+                    /**
+                     * A page number within the paginated result set.
+                     */
+                    page?: number,
+                    /**
+                     * Number of results to return per page.
+                     */
+                    pageSize?: number,
+                }): CancelablePromise<PaginatedDisclaimerList> {
+                    return __request(OpenAPI, {
+                        method: 'GET',
+                        url: '/v1/disclaimers',
+                        query: {
+                            'active': active,
+                            'mentor_id': mentorId,
+                            'ordering': ordering,
+                            'scope': scope,
+                            'search': search,
+                            'page': page,
+                            'page_size': pageSize,
+                        },
+                    });
+                }
+                /**
+                 * Requires the `iblai-org` and `iblai-user` context headers.
+                 *
+                 * ViewSet for managing mentor disclaimers.
+                 *
+                 * This viewset provides endpoints for creating and managing mentor disclaimers, which are
+                 * statements or information that mentors need to share with students.
+                 *
+                 * Permissions:
+                 * - Platform administrators have full CRUD access
+                 * - Students have read-only access
+                 * - Unauthenticated users have no access
+                 *
+                 * Endpoints:
+                 * - GET /api/orgs/{org}/users/{user_id}/disclaimers/ - List all disclaimers
+                 * - POST /api/orgs/{org}/users/{user_id}/disclaimers/ - Create a new disclaimer
+                 * - GET /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Retrieve a specific disclaimer
+                 * - PUT/PATCH /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Update a disclaimer
+                 * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/add_mentor/ - Add mentor to disclaimer
+                 * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/remove_mentor/ - Remove mentor from disclaimer
+                 *
+                 * Query Parameters:
+                 * - Supports filtering via DjangoFilterBackend
+                 * - See DisclaimerFilterSet for available filters
+                 *
+                 * Returns:
+                 * List endpoint returns paginated results with disclaimer objects:
+                 *
+                 * ```
+                 * {
+                     * "count": int,
+                     * "next": str,
+                     * "previous": str,
+                     * "results": [
+                         * {
+                             * "id": int,
+                             * "title": str,
+                             * "content": str,
+                             * "mentor": str,
+                             * "platform": str,
+                             * "created_at": datetime,
+                             * "updated_at": datetime
+                             * },
+                             * ...
+                             * ]
+                             * }
+                             * ```
+                             *
+                             * Detail endpoints return a single disclaimer object with the same structure
+                             * @returns Disclaimer
+                             * @throws ApiError
+                             */
+                            public static v1DisclaimersCreate({
+                                requestBody,
+                            }: {
+                                requestBody: Disclaimer,
+                            }): CancelablePromise<Disclaimer> {
+                                return __request(OpenAPI, {
+                                    method: 'POST',
+                                    url: '/v1/disclaimers',
+                                    body: requestBody,
+                                    mediaType: 'application/json',
+                                });
+                            }
+                            /**
+                             * Requires the `iblai-org` and `iblai-user` context headers.
+                             *
+                             * ViewSet for managing mentor disclaimers.
+                             *
+                             * This viewset provides endpoints for creating and managing mentor disclaimers, which are
+                             * statements or information that mentors need to share with students.
+                             *
+                             * Permissions:
+                             * - Platform administrators have full CRUD access
+                             * - Students have read-only access
+                             * - Unauthenticated users have no access
+                             *
+                             * Endpoints:
+                             * - GET /api/orgs/{org}/users/{user_id}/disclaimers/ - List all disclaimers
+                             * - POST /api/orgs/{org}/users/{user_id}/disclaimers/ - Create a new disclaimer
+                             * - GET /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Retrieve a specific disclaimer
+                             * - PUT/PATCH /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Update a disclaimer
+                             * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/add_mentor/ - Add mentor to disclaimer
+                             * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/remove_mentor/ - Remove mentor from disclaimer
+                             *
+                             * Query Parameters:
+                             * - Supports filtering via DjangoFilterBackend
+                             * - See DisclaimerFilterSet for available filters
+                             *
+                             * Returns:
+                             * List endpoint returns paginated results with disclaimer objects:
+                             *
+                             * ```
+                             * {
+                                 * "count": int,
+                                 * "next": str,
+                                 * "previous": str,
+                                 * "results": [
+                                     * {
+                                         * "id": int,
+                                         * "title": str,
+                                         * "content": str,
+                                         * "mentor": str,
+                                         * "platform": str,
+                                         * "created_at": datetime,
+                                         * "updated_at": datetime
+                                         * },
+                                         * ...
+                                         * ]
+                                         * }
+                                         * ```
+                                         *
+                                         * Detail endpoints return a single disclaimer object with the same structure
+                                         * @returns Disclaimer
+                                         * @throws ApiError
+                                         */
+                                        public static v1DisclaimersRetrieve({
+                                            id,
+                                        }: {
+                                            /**
+                                             * A unique integer value identifying this disclaimer.
+                                             */
+                                            id: number,
+                                        }): CancelablePromise<Disclaimer> {
+                                            return __request(OpenAPI, {
+                                                method: 'GET',
+                                                url: '/v1/disclaimers/{id}',
+                                                path: {
+                                                    'id': id,
+                                                },
+                                            });
+                                        }
+                                        /**
+                                         * Requires the `iblai-org` and `iblai-user` context headers.
+                                         *
+                                         * ViewSet for managing mentor disclaimers.
+                                         *
+                                         * This viewset provides endpoints for creating and managing mentor disclaimers, which are
+                                         * statements or information that mentors need to share with students.
+                                         *
+                                         * Permissions:
+                                         * - Platform administrators have full CRUD access
+                                         * - Students have read-only access
+                                         * - Unauthenticated users have no access
+                                         *
+                                         * Endpoints:
+                                         * - GET /api/orgs/{org}/users/{user_id}/disclaimers/ - List all disclaimers
+                                         * - POST /api/orgs/{org}/users/{user_id}/disclaimers/ - Create a new disclaimer
+                                         * - GET /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Retrieve a specific disclaimer
+                                         * - PUT/PATCH /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Update a disclaimer
+                                         * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/add_mentor/ - Add mentor to disclaimer
+                                         * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/remove_mentor/ - Remove mentor from disclaimer
+                                         *
+                                         * Query Parameters:
+                                         * - Supports filtering via DjangoFilterBackend
+                                         * - See DisclaimerFilterSet for available filters
+                                         *
+                                         * Returns:
+                                         * List endpoint returns paginated results with disclaimer objects:
+                                         *
+                                         * ```
+                                         * {
+                                             * "count": int,
+                                             * "next": str,
+                                             * "previous": str,
+                                             * "results": [
+                                                 * {
+                                                     * "id": int,
+                                                     * "title": str,
+                                                     * "content": str,
+                                                     * "mentor": str,
+                                                     * "platform": str,
+                                                     * "created_at": datetime,
+                                                     * "updated_at": datetime
+                                                     * },
+                                                     * ...
+                                                     * ]
+                                                     * }
+                                                     * ```
+                                                     *
+                                                     * Detail endpoints return a single disclaimer object with the same structure
+                                                     * @returns Disclaimer
+                                                     * @throws ApiError
+                                                     */
+                                                    public static v1DisclaimersPartialUpdate({
+                                                        id,
+                                                        requestBody,
+                                                    }: {
+                                                        /**
+                                                         * A unique integer value identifying this disclaimer.
+                                                         */
+                                                        id: number,
+                                                        requestBody?: PatchedDisclaimer,
+                                                    }): CancelablePromise<Disclaimer> {
+                                                        return __request(OpenAPI, {
+                                                            method: 'PATCH',
+                                                            url: '/v1/disclaimers/{id}',
+                                                            path: {
+                                                                'id': id,
+                                                            },
+                                                            body: requestBody,
+                                                            mediaType: 'application/json',
+                                                        });
+                                                    }
+                                                    /**
+                                                     * Requires the `iblai-org` and `iblai-user` context headers.
+                                                     *
+                                                     * ViewSet for managing mentor disclaimers.
+                                                     *
+                                                     * This viewset provides endpoints for creating and managing mentor disclaimers, which are
+                                                     * statements or information that mentors need to share with students.
+                                                     *
+                                                     * Permissions:
+                                                     * - Platform administrators have full CRUD access
+                                                     * - Students have read-only access
+                                                     * - Unauthenticated users have no access
+                                                     *
+                                                     * Endpoints:
+                                                     * - GET /api/orgs/{org}/users/{user_id}/disclaimers/ - List all disclaimers
+                                                     * - POST /api/orgs/{org}/users/{user_id}/disclaimers/ - Create a new disclaimer
+                                                     * - GET /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Retrieve a specific disclaimer
+                                                     * - PUT/PATCH /api/orgs/{org}/users/{user_id}/disclaimers/{id}/ - Update a disclaimer
+                                                     * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/add_mentor/ - Add mentor to disclaimer
+                                                     * - POST /api/orgs/{org}/users/{user_id}/disclaimers/{id}/remove_mentor/ - Remove mentor from disclaimer
+                                                     *
+                                                     * Query Parameters:
+                                                     * - Supports filtering via DjangoFilterBackend
+                                                     * - See DisclaimerFilterSet for available filters
+                                                     *
+                                                     * Returns:
+                                                     * List endpoint returns paginated results with disclaimer objects:
+                                                     *
+                                                     * ```
+                                                     * {
+                                                         * "count": int,
+                                                         * "next": str,
+                                                         * "previous": str,
+                                                         * "results": [
+                                                             * {
+                                                                 * "id": int,
+                                                                 * "title": str,
+                                                                 * "content": str,
+                                                                 * "mentor": str,
+                                                                 * "platform": str,
+                                                                 * "created_at": datetime,
+                                                                 * "updated_at": datetime
+                                                                 * },
+                                                                 * ...
+                                                                 * ]
+                                                                 * }
+                                                                 * ```
+                                                                 *
+                                                                 * Detail endpoints return a single disclaimer object with the same structure
+                                                                 * @returns Disclaimer
+                                                                 * @throws ApiError
+                                                                 */
+                                                                public static v1DisclaimersUpdate({
+                                                                    id,
+                                                                    requestBody,
+                                                                }: {
+                                                                    /**
+                                                                     * A unique integer value identifying this disclaimer.
+                                                                     */
+                                                                    id: number,
+                                                                    requestBody: Disclaimer,
+                                                                }): CancelablePromise<Disclaimer> {
+                                                                    return __request(OpenAPI, {
+                                                                        method: 'PUT',
+                                                                        url: '/v1/disclaimers/{id}',
+                                                                        path: {
+                                                                            'id': id,
+                                                                        },
+                                                                        body: requestBody,
+                                                                        mediaType: 'application/json',
+                                                                    });
+                                                                }
+                                                            }

package/src/services/V1FeaturesService.ts

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PaginatedUserAppList } from '../models/PaginatedUserAppList';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class V1FeaturesService {
+    /**
+     * Returns a list of the apps that the user has access to
+     * Returns a list of the apps that the user has access to.
+     * @returns PaginatedUserAppList
+     * @throws ApiError
+     */
+    public static v1FeaturesAppsList({
+        page,
+        pageSize,
+    }: {
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number,
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number,
+    }): CancelablePromise<PaginatedUserAppList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/features/apps',
+            query: {
+                'page': page,
+                'page_size': pageSize,
+            },
+        });
+    }
+}

package/src/services/V1LlmsService.ts

@@ -0,0 +1,79 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { LLMResponse } from '../models/LLMResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export 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
+     */
+    public static v1LlmsList({
+        allowMixingTools,
+        includeGlobal = false,
+        isMultimodal,
+        mentorId,
+        mentorUniqueId,
+        minContextWindow,
+        provider = '',
+        search = '',
+        supportsFunctionCalling,
+        view = 'grid',
+    }: {
+        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>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/llms',
+            query: {
+                'allow_mixing_tools': allowMixingTools,
+                'include_global': includeGlobal,
+                'is_multimodal': isMultimodal,
+                'mentor_id': mentorId,
+                'mentor_unique_id': mentorUniqueId,
+                'min_context_window': minContextWindow,
+                'provider': provider,
+                'search': search,
+                'supports_function_calling': supportsFunctionCalling,
+                'view': view,
+            },
+        });
+    }
+}

package/src/services/V1MemsearchStatusService.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export 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
+     */
+    public static v1MemsearchStatusRetrieve(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/memsearch-status',
+        });
+    }
+}

package/src/services/V1NotificationsService.ts

@@ -0,0 +1,136 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Notification } from '../models/Notification';
+import type { NotificationCount } from '../models/NotificationCount';
+import type { NotificationsUpdate } from '../models/NotificationsUpdate';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export 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
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/notifications',
+            headers: {
+                'iblai-user': iblaiUser,
+            },
+            query: {
+                'channel': channel,
+                'end_date': endDate,
+                'exclude_channel': excludeChannel,
+                'start_date': startDate,
+                'status': status,
+                'tags': tags,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/v1/notifications',
+            headers: {
+                'iblai-user': iblaiUser,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * 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
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/v1/notifications/count',
+            query: {
+                'channel': channel,
+                'status': status,
+            },
+        });
+    }
+}