@iblai/iblai-api 3.34.5-core

package/src/services/DepartmentsService.ts

@@ -0,0 +1,85 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { GroupList } from '../models/GroupList';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export 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
+     */
+    public static departmentsOrgsRetrieve(
+        org: string,
+        departmentId?: number,
+        departments?: Array<string>,
+        endDate?: string,
+        format: 'json' = 'json',
+        includeMainPlatform: boolean = true,
+        isEnrolled?: boolean | null,
+        length?: number,
+        location?: string,
+        page?: number,
+        pathway?: string,
+        program?: string,
+        startDate?: string,
+    ): CancelablePromise<GroupList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/departments/orgs/{org}/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'department_id': departmentId,
+                'departments': departments,
+                'end_date': endDate,
+                'format': format,
+                'include_main_platform': includeMainPlatform,
+                'is_enrolled': isEnrolled,
+                'length': length,
+                'location': location,
+                'page': page,
+                'pathway': pathway,
+                'program': program,
+                'start_date': startDate,
+            },
+        });
+    }
+}