@iblai/iblai-api 3.34.5-core

package/src/services/SkillsService.ts

@@ -0,0 +1,521 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { DesiredSkill } from '../models/DesiredSkill';
+import type { PatchedSkillThreshold } from '../models/PatchedSkillThreshold';
+import type { PointsPercentile } from '../models/PointsPercentile';
+import type { ReportedSkill } from '../models/ReportedSkill';
+import type { SkillDetail } from '../models/SkillDetail';
+import type { SkillInfo } from '../models/SkillInfo';
+import type { SkillThreshold } from '../models/SkillThreshold';
+import type { UserSkill } from '../models/UserSkill';
+import type { UserSkillPointsPercentile } from '../models/UserSkillPointsPercentile';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class SkillsService {
+    /**
+     * List all available skills on the platform.
+     *
+     * This endpoint returns information about all skills that can be
+     * acquired on the platform.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     *
+     * Returns:
+     * A list of all skills with basic information about each skill.
+     *
+     * Access Control:
+     * - Platform admins can access this information
+     * - All authenticated users can access this information
+     * @param org
+     * @returns SkillInfo
+     * @throws ApiError
+     */
+    public static skillsOrgsSkillsList(
+        org: string,
+    ): CancelablePromise<Array<SkillInfo>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/skills/orgs/{org}/skills',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Retrieve percentile distribution for a specific skill.
+     *
+     * This endpoint returns the percentile distribution of points earned
+     * by users for a specific skill.
+     *
+     * Path Parameters:
+     * skill_id (int): The ID of the skill to retrieve percentile information for
+     * org (str, optional): The platform/organization identifier to filter results
+     *
+     * Returns:
+     * A list of percentile breakpoints for the specified skill.
+     *
+     * Error Responses:
+     * 404 Not Found: If the specified skill doesn't exist
+     *
+     * Access Control:
+     * - Platform admins can access this information
+     * - All authenticated users can access this information
+     * @param org
+     * @param skillId
+     * @returns PointsPercentile
+     * @throws ApiError
+     */
+    public static skillsOrgsSkillsPercentileRetrieve(
+        org: string,
+        skillId: number,
+    ): CancelablePromise<PointsPercentile> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/skills/orgs/{org}/skills/{skill_id}/percentile/',
+            path: {
+                'org': org,
+                'skill_id': skillId,
+            },
+        });
+    }
+    /**
+     * Retrieve detailed information about a specific skill.
+     *
+     * This endpoint returns comprehensive information about a specific skill,
+     * including its description, categories, and related courses.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     * skill_name (str): The name of the skill to retrieve details for
+     *
+     * Returns:
+     * Detailed information about the specified skill.
+     *
+     * Error Responses:
+     * 404 Not Found: If the specified skill doesn't exist
+     *
+     * Access Control:
+     * - Platform admins can access this information
+     * - All authenticated users can access this information
+     * @param org
+     * @param skillName
+     * @returns SkillDetail
+     * @throws ApiError
+     */
+    public static skillsOrgsSkillsRetrieve(
+        org: string,
+        skillName: string,
+    ): CancelablePromise<SkillDetail> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/skills/orgs/{org}/skills/{skill_name}/',
+            path: {
+                'org': org,
+                'skill_name': skillName,
+            },
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @returns PointsPercentile
+     * @throws ApiError
+     */
+    public static skillsOrgsSkillsPercentileList(
+        org: string,
+    ): CancelablePromise<Array<PointsPercentile>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/skills/orgs/{org}/skills/percentile/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Manage skill thresholds for a platform.
+     *
+     * This endpoint allows platform administrators to view, create, update, and delete
+     * skill thresholds. Skill thresholds define the minimum points required to consider
+     * a skill as acquired or mastered.
+     *
+     * Path Parameters:
+     * org (str): The platform/organization identifier
+     *
+     * Methods:
+     * GET: Retrieve all skill thresholds for the platform
+     * POST: Create a new skill threshold
+     * PATCH: Update an existing skill threshold
+     * DELETE: Delete all skill thresholds for the platform
+     *
+     * Request Body (POST):
+     * name (str, required): The name of the threshold level (e.g., "Beginner", "Intermediate")
+     * threshold (int, required): The minimum points required to reach this threshold
+     *
+     * Request Body (PATCH):
+     * name (str, required): The name of the existing threshold to update
+     * threshold (int, required): The new minimum points value for this threshold
+     *
+     * Returns:
+     * GET: A list of all skill thresholds for the platform
+     * POST/PATCH: The created or updated skill threshold with format:
+     * {
+         * "name": "threshold_name",
+         * "threshold": threshold_value
+         * }
+         * DELETE: No content (204)
+         *
+         * Error Responses:
+         * 400 Bad Request: If the request data is invalid or missing required fields
+         * 404 Not Found: If the specified platform doesn't exist or the threshold
+         * to update cannot be found
+         *
+         * Access Control:
+         * - Only platform administrators can access this endpoint
+         * @param org
+         * @returns SkillThreshold
+         * @throws ApiError
+         */
+        public static skillsOrgsSkillsThresholdsRetrieve(
+            org: string,
+        ): CancelablePromise<SkillThreshold> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/skills/orgs/{org}/skills/thresholds/',
+                path: {
+                    'org': org,
+                },
+            });
+        }
+        /**
+         * Manage skill thresholds for a platform.
+         *
+         * This endpoint allows platform administrators to view, create, update, and delete
+         * skill thresholds. Skill thresholds define the minimum points required to consider
+         * a skill as acquired or mastered.
+         *
+         * Path Parameters:
+         * org (str): The platform/organization identifier
+         *
+         * Methods:
+         * GET: Retrieve all skill thresholds for the platform
+         * POST: Create a new skill threshold
+         * PATCH: Update an existing skill threshold
+         * DELETE: Delete all skill thresholds for the platform
+         *
+         * Request Body (POST):
+         * name (str, required): The name of the threshold level (e.g., "Beginner", "Intermediate")
+         * threshold (int, required): The minimum points required to reach this threshold
+         *
+         * Request Body (PATCH):
+         * name (str, required): The name of the existing threshold to update
+         * threshold (int, required): The new minimum points value for this threshold
+         *
+         * Returns:
+         * GET: A list of all skill thresholds for the platform
+         * POST/PATCH: The created or updated skill threshold with format:
+         * {
+             * "name": "threshold_name",
+             * "threshold": threshold_value
+             * }
+             * DELETE: No content (204)
+             *
+             * Error Responses:
+             * 400 Bad Request: If the request data is invalid or missing required fields
+             * 404 Not Found: If the specified platform doesn't exist or the threshold
+             * to update cannot be found
+             *
+             * Access Control:
+             * - Only platform administrators can access this endpoint
+             * @param org
+             * @param requestBody
+             * @returns SkillThreshold
+             * @throws ApiError
+             */
+            public static skillsOrgsSkillsThresholdsCreate(
+                org: string,
+                requestBody: SkillThreshold,
+            ): CancelablePromise<SkillThreshold> {
+                return __request(OpenAPI, {
+                    method: 'POST',
+                    url: '/api/skills/orgs/{org}/skills/thresholds/',
+                    path: {
+                        'org': org,
+                    },
+                    body: requestBody,
+                    mediaType: 'application/json',
+                });
+            }
+            /**
+             * Manage skill thresholds for a platform.
+             *
+             * This endpoint allows platform administrators to view, create, update, and delete
+             * skill thresholds. Skill thresholds define the minimum points required to consider
+             * a skill as acquired or mastered.
+             *
+             * Path Parameters:
+             * org (str): The platform/organization identifier
+             *
+             * Methods:
+             * GET: Retrieve all skill thresholds for the platform
+             * POST: Create a new skill threshold
+             * PATCH: Update an existing skill threshold
+             * DELETE: Delete all skill thresholds for the platform
+             *
+             * Request Body (POST):
+             * name (str, required): The name of the threshold level (e.g., "Beginner", "Intermediate")
+             * threshold (int, required): The minimum points required to reach this threshold
+             *
+             * Request Body (PATCH):
+             * name (str, required): The name of the existing threshold to update
+             * threshold (int, required): The new minimum points value for this threshold
+             *
+             * Returns:
+             * GET: A list of all skill thresholds for the platform
+             * POST/PATCH: The created or updated skill threshold with format:
+             * {
+                 * "name": "threshold_name",
+                 * "threshold": threshold_value
+                 * }
+                 * DELETE: No content (204)
+                 *
+                 * Error Responses:
+                 * 400 Bad Request: If the request data is invalid or missing required fields
+                 * 404 Not Found: If the specified platform doesn't exist or the threshold
+                 * to update cannot be found
+                 *
+                 * Access Control:
+                 * - Only platform administrators can access this endpoint
+                 * @param org
+                 * @param requestBody
+                 * @returns SkillThreshold
+                 * @throws ApiError
+                 */
+                public static skillsOrgsSkillsThresholdsPartialUpdate(
+                    org: string,
+                    requestBody?: PatchedSkillThreshold,
+                ): CancelablePromise<SkillThreshold> {
+                    return __request(OpenAPI, {
+                        method: 'PATCH',
+                        url: '/api/skills/orgs/{org}/skills/thresholds/',
+                        path: {
+                            'org': org,
+                        },
+                        body: requestBody,
+                        mediaType: 'application/json',
+                    });
+                }
+                /**
+                 * Manage skill thresholds for a platform.
+                 *
+                 * This endpoint allows platform administrators to view, create, update, and delete
+                 * skill thresholds. Skill thresholds define the minimum points required to consider
+                 * a skill as acquired or mastered.
+                 *
+                 * Path Parameters:
+                 * org (str): The platform/organization identifier
+                 *
+                 * Methods:
+                 * GET: Retrieve all skill thresholds for the platform
+                 * POST: Create a new skill threshold
+                 * PATCH: Update an existing skill threshold
+                 * DELETE: Delete all skill thresholds for the platform
+                 *
+                 * Request Body (POST):
+                 * name (str, required): The name of the threshold level (e.g., "Beginner", "Intermediate")
+                 * threshold (int, required): The minimum points required to reach this threshold
+                 *
+                 * Request Body (PATCH):
+                 * name (str, required): The name of the existing threshold to update
+                 * threshold (int, required): The new minimum points value for this threshold
+                 *
+                 * Returns:
+                 * GET: A list of all skill thresholds for the platform
+                 * POST/PATCH: The created or updated skill threshold with format:
+                 * {
+                     * "name": "threshold_name",
+                     * "threshold": threshold_value
+                     * }
+                     * DELETE: No content (204)
+                     *
+                     * Error Responses:
+                     * 400 Bad Request: If the request data is invalid or missing required fields
+                     * 404 Not Found: If the specified platform doesn't exist or the threshold
+                     * to update cannot be found
+                     *
+                     * Access Control:
+                     * - Only platform administrators can access this endpoint
+                     * @param org
+                     * @returns void
+                     * @throws ApiError
+                     */
+                    public static skillsOrgsSkillsThresholdsDestroy(
+                        org: string,
+                    ): CancelablePromise<void> {
+                        return __request(OpenAPI, {
+                            method: 'DELETE',
+                            url: '/api/skills/orgs/{org}/skills/thresholds/',
+                            path: {
+                                'org': org,
+                            },
+                        });
+                    }
+                    /**
+                     * Retrieve a user's skill information.
+                     *
+                     * This endpoint returns information about skills that a user has acquired
+                     * through the platform. It can return all skills or filter by a specific skill.
+                     *
+                     * Path Parameters:
+                     * org (str): The platform/organization identifier
+                     * user_id (str): The username of the user to retrieve skill information for
+                     *
+                     * Query Parameters:
+                     * skill_name (str, optional): Filter results to a specific skill
+                     *
+                     * Returns:
+                     * When skill_name is provided:
+                     * Details about the specific skill including points earned and percentile ranking
+                     *
+                     * When skill_name is not provided:
+                     * A list of all skills the user has acquired with their points
+                     *
+                     * Access Control:
+                     * - Platform admins can access any user's skill information
+                     * - Users can access their own skill information
+                     * @param org
+                     * @param userId
+                     * @returns UserSkill
+                     * @throws ApiError
+                     */
+                    public static skillsOrgsSkillsUsersRetrieve(
+                        org: string,
+                        userId: string,
+                    ): CancelablePromise<UserSkill> {
+                        return __request(OpenAPI, {
+                            method: 'GET',
+                            url: '/api/skills/orgs/{org}/skills/users/{user_id}/',
+                            path: {
+                                'org': org,
+                                'user_id': userId,
+                            },
+                        });
+                    }
+                    /**
+                     * Retrieve a user's desired skills.
+                     *
+                     * This endpoint returns the skills that a user has indicated they want
+                     * to develop or acquire through the platform.
+                     *
+                     * Path Parameters:
+                     * org (str): The platform/organization identifier
+                     * user_id (str): The username of the user to retrieve skill information for
+                     *
+                     * Returns:
+                     * The user's desired skills information.
+                     *
+                     * Error Responses:
+                     * 400 Bad Request: If the user doesn't exist in the platform or has no desired skills
+                     * 404 Not Found: If the specified platform doesn't exist
+                     *
+                     * Access Control:
+                     * - Platform admins can access any user's information
+                     * - Users can access their own information
+                     * @param org
+                     * @param userId
+                     * @returns DesiredSkill
+                     * @throws ApiError
+                     */
+                    public static skillsOrgsSkillsUsersDesiredSkillsRetrieve(
+                        org: string,
+                        userId: string,
+                    ): CancelablePromise<DesiredSkill> {
+                        return __request(OpenAPI, {
+                            method: 'GET',
+                            url: '/api/skills/orgs/{org}/skills/users/{user_id}/desired-skills/',
+                            path: {
+                                'org': org,
+                                'user_id': userId,
+                            },
+                        });
+                    }
+                    /**
+                     * Retrieve a user's total skill points and percentile ranking.
+                     *
+                     * This endpoint returns the total skill points a user has earned across
+                     * all skills and their percentile ranking compared to other users on the platform.
+                     *
+                     * Path Parameters:
+                     * org (str): The platform/organization identifier
+                     * user_id (str): The username of the user to retrieve information for
+                     *
+                     * Returns:
+                     * The user's total skill points and percentile ranking information:
+                     * - Username
+                     * - Total points earned across all skills
+                     * - Percentile ranking compared to other users
+                     *
+                     * Access Control:
+                     * - Platform admins can access any user's information
+                     * - Users can access their own information
+                     * @param org
+                     * @param userId
+                     * @returns UserSkillPointsPercentile
+                     * @throws ApiError
+                     */
+                    public static skillsOrgsSkillsUsersPointPercentileRetrieve(
+                        org: string,
+                        userId: string,
+                    ): CancelablePromise<UserSkillPointsPercentile> {
+                        return __request(OpenAPI, {
+                            method: 'GET',
+                            url: '/api/skills/orgs/{org}/skills/users/{user_id}/point-percentile/',
+                            path: {
+                                'org': org,
+                                'user_id': userId,
+                            },
+                        });
+                    }
+                    /**
+                     * Retrieve a user's self-reported skills.
+                     *
+                     * This endpoint returns the skills that a user has reported having
+                     * prior to or outside of the platform learning experience.
+                     *
+                     * Path Parameters:
+                     * org (str): The platform/organization identifier
+                     * user_id (str): The username of the user to retrieve skill information for
+                     *
+                     * Returns:
+                     * The user's self-reported skills information.
+                     *
+                     * Error Responses:
+                     * 400 Bad Request: If the user doesn't exist in the platform or has no reported skills
+                     * 404 Not Found: If the specified platform doesn't exist
+                     *
+                     * Access Control:
+                     * - Platform admins can access any user's information
+                     * - Users can access their own information
+                     * @param org
+                     * @param userId
+                     * @returns ReportedSkill
+                     * @throws ApiError
+                     */
+                    public static skillsOrgsSkillsUsersReportedSkillsRetrieve(
+                        org: string,
+                        userId: string,
+                    ): CancelablePromise<ReportedSkill> {
+                        return __request(OpenAPI, {
+                            method: 'GET',
+                            url: '/api/skills/orgs/{org}/skills/users/{user_id}/reported-skills/',
+                            path: {
+                                'org': org,
+                                'user_id': userId,
+                            },
+                        });
+                    }
+                }

