Hia 717 epf endpoint update (#404)

* Updated sentence for EPF

* Added in courtAppearance

* Updated Smoke tests

* Updated OpenApi.yml

* Delete localstack folder

* Made fields depcreciated rather than deleted

Author: popey2700

openapi.yml

@@ -1218,6 +1218,8 @@ components:
           format: date
         gender:
           type: string
+        courtAppearance:
+          $ref: '#/components/schemas/CourtAppearance'
         sentence:
           $ref: '#/components/schemas/CaseSentence'
         responsibleProvider:
@@ -1290,19 +1292,32 @@ components:
           type: string
           example: Some Additional Text
     CaseSentence:
-      required:
-        - date
-        - sentencingCourt
       type: object
       properties:
         date:
           type: string
           format: date
+          description: This field is depreciated and will be removed from the response soon.
         sentencingCourt:
           $ref: '#/components/schemas/Court'
         releaseDate:
           type: string
           format: date
+          description: This field is depreciated and will be removed from the response soon.
+        expectedReleaseDate:
+          type: string
+          format: date
+    CourtAppearance:
+      required:
+        - date
+        - court
+      type: object
+      properties:
+        date:
+          type: string
+          format: date
+        court:
+          $ref: "#/components/schemas/CourtDetails"
     CommunityOffenderManager:
       type: object
       properties:
@@ -1327,12 +1342,11 @@ components:
             example: "leslie.knope@pawnee.gov"
           description: A list of email addresses
     Court:
-      required:
-        - name
       type: object
       properties:
         name:
           type: string
+          description: This field is depreciated and will be removed from the response soon.
     Disability:
       type: object
       properties:
@@ -1811,6 +1825,13 @@ components:
           surname:
             type: string
             nullable: true
+    CourtDetails:
+      required:
+        - name
+      type: object
+      properties:
+        name:
+          type: string
     PersonResponsibleOfficerTeam:
       type: object
       properties:

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/CaseDetail.kt

@@ -5,6 +5,7 @@ data class CaseDetail(
   val name: Name? = null,
   val dateOfBirth: String? = null,
   val gender: String? = null,
+  val courtAppearance: CourtAppearance? = null,
   val sentence: CaseSentence? = null,
   val responsibleProvider: ResponsibleProvider? = null,
   val ogrsScore: Long? = null,
@@ -19,9 +20,13 @@ data class Name(
 )
 
 data class CaseSentence(
+  @Deprecated("This field is depreciated and will be removed from the endpoint /v1/epf/person-details/{hmppsId}/{eventNumber} response soon.")
   val date: String? = null,
+  @Deprecated("This field is depreciated and will be removed from the endpoint /v1/epf/person-details/{hmppsId}/{eventNumber} response soon.")
   val sentencingCourt: SentencingCourt? = null,
+  @Deprecated("This field is depreciated and will be removed from the endpoint /v1/epf/person-details/{hmppsId}/{eventNumber} response soon.")
   val releaseDate: String? = null,
+  val expectedReleaseDate: String? = null,
 )
 
 data class SentencingCourt(
@@ -32,3 +37,12 @@ data class ResponsibleProvider(
   val code: String? = null,
   val name: String? = null,
 )
+
+data class CourtAppearance(
+  val date: String? = null,
+  val court: CourtDetails? = null,
+)
+
+data class CourtDetails(
+  val name: String? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationintegrationepf/EPFCaseDetail.kt

@@ -2,15 +2,16 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationintegra
 
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.CaseDetail
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.CaseSentence
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.CourtAppearance
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Name
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.ResponsibleProvider
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.SentencingCourt
 
 data class EPFCaseDetail(
   val nomsId: String? = null,
   val name: Name? = null,
   val dateOfBirth: String? = null,
   val gender: String? = null,
+  val courtAppearance: CourtAppearance? = null,
   val sentence: CaseSentence? = null,
   val responsibleProvider: ResponsibleProvider? = null,
   val ogrsScore: Long? = null,
@@ -23,36 +24,14 @@ data class EPFCaseDetail(
       name = Name(forename = this.name?.forename, middleName = this.name?.middleName, surname = this.name?.surname),
       dateOfBirth = this.dateOfBirth,
       gender = this.gender,
+      courtAppearance = this.courtAppearance,
       sentence =
         CaseSentence(
-          date = this.sentence?.date,
-          sentencingCourt = SentencingCourt(this.sentence?.sentencingCourt?.name),
-          releaseDate = this.sentence?.releaseDate,
+          expectedReleaseDate = sentence?.expectedReleaseDate,
         ),
       responsibleProvider = ResponsibleProvider(code = this.responsibleProvider?.code, name = this.responsibleProvider?.name),
       ogrsScore = this.ogrsScore,
       age = this.age,
       ageAtRelease = this.ageAtRelease,
     )
 }
-
-data class Name(
-  val forename: String? = null,
-  val middleName: String? = null,
-  val surname: String? = null,
-)
-
-data class CaseSentence(
-  val date: String? = null,
-  val sentencingCourt: SentencingCourt? = null,
-  val releaseDate: String? = null,
-)
-
-data class SentencingCourt(
-  val name: String? = null,
-)
-
-data class ResponsibleProvider(
-  val code: String? = null,
-  val name: String? = null,
-)

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/probationintegrationEPF/fixtures/GetEPFPersonDetailsResponse.json

@@ -7,12 +7,14 @@
   },
   "dateOfBirth":"2000-03-01",
   "gender": null,
+  "courtAppearance": {
+    "date": "2019-10-10",
+    "court": {
+      "name": "Crown"
+    }
+  },
   "sentence": {
-    "date": "2021-03-03",
-    "sentencingCourt": {
-      "name": "Fakecourt"
-    },
-    "releaseDate": "2021-10-10"
+    "expectedReleaseDate": "2021-10-10"
   },
   "responsibleProvider": {
     "code": "999000ABC",
@@ -21,4 +23,4 @@
   "ogrsScore": 123,
   "age": 23,
   "ageAtRelease": 24
-}
+}

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/helpers/CaseDetailsHelper.kt

@@ -2,9 +2,10 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.helpers
 
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.CaseDetail
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.CaseSentence
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.CourtAppearance
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.CourtDetails
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Name
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.ResponsibleProvider
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.SentencingCourt
 
 fun generateCaseDetail(): CaseDetail {
   return CaseDetail(
@@ -17,7 +18,15 @@ fun generateCaseDetail(): CaseDetail {
       ),
     dateOfBirth = "2000-03-01",
     gender = null,
-    sentence = CaseSentence(date = "2021-03-03", sentencingCourt = SentencingCourt("Fakecourt"), releaseDate = "2021-10-10"),
+    courtAppearance =
+      CourtAppearance(
+        date = "2019-10-10",
+        court =
+          CourtDetails(
+            name = "Crown",
+          ),
+      ),
+    sentence = CaseSentence(expectedReleaseDate = "2021-10-10"),
     responsibleProvider =
       ResponsibleProvider(
         code = "999000ABC",

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/smoke/EPFPersonDetailSmokeTest.kt

@@ -21,7 +21,7 @@ class EPFPersonDetailSmokeTest : DescribeSpec(
       response.statusCode().shouldBe(HttpStatus.OK.value())
       response.body().shouldEqualJson(
         """
-      {
+        {
         "data": {
           "nomsId": "string",
           "name": {
@@ -31,12 +31,17 @@ class EPFPersonDetailSmokeTest : DescribeSpec(
           },
           "dateOfBirth": "2019-08-24",
           "gender": "string",
+          "courtAppearance": {
+            "date": "2019-08-24",
+            "court": {
+              "name": "string"
+            }
+          },
           "sentence": {
             "date": null,
-            "sentencingCourt": {
-              "name": null
-            },
-            "releaseDate": null
+            "sentencingCourt": null,
+            "releaseDate": null,
+            "expectedReleaseDate": "2019-08-24"
           },
           "responsibleProvider": {
             "code": "string",