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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs.js CHANGED
@@ -110,7 +110,7 @@ class CancelablePromise {
110
110
 
111
111
  const OpenAPI = {
112
112
  BASE: 'https://base.manager.iblai.app',
113
- VERSION: '4.108.1-core',
113
+ VERSION: '4.109.0-core',
114
114
  WITH_CREDENTIALS: false,
115
115
  CREDENTIALS: 'include',
116
116
  TOKEN: undefined,
@@ -285,22 +285,6 @@ exports.NotificationSourceTypeEnum = void 0;
285
285
  NotificationSourceTypeEnum["PROGRAM"] = "program";
286
286
  })(exports.NotificationSourceTypeEnum || (exports.NotificationSourceTypeEnum = {}));
287
287
 
288
- /* generated using openapi-typescript-codegen -- do not edit */
289
- /* istanbul ignore file */
290
- /* tslint:disable */
291
- /* eslint-disable */
292
- /**
293
- * * `READ` - Read
294
- * * `UNREAD` - Unread
295
- * * `CANCELLED` - Cancelled
296
- */
297
- exports.NotificationStatusEnum = void 0;
298
- (function (NotificationStatusEnum) {
299
- NotificationStatusEnum["READ"] = "READ";
300
- NotificationStatusEnum["UNREAD"] = "UNREAD";
301
- NotificationStatusEnum["CANCELLED"] = "CANCELLED";
302
- })(exports.NotificationStatusEnum || (exports.NotificationStatusEnum = {}));
303
-
304
288
  /* generated using openapi-typescript-codegen -- do not edit */
305
289
  /* istanbul ignore file */
306
290
  /* tslint:disable */
@@ -429,6 +413,22 @@ exports.StateEnum = void 0;
429
413
  StateEnum["EXPIRED"] = "expired";
430
414
  })(exports.StateEnum || (exports.StateEnum = {}));
431
415
 
416
+ /* generated using openapi-typescript-codegen -- do not edit */
417
+ /* istanbul ignore file */
418
+ /* tslint:disable */
419
+ /* eslint-disable */
420
+ /**
421
+ * * `READ` - Read
422
+ * * `UNREAD` - Unread
423
+ * * `CANCELLED` - Cancelled
424
+ */
425
+ exports.Status3daEnum = void 0;
426
+ (function (Status3daEnum) {
427
+ Status3daEnum["READ"] = "READ";
428
+ Status3daEnum["UNREAD"] = "UNREAD";
429
+ Status3daEnum["CANCELLED"] = "CANCELLED";
430
+ })(exports.Status3daEnum || (exports.Status3daEnum = {}));
431
+
432
432
  /* generated using openapi-typescript-codegen -- do not edit */
433
433
  /* istanbul ignore file */
434
434
  /* tslint:disable */
@@ -17544,7 +17544,7 @@ class NotificationsService {
17544
17544
  });
17545
17545
  }
17546
17546
  /**
17547
- * Get notifications for a user
17547
+ * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
17548
17548
  * @returns Notification
17549
17549
  * @throws ApiError
17550
17550
  */
@@ -17572,7 +17572,7 @@ class NotificationsService {
17572
17572
  });
17573
17573
  }
17574
17574
  /**
17575
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17575
+ * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
17576
17576
  * @returns Notification
17577
17577
  * @throws ApiError
17578
17578
  */
@@ -17591,7 +17591,7 @@ class NotificationsService {
17591
17591
  });
17592
17592
  }
17593
17593
  /**
17594
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17594
+ * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
17595
17595
  * @returns Notification
17596
17596
  * @throws ApiError
17597
17597
  */
@@ -17610,7 +17610,7 @@ class NotificationsService {
17610
17610
  });
17611
17611
  }
17612
17612
  /**
17613
- * Get notifications for a user
17613
+ * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
17614
17614
  * @returns Notification
17615
17615
  * @throws ApiError
17616
17616
  */
@@ -17640,7 +17640,7 @@ class NotificationsService {
17640
17640
  });
17641
17641
  }
