@iblai/iblai-api 4.23.2-test-ai → 4.26.0-ai

package/dist/index.cjs.js

@@ -110,7 +110,7 @@ class CancelablePromise {
 
 const OpenAPI = {
   BASE: 'https://base.manager.iblai.app',
-  VERSION: '4.23.2-ai-plus',
+  VERSION: '4.26.0-ai-plus',
   WITH_CREDENTIALS: false,
   CREDENTIALS: 'include',
   TOKEN: undefined,
@@ -697,6 +697,20 @@ exports.ResourceScrappedDataStatusEnum = void 0;
   ResourceScrappedDataStatusEnum["UNSCRAPPED"] = "unscrapped";
 })(exports.ResourceScrappedDataStatusEnum || (exports.ResourceScrappedDataStatusEnum = {}));
 
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `platform` - Platform
+ * * `mentor` - Mentor
+ */
+exports.ScopeEnum = void 0;
+(function (ScopeEnum) {
+  ScopeEnum["PLATFORM"] = "platform";
+  ScopeEnum["MENTOR"] = "mentor";
+})(exports.ScopeEnum || (exports.ScopeEnum = {}));
+
 /* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
 /* tslint:disable */
@@ -6516,6 +6530,42 @@ class AiAnalyticsService {
       }
     });
   }
