@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,49 @@
+/**
+ * Response serializer for course license assignment details
+ */
+export type CourseLicenseAssignmentDetail = {
+    /**
+     * The unique identifier for the assignment
+     */
+    id: number;
+    /**
+     * The ID of the user assigned the license
+     */
+    user_id: number;
+    /**
+     * The username of the user assigned the license
+     */
+    username: string;
+    /**
+     * The email address of the user assigned the license
+     */
+    email: string | null;
+    /**
+     * Whether the assignment is active
+     */
+    active: boolean;
+    /**
+     * Whether the assignment has been fulfilled
+     */
+    fulfilled: boolean;
+    /**
+     * URL to redirect to after fulfillment
+     */
+    redirect_to: string | null;
+    /**
+     * Additional metadata for the assignment
+     */
+    metadata: Record<string, any>;
+    /**
+     * The ID of the course license
+     */
+    license_id: number;
+    /**
+     * The name of the course license
+     */
+    license_name: string;
+    /**
+     * The course ID associated with the license
+     */
+    course_id: string;
+};

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

@@ -0,0 +1,61 @@
+/**
+ * Request serializer for CourseLicenseCreateView POST endpoint
+ */
+export type CourseLicenseCreate = {
+    /**
+     * The platform to create a license for
+     */
+    platform_key: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * The course ID to create a license for
+     */
+    course_id: 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>;
+    /**
+     * Additional enrollment configuration
+     */
+    enrollment_config?: 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;
+};

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

@@ -0,0 +1,53 @@
+/**
+ * Response serializer for course license details
+ */
+export type CourseLicenseDetail = {
+    /**
+     * The unique identifier for the license
+     */
+    id: number;
+    /**
+     * When the license was created
+     */
+    created: string;
+    /**
+     * When the license becomes active
+     */
+    started: string;
+    /**
+     * When the license expires
+     */
+    expired: string | null;
+    /**
+     * The display name of the license
+     */
+    name: string;
+    /**
+     * The number of seats purchased
+     */
+    count: number;
+    /**
+     * Whether the license is active
+     */
+    active: boolean;
+    /**
+     * Additional license metadata
+     */
+    metadata: Record<string, any>;
+    /**
+     * The source identifier for the license
+     */
+    source: string;
+    /**
+     * External identifier for the license
+     */
+    external_id: string | null;
+    /**
+     * The platform key associated with the license
+     */
+    platform_key: string;
+    /**
+     * The course ID associated with the license
+     */
+    course_id: string;
+};

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

@@ -0,0 +1,33 @@
+/**
+ * Request serializer for CourseLicenseGroupAssignmentView POST endpoint
+ */
+export type CourseLicenseGroupAssignmentCreate = {
+    /**
+     * The ID of the course license
+     */
+    license_id: number;
+    /**
+     * The group ID to assign the license to
+     */
+    group_id: number;
+    /**
+     * 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>;
+};

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

@@ -0,0 +1,45 @@
+/**
+ * Response serializer for course license group assignment details
+ */
+export type CourseLicenseGroupAssignmentDetail = {
+    /**
+     * The unique identifier for the assignment
+     */
+    id: number;
+    /**
+     * The ID of the group assigned the license
+     */
+    group_id: number;
+    /**
+     * The name of the group assigned the license
+     */
+    group_name: string;
+    /**
+     * Whether the assignment is active
+     */
+    active: boolean;
+    /**
+     * Whether the assignment has been fulfilled
+     */
+    fulfilled: boolean;
+    /**
+     * URL to redirect to after fulfillment
+     */
+    redirect_to: string | null;
+    /**
+     * Additional metadata for the assignment
+     */
+    metadata: Record<string, any>;
+    /**
+     * The ID of the course license
+     */
+    license_id: number;
+    /**
+     * The name of the course license
+     */
+    license_name: string;
+    /**
+     * The course ID associated with the license
+     */
+    course_id: string;
+};

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

@@ -0,0 +1,61 @@
+/**
+ * Request serializer for CourseLicenseUpdateView POST endpoint
+ */
+export type CourseLicenseUpdate = {
+    /**
+     * The ID of the license to update (required if external_id not provided)
+     */
+    license_id?: number;
+    /**
+     * External identifier of the license to update (required if license_id not provided)
+     */
+    external_id?: string;
+    /**
+     * The platform key (not updatable)
+     */
+    platform_key?: string;
+    /**
+     * The platform organization (not updatable)
+     */
+    platform_org?: string;
+    /**
+     * The course ID (not updatable)
+     */
+    course_id?: string;
+    /**
+     * Updated display name for the license
+     */
+    name?: string;
+    /**
+     * Updated number of seats purchased
+     */
+    count?: number;
+    /**
+     * Updated date when license should begin
+     */
+    started?: string;
+    /**
+     * Updated date when license should expire
+     */
+    expired?: string | null;
+    /**
+     * Updated active status
+     */
+    active?: boolean;
+    /**
+     * Updated additional license metadata
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Updated source identifier
+     */
+    source?: string;
+    /**
+     * Transaction identifier for tracking
+     */
+    transaction_id?: string;
+    /**
+     * Type of change being made
+     */
+    change_type?: 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/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/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/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/CourseSkillPointInfoRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Request serializer for CourseSkillPointInfoView POST endpoint.
+ * Validates request body for updating course skill point information.
+ */
+export type CourseSkillPointInfoRequest = {
+    /**
+     * ID of the course to update skill point information for
+     */
+    course_id: string;
+    /**
+     * Dictionary mapping skill names to point values. Example: {'skill_name': 5}
+     */
+    point_data: Record<string, number>;
+    /**
+     * If True, removes all skills not in point_data. If False, only updates specified skills.
+     */
+    overwrite?: boolean;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * Response serializer for CourseSkillPointInfoView GET endpoint.
+ * Returns a mapping of skill names/objects to their point values.
+ */
+export type CourseSkillPointInfoResponse = {
+    /**
+     * Dictionary mapping skill names/objects to point values. Keys are skill names (or skill objects if get_obj=True)
+     */
+    skill_points: Record<string, number>;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Request serializer for CourseSuggestionBulkManagementView POST endpoint
+ */
+export type CourseSuggestionBulkCreate = {
+    /**
+     * The platform for the suggestions
+     */
+    platform_key: string;
+    /**
+     * List of suggestion data objects, each containing course_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/CourseSuggestionCreate.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Request serializer for CourseSuggestionManagementView POST endpoint
+ */
+export type CourseSuggestionCreate = {
+    /**
+     * The platform for the suggestion
+     */
+    platform_key: string;
+    /**
+     * The course ID to suggest
+     */
+    course_id: string;
+    /**
+     * The user to suggest the course to
+     */
+    user_id: string;
+    /**
+     * The username of the user to suggest the course to
+     */
+    username?: string;
+    /**
+     * The email of the user to suggest the course 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 course
+     */
+    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/CourseSuggestionDetail.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Response serializer for course suggestion details
+ */
+export type CourseSuggestionDetail = {
+    /**
+     * 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 course ID being suggested
+     */
+    course_id: string;
+    /**
+     * The name of the course being suggested
+     */
+    course_name: string;
+};

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

@@ -0,0 +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

@@ -0,0 +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/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>;
+};