17642
17642
  /**
17643
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17643
+ * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
17644
17644
  * @returns Notification
17645
17645
  * @throws ApiError
17646
17646
  */
@@ -17661,7 +17661,7 @@ class NotificationsService {
17661
17661
  });
17662
17662
  }
17663
17663
  /**
17664
- * Get notifications count for a user
17664
+ * Get notifications count for a user. Requires: Ibl.Notifications/Notification/list
17665
17665
  * @returns NotificationCount
17666
17666
  * @throws ApiError
17667
17667
  */
@@ -17685,7 +17685,7 @@ class NotificationsService {
17685
17685
  });
17686
17686
  }
17687
17687
  /**
17688
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17688
+ * Delete a notification for a user. Requires: Ibl.Notifications/Notification/delete
17689
17689
  * @returns void
17690
17690
  * @throws ApiError
17691
17691
  */
@@ -17705,7 +17705,7 @@ class NotificationsService {
17705
17705
  });
17706
17706
  }
17707
17707
  /**
17708
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17708
+ * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
17709
17709
  * @returns Notification
17710
17710
  * @throws ApiError
17711
17711
  */
@@ -17726,7 +17726,7 @@ class NotificationsService {
17726
17726
  });
17727
17727
  }
17728
17728
  /**
17729
- * Re-enable campaigns for a user
17729
+ * Re-enable campaigns for a user. Requires: Ibl.Notifications/Campaigns/action
17730
17730
  * @returns any
17731
17731
  * @throws ApiError
17732
17732
  */
@@ -17745,7 +17745,7 @@ class NotificationsService {
17745
17745
  });
17746
17746
  }
17747
17747
  /**
17748
- * Exclude a user from specified campaigns
17748
+ * Exclude a user from specified campaigns. Requires: Ibl.Notifications/Campaigns/action
17749
17749
  * @returns any
17750
17750
  * @throws ApiError
17751
17751
  */
@@ -17764,7 +17764,7 @@ class NotificationsService {
17764
17764
  });
17765
17765
  }
17766
17766
  /**
17767
- * Mark all notifications as read for a user. Optionally provide specific notification IDs.
17767
+ * Mark all notifications as read for a user. Optionally provide specific notification IDs. Requires: Ibl.Notifications/Notification/write
17768
17768
  * @returns MarkAllReadResponse
17769
17769
  * @throws ApiError
17770
17770
  */
@@ -17888,7 +17888,7 @@ class NotificationsService {
17888
17888
  }
17889
17889
  /**
17890
17890
  * Test SMTP credentials for a platform
17891
- * Test SMTP credentials by sending a test email to the specified address
17891
+ * Test SMTP credentials by sending a test email to the specified address. Requires: Ibl.Notifications/SMTP/action
17892
17892
  * @returns TestSMTPResponse
17893
17893
  * @throws ApiError
17894
17894
  */
@@ -17908,7 +17908,7 @@ class NotificationsService {
17908
17908
  }
17909
17909
  /**
17910
17910
  * List notification templates
17911
- * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main.
17911
+ * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main. Requires permission: Ibl.Notifications/NotificationTemplate/list
17912
17912
  * @returns NotificationTemplateList
17913
17913
  * @throws ApiError
17914
17914
  */
@@ -17925,7 +17925,7 @@ class NotificationsService {
17925
17925
  }
17926
17926
  /**
17927
17927
  * Get notification template details
17928
- * Get detailed view of a notification template by type. Returns platform-specific template if exists, otherwise main template.
17928
+ * Get detailed view of a notification template by type. Returns platform-specific template if exists, otherwise main template. Requires permission: Ibl.Notifications/NotificationTemplate/read
17929
17929
  * @returns NotificationTemplateDetail
17930
17930
  * @throws ApiError
17931
17931
  */
@@ -17944,7 +17944,7 @@ class NotificationsService {
17944
17944
  }
