@iblai/iblai-api 4.251.0-core → 4.252.0-core

package/dist/index.umd.js

@@ -114,7 +114,7 @@
 
     const OpenAPI = {
       BASE: 'https://base.manager.iblai.app',
-      VERSION: '4.251.0-core',
+      VERSION: '4.252.0-core',
       WITH_CREDENTIALS: false,
       CREDENTIALS: 'include',
       TOKEN: undefined,
@@ -279,6 +279,46 @@
       EthnicityEnum["OTHER"] = "other";
     })(exports.EthnicityEnum || (exports.EthnicityEnum = {}));
 
+    /* generated using openapi-typescript-codegen -- do not edit */
+    /* istanbul ignore file */
+    /* tslint:disable */
+    /* eslint-disable */
+    /**
+     * * `USER_NOTIF_COURSE_ENROLLMENT` - Course Enrollment
+     * * `ADMIN_NOTIF_COURSE_ENROLLMENT` - Admin: Course Enrollment
+     * * `USER_NOTIF_USER_INACTIVITY` - User Inactivity
+     * * `USER_NOTIF_COURSE_COMPLETION` - Course Completion
+     * * `USER_NOTIF_CREDENTIALS` - Credentials Issued
+     * * `USER_NOTIF_LEARNER_PROGRESS` - Learner Progress
+     * * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification
+     * * `ACTIVITY_NEW_CONTENT` - New Activity Content
+     * * `ACTIVITY_COURSE_MILESTONE` - Course Milestone Reached
+     * * `SKILL_MASTERY_CHANGE` - Skill Mastery Change
+     * * `PROGRAM_ENROLLMENT_CONFIRMATION` - Program Enrollment Confirmed
+     * * `PATHWAY_ENROLLMENT_CONFIRMATION` - Pathway Enrollment Confirmed
+     * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
+     * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
+     * * `SUBSECTION_GRADE_UPDATE` - Subsection Grade Update
+     */
+    exports.EventsEnum = void 0;
+    (function (EventsEnum) {
+      EventsEnum["USER_NOTIF_COURSE_ENROLLMENT"] = "USER_NOTIF_COURSE_ENROLLMENT";
+      EventsEnum["ADMIN_NOTIF_COURSE_ENROLLMENT"] = "ADMIN_NOTIF_COURSE_ENROLLMENT";
+      EventsEnum["USER_NOTIF_USER_INACTIVITY"] = "USER_NOTIF_USER_INACTIVITY";
+      EventsEnum["USER_NOTIF_COURSE_COMPLETION"] = "USER_NOTIF_COURSE_COMPLETION";
+      EventsEnum["USER_NOTIF_CREDENTIALS"] = "USER_NOTIF_CREDENTIALS";
+      EventsEnum["USER_NOTIF_LEARNER_PROGRESS"] = "USER_NOTIF_LEARNER_PROGRESS";
+      EventsEnum["PROACTIVE_LEARNER_NOTIFICATION"] = "PROACTIVE_LEARNER_NOTIFICATION";
+      EventsEnum["ACTIVITY_NEW_CONTENT"] = "ACTIVITY_NEW_CONTENT";
+      EventsEnum["ACTIVITY_COURSE_MILESTONE"] = "ACTIVITY_COURSE_MILESTONE";
+      EventsEnum["SKILL_MASTERY_CHANGE"] = "SKILL_MASTERY_CHANGE";
+      EventsEnum["PROGRAM_ENROLLMENT_CONFIRMATION"] = "PROGRAM_ENROLLMENT_CONFIRMATION";
+      EventsEnum["PATHWAY_ENROLLMENT_CONFIRMATION"] = "PATHWAY_ENROLLMENT_CONFIRMATION";
+      EventsEnum["COURSE_SCHEDULE_CHANGE"] = "COURSE_SCHEDULE_CHANGE";
+      EventsEnum["COURSES_PROGRESS_SUMMARY"] = "COURSES_PROGRESS_SUMMARY";
+      EventsEnum["SUBSECTION_GRADE_UPDATE"] = "SUBSECTION_GRADE_UPDATE";
+    })(exports.EventsEnum || (exports.EventsEnum = {}));
+
     /* generated using openapi-typescript-codegen -- do not edit */
     /* istanbul ignore file */
     /* tslint:disable */
