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

package/src/core/OpenAPI.ts

@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: 'https://base.manager.iblai.app',
-    VERSION: '4.251.0-core',
+    VERSION: '4.252.0-core',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/src/index.ts

@@ -153,6 +153,7 @@ export type { EnrollmentsPerUserData } from './models/EnrollmentsPerUserData';
 export type { ErrorDetail } from './models/ErrorDetail';
 export type { ErrorResponse } from './models/ErrorResponse';
 export { EthnicityEnum } from './models/EthnicityEnum';
+export { EventsEnum } from './models/EventsEnum';
 export type { Experience } from './models/Experience';
 export type { ExternalCredentialMapping } from './models/ExternalCredentialMapping';
 export type { FieldDefinitionImport } from './models/FieldDefinitionImport';
@@ -266,6 +267,9 @@ export type { PaginatedUserGroupList } from './models/PaginatedUserGroupList';
 export type { PaginatedUserLicense } from './models/PaginatedUserLicense';
 export type { PaginatedUserLicenseAssignment } from './models/PaginatedUserLicenseAssignment';
 export type { PaginatedUserLicenseGroupAssignment } from './models/PaginatedUserLicenseGroupAssignment';
+export type { PaginatedWatchedGroupListList } from './models/PaginatedWatchedGroupListList';
+export type { PaginatedWatchedUserReadList } from './models/PaginatedWatchedUserReadList';
+export type { PaginatedWatcherReadList } from './models/PaginatedWatcherReadList';
 export type { Pagination } from './models/Pagination';
 export type { PatchedCreditAccountAutoRechargeUpdate } from './models/PatchedCreditAccountAutoRechargeUpdate';
 export type { PatchedDemographicsFieldDefinitionWrite } from './models/PatchedDemographicsFieldDefinitionWrite';
@@ -285,6 +289,8 @@ export type { PatchedSkillThreshold } from './models/PatchedSkillThreshold';
 export type { PatchedUserGroup } from './models/PatchedUserGroup';
 export type { PatchedUserNotificationPreferences } from './models/PatchedUserNotificationPreferences';
 export type { PatchedUserPlatformMetadataUpdate } from './models/PatchedUserPlatformMetadataUpdate';
+export type { PatchedWatchedGroupUpdate } from './models/PatchedWatchedGroupUpdate';
+export type { PatchedWatcherUpdate } from './models/PatchedWatcherUpdate';
 export type { Pathway } from './models/Pathway';
 export type { PathwayCompletion } from './models/PathwayCompletion';
 export type { PathwayCompletionResponse } from './models/PathwayCompletionResponse';
@@ -545,10 +551,20 @@ export type { VideosInCourseSummaryData } from './models/VideosInCourseSummaryDa
 export type { VideosSpecificCourse } from './models/VideosSpecificCourse';
 export type { VideosSpecificCourseData } from './models/VideosSpecificCourseData';
 export type { VideosWatchedSubSection } from './models/VideosWatchedSubSection';
+export type { WatchedGroupCreate } from './models/WatchedGroupCreate';
+export type { WatchedGroupDetail } from './models/WatchedGroupDetail';
+export type { WatchedGroupList } from './models/WatchedGroupList';
+export type { WatchedGroupUpdate } from './models/WatchedGroupUpdate';
+export type { WatchedUserRead } from './models/WatchedUserRead';
+export type { WatchedUserWrite } from './models/WatchedUserWrite';
 export type { WatchedVideosPerCourse } from './models/WatchedVideosPerCourse';
 export type { WatchedVideosPerCourseData } from './models/WatchedVideosPerCourseData';
 export type { WatchedVideosPerUser } from './models/WatchedVideosPerUser';
 export type { WatchedVideosPerUserData } from './models/WatchedVideosPerUserData';
+export type { WatcherEntry } from './models/WatcherEntry';
+export type { WatcherRead } from './models/WatcherRead';
+export type { WatcherUpdate } from './models/WatcherUpdate';
+export type { WatcherWrite } from './models/WatcherWrite';
 export type { WhitelistedDomain } from './models/WhitelistedDomain';
 
 export { AccessCheckService } from './services/AccessCheckService';

package/src/models/EventsEnum.ts

@@ -0,0 +1,38 @@
+/* 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
+ */
+export enum EventsEnum {
+    USER_NOTIF_COURSE_ENROLLMENT = 'USER_NOTIF_COURSE_ENROLLMENT',
+    ADMIN_NOTIF_COURSE_ENROLLMENT = 'ADMIN_NOTIF_COURSE_ENROLLMENT',
+    USER_NOTIF_USER_INACTIVITY = 'USER_NOTIF_USER_INACTIVITY',
+    USER_NOTIF_COURSE_COMPLETION = 'USER_NOTIF_COURSE_COMPLETION',
+    USER_NOTIF_CREDENTIALS = 'USER_NOTIF_CREDENTIALS',
+    USER_NOTIF_LEARNER_PROGRESS = 'USER_NOTIF_LEARNER_PROGRESS',
+    PROACTIVE_LEARNER_NOTIFICATION = 'PROACTIVE_LEARNER_NOTIFICATION',
+    ACTIVITY_NEW_CONTENT = 'ACTIVITY_NEW_CONTENT',
+    ACTIVITY_COURSE_MILESTONE = 'ACTIVITY_COURSE_MILESTONE',
+    SKILL_MASTERY_CHANGE = 'SKILL_MASTERY_CHANGE',
+    PROGRAM_ENROLLMENT_CONFIRMATION = 'PROGRAM_ENROLLMENT_CONFIRMATION',
+    PATHWAY_ENROLLMENT_CONFIRMATION = 'PATHWAY_ENROLLMENT_CONFIRMATION',
+    COURSE_SCHEDULE_CHANGE = 'COURSE_SCHEDULE_CHANGE',
+    COURSES_PROGRESS_SUMMARY = 'COURSES_PROGRESS_SUMMARY',
+    SUBSECTION_GRADE_UPDATE = 'SUBSECTION_GRADE_UPDATE',
+}