17945
17945
  /**
17946
17946
  * Update notification template
17947
- * Update notification template. Creates platform-specific copy on first edit.
17947
+ * Update notification template. Creates platform-specific copy on first edit. Requires permission: Ibl.Notifications/NotificationTemplate/write
17948
17948
  * @returns NotificationTemplateDetail
17949
17949
  * @throws ApiError
17950
17950
  */
@@ -17966,7 +17966,7 @@ class NotificationsService {
17966
17966
  }
17967
17967
  /**
17968
17968
  * Reset template to default
17969
- * Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved.
17969
+ * Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved. Requires permission: Ibl.Notifications/NotificationTemplate/write
17970
17970
  * @returns any
17971
17971
  * @throws ApiError
17972
17972
  */
@@ -17985,7 +17985,7 @@ class NotificationsService {
17985
17985
  }
17986
17986
  /**
17987
17987
  * Send test notification
17988
- * Send a test notification to verify template rendering and delivery. Sends to the requesting admin's email or a specified test email.
17988
+ * 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
17989
17989
  * @returns NotificationTemplateTestResponse
17990
17990
  * @throws ApiError
17991
17991
  */
@@ -18007,7 +18007,7 @@ class NotificationsService {
18007
18007
  }
18008
18008
  /**
18009
18009
  * Toggle notification preference
18010
- * Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template.
18010
+ * Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template. Requires permission: Ibl.Notifications/NotificationTemplate/write
18011
18011
  * @returns NotificationToggle
18012
18012
  * @throws ApiError
18013
18013
  */
package/dist/index.esm.js CHANGED
@@ -108,7 +108,7 @@ class CancelablePromise {
108
108
 
109
109
  const OpenAPI = {
110
110
  BASE: 'https://base.manager.iblai.app',
111
- VERSION: '4.108.1-core',
111
+ VERSION: '4.109.0-core',
112
112
  WITH_CREDENTIALS: false,
113
113
  CREDENTIALS: 'include',
114
114
  TOKEN: undefined,
@@ -283,22 +283,6 @@ var NotificationSourceTypeEnum;
283
283
  NotificationSourceTypeEnum["PROGRAM"] = "program";
284
284
  })(NotificationSourceTypeEnum || (NotificationSourceTypeEnum = {}));
285
285
 
286
- /* generated using openapi-typescript-codegen -- do not edit */
287
- /* istanbul ignore file */
288
- /* tslint:disable */
289
- /* eslint-disable */
290
- /**
291
- * * `READ` - Read
292
- * * `UNREAD` - Unread
293
- * * `CANCELLED` - Cancelled
294
- */
295
- var NotificationStatusEnum;
296
- (function (NotificationStatusEnum) {
297
- NotificationStatusEnum["READ"] = "READ";
298
- NotificationStatusEnum["UNREAD"] = "UNREAD";
299
- NotificationStatusEnum["CANCELLED"] = "CANCELLED";
300
- })(NotificationStatusEnum || (NotificationStatusEnum = {}));
301
-
302
286
  /* generated using openapi-typescript-codegen -- do not edit */
303
287
  /* istanbul ignore file */
304
288
  /* tslint:disable */
@@ -427,6 +411,22 @@ var StateEnum;
427
411
  StateEnum["EXPIRED"] = "expired";
428
412
  })(StateEnum || (StateEnum = {}));
429
413
 
414
+ /* generated using openapi-typescript-codegen -- do not edit */
415
+ /* istanbul ignore file */
416
+ /* tslint:disable */
417
+ /* eslint-disable */
418
+ /**
419
+ * * `READ` - Read
420
+ * * `UNREAD` - Unread
421
+ * * `CANCELLED` - Cancelled
422
+ */
423
+ var Status3daEnum;
424
+ (function (Status3daEnum) {
425
+ Status3daEnum["READ"] = "READ";
426
+ Status3daEnum["UNREAD"] = "UNREAD";
427
+ Status3daEnum["CANCELLED"] = "CANCELLED";
428
+ })(Status3daEnum || (Status3daEnum = {}));
429
+
430
430
  /* generated using openapi-typescript-codegen -- do not edit */
431
431
  /* istanbul ignore file */
432
432
  /* tslint:disable */
