@iblai/iblai-api 4.59.3-core → 4.60.0-core

package/sdk_schema.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ibl-data-manager
-  version: 4.59.3-core
+  version: 4.60.0-core
   description: API for iblai
 paths:
   /api/analytics/content/:
@@ -22804,6 +22804,226 @@ paths:
               schema:
                 $ref: '#/components/schemas/TestSMTPResponse'
           description: ''
+  /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.
+      summary: List notification templates
+      parameters:
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - notifications
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/NotificationTemplateList'
+          description: ''
+  /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.
+      summary: Get notification template details
+      parameters:
+      - in: path
+        name: notification_type
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - notifications
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotificationTemplateDetail'
+          description: ''
+    patch:
+      operationId: notification_v1_platforms_templates_partial_update
+      description: Update notification template. Creates platform-specific copy on
+        first edit.
+      summary: Update notification template
+      parameters:
+      - in: path
+        name: notification_type
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - notifications
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationTemplateDetail'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationTemplateDetail'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationTemplateDetail'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationTemplateDetail'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationTemplateDetail'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotificationTemplateDetail'
+          description: ''
+  /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.
+      summary: Reset template to default
+      parameters:
+      - in: path
+        name: notification_type
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - notifications
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                  deleted:
+                    type: boolean
+          description: ''
+  /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.
+      summary: Send test notification
+      parameters:
+      - in: path
+        name: notification_type
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - notifications
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NotificationTemplateTest'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/NotificationTemplateTest'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/NotificationTemplateTest'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/NotificationTemplateTest'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/NotificationTemplateTest'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotificationTemplateTestResponse'
+          description: ''
+  /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.
+      summary: Toggle notification preference
+      parameters:
+      - in: path
+        name: notification_type
+        schema:
+          type: string
+        required: true
+      - in: path
+        name: platform_key
+        schema:
+          type: string
+        required: true
+      tags:
+      - notifications
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationToggle'
+          application/scim+json:
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationToggle'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationToggle'
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationToggle'
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PatchedNotificationToggle'
+      security:
+      - PlatformApiKeyAuthentication: []
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NotificationToggle'
+          description: ''
   /api/orgs/{platform_key}/scim/v2/Groups:
     get:
       operationId: list_groups
@@ -31501,6 +31721,19 @@ components:
       required:
       - key
       - value
+    ConsumerChannel:
+      type: object
+      description: Serializer for channel
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        name:
+          type: string
+          title: Channel name
+          maxLength: 255
+      required:
+      - id
     ContentAnalytics:
       type: object
       description: Serializer for individual content item analytics.
@@ -35068,12 +35301,30 @@ components:
       description: Request serializer for source validation
       properties:
         type:
-          $ref: '#/components/schemas/TypeEnum'
+          $ref: '#/components/schemas/NotificationSourceTypeEnum'
         data:
           nullable: true
       required:
       - data
       - type
+    NotificationSourceTypeEnum:
+      enum:
+      - email
+      - username
+      - platform
+      - csv
+      - department
+      - pathway
+      - program
+      type: string
+      description: |-
+        * `email` - email
+        * `username` - username
+        * `platform` - platform
+        * `csv` - csv
+        * `department` - department
+        * `pathway` - pathway
+        * `program` - program
     NotificationStatusEnum:
       enum:
       - READ
