@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,49 @@
+/**
+ * Response serializer for platform license details
+ */
+export type PlatformLicenseDetail = {
+    /**
+     * 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;
+};

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

@@ -0,0 +1,57 @@
+/**
+ * Request serializer for PlatformLicenseUpdateView POST endpoint
+ */
+export type PlatformLicenseUpdate = {
+    /**
+     * 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;
+    /**
+     * 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/PlatformList.d.ts

@@ -0,0 +1,29 @@
+import type { PlatformListStatusEnum } from './PlatformListStatusEnum';
+export type PlatformList = {
+    /**
+     * 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;
+    status?: PlatformListStatusEnum;
+    active?: boolean;
+};

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

@@ -0,0 +1,22 @@
+/**
+ * * `-2` - FAILED
+ * * `-1` - TERMINATED
+ * * `0` - PENDING
+ * * `1` - BUILDING
+ * * `2` - RUNNING
+ * * `3` - PAUSED
+ * * `4` - STOPPING
+ * * `5` - STOPPED
+ * * `6` - REPAIR
+ */
+export declare enum PlatformListStatusEnum {
+    '_-2' = -2,
+    '_-1' = -1,
+    '_0' = 0,
+    '_1' = 1,
+    '_2' = 2,
+    '_3' = 3,
+    '_4' = 4,
+    '_5' = 5,
+    '_6' = 6
+}

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

@@ -0,0 +1,8 @@
+export type PlatformPublicMetadata = {
+    readonly platform_key: string;
+    readonly platform_name: string;
+    /**
+     * The public metadata
+     */
+    metadata?: any;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Request serializer for PlatformSkillPointBulkManagementView POST endpoint.
+ */
+export type PlatformSkillPointBulkRequest = {
+    /**
+     * Platform key identifier (required for platform admin access)
+     */
+    platform_key?: string;
+    /**
+     * List of skill point data objects to create/update
+     */
+    skill_point_data: Array<Record<string, any>>;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Response serializer for PlatformSkillPointBulkManagementView POST endpoint.
+ */
+export type PlatformSkillPointBulkResponse = {
+    /**
+     * Number of successful updates
+     */
+    successes: number;
+    /**
+     * Total number of updates attempted
+     */
+    total: number;
+};

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

@@ -0,0 +1,21 @@
+/**
+ * Request serializer for PlatformSkillPointGroupManagementView POST endpoint.
+ */
+export type PlatformSkillPointGroupRequest = {
+    /**
+     * Platform key identifier
+     */
+    platform_key: string;
+    /**
+     * ID of the user group to update
+     */
+    group_id: number;
+    /**
+     * Dictionary mapping skill names to point values to apply to group
+     */
+    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/PlatformSkillPointRequest.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Request serializer for PlatformSkillPointManagementView POST endpoint.
+ */
+export type PlatformSkillPointRequest = {
+    /**
+     * Username to update skill points for
+     */
+    username: string;
+    /**
+     * Platform key identifier
+     */
+    platform_key: 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/PlatformSkillPointResponse.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Response serializer for PlatformSkillPointManagementView GET endpoint.
+ */
+export type PlatformSkillPointResponse = {
+    /**
+     * List of platform skill point entries
+     */
+    results: Array<Record<string, any>>;
+    /**
+     * Total number of results
+     */
+    count: number;
+    /**
+     * URL for next page of results
+     */
+    next: string | null;
+    /**
+     * URL for previous page of results
+     */
+    previous: string | null;
+};

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

@@ -0,0 +1,9 @@
+export type PlatformUpdatePostRequest = {
+    user_id: number;
+    key: string;
+    new_key?: string;
+    name?: string;
+    lms_url?: string;
+    cms_url?: string;
+    portal_url?: string;
+};

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

@@ -0,0 +1,8 @@
+export type PointsPercentile = {
+    username: string;
+    points: number;
+    /**
+     * Percentile of points for user. If an `org` was provided, this is the percentile of the user relative to users within the org.
+     */
+    percentile: number;
+};

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

@@ -0,0 +1,11 @@
+import type { Recipient } from './Recipient';
+/**
+ * Response serializer for notification preview
+ */
+export type PreviewResponse = {
+    status: string;
+    build_id: string;
+    count: number;
+    warning: string | null;
+    recipients: Array<Recipient>;
+};

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

@@ -0,0 +1,22 @@
+export type Product = {
+    /**
+     * Product Name
+     */
+    name: string;
+    /**
+     * Product type (Course or Program)
+     */
+    type: string;
+    /**
+     * Product slug
+     */
+    slug: string;
+    /**
+     * DateTime product was created
+     */
+    created_on: string;
+    /**
+     * Product cost
+     */
+    price: string;
+};

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

@@ -0,0 +1,26 @@
+export type ProductTable = {
+    /**
+     * Product name
+     */
+    name: string;
+    /**
+     * Product Type (Course or Program)
+     */
+    type: string;
+    /**
+     * Gross sales for product
+     */
+    total_sales: number;
+    /**
+     * Total of all coupons for product
+     */
+    coupons: number;
+    /**
+     * Net sales for product
+     */
+    net_sales: number;
+    /**
+     * Quantity of product purchased
+     */
+    orders: number;
+};

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

@@ -0,0 +1,24 @@
+import type { Institution } from './Institution';
+import type { ProgramTypeEnum } from './ProgramTypeEnum';
+export type Program = {
+    readonly id: number;
+    readonly institution: Institution;
+    institution_id: number;
+    name: string;
+    program_type: ProgramTypeEnum;
+    /**
+     * Duration in months
+     */
+    duration: number;
+    description?: string | null;
+    /**
+     * Metadata
+     */
+    data?: any;
+    /**
+     * Metadata
+     */
+    metadata?: any;
+    created_at?: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Response serializer for ProgramCompletionQueryView GET endpoint.
+ */
+export type ProgramCompletionResponse = {
+    /**
+     * Total number of courses in the program
+     */
+    count: number;
+    /**
+     * Overall completion percentage for the program (0.0 to 1.0)
+     */
+    completion_percentage: number;
+};

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

@@ -0,0 +1,6 @@
+export type ProgramCoursePosition = {
+    course_id?: string;
+    name?: string;
+    slug?: string;
+    readonly position: number;
+};

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

@@ -0,0 +1,45 @@
+/**
+ * Serializer for program creation/update request body.
+ */
+export type ProgramCreateUpdateRequest = {
+    /**
+     * Program ID
+     */
+    program_id: string;
+    /**
+     * Program key
+     */
+    program_key?: string;
+    /**
+     * Program name
+     */
+    name: string;
+    /**
+     * Program slug
+     */
+    slug?: string;
+    /**
+     * Organization
+     */
+    org?: string;
+    /**
+     * Platform key
+     */
+    platform_key?: string;
+    /**
+     * Whether the program is enabled
+     */
+    enabled?: boolean;
+    /**
+     * List of courses in the program with course_id and optional position
+     */
+    course_list: Array<Record<string, any>>;
+    /**
+     * Program type
+     */
+    program_type?: string;
+    /**
+     * Additional program data
+     */
+    data?: any;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Serializer for program deletion response.
+ */
+export type ProgramDeleteResponse = {
+    /**
+     * Number of programs deleted
+     */
+    count: number;
+    /**
+     * Types of objects deleted
+     */
+    type: Record<string, any>;
+};

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

@@ -0,0 +1,30 @@
+export type ProgramEnrollment = {
+    user_id?: number;
+    username?: string;
+    program_id?: string;
+    program_key?: string;
+    platform_key?: string;
+    org?: string;
+    name?: string;
+    slug?: string;
+    /**
+     * Date when enrollment began/activated
+     */
+    created?: string | null;
+    /**
+     * Date when enrollment started
+     */
+    started?: string | null;
+    /**
+     * Date when enrollment ended/deactivated
+     */
+    readonly ended: string | null;
+    /**
+     * Date when enrollment expires (null, if not expiring)
+     */
+    expired?: string | null;
+    /**
+     * Whether the enrollment is active
+     */
+    active?: boolean;
+};

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

@@ -0,0 +1,34 @@
+/**
+ * Includes metadata+
+ */
+export type ProgramEnrollmentPlus = {
+    user_id?: number;
+    username?: string;
+    program_id?: string;
+    program_key?: string;
+    platform_key?: string;
+    org?: string;
+    name?: string;
+    slug?: string;
+    /**
+     * Date when enrollment began/activated
+     */
+    created?: string | null;
+    /**
+     * Date when enrollment started
+     */
+    started?: string | null;
+    /**
+     * Date when enrollment ended/deactivated
+     */
+    readonly ended: string | null;
+    /**
+     * Date when enrollment expires (null, if not expiring)
+     */
+    expired?: string | null;
+    /**
+     * Whether the enrollment is active
+     */
+    active?: boolean;
+    metadata?: any;
+};

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

@@ -0,0 +1,37 @@
+/**
+ * Request serializer for ProgramGroupSuggestionManagementView POST endpoint
+ */
+export type ProgramGroupSuggestionCreate = {
+    /**
+     * The platform for the group suggestion
+     */
+    platform_key: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * The program key to suggest
+     */
+    program_key: string;
+    /**
+     * The group to suggest the program 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>;
+    /**
+     * Flag to ensure department admins can call the API
+     */
+    department_mode?: boolean;
+};

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

@@ -0,0 +1,53 @@
+/**
+ * Response serializer for program group suggestion details
+ */
+export type ProgramGroupSuggestionDetail = {
+    /**
+     * 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 program key being suggested
+     */
+    program_key: string;
+    /**
+     * The name of the program being suggested
+     */
+    program_name: string;
+    /**
+     * Number of users in the group
+     */
+    user_count: number;
+};

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

@@ -0,0 +1,41 @@
+/**
+ * Request serializer for ProgramInvitationView POST endpoint
+ */
+export type ProgramInvitationCreate = {
+    /**
+     * The program to create an invitation for
+     */
+    program_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>;
+};