@iblai/iblai-api 4.261.1-core → 4.262.0-ai

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

@@ -0,0 +1,73 @@
+import type { LifecycleStageEnum } from './LifecycleStageEnum';
+export type Person = {
+    /**
+     * Server-assigned UUID. Stable across renames and merges.
+     */
+    readonly id: string;
+    /**
+     * Platform the person belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
+     */
+    readonly platform: number;
+    /**
+     * Display name (e.g. 'Alice Chen').
+     */
+    name: string;
+    /**
+     * Canonical email address. When a platform user is created with a matching email in your Platform, this person is automatically linked to them (case-insensitive).
+     */
+    primary_email?: string;
+    /**
+     * Additional email addresses associated with this person.
+     */
+    emails?: any;
+    /**
+     * Phone/contact numbers in any free-form shape.
+     */
+    contact_numbers?: any;
+    /**
+     * Role / job title — display only, not validated.
+     */
+    job_title?: string;
+    /**
+     * UUID of an organization in your Platform. References to organizations in other Platforms are rejected.
+     */
+    organization?: string | null;
+    /**
+     * Id of the platform user who owns / manages this person (internal account manager). Optional.
+     */
+    owner?: number | null;
+    /**
+     * Read-only. Populated once this person is bound to a platform user — either automatically on user creation when emails match, or explicitly via `POST /persons/{id}/link-user/`.
+     */
+    readonly platform_user: number | null;
+    /**
+     * Sales pipeline stage. One of: `lead`, `qualified`, `opportunity`, `customer`, `churned`.
+     *
+     * * `lead` - Lead
+     * * `qualified` - Qualified
+     * * `opportunity` - Opportunity
+     * * `customer` - Customer
+     * * `churned` - Churned
+     */
+    lifecycle_stage?: LifecycleStageEnum;
+    /**
+     * Optional external system id (e.g. import key from another CRM). When non-blank, must be unique within your Platform.
+     */
+    unique_id?: string;
+    /**
+     * Read-only. Set to `false` when the person is linked to a platform user or merged into another person.
+     */
+    readonly active: boolean;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    /**
+     * Creation timestamp.
+     */
+    readonly created_at: string;
+    /**
+     * Last-modified timestamp.
+     */
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,12 @@
+/**
+ * Shape returned when an active invitation already exists for this email.
+ */
+export type PersonInviteConflict = {
+    detail: string;
+    /**
+     * Id of the pre-existing active invitation.
+     */
+    invitation_id: number;
+    person_id: string;
+    platform_key: string;
+};

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

@@ -0,0 +1,18 @@
+export type PersonInviteRequest = {
+    /**
+     * Grant Platform-admin privileges on acceptance. Defaults to `false`.
+     */
+    is_admin?: boolean;
+    /**
+     * Grant staff privileges on acceptance. Defaults to `false`.
+     */
+    is_staff?: boolean;
+    /**
+     * Optional enrollment payload. Forwarded to the platform invitation to auto-enroll the invitee in the listed courses, programs, or pathways on acceptance.
+     */
+    enrollment_config?: Record<string, any>;
+    /**
+     * URL to send the invitee to after they accept the invitation (e.g. a custom landing page, an enrollment screen). Passed straight through to the platform invitation row. Leave blank to use the platform default.
+     */
+    redirect_to?: string;
+};

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

@@ -0,0 +1,37 @@
+/**
+ * Shape returned by `POST /persons/{id}/invite/`.
+ */
+export type PersonInviteResponse = {
+    /**
+     * UUID of the person that was invited.
+     */
+    person_id: string;
+    /**
+     * Id of the newly created invitation.
+     */
+    invitation_id: number;
+    /**
+     * Email address the invitation was sent to.
+     */
+    invitation_email: string;
+    /**
+     * Key of the Platform the invitation targets.
+     */
+    platform_key: string;
+    /**
+     * Whether the invitation is auto-accepted when the invitee first signs in.
+     */
+    auto_accept: boolean;
+    /**
+     * Whether the invitation is currently active.
+     */
+    active: boolean;
+    /**
+     * URL the invitee will be sent to after accepting. Null/blank means the platform default destination.
+     */
+    redirect_to: string | null;
+    /**
+     * When the invitation was created.
+     */
+    created: string | null;
+};

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

@@ -0,0 +1,6 @@
+export type PersonLinkUserRequest = {
+    /**
+     * Id of the platform user to bind to this person. The user must already be a member of your Platform — invite them first if they are not.
+     */
+    user_id: number;
+};

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

@@ -0,0 +1,10 @@
+export type PersonMergeRequest = {
+    /**
+     * UUID of the person to keep (the surviving record). Must belong to your Platform.
+     */
+    primary_id: string;
+    /**
+     * UUIDs of the persons to merge into `primary_id`. Each must belong to your Platform. `primary_id` may not appear in this list. The duplicates are marked inactive; their related records (deals, activities, tags) are re-parented onto the primary.
+     */
+    duplicate_ids: Array<string>;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Shape returned by `POST /persons/merge/`.
+ */
+export type PersonMergeResponse = {
+    /**
+     * UUID of the surviving (primary) person.
+     */
+    primary_id: string;
+    /**
+     * UUIDs of the persons marked inactive by this merge.
+     */
+    merged_ids: Array<string>;
+    /**
+     * Per-relation counts of related records (deals, activities, tags) re-parented onto the primary.
+     */
+    reparented: Record<string, any>;
+};

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

package/dist/types/models/Project.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 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

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

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

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