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

package/src/services/NotificationsService.ts

@@ -2,6 +2,7 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+import type { AvailableNotificationType } from '../models/AvailableNotificationType';
 import type { CampaignEnablement } from '../models/CampaignEnablement';
 import type { CampaignExclusion } from '../models/CampaignExclusion';
 import type { ContextResponse } from '../models/ContextResponse';
@@ -17,15 +18,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';
 import { OpenAPI } from '../core/OpenAPI';
@@ -549,6 +554,149 @@ export class NotificationsService {
             mediaType: 'application/json',
         });
     }
+    /**
+     * 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
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/notification/v1/platforms/{platform_key}/notification-preferences/',
+            path: {
+                'platform_key': platformKey,
+            },
+            query: {
+                'tags': tags,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/notification/v1/platforms/{platform_key}/notification-preferences/',
+            path: {
+                'platform_key': platformKey,
+            },
+            query: {
+                'tags': tags,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * 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
+     */
+    public 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>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/notification/v1/platforms/{platform_key}/notification-preferences/available-types/',
+            path: {
+                'platform_key': platformKey,
+            },
+            query: {
+                'tags': tags,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * Update per-type notification preference
+     * Set enabled/frequency for a single notification type. RBAC: Ibl.Notifications/Notification/write
+     * @returns NotificationTypePreference
+     * @throws ApiError
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/notification/v1/platforms/{platform_key}/notification-preferences/types/{notification_type}/',
+            path: {
+                'notification_type': notificationType,
+                'platform_key': platformKey,
+            },
+            query: {
+                'tags': tags,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
     /**
      * 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