@@ -17542,7 +17542,7 @@ class NotificationsService {
17542
17542
  });
17543
17543
  }
17544
17544
  /**
17545
- * Get notifications for a user
17545
+ * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
17546
17546
  * @returns Notification
17547
17547
  * @throws ApiError
17548
17548
  */
@@ -17570,7 +17570,7 @@ class NotificationsService {
17570
17570
  });
17571
17571
  }
17572
17572
  /**
17573
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17573
+ * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
17574
17574
  * @returns Notification
17575
17575
  * @throws ApiError
17576
17576
  */
@@ -17589,7 +17589,7 @@ class NotificationsService {
17589
17589
  });
17590
17590
  }
17591
17591
  /**
17592
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17592
+ * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
17593
17593
  * @returns Notification
17594
17594
  * @throws ApiError
17595
17595
  */
@@ -17608,7 +17608,7 @@ class NotificationsService {
17608
17608
  });
17609
17609
  }
17610
17610
  /**
17611
- * Get notifications for a user
17611
+ * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
17612
17612
  * @returns Notification
17613
17613
  * @throws ApiError
17614
17614
  */
@@ -17638,7 +17638,7 @@ class NotificationsService {
17638
17638
  });
17639
17639
  }
17640
17640
  /**
17641
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17641
+ * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
17642
17642
  * @returns Notification
17643
17643
  * @throws ApiError
17644
17644
  */
@@ -17659,7 +17659,7 @@ class NotificationsService {
17659
17659
  });
17660
17660
  }
17661
17661
  /**
17662
- * Get notifications count for a user
17662
+ * Get notifications count for a user. Requires: Ibl.Notifications/Notification/list
17663
17663
  * @returns NotificationCount
17664
17664
  * @throws ApiError
17665
17665
  */
@@ -17683,7 +17683,7 @@ class NotificationsService {
17683
17683
  });
17684
17684
  }
17685
17685
  /**
17686
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17686
+ * Delete a notification for a user. Requires: Ibl.Notifications/Notification/delete
17687
17687
  * @returns void
17688
17688
  * @throws ApiError
17689
17689
  */
@@ -17703,7 +17703,7 @@ class NotificationsService {
17703
17703
  });
17704
17704
  }
17705
17705
  /**
17706
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17706
+ * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
17707
17707
  * @returns Notification
17708
17708
  * @throws ApiError
17709
17709
  */
@@ -17724,7 +17724,7 @@ class NotificationsService {
17724
17724
  });
17725
17725
  }
17726
17726
  /**
17727
- * Re-enable campaigns for a user
17727
+ * Re-enable campaigns for a user. Requires: Ibl.Notifications/Campaigns/action
17728
17728
  * @returns any
17729
17729
  * @throws ApiError
17730
17730
  */
@@ -17743,7 +17743,7 @@ class NotificationsService {
17743
17743
  });
17744
17744
  }
17745
17745
  /**
17746
- * Exclude a user from specified campaigns
17746
+ * Exclude a user from specified campaigns. Requires: Ibl.Notifications/Campaigns/action
17747
17747
  * @returns any
17748
17748
  * @throws ApiError
17749
17749
  */
@@ -17762,7 +17762,7 @@ class NotificationsService {
17762
17762
  });
17763
17763
  }
17764
17764
  /**
17765
- * Mark all notifications as read for a user. Optionally provide specific notification IDs.
17765
+ * Mark all notifications as read for a user. Optionally provide specific notification IDs. Requires: Ibl.Notifications/Notification/write
17766
17766
  * @returns MarkAllReadResponse
17767
17767
  * @throws ApiError
17768
17768
  */
@@ -17886,7 +17886,7 @@ class NotificationsService {
17886
17886
  }
17887
17887
  /**
17888
17888
  * Test SMTP credentials for a platform
17889
- * Test SMTP credentials by sending a test email to the specified address
17889
+ * Test SMTP credentials by sending a test email to the specified address. Requires: Ibl.Notifications/SMTP/action
17890
17890
  * @returns TestSMTPResponse
17891
17891
  * @throws ApiError
17892
17892
  */
