@iblai/iblai-api 3.34.5-core

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

@@ -0,0 +1,17 @@
+export type NewPerLearnerListData = {
+    username: string;
+    user_id: number;
+    name: string;
+    email: string;
+    courses_enrolled: number;
+    courses_completed: number;
+    time_spent: string;
+    pathways_assigned: number;
+    pathways_completed: number;
+    certificates_earned: number;
+    assessments_passed: number;
+    skills_earned: number;
+    skills_points: number;
+    last_login: string;
+    location: string;
+};

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

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

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

@@ -0,0 +1,4 @@
+export type NotificationCount = {
+    status?: string;
+    channel?: string;
+};

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

@@ -0,0 +1,31 @@
+import type { NotificationSource } from './NotificationSource';
+import type { NotificationTemplateData } from './NotificationTemplateData';
+/**
+ * Request serializer for notification preview
+ */
+export type NotificationPreview = {
+    /**
+     * Use a predefined template in the system
+     */
+    template_id?: string | null;
+    /**
+     * Specify this to send a new custom message without using a predefined template
+     */
+    template_data?: NotificationTemplateData | null;
+    /**
+     * Specify the channel ids to send notifications to.
+     */
+    channels: Array<number>;
+    /**
+     * Specify the sources to send notifications to
+     */
+    sources: Array<NotificationSource>;
+    /**
+     * Specify the context that would be available in the message text
+     */
+    context?: Record<string, any>;
+    /**
+     * (ISO datetime) Specify the date and time of processing this notification. Note, notifications are sent hourly and only scheduled messages prior to the beginning of the hour would be sent
+     */
+    process_on?: string | null;
+};

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

@@ -0,0 +1,8 @@
+import type { TypeEnum } from './TypeEnum';
+/**
+ * Request serializer for source validation
+ */
+export type NotificationSource = {
+    type: TypeEnum;
+    data: any;
+};

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

@@ -0,0 +1,26 @@
+export type NotificationTemplateData = {
+    /**
+     * Title of the message
+     */
+    message_title?: string | null;
+    /**
+     *
+     * This would be the body of the message. Some context are available to use in the system.
+     *
+     * e.g
+     *
+     * ```
+     * This is a sample message to {{username}}.
+     *
+     * Available accessors are
+     * - site_name
+     * - site_url
+     * - site_logo_url
+     * - username
+     * and <anything passed into context dictionary>
+     * ```
+     *
+     *
+     */
+    message_body: string;
+};

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

@@ -0,0 +1,22 @@
+export type Order = {
+    /**
+     * WP Customer ID
+     */
+    customer_id: number;
+    /**
+     * WooCommerce order status
+     */
+    status: string;
+    /**
+     * WooCommerce order date
+     */
+    order_date: string;
+    /**
+     * Total discount by coupons
+     */
+    coupons: string;
+    /**
+     * Net order value
+     */
+    value: string;
+};

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

@@ -0,0 +1,3 @@
+export type OverTime = {
+    data: Record<string, any>;
+};

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

@@ -0,0 +1,22 @@
+/**
+ * Returns
+ * {
+     * "data": {
+         * "2022-04-26": 0,
+         * "2022-04-27": 0,
+         * ...
+         * "2023-01-01": 0
+         * },
+         * "total": 0
+         * }
+         */
+export type OverTimeWithTotal = {
+    /**
+     * Dates are keys and values are the value for the date in the key. e,g `{"2020-01-01": 30. ...}`
+     */
+    data?: Record<string, any>;
+    /**
+     * Total
+     */
+    total?: number;
+};

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

@@ -0,0 +1,30 @@
+export type OvertimeMeta = {
+    /**
+     * Total records
+     */
+    total: number;
+    /**
+     * Change in range
+     */
+    change_range?: number;
+    /**
+     * Change in last 7 days
+     */
+    change_last_seven_days?: number;
+    /**
+     * Change in last 30 days
+     */
+    change_last_thirty_days?: number;
+    /**
+     * Change in last 7 days in percentage
+     */
+    change_last_seven_days_percent?: number;
+    /**
+     * Change in last 30 days in percentage
+     */
+    change_last_thirty_days_percent?: number;
+    /**
+     * Change in range in percentage
+     */
+    change_range_percent?: number;
+};

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

@@ -0,0 +1,24 @@
+import type { OvertimeMeta } from './OvertimeMeta';
+/**
+ * Returns
+ * {
+     * "data": {
+         * "2022-04-26": 0,
+         * "2022-04-27": 0,
+         * ...
+         * "2023-01-01": 0
+         * },
+         * "total": 0
+         * }
+         */
+export type OvertimeWithChangeInfo = {
+    /**
+     * Dates are keys and values are the value for the date in the key. e,g `{"2020-01-01": 30. ...}`
+     */
+    data?: Record<string, any>;
+    /**
+     * Total
+     */
+    total?: number;
+    meta: OvertimeMeta;
+};

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

