Change return type.

Author: emmalanigan

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/BalancesController.kt

@@ -12,6 +12,7 @@ import org.springframework.web.bind.annotation.RequestAttribute
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception.EntityNotFoundException
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Balance
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Balances
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.DataResponse
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError
@@ -79,7 +80,7 @@ class BalancesController(
     @PathVariable prisonId: String,
     @PathVariable accountCode: String,
     @RequestAttribute filters: ConsumerFilters?,
-  ): DataResponse<Balances?> {
+  ): DataResponse<Balance?> {
     val response = getBalancesForPersonService.getBalance(prisonId, hmppsId, accountCode, filters = filters)
 
     if (response.hasError(UpstreamApiError.Type.ENTITY_NOT_FOUND)) {

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

@@ -8,3 +8,7 @@ data class AccountBalance(
 data class Balances(
   val balances: List<AccountBalance> = emptyList(),
 )
+
+data class Balance(
+  val balance: AccountBalance,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetBalancesForPersonService.kt

@@ -4,6 +4,7 @@ import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.stereotype.Service
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.gateways.NomisGateway
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.AccountBalance
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Balance
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Balances
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
@@ -77,7 +78,7 @@ class GetBalancesForPersonService(
     hmppsId: String,
     accountCode: String,
     filters: ConsumerFilters? = null,
-  ): Response<Balances?> {
+  ): Response<Balance?> {
     if (!listOf("spends", "savings", "cash").any { it == accountCode }) {
       return Response(
         data = null,
@@ -100,7 +101,7 @@ class GetBalancesForPersonService(
       throw IllegalStateException("Error occurred while trying to get accounts for person with id: $hmppsId")
     }
 
-    val balance = Balances(balances = listOf(accountBalance))
+    val balance = Balance(balance = accountBalance)
     return Response(data = balance, errors = emptyList())
   }
 }

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/BalancesControllerTest.kt

@@ -16,6 +16,7 @@ import org.springframework.test.web.servlet.MockMvc
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.removeWhitespaceAndNewlines
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.helpers.IntegrationAPIMockMvc
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.AccountBalance
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Balance
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Balances
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
@@ -50,11 +51,8 @@ class BalancesControllerTest(
           ),
       )
     val singleBalance =
-      Balances(
-        balances =
-          listOf(
-            AccountBalance(accountCode = "spends", amount = 201),
-          ),
+      Balance(
+        balance = AccountBalance(accountCode = "spends", amount = 201),
       )
 
     it("gets the balances for a person with the matching ID") {
@@ -180,12 +178,12 @@ class BalancesControllerTest(
       result.response.contentAsString.shouldContain(
         """
           "data": {
-            "balances": [
+            "balance":
               {
                 "accountCode": "spends",
                 "amount": 201
               }
-            ]
+
           }
         """.removeWhitespaceAndNewlines(),
       )

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/integration/prison/BalanceIntegrationTest.kt

@@ -51,12 +51,11 @@ class BalanceIntegrationTest : IntegrationTestBase() {
           """
         {
           "data": {
-            "balances": [
+            "balance":
               {
                 "accountCode": "savings",
                 "amount": 12344
               }
-            ]
           }
         }
       """,

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetBalancesForPersonServiceTest.kt

@@ -12,6 +12,7 @@ import org.springframework.test.context.ContextConfiguration
 import org.springframework.test.context.bean.override.mockito.MockitoBean
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.gateways.NomisGateway
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.AccountBalance
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Balance
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Balances
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.NomisNumber
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
@@ -66,11 +67,8 @@ internal class GetBalancesForPersonServiceTest(
       )
 
     val singleBalance =
-      Balances(
-        balances =
-          listOf(
-            AccountBalance(accountCode = accountCode, amount = nomisSpends),
-          ),
+      Balance(
+        balance = AccountBalance(accountCode = accountCode, amount = nomisSpends),
       )
 
     it("gets a person using a Hmpps ID") {