package/src/services/UserGroupsService.ts

@@ -0,0 +1,91 @@
+/* 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 UserGroupsService {
+    /**
+     * Get a list of user groups with metrics and filtering options.
+     *
+     * This endpoint provides a paginated list of user groups with aggregated metrics
+     * about learner performance, course completions, and skill acquisition.
+     *
+     * This endpoint uses DM token authentication and respects department-based
+     * access controls.
+     *
+     * 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
+     * groups (list, optional): Filter by group names
+     * location (str, optional): Filter by location
+     * is_enrolled (bool, optional): Filter for groups 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 user groups with comprehensive metrics.
+     *
+     * Access Control:
+     * - Platform admins can see all groups
+     * - Department admins can only see groups in their departments
+     * @param key
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate Filter by learners date_joined. Start date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param groups Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
+     * @param includeMainPlatform Include main platform data
+     * @param isEnrolled Filter for users who have at least an enrollment
+     * @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 userGroupsOrgsRetrieve(
+        key: string,
+        departmentId?: number,
+        endDate?: string,
+        format: 'json' = 'json',
+        groups?: Array<string>,
+        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/user-groups/orgs/{key}/',
+            path: {
+                'key': key,
+            },
+            query: {
+                'department_id': departmentId,
+                'end_date': endDate,
+                'format': format,
+                'groups': groups,
+                'include_main_platform': includeMainPlatform,
+                'is_enrolled': isEnrolled,
+                'length': length,
+                'location': location,
+                'page': page,
+                'pathway': pathway,
+                'program': program,
+                'start_date': startDate,
+            },
+        });
+    }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "preserveConstEnums": false,
+    "strict": true,
+    "declaration": true,
+    "declarationDir": "dist/types"
+  },
+  "include": ["src"]
+}