@@ -0,0 +1,13 @@
+import type { BlankEnum } from './BlankEnum';
+import type { StatusEnum } from './StatusEnum';
+export type PatchedNotification = {
+    readonly id?: string;
+    username?: string;
+    readonly title?: string;
+    readonly body?: string;
+    status?: (StatusEnum | BlankEnum);
+    readonly channel?: string | null;
+    context?: any;
+    readonly short_message?: string;
+    created_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/PerLearnerCourseLastAccessData.d.ts

@@ -0,0 +1,30 @@
+export type PerLearnerCourseLastAccessData = {
+    /**
+     * Edx Course ID
+     */
+    course_id?: string;
+    /**
+     * Course Name
+     */
+    course_name?: string;
+    /**
+     * Last Block Accessed
+     */
+    block_id?: string;
+    /**
+     * Last Block Display Name
+     */
+    block_display_name?: string;
+    /**
+     * Course grade
+     */
+    course_grade?: number;
+    /**
+     * Course progress
+     */
+    course_progress?: number;
+    /**
+     * Last accessed time
+     */
+    last_accessed?: string;
+};

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

@@ -0,0 +1,8 @@
+import type { PerLearnerCourseVideosWatchedData } from './PerLearnerCourseVideosWatchedData';
+export type PerLearnerCourseVideosWatched = {
+    data: Array<PerLearnerCourseVideosWatchedData>;
+    /**
+     * videos watched
+     */
+    total: number;
+};

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

@@ -0,0 +1,14 @@
+export type PerLearnerCourseVideosWatchedData = {
+    /**
+     * Video Id
+     */
+    id: string;
+    /**
+     * Video Name
+     */
+    name: string;
+    /**
+     * Watch status
+     */
+    watched: boolean;
+};

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

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

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

@@ -0,0 +1,11 @@
+import type { PerLearnerCourseLastAccessData } from './PerLearnerCourseLastAccessData';
+export type PerLearnerLastAccessData = {
+    /**
+     * Course last accessed metadata
+     */
+    course_last_accessed?: PerLearnerCourseLastAccessData;
+    /**
+     * Last accessed time
+     */
+    last_accessed?: string;
+};

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

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

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

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

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

@@ -0,0 +1,22 @@
+export type PerformanceGradesPerCourseData = {
+    /**
+     * Course name
+     */
+    name: string;
+    /**
+     * Course id
+     */
+    course_id: string;
+    /**
+     * Course enrollments
+     */
+    num_enrollments: number;
+    /**
+     * Total users who have passed the course
+     */
+    num_passed: number;
+    /**
+     * Course Average grade
+     */
+    avg_grade: number;
+};

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

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

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

@@ -0,0 +1,6 @@
+export type PerlearnerCourseProgressData = {
+    /**
+     * Perlearner Course progress
+     */
+    progress: number;
+};

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

@@ -0,0 +1,30 @@
+export type PerlearnerEngagementVideosData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Total course videos
+     */
+    total_videos: number;
+    /**
+     * Total videos watched by student
+     */
+    watched: number;
+    /**
+     * Total time user watched video
+     */
+    total_time_watch: number;
+    /**
+     * Average videos watched by students in course
+     */
+    average_class_watch: number;
+    /**
+     * Average time spent by students on this course
+     */
+    class_time_average: number;
+};

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

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

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

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

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

@@ -0,0 +1,18 @@
+export type PerlearnerGradeSummaryData = {
+    /**
+     * Assignment Type name
+     */
+    assignment_type: string;
+    /**
+     * Assignment weight
+     */
+    weight: number;
+    /**
+     * Assignment grade
+     */
+    weighted_grade: number;
+    /**
+     * Assignment section grade average in course
+     */
+    average_section_grade: number;
+};

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

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

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

@@ -0,0 +1,10 @@
+export type PerlearnerGradeWithCutOffData = {
+    /**
+     * Dictionary showing grade cutoffs
+     */
+    grade_cutoffs: Record<string, any>;
+    /**
+     * Grade
+     */
+    grade: number;
+};

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

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

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

@@ -0,0 +1,34 @@
+export type PerlearnerGradingPerCourseAPIData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Total problems in course
+     */
+    graded_activities: string;
+    /**
+     * Cumulative problem submissions
+     */
+    submissions: number;
+    /**
+     * Number of problems from total problems attempted
+     */
+    problems_attempted: number;
+    /**
+     * Number of problems answered correctly
+     */
+    assignments_correct: number;
+    /**
+     * Average grade obtained by all learner in the course
+     */
+    class_average: number;
+    /**
+     * Learner course grade
+     */
+    grade: number;
+};

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

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

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

@@ -0,0 +1,34 @@
+export type PerlearnerUserListData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner Name
+     */
+    full_name: string;
+    /**
+     * Total enrollments
+     */
+    enrollments: number;
+    /**
+     * Total completions
+     */
+    completions: number;
+    /**
+     * Last active time
+     */
+    last_active: string;
+    /**
+     * Time spent formatted in seconds
+     */
+    time_spent: string;
+    /**
+     * Engagement index
+     */
+    engagement_index: number;
+    /**
+     * Performance index
+     */
+    performance_index: number;
+};

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