@iblai/iblai-api 0.0.1-core

package/src/services/AudienceService.ts

@@ -0,0 +1,602 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ActiveUsersList } from '../models/ActiveUsersList';
+import type { ActiveUsersPerCourse } from '../models/ActiveUsersPerCourse';
+import type { Enrollments } from '../models/Enrollments';
+import type { EnrollmentsPerUser } from '../models/EnrollmentsPerUser';
+import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
+import type { PerlearnerUserList } from '../models/PerlearnerUserList';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class AudienceService {
+    /**
+     * 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.
+     * @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
+     */
+    public static audienceOrgsActiveUsersOverTimeRetrieve(
+        org: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OvertimeWithChangeInfo> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/active-users/over-time',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Get active user counts on a per-course basis.
+     *
+     * This endpoint provides counts of active users for each course within
+     * the specified date range.
+     *
+     * Query Parameters:
+     * start_date (str, optional): Start date for filtering (ISO format)
+     * end_date (str, optional): End date for filtering (ISO format)
+     *
+     * Returns:
+     * A list of courses with their active user counts.
+     *
+     * 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 ActiveUsersPerCourse
+     * @throws ApiError
+     */
+    public static audienceOrgsActiveUsersPerCourseRetrieve(
+        org: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<ActiveUsersPerCourse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/active-users/per-course',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Get a list of active users with activity metrics.
+     *
+     * This endpoint provides a paginated list of users who have had activity
+     * within the specified date range.
+     *
+     * Query Parameters:
+     * start_date (str, optional): Start date for filtering (ISO format)
+     * end_date (str, optional): End date for filtering (ISO format)
+     * course_id (str, optional): Filter by course ID
+     * page (int, optional): Page number for pagination
+     * length (int, optional): Number of items per page
+     *
+     * Returns:
+     * A paginated list of active users with their activity metrics.
+     *
+     * 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 format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param length Size of data to return
+     * @param page Page offset
+     * @returns ActiveUsersList
+     * @throws ApiError
+     */
+    public static audienceOrgsActiveUsersUsersRetrieve(
+        org: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        length?: number,
+        page?: number,
+    ): CancelablePromise<ActiveUsersList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/active-users/users',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'length': length,
+                'page': page,
+            },
+        });
+    }
+    /**
+     * Get enrollment or unenrollment counts over time.
+     *
+     * This endpoint provides daily counts of new enrollments or unenrollments
+     * 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)
+     * course_id (str, optional): Filter by course ID
+     * active (bool): Get enrollments when true, unenrollments when false
+     *
+     * Returns:
+     * Daily 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.
+     * @param courseId
+     * @param org
+     * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
+     *
+     * * `y` - y
+     * * `yes` - yes
+     * * `true` - true
+     * * `True` - True
+     * * `n` - n
+     * * `no` - no
+     * * `false` - false
+     * * `False` - False
+     * @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
+     */
+    public static audienceOrgsEnrollmentsCoursesOverTimeRetrieve(
+        courseId: string,
+        org: string,
+        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OvertimeWithChangeInfo> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/enrollments/courses/{course_id}/over-time',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+            query: {
+                'active': active,
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * List users enrolled in a specific course.
+     *
+     * This endpoint provides a list of users who are enrolled or unenrolled
+     * in a specified course.
+     *
+     * Query Parameters:
+     * course_id (str): The course ID to get enrollments for
+     * active (bool): Filter for active enrollments when true, inactive when false
+     * page (int, optional): Page number for pagination
+     * length (int, optional): Number of items per page
+     *
+     * Returns:
+     * A paginated list of users with:
+     * - Username
+     * - Full name
+     * - Email
+     * - Enrollment timestamp
+     * @param courseId
+     * @param org
+     * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
+     *
+     * * `y` - y
+     * * `yes` - yes
+     * * `true` - true
+     * * `True` - True
+     * * `n` - n
+     * * `no` - no
+     * * `false` - false
+     * * `False` - False
+     * @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 EnrollmentsPerUser
+     * @throws ApiError
+     */
+    public static audienceOrgsEnrollmentsCoursesUsersRetrieve(
+        courseId: string,
+        org: string,
+        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        length?: number,
+        page?: number,
+        startDate?: string,
+    ): CancelablePromise<EnrollmentsPerUser> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/enrollments/courses/{course_id}/users',
+            path: {
+                'course_id': courseId,
+                'org': org,
+            },
+            query: {
+                'active': active,
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'length': length,
+                'page': page,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * Get enrollment or unenrollment counts over time.
+     *
+     * This endpoint provides daily counts of new enrollments or unenrollments
+     * 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)
+     * course_id (str, optional): Filter by course ID
+     * active (bool): Get enrollments when true, unenrollments when false
+     *
+     * Returns:
+     * Daily 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.
+     * @param org
+     * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
+     *
+     * * `y` - y
+     * * `yes` - yes
+     * * `true` - true
+     * * `True` - True
+     * * `n` - n
+     * * `no` - no
+     * * `false` - false
+     * * `False` - False
+     * @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
+     */
+    public static audienceOrgsEnrollmentsOverTimeRetrieve(
+        org: string,
+        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OvertimeWithChangeInfo> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/enrollments/over-time',
+            path: {
+                'org': org,
+            },
+            query: {
+                'active': active,
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * List enrollment statistics on a per-course basis.
+     *
+     * This endpoint provides enrollment counts for all courses, with options
+     * to filter for active or inactive enrollments and to include time-based data.
+     *
+     * Query Parameters:
+     * active (bool): Filter for active enrollments when true, inactive when false
+     * start_date (str, optional): Start date for time-based filtering (ISO format)
+     * end_date (str, optional): End date for time-based 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 their enrollment counts and percentages.
+     * @param org
+     * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
+     *
+     * * `y` - y
+     * * `yes` - yes
+     * * `true` - true
+     * * `True` - True
+     * * `n` - n
+     * * `no` - no
+     * * `false` - false
+     * * `False` - False
+     * @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 Enrollments
+     * @throws ApiError
+     */
+    public static audienceOrgsEnrollmentsPerCourseRetrieve(
+        org: string,
+        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        length?: number,
+        page?: number,
+        startDate?: string,
+    ): CancelablePromise<Enrollments> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/enrollments/per-course',
+            path: {
+                'org': org,
+            },
+            query: {
+                'active': active,
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'length': length,
+                'page': page,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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.
+     * @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
+     * @param search Search string for learner
+     * @returns PerlearnerUserList
+     * @throws ApiError
+     */
+    public static audienceOrgsRegisteredUsersRetrieve(
+        org: string,
+        departmentId?: number,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        length?: number,
+        page?: number,
+        search?: string,
+    ): CancelablePromise<PerlearnerUserList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/registered-users/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'length': length,
+                'page': page,
+                'search': search,
+            },
+        });
+    }
+    /**
+     * 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.
+     * @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
+     */
+    public static audienceOrgsRegisteredUsersOverTimeRetrieve(
+        org: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        startDate?: string,
+    ): CancelablePromise<OvertimeWithChangeInfo> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/registered-users/over-time',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * List enrollment statistics on a per-course basis.
+     *
+     * This endpoint provides enrollment counts for all courses, with options
+     * to filter for active or inactive enrollments and to include time-based data.
+     *
+     * Query Parameters:
+     * active (bool): Filter for active enrollments when true, inactive when false
+     * start_date (str, optional): Start date for time-based filtering (ISO format)
+     * end_date (str, optional): End date for time-based 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 their enrollment counts and percentages.
+     * @param org
+     * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
+     *
+     * * `y` - y
+     * * `yes` - yes
+     * * `true` - true
+     * * `True` - True
+     * * `n` - n
+     * * `no` - no
+     * * `false` - false
+     * * `False` - False
+     * @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 Enrollments
+     * @throws ApiError
+     */
+    public static audienceOrgsRegisteredUsersPerCourseRetrieve(
+        org: string,
+        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        length?: number,
+        page?: number,
+        startDate?: string,
+    ): CancelablePromise<Enrollments> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/audience/orgs/{org}/registered-users/per-course',
+            path: {
+                'org': org,
+            },
+            query: {
+                'active': active,
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'length': length,
+                'page': page,
+                'start_date': startDate,
+            },
+        });
+    }
+}