@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,31 @@
+import type { ProgramLicenseDetail } from './ProgramLicenseDetail';
+/**
+ * Response serializer for paginated program license list.
+ *
+ * This serializer represents a paginated list of program licenses,
+ * with navigation links and metadata.
+ *
+ * Fields:
+ * count: Total number of results matching the query
+ * next: URL for the next page of results (null if no next page)
+ * previous: URL for the previous page of results (null if no previous page)
+ * results: List of program licenses
+ */
+export type PaginatedProgramLicense = {
+    /**
+     * Total number of results
+     */
+    count: number;
+    /**
+     * URL for next page of results
+     */
+    next: string | null;
+    /**
+     * URL for previous page of results
+     */
+    previous: string | null;
+    /**
+     * List of program licenses
+     */
+    results: Array<ProgramLicenseDetail>;
+};

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

@@ -0,0 +1,31 @@
+import type { ProgramLicenseAssignmentDetail } from './ProgramLicenseAssignmentDetail';
+/**
+ * Response serializer for paginated program license assignment list.
+ *
+ * This serializer represents a paginated list of program license assignments,
+ * with navigation links and metadata.
+ *
+ * Fields:
+ * count: Total number of results matching the query
+ * next: URL for the next page of results (null if no next page)
+ * previous: URL for the previous page of results (null if no previous page)
+ * results: List of program license assignments
+ */
+export type PaginatedProgramLicenseAssignment = {
+    /**
+     * Total number of results
+     */
+    count: number;
+    /**
+     * URL for next page of results
+     */
+    next: string | null;
+    /**
+     * URL for previous page of results
+     */
+    previous: string | null;
+    /**
+     * List of program license assignments
+     */
+    results: Array<ProgramLicenseAssignmentDetail>;
+};

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

@@ -0,0 +1,31 @@
+import type { ProgramLicenseGroupAssignmentDetail } from './ProgramLicenseGroupAssignmentDetail';
+/**
+ * Response serializer for paginated program license group assignment list.
+ *
+ * This serializer represents a paginated list of program license group assignments,
+ * with navigation links and metadata.
+ *
+ * Fields:
+ * count: Total number of results matching the query
+ * next: URL for the next page of results (null if no next page)
+ * previous: URL for the previous page of results (null if no previous page)
+ * results: List of program license group assignments
+ */
+export type PaginatedProgramLicenseGroupAssignment = {
+    /**
+     * Total number of results
+     */
+    count: number;
+    /**
+     * URL for next page of results
+     */
+    next: string | null;
+    /**
+     * URL for previous page of results
+     */
+    previous: string | null;
+    /**
+     * List of program license group assignments
+     */
+    results: Array<ProgramLicenseGroupAssignmentDetail>;
+};

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

@@ -0,0 +1,22 @@
+import type { ProgramSuggestionDetail } from './ProgramSuggestionDetail';
+/**
+ * Response serializer for paginated program suggestion list
+ */
+export type PaginatedProgramSuggestion = {
+    /**
+     * Total number of results
+     */
+    count: number;
+    /**
+     * URL for next page of results
+     */
+    next: string | null;
+    /**
+     * URL for previous page of results
+     */
+    previous: string | null;
+    /**
+     * List of program suggestions
+     */
+    results: Array<ProgramSuggestionDetail>;
+};

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

@@ -0,0 +1,7 @@
+import type { UserApp } from './UserApp';
+export type PaginatedUserAppList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<UserApp>;
+};

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

@@ -0,0 +1,22 @@
+import type { UserLicenseDetail } from './UserLicenseDetail';
+/**
+ * Response serializer for paginated user license list
+ */
+export type PaginatedUserLicense = {
+    /**
+     * Total number of results
+     */
+    count: number;
+    /**
+     * URL for next page of results
+     */
+    next: string | null;
+    /**
+     * URL for previous page of results
+     */
+    previous: string | null;
+    /**
+     * List of user licenses
+     */
+    results: Array<UserLicenseDetail>;
+};

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

@@ -0,0 +1,22 @@
+import type { UserLicenseAssignmentDetail } from './UserLicenseAssignmentDetail';
+/**
+ * Response serializer for paginated user license assignment list
+ */
+export type PaginatedUserLicenseAssignment = {
+    /**
+     * Total number of results
+     */
+    count: number;
+    /**
+     * URL for next page of results
+     */
+    next: string | null;
+    /**
+     * URL for previous page of results
+     */
+    previous: string | null;
+    /**
+     * List of user license assignments
+     */
+    results: Array<UserLicenseAssignmentDetail>;
+};

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

