@iblai/iblai-api 3.48.3-core → 3.48.4-core

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

@@ -23,18 +23,34 @@ export declare class AudienceService {
      * 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
      */
-    static audienceOrgsActiveUsersOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    static audienceOrgsActiveUsersOverTimeRetrieve({ 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 active user counts on a per-course basis.
      *
@@ -49,18 +65,34 @@ export declare class AudienceService {
      * 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
      */
-    static audienceOrgsActiveUsersPerCourseRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<ActiveUsersPerCourse>;
+    static audienceOrgsActiveUsersPerCourseRetrieve({ 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<ActiveUsersPerCourse>;
     /**
      * Get a list of active users with activity metrics.
      *
@@ -78,18 +110,34 @@ export declare class AudienceService {
      * 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
      */
-    static audienceOrgsActiveUsersUsersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<ActiveUsersList>;
+    static audienceOrgsActiveUsersUsersRetrieve({ 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<ActiveUsersList>;
     /**
      * Get enrollment or unenrollment counts over time.
      *
@@ -107,29 +155,48 @@ export declare class AudienceService {
      * 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
      */
-    static audienceOrgsEnrollmentsCoursesOverTimeRetrieve(courseId: string, org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    static audienceOrgsEnrollmentsCoursesOverTimeRetrieve({ courseId, org, active, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        courseId: string;
+        org: string;
+        /**
+         * 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
+         */
+        active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
+        /**
+         * 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>;
     /**
      * List users enrolled in a specific course.
      *
@@ -148,31 +215,56 @@ export declare class AudienceService {
      * - 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
      */
-    static audienceOrgsEnrollmentsCoursesUsersRetrieve(courseId: string, org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<EnrollmentsPerUser>;
+    static audienceOrgsEnrollmentsCoursesUsersRetrieve({ courseId, org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
+        courseId: string;
+        org: string;
+        /**
+         * 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
+         */
+        active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
+        /**
+         * 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<EnrollmentsPerUser>;
     /**
      * Get enrollment or unenrollment counts over time.
      *
@@ -190,28 +282,47 @@ export declare class AudienceService {
      * 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
      */
-    static audienceOrgsEnrollmentsOverTimeRetrieve(org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    static audienceOrgsEnrollmentsOverTimeRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, startDate, }: {
+        org: string;
+        /**
+         * 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
+         */
+        active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
+        /**
+         * 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>;
     /**
      * List enrollment statistics on a per-course basis.
      *
@@ -227,30 +338,55 @@ export declare class AudienceService {
      *
      * 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
      */
-    static audienceOrgsEnrollmentsPerCourseRetrieve(org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<Enrollments>;
+    static audienceOrgsEnrollmentsPerCourseRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
+        org: string;
+        /**
+         * 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
+         */
+        active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
+        /**
+         * 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<Enrollments>;
     /**
      * List all learners on the platform with aggregated metrics.
      *
@@ -266,19 +402,38 @@ export declare class AudienceService {
      *
      * 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
      */
-    static audienceOrgsRegisteredUsersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, search?: string): CancelablePromise<PerlearnerUserList>;
+    static audienceOrgsRegisteredUsersRetrieve({ 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 registered user counts over time.
      *
@@ -294,18 +449,34 @@ export declare class AudienceService {
      * 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 audienceOrgsRegisteredUsersOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
+    static audienceOrgsRegisteredUsersOverTimeRetrieve({ 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>;
     /**
      * List enrollment statistics on a per-course basis.
      *
@@ -321,28 +492,53 @@ export declare class AudienceService {
      *
      * 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
      */
-    static audienceOrgsRegisteredUsersPerCourseRetrieve(org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<Enrollments>;
+    static audienceOrgsRegisteredUsersPerCourseRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
+        org: string;
+        /**
+         * 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
+         */
+        active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
+        /**
+         * 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<Enrollments>;
 }