@iblai/iblai-api 4.250.4-core → 4.250.5-core

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

@@ -1,3 +1,4 @@
+import type { AvailableNotificationType } from '../models/AvailableNotificationType';
 import type { CampaignEnablement } from '../models/CampaignEnablement';
 import type { CampaignExclusion } from '../models/CampaignExclusion';
 import type { ContextResponse } from '../models/ContextResponse';
@@ -13,15 +14,19 @@ import type { NotificationTemplateList } from '../models/NotificationTemplateLis
 import type { NotificationTemplateTest } from '../models/NotificationTemplateTest';
 import type { NotificationTemplateTestResponse } from '../models/NotificationTemplateTestResponse';
 import type { NotificationToggle } from '../models/NotificationToggle';
+import type { NotificationTypePreference } from '../models/NotificationTypePreference';
 import type { PatchedNotification } from '../models/PatchedNotification';
 import type { PatchedNotificationTemplateDetail } from '../models/PatchedNotificationTemplateDetail';
 import type { PatchedNotificationToggle } from '../models/PatchedNotificationToggle';
+import type { PatchedNotificationTypePreference } from '../models/PatchedNotificationTypePreference';
+import type { PatchedUserNotificationPreferences } from '../models/PatchedUserNotificationPreferences';
 import type { PreviewResponse } from '../models/PreviewResponse';
 import type { Recipient } from '../models/Recipient';
 import type { SendNotification } from '../models/SendNotification';
 import type { SendResponse } from '../models/SendResponse';
 import type { TestSMTPCredentials } from '../models/TestSMTPCredentials';
 import type { TestSMTPResponse } from '../models/TestSMTPResponse';
+import type { UserNotificationPreferences } from '../models/UserNotificationPreferences';
 import type { ValidateSourceResponse } from '../models/ValidateSourceResponse';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class NotificationsService {
@@ -261,6 +266,77 @@ export declare class NotificationsService {
         platformKey: string;
         requestBody: TestSMTPCredentials;
     }): CancelablePromise<TestSMTPResponse>;
+    /**
+     * Get user notification preferences
+     * Retrieve notification preferences for the authenticated user (or another user via ?username= for admins). Auto-creates preferences with defaults on first access. RBAC: Ibl.Notifications/Notification/read
+     * @returns UserNotificationPreferences
+     * @throws ApiError
+     */
+    static notificationV1PlatformsNotificationPreferencesRetrieve({ platformKey, tags, username, }: {
+        platformKey: string;
+        /**
+         * Comma-separated tags to filter by (e.g. 'learning,activity'). Returns types matching ANY tag.
+         */
+        tags?: string;
+        /**
+         * Username to manage preferences for (admin only). Defaults to authenticated user.
+         */
+        username?: string;
+    }): CancelablePromise<UserNotificationPreferences>;
+    /**
+     * Update user notification preferences
+     * Partially update global notification preferences. Per-type overrides use the /types/{notification_type}/ endpoint. RBAC: Ibl.Notifications/Notification/write
+     * @returns UserNotificationPreferences
+     * @throws ApiError
+     */
+    static notificationV1PlatformsNotificationPreferencesPartialUpdate({ platformKey, tags, username, requestBody, }: {
+        platformKey: string;
+        /**
+         * Comma-separated tags to filter by (e.g. 'learning,activity'). Returns types matching ANY tag.
+         */
+        tags?: string;
+        /**
+         * Username to manage preferences for (admin only). Defaults to authenticated user.
+         */
+        username?: string;
+        requestBody?: PatchedUserNotificationPreferences;
+    }): CancelablePromise<UserNotificationPreferences>;
+    /**
+     * List available notification types
+     * Returns notification types enabled for this platform, annotated with the user's per-type preferences. RBAC: Ibl.Notifications/Notification/read
+     * @returns AvailableNotificationType
+     * @throws ApiError
+     */
+    static notificationV1PlatformsNotificationPreferencesAvailableTypesList({ platformKey, tags, username, }: {
+        platformKey: string;
+        /**
+         * Comma-separated tags to filter by (e.g. 'learning,activity'). Returns types matching ANY tag.
+         */
+        tags?: string;
+        /**
+         * Username to manage preferences for (admin only). Defaults to authenticated user.
+         */
+        username?: string;
+    }): CancelablePromise<Array<AvailableNotificationType>>;
+    /**
+     * Update per-type notification preference
+     * Set enabled/frequency for a single notification type. RBAC: Ibl.Notifications/Notification/write
+     * @returns NotificationTypePreference
+     * @throws ApiError
+     */
+    static notificationV1PlatformsNotificationPreferencesTypesPartialUpdate({ notificationType, platformKey, tags, username, requestBody, }: {
+        notificationType: string;
+        platformKey: string;
+        /**
+         * Comma-separated tags to filter by (e.g. 'learning,activity'). Returns types matching ANY tag.
+         */
+        tags?: string;
+        /**
+         * Username to manage preferences for (admin only). Defaults to authenticated user.
+         */
+        username?: string;
+        requestBody?: PatchedNotificationTypePreference;
+    }): CancelablePromise<NotificationTypePreference>;
     /**
      * List notification templates
      * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main. Filter by tags with ?tags=learning,activity (comma-separated, OR logic). Requires permission: Ibl.Notifications/NotificationTemplate/list

package/package.json

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