@iblai/iblai-api 4.243.2-ai → 4.243.2-core

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

@@ -1,58 +0,0 @@
-/**
- * Serializer for Workflow CRUD operations.
- *
- * Provides basic ReactFlow JSON validation (Phase 1) to ensure definitions
- * are renderable, while allowing draft workflows that may not be executable.
- *
- * Comprehensive execution validation (Phase 2) is available via the
- * validate action endpoint.
- *
- * Fields:
- * - All model fields are exposed
- * - Platform and creator are set automatically from URL context
- * - Read-only fields: id, unique_id, created_at, updated_at
- * - Chat settings (chat_name, chat_greeting, etc.) update the entry_mentor
- */
-export type PatchedWorkflow = {
-    readonly id?: number;
-    readonly unique_id?: string;
-    name?: string;
-    description?: string;
-    /**
-     * Workflow definition in ReactFlow format
-     */
-    definition?: any;
-    is_active?: boolean;
-    is_template?: boolean;
-    /**
-     * Parent workflow if this is a template variant
-     */
-    parent_workflow?: number | null;
-    readonly platform?: number;
-    readonly platform_key?: string;
-    readonly platform_name?: string;
-    /**
-     * edX user ID
-     */
-    readonly created_by?: number;
-    readonly created_by_username?: string;
-    readonly created_at?: string;
-    readonly updated_at?: string;
-    /**
-     * Get the number of nodes in the workflow definition.
-     */
-    readonly node_count?: number;
-    /**
-     * Get the number of edges in the workflow definition.
-     */
-    readonly edge_count?: number;
-    readonly entry_mentor_id?: string;
-    /**
-     * Display name for chat (updates entry_mentor.name)
-     */
-    chat_name?: string;
-    /**
-     * Proactive greeting message for chat (updates entry_mentor.proactive_response)
-     */
-    chat_proactive_response?: string;
-};

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

@@ -1,21 +0,0 @@
-/**
- * Information about the analysis period.
- */
-export type PeriodInfo = {
-    /**
-     * Start date of analysis period
-     */
-    start_date?: string;
-    /**
-     * End date of analysis period
-     */
-    end_date?: string;
-    /**
-     * Number of days in period
-     */
-    period_days?: number;
-    /**
-     * Type of date range (custom, default, all_time, etc.)
-     */
-    range_type?: string;
-};

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

@@ -1,42 +0,0 @@
-import type { Mentor } from './Mentor';
-import type { PeriodicTask } from './PeriodicTask';
-import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
-export type PeriodicAgent = {
-    readonly id: number;
-    mentor: Mentor;
-    title: string;
-    readonly username: string;
-    description?: string;
-    /**
-     * Prompt for the periodic agent if any.
-     */
-    prompt?: string;
-    task: PeriodicTask;
-    readonly created_at: string;
-    readonly modified_at: string;
-    readonly enabled: boolean;
-    readonly one_off: boolean;
-    readonly platform_key: string;
-    pathway?: string;
-    callback_url?: string;
-    callback_secret?: string;
-    parent_session_id?: string;
-    parent_mentor_id?: number | null;
-    /**
-     * Agent that needs to run before the current agent runs.
-     */
-    previous_agent?: number | null;
-    /**
-     * The status that the previous agent must be in before this agent gets scheduled.
-     *
-     * * `success` - Success
-     * * `error` - Error
-     * * `running` - Running
-     * * `pending` - Pending
-     */
-    previous_agent_status?: PreviousAgentStatusEnum;
-    /**
-     * This will be fed into the run of this agent as part of its input prompt.
-     */
-    readonly previous_agent_output: string;
-};

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

@@ -1,41 +0,0 @@
-import type { PeriodicTask } from './PeriodicTask';
-import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
-export type PeriodicAgentCreate = {
-    readonly id: number;
-    mentor: string;
-    title: string;
-    readonly username: string;
-    description?: string;
-    /**
-     * Prompt for the periodic agent if any.
-     */
-    prompt?: string;
-    task: PeriodicTask;
-    readonly created_at: string;
-    readonly modified_at: string;
-    readonly enabled: boolean;
-    readonly one_off: boolean;
-    readonly platform_key: string;
-    pathway?: string;
-    callback_url?: string;
-    callback_secret?: string;
-    parent_session_id?: string;
-    parent_mentor_id?: number | null;
-    /**
-     * Agent that needs to run before the current agent runs.
-     */
-    previous_agent?: number | null;
-    /**
-     * The status that the previous agent must be in before this agent gets scheduled.
-     *
-     * * `success` - Success
-     * * `error` - Error
-     * * `running` - Running
-     * * `pending` - Pending
-     */
-    previous_agent_status?: PreviousAgentStatusEnum;
-    /**
-     * This will be fed into the run of this agent as part of its input prompt.
-     */
-    readonly previous_agent_output: string;
-};

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

