@iblai/iblai-api 4.274.2-core → 4.275.0-ai

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

@@ -0,0 +1,17 @@
+import type { FileTypeEnum } from './FileTypeEnum';
+export type PatchedAgentSkillResource = {
+    readonly id?: number;
+    skill?: number;
+    file_type?: FileTypeEnum;
+    filename?: string;
+    /**
+     * Text content for script/reference resources.
+     */
+    content?: string;
+    /**
+     * Binary file for asset resources.
+     */
+    file?: string | null;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,60 @@
+/**
+ * Serializer for Artifact model.
+ *
+ * Artifacts are structured content like essays, documents, code files, etc.
+ * that are generated by AI agents during a chat session and are best
+ * displayed separately from the normal chat flow.
+ *
+ * Fields:
+ * - id: Unique identifier for the artifact
+ * - title: Title or identifier for the artifact
+ * - content: The markdown-styled content of the artifact
+ * - file_extension: The extension of the file (e.g., 'py', 'md', 'html', 'json', 'csv')
+ * - chat_message: Reference to the chat message that contains this artifact
+ * - llm_name: Name of the LLM that generated the artifact
+ * - llm_provider: Provider of the LLM (e.g., 'openai', 'google', 'anthropic')
+ * - date_created: Timestamp when the artifact was created
+ * - date_updated: Timestamp when the artifact was last updated
+ * - metadata: Additional metadata for the artifact
+ * - username: Username of the student who owns the artifact (read-only)
+ * - session_id: UUID of the session that generated the artifact (read-only)
+ *
+ * Read-only fields:
+ * - id, date_created, date_updated, username, session_id
+ */
+export type PatchedArtifact = {
+    readonly id?: number;
+    /**
+     * Title or identifier for the artifact
+     */
+    title?: string;
+    /**
+     * Content of the artifact
+     */
+    readonly content?: string;
+    /**
+     * The extension of the file for the artifact. eg. `py`, `md`, `html`, `json`, `csv`, etc
+     */
+    readonly file_extension?: string;
+    readonly llm_name?: string;
+    readonly llm_provider?: string;
+    readonly date_created?: string;
+    readonly date_updated?: string;
+    /**
+     * Additional metadata for the artifact
+     */
+    metadata?: any;
+    /**
+     * Username of the student who owns this artifact
+     */
+    readonly username?: string;
+    readonly session_id?: string | null;
+    /**
+     * Version number of the current version
+     */
+    readonly current_version_number?: number;
+    /**
+     * Total number of versions for this artifact
+     */
+    readonly version_count?: number;
+};

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

@@ -0,0 +1,6 @@
+export type PatchedBotCommand = {
+    readonly id?: number;
+    command?: string;
+    mentor?: number;
+    bot?: number;
+};

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

@@ -0,0 +1,12 @@
+import type { Provider05cEnum } from './Provider05cEnum';
+export type PatchedBotCreate = {
+    readonly id?: number;
+    name?: string;
+    provider?: Provider05cEnum;
+    readonly is_configured?: boolean;
+    readonly webhook_url?: string;
+    readonly discord_config?: number;
+    readonly webex_config?: number;
+    readonly whatsapp_config?: number;
+    readonly teams_config?: number;
+};

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

@@ -0,0 +1,38 @@
+import type { CallConfigurationModeEnum } from './CallConfigurationModeEnum';
+import type { LlmProviderEnum } from './LlmProviderEnum';
+import type { SttProviderEnum } from './SttProviderEnum';
+import type { TtsProviderEnum } from './TtsProviderEnum';
+import type { Voice } from './Voice';
+export type PatchedCallConfiguration = {
+    readonly id?: number;
+    mentor?: string;
+    mode?: CallConfigurationModeEnum;
+    tts_provider?: TtsProviderEnum;
+    stt_provider?: SttProviderEnum;
+    llm_provider?: LlmProviderEnum;
+    /**
+     * Language code for TTS, STT, and LLM (e.g., 'en', 'en-US', 'es', 'fr'). Defaults to 'en' (English).
+     */
+    language?: string;
+    /**
+     * Whether to use function calls in the agent or force RAG calls before LLM generation
+     */
+    use_function_calling_for_rag?: boolean;
+    google_voice?: Voice;
+    openai_voice?: Voice;
+    openai_voice_id?: number | null;
+    google_voice_id?: number | null;
+    /**
+     * Whether to enable video for the call. (applicable only for realtime mode)
+     */
+    enable_video?: boolean;
+    /**
+     * System prompt to use for screensharing guidance. Defaults to VIDEO_GUIDANCE_PROMPT from constants.
+     */
+    screensharing_system_prompt?: string;
+    /**
+     * Proactive prompt used during screensharing calls to guide the conversation.
+     */
+    screensharing_proactive_prompt?: string;
+    readonly platform_key?: string;
+};

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

@@ -0,0 +1,14 @@
+/**
+ * Body for ``PATCH config/`` — wraps ``OpenClawClient.patch_config``.
+ *
+ * The ``patch`` dict is deep-merged into the current config; ``null`` values
+ * delete a key, arrays replace wholesale.  Echoing
+ * ``"__OPENCLAW_REDACTED__"`` back at a secret path is the documented way
+ * to leave a secret unchanged.
+ */
+export type PatchedClawConfigPatchRequest = {
+    /**
+     * Merge-patch object applied to the current openclaw.json. Nulls delete keys; arrays replace wholesale; objects merge recursively.
+     */
+    patch?: Record<string, any>;
+};

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

@@ -0,0 +1,41 @@
+import type { ClawInstanceStatusEnum } from './ClawInstanceStatusEnum';
+import type { ClawTypeEnum } from './ClawTypeEnum';
+import type { DeployStateEnum } from './DeployStateEnum';
+import type { ProvisionModeEnum } from './ProvisionModeEnum';
+export type PatchedClawInstance = {
+    readonly id?: number;
+    name?: string;
+    claw_type?: ClawTypeEnum;
+    /**
+     * Managed = provisioned by us. Self-hosted = tenant provides the server.
+     *
+     * * `managed` - Managed
+     * * `self_hosted` - Self-hosted
+     */
+    readonly provision_mode?: ProvisionModeEnum;
+    /**
+     * HTTPS URL of the Claw worker instance.
+     */
+    server_url?: string;
+    gateway_token?: string;
+    /**
+     * Backend that deployed this server. Null = manually configured.
+     */
+    deployment_backend?: number | null;
+    /**
+     * Per-server auth headers (overrides backend defaults).
+     */
+    auth_headers?: any;
+    /**
+     * Variant-specific connection parameters (write-only in API). OpenClaw: device_identity.private_key_pem, timeouts. IronClaw: typically empty (bearer token covered by gateway_token).
+     */
+    connection_params?: any;
+    readonly status?: ClawInstanceStatusEnum;
+    readonly deploy_state?: DeployStateEnum;
+    readonly platform_key?: string;
+    readonly last_health_check?: string | null;
+    readonly last_health_status?: string | null;
+    readonly claw_version?: string | null;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,24 @@
+export type PatchedClawMentorConfig = {
+    readonly id?: number;
+    readonly mentor?: string;
+    readonly mentor_name?: string;
+    readonly mentor_slug?: string;
+    server?: number;
+    readonly server_name?: string;
+    readonly server_status?: string;
+    readonly server_last_health_status?: string | null;
+    readonly server_last_health_check?: string | null;
+    agent_config?: any;
+    agent_id?: string;
+    enabled?: boolean;
+    /**
+     * When True, saving the mentor's AgentConfig should trigger an async config push. Signal/hook not yet wired — currently a flag for future use.
+     */
+    auto_push?: boolean;
+    readonly last_config_push?: string | null;
+    readonly last_config_push_status?: string | null;
+    /**
+     * Security warnings from last config push (baseline verification).
+     */
+    readonly last_push_warnings?: any;
+};

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

@@ -0,0 +1,40 @@
+export type PatchedClawModelProvider = {
+    readonly id?: number;
+    server?: number;
+    readonly server_name?: string;
+    /**
+     * Provider identifier in the Claw config (e.g. 'minimax')
+     */
+    name?: string;
+    /**
+     * Provider API endpoint (e.g. https://api.minimax.io/anthropic)
+     */
+    base_url?: string;
+    /**
+     * Claw provider API type (e.g. 'openai-completions', 'anthropic-messages').
+     */
+    api_type?: string;
+    /**
+     * Name of the LLMCredential to resolve the API key from
+     */
+    credential_name?: string;
+    /**
+     * Key within the LLMCredential value JSON to extract the API key
+     */
+    credential_key?: string;
+    /**
+     * List of {"id": "...", "name": "..."} entries for the provider model catalog
+     */
+    model_catalog?: any;
+    enabled?: boolean;
+    /**
+     * 'merge' adds to built-in models, 'replace' uses only configured providers.
+     */
+    models_mode?: string;
+    readonly last_provider_push?: string | null;
+    readonly last_provider_push_status?: string | null;
+    /**
+     * Check if the referenced LLMCredential exists for this platform.
+     */
+    readonly credential_resolved?: boolean;
+};

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

@@ -0,0 +1,54 @@
+import type { TopicModel } from './TopicModel';
+export type PatchedConversations = {
+    readonly id?: string;
+    readonly messages?: string;
+    topics?: Array<TopicModel>;
+    readonly sentiment?: string;
+    mentor?: string;
+    readonly student?: string;
+    readonly email?: string;
+    model?: string;
+    readonly rating?: number;
+    platform?: string;
+    /**
+     * Email claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_email?: string;
+    /**
+     * Username claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_username?: string;
+    readonly inserted_at?: string;
+    has_document?: boolean;
+    memory_tracked?: boolean;
+    enable_artifacts?: boolean;
+    is_shared?: boolean;
+    /**
+     * False if session was created by an anonymous user
+     */
+    is_authenticated?: boolean;
+    /**
+     * Per-session override that skips writing ChatMessageHistory rows for this conversation. Honored only when the tenant has ALLOW_USER_CHAT_PRIVACY_CONTROL enabled. Mirrors Mentor.disable_chathistory but scoped to one session.
+     */
+    disable_chathistory?: boolean;
+    llm_name?: string | null;
+    llm_provider?: string | null;
+    metadata?: any;
+    /**
+     * AI-generated title summarizing the conversation
+     */
+    title?: string | null;
+    /**
+     * True if the session has both user and AI messages
+     */
+    is_conversation?: boolean;
+    /**
+     * Count of human messages in this session
+     */
+    message_count_human?: number;
+    /**
+     * Count of AI messages in this session
+     */
+    message_count_ai?: number;
+    tools?: Array<number>;
+};

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

@@ -0,0 +1,7 @@
+export type PatchedCourseCreationTaskFile = {
+    readonly id?: number;
+    course_creation_task?: number;
+    file?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};

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

@@ -0,0 +1,14 @@
+export type PatchedCredentialRequest = {
+    /**
+     * Name of the credential provider (e.g., 'openai', 'google-drive')
+     */
+    name?: string;
+    /**
+     * Credential data for the provider (API keys, service account details, etc.)
+     */
+    value?: any;
+    /**
+     * Organization key identifier for the tenant
+     */
+    platform?: string;
+};

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

@@ -0,0 +1,24 @@
+import type { CronDelivery } from './CronDelivery';
+import type { CronPayload } from './CronPayload';
+import type { CronSchedule } from './CronSchedule';
+import type { WakeModeEnum } from './WakeModeEnum';
+/**
+ * Body for ``PATCH cron-jobs/<job_id>/`` — sent verbatim to
+ * ``cron.update`` as the ``patch`` parameter.  Every field is optional.
+ *
+ * Field names are camelCase here to match the wire schema (``CronJobPatch``)
+ * since the patch dict is forwarded directly without translation.
+ */
+export type PatchedCronJobPatch = {
+    name?: string;
+    description?: string;
+    enabled?: boolean;
+    deleteAfterRun?: boolean;
+    agentId?: string;
+    sessionKey?: string;
+    sessionTarget?: string;
+    wakeMode?: WakeModeEnum;
+    schedule?: CronSchedule;
+    payload?: CronPayload;
+    delivery?: CronDelivery;
+};

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

@@ -0,0 +1,17 @@
+import type { DisclaimerScopeEnum } from './DisclaimerScopeEnum';
+export type PatchedDisclaimer = {
+    readonly id?: number;
+    scope?: DisclaimerScopeEnum;
+    /**
+     * Platform to which the disclaimer applies.
+     */
+    readonly platform?: number;
+    content?: string;
+    title?: string;
+    active?: boolean;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+    readonly has_agreed?: boolean;
+    readonly platform_key?: string;
+    mentors?: Array<string>;
+};

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

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

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

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

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

@@ -0,0 +1,33 @@
+import type { ScopeC1dEnum } from './ScopeC1dEnum';
+/**
+ * Serializer for updating FallbackLLM configuration.
+ */
+export type PatchedFallbackLLMUpdate = {
+    /**
+     * Whether this fallback applies to a specific model or entire provider
+     *
+     * * `model` - Model Specific
+     * * `provider` - Provider Wide
+     */
+    scope?: ScopeC1dEnum;
+    /**
+     * The provider whose models this fallback applies to
+     */
+    source_provider?: number;
+    /**
+     * Specific model this fallback applies to (only for model scope)
+     */
+    source_model?: number | null;
+    /**
+     * The provider to use as fallback
+     */
+    fallback_provider?: number;
+    /**
+     * The model to use as fallback
+     */
+    fallback_model?: number;
+    /**
+     * Whether this fallback configuration is active
+     */
+    is_enabled?: boolean;
+};

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

@@ -0,0 +1,17 @@
+export type PatchedGoogleAgentDetail = {
+    readonly id?: number;
+    readonly sub_agents?: string;
+    readonly platform?: string;
+    unique_id?: string;
+    model?: string;
+    name?: string;
+    description?: string;
+    instruction?: string;
+    output_key?: string | null;
+    readonly inserted_at?: string;
+    readonly updated_at?: string;
+    /**
+     * edX user ID
+     */
+    created_by?: number | null;
+};

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

@@ -0,0 +1,15 @@
+export type PatchedGraderCriterion = {
+    readonly id?: number;
+    /**
+     * Name for the criteria (accuracy, clarity, etc.)
+     */
+    name?: string;
+    /**
+     * The requirements to evaluate this criterion against.
+     */
+    criteria?: string;
+    /**
+     * Raw point value for this criterion (e.g. 6 for a 6-point criterion). Normalized against the sum of all criteria points at grading time.
+     */
+    points?: number;
+};

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

@@ -0,0 +1,23 @@
+import type { HumanSupportTicketStatusEnum } from './HumanSupportTicketStatusEnum';
+/**
+ * serializer interface intended for students/ non-admin users.
+ * This limits students to only update the subject and description of a ticket.
+ */
+export type PatchedHumanSupportTicket = {
+    readonly id?: number;
+    readonly username?: string;
+    readonly email?: string;
+    readonly full_name?: string;
+    /**
+     * edX user ID
+     */
+    readonly user?: number;
+    readonly session?: string;
+    subject?: string;
+    description?: string;
+    status?: HumanSupportTicketStatusEnum;
+    readonly mentor_id?: string;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+    readonly resolved_at?: string | null;
+};

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

@@ -0,0 +1,14 @@
+export type PatchedLLMCredentialRequest = {
+    /**
+     * Name of the credential provider
+     */
+    name?: string;
+    /**
+     * Value of the credential provider
+     */
+    value?: any;
+    /**
+     * Key of the tenant
+     */
+    platform?: string;
+};

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

@@ -0,0 +1,65 @@
+import type { AuthScopeEnum } from './AuthScopeEnum';
+import type { AuthTypeEnum } from './AuthTypeEnum';
+import type { MCPServerTransportEnum } from './MCPServerTransportEnum';
+import type { OAuthService } from './OAuthService';
+/**
+ * Serializer for the MCPServer model.
+ */
+export type PatchedMCPServer = {
+    readonly id?: number;
+    readonly platform?: number;
+    mentor?: string | null;
+    /**
+     * edX username
+     */
+    owner?: string | null;
+    name?: string;
+    /**
+     * A description of the MCP server.
+     */
+    description?: string;
+    /**
+     * The url of the MCP server.
+     */
+    url?: string;
+    image?: string | null;
+    transport?: MCPServerTransportEnum;
+    /**
+     * Authorization credentials to authenticate to the MCP server. If provided, these take priority over any headers configured on the server. Token here must be the full authorization value. For example: `<scheme> <credentials>`
+     */
+    credentials?: string;
+    /**
+     * Headers to send to the MCP server. Useful for authentication,
+     */
+    extra_headers?: any;
+    readonly platform_key?: string;
+    /**
+     * Featured mcp servers will be accessible to all other tenants.
+     */
+    is_featured?: boolean;
+    /**
+     * The type of authentication to use for the MCP server.
+     *
+     * * `none` - None
+     * * `token` - Token
+     * * `oauth2` - Oauth2
+     */
+    auth_type?: AuthTypeEnum;
+    /**
+     * Determines the required authentication granularity. 'platform' uses shared platform credentials, 'mentor' requires mentor-level credentials, and 'user' requires each user to authenticate individually.
+     *
+     * * `platform` - Platform
+     * * `mentor` - Mentor
+     * * `user` - User
+     */
+    auth_scope?: AuthScopeEnum;
+    oauth_service?: number | null;
+    readonly oauth_service_data?: OAuthService;
+    readonly mcp_server_connections?: string;
+    /**
+     * Whether the MCP server is enabled or not.
+     */
+    is_enabled?: boolean;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,47 @@
+import type { AuthTypeEnum } from './AuthTypeEnum';
+import type { MCPServerConnectionScopeEnum } from './MCPServerConnectionScopeEnum';
+/**
+ * Serializer for managing `MCPServerConnection` records via the API.
+ *
+ * The serializer enforces the business rules for combining scope, platform,
+ * and authentication configuration while exposing a masked view of any stored
+ * credentials.
+ */
+export type PatchedMCPServerConnection = {
+    readonly id?: number;
+    server?: number;
+    readonly server_name?: string;
+    /**
+     * Whether this connection is scoped to a user or shared across a platform.
+     *
+     * * `user` - User
+     * * `mentor` - Mentor
+     * * `platform` - Platform
+     */
+    scope?: MCPServerConnectionScopeEnum;
+    auth_type?: AuthTypeEnum;
+    platform?: number | null;
+    readonly platform_key?: string | null;
+    /**
+     * edX username
+     */
+    user?: string | null;
+    mentor?: string | null;
+    connected_service?: number | null;
+    readonly connected_service_summary?: Record<string, any> | null;
+    /**
+     * Static credential/token value for token-based authentication.
+     */
+    credentials?: string;
+    /**
+     * Authorization scheme to prefix tokens with (e.g. 'Bearer').
+     */
+    authorization_scheme?: string;
+    /**
+     * Additional headers to include when connecting to the MCP server.
+     */
+    extra_headers?: any;
+    is_active?: boolean;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,8 @@
+import type { McpServerConfig } from './McpServerConfig';
+/**
+ * Body for ``PATCH mcp-servers/<name>/``.
+ */
+export type PatchedMcpServerUpdate = {
+    config?: McpServerConfig;
+    replace?: boolean;
+};

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

@@ -0,0 +1,11 @@
+export type PatchedMentorCategoryGroupCreate = {
+    readonly id?: number;
+    name?: string;
+    description?: string;
+    /**
+     * Deprecated: This is only left for backward compatibility. Please use the audiences field instead.
+     */
+    audience?: number | null;
+    audiences?: Array<number>;
+    readonly date_created?: string;
+};