@iblai/iblai-api 3.34.5-core

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

@@ -0,0 +1,43 @@
+import type { GroupList } from '../models/GroupList';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class DepartmentsService {
+    /**
+     * Get a list of departments with metrics and filtering options.
+     *
+     * This endpoint provides a paginated list of departments with aggregated metrics
+     * about learner performance, course completions, and skill acquisition.
+     *
+     * Query Parameters:
+     * page (int, optional): Page number for pagination
+     * length (int, optional): Number of items per page
+     * program (str, optional): Filter by program
+     * pathway (str, optional): Filter by pathway
+     * departments (list, optional): Filter by department ids
+     * department_id (str, optional): Filter by department id
+     * location (str, optional): Filter by location
+     * is_enrolled (bool, optional): Filter for departments with enrolled users
+     * start_date (date, optional): Filter by learner join date (start range)
+     * end_date (date, optional): Filter by learner join date (end range)
+     *
+     * Returns:
+     * A paginated list of departments with comprehensive metrics.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param departments Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
+     * @param endDate Filter by learners date_joined. Start date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param isEnrolled Filter for users who have at least an enro;lment
+     * @param length Size of data to return
+     * @param location Location search string
+     * @param page Page offset
+     * @param pathway Pathway string
+     * @param program Program search string
+     * @param startDate Filter by learners date_joined. Start date. ISO 8601
+     * @returns GroupList
+     * @throws ApiError
+     */
+    static departmentsOrgsRetrieve(org: string, departmentId?: number, departments?: Array<string>, endDate?: string, format?: 'json', includeMainPlatform?: boolean, isEnrolled?: boolean | null, length?: number, location?: string, page?: number, pathway?: string, program?: string, startDate?: string): CancelablePromise<GroupList>;
+}

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

@@ -0,0 +1,467 @@
+import type { AverageOvertime } from '../models/AverageOvertime';
+import type { CourseCompletionPerCourse } from '../models/CourseCompletionPerCourse';
+import type { EngagementPerCourse } from '../models/EngagementPerCourse';
+import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
+import type { OverTimeWithTotal } from '../models/OverTimeWithTotal';
+import type { PerLearnerTimeSpentInCourseTree } from '../models/PerLearnerTimeSpentInCourseTree';
+import type { TimeDetail } from '../models/TimeDetail';
+import type { TimeSpentByUsersInCourse } from '../models/TimeSpentByUsersInCourse';
+import type { TimeSpentPerCourse } from '../models/TimeSpentPerCourse';
+import type { VideoEngagementPerCourse } from '../models/VideoEngagementPerCourse';
+import type { VideosInCourseSummary } from '../models/VideosInCourseSummary';
+import type { VideosSpecificCourse } from '../models/VideosSpecificCourse';
+import type { WatchedVideosPerUser } from '../models/WatchedVideosPerUser';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class EngagementService {
+    /**
+     * Get engagement metrics on a per-course basis.
+     *
+     * This endpoint provides a paginated list of courses with engagement metrics
+     * including activity counts, time spent, and interaction data.
+     *
+     * Query Parameters:
+     * page (int, optional): Page number for pagination
+     * length (int, optional): Number of items per page
+     *
+     * Returns:
+     * A paginated list of courses with their engagement metrics.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @returns EngagementPerCourse
+     * @throws ApiError
+     */
+    static engagementOrgsActivityRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<EngagementPerCourse>;
+    /**
+     * Completion count per user per course across the platform
+     *
+     * Query Params
+     * 1. start_date e.g 2020-10-01
+     * 2. end_date e.g 2020-10-10
+     *
+     * Default result when no query param is added is last_7_days (today inclusive)
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OvertimeWithChangeInfo
+     * @throws ApiError
+     */
+    static engagementOrgsCourseCompletionOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    /**
+     * List course completion metrics on a per-course basis.
+     *
+     * This endpoint provides a paginated table of courses with enrollment and
+     * completion statistics for each course.
+     *
+     * Returns:
+     * A paginated list of courses with:
+     * - Course identification (ID and name)
+     * - Enrollment count
+     * - Completion count
+     * - Average completion rate
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @returns CourseCompletionPerCourse
+     * @throws ApiError
+     */
+    static engagementOrgsCourseCompletionPerCourseRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<CourseCompletionPerCourse>;
+    /**
+     * Average time spent in secs on a per-day basis
+     *
+     * Query Params
+     * 1. start_date e.g 2020-10-01
+     * 2. end_date e.g 2020-10-10
+     * 3. course_id <optional>
+     *
+     * Default result when no query param is added is last_7_days (today inclusive)
+     * @param courseId
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns AverageOvertime
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesTimeAverageRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<AverageOvertime>;
+    /**
+     * Time spent per course in secs in a tree like form
+     *
+     * Kwargs
+     * course_id e.g course-v1:Org+Course4+Run
+     *
+     * Query Params
+     * 1. start_date <optional> e.g 2020-10-01
+     * 2. end_date <optional> e.g 2020-10-10
+     * @param courseId
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @returns TimeDetail
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesTimeDetailRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<TimeDetail>;
+    /**
+     * Time spent per course in secs on a per-day basis
+     *
+     * Query Params
+     * 1. start_date e.g 2020-10-01
+     * 2. end_date e.g 2020-10-10
+     * Kwargs
+     * 3. course_id
+     *
+     * Default result when no query param is added is last_7_days (today inclusive)
+     * @param courseId
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OverTimeWithTotal
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesTimeOverTimeRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    /**
+     * Time spent by users in a course
+     *
+     * Query Params
+     * course_id  e.g course-v1:Org+Course4+Run
+     * @param courseId
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @param startDate start date. ISO 8601
+     * @returns TimeSpentByUsersInCourse
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesTimeUsersRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<TimeSpentByUsersInCourse>;
+    /**
+     * Time spent within a course in ordered hierarchical format
+     *
+     * Kwargs
+     * 1. course_id  e.g course-v1:Org+Course4+Run
+     * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
+     * Query Params
+     * 3. start_date <optional> e.g 2020-10-01
+     * 4. end_date <optional> e.g 2020-10-10
+     * @param courseId
+     * @param org
+     * @param userId
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns PerLearnerTimeSpentInCourseTree
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesTimeUsersDetailRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerLearnerTimeSpentInCourseTree>;
+    /**
+     * Time spent in secs on a per-day basis
+     *
+     * Query Params
+     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
+     * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
+     * 3. start_date e.g 2020-10-01
+     * 4. end_date e.g 2020-10-10
+     *
+     * Default result when no query param is added is last_7_days (today inclusive)
+     * @param courseId
+     * @param org
+     * @param userId
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OverTimeWithTotal
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesTimeUsersOverTimeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    /**
+     * Get video engagement metrics for a specific course.
+     *
+     * This endpoint provides detailed video engagement statistics for a single course,
+     * including view counts, completion rates, and time spent on videos.
+     *
+     * Query Parameters:
+     * course_id (str): The course ID to get video engagement data for
+     *
+     * Returns:
+     * Detailed video engagement metrics for the specified course.
+     * @param courseId
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @returns VideosSpecificCourse
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesVideosRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<VideosSpecificCourse>;
+    /**
+     * Get video watch counts over time.
+     *
+     * This endpoint provides daily counts of videos watched over a specified time period,
+     * with options to filter by course or user.
+     *
+     * 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)
+     * course_id (str, optional): Filter by course ID
+     * user_id (str, optional): Filter by username or email
+     *
+     * Returns:
+     * Daily video watch counts over the specified time period.
+     *
+     * Default time range is the last 7 days if no dates are specified.
+     *
+     * Access Control:
+     * - Platform admins can access any video watch data
+     * - Learners can access their own video watch data
+     * @param courseId
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OverTimeWithTotal
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesVideosOverTimeRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    /**
+     * Get a summary of video watch statistics for a specific course.
+     *
+     * This endpoint provides a structured summary of video watch data for a course,
+     * organized in a tree-like format by course sections and subsections.
+     *
+     * Query Parameters:
+     * course_id (str): The course ID to get video summary for
+     *
+     * Returns:
+     * A hierarchical structure of video watch data for the course, including:
+     * - Section and subsection organization
+     * - Video identification and metadata
+     * - Watch counts and completion rates
+     * @param courseId
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @returns VideosInCourseSummary
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesVideosSummaryRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<VideosInCourseSummary>;
+    /**
+     * List of users' videos completed records for a specific course
+     *
+     * Kwargs
+     * course_id  e.g course-v1:Org+Course4+Run
+     * @param courseId
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @returns WatchedVideosPerUser
+     * @throws ApiError
+     */
+    static engagementOrgsCoursesVideosUsersRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<WatchedVideosPerUser>;
+    /**
+     * Average time spent by a learner in enrolled courses. Gives a rough estimate of whats the average time
+     * that would be spent by a learner in a course
+     *
+     * Query Params
+     * 1. start_date e.g 2020-10-01
+     * 2. end_date e.g 2020-10-10
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns AverageOvertime
+     * @throws ApiError
+     */
+    static engagementOrgsTimeAveragePerlearnerPercourseRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<AverageOvertime>;
+    /**
+     * Average time spent in secs on a per-day basis
+     *
+     * Query Params
+     * 1. start_date e.g 2020-10-01
+     * 2. end_date e.g 2020-10-10
+     * 3. course_id <optional>
+     *
+     * Default result when no query param is added is last_7_days (today inclusive)
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns AverageOvertime
+     * @throws ApiError
+     */
+    static engagementOrgsTimeAverageWithOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<AverageOvertime>;
+    /**
+     * Get time spent on the platform over time.
+     *
+     * This endpoint provides daily time spent values (in seconds) across the
+     * platform 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 time spent values 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.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OvertimeWithChangeInfo
+     * @throws ApiError
+     */
+    static engagementOrgsTimeOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    /**
+     * 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
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @param startDate start date. ISO 8601
+     * @returns TimeSpentPerCourse
+     * @throws ApiError
+     */
+    static engagementOrgsTimePerCourseRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<TimeSpentPerCourse>;
+    /**
+     * Get video engagement metrics on a per-course basis.
+     *
+     * This endpoint provides a paginated list of courses with video engagement metrics
+     * including view counts, completion rates, and time spent on videos.
+     *
+     * Query Parameters:
+     * page (int, optional): Page number for pagination
+     * length (int, optional): Number of items per page
+     *
+     * Returns:
+     * A paginated list of courses with their video engagement metrics.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @returns VideoEngagementPerCourse
+     * @throws ApiError
+     */
+    static engagementOrgsVideosRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<VideoEngagementPerCourse>;
+    /**
+     * Get video watch counts over time.
+     *
+     * This endpoint provides daily counts of videos watched over a specified time period,
+     * with options to filter by course or user.
+     *
+     * 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)
+     * course_id (str, optional): Filter by course ID
+     * user_id (str, optional): Filter by username or email
+     *
+     * Returns:
+     * Daily video watch counts over the specified time period.
+     *
+     * Default time range is the last 7 days if no dates are specified.
+     *
+     * Access Control:
+     * - Platform admins can access any video watch data
+     * - Learners can access their own video watch data
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OverTimeWithTotal
+     * @throws ApiError
+     */
+    static engagementOrgsVideosOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+}

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

