Development: Add basic reference letter request functionality (#2489)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: aniruddhzaveri <aniruddh.zaveri@tum.de>

Author: 3 people

openapi/openapi.yaml

@@ -657,6 +657,57 @@ paths:
           content:
             application/json:
               schema: {$ref: '#/components/schemas/RatingOverviewDTO'}
+  /api/applications/{applicationId}/references:
+    get:
+      tags: [reference-request-resource]
+      operationId: getReferences
+      parameters:
+      - name: applicationId
+        in: path
+        required: true
+        schema: {type: string, format: uuid}
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items: {$ref: '#/components/schemas/ReferenceRequestDTO'}
+    post:
+      tags: [reference-request-resource]
+      operationId: add
+      parameters:
+      - name: applicationId
+        in: path
+        required: true
+        schema: {type: string, format: uuid}
+      requestBody:
+        content:
+          application/json:
+            schema: {$ref: '#/components/schemas/CreateReferenceRequestDTO'}
+        required: true
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema: {$ref: '#/components/schemas/ReferenceRequestDTO'}
+  /api/applications/{applicationId}/references/{referenceId}:
+    delete:
+      tags: [reference-request-resource]
+      operationId: remove
+      parameters:
+      - name: applicationId
+        in: path
+        required: true
+        schema: {type: string, format: uuid}
+      - name: referenceId
+        in: path
+        required: true
+        schema: {type: string, format: uuid}
+      responses:
+        '200': {description: OK}
   /api/auth/login:
     post:
       tags: [authentication-resource]
@@ -2909,6 +2960,14 @@ components:
         expected: {type: integer, format: int32}
         exported: {type: integer, format: int32}
         failed: {type: integer, format: int32}
+    CreateReferenceRequestDTO:
+      type: object
+      properties:
+        email: {type: string, format: email, maxLength: 320, minLength: 0}
+        firstName: {type: string, maxLength: 255, minLength: 0}
+        lastName: {type: string, maxLength: 255, minLength: 0}
+        title: {type: string, maxLength: 32, minLength: 0}
+      required: [email, firstName, lastName]
     CreateSlotsDTO:
       type: object
       properties:
@@ -3005,7 +3064,7 @@ components:
             INTERVIEW_BOOKED_APPLICANT, INTERVIEW_BOOKED_PROFESSOR, INTERVIEW_ASSIGNED_PROFESSOR,
             INTERVIEW_LOCATION_CHANGED, INTERVIEW_SELF_SCHEDULING_INVITATION, INTERVIEW_CANCELLED,
             INTERVIEW_RESCHEDULE_REQUESTED, DATA_EXPORT_READY, USER_DATA_DELETION_WARNING,
-            APPLICANT_DATA_DELETION_WARNING]
+            APPLICANT_DATA_DELETION_WARNING, REFERENCE_LETTER_INVITATION]
         enabled: {type: boolean}
     EmailTemplateDTO:
       type: object
@@ -3020,7 +3079,7 @@ components:
             INTERVIEW_BOOKED_APPLICANT, INTERVIEW_BOOKED_PROFESSOR, INTERVIEW_ASSIGNED_PROFESSOR,
             INTERVIEW_LOCATION_CHANGED, INTERVIEW_SELF_SCHEDULING_INVITATION, INTERVIEW_CANCELLED,
             INTERVIEW_RESCHEDULE_REQUESTED, DATA_EXPORT_READY, USER_DATA_DELETION_WARNING,
-            APPLICANT_DATA_DELETION_WARNING]
+            APPLICANT_DATA_DELETION_WARNING, REFERENCE_LETTER_INVITATION]
         english: {$ref: '#/components/schemas/EmailTemplateTranslationDTO'}
         german: {$ref: '#/components/schemas/EmailTemplateTranslationDTO'}
     EmailTemplateOverviewDTO:
@@ -3036,7 +3095,7 @@ components:
             INTERVIEW_BOOKED_APPLICANT, INTERVIEW_BOOKED_PROFESSOR, INTERVIEW_ASSIGNED_PROFESSOR,
             INTERVIEW_LOCATION_CHANGED, INTERVIEW_SELF_SCHEDULING_INVITATION, INTERVIEW_CANCELLED,
             INTERVIEW_RESCHEDULE_REQUESTED, DATA_EXPORT_READY, USER_DATA_DELETION_WARNING,
-            APPLICANT_DATA_DELETION_WARNING]
+            APPLICANT_DATA_DELETION_WARNING, REFERENCE_LETTER_INVITATION]
         english: {$ref: '#/components/schemas/EmailTemplateTranslationDTO'}
         firstName: {type: string}
         german: {$ref: '#/components/schemas/EmailTemplateTranslationDTO'}
@@ -3210,6 +3269,7 @@ components:
           enum: [GARCHING, GARCHING_HOCHBRUECK, HEILBRONN, MUNICH, STRAUBING, WEIHENSTEPHAN,
             SINGAPORE]
         professorName: {type: string}
+        referenceLettersRequired: {type: integer, format: int32}
         relativeTimeEnglish: {type: string}
         relativeTimeGerman: {type: string}
         startDate: {type: string, format: date}
@@ -3304,6 +3364,7 @@ components:
           type: string
           enum: [GARCHING, GARCHING_HOCHBRUECK, HEILBRONN, MUNICH, STRAUBING, WEIHENSTEPHAN,
             SINGAPORE]
+        referenceLettersRequired: {type: integer, format: int32}
         researchArea: {type: string}
         researchGroup: {$ref: '#/components/schemas/ResearchGroupSummaryDTO'}
         startDate: {type: string, format: date}
@@ -3376,6 +3437,7 @@ components:
           type: string
           enum: [GARCHING, GARCHING_HOCHBRUECK, HEILBRONN, MUNICH, STRAUBING, WEIHENSTEPHAN,
             SINGAPORE]
+        referenceLettersRequired: {type: integer, format: int32}
         researchArea: {type: string}
         startDate: {type: string, format: date}
         startDateByArrangement: {type: boolean}
@@ -3577,6 +3639,17 @@ components:
           type: array
           items: {$ref: '#/components/schemas/RatingDTO'}
           uniqueItems: true
+    ReferenceRequestDTO:
+      type: object
+      properties:
+        email: {type: string}
+        firstName: {type: string}
+        lastName: {type: string}
+        referenceRequestId: {type: string, format: uuid}
+        status:
+          type: string
+          enum: [REQUESTED, SUBMITTED, EXPIRED]
+        title: {type: string}
     RejectDTO:
       type: object
       properties: