@iblai/iblai-api 4.236.1-core → 4.236.2-ai

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

@@ -1,10 +1,11 @@
 import type { ConsumerChannel } from './ConsumerChannel';
+import type { CoursesProgressFrequencyEnum } from './CoursesProgressFrequencyEnum';
 import type { HumanSupportRecipientModeEnum } from './HumanSupportRecipientModeEnum';
 import type { NullEnum } from './NullEnum';
 import type { PeriodicFrequencyEnum } from './PeriodicFrequencyEnum';
 import type { PeriodicLearnerScopeEnum } from './PeriodicLearnerScopeEnum';
 import type { Spa } from './Spa';
-import type { TypeFdfEnum } from './TypeFdfEnum';
+import type { Type229Enum } from './Type229Enum';
 /**
  * Serializer for detailed template view and editing
  */
@@ -23,6 +24,7 @@ export type PatchedNotificationTemplateDetail = {
      * * `COURSE_INVITATION` - Course Invitation
      * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
      * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+     * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
      * * `CUSTOM_NOTIFICATION` - Custom Notification
      * * `DEFAULT_TEMPLATE` - Default Template
      * * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
@@ -46,7 +48,7 @@ export type PatchedNotificationTemplateDetail = {
      * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
      * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
      */
-    readonly type?: (TypeFdfEnum | NullEnum) | null;
+    readonly type?: (Type229Enum | NullEnum) | null;
     /**
      * Template display name
      */
@@ -131,6 +133,10 @@ export type PatchedNotificationTemplateDetail = {
     /**
      * Number of days to include in the report period
      */
+    periodic_lookback_days?: number;
+    /**
+     * Deprecated: use periodic_lookback_days instead
+     */
     periodic_report_period_days?: number;
     /**
      * How often to send: DAILY, WEEKLY, MONTHLY, or CUSTOM
@@ -214,6 +220,39 @@ export type PatchedNotificationTemplateDetail = {
      * Mastery band thresholds (e.g. [{"name": "Beginner", "min_points": 0}, {"name": "Intermediate", "min_points": 100}])
      */
     skill_mastery_thresholds?: Array<Record<string, any>>;
+    /**
+     * Courses progress config (COURSES_PROGRESS_SUMMARY only)
+     */
+    readonly courses_progress_config?: Record<string, any> | null;
+    /**
+     * Lookback period in days for courses progress summary
+     */
+    courses_progress_lookback_days?: number;
+    /**
+     * Data points to include: courses_progressed, courses_completed, credentials_earned, time_spent, active_days, mentors_accessed
+     */
+    courses_progress_enabled_data_points?: Array<string>;
+    /**
+     * How often to send courses progress summary
+     *
+     * * `DAILY` - DAILY
+     * * `WEEKLY` - WEEKLY
+     * * `MONTHLY` - MONTHLY
+     * * `CUSTOM` - CUSTOM
+     */
+    courses_progress_frequency?: CoursesProgressFrequencyEnum;
+    /**
+     * Custom interval in days (when frequency is CUSTOM)
+     */
+    courses_progress_custom_interval_days?: number;
+    /**
+     * Time of day to send (HH:MM format)
+     */
+    courses_progress_execution_time?: string;
+    /**
+     * Timezone for execution (e.g. America/New_York)
+     */
+    courses_progress_timezone?: string;
     /**
      * Timestamp when this template was created
      */

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

@@ -0,0 +1,41 @@
+import type { PeriodicTask } from './PeriodicTask';
+import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
+export type PatchedPeriodicAgentCreate = {
+    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/PatchedPlayWrightScript.d.ts

@@ -0,0 +1,12 @@
+export type PatchedPlayWrightScript = {
+    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/PatchedProject.d.ts

@@ -0,0 +1,51 @@
+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 PatchedProject = {
+    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/PatchedPrompt.d.ts

@@ -0,0 +1,22 @@
+import type { BlankEnum } from './BlankEnum';
+import type { NullEnum } from './NullEnum';
+import type { PromptVisibilityEnum } from './PromptVisibilityEnum';
+export type PatchedPrompt = {
+    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/PatchedSeedMentorsView.d.ts

@@ -0,0 +1,3 @@
+export type PatchedSeedMentorsView = {
+    detail?: string;
+};

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

@@ -0,0 +1,8 @@
+export type PatchedSlackConfig = {
+    readonly id?: number;
+    bot?: number;
+    client_id?: string;
+    client_secret?: string;
+    app_token?: string;
+    verification_token?: string;
+};

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

@@ -0,0 +1,17 @@
+export type PatchedSlackUserConfig = {
+    readonly id?: number;
+    /**
+     * edX user ID
+     */
+    readonly user?: number;
+    /**
+     * Team Domain in the stated slack workspace. This is also the workspace name.
+     */
+    slack_team_domain?: string;
+    /**
+     * Username in the stated slack workspace
+     */
+    slack_username?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};

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

@@ -0,0 +1,7 @@
+export type PatchedTeamsConfig = {
+    readonly id?: number;
+    readonly bot?: number;
+    client_id?: string;
+    client_secret?: string;
+    verification_token?: string;
+};

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

@@ -0,0 +1,10 @@
+export type PatchedTicketMessage = {
+    readonly id?: number;
+    ticket?: number;
+    /**
+     * edX user ID
+     */
+    sender?: number | null;
+    message?: string;
+    readonly timestamp?: string;
+};

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

@@ -0,0 +1,10 @@
+export type PatchedWebexConfig = {
+    readonly id?: number;
+    readonly bot?: number;
+    /**
+     * Bot id from webex
+     */
+    webex_bot_id?: string;
+    bot_access_token?: string;
+    bot_username?: string;
+};

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

@@ -0,0 +1,11 @@
+export type PatchedWhatsappConfig = {
+    readonly id?: number;
+    readonly bot?: number;
+    phone_number_id?: string;
+    application_secret?: string;
+    webhook_verification_token?: string;
+    /**
+     * Access token to the bot. This can also be a temporary access token.
+     */
+    access_token?: string;
+};

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

@@ -0,0 +1,10 @@
+export type PatchedWhatsappUserConfig = {
+    readonly id?: number;
+    /**
+     * edX user ID
+     */
+    readonly user?: number;
+    phone_number?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};

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

@@ -0,0 +1,58 @@
+/**
+ * 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

@@ -0,0 +1,21 @@
+/**
+ * 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

@@ -0,0 +1,42 @@
+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

@@ -0,0 +1,41 @@
+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

@@ -0,0 +1,11 @@
+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

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

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,21 @@
+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

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

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

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

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

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

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

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

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

@@ -0,0 +1,34 @@
+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

@@ -0,0 +1,16 @@
+/**
+ * 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

@@ -0,0 +1,12 @@
+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

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

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * * `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

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