@iblai/iblai-api 3.34.5-core

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

@@ -0,0 +1,18 @@
+/**
+ * * `bachelors` - Bachelor's Degree
+ * * `masters` - Master's Degree
+ * * `phd` - PhD
+ * * `diploma` - Diploma
+ * * `certificate` - Certificate
+ * * `ungraded` - Ungraded
+ * * `other` - Other
+ */
+export declare enum ProgramTypeEnum {
+    BACHELORS = "bachelors",
+    MASTERS = "masters",
+    PHD = "phd",
+    DIPLOMA = "diploma",
+    CERTIFICATE = "certificate",
+    UNGRADED = "ungraded",
+    OTHER = "other"
+}

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

@@ -0,0 +1,8 @@
+/**
+ * Serializer for recipient data
+ */
+export type Recipient = {
+    username: string;
+    email: string;
+    status?: string;
+};

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

@@ -0,0 +1,3 @@
+export type RecommendationSearchAPI = {
+    search_api_url: string;
+};

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

@@ -0,0 +1,3 @@
+export type RedirectTokenRequest = {
+    url: string;
+};

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

@@ -0,0 +1,5 @@
+export type RedirectTokenResponse = {
+    readonly platform_key: string;
+    url: string;
+    readonly token: string;
+};

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

@@ -0,0 +1,7 @@
+import type { ReportStatus } from './ReportStatus';
+/**
+ * Returns this a report is successfully created
+ */
+export type ReportCreate = {
+    data: ReportStatus;
+};

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

@@ -0,0 +1,28 @@
+import type { ReportStatus } from './ReportStatus';
+export type ReportData = {
+    /**
+     * Report Name
+     */
+    display_name?: string;
+    /**
+     * Report Description
+     */
+    description?: string;
+    /**
+     * Report slug
+     */
+    report_name?: string;
+    icon?: string;
+    /**
+     * Extra parameters to be passed to the report create view, e.g learner_id
+     */
+    extra_query_params?: Array<any>;
+    /**
+     * Columns to be available in the report
+     */
+    result_columns?: Array<any>;
+    /**
+     * Report Status if any available
+     */
+    status?: ReportStatus;
+};

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

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

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

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

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

@@ -0,0 +1,21 @@
+export type ReportRequest = {
+    /**
+     * Report slug, this is passed when calling the create report endpoint
+     */
+    report_name?: string;
+    /**
+     * Advanced report filtering. e,g: {'username': 'username1, username2' }
+     */
+    params?: Record<string, any>;
+    /**
+     *
+     * Advanced Query to run the report, supports SQL Like queries.
+     *
+     * e.g For date type filtering
+     * date_joined > '2021-01-01'
+     *
+     * See https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.query.html#pandas.DataFrame.query
+     *
+     */
+    query?: string;
+};

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

@@ -0,0 +1,41 @@
+import type { StateEnum } from './StateEnum';
+export type ReportStatus = {
+    /**
+     * Used to download the report
+     */
+    report_id?: string;
+    /**
+     * Report slug, this is passed when calling the create report endpoint
+     */
+    report_name?: string;
+    /**
+     * Report States
+     *
+     * * `pending` - Pending
+     * * `running` - Running
+     * * `accumulating` - Accumulating
+     * * `processing` - Processing
+     * * `storing` - Storing
+     * * `completed` - Completed
+     * * `cancelled` - Cancelled
+     * * `error` - Error
+     * * `expired` - Expired
+     */
+    state?: StateEnum;
+    /**
+     * Report request timestamp (ISO 8601)
+     */
+    started_on?: string;
+    /**
+     * Report Owner
+     */
+    owner?: string;
+    /**
+     * When report would expire and not available for download anymore
+     */
+    expires?: string;
+    /**
+     * Download link for report when available
+     */
+    url?: string;
+};

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

@@ -0,0 +1,4 @@
+import type { Skill } from './Skill';
+export type ReportedSkill = {
+    skills: Array<Skill>;
+};

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

@@ -0,0 +1,7 @@
+export type ResourcePoint = {
+    /**
+     * The display name of the resource.
+     */
+    name?: string | null;
+    readonly points: number;
+};

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

@@ -0,0 +1,6 @@
+import type { ProductTable } from './ProductTable';
+import type { Summary } from './Summary';
+export type RevenueByProduct = {
+    product_table?: Array<ProductTable>;
+    summary?: Summary;
+};

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

@@ -0,0 +1,6 @@
+/**
+ * Request serializer for sending notification
+ */
+export type SendNotification = {
+    build_id: string;
+};

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

@@ -0,0 +1,9 @@
+/**
+ * Response serializer for send notification
+ */
+export type SendResponse = {
+    status: string;
+    notifications_sent: number;
+    build_id: string;
+    message: string;
+};

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

@@ -0,0 +1,7 @@
+export type Skill = {
+    readonly id: number;
+    /**
+     * Display name
+     */
+    name?: string | null;
+};

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

@@ -0,0 +1,9 @@
+import type { CourseSkill } from './CourseSkill';
+export type SkillDetail = {
+    /**
+     * Display name
+     */
+    name?: string | null;
+    courses: Array<CourseSkill>;
+    readonly related_skills: number;
+};

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

@@ -0,0 +1,23 @@
+export type SkillInfo = {
+    readonly id: number;
+    /**
+     * Display name
+     */
+    name?: string | null;
+    /**
+     * Number of courses with skill
+     */
+    readonly course_count: number;
+    /**
+     * Number of users with skill
+     */
+    readonly user_count: number;
+    /**
+     * Total points for skill
+     */
+    readonly total_points: number;
+    /**
+     * Average points for skill
+     */
+    readonly average_points: number;
+};

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

