@iblai/iblai-api 3.34.5-ai

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

@@ -0,0 +1,18 @@
+export type CourseGradeDetailBlock = {
+    /**
+     * Block name
+     */
+    display_name: string;
+    /**
+     * Block Id
+     */
+    id: string;
+    /**
+     * Total users who have attempted it
+     */
+    attempts?: string;
+    /**
+     * Average block value
+     */
+    average: string;
+};

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

@@ -0,0 +1,23 @@
+import type { CourseGradeDetailBlock } from './CourseGradeDetailBlock';
+export type CourseGradeDetailSubSection = {
+    /**
+     * Block name
+     */
+    display_name: string;
+    /**
+     * Block Id
+     */
+    id: string;
+    /**
+     * Total users who have attempted it
+     */
+    attempts?: string;
+    /**
+     * Average block value
+     */
+    average: string;
+    /**
+     * Problems in section
+     */
+    problems?: Array<CourseGradeDetailBlock>;
+};

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

@@ -0,0 +1,4 @@
+import type { CourseGradeSummaryData } from './CourseGradeSummaryData';
+export type CourseGradeSummary = {
+    data?: Array<CourseGradeSummaryData>;
+};

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

@@ -0,0 +1,18 @@
+export type CourseGradeSummaryData = {
+    /**
+     * Assignment Type name
+     */
+    assignment_type: string;
+    /**
+     * Assignment weight
+     */
+    weight: number;
+    /**
+     * Assignment weighted grade average in course
+     */
+    average_weighted_grade: number;
+    /**
+     * Assignment section grade average in course
+     */
+    average_section_grade: number;
+};

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

@@ -0,0 +1,4 @@
+import type { CourseGradingDetailData } from './CourseGradingDetailData';
+export type CourseGradingDetail = {
+    data?: Array<CourseGradingDetailData>;
+};

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

@@ -0,0 +1,12 @@
+import type { CourseGradeDetailSubSection } from './CourseGradeDetailSubSection';
+export type CourseGradingDetailData = {
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    subsections?: Array<CourseGradeDetailSubSection>;
+};

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

@@ -0,0 +1,7 @@
+export type CoursePoint = {
+    /**
+     * The edX course ID string for the course.
+     */
+    course_id: string;
+    points: number;
+};

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

@@ -0,0 +1,8 @@
+import type { Skill } from './Skill';
+export type CourseSkill = {
+    /**
+     * The edX course ID string for the course.
+     */
+    course_id: string;
+    skills: Array<Skill>;
+};

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

@@ -0,0 +1,28 @@
+export type Credential = {
+    entityId: string;
+    name: string;
+    name_override?: string | null;
+    description?: string | null;
+    criteriaUrl: string;
+    criteriaNarrative: string;
+    createdAt: string;
+    readonly iconImage: string;
+    icon_image_id: number;
+    readonly backgroundImage: string;
+    background_image_id: number;
+    readonly thumbnailImage: string;
+    thumbnail_image_id: number;
+    readonly catalog_items: Array<string>;
+    readonly courses: Array<Record<string, string>>;
+    readonly programs: string;
+    readonly issuerDetails: Record<string, string>;
+    html_template?: string | null;
+    css_template?: string | null;
+    metadata?: any;
+    credentialType: string;
+    readonly expires: Record<string, number>;
+    tags?: any;
+    readonly signatories: Array<Record<string, string>>;
+    signal: string;
+    readonly pathways: Array<Record<string, string>>;
+};

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/DesiredSkill.d.ts

@@ -0,0 +1,4 @@
+import type { Skill } from './Skill';
+export type DesiredSkill = {
+    skills: Array<Skill>;
+};

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

@@ -0,0 +1,22 @@
+export type DetailedGradeSubsection = {
+    /**
+     * Subsection name
+     */
+    display_name: string;
+    /**
+     * Subsection Id
+     */
+    id: string;
+    /**
+     * Subsection earned mark
+     */
+    graded_earned: string;
+    /**
+     * Subsection Possible Mark
+     */
+    graded_possible: string;
+    /**
+     * Subsection Grade
+     */
+    graded_percent: string;
+};

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

@@ -0,0 +1,4 @@
+import type { DetailedGradeViewData } from './DetailedGradeViewData';
+export type DetailedGradeView = {
+    data?: Array<DetailedGradeViewData>;
+};

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

@@ -0,0 +1,12 @@
+import type { DetailedGradeSubsection } from './DetailedGradeSubsection';
+export type DetailedGradeViewData = {
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    children?: Array<DetailedGradeSubsection>;
+};

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

