@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,21 @@
+/**
+ * Request serializer for PathwaySuggestionBulkManagementView POST endpoint
+ */
+export type PathwaySuggestionBulkCreate = {
+    /**
+     * The platform for the suggestions
+     */
+    platform_key: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * List of suggestion data objects, each containing pathway_id, user_id, etc.
+     */
+    suggestion_data: Array<Record<string, any>>;
+    /**
+     * Flag to ensure department admins can call the API
+     */
+    department_mode?: boolean;
+};

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

@@ -0,0 +1,53 @@
+/**
+ * Request serializer for PathwaySuggestionManagementView POST endpoint
+ */
+export type PathwaySuggestionCreate = {
+    /**
+     * The platform for the suggestion
+     */
+    platform_key: string;
+    /**
+     * The pathway ID to suggest
+     */
+    pathway_id: string;
+    /**
+     * The pathway UUID to suggest
+     */
+    pathway_uuid: string;
+    /**
+     * The user to suggest the pathway to
+     */
+    user_id: string;
+    /**
+     * The username of the user to suggest the pathway to
+     */
+    username?: string;
+    /**
+     * The email of the user to suggest the pathway to
+     */
+    email?: string;
+    /**
+     * Whether the suggestion is accepted
+     */
+    accepted?: boolean;
+    /**
+     * Whether the suggestion is visible
+     */
+    visible?: boolean;
+    /**
+     * Additional suggestion metadata
+     */
+    metadata?: Record<string, any>;
+    /**
+     * The user who suggested the pathway
+     */
+    suggested_by?: string;
+    /**
+     * Whether the suggestion is direct
+     */
+    direct?: boolean;
+    /**
+     * Flag to ensure department admins can call the API
+     */
+    department_mode?: boolean;
+};

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

@@ -0,0 +1,61 @@
+/**
+ * Response serializer for pathway suggestion details
+ */
+export type PathwaySuggestionDetail = {
+    /**
+     * The unique identifier for the suggestion
+     */
+    id: number;
+    /**
+     * The ID of the user receiving the suggestion
+     */
+    user_id: number;
+    /**
+     * The username of the user receiving the suggestion
+     */
+    username: string;
+    /**
+     * The full name of the user receiving the suggestion
+     */
+    name: string;
+    /**
+     * The platform key associated with the suggestion
+     */
+    platform_key: string;
+    /**
+     * Whether the suggestion has been accepted by the user
+     */
+    accepted: boolean;
+    /**
+     * Whether the suggestion is visible to the user
+     */
+    visible: boolean;
+    /**
+     * When the suggestion was created
+     */
+    created: string;
+    /**
+     * When the suggestion was last modified
+     */
+    modified: string;
+    /**
+     * Additional metadata for the suggestion
+     */
+    metadata: Record<string, any>;
+    /**
+     * The pathway ID being suggested
+     */
+    pathway_id: string;
+    /**
+     * The UUID of the pathway being suggested
+     */
+    pathway_uuid: string;
+    /**
+     * The name of the pathway being suggested
+     */
+    pathway_name: string;
+    /**
+     * The platform key associated with the pathway
+     */
+    pathway_platform_key: string;
+};

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

@@ -0,0 +1,30 @@
+export type PerLearnerCourseLastAccessData = {
+    /**
+     * Edx Course ID
+     */
+    course_id?: string;
+    /**
+     * Course Name
+     */
+    course_name?: string;
+    /**
+     * Last Block Accessed
+     */
+    block_id?: string;
+    /**
+     * Last Block Display Name
+     */
+    block_display_name?: string;
+    /**
+     * Course grade
+     */
+    course_grade?: number;
+    /**
+     * Course progress
+     */
+    course_progress?: number;
+    /**
+     * Last accessed time
+     */
+    last_accessed?: string;
+};

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

@@ -0,0 +1,8 @@
+import type { PerLearnerCourseVideosWatchedData } from './PerLearnerCourseVideosWatchedData';
+export type PerLearnerCourseVideosWatched = {
+    data: Array<PerLearnerCourseVideosWatchedData>;
+    /**
+     * videos watched
+     */
+    total: number;
+};

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

@@ -0,0 +1,14 @@
+export type PerLearnerCourseVideosWatchedData = {
+    /**
+     * Video Id
+     */
+    id: string;
+    /**
+     * Video Name
+     */
+    name: string;
+    /**
+     * Watch status
+     */
+    watched: boolean;
+};

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