@@ -35101,6 +35352,261 @@ components:
             \    and <anything passed into context dictionary>\n    ```\n\n    "
       required:
       - message_body
+    NotificationTemplateDetail:
+      type: object
+      description: Serializer for detailed template view and editing
+      properties:
+        id:
+          type: string
+          format: uuid
+          readOnly: true
+          description: Unique identifier for this notification template.
+        type:
+          readOnly: true
+          nullable: true
+          description: |-
+            Select the type of notification from the available options.
+
+            * `APP_REGISTRATION` - App Registration
+            * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
+            * `USER_NOTIF_COURSE_ENROLLMENT` - User Notif Course Enrollment
+            * `ADMIN_NOTIF_COURSE_ENROLLMENT` - Admin Notif Course Enrollment
+            * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
+            * `USER_NOTIF_COURSE_COMPLETION` - User Notif Course Completion
+            * `USER_NOTIF_CREDENTIALS` - User Notif Credentials
+            * `CUSTOM_NOTIFICATION` - Custom Notification
+            * `PLATFORM_INVITATION` - Platform Invitation
+            * `PROGRAM_INVITATION` - Program Invitation
+            * `COURSE_INVITATION` - Course Invitation
+            * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+            * `ROLE_CHANGE` - Role Change
+            * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
+            * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+            * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
+            * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
+            * `USER_LICENSE_ASSIGNMENT` - User License Assignment
+            * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment
+          oneOf:
+          - $ref: '#/components/schemas/TypeA81Enum'
+          - $ref: '#/components/schemas/NullEnum'
+        name:
+          type: string
+          nullable: true
+          description: A friendly name for the notification template.
+          maxLength: 255
+        description:
+          type: string
+          description: Admin-friendly description of what this notification does,
+            when it triggers, and what data it needs
+        message_title:
+          type: string
+          nullable: true
+          description: The title for the notification message.
+          maxLength: 255
+        message_body:
+          type: string
+          description: The full notification message body.
+        short_message_body:
+          type: string
+          description: A short version of the notification message body.
+        email_subject:
+          type: string
+          nullable: true
+          description: Email subject line (supports Django template syntax)
+          maxLength: 255
+        email_from_address:
+          type: string
+          nullable: true
+          description: 'Sender email address (default: IBL <noreply@ibl.ai>)'
+          maxLength: 255
+        email_html_template:
+          type: string
+          nullable: true
+          description: Full HTML template for email body
+        spas_detail:
+          type: array
+          items:
+            $ref: '#/components/schemas/Spa'
+          readOnly: true
+        allowed_channels_detail:
+          type: array
+          items:
+            $ref: '#/components/schemas/ConsumerChannel'
+          readOnly: true
+        spa_ids:
+          type: array
+          items:
+            type: integer
+            writeOnly: true
+          writeOnly: true
+        channel_ids:
+          type: array
+          items:
+            type: integer
+            writeOnly: true
+          writeOnly: true
+        is_inherited:
+          type: boolean
+          readOnly: true
+        is_enabled:
+          type: boolean
+          readOnly: true
+        source_platform:
+          type: string
+          readOnly: true
+        metadata: {}
+        available_context:
+          type: string
+          readOnly: true
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+          description: Timestamp when this template was created
+        updated_at:
+          type: string
+          format: date-time
+          readOnly: true
+          description: Timestamp when this template was last updated
+      required:
+      - allowed_channels_detail
+      - available_context
+      - created_at
+      - id
+      - is_enabled
+      - is_inherited
+      - source_platform
+      - spas_detail
+      - type
+      - updated_at
+    NotificationTemplateList:
+      type: object
+      description: Serializer for listing notification templates with inheritance
+        info
+      properties:
+        id:
+          type: string
+          format: uuid
+          readOnly: true
+          description: Unique identifier for this notification template.
+        type:
+          nullable: true
+          description: |-
+            Select the type of notification from the available options.
+
+            * `APP_REGISTRATION` - App Registration
+            * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
+            * `USER_NOTIF_COURSE_ENROLLMENT` - User Notif Course Enrollment
+            * `ADMIN_NOTIF_COURSE_ENROLLMENT` - Admin Notif Course Enrollment
+            * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
+            * `USER_NOTIF_COURSE_COMPLETION` - User Notif Course Completion
+            * `USER_NOTIF_CREDENTIALS` - User Notif Credentials
+            * `CUSTOM_NOTIFICATION` - Custom Notification
+            * `PLATFORM_INVITATION` - Platform Invitation
+            * `PROGRAM_INVITATION` - Program Invitation
+            * `COURSE_INVITATION` - Course Invitation
+            * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+            * `ROLE_CHANGE` - Role Change
+            * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
+            * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+            * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
+            * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
+            * `USER_LICENSE_ASSIGNMENT` - User License Assignment
+            * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment
+          oneOf:
+          - $ref: '#/components/schemas/TypeA81Enum'
+          - $ref: '#/components/schemas/BlankEnum'
+          - $ref: '#/components/schemas/NullEnum'
+        name:
+          type: string
+          nullable: true
+          description: A friendly name for the notification template.
+          maxLength: 255
+        description:
+          type: string
+          description: Admin-friendly description of what this notification does,
+            when it triggers, and what data it needs
+        is_inherited:
+          type: boolean
+          readOnly: true
+        source_platform:
+          type: string
+          readOnly: true
+        is_enabled:
+          type: boolean
+          readOnly: true
+        can_customize:
+          type: boolean
+          readOnly: true
+        message_title:
+          type: string
+          nullable: true
+          description: The title for the notification message.
+          maxLength: 255
+        email_subject:
+          type: string
+          nullable: true
+          description: Email subject line (supports Django template syntax)
+          maxLength: 255
+        spas:
+          type: string
+          readOnly: true
+        allowed_channels:
+          type: string
+          readOnly: true
+        available_context:
+          type: string
+          readOnly: true
+      required:
+      - allowed_channels
+      - available_context
+      - can_customize
+      - id
+      - is_enabled
+      - is_inherited
+      - source_platform
+      - spas
+    NotificationTemplateTest:
+      type: object
+      description: Serializer for testing notification template
+      properties:
+        test_email:
+          type: string
+          format: email
+          description: Email address to send test notification to. Defaults to requesting
+            user's email.
+        context:
+          description: 'Optional context variables for template rendering (e.g., {''course_name'':
+            ''Test Course''})'
+    NotificationTemplateTestResponse:
+      type: object
+      description: Serializer for test notification response
+      properties:
+        success:
+          type: boolean
+          description: Whether the test email was sent successfully
+        message:
+          type: string
+          description: Description of the result
+        recipient:
+          type: string
+          format: email
+          description: Email address the test was sent to
+      required:
+      - message
+      - recipient
+      - success
+    NotificationToggle:
+      type: object
+      description: Serializer for toggling notification preference
+      properties:
+        allow_notification:
+          type: boolean
+      required:
+      - allow_notification
+    NullEnum:
+      enum:
+      - null
     OnboardingStatusUpdate:
       type: object
       properties:
@@ -36087,6 +36593,128 @@ components:
           type: string
           format: date-time
           readOnly: true
+    PatchedNotificationTemplateDetail:
+      type: object
+      description: Serializer for detailed template view and editing
+      properties:
+        id:
+          type: string
+          format: uuid
+          readOnly: true
+          description: Unique identifier for this notification template.
+        type:
+          readOnly: true
+          nullable: true
+          description: |-
+            Select the type of notification from the available options.
+
+            * `APP_REGISTRATION` - App Registration
+            * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
+            * `USER_NOTIF_COURSE_ENROLLMENT` - User Notif Course Enrollment
+            * `ADMIN_NOTIF_COURSE_ENROLLMENT` - Admin Notif Course Enrollment
+            * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
+            * `USER_NOTIF_COURSE_COMPLETION` - User Notif Course Completion
+            * `USER_NOTIF_CREDENTIALS` - User Notif Credentials
+            * `CUSTOM_NOTIFICATION` - Custom Notification
+            * `PLATFORM_INVITATION` - Platform Invitation
+            * `PROGRAM_INVITATION` - Program Invitation
+            * `COURSE_INVITATION` - Course Invitation
+            * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+            * `ROLE_CHANGE` - Role Change
+            * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
+            * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+            * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
+            * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
+            * `USER_LICENSE_ASSIGNMENT` - User License Assignment
+            * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment
+          oneOf:
+          - $ref: '#/components/schemas/TypeA81Enum'
+          - $ref: '#/components/schemas/NullEnum'
+        name:
+          type: string
+          nullable: true
+          description: A friendly name for the notification template.
+          maxLength: 255
+        description:
+          type: string
+          description: Admin-friendly description of what this notification does,
+            when it triggers, and what data it needs
+        message_title:
+          type: string
+          nullable: true
+          description: The title for the notification message.
+          maxLength: 255
+        message_body:
+          type: string
+          description: The full notification message body.
+        short_message_body:
+          type: string
+          description: A short version of the notification message body.
+        email_subject:
+          type: string
+          nullable: true
+          description: Email subject line (supports Django template syntax)
+          maxLength: 255
+        email_from_address:
+          type: string
+          nullable: true
+          description: 'Sender email address (default: IBL <noreply@ibl.ai>)'
+          maxLength: 255
+        email_html_template:
+          type: string
+          nullable: true
+          description: Full HTML template for email body
+        spas_detail:
+          type: array
+          items:
+            $ref: '#/components/schemas/Spa'
+          readOnly: true
+        allowed_channels_detail:
+          type: array
+          items:
+            $ref: '#/components/schemas/ConsumerChannel'
+          readOnly: true
+        spa_ids:
+          type: array
+          items:
+            type: integer
+            writeOnly: true
+          writeOnly: true
+        channel_ids:
+          type: array
+          items:
+            type: integer
+            writeOnly: true
+          writeOnly: true
+        is_inherited:
+          type: boolean
+          readOnly: true
+        is_enabled:
+          type: boolean
+          readOnly: true
+        source_platform:
+          type: string
+          readOnly: true
+        metadata: {}
+        available_context:
+          type: string
+          readOnly: true
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+          description: Timestamp when this template was created
+        updated_at:
+          type: string
+          format: date-time
+          readOnly: true
+          description: Timestamp when this template was last updated
+    PatchedNotificationToggle:
+      type: object
+      description: Serializer for toggling notification preference
+      properties:
+        allow_notification:
+          type: boolean
     PatchedPlatformPublicMetadata:
       type: object
       properties:
@@ -40713,6 +41341,25 @@ components:
       - desired
       - reported
       - total
+    Spa:
+      type: object
+      description: Serializer for SPA
+      properties:
+        id:
+          type: integer
+          readOnly: true
+        name:
+          type: string
+          description: Unique identifier for the SPA (e.g., 'skills', 'mentor', 'admin',
+            'mobile')
+          maxLength: 100
+        description:
+          type: string
+          description: Human-friendly description of this SPA
+          maxLength: 255
+      required:
+      - id
+      - name
     StateEnum:
       enum:
       - pending
@@ -41516,24 +42163,48 @@ components:
       - course_identifier
       - course_name
       - time_spent_seconds
-    TypeEnum:
+    TypeA81Enum:
       enum:
-      - email
-      - username
-      - platform
-      - csv
-      - department
-      - pathway
-      - program
+      - APP_REGISTRATION
+      - USER_NOTIF_USER_REGISTRATION
+      - USER_NOTIF_COURSE_ENROLLMENT
+      - ADMIN_NOTIF_COURSE_ENROLLMENT
+      - USER_NOTIF_USER_INACTIVITY
+      - USER_NOTIF_COURSE_COMPLETION
+      - USER_NOTIF_CREDENTIALS
+      - CUSTOM_NOTIFICATION
+      - PLATFORM_INVITATION
+      - PROGRAM_INVITATION
+      - COURSE_INVITATION
+      - USER_NOTIF_LEARNER_PROGRESS
+      - ROLE_CHANGE
+      - COURSE_LICENSE_ASSIGNMENT
+      - COURSE_LICENSE_GROUP_ASSIGNMENT
+      - PROGRAM_LICENSE_ASSIGNMENT
+      - PROGRAM_LICENSE_GROUP_ASSIGNMENT
+      - USER_LICENSE_ASSIGNMENT
+      - USER_LICENSE_GROUP_ASSIGNMENT
       type: string
       description: |-
-        * `email` - email
-        * `username` - username
-        * `platform` - platform
-        * `csv` - csv
-        * `department` - department
-        * `pathway` - pathway
-        * `program` - program
+        * `APP_REGISTRATION` - App Registration
+        * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
+        * `USER_NOTIF_COURSE_ENROLLMENT` - User Notif Course Enrollment
+        * `ADMIN_NOTIF_COURSE_ENROLLMENT` - Admin Notif Course Enrollment
+        * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
+        * `USER_NOTIF_COURSE_COMPLETION` - User Notif Course Completion
+        * `USER_NOTIF_CREDENTIALS` - User Notif Credentials
+        * `CUSTOM_NOTIFICATION` - Custom Notification
+        * `PLATFORM_INVITATION` - Platform Invitation
+        * `PROGRAM_INVITATION` - Program Invitation
+        * `COURSE_INVITATION` - Course Invitation
+        * `USER_NOTIF_LEARNER_PROGRESS` - User Notif Learner Progress
+        * `ROLE_CHANGE` - Role Change
+        * `COURSE_LICENSE_ASSIGNMENT` - Course License Assignment
+        * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
+        * `PROGRAM_LICENSE_ASSIGNMENT` - Program License Assignment
+        * `PROGRAM_LICENSE_GROUP_ASSIGNMENT` - Program License Group Assignment
+        * `USER_LICENSE_ASSIGNMENT` - User License Assignment
+        * `USER_LICENSE_GROUP_ASSIGNMENT` - User License Group Assignment
     UploadedImage:
       type: object
       properties: