@iblai/iblai-api 4.108.1-core → 4.109.0-core

package/src/services/NotificationsService.ts

@@ -11,6 +11,7 @@ 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 { NotificationsUpdate } from '../models/NotificationsUpdate';
 import type { NotificationTemplateDetail } from '../models/NotificationTemplateDetail';
 import type { NotificationTemplateList } from '../models/NotificationTemplateList';
 import type { NotificationTemplateTest } from '../models/NotificationTemplateTest';
@@ -52,7 +53,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Get notifications for a user
+     * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
      * @returns Notification
      * @throws ApiError
      */
@@ -87,7 +88,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
      * @returns Notification
      * @throws ApiError
      */
@@ -96,7 +97,7 @@ export class NotificationsService {
         requestBody,
     }: {
         org: string,
-        requestBody: Notification,
+        requestBody: NotificationsUpdate,
     }): CancelablePromise<Notification> {
         return __request(OpenAPI, {
             method: 'PUT',
@@ -109,7 +110,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
      * @returns Notification
      * @throws ApiError
      */
@@ -131,7 +132,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Get notifications for a user
+     * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
      * @returns Notification
      * @throws ApiError
      */
@@ -169,7 +170,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
      * @returns Notification
      * @throws ApiError
      */
@@ -180,7 +181,7 @@ export class NotificationsService {
     }: {
         org: string,
         userId: string,
-        requestBody: Notification,
+        requestBody: NotificationsUpdate,
     }): CancelablePromise<Notification> {
         return __request(OpenAPI, {
             method: 'PUT',
@@ -194,7 +195,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Get notifications count for a user
+     * Get notifications count for a user. Requires: Ibl.Notifications/Notification/list
      * @returns NotificationCount
      * @throws ApiError
      */
@@ -223,7 +224,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Delete a notification for a user. Requires: Ibl.Notifications/Notification/delete
      * @returns void
      * @throws ApiError
      */
@@ -247,7 +248,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
      * @returns Notification
      * @throws ApiError
      */
@@ -272,7 +273,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Re-enable campaigns for a user
+     * Re-enable campaigns for a user. Requires: Ibl.Notifications/Campaigns/action
      * @returns any
      * @throws ApiError
      */
@@ -297,7 +298,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Exclude a user from specified campaigns
+     * Exclude a user from specified campaigns. Requires: Ibl.Notifications/Campaigns/action
      * @returns any
      * @throws ApiError
      */
@@ -322,7 +323,7 @@ export class NotificationsService {
         });
     }
     /**
-     * Mark all notifications as read for a user. Optionally provide specific notification IDs.
+     * Mark all notifications as read for a user. Optionally provide specific notification IDs. Requires: Ibl.Notifications/Notification/write
      * @returns MarkAllReadResponse
      * @throws ApiError
      */
@@ -475,7 +476,7 @@ export class NotificationsService {
     }
     /**
      * Test SMTP credentials for a platform
-     * Test SMTP credentials by sending a test email to the specified address
+     * Test SMTP credentials by sending a test email to the specified address. Requires: Ibl.Notifications/SMTP/action
      * @returns TestSMTPResponse
      * @throws ApiError
      */
@@ -498,7 +499,7 @@ export class NotificationsService {
     }
     /**
      * List notification templates
-     * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main.
+     * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main. Requires permission: Ibl.Notifications/NotificationTemplate/list
      * @returns NotificationTemplateList
      * @throws ApiError
      */
@@ -517,7 +518,7 @@ export class NotificationsService {
     }
     /**
      * Get notification template details
-     * Get detailed view of a notification template by type. Returns platform-specific template if exists, otherwise main template.
+     * Get detailed view of a notification template by type. Returns platform-specific template if exists, otherwise main template. Requires permission: Ibl.Notifications/NotificationTemplate/read
      * @returns NotificationTemplateDetail
      * @throws ApiError
      */
@@ -539,7 +540,7 @@ export class NotificationsService {
     }
     /**
      * Update notification template
-     * Update notification template. Creates platform-specific copy on first edit.
+     * Update notification template. Creates platform-specific copy on first edit. Requires permission: Ibl.Notifications/NotificationTemplate/write
      * @returns NotificationTemplateDetail
      * @throws ApiError
      */
@@ -565,7 +566,7 @@ export class NotificationsService {
     }
     /**
      * Reset template to default
-     * Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved.
+     * Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved. Requires permission: Ibl.Notifications/NotificationTemplate/write
      * @returns any
      * @throws ApiError
      */
@@ -590,7 +591,7 @@ export class NotificationsService {
     }
     /**
      * 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.
+     * Send a test notification to verify template rendering and delivery. Sends to the requesting admin's email or a specified test email. Requires permission: Ibl.Notifications/NotificationTemplate/action
      * @returns NotificationTemplateTestResponse
      * @throws ApiError
      */
@@ -616,7 +617,7 @@ export class NotificationsService {
     }
     /**
      * Toggle notification preference
-     * Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template.
+     * Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template. Requires permission: Ibl.Notifications/NotificationTemplate/write
      * @returns NotificationToggle
      * @throws ApiError
      */