@iblai/iblai-api 4.256.0-ai → 4.256.0-core

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

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

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

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

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

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

@@ -1,14 +0,0 @@
-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/PatchedDisclaimer.d.ts

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

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

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

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

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

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

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

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

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

@@ -1,65 +0,0 @@
-import type { AuthScopeEnum } from './AuthScopeEnum';
-import type { AuthTypeEnum } from './AuthTypeEnum';
-import type { OAuthService } from './OAuthService';
-import type { TransportEnum } from './TransportEnum';
-/**
- * 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?: TransportEnum;
-    /**
-     * 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

@@ -1,47 +0,0 @@
-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/PatchedMentorCategoryGroupCreate.d.ts

@@ -1,11 +0,0 @@
-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;
-};

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

@@ -1,194 +0,0 @@
-import type { GreetingMethodEnum } from './GreetingMethodEnum';
-import type { PrivacyAction011Enum } from './PrivacyAction011Enum';
-import type { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
-import type { VoiceProviderEnum } from './VoiceProviderEnum';
-export type PatchedMentorCreate = {
-    name?: string;
-    unique_id?: string;
-    /**
-     * The langflow json for the mentor
-     */
-    flow?: any;
-    slug?: string;
-    platform?: string;
-    allow_anonymous?: boolean;
-    /**
-     * Allow this mentor to be used offline with local LLMs
-     */
-    enable_offline_mode?: boolean;
-    metadata?: any;
-    enable_moderation?: boolean;
-    enable_multi_query_rag?: boolean;
-    /**
-     * Enable prompt caching for Anthropic models to reduce latency and cost. This disabled RAG and other dynamic parts of system prompt such as memory, current datetime, etc. Use with caution
-     */
-    enable_prompt_caching?: boolean;
-    enable_post_processing_system?: boolean;
-    /**
-     * (Deprecated) Set template mentor to openai-agent instead.
-     */
-    enable_openai_assistant?: boolean;
-    /**
-     * Whether to force mentor to only use information within the provided documents.
-     */
-    enable_total_grounding?: boolean;
-    /**
-     * Whether to show suggested prompts for the mentor or not. Note: Suggested prompts are created by tenant admins.
-     */
-    enable_suggested_prompts?: boolean;
-    /**
-     * Whether to show suggested prompts for the mentor or not. Note: Guided prompts are created with an llm based on chat history.
-     */
-    enable_guided_prompts?: boolean;
-    save_flagged_prompts?: boolean;
-    google_voice?: number | null;
-    openai_voice?: number | null;
-    /**
-     * TTS provider used when synthesizing chat messages from this mentor. Selects between openai_voice and google_voice.
-     *
-     * * `openai` - OpenAI
-     * * `google` - Google
-     */
-    voice_provider?: VoiceProviderEnum;
-    /**
-     * Instructions to determine how prompt suggestions are generated.
-     */
-    guided_prompt_instructions?: string;
-    categories?: Array<number>;
-    types?: Array<number>;
-    subjects?: Array<number>;
-    /**
-     * Prompt template used to start a conversation with the user when greeting_type is proactive_prompt. This will be sent to the LLM so it can respond naturally
-     */
-    proactive_prompt?: string;
-    /**
-     * Prompt to be used to guide the user through their studies when study mode tool is enabled.
-     */
-    study_mode_prompt?: string;
-    /**
-     * Disclaimer to be shown to the user when the mentor is used.
-     */
-    disclaimer?: string;
-    enable_disclaimer?: boolean;
-    /**
-     * Show attachments on mentor.
-     */
-    show_attachment?: boolean;
-    /**
-     * Show voice call button on mentor.
-     */
-    show_voice_call?: boolean;
-    /**
-     * Show voice recording button on mentor.
-     */
-    show_voice_record?: boolean;
-    /**
-     * Show RAG images in mentor response.
-     */
-    show_rag_images?: boolean;
-    /**
-     * Type of starter prompts to show: guided_prompt or suggested_prompt.
-     *
-     * * `guided_prompt` - Guided Prompt
-     * * `suggested_prompt` - Suggested Prompt
-     */
-    starter_prompts?: StarterPromptsB04Enum;
-    /**
-     * Allow embedded mentor to read content on the embedded web page.
-     */
-    embed_is_context_aware?: boolean;
-    /**
-     * Open mentor embed iframe by default.
-     */
-    embed_open_by_default?: boolean;
-    /**
-     * Show attachments on embedded mentor.
-     */
-    embed_show_attachment?: boolean;
-    /**
-     * Show voice call button on embedded mentor.
-     */
-    embed_show_voice_call?: boolean;
-    /**
-     * Show voice recording button on embedded mentor.
-     */
-    embed_show_voice_record?: boolean;
-    /**
-     * Show explore mentors option.
-     */
-    show_explore_mentors?: boolean;
-    /**
-     * Stores embedded icon selection data for the mentor widget.
-     */
-    embed_icon_selection_data?: any;
-    /**
-     * Placeholder to be shown in the input text area when the mentor is used.
-     */
-    placeholder_prompt?: string;
-    /**
-     * The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.
-     */
-    moderation_system_prompt?: string;
-    /**
-     * Prompt to be used to alter or modify final llm response into any desired form.
-     */
-    post_processing_prompt?: string;
-    /**
-     * Desired feedback to return to the user when their prompt is deemed inappropriate.
-     */
-    moderation_response?: string;
-    /**
-     * Prompt to check whether the models response is appropriate or not.
-     */
-    safety_system_prompt?: string;
-    /**
-     * Feedback given to the user when a model generates an inappropriate response
-     */
-    safety_response?: string;
-    disable_chathistory?: boolean;
-    enable_safety_system?: boolean;
-    /**
-     * Enable PII detection and filtering before messages reach the LLM
-     */
-    enable_privacy_router?: boolean;
-    /**
-     * Action to take when PII is detected: redact replaces with labels, mask partially hides, block rejects the message
-     *
-     * * `redact` - Redact
-     * * `mask` - Mask
-     * * `block` - Block
-     */
-    privacy_action?: PrivacyAction011Enum;
-    /**
-     * List of PII entity types to detect. Empty list uses defaults (PERSON, EMAIL, PHONE, SSN, etc.)
-     */
-    privacy_entities?: any;
-    /**
-     * Response shown to user when a message is blocked due to PII detection
-     */
-    privacy_response?: string;
-    /**
-     * Also filter PII from LLM responses (output rail)
-     */
-    enable_privacy_output_filter?: boolean;
-    /**
-     * Response to start a conversation with a user.
-     */
-    proactive_response?: string;
-    mcp_servers?: Array<number>;
-    /**
-     * How the mentor should greet the user. proactive_prompt: Allow the LLM to respond to proactive_prompt msg. proactive_response: use proactive_response template without performing an LLM call.
-     *
-     * * `proactive_prompt` - Proactive Prompt
-     * * `proactive_response` - Proactive Response
-     */
-    greeting_method?: GreetingMethodEnum;
-    /**
-     * edX user ID
-     */
-    last_accessed_by?: number | null;
-    recently_accessed_at?: string | null;
-    created_by?: string | null;
-    readonly created_at?: string | null;
-    readonly updated_at?: string | null;
-};

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

@@ -1,3 +0,0 @@
-export type PatchedMentorFromTemplate = {
-    detail?: string;
-};

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

@@ -1,24 +0,0 @@
-import type { FeedbackModeEnum } from './FeedbackModeEnum';
-import type { GradingModeEnum } from './GradingModeEnum';
-/**
- * Config-only surface. Criteria are managed through the criteria
- * endpoints — keeping the two responsibilities separate.
- */
-export type PatchedMentorGraderConfig = {
-    readonly id?: number;
-    readonly mentor?: string;
-    /**
-     * Selects which grading tool the mentor exposes to the LLM. Only one tool is exposed per mode so the agent can't choose between them.
-     *
-     * * `submission` - Submission
-     * * `conversation` - Conversation
-     */
-    grading_mode?: GradingModeEnum;
-    /**
-     * Describe the problem that's being graded and any special instructions outside of the rubric. The grading LLM is already instructed to give a score of 0-1 for each rubric criterion which is multiplied by the criterion's points to give earned points; overall score is total earned points / total possible points.
-     */
-    grader_instructions?: string;
-    feedback_mode?: FeedbackModeEnum;
-    readonly created_at?: string;
-    readonly updated_at?: string;
-};