@iblai/iblai-api 4.59.3-core → 4.60.0-core

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

@@ -0,0 +1,86 @@
+import type { ConsumerChannel } from './ConsumerChannel';
+import type { NullEnum } from './NullEnum';
+import type { Spa } from './Spa';
+import type { TypeA81Enum } from './TypeA81Enum';
+/**
+ * Serializer for detailed template view and editing
+ */
+export type PatchedNotificationTemplateDetail = {
+    /**
+     * Unique identifier for this notification template.
+     */
+    readonly id?: string;
+    /**
+     * Select the type of notification from the available options.
+     *
+     * * `APP_REGISTRATION` - App Registration
+     * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
+     * * `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
+     * * `CUSTOM_NOTIFICATION` - Custom Notification
+     * * `PLATFORM_INVITATION` - Platform Invitation
+     * * `PROGRAM_INVITATION` - Program Invitation
+     * * `COURSE_INVITATION` - Course Invitation
+     * * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+     * * `ROLE_CHANGE` - Role Change
+     * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
+     * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+     * * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
+     * * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
+     * * `USER_LICENSE_ASSIGNMENT` - User License Assignment
+     * * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment
+     */
+    readonly type?: (TypeA81Enum | 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;
+    /**
+     * The title for the notification message.
+     */
+    message_title?: string | null;
+    /**
+     * The full notification message body.
+     */
+    message_body?: string;
+    /**
+     * A short version of the notification message body.
+     */
+    short_message_body?: string;
+    /**
+     * Email subject line (supports Django template syntax)
+     */
+    email_subject?: string | null;
+    /**
+     * Sender email address (default: IBL <noreply@ibl.ai>)
+     */
+    email_from_address?: string | null;
+    /**
+     * Full HTML template for email body
+     */
+    email_html_template?: string | null;
+    readonly spas_detail?: Array<Spa>;
+    readonly allowed_channels_detail?: Array<ConsumerChannel>;
+    spa_ids?: Array<number>;
+    channel_ids?: Array<number>;
+    readonly is_inherited?: boolean;
+    readonly is_enabled?: boolean;
+    readonly source_platform?: string;
+    metadata?: any;
+    readonly available_context?: string;
+    /**
+     * Timestamp when this template was created
+     */
+    readonly created_at?: string;
+    /**
+     * Timestamp when this template was last updated
+     */
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,6 @@
+/**
+ * Serializer for toggling notification preference
+ */
+export type PatchedNotificationToggle = {
+    allow_notification?: boolean;
+};

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

@@ -0,0 +1,14 @@
+/**
+ * Serializer for SPA
+ */
+export type Spa = {
+    readonly id: number;
+    /**
+     * Unique identifier for the SPA (e.g., 'skills', 'mentor', 'admin', 'mobile')
+     */
+    name: string;
+    /**
+     * Human-friendly description of this SPA
+     */
+    description?: string;
+};

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

@@ -0,0 +1,42 @@
+/**
+ * * `APP_REGISTRATION` - App Registration
+ * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
+ * * `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
+ * * `CUSTOM_NOTIFICATION` - Custom Notification
+ * * `PLATFORM_INVITATION` - Platform Invitation
+ * * `PROGRAM_INVITATION` - Program Invitation
+ * * `COURSE_INVITATION` - Course Invitation
+ * * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+ * * `ROLE_CHANGE` - Role Change
+ * * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
+ * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+ * * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
+ * * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
+ * * `USER_LICENSE_ASSIGNMENT` - User License Assignment
+ * * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment
+ */
+export declare enum TypeA81Enum {
+    APP_REGISTRATION = "APP_REGISTRATION",
+    USER_NOTIF_USER_REGISTRATION = "USER_NOTIF_USER_REGISTRATION",
+    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",
+    CUSTOM_NOTIFICATION = "CUSTOM_NOTIFICATION",
+    PLATFORM_INVITATION = "PLATFORM_INVITATION",
+    PROGRAM_INVITATION = "PROGRAM_INVITATION",
+    COURSE_INVITATION = "COURSE_INVITATION",
+    USER_NOTIF_LEARNER_PROGRESS = "USER_NOTIF_LEARNER_PROGRESS",
+    ROLE_CHANGE = "ROLE_CHANGE",
+    COURSE_LICENSE_ASSIGNMENT = "COURSE_LICENSE_ASSIGNMENT",
+    COURSE_LICENSE_GROUP_ASSIGNMENT = "COURSE_LICENSE_GROUP_ASSIGNMENT",
+    PROGRAM_LICENSE_ASSIGNMENT = "PROGRAM_LICENSE_ASSIGNMENT",
+    PROGRAM_LICENSE_GROUP_ASSIGNMENT = "PROGRAM_LICENSE_GROUP_ASSIGNMENT",
+    USER_LICENSE_ASSIGNMENT = "USER_LICENSE_ASSIGNMENT",
+    USER_LICENSE_GROUP_ASSIGNMENT = "USER_LICENSE_GROUP_ASSIGNMENT"
+}

package/dist/types/services/NotificationsService.d.ts

@@ -7,7 +7,14 @@ import type { Notification } from '../models/Notification';
 import type { NotificationCount } from '../models/NotificationCount';
 import type { NotificationPreview } from '../models/NotificationPreview';
 import type { NotificationSource } from '../models/NotificationSource';
+import type { NotificationTemplateDetail } from '../models/NotificationTemplateDetail';
+import type { NotificationTemplateList } from '../models/NotificationTemplateList';
+import type { NotificationTemplateTest } from '../models/NotificationTemplateTest';
+import type { NotificationTemplateTestResponse } from '../models/NotificationTemplateTestResponse';
+import type { NotificationToggle } from '../models/NotificationToggle';
 import type { PatchedNotification } from '../models/PatchedNotification';
+import type { PatchedNotificationTemplateDetail } from '../models/PatchedNotificationTemplateDetail';
+import type { PatchedNotificationToggle } from '../models/PatchedNotificationToggle';
 import type { PreviewResponse } from '../models/PreviewResponse';
 import type { Recipient } from '../models/Recipient';
 import type { SendNotification } from '../models/SendNotification';
@@ -213,4 +220,69 @@ export declare class NotificationsService {
         platformKey: string;
         requestBody: TestSMTPCredentials;
     }): CancelablePromise<TestSMTPResponse>;
+    /**
+     * List notification templates
+     * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main.
+     * @returns NotificationTemplateList
+     * @throws ApiError
+     */
+    static notificationV1PlatformsTemplatesList({ platformKey, }: {
+        platformKey: string;
+    }): CancelablePromise<Array<NotificationTemplateList>>;
+    /**
+     * Get notification template details
+     * Get detailed view of a notification template by type. Returns platform-specific template if exists, otherwise main template.
+     * @returns NotificationTemplateDetail
+     * @throws ApiError
+     */
+    static notificationV1PlatformsTemplatesRetrieve({ notificationType, platformKey, }: {
+        notificationType: string;
+        platformKey: string;
+    }): CancelablePromise<NotificationTemplateDetail>;
+    /**
+     * Update notification template
+     * Update notification template. Creates platform-specific copy on first edit.
+     * @returns NotificationTemplateDetail
+     * @throws ApiError
+     */
+    static notificationV1PlatformsTemplatesPartialUpdate({ notificationType, platformKey, requestBody, }: {
+        notificationType: string;
+        platformKey: string;
+        requestBody?: PatchedNotificationTemplateDetail;
+    }): CancelablePromise<NotificationTemplateDetail>;
+    /**
+     * Reset template to default
+     * Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved.
+     * @returns any
+     * @throws ApiError
+     */
+    static notificationV1PlatformsTemplatesResetCreate({ notificationType, platformKey, }: {
+        notificationType: string;
+        platformKey: string;
+    }): CancelablePromise<{
+        message?: string;
+        deleted?: boolean;
+    }>;
+    /**
+     * Send test notification
+     * Send a test notification to verify template rendering and delivery. Sends to the requesting admin's email or a specified test email.
+     * @returns NotificationTemplateTestResponse
+     * @throws ApiError
+     */
+    static notificationV1PlatformsTemplatesTestCreate({ notificationType, platformKey, requestBody, }: {
+        notificationType: string;
+        platformKey: string;
+        requestBody?: NotificationTemplateTest;
+    }): CancelablePromise<NotificationTemplateTestResponse>;
+    /**
+     * Toggle notification preference
+     * Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template.
+     * @returns NotificationToggle
+     * @throws ApiError
+     */
+    static notificationV1PlatformsTemplatesTogglePartialUpdate({ notificationType, platformKey, requestBody, }: {
+        notificationType: string;
+        platformKey: string;
+        requestBody?: PatchedNotificationToggle;
+    }): CancelablePromise<NotificationToggle>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/iblai-api",
-  "version": "4.59.3-core",
+  "version": "4.60.0-core",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "type": "module",