@iblai/iblai-api 4.112.2-core → 4.112.3-ai

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/PatchedSubSection.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Status6eeEnum } from './Status6eeEnum';
+export type PatchedSubSection = {
+    readonly id?: number;
+    section?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    readonly created_at?: string;
+    readonly updated_at?: 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/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/PatchedTrainingCreate.ts

@@ -0,0 +1,36 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Provider63aEnum } from './Provider63aEnum';
+export type PatchedTrainingCreate = {
+    readonly id?: string;
+    project_name?: string;
+    dataset?: string;
+    base_model_name?: string;
+    provider?: Provider63aEnum;
+    text_column?: string;
+    learning_rate?: number;
+    batch_size?: number;
+    num_epochs?: number;
+    block_size?: number;
+    warmup_ratio?: number;
+    lora_r?: number;
+    lora_alpha?: number;
+    lora_dropout?: number;
+    weight_decay?: number;
+    gradient_accumulation?: number;
+    use_peft?: boolean;
+    use_fp16?: boolean;
+    use_int4?: boolean;
+    push_to_hub?: boolean;
+    repo_id?: string;
+    preprocess_dataset?: boolean;
+    prompt_column?: string;
+    prompt_prefix?: string;
+    prompt_suffix?: string;
+    response_prefix?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};
+

package/src/models/PatchedUnit.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Status6eeEnum } from './Status6eeEnum';
+import type { TypeC42Enum } from './TypeC42Enum';
+export type PatchedUnit = {
+    readonly id?: number;
+    subsection?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    type?: TypeC42Enum;
+    readonly created_at?: string;
+    readonly updated_at?: 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/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,47 @@
+/* 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';
+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/src/models/PeriodicAgentCreate.ts

@@ -0,0 +1,46 @@
+/* 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';
+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/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/PieChartData.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PieChartSegment } from './PieChartSegment';
+export type PieChartData = {
+    new_users: PieChartSegment;
+    returning_users: PieChartSegment;
+};
+

package/src/models/PieChartSegment.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PieChartSegment = {
+    count: number;
+    percentage: number;
+};
+

package/src/models/PinnedMessageCreate.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PinnedMessageCreate = {
+    readonly id: number;
+    /**
+     * The platform key
+     */
+    platform: string;
+    username: string;
+    session_id: string | null;
+};
+

package/src/models/PinnedMessageGet.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ChatHistory } from './ChatHistory';
+import type { Mentor } from './Mentor';
+export type PinnedMessageGet = {
+    session_id: string;
+    mentor: Mentor;
+    messages: Array<ChatHistory>;
+};
+

package/src/models/PinnedMessageRequest.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PinnedMessageRequest = {
+    /**
+     * Session id of the message to pin
+     */
+    session_id: string;
+};
+

package/src/models/PlatformInvitationCreate.ts

@@ -4,6 +4,13 @@
 /* eslint-disable */
 /**
  * Request serializer for PlatformInvitationView POST endpoint
+ *
+ * Supports new CSV format fields:
+ * - company_name (optional): Company name for the invited user
+ * - first_name (new): First name of the invited user
+ * - last_name (new): Last name of the invited user
+ * - group (new): Name of the UserGroup to assign the user to
+ * - department_admin_email (optional): Email of department admin (for validation)
  */
 export type PlatformInvitationCreate = {
     /**
@@ -42,5 +49,25 @@ export type PlatformInvitationCreate = {
      * Additional metadata for the invitation
      */
     metadata?: Record<string, any>;
+    /**
+     * Company name for the invited user
+     */
+    company_name?: string;
+    /**
+     * First name of the invited user
+     */
+    first_name?: string;
+    /**
+     * Last name of the invited user
+     */
+    last_name?: string;
+    /**
+     * Name of the UserGroup to assign the user to
+     */
+    group?: string;
+    /**
+     * Email of department admin (for validation when group is specified)
+     */
+    department_admin_email?: string;
 };
 

package/src/models/PlatformPrompt.ts

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

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

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

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ReuestDataVariableList } from './ReuestDataVariableList';
+export type PredictiveAnalyticsRequest = {
+    prompt: ReuestDataVariableList;
+};
+

package/src/models/PredictiveAnalyticsResponse.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ResponseDataVariable } from './ResponseDataVariable';
+export type PredictiveAnalyticsResponse = {
+    predictions: Array<ResponseDataVariable>;
+};
+

package/src/models/PreviousAgentStatusEnum.ts

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

package/src/models/ProgramInvitationCreate.ts

@@ -3,7 +3,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Request serializer for ProgramInvitationView POST endpoint
+ * Request serializer for ProgramInvitationView POST endpoint.
+ *
+ * Supports CSV date fields for enrollment_config:
+ * - program_access_start_date: Maps to enrollment_config['started']
+ * - program_access_expiration_date: Maps to enrollment_config['expired']
  */
 export type ProgramInvitationCreate = {
     /**
@@ -46,5 +50,13 @@ export type ProgramInvitationCreate = {
      * Enrollment configuration (dates, etc.)
      */
     enrollment_config?: Record<string, any>;
+    /**
+     * Program access start date (maps to enrollment_config['started'])
+     */
+    program_access_start_date?: string | null;
+    /**
+     * Program access expiration date (maps to enrollment_config['expired'])
+     */
+    program_access_expiration_date?: string | null;
 };
 

package/src/models/Project.ts

@@ -0,0 +1,56 @@
+/* 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 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>;
+};
+