@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,57 @@
+/**
+ * Request serializer for UserLicenseCreateView POST endpoint
+ */
+export type UserLicenseCreate = {
+    /**
+     * The platform to create a license for
+     */
+    platform_key: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: 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/UserLicenseDetail.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Response serializer for user license details
+ */
+export type UserLicenseDetail = {
+    /**
+     * 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;
+    /**
+     * Assignment counts by status (only included in verbose mode)
+     */
+    assignments?: Record<string, number>;
+};

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

@@ -0,0 +1,33 @@
+/**
+ * Request serializer for UserLicenseGroupAssignmentView POST endpoint
+ */
+export type UserLicenseGroupAssignmentCreate = {
+    /**
+     * The ID of the user license
+     */
+    license_id: number;
+    /**
+     * The ID of the user group 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/UserLicenseGroupAssignmentDetail.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Response serializer for user license group assignment details
+ */
+export type UserLicenseGroupAssignmentDetail = {
+    /**
+     * 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 user license
+     */
+    license_id: number;
+    /**
+     * The name of the user license
+     */
+    license_name: string;
+    /**
+     * The platform key associated with the license
+     */
+    platform_key: string;
+};

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

@@ -0,0 +1,61 @@
+/**
+ * Request serializer for UserLicenseUpdateView POST endpoint
+ */
+export type UserLicenseUpdate = {
+    /**
+     * 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 enrollment configuration
+     */
+    enrollment_config?: 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/UserPlatformLink.d.ts

@@ -0,0 +1,17 @@
+export type UserPlatformLink = {
+    user_id: number;
+    username: string;
+    email: string;
+    user_active: boolean;
+    key: string;
+    org: string;
+    lms_url: string;
+    cms_url: string;
+    portal_url: string;
+    is_admin?: boolean;
+    is_staff?: boolean;
+    added_on?: string | null;
+    expired_on?: string | null;
+    readonly public: string;
+    active?: boolean;
+};

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

@@ -0,0 +1,6 @@
+export type UserPlatformManagementListViewGetResponse = {
+    count: number;
+    next_page: number;
+    previous_page: number;
+    results: Array<Record<string, any>>;
+};

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

@@ -0,0 +1,8 @@
+export type UserPlatformViewPostRequest = {
+    user_id: number;
+    platform_key: string;
+    added_on?: string;
+    expired_on?: string;
+    is_admin?: boolean;
+    active?: boolean;
+};

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

@@ -0,0 +1,3 @@
+export type UserProxyBulkRequest = {
+    users: Array<Record<string, string>>;
+};

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

@@ -0,0 +1,8 @@
+export type UserProxyGetResponse = {
+    user_id: number;
+    username: string;
+    email: string;
+    active: boolean;
+    edx_data: any;
+    data: any;
+};

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

@@ -0,0 +1,7 @@
+export type UserProxyPostRequest = {
+    user_id: number;
+    username: string;
+    email: string;
+    edx_data: any;
+    data: any;
+};

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

@@ -0,0 +1,8 @@
+export type UserProxyPostResponse = {
+    user_id: number;
+    username: string;
+    email: string;
+    active: boolean;
+    edx_data: any;
+    data: any;
+};

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

@@ -0,0 +1,29 @@
+/**
+ * Response serializer for UsersSearchView
+ */
+export type UserSearchResponse = {
+    /**
+     * List of search results (can include user_resume, education, institution, etc.)
+     */
+    results: Array<Record<string, any>>;
+    /**
+     * Total number of results
+     */
+    count: number;
+    /**
+     * URL for the next page of results
+     */
+    next: string | null;
+    /**
+     * URL for the previous page of results
+     */
+    previous: string | null;
+    /**
+     * Current page number
+     */
+    current_page: number;
+    /**
+     * Total number of pages
+     */
+    total_pages: number;
+};

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

@@ -0,0 +1,6 @@
+export type UserSearchViewGetResponse = {
+    count: number;
+    next_page: number;
+    previous_page: number;
+    results: Array<Record<string, any>>;
+};

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

@@ -0,0 +1,22 @@
+import type { CoursePoint } from './CoursePoint';
+import type { ResourcePoint } from './ResourcePoint';
+import type { Skill } from './Skill';
+export type UserSkill = {
+    skill: Skill;
+    /**
+     * Courses with skill and associated points
+     */
+    courses: Array<CoursePoint>;
+    /**
+     * Resources with skill and associated points
+     */
+    resources: Array<ResourcePoint>;
+    /**
+     * Total points for skill
+     */
+    readonly total_points: number;
+    /**
+     * Percentile of points for user.
+     */
+    percentile?: number;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * Response serializer for UserSkillPointInfoView GET endpoint.
+ * Returns a mapping of skill names to point breakdowns.
+ */
+export type UserSkillPointInfoResponse = {
+    /**
+     * Dictionary mapping skill names to their point breakdowns. Example: {'skill_name': {'course_points': 10, 'block_points': 5, 'platform_points': 3, 'total_points': 18}}
+     */
+    skill_points: Record<string, Record<string, number>>;
+};

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

@@ -0,0 +1,8 @@
+export type UserSkillPointsPercentile = {
+    username: string;
+    total_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/ValidateSourceResponse.d.ts

@@ -0,0 +1,10 @@
+import type { Recipient } from './Recipient';
+/**
+ * Response serializer for source validation
+ */
+export type ValidateSourceResponse = {
+    status: string;
+    valid_count: number;
+    invalid_entries: Array<string>;
+    sample_recipients: Array<Recipient>;
+};

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

@@ -0,0 +1,4 @@
+import type { ValueData } from './ValueData';
+export type Value = {
+    data: ValueData;
+};

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

@@ -0,0 +1,6 @@
+export type ValueData = {
+    /**
+     * value
+     */
+    value: number;
+};

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

@@ -0,0 +1,11 @@
+export type VerifyGCPMarketPlaceFailedResponse = {
+    sub?: string;
+    aud?: string;
+    iat?: string;
+    exp?: string;
+    google?: Record<string, any>;
+    iss?: string;
+    readonly redirect_to: string;
+    message?: string;
+    success?: boolean;
+};

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

@@ -0,0 +1,3 @@
+export type VerifyGCPMarketPlaceRequest = {
+    token: string;
+};

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

@@ -0,0 +1,11 @@
+export type VerifyGCPMarketPlaceResponse = {
+    sub?: string;
+    aud?: string;
+    iat?: string;
+    exp?: string;
+    google?: Record<string, any>;
+    iss?: string;
+    readonly redirect_to: string;
+    message?: string;
+    success?: boolean;
+};

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

@@ -0,0 +1,14 @@
+export type VideoBlock = {
+    /**
+     * Video name
+     */
+    display_name: string;
+    /**
+     * Video Id
+     */
+    id: string;
+    /**
+     * Total users who have watched the video
+     */
+    total_users?: number;
+};

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

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

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

@@ -0,0 +1,30 @@
+export type VideoEngagementPerCourseData = {
+    /**
+     * Course name
+     */
+    name: string;
+    /**
+     * edx Course Id
+     */
+    course_id: string;
+    /**
+     * Number of videos in course
+     */
+    num_vids: number;
+    /**
+     * Number of videos watched
+     */
+    num_watched: number;
+    /**
+     * Total time spent by all users watching videos
+     */
+    time_watched: number;
+    /**
+     * Average percentage of videos watched per user per course
+     */
+    avg_percent_watched: number;
+    /**
+     * Average time spent per learner
+     */
+    avg_time_watched: number;
+};

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

@@ -0,0 +1,4 @@
+import type { VideosCountData } from './VideosCountData';
+export type VideosCount = {
+    data?: VideosCountData;
+};

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

@@ -0,0 +1,6 @@
+export type VideosCountData = {
+    /**
+     * Total videos (videos watched / Total Course Videos)
+     */
+    count: string;
+};

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

@@ -0,0 +1,4 @@
+import type { VideosInCourseSummaryData } from './VideosInCourseSummaryData';
+export type VideosInCourseSummary = {
+    data?: Array<VideosInCourseSummaryData>;
+};

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

@@ -0,0 +1,12 @@
+import type { VideosWatchedSubSection } from './VideosWatchedSubSection';
+export type VideosInCourseSummaryData = {
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    subsections?: Array<VideosWatchedSubSection>;
+};

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

@@ -0,0 +1,4 @@
+import type { VideosSpecificCourseData } from './VideosSpecificCourseData';
+export type VideosSpecificCourse = {
+    data?: Array<VideosSpecificCourseData>;
+};

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

@@ -0,0 +1,26 @@
+export type VideosSpecificCourseData = {
+    /**
+     * Course name
+     */
+    display_name: string;
+    /**
+     * Video Id
+     */
+    id: string;
+    /**
+     * Video duration
+     */
+    duration: number;
+    /**
+     * Total time spent by users watching
+     */
+    total_time: number;
+    /**
+     * Total users who have watched this video
+     */
+    total_users: number;
+    /**
+     * Average time spent per learner
+     */
+    average_time: number;
+};

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

@@ -0,0 +1,19 @@
+import type { VideoBlock } from './VideoBlock';
+export type VideosWatchedSubSection = {
+    /**
+     * Subsection name
+     */
+    display_name: string;
+    /**
+     * Subsection Id
+     */
+    id: string;
+    /**
+     * Total videos watched. N/A if no record found
+     */
+    total_watch: string;
+    /**
+     * Videos
+     */
+    videos?: Array<VideoBlock>;
+};

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

@@ -0,0 +1,8 @@
+import type { WatchedVideosPerCourseData } from './WatchedVideosPerCourseData';
+export type WatchedVideosPerCourse = {
+    data?: Array<WatchedVideosPerCourseData>;
+    /**
+     * Total videos Watched for all rows
+     */
+    total?: number;
+};

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

@@ -0,0 +1,18 @@
+export type WatchedVideosPerCourseData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Number of watched videos
+     */
+    count: number;
+    /**
+     * Percentage ...
+     */
+    percentage: number;
+};

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

@@ -0,0 +1,8 @@
+import type { WatchedVideosPerUserData } from './WatchedVideosPerUserData';
+export type WatchedVideosPerUser = {
+    data?: Array<WatchedVideosPerUserData>;
+    /**
+     * Total rows
+     */
+    total?: number;
+};

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

@@ -0,0 +1,18 @@
+export type WatchedVideosPerUserData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner fullname
+     */
+    full_name: string;
+    /**
+     * Videos watched count
+     */
+    count: number;
+    /**
+     * Percentage ...
+     */
+    percentage: number;
+};

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

@@ -0,0 +1,4 @@
+export type WhitelistedDomain = {
+    url: string;
+    is_active?: boolean;
+};