@@ -0,0 +1,4 @@
+import type { PerLearnerLastAccessData } from './PerLearnerLastAccessData';
+export type PerLearnerLastAccess = {
+    data?: PerLearnerLastAccessData;
+};

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

@@ -0,0 +1,11 @@
+import type { PerLearnerCourseLastAccessData } from './PerLearnerCourseLastAccessData';
+export type PerLearnerLastAccessData = {
+    /**
+     * Course last accessed metadata
+     */
+    course_last_accessed?: PerLearnerCourseLastAccessData;
+    /**
+     * Last accessed time
+     */
+    last_accessed?: string;
+};

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

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

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

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

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

@@ -0,0 +1,22 @@
+export type PerformanceGradesPerCourseData = {
+    /**
+     * Course name
+     */
+    name: string;
+    /**
+     * Course id
+     */
+    course_id: string;
+    /**
+     * Course enrollments
+     */
+    num_enrollments: number;
+    /**
+     * Total users who have passed the course
+     */
+    num_passed: number;
+    /**
+     * Course Average grade
+     */
+    avg_grade: number;
+};

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

@@ -0,0 +1,4 @@
+import type { PerlearnerCourseProgressData } from './PerlearnerCourseProgressData';
+export type PerlearnerCourseProgress = {
+    data: PerlearnerCourseProgressData;
+};

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

@@ -0,0 +1,6 @@
+export type PerlearnerCourseProgressData = {
+    /**
+     * Perlearner Course progress
+     */
+    progress: number;
+};

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

@@ -0,0 +1,30 @@
+export type PerlearnerEngagementVideosData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Total course videos
+     */
+    total_videos: number;
+    /**
+     * Total videos watched by student
+     */
+    watched: number;
+    /**
+     * Total time user watched video
+     */
+    total_time_watch: number;
+    /**
+     * Average videos watched by students in course
+     */
+    average_class_watch: number;
+    /**
+     * Average time spent by students on this course
+     */
+    class_time_average: number;
+};

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

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

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

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

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

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

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

@@ -0,0 +1,4 @@
+import type { PerlearnerGradeWithCutOffData } from './PerlearnerGradeWithCutOffData';
+export type PerlearnerGradeWithCutOff = {
+    data?: PerlearnerGradeWithCutOffData;
+};

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

@@ -0,0 +1,10 @@
+export type PerlearnerGradeWithCutOffData = {
+    /**
+     * Dictionary showing grade cutoffs
+     */
+    grade_cutoffs: Record<string, any>;
+    /**
+     * Grade
+     */
+    grade: number;
+};

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

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

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

@@ -0,0 +1,34 @@
+export type PerlearnerGradingPerCourseAPIData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Total problems in course
+     */
+    graded_activities: string;
+    /**
+     * Cumulative problem submissions
+     */
+    submissions: number;
+    /**
+     * Number of problems from total problems attempted
+     */
+    problems_attempted: number;
+    /**
+     * Number of problems answered correctly
+     */
+    assignments_correct: number;
+    /**
+     * Average grade obtained by all learner in the course
+     */
+    class_average: number;
+    /**
+     * Learner course grade
+     */
+    grade: number;
+};

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

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

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

@@ -0,0 +1,34 @@
+export type PerlearnerUserListData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner Name
+     */
+    full_name: string;
+    /**
+     * Total enrollments
+     */
+    enrollments: number;
+    /**
+     * Total completions
+     */
+    completions: number;
+    /**
+     * Last active time
+     */
+    last_active: string;
+    /**
+     * Time spent formatted in seconds
+     */
+    time_spent: string;
+    /**
+     * Engagement index
+     */
+    engagement_index: number;
+    /**
+     * Performance index
+     */
+    performance_index: number;
+};

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

@@ -0,0 +1,29 @@
+/**
+ * Note: Create and update operations deprecated.
+ */
+export type Platform = {
+    /**
+     * The platform key
+     */
+    key: string;
+    /**
+     * The name of the platform
+     */
+    name?: string | null;
+    /**
+     * The associated edX org code
+     */
+    org?: string | null;
+    /**
+     * The LMS URL for the platform
+     */
+    lms_url?: string | null;
+    /**
+     * The CMS URL for the platform
+     */
+    cms_url?: string | null;
+    /**
+     * The portal URL for the platform
+     */
+    portal_url?: string | null;
+};

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

