@iblai/iblai-api 2025.11.13-teams-bot-renovation-3-core → 2025.11.13-teams-bot-renovation-3-ai

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

@@ -0,0 +1,13 @@
+export type AIGeneratedImage = {
+    readonly id: number;
+    /**
+     * edX user ID
+     */
+    user?: number | null;
+    image: string;
+    platform?: number | null;
+    prompt?: string;
+    model?: string;
+    provider?: string;
+    readonly date_created: string;
+};

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

@@ -0,0 +1,4 @@
+export type AIUserProfileMemoryRelation = {
+    readonly tag: string;
+    detail?: string | null;
+};

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

@@ -0,0 +1,4 @@
+export type AIUserProfileRequest = {
+    tag: string;
+    detail: string;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `public` - Public
+ * * `private` - Private
+ */
+export declare enum AccessEnum {
+    PUBLIC = "public",
+    PRIVATE = "private"
+}

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

@@ -0,0 +1,5 @@
+export type AccessTimesHeatmap = {
+    day_of_week: number;
+    hour: number;
+    value: number;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Request serializer for accessible mentors by email endpoint.
+ */
+export type AccessibleMentorsByEmailRequest = {
+    /**
+     * The user email to check mentor access for
+     */
+    email: string;
+    /**
+     * If true, return all mentors in the platform. If false (default), return only mentors owned by the user's email.
+     */
+    all_mentors?: boolean;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Response serializer for accessible mentors by email.
+ */
+export type AccessibleMentorsByEmailResponse = {
+    /**
+     * List of mentor unique IDs
+     */
+    readonly mentors: Array<string>;
+    /**
+     * The user ID that mentors belong to
+     */
+    readonly user_id: number;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * Action/trace name cost breakdown.
+ */
+export type ActionBreakdown = {
+    action: string;
+    cost: string;
+    sessions: number;
+    trace_count: number;
+    unique_users?: number;
+};

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

@@ -0,0 +1,12 @@
+/**
+ * Serializer for adding a mentor to a disclaimer.
+ *
+ * This serializer validates the mentor_id input and provides proper schema documentation
+ * for the add_mentor action.
+ */
+export type AddMentorToDisclaimer = {
+    /**
+     * The unique_id of the mentor to add to the disclaimer.
+     */
+    mentor_id: string;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `left` - Left
+ * * `right` - Right
+ */
+export declare enum AlignMentorBubbleEnum {
+    LEFT = "left",
+    RIGHT = "right"
+}

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

@@ -0,0 +1,7 @@
+import type { MetricChange } from './MetricChange';
+export type AnalyticsOverview = {
+    conversation_volume: MetricChange;
+    users: MetricChange;
+    topics: MetricChange;
+    user_rating: MetricChange;
+};

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

@@ -0,0 +1,11 @@
+/**
+ * Serializer for an individual answer choice for a question.
+ *
+ * Attributes:
+ * text (str): The text of the answer.
+ * is_correct (Optional[bool]): Boolean indicating if this answer is correct.
+ */
+export type Answer = {
+    text: string;
+    is_correct?: boolean;
+};

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

@@ -0,0 +1,56 @@
+/**
+ * Serializer for Artifact model.
+ *
+ * Artifacts are structured content like essays, documents, code files, etc.
+ * that are generated by AI agents during a chat session and are best
+ * displayed separately from the normal chat flow.
+ *
+ * Fields:
+ * - id: Unique identifier for the artifact
+ * - title: Title or identifier for the artifact
+ * - content: The markdown-styled content of the artifact
+ * - file_extension: The extension of the file (e.g., 'py', 'md', 'html', 'json', 'csv')
+ * - chat_message: Reference to the chat message that contains this artifact
+ * - llm_name: Name of the LLM that generated the artifact
+ * - llm_provider: Provider of the LLM (e.g., 'openai', 'google', 'anthropic')
+ * - date_created: Timestamp when the artifact was created
+ * - date_updated: Timestamp when the artifact was last updated
+ * - metadata: Additional metadata for the artifact
+ * - username: Username of the student who owns the artifact (read-only)
+ * - session_id: UUID of the session that generated the artifact (read-only)
+ *
+ * Read-only fields:
+ * - id, date_created, date_updated, username, session_id
+ */
+export type Artifact = {
+    readonly id: number;
+    /**
+     * Title or identifier for the artifact
+     */
+    title: string;
+    /**
+     * The markdown-styled content of the artifact
+     */
+    content: string;
+    /**
+     * The extension of the file for the artifact. eg. `py`, `md`, `html`, `json`, `csv`, etc
+     */
+    readonly file_extension: string;
+    readonly chat_message: number;
+    readonly llm_name: string;
+    readonly llm_provider: string;
+    readonly date_created: string;
+    readonly date_updated: string;
+    /**
+     * Additional metadata for the artifact
+     */
+    metadata?: any;
+    /**
+     * Username of the student who owns this artifact
+     */
+    readonly username: string;
+    /**
+     * UUID of the session that generated this artifact
+     */
+    readonly session_id: string;
+};

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

@@ -0,0 +1,45 @@
+/**
+ * Lightweight serializer for listing artifacts.
+ *
+ * This serializer is optimized for list views, excluding the potentially
+ * large content field and including useful computed fields.
+ *
+ * Fields:
+ * - id: Unique identifier for the artifact
+ * - title: Title or identifier for the artifact
+ * - file_extension: The extension of the file
+ * - llm_name: Name of the LLM that generated the artifact
+ * - llm_provider: Provider of the LLM
+ * - date_created: Timestamp when the artifact was created
+ * - date_updated: Timestamp when the artifact was last updated
+ * - username: Username of the student who owns the artifact
+ * - session_id: UUID of the session that generated the artifact
+ * - content_length: Length of the content in characters
+ */
+export type ArtifactList = {
+    readonly id: number;
+    /**
+     * Title or identifier for the artifact
+     */
+    readonly title: string;
+    /**
+     * The extension of the file for the artifact. eg. `py`, `md`, `html`, `json`, `csv`, etc
+     */
+    readonly file_extension: string;
+    readonly llm_name: string;
+    readonly llm_provider: string;
+    readonly date_created: string;
+    readonly date_updated: string;
+    /**
+     * Username of the student who owns this artifact
+     */
+    readonly username: string;
+    /**
+     * UUID of the session that generated this artifact
+     */
+    readonly session_id: string;
+    /**
+     * Length of the artifact content in characters
+     */
+    readonly content_length: number;
+};

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

@@ -0,0 +1,4 @@
+import type { AssumedKnowledgeLevel } from './AssumedKnowledgeLevel';
+export type AssumedKnowledge = {
+    levels: Array<AssumedKnowledgeLevel>;
+};

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/AuthTypeEnum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * * `none` - None
+ * * `token` - Token
+ * * `oauth2` - Oauth2
+ */
+export declare enum AuthTypeEnum {
+    NONE = "none",
+    TOKEN = "token",
+    OAUTH2 = "oauth2"
+}

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

@@ -0,0 +1,4 @@
+export type AutoMemoryPrompt = {
+    auto_memory_prompt?: string;
+    reset?: boolean;
+};

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

@@ -0,0 +1,37 @@
+import type { ComparisonInfo } from './ComparisonInfo';
+import type { FinanceFilters } from './FinanceFilters';
+import type { OvertimeData } from './OvertimeData';
+import type { PeriodInfo } from './PeriodInfo';
+/**
+ * Base response for all finance metrics.
+ */
+export type BaseFinanceResponse = {
+    /**
+     * The metric type that was requested
+     */
+    metric: string;
+    /**
+     * Applied filters for this query
+     */
+    filters: FinanceFilters;
+    /**
+     * Primary metric value (cost in USD)
+     */
+    value: string;
+    /**
+     * Percentage change vs comparison period (null if no comparison)
+     */
+    percentage_change: number | null;
+    /**
+     * Time series data for overtime visualization
+     */
+    overtime: Array<OvertimeData>;
+    /**
+     * Information about the analysis period
+     */
+    period_info: PeriodInfo;
+    /**
+     * Information about comparison period (empty if no comparison)
+     */
+    comparison_info: ComparisonInfo;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * Billing period information.
+ */
+export type BillingPeriod = {
+    start_date: string;
+    end_date: string;
+    days: number;
+};

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

@@ -0,0 +1,15 @@
+import type { Provider05cEnum } from './Provider05cEnum';
+export type Bot = {
+    readonly id: number;
+    readonly platform: number;
+    readonly tenant: string;
+    name: string;
+    provider: Provider05cEnum;
+    readonly is_configured: boolean;
+    slack_config: number;
+    readonly discord_config: number;
+    readonly webex_config: number;
+    readonly whatsapp_config: number;
+    readonly teams_config: number;
+    readonly webhook_url: string;
+};

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

@@ -0,0 +1,6 @@
+export type BotCommand = {
+    readonly id: number;
+    command: string;
+    mentor: number;
+    bot: number;
+};

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

@@ -0,0 +1,12 @@
+import type { Provider05cEnum } from './Provider05cEnum';
+export type BotCreate = {
+    readonly id: number;
+    name: string;
+    provider: Provider05cEnum;
+    readonly is_configured: boolean;
+    readonly webhook_url: string;
+    readonly discord_config: number;
+    readonly webex_config: number;
+    readonly whatsapp_config: number;
+    readonly teams_config: number;
+};

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

@@ -0,0 +1,11 @@
+import type { ActionBreakdown } from './ActionBreakdown';
+import type { MentorBreakdown } from './MentorBreakdown';
+import type { ProviderBreakdown } from './ProviderBreakdown';
+/**
+ * Detailed breakdown of costs.
+ */
+export type Breakdown = {
+    by_provider?: Array<ProviderBreakdown>;
+    by_mentor?: Array<MentorBreakdown>;
+    by_action?: Array<ActionBreakdown>;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * 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;
+    /**
+     * Whether to enable video during the call. Required for screensharing and video calls to work.
+     */
+    enable_video?: boolean;
+};

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/CallConfiguration.d.ts

@@ -0,0 +1,26 @@
+import type { CallConfigurationModeEnum } from './CallConfigurationModeEnum';
+import type { LlmProviderEnum } from './LlmProviderEnum';
+import type { SttProviderEnum } from './SttProviderEnum';
+import type { TtsProviderEnum } from './TtsProviderEnum';
+import type { Voice } from './Voice';
+export type CallConfiguration = {
+    readonly id: number;
+    mentor: string;
+    mode?: CallConfigurationModeEnum;
+    tts_provider?: TtsProviderEnum;
+    stt_provider?: SttProviderEnum;
+    llm_provider?: LlmProviderEnum;
+    /**
+     * Whether to use function calls in the agent or force RAG calls before LLM generation
+     */
+    use_function_calling_for_rag?: boolean;
+    google_voice?: Voice;
+    openai_voice?: Voice;
+    openai_voice_id?: number | null;
+    google_voice_id?: number | null;
+    /**
+     * Whether to enable video for the call. (applicable only for realtime mode)
+     */
+    enable_video?: boolean;
+    readonly platform_key: string;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `realtime` - Realtime
+ * * `inference` - Inference
+ */
+export declare enum CallConfigurationModeEnum {
+    REALTIME = "realtime",
+    INFERENCE = "inference"
+}

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

@@ -0,0 +1,9 @@
+export type ChatHistory = {
+    readonly id: number;
+    readonly message: any;
+    readonly inserted_at: string;
+    title?: string | null;
+    readonly feedback: any;
+    document_sources?: any;
+    readonly files: 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,15 @@
+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>;
+    enable_artifacts?: boolean;
+    /**
+     * Optional token for a mentor's shareable link
+     */
+    shareable_link_token?: string;
+};

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

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

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/ComparisonInfo.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Comparison period information.
+ */
+export type ComparisonInfo = {
+    /**
+     * Number of days in comparison period
+     */
+    previous_period_count?: number;
+    /**
+     * Cost value for comparison period
+     */
+    previous_period_value?: string;
+    /**
+     * Start date of comparison period
+     */
+    comparison_start?: string;
+    /**
+     * End date of comparison period
+     */
+    comparison_end?: string;
+    /**
+     * Number of comparison days
+     */
+    comparison_days?: number;
+    /**
+     * Cost value for current period
+     */
+    recent_period_value?: 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/ConnectedService.d.ts

@@ -0,0 +1,24 @@
+import type { ExternalServiceInfo } from './ExternalServiceInfo';
+/**
+ * Serializer for representing connected OAuth services.
+ *
+ * Includes both the legacy `service` / `scope` string values and structured
+ * representations so that consumers can reason about individual scope names.
+ */
+export type ConnectedService = {
+    readonly id: number;
+    provider: string;
+    service?: string;
+    expires_at?: string | null;
+    scope?: string;
+    /**
+     * Return the canonical list of scope identifiers for the connection.
+     */
+    readonly scope_names: Array<string>;
+    /**
+     * Return the OAuth scope strings associated with the connection.
+     */
+    readonly scopes: Array<string>;
+    token_type?: string;
+    readonly service_info: ExternalServiceInfo;
+};

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

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

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

@@ -0,0 +1,4 @@
+export type ConversationDetailResponse = {
+    summary: Record<string, any>;
+    messages: Array<Record<string, any>>;
+};

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

@@ -0,0 +1,24 @@
+export type ConversationListItem = {
+    platform_name: string;
+    platform_key: string;
+    mentor: string;
+    mentor_unique_id: string;
+    model: string;
+    readonly cost: string;
+    username?: string | null;
+    name: string;
+    first_user_message?: string | null;
+    topics: any;
+    message_count: number;
+    user_queries?: number | null;
+    assistant_responses?: number | null;
+    average_sentiment?: number | null;
+    sentiment?: string | null;
+    created_at: string;
+    platform: number;
+    session: string;
+    /**
+     * edX user ID
+     */
+    user?: number | null;
+};

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

@@ -0,0 +1,6 @@
+import type { ConversationListItem } from './ConversationListItem';
+export type ConversationListResponse = {
+    summary: Record<string, any>;
+    results: Array<ConversationListItem>;
+    pagination: Record<string, any>;
+};

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;
+};