@iblai/iblai-api 3.34.5-core

package/src/models/PerlearnerUserListData.ts

@@ -0,0 +1,39 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/PlatformPublicMetadata.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PlatformPublicMetadata = {
+    readonly platform_key: string;
+    readonly platform_name: string;
+    /**
+     * The public metadata
+     */
+    metadata?: any;
+};
+

package/src/models/PointsPercentile.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/PreviewResponse.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/Product.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ProductTable.ts

@@ -0,0 +1,31 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/Program.ts

@@ -0,0 +1,29 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ProgramTypeEnum.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `bachelors` - Bachelor's Degree
+ * * `masters` - Master's Degree
+ * * `phd` - PhD
+ * * `diploma` - Diploma
+ * * `certificate` - Certificate
+ * * `ungraded` - Ungraded
+ * * `other` - Other
+ */
+export enum ProgramTypeEnum {
+    BACHELORS = 'bachelors',
+    MASTERS = 'masters',
+    PHD = 'phd',
+    DIPLOMA = 'diploma',
+    CERTIFICATE = 'certificate',
+    UNGRADED = 'ungraded',
+    OTHER = 'other',
+}

package/src/models/Recipient.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for recipient data
+ */
+export type Recipient = {
+    username: string;
+    email: string;
+    status?: string;
+};
+

package/src/models/RecommendationSearchAPI.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RecommendationSearchAPI = {
+    search_api_url: string;
+};
+

package/src/models/RedirectTokenRequest.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RedirectTokenRequest = {
+    url: string;
+};
+

package/src/models/RedirectTokenResponse.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RedirectTokenResponse = {
+    readonly platform_key: string;
+    url: string;
+    readonly token: string;
+};
+

package/src/models/ReportCreate.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ReportStatus } from './ReportStatus';
+/**
+ * Returns this a report is successfully created
+ */
+export type ReportCreate = {
+    data: ReportStatus;
+};
+

package/src/models/ReportData.ts

@@ -0,0 +1,33 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ReportDetail.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ReportData } from './ReportData';
+export type ReportDetail = {
+    data: ReportData;
+};
+

package/src/models/ReportList.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ReportData } from './ReportData';
+export type ReportList = {
+    data: Array<ReportData>;
+};
+

package/src/models/ReportRequest.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ReportStatus.ts

@@ -0,0 +1,46 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ReportedSkill.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Skill } from './Skill';
+export type ReportedSkill = {
+    skills: Array<Skill>;
+};
+

package/src/models/ResourcePoint.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ResourcePoint = {
+    /**
+     * The display name of the resource.
+     */
+    name?: string | null;
+    readonly points: number;
+};
+

package/src/models/RevenueByProduct.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ProductTable } from './ProductTable';
+import type { Summary } from './Summary';
+export type RevenueByProduct = {
+    product_table?: Array<ProductTable>;
+    summary?: Summary;
+};
+

package/src/models/SendNotification.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request serializer for sending notification
+ */
+export type SendNotification = {
+    build_id: string;
+};
+

package/src/models/SendResponse.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Response serializer for send notification
+ */
+export type SendResponse = {
+    status: string;
+    notifications_sent: number;
+    build_id: string;
+    message: string;
+};
+

package/src/models/Skill.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type Skill = {
+    readonly id: number;
+    /**
+     * Display name
+     */
+    name?: string | null;
+};
+

package/src/models/SkillDetail.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CourseSkill } from './CourseSkill';
+export type SkillDetail = {
+    /**
+     * Display name
+     */
+    name?: string | null;
+    courses: Array<CourseSkill>;
+    readonly related_skills: number;
+};
+

package/src/models/SkillInfo.ts

@@ -0,0 +1,28 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/SkillThreshold.ts

@@ -0,0 +1,19 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/StateEnum.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `pending` - Pending
+ * * `running` - Running
+ * * `accumulating` - Accumulating
+ * * `processing` - Processing
+ * * `storing` - Storing
+ * * `completed` - Completed
+ * * `cancelled` - Cancelled
+ * * `error` - Error
+ * * `expired` - Expired
+ */
+export enum StateEnum {
+    PENDING = 'pending',
+    RUNNING = 'running',
+    ACCUMULATING = 'accumulating',
+    PROCESSING = 'processing',
+    STORING = 'storing',
+    COMPLETED = 'completed',
+    CANCELLED = 'cancelled',
+    ERROR = 'error',
+    EXPIRED = 'expired',
+}

package/src/models/StatusEnum.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `READ` - Read
+ * * `UNREAD` - Unread
+ * * `CANCELLED` - Cancelled
+ */
+export enum StatusEnum {
+    READ = 'READ',
+    UNREAD = 'UNREAD',
+    CANCELLED = 'CANCELLED',
+}

package/src/models/SubTimeChild.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type SubTimeChild = {
+    /**
+     * Display name
+     */
+    display_name: string;
+    /**
+     * block id
+     */
+    id: string;
+    /**
+     * block id
+     */
+    block_id?: string;
+    /**
+     * Total time spent
+     */
+    total_time?: number;
+};
+

package/src/models/Summary.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/TimeChildData.ts

@@ -0,0 +1,25 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/TimeDetail.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { TimeDetailData } from './TimeDetailData';
+export type TimeDetail = {
+    data?: Array<TimeDetailData>;
+    /**
+     * Total time spent
+     */
+    total?: number;
+};
+