@iblai/iblai-api 4.338.1-core → 4.340.0-core

package/src/models/PatchedNotificationTemplateDetail.ts

@@ -7,11 +7,10 @@ import type { CoursesProgressFrequencyEnum } from './CoursesProgressFrequencyEnu
 import type { GradePostedNotifyModeEnum } from './GradePostedNotifyModeEnum';
 import type { HumanSupportRecipientModeEnum } from './HumanSupportRecipientModeEnum';
 import type { NullEnum } from './NullEnum';
-import type { PeriodicFrequencyEnum } from './PeriodicFrequencyEnum';
 import type { PeriodicLearnerScopeEnum } from './PeriodicLearnerScopeEnum';
 import type { RecipientsRecipientModeEnum } from './RecipientsRecipientModeEnum';
 import type { Spa } from './Spa';
-import type { TypeAf9Enum } from './TypeAf9Enum';
+import type { TypeF30Enum } from './TypeF30Enum';
 /**
  * Serializer for detailed template view and editing
  */
@@ -31,7 +30,6 @@ export type PatchedNotificationTemplateDetail = {
      * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
      * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
      * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
-     * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
      * * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
      * * `CRM_PERSON_CREATED` - Crm Person Created
      * * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
@@ -61,8 +59,9 @@ export type PatchedNotificationTemplateDetail = {
      * * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
      * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
      * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
+     * * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
      */
-    readonly type?: (TypeAf9Enum | NullEnum) | null;
+    readonly type?: (TypeF30Enum | NullEnum) | null;
     /**
      * Template display name
      */
@@ -95,6 +94,14 @@ export type PatchedNotificationTemplateDetail = {
      * HTML email body (supports Django template syntax)
      */
     email_html_template?: string | null;
+    /**
+     * Watcher-variant email HTML template (e.g., 'Your child completed...'). Falls back to email_html_template if null.
+     */
+    watcher_email_html_template?: string | null;
+    /**
+     * Watcher-variant email subject. Falls back to email_subject if null.
+     */
+    watcher_email_subject?: string | null;
     /**
      * Free-form tags for categorization (e.g. ['activity', 'learning'])
      */
@@ -133,6 +140,10 @@ export type PatchedNotificationTemplateDetail = {
      * Context variables available for template rendering
      */
     readonly available_context?: string;
+    /**
+     * Context variables available in the watcher email variant (null for notification types without a watcher variant)
+     */
+    readonly watcher_available_context?: string;
     /**
      * Default prompt message for AI agent notifications
      */
@@ -164,7 +175,7 @@ export type PatchedNotificationTemplateDetail = {
      * * `MONTHLY` - MONTHLY
      * * `CUSTOM` - CUSTOM
      */
-    periodic_frequency?: PeriodicFrequencyEnum;
+    periodic_frequency?: CoursesProgressFrequencyEnum;
     /**
      * Custom interval in days (when frequency is CUSTOM)
      */
@@ -265,19 +276,52 @@ export type PatchedNotificationTemplateDetail = {
      */
     schedule_change_enabled_signals?: Array<string>;
     /**
-     * Courses progress config (COURSES_PROGRESS_SUMMARY only)
+     * User progress summary config (COURSES_PROGRESS_SUMMARY only)
+     */
+    readonly user_progress_config?: Record<string, any> | null;
+    /**
+     * Lookback window in days for the user progress summary
+     */
+    user_progress_lookback_days?: number;
+    /**
+     * Data points to include: courses_progressed, courses_completed, credentials_earned, time_spent, active_days, mentors_accessed (AI agent activity)
+     */
+    user_progress_enabled_data_points?: Array<string>;
+    /**
+     * How often to send the user progress summary
+     *
+     * * `DAILY` - DAILY
+     * * `WEEKLY` - WEEKLY
+     * * `MONTHLY` - MONTHLY
+     * * `CUSTOM` - CUSTOM
+     */
+    user_progress_frequency?: CoursesProgressFrequencyEnum;
+    /**
+     * Custom interval in days (when frequency is CUSTOM)
+     */
+    user_progress_custom_interval_days?: number;
+    /**
+     * Time of day to send (HH:MM format)
+     */
+    user_progress_execution_time?: string;
+    /**
+     * Timezone for execution (e.g. America/New_York)
+     */
+    user_progress_timezone?: string;
+    /**
+     * Deprecated alias of user_progress_config (COURSES_PROGRESS_SUMMARY only)
      */
     readonly courses_progress_config?: Record<string, any> | null;
     /**
-     * Lookback period in days for courses progress summary
+     * Deprecated alias of user_progress_lookback_days
      */
     courses_progress_lookback_days?: number;
     /**
-     * Data points to include: courses_progressed, courses_completed, credentials_earned, time_spent, active_days, mentors_accessed
+     * Deprecated alias of user_progress_enabled_data_points
      */
     courses_progress_enabled_data_points?: Array<string>;
     /**
-     * How often to send courses progress summary
+     * Deprecated alias of user_progress_frequency
      *
      * * `DAILY` - DAILY
      * * `WEEKLY` - WEEKLY
@@ -286,15 +330,15 @@ export type PatchedNotificationTemplateDetail = {
      */
     courses_progress_frequency?: CoursesProgressFrequencyEnum;
     /**
-     * Custom interval in days (when frequency is CUSTOM)
+     * Deprecated alias of user_progress_custom_interval_days
      */
     courses_progress_custom_interval_days?: number;
     /**
-     * Time of day to send (HH:MM format)
+     * Deprecated alias of user_progress_execution_time
      */
     courses_progress_execution_time?: string;
     /**
-     * Timezone for execution (e.g. America/New_York)
+     * Deprecated alias of user_progress_timezone
      */
     courses_progress_timezone?: string;
     /**

package/src/models/{TypeAf9Enum.ts → TypeF30Enum.ts}

@@ -11,7 +11,6 @@
  * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
  * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
  * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
- * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
  * * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
  * * `CRM_PERSON_CREATED` - Crm Person Created
  * * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
@@ -41,8 +40,9 @@
  * * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
  * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
  * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
+ * * `COURSES_PROGRESS_SUMMARY` - User Progress Summary
  */
-export enum TypeAf9Enum {
+export enum TypeF30Enum {
     ACTIVITY_COURSE_MILESTONE = 'ACTIVITY_COURSE_MILESTONE',
     ACTIVITY_NEW_CONTENT = 'ACTIVITY_NEW_CONTENT',
     ADMIN_NOTIF_COURSE_ENROLLMENT = 'ADMIN_NOTIF_COURSE_ENROLLMENT',
@@ -51,7 +51,6 @@ export enum TypeAf9Enum {
     COURSE_LICENSE_ASSIGNMENT = 'COURSE_LICENSE_ASSIGNMENT',
     COURSE_LICENSE_GROUP_ASSIGNMENT = 'COURSE_LICENSE_GROUP_ASSIGNMENT',
     COURSE_SCHEDULE_CHANGE = 'COURSE_SCHEDULE_CHANGE',
-    COURSES_PROGRESS_SUMMARY = 'COURSES_PROGRESS_SUMMARY',
     CRM_DEAL_STAGE_CHANGED = 'CRM_DEAL_STAGE_CHANGED',
     CRM_PERSON_CREATED = 'CRM_PERSON_CREATED',
     CRM_PERSON_LINKED_TO_USER = 'CRM_PERSON_LINKED_TO_USER',
@@ -81,4 +80,5 @@ export enum TypeAf9Enum {
     USER_NOTIF_LEARNER_PROGRESS = 'USER_NOTIF_LEARNER_PROGRESS',
     USER_NOTIF_USER_INACTIVITY = 'USER_NOTIF_USER_INACTIVITY',
     USER_NOTIF_USER_REGISTRATION = 'USER_NOTIF_USER_REGISTRATION',
+    COURSES_PROGRESS_SUMMARY = 'COURSES_PROGRESS_SUMMARY',
 }

package/dist/types/models/PeriodicFrequencyEnum.d.ts

@@ -1,12 +0,0 @@
-/**
- * * `DAILY` - DAILY
- * * `WEEKLY` - WEEKLY
- * * `MONTHLY` - MONTHLY
- * * `CUSTOM` - CUSTOM
- */
-export declare enum PeriodicFrequencyEnum {
-    DAILY = "DAILY",
-    WEEKLY = "WEEKLY",
-    MONTHLY = "MONTHLY",
-    CUSTOM = "CUSTOM"
-}

package/src/models/PeriodicFrequencyEnum.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * * `DAILY` - DAILY
- * * `WEEKLY` - WEEKLY
- * * `MONTHLY` - MONTHLY
- * * `CUSTOM` - CUSTOM
- */
-export enum PeriodicFrequencyEnum {
-    DAILY = 'DAILY',
-    WEEKLY = 'WEEKLY',
-    MONTHLY = 'MONTHLY',
-    CUSTOM = 'CUSTOM',
-}