/* generated using openapi-typescript-codegen -- do not edit */ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ import type { BlankEnum } from './BlankEnum'; import type { NullEnum } from './NullEnum'; import type { TypeF30Enum } from './TypeF30Enum'; /** * Serializer for listing notification templates with inheritance info */ export type NotificationTemplateList = { /** * Unique identifier for this notification template. */ readonly id: string; /** * Select the type of notification from the available options. * * * `ACTIVITY_COURSE_MILESTONE` - Activity Course Milestone * * `ACTIVITY_NEW_CONTENT` - Activity New Content * * `ADMIN_NOTIF_COURSE_ENROLLMENT` - Admin Notif Course Enrollment * * `APP_REGISTRATION` - App Registration * * `COURSE_INVITATION` - Course Invitation * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change * * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed * * `CRM_PERSON_CREATED` - Crm Person Created * * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User * * `CUSTOM_NOTIFICATION` - Custom Notification * * `DEFAULT_TEMPLATE` - Default Template * * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification * * `HUMAN_SUPPORT_TICKET_MESSAGE` - Human Support Ticket Message * * `PATHWAY_ENROLLMENT_CONFIRMATION` - Pathway Enrollment Confirmation * * `PLATFORM_APPLICATION_DECISION` - Platform Application Decision * * `PLATFORM_INVITATION` - Platform Invitation * * `POLICY_ASSIGNMENT` - Policy Assignment * * `PROACTIVE_LEARNER_NOTIFICATION` - Proactive Learner Notification * * `PROGRAM_ENROLLMENT_CONFIRMATION` - Program Enrollment Confirmation * * `PROGRAM_INVITATION` - Program Invitation * * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment * * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment * * `REPORT_COMPLETED` - Report Completed * * `ROLE_CHANGE` - Role Change * * `SKILL_MASTERY_CHANGE` - Skill Mastery Change * * `SPEND_CAP_ALERT` - Spend Cap Alert * * `SUBSECTION_GRADE_UPDATE` - Subsection Grade Update * * `USER_LICENSE_ASSIGNMENT` - User License Assignment * * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment * * `USER_NOTIF_COURSE_COMPLETION` - User Notif Course Completion * * `USER_NOTIF_COURSE_ENROLLMENT` - User Notif Course Enrollment * * `USER_NOTIF_CREDENTIALS` - User Notif Credentials * * `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 */ type?: (TypeF30Enum | BlankEnum | NullEnum) | null; /** * A friendly name for the notification template. */ name?: string | null; /** * Admin-friendly description of what this notification does, when it triggers, and what data it needs */ description?: string; /** * True if using main platform template (no platform override) */ readonly is_inherited: boolean; /** * Platform key of the template source (main or tenant) */ readonly source_platform: string; /** * True if notification is enabled for this platform */ readonly is_enabled: boolean; /** * True if platform admin can edit template content */ readonly can_customize: boolean; /** * True if this is a custom notification type */ readonly is_custom: boolean; /** * The title for the notification message. */ message_title?: string | null; /** * Email subject line (supports Django template syntax) */ email_subject?: string | null; /** * Free-form tags for categorization (e.g. ['activity', 'learning']) */ tags?: any; /** * SPAs (Single Page Apps) that can use this template */ readonly spas: string; /** * Channels this template can be delivered via (email, push, etc.) */ readonly allowed_channels: string; /** * Context variables available for template rendering */ readonly available_context: string; };