@iblai/iblai-api 4.396.0-core → 4.397.0-ai

package/src/models/PatchedPeriodicAgentCreate.ts

@@ -0,0 +1,74 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PeriodicTask } from './PeriodicTask';
+import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
+/**
+ * Adds read-only ``user_email``/``user_full_name`` from a username column.
+ *
+ * For models that store the username but hold no FK to the user, so there is
+ * nothing to traverse. Resolution costs **one query per payload**: DRF reuses
+ * a single child serializer for a whole page, so the first field access reads
+ * every username being serialized and looks them all up at once. A view that
+ * already knows the identities can put a ``user_identity_map`` in serializer
+ * context to skip the query entirely.
+ *
+ * ``SerializerMetaclass`` is what collects ``_declared_fields``; it also keeps
+ * this out of the MRO games that subclassing ``Serializer`` into a
+ * ``ModelSerializer`` would introduce.
+ *
+ * **Privacy invariant — resolve only from the row's own stored username.**
+ * Chat privacy's ``ANONYMIZED`` mode removes identity by writing the row with
+ * no username (``ibl_ai_langchain_ext/langchain/memories.py``:
+ * ``None if privacy_mode == ChatPrivacyMode.ANONYMIZED else self.username``),
+ * so an anonymised row reaches this mixin with nothing to look up and renders
+ * nulls. That is the whole of the protection: nothing here may back-fill the
+ * identity from elsewhere (``session.student``, the request user, …), or an
+ * anonymised row would be re-identified in the response. Privacy mode redacts
+ * conversation *text*, not identity, on the other rows this mixin serves —
+ * a moderation log or run tracker keeps its username by design — so those
+ * resolving an identity is intended, not a leak.
+ */
+export type PatchedPeriodicAgentCreate = {
+    readonly id?: number;
+    mentor?: string;
+    title?: string;
+    readonly username?: string;
+    readonly user_email?: string | null;
+    readonly user_full_name?: string | null;
+    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/src/models/PatchedPlacementAssessmentUpdate.ts

@@ -2,13 +2,13 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { SourceEnum } from './SourceEnum';
+import type { SourceBf5Enum } from './SourceBf5Enum';
 /**
  * Update body: every field optional; at least one must be present.
  */
 export type PatchedPlacementAssessmentUpdate = {
     name?: string;
-    source?: SourceEnum;
+    source?: SourceBf5Enum;
     agent_unique_id?: string;
     agent_label?: string;
     subject?: string;

package/src/models/PatchedPlatformApplicationNote.ts

@@ -2,12 +2,12 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { KindEnum } from './KindEnum';
+import type { PlatformApplicationNoteKindEnum } from './PlatformApplicationNoteKindEnum';
 /**
  * Body for adding/updating an internal reviewer note.
  */
 export type PatchedPlatformApplicationNote = {
     body?: string;
-    kind?: KindEnum;
+    kind?: PlatformApplicationNoteKindEnum;
 };
 

package/src/models/PatchedProject.ts

@@ -0,0 +1,58 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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;
+    readonly owner_email?: string | null;
+    readonly owner_full_name?: string | null;
+    /**
+     * 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/src/models/PatchedPrompt.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/PatchedSeedMentorsView.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedSeedMentorsView = {
+    detail?: string;
+};
+

package/src/models/PatchedSlackConfig.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedSlackConfig = {
+    readonly id?: number;
+    bot?: number;
+    client_id?: string;
+    client_secret?: string;
+    app_token?: string;
+    verification_token?: string;
+};
+

package/src/models/PatchedSlackUserConfig.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/PatchedTeamsConfig.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedTeamsConfig = {
+    readonly id?: number;
+    readonly bot?: number;
+    client_id?: string;
+    client_secret?: string;
+    verification_token?: string;
+};
+

package/src/models/PatchedTenantChatPrivacyConfig.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for the tenant-wide chat-privacy config payload.
+ *
+ * Shared by GET and PATCH on /orgs/{org}/chat-privacy-config/.
+ */
+export type PatchedTenantChatPrivacyConfig = {
+    /**
+     * Whether the tenant allows end users to control their chat history privacy (anonymize or disable). When False, user and session preferences are ignored and history is always logged.
+     */
+    allow_user_chat_privacy_control?: boolean;
+};
+

package/src/models/PatchedTicketMessage.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedTicketMessage = {
+    readonly id?: number;
+    ticket?: number;
+    /**
+     * edX user ID
+     */
+    sender?: number | null;
+    message?: string;
+    readonly timestamp?: string;
+};
+

package/src/models/PatchedWebexConfig.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/PatchedWhatsappConfig.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/PatchedWhatsappUserConfig.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedWhatsappUserConfig = {
+    readonly id?: number;
+    /**
+     * edX user ID
+     */
+    readonly user?: number;
+    phone_number?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};
+

package/src/models/PatchedWorkflow.ts

@@ -0,0 +1,65 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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_by_email?: string | null;
+    readonly created_by_full_name?: string | null;
+    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/src/models/PeriodInfo.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/PeriodicAgent.ts

@@ -0,0 +1,75 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Mentor } from './Mentor';
+import type { PeriodicTask } from './PeriodicTask';
+import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
+/**
+ * Adds read-only ``user_email``/``user_full_name`` from a username column.
+ *
+ * For models that store the username but hold no FK to the user, so there is
+ * nothing to traverse. Resolution costs **one query per payload**: DRF reuses
+ * a single child serializer for a whole page, so the first field access reads
+ * every username being serialized and looks them all up at once. A view that
+ * already knows the identities can put a ``user_identity_map`` in serializer
+ * context to skip the query entirely.
+ *
+ * ``SerializerMetaclass`` is what collects ``_declared_fields``; it also keeps
+ * this out of the MRO games that subclassing ``Serializer`` into a
+ * ``ModelSerializer`` would introduce.
+ *
+ * **Privacy invariant — resolve only from the row's own stored username.**
+ * Chat privacy's ``ANONYMIZED`` mode removes identity by writing the row with
+ * no username (``ibl_ai_langchain_ext/langchain/memories.py``:
+ * ``None if privacy_mode == ChatPrivacyMode.ANONYMIZED else self.username``),
+ * so an anonymised row reaches this mixin with nothing to look up and renders
+ * nulls. That is the whole of the protection: nothing here may back-fill the
+ * identity from elsewhere (``session.student``, the request user, …), or an
+ * anonymised row would be re-identified in the response. Privacy mode redacts
+ * conversation *text*, not identity, on the other rows this mixin serves —
+ * a moderation log or run tracker keeps its username by design — so those
+ * resolving an identity is intended, not a leak.
+ */
+export type PeriodicAgent = {
+    readonly id: number;
+    mentor: Mentor;
+    title: string;
+    readonly username: string;
+    readonly user_email: string | null;
+    readonly user_full_name: string | null;
+    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/src/models/PeriodicAgentCreate.ts

@@ -0,0 +1,74 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PeriodicTask } from './PeriodicTask';
+import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
+/**
+ * Adds read-only ``user_email``/``user_full_name`` from a username column.
+ *
+ * For models that store the username but hold no FK to the user, so there is
+ * nothing to traverse. Resolution costs **one query per payload**: DRF reuses
+ * a single child serializer for a whole page, so the first field access reads
+ * every username being serialized and looks them all up at once. A view that
+ * already knows the identities can put a ``user_identity_map`` in serializer
+ * context to skip the query entirely.
+ *
+ * ``SerializerMetaclass`` is what collects ``_declared_fields``; it also keeps
+ * this out of the MRO games that subclassing ``Serializer`` into a
+ * ``ModelSerializer`` would introduce.
+ *
+ * **Privacy invariant — resolve only from the row's own stored username.**
+ * Chat privacy's ``ANONYMIZED`` mode removes identity by writing the row with
+ * no username (``ibl_ai_langchain_ext/langchain/memories.py``:
+ * ``None if privacy_mode == ChatPrivacyMode.ANONYMIZED else self.username``),
+ * so an anonymised row reaches this mixin with nothing to look up and renders
+ * nulls. That is the whole of the protection: nothing here may back-fill the
+ * identity from elsewhere (``session.student``, the request user, …), or an
+ * anonymised row would be re-identified in the response. Privacy mode redacts
+ * conversation *text*, not identity, on the other rows this mixin serves —
+ * a moderation log or run tracker keeps its username by design — so those
+ * resolving an identity is intended, not a leak.
+ */
+export type PeriodicAgentCreate = {
+    readonly id: number;
+    mentor: string;
+    title: string;
+    readonly username: string;
+    readonly user_email: string | null;
+    readonly user_full_name: string | null;
+    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/src/models/PeriodicAgentLog.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/PeriodicAgentLogStatusEnum.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `success` - Success
+ * * `error` - Error
+ * * `running` - Running
+ */
+export enum PeriodicAgentLogStatusEnum {
+    SUCCESS = 'success',
+    ERROR = 'error',
+    RUNNING = 'running',
+}

package/src/models/PeriodicAgentStatistics.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PeriodicAgentStatistics = {
+    total_tasks: number;
+    succeeded_tasks: number;
+    failed_tasks: number;
+    running_tasks: number;
+    pending_tasks: number;
+};
+

package/src/models/PeriodicTask.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/PhiActionEnum.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `redact` - Redact
+ * * `mask` - Mask
+ * * `block` - Block
+ * * `allow` - Allow
+ */
+export enum PhiActionEnum {
+    REDACT = 'redact',
+    MASK = 'mask',
+    BLOCK = 'block',
+    ALLOW = 'allow',
+}