@@ -0,0 +1,30 @@
+/**
+ * Serializer for PlatformApiKey's
+ */
+export type PlatformApiKey = {
+    /**
+     * Username that created token
+     */
+    readonly username: string;
+    /**
+     * Name of the token. Used by the user to identify the token.
+     */
+    name: string;
+    readonly key: string;
+    /**
+     * The platform key
+     */
+    platform_key: string;
+    /**
+     * When token expires
+     */
+    readonly expires: string;
+    /**
+     * Optional duration until key expires. Format: [DD] [HH:[MM:]]ss[.uuuuuu]
+     */
+    expires_in?: string | null;
+    /**
+     * When token was created
+     */
+    readonly created: string;
+};

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

@@ -0,0 +1,41 @@
+/**
+ * Request serializer for PlatformInvitationView POST endpoint
+ */
+export type PlatformInvitationCreate = {
+    /**
+     * The platform to create an invitation for
+     */
+    platform_key: string;
+    /**
+     * The email address to invite
+     */
+    email?: string;
+    /**
+     * The username to invite
+     */
+    username?: string;
+    /**
+     * Whether the invitation is active
+     */
+    active?: boolean;
+    /**
+     * The source of the invitation
+     */
+    source?: string;
+    /**
+     * URL to redirect to after accepting the invitation
+     */
+    redirect_to?: string;
+    /**
+     * When the invitation was created
+     */
+    created?: string;
+    /**
+     * When the invitation expires
+     */
+    expired?: string;
+    /**
+     * Additional metadata for the invitation
+     */
+    metadata?: Record<string, any>;
+};

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

@@ -0,0 +1,53 @@
+/**
+ * Response serializer for platform invitation details
+ */
+export type PlatformInvitationDetail = {
+    /**
+     * The unique identifier for the invitation
+     */
+    id: number;
+    /**
+     * The ID of the user associated with the invitation
+     */
+    user_id: number | null;
+    /**
+     * The username of the user associated with the invitation
+     */
+    username: string | null;
+    /**
+     * The email address associated with the invitation
+     */
+    email: string | null;
+    /**
+     * When the invitation was created
+     */
+    created: string;
+    /**
+     * When the invitation was started
+     */
+    started: string | null;
+    /**
+     * When the invitation expires
+     */
+    expired: string | null;
+    /**
+     * The source of the invitation
+     */
+    source: string | null;
+    /**
+     * URL to redirect to after accepting the invitation
+     */
+    redirect_to: string | null;
+    /**
+     * Whether the invitation is active
+     */
+    active: boolean;
+    /**
+     * Additional metadata for the invitation
+     */
+    metadata: Record<string, any>;
+    /**
+     * The platform key associated with the invitation
+     */
+    platform_key: string;
+};

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

@@ -0,0 +1,25 @@
+/**
+ * Request serializer for PlatformInvitationRedemptionView POST endpoint
+ */
+export type PlatformInvitationRedemption = {
+    /**
+     * The platform key for the invitation
+     */
+    platform_key: string;
+    /**
+     * The source identifier for the invitation
+     */
+    source: string;
+    /**
+     * The email to associate with the invitation
+     */
+    email?: string;
+    /**
+     * The username to associate with the invitation
+     */
+    username?: string;
+    /**
+     * Additional metadata for the invitation
+     */
+    metadata?: Record<string, any>;
+};

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

@@ -0,0 +1,53 @@
+/**
+ * Request serializer for PlatformLicenseCreateView POST endpoint
+ */
+export type PlatformLicenseCreate = {
+    /**
+     * The platform to create a license for
+     */
+    platform_key: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * Display name for the license
+     */
+    name?: string;
+    /**
+     * Number of seats purchased
+     */
+    count?: number;
+    /**
+     * Date when license should begin
+     */
+    started?: string;
+    /**
+     * Date when license should expire
+     */
+    expired?: string | null;
+    /**
+     * Whether the license is active
+     */
+    active?: boolean;
+    /**
+     * Additional license metadata
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Source identifier
+     */
+    source?: string;
+    /**
+     * External identifier (must be unique)
+     */
+    external_id?: string | null;
+    /**
+     * Transaction identifier for tracking
+     */
+    transaction_id?: string;
+    /**
+     * Type of change being made
+     */
+    change_type?: string;
+};