@@ -0,0 +1,14 @@
+export type SkillThreshold = {
+    /**
+     * 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/StateEnum.d.ts

@@ -0,0 +1,22 @@
+/**
+ * * `pending` - Pending
+ * * `running` - Running
+ * * `accumulating` - Accumulating
+ * * `processing` - Processing
+ * * `storing` - Storing
+ * * `completed` - Completed
+ * * `cancelled` - Cancelled
+ * * `error` - Error
+ * * `expired` - Expired
+ */
+export declare enum StateEnum {
+    PENDING = "pending",
+    RUNNING = "running",
+    ACCUMULATING = "accumulating",
+    PROCESSING = "processing",
+    STORING = "storing",
+    COMPLETED = "completed",
+    CANCELLED = "cancelled",
+    ERROR = "error",
+    EXPIRED = "expired"
+}

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

@@ -0,0 +1,10 @@
+/**
+ * * `READ` - Read
+ * * `UNREAD` - Unread
+ * * `CANCELLED` - Cancelled
+ */
+export declare enum StatusEnum {
+    READ = "READ",
+    UNREAD = "UNREAD",
+    CANCELLED = "CANCELLED"
+}

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

@@ -0,0 +1,18 @@
+export type SubTimeChild = {
+    /**
+     * Display name
+     */
+    display_name: string;
+    /**
+     * block id
+     */
+    id: string;
+    /**
+     * block id
+     */
+    block_id?: string;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+};

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

@@ -0,0 +1,18 @@
+export type Summary = {
+    /**
+     * Total number of products
+     */
+    num_products: number;
+    /**
+     * Total number of items ordered
+     */
+    num_orders: number;
+    /**
+     * Total Net revenue
+     */
+    net_revenue: number;
+    /**
+     * Average Net value per item sold
+     */
+    avg_order_value: number;
+};

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

@@ -0,0 +1,20 @@
+import type { SubTimeChild } from './SubTimeChild';
+export type TimeChildData = {
+    /**
+     * Display name
+     */
+    display_name: string;
+    /**
+     * block id
+     */
+    id: string;
+    /**
+     * block id
+     */
+    block_id?: string;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+    children: Array<SubTimeChild>;
+};

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

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

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

@@ -0,0 +1,26 @@
+export type TimeDetailChild = {
+    /**
+     * Average time spent
+     */
+    average_time: number;
+    /**
+     * Subsection Display name
+     */
+    display_name: string;
+    /**
+     * Subsection HTML id
+     */
+    id: string;
+    /**
+     * Subsection block id
+     */
+    block_id: string;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+    /**
+     * Total users who accessed the subsection
+     */
+    total_users?: number;
+};

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

@@ -0,0 +1,24 @@
+import type { TimeDetailChild } from './TimeDetailChild';
+export type TimeDetailData = {
+    /**
+     * Average time spent
+     */
+    average_time: number;
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    children?: Array<TimeDetailChild>;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+    /**
+     * Total users who accessed the chapter
+     */
+    total_users?: number;
+};

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

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

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

@@ -0,0 +1,22 @@
+export type TimeSpentByUsersInCourseData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner Name
+     */
+    full_name: string;
+    /**
+     * learner email
+     */
+    email: string;
+    /**
+     * Total assessments
+     */
+    assessments: number;
+    /**
+     * Time spent formatted in seconds
+     */
+    time_spent: string;
+};

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

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

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

@@ -0,0 +1,26 @@
+export type TimeSpentPerCourseData = {
+    /**
+     * Course name
+     */
+    name: string;
+    /**
+     * Edx Course Id
+     */
+    course_id: string;
+    /**
+     * Total time spent
+     */
+    time_spent: number;
+    /**
+     * Course Start
+     */
+    course_start: string;
+    /**
+     * Course End
+     */
+    course_end: string;
+    /**
+     * Average time spent
+     */
+    average_time: number;
+};

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

@@ -0,0 +1,3 @@
+export type TimeSpentPerUserResponse = {
+    total_seconds: number;
+};

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

@@ -0,0 +1,11 @@
+export type TimeSpentUpdateRequest = {
+    /**
+     * Time when the event occurred, ensure it is UTC (ISO 8601 format)
+     */
+    timestamp: string;
+    course_id?: string;
+    block_id?: string;
+    count: number;
+    url: string;
+    metadata?: any;
+};

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

@@ -0,0 +1,4 @@
+export type TimeSpentUpdateResponse = {
+    success?: boolean;
+    message?: any;
+};

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

@@ -0,0 +1,18 @@
+/**
+ * * `email` - email
+ * * `username` - username
+ * * `platform` - platform
+ * * `csv` - csv
+ * * `department` - department
+ * * `pathway` - pathway
+ * * `program` - program
+ */
+export declare enum TypeEnum {
+    EMAIL = "email",
+    USERNAME = "username",
+    PLATFORM = "platform",
+    CSV = "csv",
+    DEPARTMENT = "department",
+    PATHWAY = "pathway",
+    PROGRAM = "program"
+}

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

@@ -0,0 +1,5 @@
+export type UploadedImage = {
+    readonly id: number;
+    name?: string | null;
+    readonly image: string;
+};

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

@@ -0,0 +1,13 @@
+export type UserInfo = {
+    /**
+     * edX user ID
+     */
+    id: number;
+    /**
+     * edX username
+     */
+    username?: string | null;
+    email: string;
+    active: boolean;
+    edx_data: 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/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/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;
+};