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

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

@@ -1,11 +1,11 @@
 import type { BlankEnum } from './BlankEnum';
-import type { NotificationStatusEnum } from './NotificationStatusEnum';
+import type { Status3daEnum } from './Status3daEnum';
 export type PatchedNotification = {
     readonly id?: string;
     username?: string;
     readonly title?: string;
     readonly body?: string;
-    status?: (NotificationStatusEnum | BlankEnum);
+    status?: (Status3daEnum | BlankEnum);
     readonly channel?: string | null;
     context?: any;
     readonly short_message?: string;

package/dist/types/models/{NotificationStatusEnum.d.ts → Status3daEnum.d.ts}

@@ -3,7 +3,7 @@
  * * `UNREAD` - Unread
  * * `CANCELLED` - Cancelled
  */
-export declare enum NotificationStatusEnum {
+export declare enum Status3daEnum {
     READ = "READ",
     UNREAD = "UNREAD",
     CANCELLED = "CANCELLED"

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

@@ -7,6 +7,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';
@@ -36,7 +37,7 @@ export declare class NotificationsService {
         message?: string;
     }>;
     /**
-     * Get notifications for a user
+     * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
      * @returns Notification
      * @throws ApiError
      */
@@ -49,16 +50,16 @@ export declare class NotificationsService {
         status?: string;
     }): CancelablePromise<Notification>;
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
      * @returns Notification
      * @throws ApiError
      */
     static notificationV1OrgsNotificationsUpdate({ org, requestBody, }: {
         org: string;
-        requestBody: Notification;
+        requestBody: NotificationsUpdate;
     }): CancelablePromise<Notification>;
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
      * @returns Notification
      * @throws ApiError
      */
@@ -67,7 +68,7 @@ export declare class NotificationsService {
         requestBody?: PatchedNotification;
     }): CancelablePromise<Notification>;
     /**
-     * Get notifications for a user
+     * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
      * @returns Notification
      * @throws ApiError
      */
@@ -80,16 +81,16 @@ export declare class NotificationsService {
         status?: string;
     }): CancelablePromise<Notification>;
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
      * @returns Notification
      * @throws ApiError
      */
     static notificationV1OrgsUsersNotificationsUpdate({ org, userId, requestBody, }: {
         org: string;
-        requestBody: Notification;
+        requestBody: NotificationsUpdate;
     }): CancelablePromise<Notification>;
     /**
-     * Get notifications count for a user
+     * Get notifications count for a user. Requires: Ibl.Notifications/Notification/list
      * @returns NotificationCount
      * @throws ApiError
      */
@@ -99,7 +100,7 @@ export declare class NotificationsService {
         status?: string;
     }): CancelablePromise<NotificationCount>;
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Delete a notification for a user. Requires: Ibl.Notifications/Notification/delete
      * @returns void
      * @throws ApiError
      */
@@ -108,7 +109,7 @@ export declare class NotificationsService {
         org: string;
     }): CancelablePromise<void>;
     /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
      * @returns Notification
      * @throws ApiError
      */
@@ -117,7 +118,7 @@ export declare class NotificationsService {
         requestBody?: PatchedNotification;
     }): CancelablePromise<Notification>;
     /**
-     * Re-enable campaigns for a user
+     * Re-enable campaigns for a user. Requires: Ibl.Notifications/Campaigns/action
      * @returns any
      * @throws ApiError
      */
@@ -129,7 +130,7 @@ export declare class NotificationsService {
         message?: string;
     }>;
     /**
-     * Exclude a user from specified campaigns
+     * Exclude a user from specified campaigns. Requires: Ibl.Notifications/Campaigns/action
      * @returns any
      * @throws ApiError
      */
@@ -141,7 +142,7 @@ export declare class NotificationsService {
         message?: string;
     }>;
     /**
-     * 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
      */
@@ -212,7 +213,7 @@ export declare class NotificationsService {
     }): CancelablePromise<ValidateSourceResponse>;
     /**
      * 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
      */
@@ -222,7 +223,7 @@ export declare class NotificationsService {
     }): CancelablePromise<TestSMTPResponse>;
     /**
      * 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
      */
@@ -231,7 +232,7 @@ export declare class NotificationsService {
     }): 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.
+     * 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
      */
@@ -241,7 +242,7 @@ export declare class NotificationsService {
     }): CancelablePromise<NotificationTemplateDetail>;
     /**
      * 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
      */
@@ -252,7 +253,7 @@ export declare class NotificationsService {
     }): CancelablePromise<NotificationTemplateDetail>;
     /**
      * 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
      */
