@iblai/iblai-api 4.236.1-core → 4.236.2-core

package/src/models/CoursesProgressFrequencyEnum.ts

@@ -0,0 +1,16 @@
+/* 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 CoursesProgressFrequencyEnum {
+    DAILY = 'DAILY',
+    WEEKLY = 'WEEKLY',
+    MONTHLY = 'MONTHLY',
+    CUSTOM = 'CUSTOM',
+}

package/src/models/NotificationTemplateDetail.ts

@@ -3,12 +3,13 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { ConsumerChannel } from './ConsumerChannel';
+import type { CoursesProgressFrequencyEnum } from './CoursesProgressFrequencyEnum';
 import type { HumanSupportRecipientModeEnum } from './HumanSupportRecipientModeEnum';
 import type { NullEnum } from './NullEnum';
 import type { PeriodicFrequencyEnum } from './PeriodicFrequencyEnum';
 import type { PeriodicLearnerScopeEnum } from './PeriodicLearnerScopeEnum';
 import type { Spa } from './Spa';
-import type { TypeFdfEnum } from './TypeFdfEnum';
+import type { Type229Enum } from './Type229Enum';
 /**
  * Serializer for detailed template view and editing
  */
@@ -27,6 +28,7 @@ export type NotificationTemplateDetail = {
      * * `COURSE_INVITATION` - Course Invitation
      * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
      * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+     * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
      * * `CUSTOM_NOTIFICATION` - Custom Notification
      * * `DEFAULT_TEMPLATE` - Default Template
      * * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
@@ -50,7 +52,7 @@ export type NotificationTemplateDetail = {
      * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
      * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
      */
-    readonly type: (TypeFdfEnum | NullEnum) | null;
+    readonly type: (Type229Enum | NullEnum) | null;
     /**
      * Template display name
      */
@@ -135,6 +137,10 @@ export type NotificationTemplateDetail = {
     /**
      * Number of days to include in the report period
      */
+    periodic_lookback_days?: number;
+    /**
+     * Deprecated: use periodic_lookback_days instead
+     */
     periodic_report_period_days?: number;
     /**
      * How often to send: DAILY, WEEKLY, MONTHLY, or CUSTOM
@@ -218,6 +224,39 @@ export type NotificationTemplateDetail = {
      * Mastery band thresholds (e.g. [{"name": "Beginner", "min_points": 0}, {"name": "Intermediate", "min_points": 100}])
      */
     skill_mastery_thresholds?: Array<Record<string, any>>;
+    /**
+     * Courses progress config (COURSES_PROGRESS_SUMMARY only)
+     */
+    readonly courses_progress_config: Record<string, any> | null;
+    /**
+     * Lookback period in days for courses progress summary
+     */
+    courses_progress_lookback_days?: number;
+    /**
+     * Data points to include: courses_progressed, courses_completed, credentials_earned, time_spent, active_days, mentors_accessed
+     */
+    courses_progress_enabled_data_points?: Array<string>;
+    /**
+     * How often to send courses progress summary
+     *
+     * * `DAILY` - DAILY
+     * * `WEEKLY` - WEEKLY
+     * * `MONTHLY` - MONTHLY
+     * * `CUSTOM` - CUSTOM
+     */
+    courses_progress_frequency?: CoursesProgressFrequencyEnum;
+    /**
+     * Custom interval in days (when frequency is CUSTOM)
+     */
+    courses_progress_custom_interval_days?: number;
+    /**
+     * Time of day to send (HH:MM format)
+     */
+    courses_progress_execution_time?: string;
+    /**
+     * Timezone for execution (e.g. America/New_York)
+     */
+    courses_progress_timezone?: string;
     /**
      * Timestamp when this template was created
      */

package/src/models/NotificationTemplateList.ts

@@ -4,7 +4,7 @@
 /* eslint-disable */
 import type { BlankEnum } from './BlankEnum';
 import type { NullEnum } from './NullEnum';
-import type { TypeFdfEnum } from './TypeFdfEnum';
+import type { Type229Enum } from './Type229Enum';
 /**
  * Serializer for listing notification templates with inheritance info
  */
@@ -23,6 +23,7 @@ export type NotificationTemplateList = {
      * * `COURSE_INVITATION` - Course Invitation
      * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
      * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+     * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
      * * `CUSTOM_NOTIFICATION` - Custom Notification
      * * `DEFAULT_TEMPLATE` - Default Template
      * * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
@@ -46,7 +47,7 @@ export type NotificationTemplateList = {
      * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
      * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
      */
-    type?: (TypeFdfEnum | BlankEnum | NullEnum) | null;
+    type?: (Type229Enum | BlankEnum | NullEnum) | null;
     /**
      * A friendly name for the notification template.
      */

package/src/models/NotificationTemplateTest.ts

@@ -10,5 +10,9 @@ export type NotificationTemplateTest = {
      * Optional context variables for template rendering (e.g., {'course_name': 'Test Course'})
      */
     context?: any;
+    /**
+     * Use realistic sample data for this notification type. Set False for minimal context.
+     */
+    use_sample_context?: boolean;
 };
 

package/src/models/PatchedNotificationTemplateDetail.ts

@@ -3,12 +3,13 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { ConsumerChannel } from './ConsumerChannel';
+import type { CoursesProgressFrequencyEnum } from './CoursesProgressFrequencyEnum';
 import type { HumanSupportRecipientModeEnum } from './HumanSupportRecipientModeEnum';
 import type { NullEnum } from './NullEnum';
 import type { PeriodicFrequencyEnum } from './PeriodicFrequencyEnum';
 import type { PeriodicLearnerScopeEnum } from './PeriodicLearnerScopeEnum';
 import type { Spa } from './Spa';
-import type { TypeFdfEnum } from './TypeFdfEnum';
+import type { Type229Enum } from './Type229Enum';
 /**
  * Serializer for detailed template view and editing
  */
@@ -27,6 +28,7 @@ export type PatchedNotificationTemplateDetail = {
      * * `COURSE_INVITATION` - Course Invitation
      * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
      * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+     * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
      * * `CUSTOM_NOTIFICATION` - Custom Notification
      * * `DEFAULT_TEMPLATE` - Default Template
      * * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
@@ -50,7 +52,7 @@ export type PatchedNotificationTemplateDetail = {
      * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
      * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
      */
-    readonly type?: (TypeFdfEnum | NullEnum) | null;
+    readonly type?: (Type229Enum | NullEnum) | null;
     /**
      * Template display name
      */
@@ -135,6 +137,10 @@ export type PatchedNotificationTemplateDetail = {
     /**
      * Number of days to include in the report period
      */
+    periodic_lookback_days?: number;
+    /**
+     * Deprecated: use periodic_lookback_days instead
+     */
     periodic_report_period_days?: number;
     /**
      * How often to send: DAILY, WEEKLY, MONTHLY, or CUSTOM
@@ -218,6 +224,39 @@ export type PatchedNotificationTemplateDetail = {
      * Mastery band thresholds (e.g. [{"name": "Beginner", "min_points": 0}, {"name": "Intermediate", "min_points": 100}])
      */
     skill_mastery_thresholds?: Array<Record<string, any>>;
+    /**
+     * Courses progress config (COURSES_PROGRESS_SUMMARY only)
+     */
+    readonly courses_progress_config?: Record<string, any> | null;
+    /**
+     * Lookback period in days for courses progress summary
+     */
+    courses_progress_lookback_days?: number;
+    /**
+     * Data points to include: courses_progressed, courses_completed, credentials_earned, time_spent, active_days, mentors_accessed
+     */
+    courses_progress_enabled_data_points?: Array<string>;
+    /**
+     * How often to send courses progress summary
+     *
+     * * `DAILY` - DAILY
+     * * `WEEKLY` - WEEKLY
+     * * `MONTHLY` - MONTHLY
+     * * `CUSTOM` - CUSTOM
+     */
+    courses_progress_frequency?: CoursesProgressFrequencyEnum;
+    /**
+     * Custom interval in days (when frequency is CUSTOM)
+     */
+    courses_progress_custom_interval_days?: number;
+    /**
+     * Time of day to send (HH:MM format)
+     */
+    courses_progress_execution_time?: string;
+    /**
+     * Timezone for execution (e.g. America/New_York)
+     */
+    courses_progress_timezone?: string;
     /**
      * Timestamp when this template was created
      */

package/src/models/{TypeFdfEnum.ts → Type229Enum.ts}

@@ -10,6 +10,7 @@
  * * `COURSE_INVITATION` - Course Invitation
  * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
  * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+ * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
  * * `CUSTOM_NOTIFICATION` - Custom Notification
  * * `DEFAULT_TEMPLATE` - Default Template
  * * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
@@ -33,7 +34,7 @@
  * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
  * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
  */
-export enum TypeFdfEnum {
+export enum Type229Enum {
     ACTIVITY_COURSE_MILESTONE = 'ACTIVITY_COURSE_MILESTONE',
     ACTIVITY_NEW_CONTENT = 'ACTIVITY_NEW_CONTENT',
     ADMIN_NOTIF_COURSE_ENROLLMENT = 'ADMIN_NOTIF_COURSE_ENROLLMENT',
@@ -41,6 +42,7 @@ export enum TypeFdfEnum {
     COURSE_INVITATION = 'COURSE_INVITATION',
     COURSE_LICENSE_ASSIGNMENT = 'COURSE_LICENSE_ASSIGNMENT',
     COURSE_LICENSE_GROUP_ASSIGNMENT = 'COURSE_LICENSE_GROUP_ASSIGNMENT',
+    COURSES_PROGRESS_SUMMARY = 'COURSES_PROGRESS_SUMMARY',
     CUSTOM_NOTIFICATION = 'CUSTOM_NOTIFICATION',
     DEFAULT_TEMPLATE = 'DEFAULT_TEMPLATE',
     HUMAN_SUPPORT_NOTIFICATION = 'HUMAN_SUPPORT_NOTIFICATION',