@@ -1,11 +0,0 @@
-import type { PeriodicAgentLogStatusEnum } from './PeriodicAgentLogStatusEnum';
-export type PeriodicAgentLog = {
-    readonly id: number;
-    content?: string;
-    status?: PeriodicAgentLogStatusEnum;
-    start_time?: string;
-    end_time?: string | null;
-    readonly created_at: string;
-    readonly modified_at: string;
-    periodic_agent: number;
-};

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

@@ -1,10 +0,0 @@
-/**
- * * `success` - Success
- * * `error` - Error
- * * `running` - Running
- */
-export declare enum PeriodicAgentLogStatusEnum {
-    SUCCESS = "success",
-    ERROR = "error",
-    RUNNING = "running"
-}

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

@@ -1,7 +0,0 @@
-export type PeriodicAgentStatistics = {
-    total_tasks: number;
-    succeeded_tasks: number;
-    failed_tasks: number;
-    running_tasks: number;
-    pending_tasks: number;
-};

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

@@ -1,21 +0,0 @@
-import type { CrontabSchedule } from './CrontabSchedule';
-export type PeriodicTask = {
-    readonly id: number;
-    /**
-     * Short Description For This Task
-     */
-    readonly name: string;
-    crontab: CrontabSchedule;
-    /**
-     * If True, the schedule will only run the task a single time
-     */
-    one_off?: boolean;
-    /**
-     * Datetime when the schedule should begin triggering the task to run
-     */
-    start_time?: string | null;
-    /**
-     * Set to False to disable the schedule
-     */
-    enabled?: boolean;
-};

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

@@ -1,5 +0,0 @@
-import type { PieChartSegment } from './PieChartSegment';
-export type PieChartData = {
-    new_users: PieChartSegment;
-    returning_users: PieChartSegment;
-};

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

@@ -1,4 +0,0 @@
-export type PieChartSegment = {
-    count: number;
-    percentage: number;
-};

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

@@ -1,9 +0,0 @@
-export type PinnedMessageCreate = {
-    readonly id: number;
-    /**
-     * The platform key
-     */
-    platform: string;
-    username: string;
-    session_id: string | null;
-};

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

@@ -1,6 +0,0 @@
-export type PinnedMessageRequest = {
-    /**
-     * Session id of the message to pin
-     */
-    session_id: string;
-};

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

@@ -1,34 +0,0 @@
-import type { RecommendationTypeEnum } from './RecommendationTypeEnum';
-/**
- * Serializer for platform recommendation prompt management.
- *
- * Used by instructors/admins to configure tenant-specific prompts for different SPAs.
- * A platform can have multiple prompts (one per SPA/frontend).
- *
- * Note: spa_url will be automatically normalized (protocol stripped, lowercase) during validation.
- */
-export type PlatformPrompt = {
-    /**
-     * Platform key this prompt belongs to
-     */
-    platform_key?: string;
-    /**
-     * The custom recommendation strategy prompt
-     */
-    prompt_text?: string;
-    /**
-     * Prompt category. Use 'catalog' for courses/programs/resources/pathways; use 'mentors' for mentor prompts.
-     *
-     * * `mentors` - Mentor Recommendations
-     * * `catalog` - Catalog Recommendations
-     */
-    recommendation_type?: RecommendationTypeEnum;
-    /**
-     * Frontend/SPA identifier (e.g., 'catalog.example.com', 'mentor-ai.ibl.com', 'https://mentor-ai.ibl.com'). Protocol and case will be normalized automatically. Leave blank for platform-wide prompts.
-     */
-    spa_url?: string | null;
-    /**
-     * Whether this prompt is currently active
-     */
-    active?: boolean;
-};

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

@@ -1,16 +0,0 @@
-/**
- * Response serializer for platform prompt retrieval.
- */
-export type PlatformPromptResponse = {
-    platform_key: string;
-    prompt_text: string;
-    recommendation_type: string;
-    spa_url?: string | null;
-    active: boolean;
-    created_at: string;
-    updated_at: string;
-    /**
-     * Username of who created this prompt
-     */
-    created_by?: string | null;
-};

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