+  /**
+   * Unified API endpoint for learner analytics.
+   *
+   * This endpoint provides either:
+   * 1. Cross-platform summary (when only username is provided)
+   * 2. Platform-specific detailed data (when username + platform_key are provided)
+   *
+   * Query params:
+   * - username (required): Username of the learner
+   * - platform_key (optional): Platform key for platform-specific data
+   * - page (optional): Page number (default: 1)
+   * - limit (optional): Records per page (default: 20, max: 100)
+   *
+   * Returns:
+   * - If platform_key provided: Detailed platform metrics
+   * - If no platform_key: Cross-platform summary with pagination
+   * @returns LearnerAnalyticsResponse
+   * @throws ApiError
+   */
+  static analyticsLearnersRetrieve({
+    limit = 20,
+    page = 1,
+    platformKey,
+    username
+  }) {
+    return request(OpenAPI, {
+      method: 'GET',
+      url: '/api/analytics/learners/',
+      query: {
+        'limit': limit,
+        'page': page,
+        'platform_key': platformKey,
+        'username': username
+      }
+    });
+  }
   /**
    * Conversation list endpoint for analytics.
    *
@@ -12354,6 +12404,104 @@ class AiMediaService {
       }
     });
   }
+  /**
+   * Endpoint to generate video scripts from a audio file. The audio file can be one of mp3 and wav.
+   *
+   * The request should be a multipart form with your audio file in the `file` field.
+   *
+   * Initial Response:
+   * ```
+   * {"script": None, "status": "started_generation", "generation_id": "your-generation-id."}
+   * ```
+   * This signals the generation has started. You can use the generation id to query video script generation status from this endpoint, using a JSON like below:
+   * ```
+   * {"generation_id": "your-generation-id"}
+   * ```
+   *
+   * Example response:
+   * ```
+   * {"script": "hello this is a video script.", "status": "finished", "generation_id": "your-generation-id"}
+   *
+   * ```
+   * @returns any No response body
+   * @throws ApiError
+   */
+  static aiMediaOrgsUsersVideoScriptGenerationAudioCreate({
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'POST',
+      url: '/api/ai-media/orgs/{org}/users/{user_id}/video-script-generation/audio/',
+      path: {
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
+  /**
+   *     Endpoint to generate video scripts from a document file. The document file can be one of docx, doc, pptx, ppt, txt and pdf.
+   *
+   * The request should be a multipart form with your document file in the `file` field.
+   * Initial Response:
+   * ```
+   * {"script": None, "status": "started_generation", "generation_id": "your-generation-id."}
+   * ```
+   * This signals the generation has started. You can use the generation id to query video script generation status from this endpoint, using a JSON like below:
+   * ```
+   * {"generation_id": "your-generation-id"}
+   * ```
+   *
+   * Example response:
+   * ```
+   * {"script": "hello this is a video script.", "status": "finished", "generation_id": "your-generation-id"}
+   *
+   * ```
+   * @returns any No response body
+   * @throws ApiError
+   */
+  static aiMediaOrgsUsersVideoScriptGenerationDocumentCreate({
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'POST',
+      url: '/api/ai-media/orgs/{org}/users/{user_id}/video-script-generation/document/',
+      path: {
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
+  /**
+   * Endpoint to generate video scripts from a text.
+   *
+   * The request body should be a JSON with your text, like below:
+   * ```
+   * {"text": "Generate a script about a campus comedy."}
+   * ```
+   *
+   * Example response:
+   * ```
+   * {"script": "hello this is a video script."}
+   *
+   * ```
+   * @returns any No response body
+   * @throws ApiError
+   */
+  static aiMediaOrgsUsersVideoScriptGenerationTextCreate({
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'POST',
+      url: '/api/ai-media/orgs/{org}/users/{user_id}/video-script-generation/text/',
+      path: {
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
 }
 
 class AiMentorService {
@@ -15932,6 +16080,575 @@ class AiMentorService {
       }
     });
   }
+  /**
+   * API view for managing disclaimer agreements.
+   *
+   * This viewset provides Create Read and Delete operations for disclaimer agreements with different access levels:
+   *
+   * Platform Admins:
+   * - Can view all disclaimer agreements for their platform
+   * - Have full access to create (for themselves) and delete agreements for themselves and other users.
+   * - Results are paginated and can be filtered
+   *
+   * Students:
+   * - Can only view their own disclaimer agreements
+   * - Limited to agreements where they are the user
+   * - Results are paginated and can be filtered
+   *
+   * List endpoint returns paginated results with disclaimer agreement objects:
+   * {
+       * "count": int,
+       * "next": str,
+       * "previous": str,
+       * "results": [
+           * {
+               * "id": int,
+               * "user": str,
+               * "disclaimer": int,
+               * "agreed_at": datetime,
+               *
+               * },
+               * ...
+               * ]
+               * }
+               *
+               * Detail endpoints return a single disclaimer agreement object with the same structure
+               * @returns PaginatedDisclaimerAgreementList
+               * @throws ApiError
+               */
+  static aiMentorOrgsUsersDisclaimerAgreementsList({
+    org,
+    userId,
+    disclaimer,
+    mentorId,
+    page,
+    pageSize,
+    username
+  }) {
+    return request(OpenAPI, {
+      method: 'GET',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimer-agreements/',
+      path: {
+        'org': org,
+        'user_id': userId
+      },
+      query: {
+        'disclaimer': disclaimer,
+        'mentor_id': mentorId,
+        'page': page,
+        'page_size': pageSize,
+        'username': username
+      }
+    });
+  }
+  /**
+   * API view for managing disclaimer agreements.
+   *
+   * This viewset provides Create Read and Delete operations for disclaimer agreements with different access levels:
+   *
+   * Platform Admins:
+   * - Can view all disclaimer agreements for their platform
+   * - Have full access to create (for themselves) and delete agreements for themselves and other users.
+   * - Results are paginated and can be filtered
+   *
+   * Students:
+   * - Can only view their own disclaimer agreements
+   * - Limited to agreements where they are the user
+   * - Results are paginated and can be filtered
+   *
+   * List endpoint returns paginated results with disclaimer agreement objects:
+   * {
+       * "count": int,
+       * "next": str,
+       * "previous": str,
+       * "results": [
+           * {
+               * "id": int,
+               * "user": str,
+               * "disclaimer": int,
+               * "agreed_at": datetime,
+               *
+               * },
+               * ...
+               * ]
+               * }
+               *
+               * Detail endpoints return a single disclaimer agreement object with the same structure
+               * @returns DisclaimerAgreement
+               * @throws ApiError
+               */
+  static aiMentorOrgsUsersDisclaimerAgreementsCreate({
+    org,
+    userId,
+    requestBody
+  }) {
+    return request(OpenAPI, {
+      method: 'POST',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimer-agreements/',
+      path: {
+        'org': org,
+        'user_id': userId
+      },
+      body: requestBody,
+      mediaType: 'application/json'
+    });
+  }
+  /**
+   * API view for managing disclaimer agreements.
+   *
+   * This viewset provides Create Read and Delete operations for disclaimer agreements with different access levels:
+   *
+   * Platform Admins:
+   * - Can view all disclaimer agreements for their platform
+   * - Have full access to create (for themselves) and delete agreements for themselves and other users.
+   * - Results are paginated and can be filtered
+   *
+   * Students:
+   * - Can only view their own disclaimer agreements
+   * - Limited to agreements where they are the user
+   * - Results are paginated and can be filtered
+   *
+   * List endpoint returns paginated results with disclaimer agreement objects:
+   * {
+       * "count": int,
+       * "next": str,
+       * "previous": str,
+       * "results": [
+           * {
+               * "id": int,
+               * "user": str,
+               * "disclaimer": int,
+               * "agreed_at": datetime,
+               *
+               * },
+               * ...
+               * ]
+               * }
+               *
+               * Detail endpoints return a single disclaimer agreement object with the same structure
+               * @returns DisclaimerAgreement
+               * @throws ApiError
+               */
+  static aiMentorOrgsUsersDisclaimerAgreementsRetrieve({
+    id,
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'GET',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimer-agreements/{id}/',
+      path: {
+        'id': id,
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
+  /**
+   * API view for managing disclaimer agreements.
+   *
+   * This viewset provides Create Read and Delete operations for disclaimer agreements with different access levels:
+   *
+   * Platform Admins:
+   * - Can view all disclaimer agreements for their platform
+   * - Have full access to create (for themselves) and delete agreements for themselves and other users.
+   * - Results are paginated and can be filtered
+   *
+   * Students:
+   * - Can only view their own disclaimer agreements
+   * - Limited to agreements where they are the user
+   * - Results are paginated and can be filtered
+   *
+   * List endpoint returns paginated results with disclaimer agreement objects:
+   * {
+       * "count": int,
+       * "next": str,
+       * "previous": str,
+       * "results": [
+           * {
+               * "id": int,
+               * "user": str,
+               * "disclaimer": int,
+               * "agreed_at": datetime,
+               *
+               * },
+               * ...
+               * ]
+               * }
+               *
+               * Detail endpoints return a single disclaimer agreement object with the same structure
+               * @returns void
+               * @throws ApiError
+               */
+  static aiMentorOrgsUsersDisclaimerAgreementsDestroy({
+    id,
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'DELETE',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimer-agreements/{id}/',
+      path: {
+        'id': id,
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
+  /**
+   * 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 any No response body
+               * @throws ApiError
+               */
+  static aiMentorOrgsUsersDisclaimersRetrieve({
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'GET',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimers/',
+      path: {
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
+  /**
+   * 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 any No response body
+               * @throws ApiError
+               */
+  static aiMentorOrgsUsersDisclaimersCreate({
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'POST',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimers/',
+      path: {
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
+  /**
+   * 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 any No response body
+               * @throws ApiError
+               */
+  static aiMentorOrgsUsersDisclaimersRetrieve2({
+    id,
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'GET',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimers/{id}/',
+      path: {
+        'id': id,
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
+  /**
+   * 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 any No response body
+               * @throws ApiError
+               */
+  static aiMentorOrgsUsersDisclaimersUpdate({
+    id,
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'PUT',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimers/{id}/',
+      path: {
+        'id': id,
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
+  /**
+   * 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 any No response body
+               * @throws ApiError
+               */
+  static aiMentorOrgsUsersDisclaimersPartialUpdate({
+    id,
+    org,
+    userId
+  }) {
+    return request(OpenAPI, {
+      method: 'PATCH',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimers/{id}/',
+      path: {
+        'id': id,
+        'org': org,
+        'user_id': userId
+      }
+    });
+  }
+  /**
+   * Add mentor to disclaimer
+   * Add a mentor to a disclaimer with `mentor` scope. Only platform admins can perform this action.
+   * @returns Disclaimer
+   * @throws ApiError
+   */
+  static aiMentorOrgsUsersDisclaimersAddMentorCreate({
+    id,
+    org,
+    userId,
+    requestBody
+  }) {
+    return request(OpenAPI, {
+      method: 'POST',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimers/{id}/add-mentor/',
+      path: {
+        'id': id,
+        'org': org,
+        'user_id': userId
+      },
+      body: requestBody,
+      mediaType: 'application/json'
+    });
+  }
+  /**
+   * Remove mentor from disclaimer
+   * Remove a mentor from a disclaimer with `mentor` scope. Only platform admins can perform this action. Validates that at least one mentor remains after removal.
+   * @returns Disclaimer
+   * @throws ApiError
+   */
+  static aiMentorOrgsUsersDisclaimersRemoveMentorCreate({
+    id,
+    org,
+    userId,
+    requestBody
+  }) {
+    return request(OpenAPI, {
+      method: 'POST',
+      url: '/api/ai-mentor/orgs/{org}/users/{user_id}/disclaimers/{id}/remove-mentor/',
+      path: {
+        'id': id,
+        'org': org,
+        'user_id': userId
+      },
+      body: requestBody,
+      mediaType: 'application/json'
+    });
+  }
   /**
    * Retrieves the chat history for a user if the export task is ready.
    *