@@ -265,7 +266,7 @@ export declare 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
      */
@@ -276,7 +277,7 @@ export declare class NotificationsService {
     }): CancelablePromise<NotificationTemplateTestResponse>;
     /**
      * 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
      */

package/package.json

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

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.108.1-core
+  version: 4.109.0-core
   description: API for iblai
 paths:
   /api/analytics/content/:
@@ -23017,7 +23017,7 @@ paths:
   /api/notification/v1/orgs/{org}/notifications/:
     get:
       operationId: notification_v1_orgs_notifications_retrieve
-      description: Get notifications for a user
+      description: 'Get notifications for a user. Requires: Ibl.Notifications/Notification/list'
       parameters:
       - in: query
         name: channel
@@ -23062,7 +23062,7 @@ paths:
           description: ''
     put:
       operationId: notification_v1_orgs_notifications_update
-      description: Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+      description: 'Update notification status for a user. Requires: Ibl.Notifications/Notification/write'
       parameters:
       - in: path
         name: org
@@ -23075,19 +23075,19 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
           application/scim+json:
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
           application/x-www-form-urlencoded:
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
           multipart/form-data:
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
           '*/*':
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
         required: true
       security:
       - PlatformApiKeyAuthentication: []
@@ -23101,7 +23101,7 @@ paths:
   /api/notification/v1/orgs/{org}/notifications/bulk-update/:
     patch:
       operationId: notification_v1_orgs_notifications_bulk_update_partial_update
-      description: Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+      description: 'Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write'
       parameters:
       - in: path
         name: org
@@ -23139,7 +23139,7 @@ paths:
   /api/notification/v1/orgs/{org}/users/{user_id}/notifications/:
     get:
       operationId: notification_v1_orgs_users_notifications_retrieve
-      description: Get notifications for a user
+      description: 'Get notifications for a user. Requires: Ibl.Notifications/Notification/list'
       parameters:
       - in: query
         name: channel
@@ -23189,7 +23189,7 @@ paths:
           description: ''
     put:
       operationId: notification_v1_orgs_users_notifications_update
-      description: Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+      description: 'Update notification status for a user. Requires: Ibl.Notifications/Notification/write'
       parameters:
       - in: path
         name: org
@@ -23207,19 +23207,19 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
           application/scim+json:
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
           application/x-www-form-urlencoded:
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
           multipart/form-data:
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
           '*/*':
             schema:
-              $ref: '#/components/schemas/Notification'
+              $ref: '#/components/schemas/NotificationsUpdate'
         required: true
       security:
       - PlatformApiKeyAuthentication: []
@@ -23233,7 +23233,7 @@ paths:
   /api/notification/v1/orgs/{org}/users/{user_id}/notifications-count/:
     get:
       operationId: notification_v1_orgs_users_notifications_count_retrieve
-      description: Get notifications count for a user
+      description: 'Get notifications count for a user. Requires: Ibl.Notifications/Notification/list'
       parameters:
       - in: query
         name: channel
@@ -23269,7 +23269,7 @@ paths:
   /api/notification/v1/orgs/{org}/users/{user_id}/notifications/{notification_id}/:
     delete:
       operationId: notification_v1_orgs_users_notifications_destroy
-      description: Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+      description: 'Delete a notification for a user. Requires: Ibl.Notifications/Notification/delete'
       parameters:
       - in: path
         name: notification_id
@@ -23296,7 +23296,7 @@ paths:
   /api/notification/v1/orgs/{org}/users/{user_id}/notifications/bulk-update/:
     patch:
       operationId: notification_v1_orgs_users_notifications_bulk_update_partial_update
-      description: Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+      description: 'Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write'
       parameters:
       - in: path
         name: org
@@ -23339,7 +23339,7 @@ paths:
   /api/notification/v1/orgs/{platform_key}/campaigns/enable/:
     post:
       operationId: notification_v1_orgs_campaigns_enable_create
-      description: Re-enable campaigns for a user
+      description: 'Re-enable campaigns for a user. Requires: Ibl.Notifications/Campaigns/action'
       parameters:
       - in: path
         name: platform_key
@@ -23382,7 +23382,7 @@ paths:
   /api/notification/v1/orgs/{platform_key}/campaigns/exclude/:
     post:
       operationId: notification_v1_orgs_campaigns_exclude_create
-      description: Exclude a user from specified campaigns
+      description: 'Exclude a user from specified campaigns. Requires: Ibl.Notifications/Campaigns/action'
       parameters:
       - in: path
         name: platform_key
