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

package/src/services/AudienceService.ts

@@ -29,25 +29,41 @@ export 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
      */
-    public static audienceOrgsActiveUsersOverTimeRetrieve(
+    public static audienceOrgsActiveUsersOverTimeRetrieve({
+        org,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OvertimeWithChangeInfo> {
+    }): CancelablePromise<OvertimeWithChangeInfo> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/active-users/over-time',
@@ -77,25 +93,41 @@ export 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
      */
-    public static audienceOrgsActiveUsersPerCourseRetrieve(
+    public static audienceOrgsActiveUsersPerCourseRetrieve({
+        org,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<ActiveUsersPerCourse> {
+    }): CancelablePromise<ActiveUsersPerCourse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/active-users/per-course',
@@ -128,25 +160,41 @@ export 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
      */
-    public static audienceOrgsActiveUsersUsersRetrieve(
+    public static audienceOrgsActiveUsersUsersRetrieve({
+        org,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+        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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * Size of data to return
+         */
         length?: number,
+        /**
+         * Page offset
+         */
         page?: number,
-    ): CancelablePromise<ActiveUsersList> {
+    }): CancelablePromise<ActiveUsersList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/active-users/users',
@@ -179,38 +227,57 @@ export 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
      */
-    public static audienceOrgsEnrollmentsCoursesOverTimeRetrieve(
+    public static audienceOrgsEnrollmentsCoursesOverTimeRetrieve({
+        courseId,
+        org,
+        active = 'y',
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         courseId: string,
         org: string,
-        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        /**
+         * 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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OvertimeWithChangeInfo> {
+    }): CancelablePromise<OvertimeWithChangeInfo> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/enrollments/courses/{course_id}/over-time',
@@ -246,42 +313,67 @@ export 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
      */
-    public static audienceOrgsEnrollmentsCoursesUsersRetrieve(
+    public static audienceOrgsEnrollmentsCoursesUsersRetrieve({
+        courseId,
+        org,
+        active = 'y',
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        length,
+        page,
+        startDate,
+    }: {
         courseId: string,
         org: string,
-        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        /**
+         * 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',
-        includeMainPlatform: boolean = true,
+        /**
+         * 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> {
+    }): CancelablePromise<EnrollmentsPerUser> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/enrollments/courses/{course_id}/users',
@@ -318,36 +410,55 @@ export 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
      */
-    public static audienceOrgsEnrollmentsOverTimeRetrieve(
+    public static audienceOrgsEnrollmentsOverTimeRetrieve({
+        org,
+        active = 'y',
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        startDate,
+    }: {
         org: string,
-        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        /**
+         * 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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OvertimeWithChangeInfo> {
+    }): CancelablePromise<OvertimeWithChangeInfo> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/enrollments/over-time',
@@ -379,40 +490,65 @@ export 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
      */
-    public static audienceOrgsEnrollmentsPerCourseRetrieve(
+    public static audienceOrgsEnrollmentsPerCourseRetrieve({
+        org,
+        active = 'y',
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        length,
+        page,
+        startDate,
+    }: {
         org: string,
-        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        /**
+         * 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',
-        includeMainPlatform: boolean = true,
+        /**
+         * 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> {
+    }): CancelablePromise<Enrollments> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/enrollments/per-course',
@@ -446,27 +582,46 @@ export 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
      */
-    public static audienceOrgsRegisteredUsersRetrieve(
+    public static audienceOrgsRegisteredUsersRetrieve({
+        org,
+        departmentId,
+        format = 'json',
+        includeMainPlatform = true,
+        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',
-        includeMainPlatform: boolean = true,
+        /**
+         * 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> {
+    }): CancelablePromise<PerlearnerUserList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/registered-users/',
@@ -498,25 +653,41 @@ export 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
      */
-    public static audienceOrgsRegisteredUsersOverTimeRetrieve(
+    public static audienceOrgsRegisteredUsersOverTimeRetrieve({
+        org,
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        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',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<OvertimeWithChangeInfo> {
+    }): CancelablePromise<OvertimeWithChangeInfo> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/registered-users/over-time',
@@ -547,40 +718,65 @@ export 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
      */
-    public static audienceOrgsRegisteredUsersPerCourseRetrieve(
+    public static audienceOrgsRegisteredUsersPerCourseRetrieve({
+        org,
+        active = 'y',
+        departmentId,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        length,
+        page,
+        startDate,
+    }: {
         org: string,
-        active: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False' = 'y',
+        /**
+         * 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',
-        includeMainPlatform: boolean = true,
+        /**
+         * 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> {
+    }): CancelablePromise<Enrollments> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/audience/orgs/{org}/registered-users/per-course',