@@ -0,0 +1,30 @@
+import type { Institution } from './Institution';
+import type { UserInfo } from './UserInfo';
+export type Education = {
+    readonly id: number;
+    /**
+     * edX user ID
+     */
+    readonly user: number;
+    readonly user_info: UserInfo;
+    readonly institution: Institution;
+    institution_id: number;
+    degree?: string | null;
+    field_of_study?: string | null;
+    start_date: string;
+    end_date?: string | null;
+    grade?: string | null;
+    activities?: string | null;
+    description?: string | null;
+    /**
+     * Metadata
+     */
+    data?: any;
+    /**
+     * Metadata
+     */
+    metadata?: any;
+    created_at?: string;
+    readonly updated_at: string;
+    is_current?: boolean | null;
+};

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

@@ -0,0 +1,11 @@
+export type EdxCourse = {
+    readonly id: number;
+    name: string;
+    run: string;
+    number: string;
+    description?: string;
+    xblock_id: string;
+    task?: number | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,4 @@
+export type ElevenlabsCustomVoice = {
+    name: string;
+    files: Array<string>;
+};

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

@@ -0,0 +1,8 @@
+export type ElevenlabsCustomVoiceResponse = {
+    name: string;
+    readonly owner_student: string | null;
+    language?: string;
+    is_premade?: boolean;
+    description?: string;
+    readonly sample_audio_url: string | null;
+};

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

@@ -0,0 +1,13 @@
+export type EmailPromptDetail = {
+    readonly id: number;
+    readonly inserted_at: string;
+    sender_email: string;
+    sender_name?: string | null;
+    subject?: string | null;
+    content: string;
+    mentor_name?: string | null;
+    mentor_email: string;
+    is_processed?: boolean;
+    mentor_response?: string | null;
+    send_status?: string | null;
+};

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

@@ -0,0 +1,11 @@
+export type EmailPromptList = {
+    readonly id: number;
+    sender_email: string;
+    sender_name?: string | null;
+    subject?: string | null;
+    readonly content_summary: string | null;
+    mentor_name?: string | null;
+    mentor_email: string;
+    is_processed?: boolean;
+    readonly inserted_at: string;
+};

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

@@ -0,0 +1,5 @@
+export type EmailPromptSummary = {
+    readonly total_emails: number;
+    readonly replied_emails: number;
+    readonly pending_emails: number;
+};

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

@@ -0,0 +1,6 @@
+import type { EngagementPerCourseData } from './EngagementPerCourseData';
+import type { Pagination } from './Pagination';
+export type EngagementPerCourse = {
+    data?: Array<EngagementPerCourseData>;
+    pagination: Pagination;
+};

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

@@ -0,0 +1,26 @@
+export type EngagementPerCourseData = {
+    /**
+     * edx Course Id
+     */
+    course_id: string;
+    /**
+     * Course start date
+     */
+    course_start: string;
+    /**
+     * Course end date
+     */
+    course_end: string;
+    /**
+     * Average days spent by each learners on the course
+     */
+    average_days: number;
+    /**
+     * Average days spent by learner on the course
+     */
+    average_time_spent: number;
+    /**
+     * Course name
+     */
+    name: string;
+};

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

@@ -0,0 +1,8 @@
+import type { EnrollmentsData } from './EnrollmentsData';
+import type { OvertimeMeta } from './OvertimeMeta';
+import type { Pagination } from './Pagination';
+export type Enrollments = {
+    data?: Array<EnrollmentsData>;
+    pagination: Pagination;
+    meta?: OvertimeMeta;
+};

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

@@ -0,0 +1,18 @@
+export type EnrollmentsData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Number of users
+     */
+    users: number;
+    /**
+     * Percentage ...
+     */
+    percentage: number;
+};

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

@@ -0,0 +1,6 @@
+import type { EnrollmentsPerUserData } from './EnrollmentsPerUserData';
+import type { Pagination } from './Pagination';
+export type EnrollmentsPerUser = {
+    data?: Array<EnrollmentsPerUserData>;
+    pagination: Pagination;
+};

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

@@ -0,0 +1,18 @@
+export type EnrollmentsPerUserData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner Name
+     */
+    full_name: string;
+    /**
+     * Email
+     */
+    email: string;
+    /**
+     * Course start date
+     */
+    timestamp: string;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * Generic error response serializer
+ */
+export type ErrorResponse = {
+    status: string;
+    message: string;
+    details?: any;
+};

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