@@ -0,0 +1,22 @@
+import type { UserLicenseGroupAssignmentDetail } from './UserLicenseGroupAssignmentDetail';
+/**
+ * Response serializer for paginated user license group assignment list
+ */
+export type PaginatedUserLicenseGroupAssignment = {
+    /**
+     * Total number of results
+     */
+    count: number;
+    /**
+     * URL for next page of results
+     */
+    next: string | null;
+    /**
+     * URL for previous page of results
+     */
+    previous: string | null;
+    /**
+     * List of user license group assignments
+     */
+    results: Array<UserLicenseGroupAssignmentDetail>;
+};

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

@@ -0,0 +1,18 @@
+export type Pagination = {
+    /**
+     * Total records
+     */
+    totalItems: number;
+    /**
+     * Current Page
+     */
+    currentPage: number;
+    /**
+     * Size of data returned per page
+     */
+    perPage: number;
+    /**
+     * Amount of pages
+     */
+    totalPages: number;
+};

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

@@ -0,0 +1,71 @@
+import type { ItemTypeEnum } from './ItemTypeEnum';
+import type { MediaTypeEnum } from './MediaTypeEnum';
+export type PatchedMediaResource = {
+    readonly id?: number;
+    /**
+     * Title of the media resource
+     */
+    title?: string;
+    /**
+     * Description of the media resource
+     */
+    description?: string | null;
+    /**
+     * Type of media
+     *
+     * * `video` - Video
+     * * `image` - Image
+     * * `document` - Document
+     * * `audio` - Audio
+     * * `other` - Other
+     */
+    media_type?: MediaTypeEnum;
+    /**
+     * Type of item this media is associated with
+     *
+     * * `course` - Course
+     * * `unit` - Unit
+     * * `resource` - Resource
+     * * `course_unit` - Course and Unit
+     * * `course_resource` - Course and Resource
+     * * `unit_resource` - Unit and Resource
+     * * `all` - Course, Unit, and Resource
+     */
+    readonly item_type?: ItemTypeEnum;
+    /**
+     * ID of the associated course
+     */
+    course_id?: string | null;
+    /**
+     * ID of the associated unit
+     */
+    unit_id?: string | null;
+    /**
+     * ID of the associated item (resource)
+     */
+    item_id?: string | null;
+    /**
+     * The platform this media resource belongs to
+     */
+    readonly platform?: number;
+    /**
+     * External URL for the media resource
+     */
+    file_url?: string | null;
+    /**
+     * Uploaded media file
+     */
+    file?: string | null;
+    /**
+     * User who created this media resource
+     */
+    readonly created_by?: number | null;
+    /**
+     * When this record was created
+     */
+    readonly created_at?: string;
+    /**
+     * When this record was last updated
+     */
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,14 @@
+import type { BlankEnum } from './BlankEnum';
+import type { NotificationStatusEnum } from './NotificationStatusEnum';
+export type PatchedNotification = {
+    readonly id?: string;
+    username?: string;
+    readonly title?: string;
+    readonly body?: string;
+    status?: (NotificationStatusEnum | BlankEnum);
+    readonly channel?: string | null;
+    context?: any;
+    readonly short_message?: string;
+    created_at?: string;
+    readonly updated_at?: string;
+};

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

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

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

@@ -0,0 +1,14 @@
+export type PatchedSkillThreshold = {
+    /**
+     * The name of the threshold e.g Beginner.
+     */
+    name?: string;
+    /**
+     * The threshold for the skill.
+     */
+    threshold?: number;
+    /**
+     * The platform key
+     */
+    platform?: string;
+};

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

@@ -0,0 +1,28 @@
+export type Pathway = {
+    readonly id: number;
+    /**
+     * A unique pathway ID.
+     */
+    pathway_id: string;
+    pathway_uuid?: string;
+    readonly path: string;
+    /**
+     * The verbose name of the pathway.
+     */
+    name?: string;
+    /**
+     * Pathway visibility
+     */
+    visible?: boolean;
+    /**
+     * An additional unique slug field. (Optional)
+     */
+    slug?: string | null;
+    user_id?: number;
+    username?: string;
+    platform_key?: string;
+    /**
+     * Metadata
+     */
+    data?: any;
+};

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

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

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

@@ -0,0 +1,45 @@
+/**
+ * Serializer for pathway creation/update request body.
+ */
+export type PathwayCreateUpdateRequest = {
+    /**
+     * Pathway ID
+     */
+    pathway_id?: string;
+    /**
+     * Pathway UUID
+     */
+    pathway_uuid?: string;
+    /**
+     * User ID of the pathway owner
+     */
+    user_id: number;
+    /**
+     * Username of the pathway owner
+     */
+    username?: string;
+    /**
+     * Pathway name
+     */
+    name: string;
+    /**
+     * Pathway slug
+     */
+    slug?: string;
+    /**
+     * Whether the pathway is visible
+     */
+    visible?: boolean;
+    /**
+     * Platform key
+     */
+    platform_key?: string;
+    /**
+     * List of items in the pathway with item_id and optional position
+     */
+    path: Array<Record<string, any>>;
+    /**
+     * Additional pathway data
+     */
+    data?: any;
+};

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

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

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

@@ -0,0 +1,22 @@
+export type PathwayEnrollment = {
+    user_id?: number;
+    username?: string;
+    pathway_id?: string;
+    pathway_uuid?: string;
+    platform_key?: string;
+    org?: string;
+    name?: string;
+    slug?: string;
+    /**
+     * Date when enrollment began/activated
+     */
+    created?: string | null;
+    /**
+     * Date when enrollment ended/deactivated
+     */
+    readonly ended: string | null;
+    /**
+     * Whether the enrollment is active
+     */
+    active?: boolean;
+};

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

@@ -0,0 +1,26 @@
+/**
+ * Includes metadata+
+ */
+export type PathwayEnrollmentPlus = {
+    user_id?: number;
+    username?: string;
+    pathway_id?: string;
+    pathway_uuid?: string;
+    platform_key?: string;
+    org?: string;
+    name?: string;
+    slug?: string;
+    /**
+     * Date when enrollment began/activated
+     */
+    created?: string | null;
+    /**
+     * Date when enrollment ended/deactivated
+     */
+    readonly ended: string | null;
+    /**
+     * Whether the enrollment is active
+     */
+    active?: boolean;
+    metadata?: any;
+};

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

@@ -0,0 +1,49 @@
+/**
+ * Serializer for pathway enrollment request parameters.
+ */
+export type PathwayEnrollmentRequest = {
+    /**
+     * User ID for enrollment
+     */
+    user_id?: string;
+    /**
+     * Username for enrollment
+     */
+    username?: string;
+    /**
+     * Pathway ID for enrollment
+     */
+    pathway_id?: string;
+    /**
+     * Pathway UUID for enrollment
+     */
+    pathway_uuid?: string;
+    /**
+     * Pathway key for enrollment
+     */
+    pathway_key?: string;
+    /**
+     * Pathway slug for enrollment
+     */
+    slug?: string;
+    /**
+     * Organization for the pathway
+     */
+    org?: string;
+    /**
+     * Platform key for the pathway
+     */
+    platform_key?: string;
+    /**
+     * Include enrollments from default platform
+     */
+    include_default_platform?: boolean;
+    /**
+     * Include metadata in the response
+     */
+    include_metadata?: boolean;
+    /**
+     * Whether the enrollment should be active
+     */
+    active?: boolean;
+};

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

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

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

@@ -0,0 +1,61 @@
+/**
+ * Response serializer for pathway group suggestion details
+ */
+export type PathwayGroupSuggestionDetail = {
+    /**
+     * 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 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;
+    /**
+     * Number of users in the group
+     */
+    user_count: number;
+};

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

@@ -0,0 +1,37 @@
+/**
+ * Serializer for pathway self-enrollment request parameters.
+ */
+export type PathwaySelfEnrollmentRequest = {
+    /**
+     * User ID for self-enrollment
+     */
+    user_id?: string;
+    /**
+     * Username for self-enrollment
+     */
+    username?: string;
+    /**
+     * Pathway ID for self-enrollment
+     */
+    pathway_id?: string;
+    /**
+     * Pathway key for self-enrollment
+     */
+    pathway_key?: string;
+    /**
+     * Pathway slug for self-enrollment
+     */
+    slug?: string;
+    /**
+     * Organization for the pathway
+     */
+    org?: string;
+    /**
+     * Platform key for the pathway
+     */
+    platform_key?: string;
+    /**
+     * Whether the enrollment should be active
+     */
+    active?: boolean;
+};