@@ -0,0 +1,52 @@
+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
+     * @param org
+     * @returns Product
+     * @throws ApiError
+     */
+    static financeOrgsProductsRetrieve(org: string): CancelablePromise<Product>;
+    /**
+     * Return list of WooCommerce orders for product item_id over optional date range
+     * @param itemId
+     * @param org
+     * @param endDate End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+     * @param startDate Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+     * @returns Order
+     * @throws ApiError
+     */
+    static financeOrgsProductsOrdersRetrieve(itemId: string, org: string, endDate?: string, startDate?: string): CancelablePromise<Order>;
+    /**
+     * Returns Net Revenue over time for org and slug
+     * @param itemId
+     * @param org
+     * @param endDate End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+     * @param startDate Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+     * @returns NetRevenueOverTime
+     * @throws ApiError
+     */
+    static financeOrgsProductsSalesOverTimeRetrieve(itemId: string, org: string, endDate?: string, startDate?: string): CancelablePromise<NetRevenueOverTime>;
+    /**
+     * Returns Net Revenue over time for org and slug
+     * @param org
+     * @param endDate End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+     * @param startDate Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+     * @returns NetRevenueOverTime
+     * @throws ApiError
+     */
+    static financeOrgsRevenueNetOverTimeRetrieve(org: string, endDate?: string, startDate?: string): CancelablePromise<NetRevenueOverTime>;
+    /**
+     * Returns Revenue by Product + summary for specific org
+     * @param org
+     * @param endDate End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+     * @param startDate Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+     * @returns RevenueByProduct
+     * @throws ApiError
+     */
+    static financeOrgsRevenueProductsRetrieve(org: string, endDate?: string, startDate?: string): CancelablePromise<RevenueByProduct>;
+}

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

@@ -0,0 +1,58 @@
+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
+     * @param id
+     * @param platformKey
+     * @param page Page number
+     * @param pageSize Number of items per page
+     * @param search Search recipients by username or email
+     * @returns Recipient
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderRecipientsList(id: string, platformKey: string, page?: number, pageSize?: number, search?: string): CancelablePromise<Array<Recipient>>;
+    /**
+     * Get notification context data
+     * Get all context data needed for notification building including templates, channels, and platforms
+     * @param platformKey
+     * @returns ContextResponse
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderContextRetrieve(platformKey: string): CancelablePromise<ContextResponse>;
+    /**
+     * Preview notification
+     * Preview notification recipients and get build ID for sending
+     * @param platformKey
+     * @param requestBody
+     * @returns PreviewResponse
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderPreviewCreate(platformKey: string, requestBody: NotificationPreview): CancelablePromise<PreviewResponse>;
+    /**
+     * Send notification
+     * Send notifications to all recipients in a build
+     * @param platformKey
+     * @param requestBody
+     * @returns SendResponse
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderSendCreate(platformKey: string, requestBody: SendNotification): CancelablePromise<SendResponse>;
+    /**
+     * Validate notification source
+     * Validate a single notification source (email, username, platform, csv)
+     * @param platformKey
+     * @param requestBody
+     * @returns ValidateSourceResponse
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationBuilderValidateSourceCreate(platformKey: string, requestBody: NotificationSource): CancelablePromise<ValidateSourceResponse>;
+}