@@ -0,0 +1,29 @@
+import type { Company } from './Company';
+import type { UserInfo } from './UserInfo';
+export type Experience = {
+    readonly id: number;
+    /**
+     * edX user ID
+     */
+    readonly user: number;
+    readonly user_info: UserInfo;
+    readonly company: Company;
+    company_id: number;
+    title: string;
+    employment_type?: string | null;
+    location?: string | null;
+    start_date: string;
+    end_date?: string | null;
+    is_current?: boolean;
+    description?: string | null;
+    /**
+     * Metadata
+     */
+    data?: any;
+    /**
+     * Metadata
+     */
+    metadata?: any;
+    created_at?: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,10 @@
+export type FloatOverTime = {
+    /**
+     * Date of event
+     */
+    date: string;
+    /**
+     * Total quantity for date
+     */
+    total: number;
+};

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

@@ -0,0 +1,3 @@
+export type FreeUsageCount = {
+    count: number;
+};

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

@@ -0,0 +1,13 @@
+import type { SectionWithChildren } from './SectionWithChildren';
+export type FullCourse = {
+    readonly id: number;
+    name: string;
+    run: string;
+    number: string;
+    description?: string;
+    xblock_id: string;
+    task?: number | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+    sections: Array<SectionWithChildren>;
+};

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

@@ -0,0 +1,8 @@
+import type { GradingPerUserData } from './GradingPerUserData';
+export type GradingPerUser = {
+    data?: Array<GradingPerUserData>;
+    /**
+     * Total rows
+     */
+    total?: number;
+};

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

@@ -0,0 +1,26 @@
+export type GradingPerUserData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner Name
+     */
+    full_name: string;
+    /**
+     * Course enrollment date
+     */
+    start_date: string;
+    /**
+     * Total assessment submissions
+     */
+    submissions: number;
+    /**
+     * Last active time
+     */
+    last_active: string;
+    /**
+     * TStudent course grade
+     */
+    percent: number;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `proactive_prompt` - Proactive Prompt
+ * * `proactive_response` - Proactive Response
+ */
+export declare enum GreetingMethodEnum {
+    PROACTIVE_PROMPT = "proactive_prompt",
+    PROACTIVE_RESPONSE = "proactive_response"
+}

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

@@ -0,0 +1,6 @@
+import type { GroupListData } from './GroupListData';
+import type { Pagination } from './Pagination';
+export type GroupList = {
+    data?: Array<GroupListData>;
+    pagination: Pagination;
+};

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

@@ -0,0 +1,16 @@
+/**
+ * Serializer for department list endpoint
+ */
+export type GroupListData = {
+    id: number;
+    name: string;
+    platform: string;
+    courses_enrolled: number;
+    courses_completed: number;
+    completion_rate: number;
+    pathways_completed: number;
+    certificates_earned: number;
+    skills_points: number;
+    skills_earned: number;
+    time_spent: string;
+};

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

@@ -0,0 +1,3 @@
+export type GuidedPromptsResponse = {
+    ai_prompts: Array<string>;
+};

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

@@ -0,0 +1,8 @@
+export type HeygenMarketingVideoDetail = {
+    name?: string;
+    data?: any;
+    script?: string | null;
+    readonly pk: number;
+    readonly video_file: string | null;
+    readonly generation_status: string;
+};

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

@@ -0,0 +1,6 @@
+export type HeygenMarketingVideoList = {
+    name?: string;
+    data?: any;
+    readonly pk: number;
+    readonly generation_status: string;
+};

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

@@ -0,0 +1,3 @@
+export type IBLAIPlatformMeta = {
+    metadata?: any;
+};

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

@@ -0,0 +1,6 @@
+export type IBLAIPlatformMetaRequest = {
+    /**
+     * Platform metadata including LLM configurations and active services
+     */
+    data: any;
+};

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

@@ -0,0 +1,10 @@
+export type IBLAIPlatformMetaUpdateRequest = {
+    /**
+     * The LLM provider to set as active (e.g., 'openai', 'google')
+     */
+    active_llm?: string;
+    /**
+     * List of LLM providers to add to available providers
+     */
+    llms?: Array<string>;
+};

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

@@ -0,0 +1,3 @@
+export type ImageUpload = {
+    file: string;
+};

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

@@ -0,0 +1,6 @@
+import type { IntialQuestionAnswer } from './IntialQuestionAnswer';
+export type InputQuestion = {
+    text: string;
+    difficulty_level?: number;
+    possible_answers: Array<IntialQuestionAnswer>;
+};

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

@@ -0,0 +1,20 @@
+import type { InstitutionTypeEnum } from './InstitutionTypeEnum';
+export type Institution = {
+    readonly id: number;
+    name: string;
+    institution_type?: InstitutionTypeEnum;
+    location?: string | null;
+    website?: string | null;
+    accreditation?: string | null;
+    established_year?: number | null;
+    /**
+     * Metadata
+     */
+    data?: any;
+    /**
+     * Metadata
+     */
+    metadata?: any;
+    created_at?: string;
+    readonly updated_at: string;
+};