@@ -1,12 +0,0 @@
-export type PlayWrightScript = {
-    readonly id: number;
-    readonly platform: number | null;
-    /**
-     * edX user ID
-     */
-    readonly student: number | null;
-    title: string;
-    description?: string;
-    script: string;
-    readonly is_public: boolean;
-};

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

@@ -1,4 +0,0 @@
-import type { ReuestDataVariableList } from './ReuestDataVariableList';
-export type PredictiveAnalyticsRequest = {
-    prompt: ReuestDataVariableList;
-};

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

@@ -1,4 +0,0 @@
-import type { ResponseDataVariable } from './ResponseDataVariable';
-export type PredictiveAnalyticsResponse = {
-    predictions: Array<ResponseDataVariable>;
-};

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

@@ -1,12 +0,0 @@
-/**
- * * `success` - Success
- * * `error` - Error
- * * `running` - Running
- * * `pending` - Pending
- */
-export declare enum PreviousAgentStatusEnum {
-    SUCCESS = "success",
-    ERROR = "error",
-    RUNNING = "running",
-    PENDING = "pending"
-}

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

@@ -1,10 +0,0 @@
-/**
- * * `redact` - Redact
- * * `mask` - Mask
- * * `block` - Block
- */
-export declare enum PrivacyAction011Enum {
-    REDACT = "redact",
-    MASK = "mask",
-    BLOCK = "block"
-}

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

@@ -1,51 +0,0 @@
-import type { ProjectMentor } from './ProjectMentor';
-/**
- * Unified serializer for Project model.
- *
- * Write-only fields:
- * - mentors_to_add: List of mentor unique IDs to add to the project
- * - mentors_to_remove: List of mentor unique IDs to remove from the project
- *
- * These fields are mutually exclusive and only used during create/update operations.
- * For create: only mentors_to_add is used
- * For update: either can be used, but not both at once
- */
-export type Project = {
-    readonly id: number;
-    /**
-     * Name of the project
-     */
-    name: string;
-    /**
-     * Description of the project
-     */
-    description?: string;
-    /**
-     * Whether this project is shared with others or personal
-     */
-    shared?: boolean;
-    /**
-     * User who created this project
-     */
-    readonly owner: number;
-    readonly owner_username: string;
-    /**
-     * Platform this project belongs to
-     */
-    readonly platform: number | null;
-    readonly platform_key: string;
-    readonly platform_name: string;
-    readonly mentor_count: number;
-    readonly is_personal: boolean;
-    readonly created_at: string;
-    readonly updated_at: string;
-    readonly mentors: Array<ProjectMentor>;
-    /**
-     * List of mentor unique IDs to add to the project
-     */
-    mentors_to_add?: Array<string>;
-    /**
-     * List of mentor unique IDs to remove from the project
-     */
-    mentors_to_remove?: Array<string>;
-};

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

@@ -1,11 +0,0 @@
-/**
- * Serializer for mentors within a project.
- */
-export type ProjectMentor = {
-    readonly id: number;
-    name: string;
-    description?: string | null;
-    readonly unique_id: string;
-    readonly slug: string;
-    readonly created_at: string | null;
-};

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

@@ -1,22 +0,0 @@
-import type { BlankEnum } from './BlankEnum';
-import type { NullEnum } from './NullEnum';
-import type { PromptVisibilityEnum } from './PromptVisibilityEnum';
-export type Prompt = {
-    readonly id: number;
-    mentor?: string;
-    tone?: string | null;
-    style?: string;
-    language?: string;
-    tags?: Array<number>;
-    is_system?: boolean;
-    metadata?: any;
-    category?: string;
-    prompt: string;
-    title?: string | null;
-    description?: string | null;
-    prompt_visibility?: (PromptVisibilityEnum | BlankEnum | NullEnum) | null;
-    readonly created_at: string;
-    readonly updated_at: string;
-    created_by?: string | null;
-    platform: number;
-};

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

@@ -1,7 +0,0 @@
-export type PromptCategory = {
-    readonly id: number;
-    name: string;
-    description?: string | null;
-    readonly created_at: string | null;
-    readonly updated_at: string | null;
-};

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

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

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

@@ -1,35 +0,0 @@
-import type { Prompt } from './Prompt';
-import type { PromptFacet } from './PromptFacet';
-/**
- * Response serializer for PromptSearchView
- */
-export type PromptSearchResponse = {
-    /**
-     * List of prompts matching the search criteria
-     */
-    results: Array<Prompt>;
-    /**
-     * Total number of prompts 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
-     */
-    num_pages: number;
-    /**
-     * Facet information for filtering
-     */
-    facets?: Record<string, PromptFacet>;
-};

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