@@ -23425,8 +23425,8 @@ paths:
   /api/notification/v1/orgs/{platform_key}/mark-all-as-read:
     post:
       operationId: notification_v1_orgs_mark_all_as_read_create
-      description: Mark all notifications as read for a user. Optionally provide specific
-        notification IDs.
+      description: 'Mark all notifications as read for a user. Optionally provide
+        specific notification IDs. Requires: Ibl.Notifications/Notification/write'
       parameters:
       - in: path
         name: platform_key
@@ -23706,8 +23706,8 @@ paths:
   /api/notification/v1/platforms/{platform_key}/config/test-smtp/:
     post:
       operationId: notification_v1_platforms_config_test_smtp_create
-      description: Test SMTP credentials by sending a test email to the specified
-        address
+      description: 'Test SMTP credentials by sending a test email to the specified
+        address. Requires: Ibl.Notifications/SMTP/action'
       summary: Test SMTP credentials for a platform
       parameters:
       - in: path
@@ -23747,8 +23747,9 @@ paths:
   /api/notification/v1/platforms/{platform_key}/templates/:
     get:
       operationId: notification_v1_platforms_templates_list
-      description: Get all notification templates for the platform. Includes both
-        platform-specific and inherited templates from main.
+      description: 'Get all notification templates for the platform. Includes both
+        platform-specific and inherited templates from main. Requires permission:
+        Ibl.Notifications/NotificationTemplate/list'
       summary: List notification templates
       parameters:
       - in: path
@@ -23772,8 +23773,9 @@ paths:
   /api/notification/v1/platforms/{platform_key}/templates/{notification_type}/:
     get:
       operationId: notification_v1_platforms_templates_retrieve
-      description: Get detailed view of a notification template by type. Returns platform-specific
-        template if exists, otherwise main template.
+      description: 'Get detailed view of a notification template by type. Returns
+        platform-specific template if exists, otherwise main template. Requires permission:
+        Ibl.Notifications/NotificationTemplate/read'
       summary: Get notification template details
       parameters:
       - in: path
@@ -23799,8 +23801,8 @@ paths:
           description: ''
     patch:
       operationId: notification_v1_platforms_templates_partial_update
-      description: Update notification template. Creates platform-specific copy on
-        first edit.
+      description: 'Update notification template. Creates platform-specific copy on
+        first edit. Requires permission: Ibl.Notifications/NotificationTemplate/write'
       summary: Update notification template
       parameters:
       - in: path
@@ -23844,8 +23846,9 @@ paths:
   /api/notification/v1/platforms/{platform_key}/templates/{notification_type}/reset/:
     post:
       operationId: notification_v1_platforms_templates_reset_create
-      description: Delete platform-specific template override and revert to main template.
-        Notification preference (on/off) is preserved.
+      description: 'Delete platform-specific template override and revert to main
+        template. Notification preference (on/off) is preserved. Requires permission:
+        Ibl.Notifications/NotificationTemplate/write'
       summary: Reset template to default
       parameters:
       - in: path
@@ -23877,8 +23880,9 @@ paths:
   /api/notification/v1/platforms/{platform_key}/templates/{notification_type}/test/:
     post:
       operationId: notification_v1_platforms_templates_test_create
-      description: Send a test notification to verify template rendering and delivery.
-        Sends to the requesting admin's email or a specified test email.
+      description: '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'
       summary: Send test notification
       parameters:
       - in: path
@@ -23922,8 +23926,8 @@ paths:
   /api/notification/v1/platforms/{platform_key}/templates/{notification_type}/toggle/:
     patch:
       operationId: notification_v1_platforms_templates_toggle_partial_update
-      description: Enable or disable a notification type for the platform. This sets
-        the NotificationPreference, not the template.
+      description: 'Enable or disable a notification type for the platform. This sets
+        the NotificationPreference, not the template. Requires permission: Ibl.Notifications/NotificationTemplate/write'
       summary: Toggle notification preference
       parameters:
       - in: path
@@ -36281,7 +36285,7 @@ components:
         status:
           title: Message status
           oneOf:
-          - $ref: '#/components/schemas/NotificationStatusEnum'
+          - $ref: '#/components/schemas/Status3daEnum'
           - $ref: '#/components/schemas/BlankEnum'
         channel:
           type: string
@@ -36383,16 +36387,6 @@ components:
         * `department` - department
         * `pathway` - pathway
         * `program` - program
