@iblai/iblai-api 3.58.0-core → 3.59.0-ai

package/dist/types/services/FinanceService.d.ts

@@ -1,81 +0,0 @@
-import type { NetRevenueOverTime } from '../models/NetRevenueOverTime';
-import type { Order } from '../models/Order';
-import type { Product } from '../models/Product';
-import type { RevenueByProduct } from '../models/RevenueByProduct';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class FinanceService {
-    /**
-     * Returns table listing products and product info for all or specific org
-     * @returns Product
-     * @throws ApiError
-     */
-    static financeOrgsProductsRetrieve({ org, }: {
-        org: string;
-    }): CancelablePromise<Product>;
-    /**
-     * Return list of WooCommerce orders for product item_id over optional date range
-     * @returns Order
-     * @throws ApiError
-     */
-    static financeOrgsProductsOrdersRetrieve({ itemId, org, endDate, startDate, }: {
-        itemId: string;
-        org: string;
-        /**
-         * End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-         */
-        endDate?: string;
-        /**
-         * Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-         */
-        startDate?: string;
-    }): CancelablePromise<Order>;
-    /**
-     * Returns Net Revenue over time for org and slug
-     * @returns NetRevenueOverTime
-     * @throws ApiError
-     */
-    static financeOrgsProductsSalesOverTimeRetrieve({ itemId, org, endDate, startDate, }: {
-        itemId: string;
-        org: string;
-        /**
-         * End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-         */
-        endDate?: string;
-        /**
-         * Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-         */
-        startDate?: string;
-    }): CancelablePromise<NetRevenueOverTime>;
-    /**
-     * Returns Net Revenue over time for org and slug
-     * @returns NetRevenueOverTime
-     * @throws ApiError
-     */
-    static financeOrgsRevenueNetOverTimeRetrieve({ org, endDate, startDate, }: {
-        org: string;
-        /**
-         * End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-         */
-        endDate?: string;
-        /**
-         * Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-         */
-        startDate?: string;
-    }): CancelablePromise<NetRevenueOverTime>;
-    /**
-     * Returns Revenue by Product + summary for specific org
-     * @returns RevenueByProduct
-     * @throws ApiError
-     */
-    static financeOrgsRevenueProductsRetrieve({ org, endDate, startDate, }: {
-        org: string;
-        /**
-         * End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-         */
-        endDate?: string;
-        /**
-         * Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-         */
-        startDate?: string;
-    }): CancelablePromise<RevenueByProduct>;
-}

package/dist/types/services/NotificationBuilderService.d.ts

@@ -1,72 +0,0 @@
-import type { ContextResponse } from '../models/ContextResponse';
-import type { NotificationPreview } from '../models/NotificationPreview';
-import type { NotificationSource } from '../models/NotificationSource';
-import type { PreviewResponse } from '../models/PreviewResponse';
-import type { Recipient } from '../models/Recipient';
-import type { SendNotification } from '../models/SendNotification';
-import type { SendResponse } from '../models/SendResponse';
-import type { ValidateSourceResponse } from '../models/ValidateSourceResponse';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class NotificationBuilderService {
-    /**
-     * Get build recipients
-     * Get paginated list of recipients for a notification build
-     * @returns Recipient
-     * @throws ApiError
-     */
-    static notificationV1OrgsNotificationBuilderRecipientsList({ id, platformKey, page, pageSize, search, }: {
-        id: string;
-        platformKey: string;
-        /**
-         * Page number
-         */
-        page?: number;
-        /**
-         * Number of items per page
-         */
-        pageSize?: number;
-        /**
-         * Search recipients by username or email
-         */
-        search?: string;
-    }): CancelablePromise<Array<Recipient>>;
-    /**
-     * Get notification context data
-     * Get all context data needed for notification building including templates, channels, and platforms
-     * @returns ContextResponse
-     * @throws ApiError
-     */
-    static notificationV1OrgsNotificationBuilderContextRetrieve({ platformKey, }: {
-        platformKey: string;
-    }): CancelablePromise<ContextResponse>;
-    /**
-     * Preview notification
-     * Preview notification recipients and get build ID for sending
-     * @returns PreviewResponse
-     * @throws ApiError
-     */
-    static notificationV1OrgsNotificationBuilderPreviewCreate({ platformKey, requestBody, }: {
-        platformKey: string;
-        requestBody: NotificationPreview;
-    }): CancelablePromise<PreviewResponse>;
-    /**
-     * Send notification
-     * Send notifications to all recipients in a build
-     * @returns SendResponse
-     * @throws ApiError
-     */
-    static notificationV1OrgsNotificationBuilderSendCreate({ platformKey, requestBody, }: {
-        platformKey: string;
-        requestBody: SendNotification;
-    }): CancelablePromise<SendResponse>;
-    /**
-     * Validate notification source
-     * Validate a single notification source (email, username, platform, csv)
-     * @returns ValidateSourceResponse
-     * @throws ApiError
-     */
-    static notificationV1OrgsNotificationBuilderValidateSourceCreate({ platformKey, requestBody, }: {
-        platformKey: string;
-        requestBody: NotificationSource;
-    }): CancelablePromise<ValidateSourceResponse>;
-}