@@ -17906,7 +17906,7 @@ class NotificationsService {
17906
17906
  }
17907
17907
  /**
17908
17908
  * List notification templates
17909
- * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main.
17909
+ * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main. Requires permission: Ibl.Notifications/NotificationTemplate/list
17910
17910
  * @returns NotificationTemplateList
17911
17911
  * @throws ApiError
17912
17912
  */
@@ -17923,7 +17923,7 @@ class NotificationsService {
17923
17923
  }
17924
17924
  /**
17925
17925
  * Get notification template details
17926
- * Get detailed view of a notification template by type. Returns platform-specific template if exists, otherwise main template.
17926
+ * Get detailed view of a notification template by type. Returns platform-specific template if exists, otherwise main template. Requires permission: Ibl.Notifications/NotificationTemplate/read
17927
17927
  * @returns NotificationTemplateDetail
17928
17928
  * @throws ApiError
17929
17929
  */
@@ -17942,7 +17942,7 @@ class NotificationsService {
17942
17942
  }
17943
17943
  /**
17944
17944
  * Update notification template
17945
- * Update notification template. Creates platform-specific copy on first edit.
17945
+ * Update notification template. Creates platform-specific copy on first edit. Requires permission: Ibl.Notifications/NotificationTemplate/write
17946
17946
  * @returns NotificationTemplateDetail
17947
17947
  * @throws ApiError
17948
17948
  */
@@ -17964,7 +17964,7 @@ class NotificationsService {
17964
17964
  }
17965
17965
  /**
17966
17966
  * Reset template to default
17967
- * Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved.
17967
+ * Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved. Requires permission: Ibl.Notifications/NotificationTemplate/write
17968
17968
  * @returns any
17969
17969
  * @throws ApiError
17970
17970
  */
@@ -17983,7 +17983,7 @@ class NotificationsService {
17983
17983
  }
17984
17984
  /**
17985
17985
  * Send test notification
17986
- * Send a test notification to verify template rendering and delivery. Sends to the requesting admin's email or a specified test email.
17986
+ * 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
17987
17987
  * @returns NotificationTemplateTestResponse
17988
17988
  * @throws ApiError
17989
17989
  */
@@ -18005,7 +18005,7 @@ class NotificationsService {
18005
18005
  }
18006
18006
  /**
18007
18007
  * Toggle notification preference
18008
- * Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template.
18008
+ * Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template. Requires permission: Ibl.Notifications/NotificationTemplate/write
18009
18009
  * @returns NotificationToggle
18010
18010
  * @throws ApiError
18011
18011
  */
@@ -19729,5 +19729,5 @@ class SkillsService {
19729
19729
  }
19730
19730
  }
19731
19731
 
19732
- export { AcceptanceEnum, AiAnalyticsService, AnalyticsService, ApiError, BlankEnum, CancelError, CancelablePromise, CareerService, CatalogService, CeleryHeartbeatFailStatusEnum, CeleryHeartbeatStatusEnum, CommerceService, CoreService, CredentialsService, CustomDomainsService, FeaturesService, GooglePayAccountResponseStatusEnum, InstitutionTypeEnum, ItemTypeEnum, MediaService, MediaTypeEnum, ModeEnum, NotificationSourceTypeEnum, NotificationStatusEnum, NotificationsService, OpenAPI, PeriodEnum, PeriodicFrequencyEnum, PeriodicLearnerScopeEnum, PlatformListStatusEnum, ProgramTypeEnum, RecommendationsService, ReportsService, ScimService, SearchService, SkillsService, StateEnum, Type2a5Enum };
19732
+ export { AcceptanceEnum, AiAnalyticsService, AnalyticsService, ApiError, BlankEnum, CancelError, CancelablePromise, CareerService, CatalogService, CeleryHeartbeatFailStatusEnum, CeleryHeartbeatStatusEnum, CommerceService, CoreService, CredentialsService, CustomDomainsService, FeaturesService, GooglePayAccountResponseStatusEnum, InstitutionTypeEnum, ItemTypeEnum, MediaService, MediaTypeEnum, ModeEnum, NotificationSourceTypeEnum, NotificationsService, OpenAPI, PeriodEnum, PeriodicFrequencyEnum, PeriodicLearnerScopeEnum, PlatformListStatusEnum, ProgramTypeEnum, RecommendationsService, ReportsService, ScimService, SearchService, SkillsService, StateEnum, Status3daEnum, Type2a5Enum };
19733
19733
  //# sourceMappingURL=index.esm.js.map
