@iblai/iblai-api 0.0.1-core

package/src/models/Course.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/CourseAccessRequestCreate.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request serializer for CourseLicenseAccessRequestUserView POST endpoint
+ */
+export type CourseAccessRequestCreate = {
+    /**
+     * The unique identifier for the platform
+     */
+    platform_key?: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * The unique identifier for the course
+     */
+    course_id: string;
+};
+

package/src/models/CourseAccessRequestDetail.ts

@@ -0,0 +1,54 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Response serializer for access request details
+ */
+export type CourseAccessRequestDetail = {
+    /**
+     * The unique identifier for the access request
+     */
+    id: number;
+    /**
+     * The ID of the user who made the request
+     */
+    user_id: number;
+    /**
+     * The username of the user who made the request
+     */
+    username: string;
+    /**
+     * The full name of the user who made the request
+     */
+    name: string;
+    /**
+     * Whether the request has been approved (null if not reviewed)
+     */
+    approved: boolean | null;
+    /**
+     * Whether the request has been reviewed
+     */
+    reviewed: boolean;
+    /**
+     * When the request was created
+     */
+    created: string;
+    /**
+     * When the request was last modified
+     */
+    modified: string;
+    /**
+     * Additional metadata for the request
+     */
+    metadata?: Record<string, any>;
+    /**
+     * The platform key associated with the request
+     */
+    platform_key: string;
+    /**
+     * The course ID associated with the request
+     */
+    course_id: string;
+};
+

package/src/models/CourseAccessRequestStatusResponse.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/CourseAccessRequestUpdate.ts

@@ -0,0 +1,30 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/CourseCompletion.ts

@@ -0,0 +1,71 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/CourseCompletionCatalogResponse.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/CourseCompletionPerCourse.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CourseCompletionPerCourseData } from './CourseCompletionPerCourseData';
+import type { Pagination } from './Pagination';
+export type CourseCompletionPerCourse = {
+    data?: Array<CourseCompletionPerCourseData>;
+    pagination: Pagination;
+};
+

package/src/models/CourseCompletionPerCourseData.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/CourseCompletionSummaryDataOvertime.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/CourseCompletionSummaryOvertime.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CourseCompletionSummaryDataOvertime } from './CourseCompletionSummaryDataOvertime';
+import type { OvertimeMeta } from './OvertimeMeta';
+export type CourseCompletionSummaryOvertime = {
+    data: CourseCompletionSummaryDataOvertime;
+    meta: OvertimeMeta;
+};
+

package/src/models/CourseCreateUpdate.ts

@@ -0,0 +1,30 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/CourseDeleteResponse.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for course deletion response.
+ */
+export type CourseDeleteResponse = {
+    /**
+     * Number of courses deleted
+     */
+    count: number;
+    /**
+     * Types of objects deleted
+     */
+    type: Record<string, any>;
+};
+

package/src/models/CourseEligibilityCheckResponse.ts

@@ -0,0 +1,30 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/CourseEnrollmentSearchResponse.ts

@@ -0,0 +1,58 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/CourseGradeDetailBlock.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/CourseGradeDetailSubSection.ts

@@ -0,0 +1,28 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/CourseGradeSummary.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CourseGradeSummaryData } from './CourseGradeSummaryData';
+export type CourseGradeSummary = {
+    data?: Array<CourseGradeSummaryData>;
+};
+

package/src/models/CourseGradeSummaryData.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/CourseGradingDetail.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CourseGradingDetailData } from './CourseGradingDetailData';
+export type CourseGradingDetail = {
+    data?: Array<CourseGradingDetailData>;
+};
+

package/src/models/CourseGradingDetailData.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CourseGradeDetailSubSection } from './CourseGradeDetailSubSection';
+export type CourseGradingDetailData = {
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    subsections?: Array<CourseGradeDetailSubSection>;
+};
+

package/src/models/CourseGroupSuggestionCreate.ts

@@ -0,0 +1,46 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/CourseGroupSuggestionDetail.ts

@@ -0,0 +1,58 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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;
+};
+