/* 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;
};