@iblai/iblai-api 3.45.14-core → 3.45.15-ai

package/dist/types/models/AssumedKnowledgeLevel.d.ts

@@ -0,0 +1,4 @@
+export type AssumedKnowledgeLevel = {
+    category: string;
+    level: string;
+};

package/dist/types/models/AudioToTextRequest.d.ts

@@ -0,0 +1,3 @@
+export type AudioToTextRequest = {
+    file: string;
+};

package/dist/types/models/AudioToTextResponse.d.ts

@@ -0,0 +1,3 @@
+export type AudioToTextResponse = {
+    text: string;
+};

package/dist/types/models/CallAuthenticationRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Serializer for IBL Call Pro authentication request.
+ */
+export type CallAuthenticationRequest = {
+    /**
+     * The ID of the session for the call
+     */
+    session_id: string;
+    /**
+     * The pathway identifier for the call context
+     */
+    pathway: string;
+};

package/dist/types/models/CallAuthenticationResponse.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Serializer for IBL Call Pro authentication parameters.
+ */
+export type CallAuthenticationResponse = {
+    /**
+     * The WebSocket URL for the IBL Call Pro server
+     */
+    ws_url: string;
+    /**
+     * The name of the IBL Call Pro room
+     */
+    room_name: string;
+    /**
+     * The name of the participant joining the room
+     */
+    participant_name: string;
+    /**
+     * The JWT token for authenticating the participant
+     */
+    participant_token: string;
+};

package/dist/types/models/ChatHistory.d.ts

@@ -0,0 +1,8 @@
+export type ChatHistory = {
+    readonly id: number;
+    message?: any;
+    readonly inserted_at: string;
+    title?: string | null;
+    readonly feedback: any;
+    document_sources?: any;
+};

package/dist/types/models/ChatHistoryFilterData.d.ts

@@ -0,0 +1,9 @@
+import type { ChatHistoryFilterUser } from './ChatHistoryFilterUser';
+import type { DateRange } from './DateRange';
+import type { TopicModel } from './TopicModel';
+export type ChatHistoryFilterData = {
+    topics: Array<TopicModel>;
+    date_ranges?: Array<DateRange>;
+    sentiment?: Array<string>;
+    users: Array<ChatHistoryFilterUser>;
+};

package/dist/types/models/ChatHistoryFilterUser.d.ts

@@ -0,0 +1,5 @@
+export type ChatHistoryFilterUser = {
+    username: string;
+    email: string;
+    readonly lti_email: string;
+};

package/dist/types/models/ChatHistoryItem.d.ts

@@ -0,0 +1,5 @@
+export type ChatHistoryItem = {
+    type: string;
+    content: string;
+    timestamp: string;
+};

package/dist/types/models/ChatHistorySessionId.d.ts

@@ -0,0 +1,3 @@
+export type ChatHistorySessionId = {
+    id: string;
+};

package/dist/types/models/ChatSessionRequest.d.ts

@@ -0,0 +1,10 @@
+export type ChatSessionRequest = {
+    /**
+     * Name of mentor
+     */
+    mentor: string;
+    /**
+     * List of tools slugs to use. Passing `null` will use all tools assigned to the mentor. For no tools, pass an empty list.
+     */
+    tools?: Array<string>;
+};

package/dist/types/models/ChatSessionResponse.d.ts

@@ -0,0 +1,5 @@
+import type { ToolResponse } from './ToolResponse';
+export type ChatSessionResponse = {
+    session_id: string;
+    tools: Array<ToolResponse>;
+};

package/dist/types/models/CheckDocumentTrainingStatus.d.ts

@@ -0,0 +1,10 @@
+export type CheckDocumentTrainingStatus = {
+    /**
+     * Status of the training
+     */
+    status: string;
+    /**
+     * Message of the training
+     */
+    message: string;
+};

package/dist/types/models/ComponentBlock.d.ts

