@iblai/iblai-api 0.0.2-core → 0.0.12-scan-core

package/src/services/DepartmentsService.ts

@@ -27,39 +27,76 @@ export class DepartmentsService {
      *
      * 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
      */
-    public static departmentsOrgsRetrieve(
+    public static departmentsOrgsRetrieve({
+        org,
+        departmentId,
+        departments,
+        endDate,
+        format = 'json',
+        includeMainPlatform = true,
+        isEnrolled,
+        length,
+        location,
+        page,
+        pathway,
+        program,
+        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,
+        /**
+         * Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
+         */
         departments?: Array<string>,
+        /**
+         * Filter by learners date_joined. Start date. ISO 8601
+         */
         endDate?: string,
-        format: 'json' = 'json',
-        includeMainPlatform: boolean = true,
+        /**
+         * Format
+         *
+         * * `json` - json
+         */
+        format?: 'json',
+        /**
+         * Include main platform data
+         */
+        includeMainPlatform?: boolean,
+        /**
+         * Filter for users who have at least an enro;lment
+         */
         isEnrolled?: boolean | null,
+        /**
+         * Size of data to return
+         */
         length?: number,
+        /**
+         * Location search string
+         */
         location?: string,
+        /**
+         * Page offset
+         */
         page?: number,
+        /**
+         * Pathway string
+         */
         pathway?: string,
+        /**
+         * Program search string
+         */
         program?: string,
+        /**
+         * Filter by learners date_joined. Start date. ISO 8601
+         */
         startDate?: string,
-    ): CancelablePromise<GroupList> {
+    }): CancelablePromise<GroupList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/departments/orgs/{org}/',