package/dist/types/services/OverviewService.d.ts

@@ -1,283 +0,0 @@
-import type { Average } from '../models/Average';
-import type { CourseCompletionSummaryOvertime } from '../models/CourseCompletionSummaryOvertime';
-import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
-import type { PerlearnerUserList } from '../models/PerlearnerUserList';
-import type { TimeSpentPerCourse } from '../models/TimeSpentPerCourse';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class OverviewService {
-    /**
-     * Get active user counts over time.
-     *
-     * This endpoint provides daily counts of active users (users with known activity)
-     * over a specified time period.
-     *
-     * Query Parameters:
-     * start_date (str, optional): Start date for the time range (ISO format)
-     * end_date (str, optional): End date for the time range (ISO format)
-     *
-     * Returns:
-     * Daily active user counts over the specified time period, with change metrics
-     * compared to previous periods.
-     *
-     * Default time range is the last 7 days if no dates are specified.
-     *
-     * An active user is defined as a user with any activity within the past 30 days.
-     * @returns OvertimeWithChangeInfo
-     * @throws ApiError
-     */
-    static overviewOrgsActiveUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<OvertimeWithChangeInfo>;
-    /**
-     * Get average grade value for platform, course, or user.
-     *
-     * This endpoint returns the average grade at different levels:
-     * - Platform level: Average grade across all courses
-     * - Course level: Average grade for a specific course
-     * - Learner level: Average grade for a specific learner
-     * - Course-learner level: Grade for a specific learner in a specific course
-     *
-     * Query Parameters:
-     * course_id (str, optional): Filter by course ID
-     * learner_id (str, optional): Filter by username or email
-     *
-     * Returns:
-     * The average grade value based on the specified filters.
-     *
-     * Access Control:
-     * - Platform admins can access any grade data
-     * - Learners can access their own grade data
-     * @returns Average
-     * @throws ApiError
-     */
-    static overviewOrgsAverageGradeRetrieve({ org, departmentId, format, includeMainPlatform, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-    }): CancelablePromise<Average>;
-    /**
-     * Get course completion summary metrics over time.
-     *
-     * This endpoint provides completion statistics across the platform over a
-     * specified time period, including daily completion counts and overall metrics.
-     *
-     * Query Parameters:
-     * start_date (str): Start date for the time range (ISO format)
-     * end_date (str): End date for the time range (ISO format)
-     *
-     * Returns:
-     * Completion data including:
-     * - Daily completion counts over time
-     * - Total unique user count
-     * - Total completion count
-     * - Completion percentage
-     * - Change metrics compared to previous periods
-     *
-     * Default time range is the last 7 days if no dates are specified.
-     * @returns CourseCompletionSummaryOvertime
-     * @throws ApiError
-     */
-    static overviewOrgsCoursesCompletionsRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<CourseCompletionSummaryOvertime>;
-    /**
-     * List all learners on the platform with aggregated metrics.
-     *
-     * This endpoint returns a paginated list of all learners with key metrics including:
-     * - Enrollment counts
-     * - Completion counts
-     * - Time spent on platform
-     *
-     * Query Parameters:
-     * page (int): Page number for pagination
-     * length (int): Number of items per page
-     * search (str): Filter learners by username, email, or name
-     *
-     * Returns:
-     * A paginated list of learners with their associated metrics.
-     * @returns PerlearnerUserList
-     * @throws ApiError
-     */
-    static overviewOrgsLearnersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * Size of data to return
-         */
-        length?: number;
-        /**
-         * Page offset
-         */
-        page?: number;
-        /**
-         * Search string for learner
-         */
-        search?: string;
-    }): CancelablePromise<PerlearnerUserList>;
-    /**
-     * Get time spent statistics on a per-course basis.
-     *
-     * This endpoint provides a paginated list of courses with the total time
-     * spent by users in each course.
-     *
-     * Query Parameters:
-     * start_date (str, optional): Start date for filtering (ISO format)
-     * end_date (str, optional): End date for filtering (ISO format)
-     * page (int, optional): Page number for pagination
-     * length (int, optional): Number of items per page
-     *
-     * Returns:
-     * A paginated list of courses with:
-     * - Course identification (ID and name)
-     * - Total time spent (in seconds)
-     * - Formatted time spent (human-readable)
-     * - Percentage of total platform time
-     * @returns TimeSpentPerCourse
-     * @throws ApiError
-     */
-    static overviewOrgsMostActiveCoursesRetrieve({ org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * Size of data to return
-         */
-        length?: number;
-        /**
-         * Page offset
-         */
-        page?: number;
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<TimeSpentPerCourse>;
-    /**
-     * Get registered user counts over time.
-     *
-     * This endpoint provides daily counts of new user registrations over a
-     * specified time period.
-     *
-     * Query Parameters:
-     * start_date (str, optional): Start date for the time range (ISO format)
-     * end_date (str, optional): End date for the time range (ISO format)
-     *
-     * Returns:
-     * Daily registration counts over the specified time period, with change metrics
-     * compared to previous periods.
-     *
-     * Default time range is the last 7 days if no dates are specified.
-     * @returns OvertimeWithChangeInfo
-     * @throws ApiError
-     */
-    static overviewOrgsRegisteredUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<OvertimeWithChangeInfo>;
-}

package/dist/types/services/PerformanceService.d.ts

@@ -1,259 +0,0 @@
-import type { Average } from '../models/Average';
-import type { AvgCourseGradeWithCutoff } from '../models/AvgCourseGradeWithCutoff';
-import type { CourseGradeSummary } from '../models/CourseGradeSummary';
-import type { CourseGradingDetail } from '../models/CourseGradingDetail';
-import type { GradingPerUser } from '../models/GradingPerUser';
-import type { PerformanceGradesPerCourse } from '../models/PerformanceGradesPerCourse';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class PerformanceService {
-    /**
-     * Get average grade value for platform, course, or user.
-     *
-     * This endpoint returns the average grade at different levels:
-     * - Platform level: Average grade across all courses
-     * - Course level: Average grade for a specific course
-     * - Learner level: Average grade for a specific learner
-     * - Course-learner level: Grade for a specific learner in a specific course
-     *
-     * Query Parameters:
-     * course_id (str, optional): Filter by course ID
-     * learner_id (str, optional): Filter by username or email
-     *
-     * Returns:
-     * The average grade value based on the specified filters.
-     *
-     * Access Control:
-     * - Platform admins can access any grade data
-     * - Learners can access their own grade data
-     * @returns Average
-     * @throws ApiError
-     */
-    static performanceOrgsCoursesGradingAverageRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
-        courseId: string;
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-    }): CancelablePromise<Average>;
-    /**
-     * Returns average course grade and grade cuttoff
-     *
-     * e.g
-     * ```
-     * {
-         * "data": {
-             * "grade_cutoffs": {
-                 * "A": 90,
-                 * "B": 80,
-                 * "C": 70,
-                 * },
-                 * "average_grade": 50.0,
-                 * }
-                 * }
-                 * ```
-                 *
-                 * Kwargs
-                 * course_id
-                 * @returns AvgCourseGradeWithCutoff
-                 * @throws ApiError
-                 */
-    static performanceOrgsCoursesGradingAverageWithCutoffRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
-        courseId: string;
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-    }): CancelablePromise<AvgCourseGradeWithCutoff>;
-    /**
-     * Grading summary for the entire course overview in a tree-like format
-     *
-     * Kwargs
-     * course_id <required>
-     * @returns CourseGradingDetail
-     * @throws ApiError
-     */
-    static performanceOrgsCoursesGradingDetailRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
-        courseId: string;
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-    }): CancelablePromise<CourseGradingDetail>;
-    /**
-     * Grading information per enrolled user in a course
-     *
-     * Kwargs
-     * course_id <required>
-     * @returns GradingPerUser
-     * @throws ApiError
-     */
-    static performanceOrgsCoursesGradingPerLearnerRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
-        courseId: string;
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-    }): CancelablePromise<GradingPerUser>;
-    /**
-     * Returns average grades across various assignment types in a course
-     *
-     * Query Params
-     * course_id
-     *
-     * Returns:
-     * dict
-     * {
-         * "data": [
-             * {
-                 * "assignment_type': <str>,
-                 * "weight": <float>,
-                 * "average_weighted_grade": <float>,
-                 * "average_section_grade": <float>
-                 * }, ...
-                 * ]
-                 * }
-                 * @returns CourseGradeSummary
-                 * @throws ApiError
-                 */
-    static performanceOrgsCoursesGradingSummaryRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
-        courseId: string;
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-    }): CancelablePromise<CourseGradeSummary>;
-    /**
-     * Get average grade value for platform, course, or user.
-     *
-     * This endpoint returns the average grade at different levels:
-     * - Platform level: Average grade across all courses
-     * - Course level: Average grade for a specific course
-     * - Learner level: Average grade for a specific learner
-     * - Course-learner level: Grade for a specific learner in a specific course
-     *
-     * Query Parameters:
-     * course_id (str, optional): Filter by course ID
-     * learner_id (str, optional): Filter by username or email
-     *
-     * Returns:
-     * The average grade value based on the specified filters.
-     *
-     * Access Control:
-     * - Platform admins can access any grade data
-     * - Learners can access their own grade data
-     * @returns Average
-     * @throws ApiError
-     */
-    static performanceOrgsGradingAverageRetrieve({ org, departmentId, format, includeMainPlatform, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-    }): CancelablePromise<Average>;
-    /**
-     * List grade-related performance data for all courses.
-     *
-     * This endpoint provides a comprehensive view of grade performance across
-     * courses, including enrollment counts, pass rates, and average grades.
-     *
-     * Returns:
-     * A paginated list of courses with:
-     * - Course identification (ID and name)
-     * - Enrollment count
-     * - Number of students who passed
-     * - Average grade
-     * @returns PerformanceGradesPerCourse
-     * @throws ApiError
-     */
-    static performanceOrgsGradingPerCourseRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * Size of data to return
-         */
-        length?: number;
-        /**
-         * Page offset
-         */
-        page?: number;
-    }): CancelablePromise<PerformanceGradesPerCourse>;
-}