@@ -1,10 +0,0 @@
-/**
- * * `viewable_by_tenant_admins` - Viewable By Tenant Admins
- * * `viewable_by_tenant_students` - Viewable By Tenant Students
- * * `viewable_by_anyone` - Viewable By Anyone
- */
-export declare enum PromptVisibilityEnum {
-    VIEWABLE_BY_TENANT_ADMINS = "viewable_by_tenant_admins",
-    VIEWABLE_BY_TENANT_STUDENTS = "viewable_by_tenant_students",
-    VIEWABLE_BY_ANYONE = "viewable_by_anyone"
-}

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

@@ -1,14 +0,0 @@
-/**
- * * `webex` - Webex
- * * `slack` - Slack
- * * `whatsapp` - Whatsapp
- * * `discord` - Discord
- * * `teams` - Teams
- */
-export declare enum Provider05cEnum {
-    WEBEX = "webex",
-    SLACK = "slack",
-    WHATSAPP = "whatsapp",
-    DISCORD = "discord",
-    TEAMS = "teams"
-}

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

@@ -1,8 +0,0 @@
-/**
- * Provider cost breakdown.
- */
-export type ProviderBreakdown = {
-    provider: string;
-    cost: string;
-    percentage: string;
-};

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

@@ -1,8 +0,0 @@
-/**
- * * `managed` - Managed
- * * `self_hosted` - Self-hosted
- */
-export declare enum ProvisionModeEnum {
-    MANAGED = "managed",
-    SELF_HOSTED = "self_hosted"
-}

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

@@ -1,8 +0,0 @@
-export type QuestionCardTag = {
-    readonly id: number;
-    name: string;
-    difficulty: number;
-    readonly total_cards: number;
-    readonly correct_answers: number;
-    readonly correct_rate: number;
-};

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

@@ -1,15 +0,0 @@
-import type { InputQuestion } from './InputQuestion';
-/**
- * Serializer for incoming request data that includes initial questions and the username.
- *
- * Attributes:
- * username (str): Username of the requesting student or user.
- * initial_questions (list[InputQuestionSerializer]): List of initial questions provided by the LMS.
- * question_count (int): Number of questions the mentor (llm) should generate
- */
-export type QuestionRequest = {
-    username: string;
-    initial_questions: Array<InputQuestion>;
-    question_count?: number;
-    subject: string;
-};

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

@@ -1,10 +0,0 @@
-import type { LLMQuestion } from './LLMQuestion';
-/**
- * Serializer for the response data that returns additional questions.
- *
- * Attributes:
- * follow_up_questions (list[LLMQuestionSerializer]): List of generated follow-up questions.
- */
-export type QuestionResponse = {
-    questions: Array<LLMQuestion>;
-};

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

@@ -1,10 +0,0 @@
-/**
- * Serializer for rating average overtime data.
- */
-export type RatingAverageRecord = {
-    date: string;
-    /**
-     * Average rating value for this time period
-     */
-    value: number;
-};

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

@@ -1,8 +0,0 @@
-/**
- * * `1` - Up Vote
- * * `-1` - Down Vote
- */
-export declare enum RatingEnum {
-    '_1' = 1,
-    '_-1' = -1
-}

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

@@ -1,4 +0,0 @@
-export type RatingRecord = {
-    time: string;
-    total_ratings: number;
-};

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

@@ -1,5 +0,0 @@
-import type { RatingAverageRecord } from './RatingAverageRecord';
-export type RatingsOvertime = {
-    metric: string;
-    points: Array<RatingAverageRecord>;
-};

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

@@ -1,11 +0,0 @@
-export type RecentlyAccessedMentor = {
-    readonly id: number | null;
-    readonly unique_id: string | null;
-    readonly slug: string | null;
-    readonly name: string | null;
-    readonly description: string | null;
-    readonly recently_accessed_at: string | null;
-    readonly platform_key: string | null;
-    readonly last_accessed_by: string | null;
-    readonly created_by: string | null;
-};

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

@@ -1,8 +0,0 @@
-/**
- * * `mentors` - Mentor Recommendations
- * * `catalog` - Catalog Recommendations
- */
-export declare enum RecommendationTypeEnum {
-    MENTORS = "mentors",
-    CATALOG = "catalog"
-}