@iblai/iblai-api 3.38.8-core → 3.38.9-ai

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

@@ -0,0 +1,13 @@
+/**
+ * Serializer for IBL Call Pro authentication request.
+ */
+export type CallAuthenticationRequest = {
+    /**
+     * The ID of the session for the call
+     */
+    session_id: string;
+    /**
+     * The pathway identifier for the call context
+     */
+    pathway: string;
+};

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

@@ -0,0 +1,21 @@
+/**
+ * Serializer for IBL Call Pro authentication parameters.
+ */
+export type CallAuthenticationResponse = {
+    /**
+     * The WebSocket URL for the IBL Call Pro server
+     */
+    ws_url: string;
+    /**
+     * The name of the IBL Call Pro room
+     */
+    room_name: string;
+    /**
+     * The name of the participant joining the room
+     */
+    participant_name: string;
+    /**
+     * The JWT token for authenticating the participant
+     */
+    participant_token: string;
+};

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

@@ -0,0 +1,25 @@
+/**
+ * Serializer for auto increment information response.
+ */
+export type CatalogAutoIncrementResponse = {
+    /**
+     * Platform key identifier
+     */
+    platform_key: string;
+    /**
+     * Platform organization identifier
+     */
+    platform_org: string;
+    /**
+     * Current course number
+     */
+    course_number: number;
+    /**
+     * Current program number
+     */
+    program_number: number;
+    /**
+     * Current pathway number
+     */
+    pathway_number: number;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Serializer for auto increment update request parameters.
+ */
+export type CatalogAutoIncrementUpdateRequest = {
+    /**
+     * Platform key identifier
+     */
+    key?: string;
+    /**
+     * Platform organization identifier
+     */
+    org?: string;
+    /**
+     * Type of number requested (e.g., course, program, pathway)
+     */
+    number_type: string;
+};

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

@@ -0,0 +1,8 @@
+export type ChatHistory = {
+    readonly id: number;
+    message?: any;
+    readonly inserted_at: string;
+    title?: string | null;
+    readonly feedback: any;
+    document_sources?: any;
+};

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

@@ -0,0 +1,9 @@
+import type { ChatHistoryFilterUser } from './ChatHistoryFilterUser';
+import type { DateRange } from './DateRange';
+import type { TopicModel } from './TopicModel';
+export type ChatHistoryFilterData = {
+    topics: Array<TopicModel>;
+    date_ranges?: Array<DateRange>;
+    sentiment?: Array<string>;
+    users: Array<ChatHistoryFilterUser>;
+};

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

@@ -0,0 +1,5 @@
+export type ChatHistoryFilterUser = {
+    username: string;
+    email: string;
+    readonly lti_email: string;
+};

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

@@ -0,0 +1,5 @@
+export type ChatHistoryItem = {
+    type: string;
+    content: string;
+    timestamp: string;
+};

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

@@ -0,0 +1,3 @@
+export type ChatHistorySessionId = {
+    id: string;
+};

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

@@ -0,0 +1,10 @@
+export type ChatSessionRequest = {
+    /**
+     * Name of mentor
+     */
+    mentor: string;
+    /**
+     * List of tools slugs to use. Passing `null` will use all tools assigned to the mentor. For no tools, pass an empty list.
+     */
+    tools?: Array<string>;
+};

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

@@ -0,0 +1,5 @@
+import type { ToolResponse } from './ToolResponse';
+export type ChatSessionResponse = {
+    session_id: string;
+    tools: Array<ToolResponse>;
+};

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

@@ -0,0 +1,10 @@
+export type CheckDocumentTrainingStatus = {
+    /**
+     * Status of the training
+     */
+    status: string;
+    /**
+     * Message of the training
+     */
+    message: string;
+};

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

@@ -0,0 +1,9 @@
+import type { ComponentBlockTypeEnum } from './ComponentBlockTypeEnum';
+export type ComponentBlock = {
+    readonly id: number;
+    unit: number;
+    type?: ComponentBlockTypeEnum;
+    display_name: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `html` - Html
+ * * `multiple_choice` - Multiple Choice
+ */
+export declare enum ComponentBlockTypeEnum {
+    HTML = "html",
+    MULTIPLE_CHOICE = "multiple_choice"
+}

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

@@ -0,0 +1,11 @@
+import type { TopicModel } from './TopicModel';
+export type ConversationMessage = {
+    readonly first_message: string;
+    topics: Array<TopicModel>;
+    id: string;
+    user_id: string;
+    readonly message_count: number;
+    model: string;
+    inserted_at: string;
+    readonly user_sentiment: string;
+};

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

@@ -0,0 +1,6 @@
+export type ConversationRating = {
+    readonly id: number;
+    full_conversation_text: string;
+    rating_text?: string | null;
+    score?: number | null;
+};

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

@@ -0,0 +1,5 @@
+export type ConversationSummary = {
+    total_conversations: number;
+    total_human_messages: number;
+    total_ai_messages: number;
+};

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

@@ -0,0 +1,4 @@
+export type ConversationVolume = {
+    date: string;
+    conversation_count: number;
+};

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

@@ -0,0 +1,28 @@
+import type { TopicModel } from './TopicModel';
+export type Conversations = {
+    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;
+    llm_name?: string | null;
+    llm_provider?: string | null;
+    metadata?: any;
+    tools?: Array<number>;
+};

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

@@ -0,0 +1,3 @@
+export type Cost = {
+    total_cost: number;
+};

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

@@ -0,0 +1,6 @@
+import type { ModelCost } from './ModelCost';
+export type CostPerTenant = {
+    platform_key: string;
+    total_cost: number;
+    model_costs: Array<ModelCost>;
+};

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

@@ -0,0 +1,15 @@
+export type Course = {
+    /**
+     * The edX course ID string for the course.
+     */
+    readonly course_id: string;
+    /**
+     * The display name of the course. (Should match edX)
+     */
+    readonly name: string;
+    /**
+     * An additional unique slug field. (Optional)
+     */
+    readonly slug: string | null;
+    org?: string;
+};

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

@@ -0,0 +1,25 @@
+/**
+ * Serializer for course creation/update request body.
+ */
+export type CourseCreateUpdate = {
+    /**
+     * The unique identifier for the course
+     */
+    course_id: string;
+    /**
+     * The organization associated with the course
+     */
+    org: string;
+    /**
+     * The name of the course
+     */
+    name?: string;
+    /**
+     * The slug for the course
+     */
+    slug?: string;
+    /**
+     * Additional course data
+     */
+    data?: any;
+};

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

@@ -0,0 +1,31 @@
+import type { CourseCreationTaskFile } from './CourseCreationTaskFile';
+import type { CourseCreationTaskStatusEnum } from './CourseCreationTaskStatusEnum';
+export type CourseCreationTask = {
+    readonly id: number;
+    readonly user_id: string;
+    /**
+     * edX user ID
+     */
+    readonly student: number;
+    name: string;
+    /**
+     * Description of the course to create and its requirements
+     */
+    description: string;
+    /**
+     * The intended audience for the course. eg. Grade 11 students.
+     */
+    target_audience: string;
+    readonly platform: number;
+    readonly platform_key: string;
+    readonly status: CourseCreationTaskStatusEnum;
+    publish_course?: boolean;
+    readonly course_data: any;
+    provider?: string;
+    model?: string;
+    desired_number_of_sections?: number;
+    readonly logs: string;
+    readonly files: Array<CourseCreationTaskFile>;
+    readonly date_created: string;
+    readonly last_modified: string;
+};

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * * `Pending` - Pending
+ * * `Scheduled` - Scheduled
+ * * `Success` - Success
+ * * `Failed` - Failed
+ * * `Cancelled` - Cancelled
+ * * `In Progress` - In Progress
+ */
+export declare enum CourseCreationTaskStatusEnum {
+    PENDING = "Pending",
+    SCHEDULED = "Scheduled",
+    SUCCESS = "Success",
+    FAILED = "Failed",
+    CANCELLED = "Cancelled",
+    IN_PROGRESS = "In Progress"
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Serializer for course deletion response.
+ */
+export type CourseDeleteResponse = {
+    /**
+     * Number of courses deleted
+     */
+    count: number;
+    /**
+     * Types of objects deleted
+     */
+    type: Record<string, any>;
+};

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

@@ -0,0 +1,25 @@
+/**
+ * Serializer for course eligibility check response.
+ */
+export type CourseEligibilityCheckResponse = {
+    /**
+     * Whether the user is eligible for the course
+     */
+    eligible: boolean;
+    /**
+     * Reasons for eligibility or ineligibility
+     */
+    reasons: Array<string>;
+    /**
+     * User ID checked
+     */
+    user_id: number;
+    /**
+     * Course ID checked
+     */
+    course_id: string;
+    /**
+     * Organization of the course
+     */
+    org: string;
+};

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

@@ -0,0 +1,53 @@
+/**
+ * Serializer for course enrollment search results.
+ */
+export type CourseEnrollmentSearchResponse = {
+    /**
+     * User ID associated with the enrollment
+     */
+    user_id: number;
+    /**
+     * Username associated with the enrollment
+     */
+    username: string;
+    /**
+     * Email of the user
+     */
+    email: string;
+    /**
+     * Course ID associated with the enrollment
+     */
+    course_id: string;
+    /**
+     * Whether the enrollment is active
+     */
+    active: boolean;
+    /**
+     * Date when enrollment began/activated
+     */
+    created: string;
+    /**
+     * Date when enrollment started
+     */
+    started: string | null;
+    /**
+     * Date when enrollment ended/deactivated
+     */
+    ended: string | null;
+    /**
+     * Date when enrollment expires
+     */
+    expired: string | null;
+    /**
+     * Enrollment specific metadata
+     */
+    metadata: any;
+    /**
+     * Full name of the user
+     */
+    name: string | null;
+    /**
+     * Name of the course
+     */
+    course_name: string;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Serializer for course metadata search request body.
+ */
+export type CourseMetadataSearchRequest = {
+    /**
+     * Filter by metadata fields (JSON object)
+     */
+    data__contains?: any;
+    /**
+     * Filter by course slug
+     */
+    slug?: string;
+    /**
+     * Filter by course ID
+     */
+    course_id?: string;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Serializer for course metadata update request body.
+ */
+export type CourseMetadataUpdateRequest = {
+    /**
+     * The course ID to update metadata for
+     */
+    course_id: string;
+    /**
+     * The metadata to update
+     */
+    metadata: any;
+    /**
+     * Whether to update (True) or overwrite (False) existing metadata
+     */
+    update?: boolean;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Serializer for course review info response.
+ */
+export type CourseReviewInfoResponse = {
+    /**
+     * The course ID associated with the reviews
+     */
+    course_id: string;
+    /**
+     * Average rating of the course
+     */
+    avg_rating: number | null;
+    /**
+     * Total number of reviews for the course
+     */
+    count: number;
+};

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

@@ -0,0 +1,14 @@
+export type CredentialRequest = {
+    /**
+     * 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/CrontabSchedule.d.ts

@@ -0,0 +1,22 @@
+export type CrontabSchedule = {
+    /**
+     * Cron Minutes to Run. Use "*" for "all". (Example: "0,30")
+     */
+    minute?: string;
+    /**
+     * Cron Hours to Run. Use "*" for "all". (Example: "8,20")
+     */
+    hour?: string;
+    /**
+     * Cron Days Of The Week to Run. Use "*" for "all", Sunday is 0 or 7, Monday is 1. (Example: "0,5")
+     */
+    day_of_week?: string;
+    /**
+     * Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")
+     */
+    day_of_month?: string;
+    /**
+     * Cron Months (1-12) Of The Year to Run. Use "*" for "all". (Example: "1,12")
+     */
+    month_of_year?: string;
+};

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

@@ -0,0 +1,13 @@
+export type CustomInstructionResponse = {
+    readonly id: number;
+    about_user?: string | null;
+    mentor_tone?: string | null;
+    /**
+     * Position or work. eg: Engineer, student etc.
+     */
+    profession?: string;
+    /**
+     * Comma seperated list of expected traits for mentor.
+     */
+    desired_mentor_traits?: string;
+};

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

@@ -0,0 +1,4 @@
+export type DateRange = {
+    start_date: string;
+    end_date: string;
+};

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

@@ -1,4 +1,7 @@
 import type { Role } from './Role';
 export type DesiredRole = {
+    user_id?: number;
+    username?: string;
     roles: Array<Role>;
+    readonly data: any;
 };

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

@@ -0,0 +1,21 @@
+/**
+ * Serializer for desired role creation/update request parameters.
+ */
+export type DesiredRoleCreateUpdateRequest = {
+    /**
+     * User ID
+     */
+    user_id?: number;
+    /**
+     * Username
+     */
+    username?: string;
+    /**
+     * List of roles (can be role IDs or objects with name, platform_key, etc.)
+     */
+    roles: Array<Record<string, any>>;
+    /**
+     * Additional data
+     */
+    data?: any;
+};

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

@@ -1,4 +1,7 @@
 import type { Skill } from './Skill';
 export type DesiredSkill = {
+    user_id?: number;
+    username?: string;
     skills: Array<Skill>;
+    readonly data: any;
 };

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

@@ -0,0 +1,21 @@
+/**
+ * Serializer for desired skill creation/update request parameters.
+ */
+export type DesiredSkillCreateUpdateRequest = {
+    /**
+     * User ID
+     */
+    user_id?: number;
+    /**
+     * Username
+     */
+    username?: string;
+    /**
+     * List of skills (can be skill IDs or objects with name, platform_key, etc.)
+     */
+    skills: Array<Record<string, any>>;
+    /**
+     * Additional data
+     */
+    data?: any;
+};

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

@@ -0,0 +1,41 @@
+/**
+ * Serializer for document objects
+ */
+export type Document = {
+    /**
+     * Document ID
+     */
+    id: number;
+    /**
+     * Name of the document
+     */
+    document_name: string;
+    /**
+     * Type of document (e.g., 'pdf', 'text')
+     */
+    document_type: string;
+    /**
+     * Access level of the document
+     */
+    access: string;
+    /**
+     * Training status of the document
+     */
+    training_status: string;
+    /**
+     * Date when the document was created
+     */
+    date_created: string;
+    /**
+     * Date when the document was last modified
+     */
+    last_modified: string;
+    /**
+     * URL to access the document
+     */
+    url: string;
+    /**
+     * Additional metadata for the document
+     */
+    metadata: any;
+};