package/dist/index.umd.js CHANGED
@@ -114,7 +114,7 @@
114
114
 
115
115
  const OpenAPI = {
116
116
  BASE: 'https://base.manager.iblai.app',
117
- VERSION: '4.108.1-core',
117
+ VERSION: '4.109.0-core',
118
118
  WITH_CREDENTIALS: false,
119
119
  CREDENTIALS: 'include',
120
120
  TOKEN: undefined,
@@ -289,22 +289,6 @@
289
289
  NotificationSourceTypeEnum["PROGRAM"] = "program";
290
290
  })(exports.NotificationSourceTypeEnum || (exports.NotificationSourceTypeEnum = {}));
291
291
 
292
- /* generated using openapi-typescript-codegen -- do not edit */
293
- /* istanbul ignore file */
294
- /* tslint:disable */
295
- /* eslint-disable */
296
- /**
297
- * * `READ` - Read
298
- * * `UNREAD` - Unread
299
- * * `CANCELLED` - Cancelled
300
- */
301
- exports.NotificationStatusEnum = void 0;
302
- (function (NotificationStatusEnum) {
303
- NotificationStatusEnum["READ"] = "READ";
304
- NotificationStatusEnum["UNREAD"] = "UNREAD";
305
- NotificationStatusEnum["CANCELLED"] = "CANCELLED";
306
- })(exports.NotificationStatusEnum || (exports.NotificationStatusEnum = {}));
307
-
308
292
  /* generated using openapi-typescript-codegen -- do not edit */
309
293
  /* istanbul ignore file */
310
294
  /* tslint:disable */
@@ -433,6 +417,22 @@
433
417
  StateEnum["EXPIRED"] = "expired";
434
418
  })(exports.StateEnum || (exports.StateEnum = {}));
435
419
 
420
+ /* generated using openapi-typescript-codegen -- do not edit */
421
+ /* istanbul ignore file */
422
+ /* tslint:disable */
423
+ /* eslint-disable */
424
+ /**
425
+ * * `READ` - Read
426
+ * * `UNREAD` - Unread
427
+ * * `CANCELLED` - Cancelled
428
+ */
429
+ exports.Status3daEnum = void 0;
430
+ (function (Status3daEnum) {
431
+ Status3daEnum["READ"] = "READ";
432
+ Status3daEnum["UNREAD"] = "UNREAD";
433
+ Status3daEnum["CANCELLED"] = "CANCELLED";
434
+ })(exports.Status3daEnum || (exports.Status3daEnum = {}));
435
+
436
436
  /* generated using openapi-typescript-codegen -- do not edit */
437
437
  /* istanbul ignore file */
438
438
  /* tslint:disable */
@@ -17548,7 +17548,7 @@
17548
17548
  });
17549
17549
  }
17550
17550
  /**
17551
- * Get notifications for a user
17551
+ * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
17552
17552
  * @returns Notification
17553
17553
  * @throws ApiError
17554
17554
  */
@@ -17576,7 +17576,7 @@
17576
17576
  });
17577
17577
  }
17578
17578
  /**
17579
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17579
+ * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
17580
17580
  * @returns Notification
17581
17581
  * @throws ApiError
17582
17582
  */
@@ -17595,7 +17595,7 @@
17595
17595
  });
17596
17596
  }
17597
17597
  /**
17598
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17598
+ * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
17599
17599
  * @returns Notification
17600
17600
  * @throws ApiError
17601
17601
  */