@@ -0,0 +1,9 @@
+import type { ComponentBlockTypeEnum } from './ComponentBlockTypeEnum';
+export type ComponentBlock = {
+    readonly id: number;
+    unit: number;
+    type?: ComponentBlockTypeEnum;
+    display_name: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

package/dist/types/models/ComponentBlockTypeEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * * `html` - Html
+ * * `multiple_choice` - Multiple Choice
+ */
+export declare enum ComponentBlockTypeEnum {
+    HTML = "html",
+    MULTIPLE_CHOICE = "multiple_choice"
+}

package/dist/types/models/ConversationMessage.d.ts

@@ -0,0 +1,11 @@
+import type { TopicModel } from './TopicModel';
+export type ConversationMessage = {
+    readonly first_message: string;
+    topics: Array<TopicModel>;
+    id: string;
+    user_id: string;
+    readonly message_count: number;
+    model: string;
+    inserted_at: string;
+    readonly user_sentiment: string;
+};

package/dist/types/models/ConversationRating.d.ts

@@ -0,0 +1,6 @@
+export type ConversationRating = {
+    readonly id: number;
+    full_conversation_text: string;
+    rating_text?: string | null;
+    score?: number | null;
+};

package/dist/types/models/ConversationSummary.d.ts

@@ -0,0 +1,5 @@
+export type ConversationSummary = {
+    total_conversations: number;
+    total_human_messages: number;
+    total_ai_messages: number;
+};

package/dist/types/models/ConversationVolume.d.ts

@@ -0,0 +1,4 @@
+export type ConversationVolume = {
+    date: string;
+    conversation_count: number;
+};

package/dist/types/models/Conversations.d.ts

@@ -0,0 +1,28 @@
+import type { TopicModel } from './TopicModel';
+export type Conversations = {
+    readonly id: string;
+    readonly messages: string;
+    topics: Array<TopicModel>;
+    readonly sentiment: string;
+    mentor: string;
+    readonly student: string;
+    readonly email: string;
+    model: string;
+    readonly rating: number;
+    platform: string;
+    /**
+     * Email claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_email: string;
+    /**
+     * Username claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_username: string;
+    readonly inserted_at: string;
+    has_document?: boolean;
+    memory_tracked?: boolean;
+    llm_name?: string | null;
+    llm_provider?: string | null;
+    metadata?: any;
+    tools?: Array<number>;
+};

package/dist/types/models/Cost.d.ts

@@ -0,0 +1,3 @@
+export type Cost = {
+    total_cost: number;
+};

package/dist/types/models/CostPerTenant.d.ts

@@ -0,0 +1,6 @@
+import type { ModelCost } from './ModelCost';
+export type CostPerTenant = {
+    platform_key: string;
+    total_cost: number;
+    model_costs: Array<ModelCost>;
+};

package/dist/types/models/CourseCreationTask.d.ts

@@ -0,0 +1,31 @@
+import type { CourseCreationTaskFile } from './CourseCreationTaskFile';
+import type { CourseCreationTaskStatusEnum } from './CourseCreationTaskStatusEnum';
+export type CourseCreationTask = {
+    readonly id: number;
+    readonly user_id: string;
+    /**
+     * edX user ID
+     */
+    readonly student: number;
+    name: string;
+    /**
+     * Description of the course to create and its requirements
+     */
+    description: string;
+    /**
+     * The intended audience for the course. eg. Grade 11 students.
+     */
+    target_audience: string;
+    readonly platform: number;
+    readonly platform_key: string;
+    readonly status: CourseCreationTaskStatusEnum;
+    publish_course?: boolean;
+    readonly course_data: any;
+    provider?: string;
+    model?: string;
+    desired_number_of_sections?: number;
+    readonly logs: string;
+    readonly files: Array<CourseCreationTaskFile>;
+    readonly date_created: string;
+    readonly last_modified: string;
+};

package/dist/types/models/CourseCreationTaskFile.d.ts

@@ -0,0 +1,7 @@
+export type CourseCreationTaskFile = {
+    readonly id: number;
+    course_creation_task: number;
+    file: string;
+    readonly date_created: string;
+    readonly last_modified: string;
+};

package/dist/types/models/CourseCreationTaskStatusEnum.d.ts

@@ -0,0 +1,16 @@
+/**
+ * * `Pending` - Pending
+ * * `Scheduled` - Scheduled
+ * * `Success` - Success
+ * * `Failed` - Failed
+ * * `Cancelled` - Cancelled
+ * * `In Progress` - In Progress
+ */
+export declare enum CourseCreationTaskStatusEnum {
+    PENDING = "Pending",
+    SCHEDULED = "Scheduled",
+    SUCCESS = "Success",
+    FAILED = "Failed",
+    CANCELLED = "Cancelled",
+    IN_PROGRESS = "In Progress"
+}

package/dist/types/models/CourseGroupSuggestionDetail.d.ts

@@ -21,7 +21,7 @@ export type CourseGroupSuggestionDetail = {
     /**
      * Whether the suggestion has been accepted
      */
-    accepted: boolean;
+    accepted?: boolean;
     /**
      * Whether the suggestion is visible
      */
@@ -49,5 +49,5 @@ export type CourseGroupSuggestionDetail = {
     /**
      * Number of users in the group
      */
-    user_count: number;
+    user_count?: number;
 };

package/dist/types/models/CourseInvitationDetail.d.ts

@@ -9,7 +9,7 @@ export type CourseInvitationDetail = {
     /**
      * The ID of the user associated with the invitation
      */
-    user_id: number | null;
+    user_id?: number | null;
     /**
      * The username of the user associated with the invitation
      */
@@ -21,7 +21,7 @@ export type CourseInvitationDetail = {
     /**
      * When the invitation was created
      */
-    created: string;
+    created?: string;
     /**
      * When the invitation was started
      */

package/dist/types/models/CourseLicenseAssignmentDetail.d.ts

@@ -25,11 +25,11 @@ export type CourseLicenseAssignmentDetail = {
     /**
      * Whether the assignment has been fulfilled
      */
-    fulfilled: boolean;
+    fulfilled?: boolean;
     /**
      * URL to redirect to after fulfillment
      */
-    redirect_to: string | null;
+    redirect_to?: string | null;
     /**
      * Additional metadata for the assignment
      */

package/dist/types/models/CourseLicenseDetail.d.ts

@@ -50,4 +50,8 @@ export type CourseLicenseDetail = {
      * The course ID associated with the license
      */
     course_id: string;
+    /**
+     * The number of seats purchased
+     */
+    usage_count?: number;
 };

package/dist/types/models/CourseLicenseGroupAssignmentDetail.d.ts

@@ -21,11 +21,11 @@ export type CourseLicenseGroupAssignmentDetail = {
     /**
      * Whether the assignment has been fulfilled
      */
-    fulfilled: boolean;
+    fulfilled?: boolean;
     /**
      * URL to redirect to after fulfillment
      */
-    redirect_to: string | null;
+    redirect_to?: string | null;
     /**
      * Additional metadata for the assignment
      */

package/dist/types/models/CredentialRequest.d.ts

@@ -0,0 +1,14 @@
+export type CredentialRequest = {
+    /**
+     * Name of the credential provider (e.g., 'openai', 'google-drive')
+     */
+    name: string;
+    /**
+     * Credential data for the provider (API keys, service account details, etc.)
+     */
+    value: any;
+    /**
+     * Organization key identifier for the tenant
+     */
+    platform: string;
+};

package/dist/types/models/CrontabSchedule.d.ts

@@ -0,0 +1,22 @@
+export type CrontabSchedule = {
+    /**
+     * Cron Minutes to Run. Use "*" for "all". (Example: "0,30")
+     */
+    minute?: string;
+    /**
+     * Cron Hours to Run. Use "*" for "all". (Example: "8,20")
+     */
+    hour?: string;
+    /**
+     * Cron Days Of The Week to Run. Use "*" for "all", Sunday is 0 or 7, Monday is 1. (Example: "0,5")
+     */
+    day_of_week?: string;
+    /**
+     * Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")
+     */
+    day_of_month?: string;
+    /**
+     * Cron Months (1-12) Of The Year to Run. Use "*" for "all". (Example: "1,12")
+     */
+    month_of_year?: string;
+};

package/dist/types/models/CustomInstructionResponse.d.ts

@@ -0,0 +1,13 @@
+export type CustomInstructionResponse = {
+    readonly id: number;
+    about_user?: string | null;
+    mentor_tone?: string | null;
+    /**
+     * Position or work. eg: Engineer, student etc.
+     */
+    profession?: string;
+    /**
+     * Comma separated list of expected traits for mentor.
+     */
+    desired_mentor_traits?: string;
+};

package/dist/types/models/DateRange.d.ts

@@ -0,0 +1,4 @@
+export type DateRange = {
+    start_date: string;
+    end_date: string;
+};

package/dist/types/models/Document.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Serializer for document objects
+ */
+export type Document = {
+    /**
+     * Document ID
+     */
+    id: number;
+    /**
+     * Name of the document
+     */
+    document_name: string;
+    /**
+     * Type of document (e.g., 'pdf', 'text')
+     */
+    document_type: string;
+    /**
+     * Access level of the document
+     */
+    access: string;
+    /**
+     * Training status of the document
+     */
+    training_status: string;
+    /**
+     * Date when the document was created
+     */
+    date_created: string;
+    /**
+     * Date when the document was last modified
+     */
+    last_modified: string;
+    /**
+     * URL to access the document
+     */
+    url: string;
+    /**
+     * Additional metadata for the document
+     */
+    metadata: any;
+};

package/dist/types/models/DocumentFacet.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Serializer for document facets
+ */
+export type DocumentFacet = {
+    /**
+     * Total number of documents in this facet
+     */
+    total: number;
+    /**
+     * Terms and their counts in this facet
+     */
+    terms: Record<string, any>;
+    /**
+     * Count of documents not in any term
+     */
+    other: number;
+};

package/dist/types/models/DocumentSearchResponse.d.ts

@@ -0,0 +1,35 @@
+import type { Document } from './Document';
+import type { DocumentFacet } from './DocumentFacet';
+/**
+ * Response serializer for DocumentSearchView
+ */
+export type DocumentSearchResponse = {
+    /**
+     * List of documents matching the search criteria
+     */
+    results: Array<Document>;
+    /**
+     * Total number of documents matching the search criteria
+     */
+    count: number;
+    /**
+     * URL for the next page of results
+     */
+    next: string | null;
+    /**
+     * URL for the previous page of results
+     */
+    previous: string | null;
+    /**
+     * Current page number
+     */
+    current_page: number;
+    /**
+     * Total number of pages
+     */
+    total_pages: number;
+    /**
+     * Facet information for filtering
+     */
+    facets: Record<string, DocumentFacet>;
+};

package/dist/types/models/DocumentSettingsResponse.d.ts

@@ -0,0 +1,3 @@
+export type DocumentSettingsResponse = {
+    retrain_interval_seconds?: number | null;
+};

package/dist/types/models/EdxCourse.d.ts

@@ -0,0 +1,11 @@
+export type EdxCourse = {
+    readonly id: number;
+    name: string;
+    run: string;
+    number: string;
+    description?: string;
+    xblock_id: string;
+    task?: number | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

package/dist/types/models/ElevenlabsCustomVoice.d.ts

@@ -0,0 +1,4 @@
+export type ElevenlabsCustomVoice = {
+    name: string;
+    files: Array<string>;
+};

package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts

@@ -0,0 +1,8 @@
+export type ElevenlabsCustomVoiceResponse = {
+    name: string;
+    readonly owner_student: string | null;
+    language?: string;
+    is_premade?: boolean;
+    description?: string;
+    readonly sample_audio_url: string | null;
+};

package/dist/types/models/EmailPromptDetail.d.ts

@@ -0,0 +1,13 @@
+export type EmailPromptDetail = {
+    readonly id: number;
+    readonly inserted_at: string;
+    sender_email: string;
+    sender_name?: string | null;
+    subject?: string | null;
+    content: string;
+    mentor_name?: string | null;
+    mentor_email: string;
+    is_processed?: boolean;
+    mentor_response?: string | null;
+    send_status?: string | null;
+};

package/dist/types/models/EmailPromptList.d.ts

@@ -0,0 +1,11 @@
+export type EmailPromptList = {
+    readonly id: number;
+    sender_email: string;
+    sender_name?: string | null;
+    subject?: string | null;
+    readonly content_summary: string | null;
+    mentor_name?: string | null;
+    mentor_email: string;
+    is_processed?: boolean;
+    readonly inserted_at: string;
+};

package/dist/types/models/EmailPromptSummary.d.ts

@@ -0,0 +1,5 @@
+export type EmailPromptSummary = {
+    readonly total_emails: number;
+    readonly replied_emails: number;
+    readonly pending_emails: number;
+};

package/dist/types/models/FreeUsageCount.d.ts

@@ -0,0 +1,3 @@
+export type FreeUsageCount = {
+    count: number;
+};

package/dist/types/models/FullCourse.d.ts

@@ -0,0 +1,13 @@
+import type { SectionWithChildren } from './SectionWithChildren';
+export type FullCourse = {
+    readonly id: number;
+    name: string;
+    run: string;
+    number: string;
+    description?: string;
+    xblock_id: string;
+    task?: number | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+    sections: Array<SectionWithChildren>;
+};

package/dist/types/models/GreetingMethodEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * * `proactive_prompt` - Proactive Prompt
+ * * `proactive_response` - Proactive Response
+ */
+export declare enum GreetingMethodEnum {
+    PROACTIVE_PROMPT = "proactive_prompt",
+    PROACTIVE_RESPONSE = "proactive_response"
+}

package/dist/types/models/GuidedPromptsResponse.d.ts

@@ -0,0 +1,3 @@
+export type GuidedPromptsResponse = {
+    ai_prompts: Array<string>;
+};

package/dist/types/models/HeygenMarketingVideoDetail.d.ts

@@ -0,0 +1,8 @@
+export type HeygenMarketingVideoDetail = {
+    name?: string;
+    data?: any;
+    script?: string | null;
+    readonly pk: number;
+    readonly video_file: string | null;
+    readonly generation_status: string;
+};

package/dist/types/models/HeygenMarketingVideoList.d.ts

@@ -0,0 +1,6 @@
+export type HeygenMarketingVideoList = {
+    name?: string;
+    data?: any;
+    readonly pk: number;
+    readonly generation_status: string;
+};

package/dist/types/models/HeygenTemplateRequest.d.ts

@@ -0,0 +1,5 @@
+export type HeygenTemplateRequest = {
+    template_id: string;
+    preview_image_url?: string | null;
+    name: string;
+};

package/dist/types/models/HeygenTemplateResponseSingle.d.ts

@@ -0,0 +1,6 @@
+export type HeygenTemplateResponseSingle = {
+    readonly template_id: string | null;
+    readonly preview_image_url: string | null;
+    name: string;
+    provider: string;
+};

package/dist/types/models/HeygenVideoDetail.d.ts

@@ -0,0 +1,8 @@
+export type HeygenVideoDetail = {
+    name?: string;
+    data?: any;
+    script?: string | null;
+    readonly id: number;
+    readonly video_file: string | null;
+    readonly generation_status: string;
+};