-    NotificationStatusEnum:
-      enum:
-      - READ
-      - UNREAD
-      - CANCELLED
-      type: string
-      description: |-
-        * `READ` - Read
-        * `UNREAD` - Unread
-        * `CANCELLED` - Cancelled
     NotificationTemplateData:
       type: object
       properties:
@@ -36711,6 +36705,16 @@ components:
           type: boolean
       required:
       - allow_notification
+    NotificationsUpdate:
+      type: object
+      properties:
+        notification_id:
+          type: string
+          default: ''
+        status:
+          $ref: '#/components/schemas/Status3daEnum'
+      required:
+      - status
     NullEnum:
       enum:
       - null
@@ -37705,7 +37709,7 @@ components:
         status:
           title: Message status
           oneOf:
-          - $ref: '#/components/schemas/NotificationStatusEnum'
+          - $ref: '#/components/schemas/Status3daEnum'
           - $ref: '#/components/schemas/BlankEnum'
         channel:
           type: string
@@ -42717,6 +42721,16 @@ components:
         * `cancelled` - Cancelled
         * `error` - Error
         * `expired` - Expired
+    Status3daEnum:
+      enum:
+      - READ
+      - UNREAD
+      - CANCELLED
+      type: string
+      description: |-
+        * `READ` - Read
+        * `UNREAD` - Unread
+        * `CANCELLED` - Cancelled
     StripeBillingPageIdentifierResponse:
       type: object
       properties:

package/src/core/OpenAPI.ts

@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: 'https://base.manager.iblai.app',
-    VERSION: '4.108.1-core',
+    VERSION: '4.109.0-core',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/src/index.ts

@@ -187,7 +187,7 @@ export type { NotificationCount } from './models/NotificationCount';
 export type { NotificationPreview } from './models/NotificationPreview';
 export type { NotificationSource } from './models/NotificationSource';
 export { NotificationSourceTypeEnum } from './models/NotificationSourceTypeEnum';
-export { NotificationStatusEnum } from './models/NotificationStatusEnum';
+export type { NotificationsUpdate } from './models/NotificationsUpdate';
 export type { NotificationTemplateData } from './models/NotificationTemplateData';
 export type { NotificationTemplateDetail } from './models/NotificationTemplateDetail';
 export type { NotificationTemplateList } from './models/NotificationTemplateList';
@@ -396,6 +396,7 @@ export type { SkillsMetric } from './models/SkillsMetric';
 export type { SkillThreshold } from './models/SkillThreshold';
 export type { Spa } from './models/Spa';
 export { StateEnum } from './models/StateEnum';
+export { Status3daEnum } from './models/Status3daEnum';
 export type { StripeBillingPageIdentifierResponse } from './models/StripeBillingPageIdentifierResponse';
 export type { StripeCheckoutSessionRequest } from './models/StripeCheckoutSessionRequest';
 export type { StripeCheckoutSessionResponse } from './models/StripeCheckoutSessionResponse';

package/src/models/Notification.ts

@@ -3,13 +3,13 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { BlankEnum } from './BlankEnum';
-import type { NotificationStatusEnum } from './NotificationStatusEnum';
+import type { Status3daEnum } from './Status3daEnum';
 export type Notification = {
     readonly id: string;
     username: string;
     readonly title: string;
     readonly body: string;
-    status?: (NotificationStatusEnum | BlankEnum);
+    status?: (Status3daEnum | BlankEnum);
     readonly channel: string | null;
     context?: any;
     readonly short_message: string;

package/src/models/NotificationsUpdate.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Status3daEnum } from './Status3daEnum';
+export type NotificationsUpdate = {
+    notification_id?: string;
+    status: Status3daEnum;
+};
+

package/src/models/PatchedNotification.ts

@@ -3,13 +3,13 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { BlankEnum } from './BlankEnum';
-import type { NotificationStatusEnum } from './NotificationStatusEnum';
+import type { Status3daEnum } from './Status3daEnum';
 export type PatchedNotification = {
     readonly id?: string;
     username?: string;
     readonly title?: string;
     readonly body?: string;
-    status?: (NotificationStatusEnum | BlankEnum);
+    status?: (Status3daEnum | BlankEnum);
     readonly channel?: string | null;
     context?: any;
     readonly short_message?: string;

package/src/models/{NotificationStatusEnum.ts → Status3daEnum.ts}

@@ -7,7 +7,7 @@
  * * `UNREAD` - Unread
  * * `CANCELLED` - Cancelled
  */
-export enum NotificationStatusEnum {
+export enum Status3daEnum {
     READ = 'READ',
     UNREAD = 'UNREAD',
     CANCELLED = 'CANCELLED',