Add ContractPage welcome message (#3059)

Author: gumaerc

b2b/migrations/0012_contractpage_welcome_message_and_more.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.2.25 on 2025-10-31 19:55
+
+import wagtail.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("b2b", "0011_sync_contract_type_fields"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="contractpage",
+            name="welcome_message",
+            field=models.CharField(
+                blank=True, help_text="A welcome message for learners.", max_length=255
+            ),
+        ),
+        migrations.AddField(
+            model_name="contractpage",
+            name="welcome_message_extra",
+            field=wagtail.fields.RichTextField(
+                blank=True, help_text="Additional welcome message content for learners."
+            ),
+        ),
+    ]

b2b/models.py

@@ -197,6 +197,12 @@ class ContractPage(Page):
     description = RichTextField(
         blank=True, help_text="Any useful extra information about the contract."
     )
+    welcome_message = models.CharField(
+        max_length=255, blank=True, help_text="A welcome message for learners."
+    )
+    welcome_message_extra = RichTextField(
+        blank=True, help_text="Additional welcome message content for learners."
+    )
     integration_type = models.CharField(
         max_length=255,
         choices=CONTRACT_MEMBERSHIP_CHOICES,
@@ -253,6 +259,8 @@ class ContractPage(Page):
         MultiFieldPanel(
             [
                 FieldPanel("description"),
+                FieldPanel("welcome_message"),
+                FieldPanel("welcome_message_extra"),
                 FieldPanel("organization"),
             ],
             heading="Basic Information",

b2b/serializers/v0/__init__.py

@@ -21,6 +21,8 @@ class Meta:
             "id",
             "name",
             "description",
+            "welcome_message",
+            "welcome_message_extra",
             "integration_type",
             "membership_type",
             "organization",
@@ -34,6 +36,8 @@ class Meta:
             "id",
             "name",
             "description",
+            "welcome_message",
+            "welcome_message_extra",
             "integration_type",
             "membership_type",
             "organization",

openapi/specs/v0.yaml

@@ -1515,6 +1515,14 @@ components:
           type: string
           readOnly: true
           description: Any useful extra information about the contract.
+        welcome_message:
+          type: string
+          readOnly: true
+          description: A welcome message for learners.
+        welcome_message_extra:
+          type: string
+          readOnly: true
+          description: Additional welcome message content for learners.
         integration_type:
           allOf:
           - $ref: '#/components/schemas/IntegrationTypeEnum'
@@ -1565,6 +1573,8 @@ components:
       - name
       - organization
       - slug
+      - welcome_message
+      - welcome_message_extra
     Country:
       type: object
       description: Serializer for pycountry countries, with states for US/CA

openapi/specs/v1.yaml

@@ -1515,6 +1515,14 @@ components:
           type: string
           readOnly: true
           description: Any useful extra information about the contract.
+        welcome_message:
+          type: string
+          readOnly: true
+          description: A welcome message for learners.
+        welcome_message_extra:
+          type: string
+          readOnly: true
+          description: Additional welcome message content for learners.
         integration_type:
           allOf:
           - $ref: '#/components/schemas/IntegrationTypeEnum'
@@ -1565,6 +1573,8 @@ components:
       - name
       - organization
       - slug
+      - welcome_message
+      - welcome_message_extra
     Country:
       type: object
       description: Serializer for pycountry countries, with states for US/CA

openapi/specs/v2.yaml

@@ -1515,6 +1515,14 @@ components:
           type: string
           readOnly: true
           description: Any useful extra information about the contract.
+        welcome_message:
+          type: string
+          readOnly: true
+          description: A welcome message for learners.
+        welcome_message_extra:
+          type: string
+          readOnly: true
+          description: Additional welcome message content for learners.
         integration_type:
           allOf:
           - $ref: '#/components/schemas/IntegrationTypeEnum'
@@ -1565,6 +1573,8 @@ components:
       - name
       - organization
       - slug
+      - welcome_message
+      - welcome_message_extra
     Country:
       type: object
       description: Serializer for pycountry countries, with states for US/CA

users/views_test.py

@@ -73,6 +73,8 @@ def test_get_user_by_me(mocker, client, user, is_anonymous, has_orgs):
                             "id": contract.id,
                             "name": contract.name,
                             "description": contract.description,
+                            "welcome_message": contract.welcome_message,
+                            "welcome_message_extra": contract.welcome_message_extra,
                             "membership_type": contract.membership_type,
                             "integration_type": contract.integration_type,
                             "contract_start": None,