package/src/models/PaginatedWatchedGroupListList.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { WatchedGroupList } from './WatchedGroupList';
+export type PaginatedWatchedGroupListList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<WatchedGroupList>;
+};
+

package/src/models/PaginatedWatchedUserReadList.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { WatchedUserRead } from './WatchedUserRead';
+export type PaginatedWatchedUserReadList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<WatchedUserRead>;
+};
+

package/src/models/PaginatedWatcherReadList.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { WatcherRead } from './WatcherRead';
+export type PaginatedWatcherReadList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<WatcherRead>;
+};
+

package/src/models/PatchedWatchedGroupUpdate.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Payload for PATCH /watched-groups/{pk}/ — name only.
+ *
+ * Watchers are managed via /watchers/; watched users via /watched-users/.
+ */
+export type PatchedWatchedGroupUpdate = {
+    name?: string;
+};
+

package/src/models/PatchedWatcherUpdate.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { EventsEnum } from './EventsEnum';
+/**
+ * Payload for PATCH /watched-groups/{wg_pk}/watchers/{pk}/ — events only.
+ */
+export type PatchedWatcherUpdate = {
+    events?: Array<EventsEnum>;
+};
+

package/src/models/WatchedGroupCreate.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { WatcherEntry } from './WatcherEntry';
+/**
+ * Payload for POST /watched-groups/.
+ *
+ * Platform is resolved by the view (auth token for normal callers, query
+ * param or body `platform_key` for service accounts) and passed via
+ * `context["platform"]`. The body `platform_key` field is consumed by the
+ * view, not the serializer.
+ *
+ * `owner_id` is reserved for service-account callers. Platform users are
+ * implicitly the owner; specifying `owner_id` from a platform user yields 400.
+ */
+export type WatchedGroupCreate = {
+    watched_users?: Array<number>;
+    name: string;
+    watchers?: Array<WatcherEntry>;
+    /**
+     * edX user ID
+     */
+    owner_id?: number | null;
+};
+

package/src/models/WatchedGroupDetail.ts

@@ -0,0 +1,21 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Detail shape — counts plus opt-in inline collections.
+ *
+ * `watchers` honors `watcher_limit` from context (default 0).
+ * `watched_users` honors `watched_user_limit` from context (default 0).
+ * Use the dedicated sub-resources for paginated walks.
+ */
+export type WatchedGroupDetail = {
+    readonly id: number;
+    readonly name: string;
+    readonly platform_key: string;
+    readonly watcher_count: number;
+    readonly watchers: Array<any>;
+    readonly watched_user_count: number;
+    readonly watched_users: Array<any>;
+};
+

package/src/models/WatchedGroupList.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Lean shape for list responses — no watchers, no watched_users, no counts.
+ */
+export type WatchedGroupList = {
+    readonly id: number;
+    readonly name: string;
+    readonly platform_key: string;
+};
+

package/src/models/WatchedGroupUpdate.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Payload for PATCH /watched-groups/{pk}/ — name only.
+ *
+ * Watchers are managed via /watchers/; watched users via /watched-users/.
+ */
+export type WatchedGroupUpdate = {
+    name?: string;
+};
+

package/src/models/WatchedUserRead.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Output for a single user inside a WatchedGroup.
+ *
+ * The entity is the user — `id` is the user's id (matching the URL pk). The
+ * underlying `UserGroupLink.id` is a routing artifact and isn't surfaced.
+ */
+export type WatchedUserRead = {
+    readonly id: number;
+    readonly username: string;
+    readonly email: string;
+};
+

package/src/models/WatchedUserWrite.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Payload for POST /watched-groups/{wg_pk}/watched-users/.
+ */
+export type WatchedUserWrite = {
+    /**
+     * edX user ID
+     */
+    user_id: number;
+};
+

package/src/models/WatcherEntry.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { EventsEnum } from './EventsEnum';
+/**
+ * A single watcher entry in the create payload: who watches and which events.
+ */
+export type WatcherEntry = {
+    watcher_id: number;
+    events?: Array<EventsEnum>;
+};
+

package/src/models/WatcherRead.ts

@@ -0,0 +1,21 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Output for a watcher (a user watching a WatchedGroup).
+ *
+ * The entity is the user — `id` is the watcher's user id (matching the URL
+ * pk). The underlying `WatcherToWatchedGroup.id` is a routing artifact and
+ * isn't surfaced.
+ */
+export type WatcherRead = {
+    readonly id: number;
+    readonly username: string;
+    readonly email: string;
+    /**
+     * List of events the watcher is subscribed to for this group
+     */
+    events?: any;
+};
+

package/src/models/WatcherUpdate.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { EventsEnum } from './EventsEnum';
+/**
+ * Payload for PATCH /watched-groups/{wg_pk}/watchers/{pk}/ — events only.
+ */
+export type WatcherUpdate = {
+    events: Array<EventsEnum>;
+};
+

package/src/models/WatcherWrite.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { EventsEnum } from './EventsEnum';
+/**
+ * Payload for POST /watched-groups/{wg_pk}/watchers/.
+ */
+export type WatcherWrite = {
+    /**
+     * edX user ID
+     */
+    watcher_id: number;
+    events?: Array<EventsEnum>;
+};
+