@@ -17614,7 +17614,7 @@
17614
17614
  });
17615
17615
  }
17616
17616
  /**
17617
- * Get notifications for a user
17617
+ * Get notifications for a user. Requires: Ibl.Notifications/Notification/list
17618
17618
  * @returns Notification
17619
17619
  * @throws ApiError
17620
17620
  */
@@ -17644,7 +17644,7 @@
17644
17644
  });
17645
17645
  }
17646
17646
  /**
17647
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17647
+ * Update notification status for a user. Requires: Ibl.Notifications/Notification/write
17648
17648
  * @returns Notification
17649
17649
  * @throws ApiError
17650
17650
  */
@@ -17665,7 +17665,7 @@
17665
17665
  });
17666
17666
  }
17667
17667
  /**
17668
- * Get notifications count for a user
17668
+ * Get notifications count for a user. Requires: Ibl.Notifications/Notification/list
17669
17669
  * @returns NotificationCount
17670
17670
  * @throws ApiError
17671
17671
  */
@@ -17689,7 +17689,7 @@
17689
17689
  });
17690
17690
  }
17691
17691
  /**
17692
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17692
+ * Delete a notification for a user. Requires: Ibl.Notifications/Notification/delete
17693
17693
  * @returns void
17694
17694
  * @throws ApiError
17695
17695
  */
@@ -17709,7 +17709,7 @@
17709
17709
  });
17710
17710
  }
17711
17711
  /**
17712
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
17712
+ * Bulk update notification status for a user. Requires: Ibl.Notifications/Notification/write
17713
17713
  * @returns Notification
17714
17714
  * @throws ApiError
17715
17715
  */
@@ -17730,7 +17730,7 @@
17730
17730
  });
17731
17731
  }
17732
17732
  /**
17733
- * Re-enable campaigns for a user
17733
+ * Re-enable campaigns for a user. Requires: Ibl.Notifications/Campaigns/action
17734
17734
  * @returns any
17735
17735
  * @throws ApiError
17736
17736
  */
@@ -17749,7 +17749,7 @@
17749
17749
  });
17750
17750
  }
17751
17751
  /**
17752
- * Exclude a user from specified campaigns
17752
+ * Exclude a user from specified campaigns. Requires: Ibl.Notifications/Campaigns/action
17753
17753
  * @returns any
17754
17754
  * @throws ApiError
17755
17755
  */
@@ -17768,7 +17768,7 @@
17768
17768
  });
17769
17769
  }
17770
17770
  /**
17771
- * Mark all notifications as read for a user. Optionally provide specific notification IDs.
17771
+ * Mark all notifications as read for a user. Optionally provide specific notification IDs. Requires: Ibl.Notifications/Notification/write
17772
17772
  * @returns MarkAllReadResponse
17773
17773
  * @throws ApiError
17774
17774
  */
@@ -17892,7 +17892,7 @@
17892
17892
  }
17893
17893
  /**
17894
17894
  * Test SMTP credentials for a platform
17895
- * Test SMTP credentials by sending a test email to the specified address
17895
+ * Test SMTP credentials by sending a test email to the specified address. Requires: Ibl.Notifications/SMTP/action
17896
17896
  * @returns TestSMTPResponse
17897
17897
  * @throws ApiError
17898
17898
  */
@@ -17912,7 +17912,7 @@
17912
17912
  }
17913
17913
  /**
17914
17914
  * List notification templates
17915
- * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main.
17915
+ * Get all notification templates for the platform. Includes both platform-specific and inherited templates from main. Requires permission: Ibl.Notifications/NotificationTemplate/list
17916
17916
  * @returns NotificationTemplateList
17917
17917
  * @throws ApiError
17918
17918
  */
@@ -17929,7 +17929,7 @@
17929
17929
  }
17930
17930
  /**
17931
17931
  * Get notification template details
17932
- * Get detailed view of a notification template by type. Returns platform-specific template if exists, otherwise main template.
17932
+ * Get detailed view of a notification template by type. Returns platform-specific template if exists, otherwise main template. Requires permission: Ibl.Notifications/NotificationTemplate/read
17933
17933
  * @returns NotificationTemplateDetail
17934
17934
  * @throws ApiError
17935
17935
  */
