@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,17 @@
+/**
+ * Response serializer for CourseLicenseAccessRequestUserView GET endpoint
+ */
+export type CourseAccessRequestStatusResponse = {
+    /**
+     * Whether the access request is active
+     */
+    active: boolean;
+    /**
+     * Whether the access request has been approved (null if not reviewed)
+     */
+    approved: boolean | null;
+    /**
+     * Whether an access request exists for this user and course
+     */
+    exists: boolean;
+};

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

@@ -0,0 +1,25 @@
+/**
+ * Request serializer for CourseLicenseAccessRequestManagementView POST endpoint
+ */
+export type CourseAccessRequestUpdate = {
+    /**
+     * The ID of the access request to update
+     */
+    request_id: number;
+    /**
+     * The unique identifier for the platform
+     */
+    platform_key?: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * Whether to approve the request
+     */
+    approved?: boolean;
+    /**
+     * Whether the request should remain active
+     */
+    active?: boolean;
+};

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

@@ -0,0 +1,66 @@
+/**
+ * Serializer for course completion data used in both request and response.
+ * Inherits common completion fields from CompletableBaseSerializer.
+ */
+export type CourseCompletion = {
+    /**
+     * Completion percentage
+     */
+    completion_percentage?: number | null;
+    /**
+     * Whether completable is completed
+     */
+    completed?: boolean | null;
+    /**
+     * Last update timestamp
+     */
+    readonly last_updated: string;
+    /**
+     * Completion timestamp
+     */
+    completion_date?: string | null;
+    /**
+     * Completion metadata
+     */
+    completion_data?: any;
+    /**
+     * Whether skill points have been evaluated
+     */
+    skill_points_computed?: boolean | null;
+    /**
+     * Unique identifier for the completion record
+     */
+    readonly id: number;
+    /**
+     * The user identifier
+     */
+    user_id: number;
+    /**
+     * The username associated with the completion
+     */
+    readonly username: string;
+    /**
+     * The course identifier (e.g., 'course-v1:org+code+run')
+     */
+    course_id: string;
+    /**
+     * The organization identifier for the course
+     */
+    readonly org: string;
+    /**
+     * Whether the user passed the course
+     */
+    passed?: boolean;
+    /**
+     * The user's grade in the course
+     */
+    grading_percentage?: number | null;
+    /**
+     * The date the course was passed (ISO format)
+     */
+    passed_date?: string | null;
+    /**
+     * Additional grading metadata
+     */
+    grade_data?: any;
+};

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

@@ -0,0 +1,11 @@
+import type { CourseCompletion } from './CourseCompletion';
+/**
+ * Response serializer for CourseCompletionCatalogView GET endpoint.
+ * Maps course IDs to their completion information.
+ */
+export type CourseCompletionCatalogResponse = {
+    /**
+     * Completion information for each course. Keys are course IDs.
+     */
+    '{course_id}'?: CourseCompletion;
+};

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

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

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

@@ -0,0 +1,22 @@
+export type CourseCompletionPerCourseData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Number of enrollments
+     */
+    enrollments: number;
+    /**
+     * Number of completions
+     */
+    completions: number;
+    /**
+     * Average Completions.
+     */
+    average: number;
+};

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

@@ -0,0 +1,18 @@
+export type CourseCompletionSummaryDataOvertime = {
+    /**
+     * Dates are keys and values are the value for the date in the key. e,g `{"2020-01-01": 30. ...}`
+     */
+    overtime?: Record<string, any>;
+    /**
+     * Total unique active users in this period
+     */
+    total_user_count: number;
+    /**
+     * Total course completions
+     */
+    completed_count: number;
+    /**
+     * Completion percent for the time range
+     */
+    completed_percent: number;
+};

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

@@ -0,0 +1,6 @@
+import type { CourseCompletionSummaryDataOvertime } from './CourseCompletionSummaryDataOvertime';
+import type { OvertimeMeta } from './OvertimeMeta';
+export type CourseCompletionSummaryOvertime = {
+    data: CourseCompletionSummaryDataOvertime;
+    meta: OvertimeMeta;
+};

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

@@ -0,0 +1,41 @@
+/**
+ * Request serializer for CourseGroupSuggestionManagementView POST endpoint
+ */
+export type CourseGroupSuggestionCreate = {
+    /**
+     * The platform for the group suggestion
+     */
+    platform_key: string;
+    /**
+     * The course ID to suggest
+     */
+    course_id: string;
+    /**
+     * The group to suggest the course to
+     */
+    group_id: number;
+    /**
+     * 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 group
+     */
+    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/CourseGroupSuggestionDetail.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Response serializer for course group suggestion details
+ */
+export type CourseGroupSuggestionDetail = {
+    /**
+     * The unique identifier for the group suggestion
+     */
+    id: number;
+    /**
+     * The ID of the group receiving the suggestion
+     */
+    group_id: number;
+    /**
+     * The name of the group receiving the suggestion
+     */
+    group_name: string;
+    /**
+     * The platform key associated with the suggestion
+     */
+    platform_key: string;
+    /**
+     * Whether the suggestion has been accepted
+     */
+    accepted: boolean;
+    /**
+     * Whether the suggestion is visible
+     */
+    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 course ID being suggested
+     */
+    course_id: string;
+    /**
+     * The name of the course being suggested
+     */
+    course_name: string;
+    /**
+     * Number of users in the group
+     */
+    user_count: number;
+};

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

@@ -0,0 +1,41 @@
+/**
+ * Request serializer for CourseInvitationView POST endpoint
+ */
+export type CourseInvitationCreate = {
+    /**
+     * The course to create an invitation for
+     */
+    course_id: 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/CourseInvitationDetail.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Response serializer for course invitation details
+ */
+export type CourseInvitationDetail = {
+    /**
+     * 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 course ID associated with the invitation
+     */
+    course_id: string;
+};

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

@@ -0,0 +1,25 @@
+/**
+ * Request serializer for CourseInvitationRedemptionView POST endpoint
+ */
+export type CourseInvitationRedemption = {
+    /**
+     * The course ID for the invitation
+     */
+    course_id: 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/CourseLicenseAssignmentCreate.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Request serializer for CourseLicenseAssignmentView POST endpoint
+ */
+export type CourseLicenseAssignmentCreate = {
+    /**
+     * The ID of the course license
+     */
+    license_id: number;
+    /**
+     * The user ID to assign the license to
+     */
+    user_id?: number;
+    /**
+     * The email to assign the license to
+     */
+    email?: string;
+    /**
+     * The unique identifier for the platform
+     */
+    platform_key?: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * Whether the assignment is active
+     */
+    active?: boolean;
+    /**
+     * Whether the assignment has been fulfilled
+     */
+    fulfilled?: boolean;
+    /**
+     * Additional metadata for the assignment
+     */
+    metadata?: Record<string, any>;
+};