@@ -17894,6 +17934,529 @@
           }
         });
       }
+      /**
+       * List watched groups visible to the caller
+       * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+       * POST here accepts an optional `watchers` array as a create-time convenience.
+       * @returns PaginatedWatchedGroupListList
+       * @throws ApiError
+       */
+      static coreWatchedGroupsList({
+        limit,
+        offset,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'GET',
+          url: '/api/core/watched-groups/',
+          query: {
+            'limit': limit,
+            'offset': offset,
+            'platform_key': platformKey
+          },
+          errors: {
+            403: `Permission denied`,
+            404: `Platform not found`
+          }
+        });
+      }
+      /**
+       * Create a watched group
+       * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+       * POST here accepts an optional `watchers` array as a create-time convenience.
+       * @returns WatchedGroupDetail
+       * @throws ApiError
+       */
+      static coreWatchedGroupsCreate({
+        requestBody,
+        platformKey,
+        watchedUserLimit,
+        watcherLimit
+      }) {
+        return request(OpenAPI, {
+          method: 'POST',
+          url: '/api/core/watched-groups/',
+          query: {
+            'platform_key': platformKey,
+            'watched_user_limit': watchedUserLimit,
+            'watcher_limit': watcherLimit
+          },
+          body: requestBody,
+          mediaType: 'application/json',
+          errors: {
+            400: `Invalid request`,
+            403: `Permission denied`
+          }
+        });
+      }
+      /**
+       * Retrieve a watched group
+       * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+       * POST here accepts an optional `watchers` array as a create-time convenience.
+       * @returns WatchedGroupDetail
+       * @throws ApiError
+       */
+      static coreWatchedGroupsRetrieve({
+        id,
+        platformKey,
+        watchedUserLimit,
+        watcherLimit
+      }) {
+        return request(OpenAPI, {
+          method: 'GET',
+          url: '/api/core/watched-groups/{id}/',
+          path: {
+            'id': id
+          },
+          query: {
+            'platform_key': platformKey,
+            'watched_user_limit': watchedUserLimit,
+            'watcher_limit': watcherLimit
+          },
+          errors: {
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
+      /**
+       * Update a watched group's name
+       * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+       * POST here accepts an optional `watchers` array as a create-time convenience.
+       * @returns WatchedGroupDetail
+       * @throws ApiError
+       */
+      static coreWatchedGroupsUpdate({
+        id,
+        platformKey,
+        watchedUserLimit,
+        watcherLimit,
+        requestBody
+      }) {
+        return request(OpenAPI, {
+          method: 'PUT',
+          url: '/api/core/watched-groups/{id}/',
+          path: {
+            'id': id
+          },
+          query: {
+            'platform_key': platformKey,
+            'watched_user_limit': watchedUserLimit,
+            'watcher_limit': watcherLimit
+          },
+          body: requestBody,
+          mediaType: 'application/json',
+          errors: {
+            400: `Invalid request`,
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
+      /**
+       * Partially update a watched group's name
+       * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+       * POST here accepts an optional `watchers` array as a create-time convenience.
+       * @returns WatchedGroupDetail
+       * @throws ApiError
+       */
+      static coreWatchedGroupsPartialUpdate({
+        id,
+        platformKey,
+        watchedUserLimit,
+        watcherLimit,
+        requestBody
+      }) {
+        return request(OpenAPI, {
+          method: 'PATCH',
+          url: '/api/core/watched-groups/{id}/',
+          path: {
+            'id': id
+          },
+          query: {
+            'platform_key': platformKey,
+            'watched_user_limit': watchedUserLimit,
+            'watcher_limit': watcherLimit
+          },
+          body: requestBody,
+          mediaType: 'application/json',
+          errors: {
+            400: `Invalid request`,
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
+      /**
+       * Delete a watched group
+       * CRUD for WatchedGroup. Watcher mutations live on the nested /watchers/ endpoint;
+       * POST here accepts an optional `watchers` array as a create-time convenience.
+       * @returns void
+       * @throws ApiError
+       */
+      static coreWatchedGroupsDestroy({
+        id,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'DELETE',
+          url: '/api/core/watched-groups/{id}/',
+          path: {
+            'id': id
+          },
+          query: {
+            'platform_key': platformKey
+          },
+          errors: {
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
+      /**
+       * List watched users in a watched group (paginated)
+       * CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
+       * No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
+       * this feature. Add via POST, remove via DELETE.
+       * @returns PaginatedWatchedUserReadList
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchedUsersList({
+        watchedGroupPk,
+        limit,
+        offset,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'GET',
+          url: '/api/core/watched-groups/{watched_group_pk}/watched-users/',
+          path: {
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'limit': limit,
+            'offset': offset,
+            'platform_key': platformKey
+          },
+          errors: {
+            403: `Permission denied`,
+            404: `WatchedGroup not found`
+          }
+        });
+      }
+      /**
+       * Add a user to the watched group
+       * CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
+       * No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
+       * this feature. Add via POST, remove via DELETE.
+       * @returns WatchedUserRead
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchedUsersCreate({
+        watchedGroupPk,
+        requestBody,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'POST',
+          url: '/api/core/watched-groups/{watched_group_pk}/watched-users/',
+          path: {
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'platform_key': platformKey
+          },
+          body: requestBody,
+          mediaType: 'application/json',
+          errors: {
+            400: `Invalid payload`,
+            403: `Permission denied`,
+            404: `WatchedGroup not found`
+          }
+        });
+      }
+      /**
+       * Retrieve a single watched-user link
+       * CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
+       * No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
+       * this feature. Add via POST, remove via DELETE.
+       * @returns WatchedUserRead
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchedUsersRetrieve({
+        id,
+        watchedGroupPk,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'GET',
+          url: '/api/core/watched-groups/{watched_group_pk}/watched-users/{id}/',
+          path: {
+            'id': id,
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'platform_key': platformKey
+          },
+          errors: {
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
+      /**
+       * Remove a user from the watched group
+       * CRUD-minus-update for watched users (UserGroupLink rows) under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchedusers/{link_id}/
+       * No PATCH/PUT — there's nothing meaningful to update on a UserGroupLink for
+       * this feature. Add via POST, remove via DELETE.
+       * @returns void
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchedUsersDestroy({
+        id,
+        watchedGroupPk,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'DELETE',
+          url: '/api/core/watched-groups/{watched_group_pk}/watched-users/{id}/',
+          path: {
+            'id': id,
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'platform_key': platformKey
+          },
+          errors: {
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
+      /**
+       * List watchers of a watched group (paginated)
+       * CRUD for watchers nested under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+       * `is_owner` here covers two cases that both deserve owner-level perms on a
+       * watcher row:
+       * - the watcher themselves (WATCHER_OWNER well-known role)
+       * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+       * `Ibl.Core/Watchers*`)
+       * @returns PaginatedWatcherReadList
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchersList({
+        watchedGroupPk,
+        limit,
+        offset,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'GET',
+          url: '/api/core/watched-groups/{watched_group_pk}/watchers/',
+          path: {
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'limit': limit,
+            'offset': offset,
+            'platform_key': platformKey
+          },
+          errors: {
+            403: `Permission denied`,
+            404: `WatchedGroup not found`
+          }
+        });
+      }
+      /**
+       * Add a watcher to a watched group
+       * CRUD for watchers nested under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+       * `is_owner` here covers two cases that both deserve owner-level perms on a
+       * watcher row:
+       * - the watcher themselves (WATCHER_OWNER well-known role)
+       * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+       * `Ibl.Core/Watchers*`)
+       * @returns WatcherRead
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchersCreate({
+        watchedGroupPk,
+        requestBody,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'POST',
+          url: '/api/core/watched-groups/{watched_group_pk}/watchers/',
+          path: {
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'platform_key': platformKey
+          },
+          body: requestBody,
+          mediaType: 'application/json',
+          errors: {
+            400: `Invalid payload`,
+            403: `Permission denied`,
+            404: `WatchedGroup not found`
+          }
+        });
+      }
+      /**
+       * Retrieve a single watcher
+       * CRUD for watchers nested under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+       * `is_owner` here covers two cases that both deserve owner-level perms on a
+       * watcher row:
+       * - the watcher themselves (WATCHER_OWNER well-known role)
+       * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+       * `Ibl.Core/Watchers*`)
+       * @returns WatcherRead
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchersRetrieve({
+        id,
+        watchedGroupPk,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'GET',
+          url: '/api/core/watched-groups/{watched_group_pk}/watchers/{id}/',
+          path: {
+            'id': id,
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'platform_key': platformKey
+          },
+          errors: {
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
+      /**
+       * Replace a watcher's events
+       * CRUD for watchers nested under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+       * `is_owner` here covers two cases that both deserve owner-level perms on a
+       * watcher row:
+       * - the watcher themselves (WATCHER_OWNER well-known role)
+       * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+       * `Ibl.Core/Watchers*`)
+       * @returns WatcherRead
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchersUpdate({
+        id,
+        watchedGroupPk,
+        requestBody,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'PUT',
+          url: '/api/core/watched-groups/{watched_group_pk}/watchers/{id}/',
+          path: {
+            'id': id,
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'platform_key': platformKey
+          },
+          body: requestBody,
+          mediaType: 'application/json',
+          errors: {
+            400: `Invalid payload`,
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
+      /**
+       * Update a watcher's events
+       * CRUD for watchers nested under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+       * `is_owner` here covers two cases that both deserve owner-level perms on a
+       * watcher row:
+       * - the watcher themselves (WATCHER_OWNER well-known role)
+       * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+       * `Ibl.Core/Watchers*`)
+       * @returns WatcherRead
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchersPartialUpdate({
+        id,
+        watchedGroupPk,
+        platformKey,
+        requestBody
+      }) {
+        return request(OpenAPI, {
+          method: 'PATCH',
+          url: '/api/core/watched-groups/{watched_group_pk}/watchers/{id}/',
+          path: {
+            'id': id,
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'platform_key': platformKey
+          },
+          body: requestBody,
+          mediaType: 'application/json',
+          errors: {
+            400: `Invalid payload`,
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
+      /**
+       * Remove (or unsubscribe) a watcher from a watched group
+       * CRUD for watchers nested under a WatchedGroup.
+       *
+       * Resource path: /platforms/{pk}/watchedgroups/{wg_id}/watchers/{watcher_id}/
+       * `is_owner` here covers two cases that both deserve owner-level perms on a
+       * watcher row:
+       * - the watcher themselves (WATCHER_OWNER well-known role)
+       * - the parent WatchedGroup's owner (WATCHED_GROUP_OWNER role grants
+       * `Ibl.Core/Watchers*`)
+       * @returns void
+       * @throws ApiError
+       */
+      static coreWatchedGroupsWatchersDestroy({
+        id,
+        watchedGroupPk,
+        platformKey
+      }) {
+        return request(OpenAPI, {
+          method: 'DELETE',
+          url: '/api/core/watched-groups/{watched_group_pk}/watchers/{id}/',
+          path: {
+            'id': id,
+            'watched_group_pk': watchedGroupPk
+          },
+          query: {
+            'platform_key': platformKey
+          },
+          errors: {
+            403: `Permission denied`,
+            404: `Not found`
+          }
+        });
+      }
       /**
        * Get a list of departments with metrics and filtering options.
        *