@@ -17948,7 +17948,7 @@
17948
17948
  }
17949
17949
  /**
17950
17950
  * Update notification template
17951
- * Update notification template. Creates platform-specific copy on first edit.
17951
+ * Update notification template. Creates platform-specific copy on first edit. Requires permission: Ibl.Notifications/NotificationTemplate/write
17952
17952
  * @returns NotificationTemplateDetail
17953
17953
  * @throws ApiError
17954
17954
  */
@@ -17970,7 +17970,7 @@
17970
17970
  }
17971
17971
  /**
17972
17972
  * Reset template to default
17973
- * Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved.
17973
+ * Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved. Requires permission: Ibl.Notifications/NotificationTemplate/write
17974
17974
  * @returns any
17975
17975
  * @throws ApiError
17976
17976
  */
@@ -17989,7 +17989,7 @@
17989
17989
  }
17990
17990
  /**
17991
17991
  * Send test notification
17992
- * Send a test notification to verify template rendering and delivery. Sends to the requesting admin's email or a specified test email.
17992
+ * 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
17993
17993
  * @returns NotificationTemplateTestResponse
17994
17994
  * @throws ApiError
17995
17995
  */
@@ -18011,7 +18011,7 @@
18011
18011
  }
18012
18012
  /**
18013
18013
  * Toggle notification preference
18014
- * Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template.
18014
+ * Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template. Requires permission: Ibl.Notifications/NotificationTemplate/write
18015
18015
  * @returns NotificationToggle
18016
18016
  * @throws ApiError
18017
18017
  */
@@ -182,7 +182,7 @@ export type { NotificationCount } from './models/NotificationCount';
182
182
  export type { NotificationPreview } from './models/NotificationPreview';
183
183
  export type { NotificationSource } from './models/NotificationSource';
184
184
  export { NotificationSourceTypeEnum } from './models/NotificationSourceTypeEnum';
185
- export { NotificationStatusEnum } from './models/NotificationStatusEnum';
185
+ export type { NotificationsUpdate } from './models/NotificationsUpdate';
186
186
  export type { NotificationTemplateData } from './models/NotificationTemplateData';
187
187
  export type { NotificationTemplateDetail } from './models/NotificationTemplateDetail';
188
188
  export type { NotificationTemplateList } from './models/NotificationTemplateList';
@@ -391,6 +391,7 @@ export type { SkillsMetric } from './models/SkillsMetric';
391
391
  export type { SkillThreshold } from './models/SkillThreshold';
392
392
  export type { Spa } from './models/Spa';
393
393
  export { StateEnum } from './models/StateEnum';
394
+ export { Status3daEnum } from './models/Status3daEnum';
394
395
  export type { StripeBillingPageIdentifierResponse } from './models/StripeBillingPageIdentifierResponse';
395
396
  export type { StripeCheckoutSessionRequest } from './models/StripeCheckoutSessionRequest';
396
397
  export type { StripeCheckoutSessionResponse } from './models/StripeCheckoutSessionResponse';
@@ -1,11 +1,11 @@
1
1
  import type { BlankEnum } from './BlankEnum';
2
- import type { NotificationStatusEnum } from './NotificationStatusEnum';
2
+ import type { Status3daEnum } from './Status3daEnum';
3
3
  export type Notification = {
4
4
  readonly id: string;
5
5
  username: string;
6
6
  readonly title: string;
7
7
  readonly body: string;
8
- status?: (NotificationStatusEnum | BlankEnum);
8
+ status?: (Status3daEnum | BlankEnum);
9
9
  readonly channel: string | null;
10
10
  context?: any;
11
11
  readonly short_message: string;
@@ -0,0 +1,5 @@
1
+ import type { Status3daEnum } from './Status3daEnum';
2
+ export type NotificationsUpdate = {
3
+ notification_id?: string;
4
+ status: Status3daEnum;
5
+ };