[APB-10746] Update shared models (#198)

* [APB-10746] Update shared models

* [APB-10746] Dependency update

* [APB-10746] Plugin update

* [APB-10746] Review comments

Author: mrolfe88

app/uk/gov/hmrc/agentregistration/shared/AgentApplication.scala

@@ -46,6 +46,8 @@ sealed trait AgentApplication:
   def hmrcStandardForAgentsAgreed: StateOfAgreement
   def numberOfRequiredKeyIndividuals: Option[NumberOfRequiredKeyIndividuals] // all applications require this, sole traders will have a list of one
   def hasOtherRelevantIndividuals: Option[Boolean]
+  def vrns: Option[List[Vrn]]
+  def payeRefs: Option[List[PayeRef]]
 
   //  /** Updates the application state to the next state */
   //  def updateApplicationState: AgentApplication =
@@ -103,10 +105,6 @@ sealed trait AgentApplication:
     expectedDataNotDefinedError("numberOfRequiredKeyIndividuals")
   )
 
-  def getHasOtherRelevantIndividuals: Boolean = hasOtherRelevantIndividuals.getOrElse(
-    expectedDataNotDefinedError("hasOtherRelevantIndividuals")
-  )
-
   private def as[T <: AgentApplication](using ct: reflect.ClassTag[T]): Option[T] =
     this match
       case t: T => Some(t)
@@ -140,14 +138,16 @@ final case class AgentApplicationSoleTrader(
   override val agentDetails: Option[AgentDetails],
   override val refusalToDealWithCheckResult: Option[CheckResult],
   deceasedCheckResult: Option[CheckResult],
-  override val hmrcStandardForAgentsAgreed: StateOfAgreement
+  override val hmrcStandardForAgentsAgreed: StateOfAgreement,
+  override val hasOtherRelevantIndividuals: Option[Boolean],
+  override val vrns: Option[List[Vrn]],
+  override val payeRefs: Option[List[PayeRef]]
 )
 extends AgentApplication:
 
   override val businessType: BusinessType.SoleTrader.type = BusinessType.SoleTrader
   def getBusinessDetails: BusinessDetailsSoleTrader = businessDetails.getOrElse(expectedDataNotDefinedError("businessDetails"))
   override def numberOfRequiredKeyIndividuals: Option[NumberOfRequiredKeyIndividuals] = Some(AgentApplicationSoleTrader.numberOfRequiredKeyIndividuals)
-  override def hasOtherRelevantIndividuals: Option[Boolean] = Some(false)
 
 object AgentApplicationSoleTrader:
   val numberOfRequiredKeyIndividuals: NumberOfRequiredKeyIndividuals = FiveOrLess(1)
@@ -170,7 +170,9 @@ final case class AgentApplicationLlp(
   companyStatusCheckResult: Option[CheckResult],
   override val hmrcStandardForAgentsAgreed: StateOfAgreement,
   override val numberOfRequiredKeyIndividuals: Option[NumberOfRequiredKeyIndividuals],
-  override val hasOtherRelevantIndividuals: Option[Boolean]
+  override val hasOtherRelevantIndividuals: Option[Boolean],
+  override val vrns: Option[List[Vrn]],
+  override val payeRefs: Option[List[PayeRef]]
 )
 extends AgentApplication:
 
@@ -197,7 +199,9 @@ final case class AgentApplicationLimitedCompany(
   companyStatusCheckResult: Option[CheckResult],
   override val hmrcStandardForAgentsAgreed: StateOfAgreement,
   override val numberOfRequiredKeyIndividuals: Option[NumberOfRequiredKeyIndividuals],
-  override val hasOtherRelevantIndividuals: Option[Boolean]
+  override val hasOtherRelevantIndividuals: Option[Boolean],
+  override val vrns: Option[List[Vrn]],
+  override val payeRefs: Option[List[PayeRef]]
 )
 extends AgentApplication:
 
@@ -223,7 +227,9 @@ final case class AgentApplicationGeneralPartnership(
   override val refusalToDealWithCheckResult: Option[CheckResult],
   override val hmrcStandardForAgentsAgreed: StateOfAgreement,
   override val numberOfRequiredKeyIndividuals: Option[NumberOfRequiredKeyIndividuals],
-  override val hasOtherRelevantIndividuals: Option[Boolean]
+  override val hasOtherRelevantIndividuals: Option[Boolean],
+  override val vrns: Option[List[Vrn]],
+  override val payeRefs: Option[List[PayeRef]]
 )
 extends AgentApplication:
 
@@ -248,7 +254,9 @@ final case class AgentApplicationLimitedPartnership(
   companyStatusCheckResult: Option[CheckResult],
   override val hmrcStandardForAgentsAgreed: StateOfAgreement,
   override val numberOfRequiredKeyIndividuals: Option[NumberOfRequiredKeyIndividuals],
-  override val hasOtherRelevantIndividuals: Option[Boolean]
+  override val hasOtherRelevantIndividuals: Option[Boolean],
+  override val vrns: Option[List[Vrn]],
+  override val payeRefs: Option[List[PayeRef]]
 )
 extends AgentApplication:
 
@@ -273,7 +281,9 @@ final case class AgentApplicationScottishLimitedPartnership(
   companyStatusCheckResult: Option[CheckResult],
   override val hmrcStandardForAgentsAgreed: StateOfAgreement,
   override val numberOfRequiredKeyIndividuals: Option[NumberOfRequiredKeyIndividuals],
-  override val hasOtherRelevantIndividuals: Option[Boolean]
+  override val hasOtherRelevantIndividuals: Option[Boolean],
+  override val vrns: Option[List[Vrn]],
+  override val payeRefs: Option[List[PayeRef]]
 )
 extends AgentApplication:
 
@@ -297,7 +307,9 @@ final case class AgentApplicationScottishPartnership(
   override val refusalToDealWithCheckResult: Option[CheckResult],
   override val hmrcStandardForAgentsAgreed: StateOfAgreement,
   override val numberOfRequiredKeyIndividuals: Option[NumberOfRequiredKeyIndividuals],
-  override val hasOtherRelevantIndividuals: Option[Boolean]
+  override val hasOtherRelevantIndividuals: Option[Boolean],
+  override val vrns: Option[List[Vrn]],
+  override val payeRefs: Option[List[PayeRef]]
 )
 extends AgentApplication:
 

app/uk/gov/hmrc/agentregistration/shared/PayeRef.scala

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2025 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package uk.gov.hmrc.agentregistration.shared
+
+import play.api.libs.json.Format
+import uk.gov.hmrc.agentregistration.shared.util.JsonFormatsFactory
+
+/** Paye Reference Number
+  */
+final case class PayeRef(value: String)
+
+object PayeRef:
+  given format: Format[PayeRef] = JsonFormatsFactory.makeValueClassFormat

app/uk/gov/hmrc/agentregistration/shared/Vrn.scala

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2025 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package uk.gov.hmrc.agentregistration.shared
+
+import play.api.libs.json.Format
+import uk.gov.hmrc.agentregistration.shared.util.JsonFormatsFactory
+
+/** Vat Registration Number (Vrn)
+  */
+final case class Vrn(value: String)
+
+object Vrn:
+  given format: Format[Vrn] = JsonFormatsFactory.makeValueClassFormat

app/uk/gov/hmrc/agentregistration/shared/individual/IndividualProvidedDetails.scala

@@ -19,8 +19,10 @@ package uk.gov.hmrc.agentregistration.shared.individual
 import play.api.libs.json.*
 import uk.gov.hmrc.agentregistration.shared.AgentApplicationId
 import uk.gov.hmrc.agentregistration.shared.InternalUserId
+import uk.gov.hmrc.agentregistration.shared.PayeRef
 import uk.gov.hmrc.agentregistration.shared.StateOfAgreement
 import uk.gov.hmrc.agentregistration.shared.TelephoneNumber
+import uk.gov.hmrc.agentregistration.shared.Vrn
 import uk.gov.hmrc.agentregistration.shared.lists.IndividualName
 import uk.gov.hmrc.agentregistration.shared.individual.ProvidedDetailsState.Finished
 import uk.gov.hmrc.agentregistration.shared.individual.ProvidedDetailsState.Precreated
@@ -45,7 +47,9 @@ final case class IndividualProvidedDetails(
   individualNino: Option[IndividualNino] = None,
   individualSaUtr: Option[IndividualSaUtr] = None,
   hmrcStandardForAgentsAgreed: StateOfAgreement = StateOfAgreement.NotSet,
-  hasApprovedApplication: Option[Boolean] = None
+  hasApprovedApplication: Option[Boolean] = None,
+  vrns: Option[List[Vrn]] = None,
+  payeRefs: Option[List[PayeRef]] = None
 ):
 
   val individualProvidedDetailsId: IndividualProvidedDetailsId = _id

app/uk/gov/hmrc/agentregistration/shared/risking/SubmitForRiskingRequest.scala

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2026 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package uk.gov.hmrc.agentregistration.shared.risking
+
+import play.api.libs.json.Json
+import play.api.libs.json.OFormat
+import uk.gov.hmrc.agentregistration.shared.AgentApplication
+import uk.gov.hmrc.agentregistration.shared.AgentApplicationFormats
+import uk.gov.hmrc.agentregistration.shared.individual.IndividualProvidedDetails
+
+final case class SubmitForRiskingRequest(
+  agentApplication: AgentApplication,
+  individuals: List[IndividualProvidedDetails]
+)
+
+object SubmitForRiskingRequest:
+
+  import AgentApplicationFormats.format
+
+  given OFormat[SubmitForRiskingRequest] = Json.format[SubmitForRiskingRequest]

app/uk/gov/hmrc/agentregistration/shared/util/OptionalListExtensions.scala

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2026 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package uk.gov.hmrc.agentregistration.shared.util
+
+object OptionalListExtensions:
+
+  extension (s: Option[List[String]])
+
+    inline def transformToCommaSeparatedString: String = s.fold("")(_.mkString(","))

app/uk/gov/hmrc/agentregistrationfrontend/services/applicant/ApplicationFactory.scala

@@ -48,7 +48,10 @@ class ApplicationFactory @Inject() (
     agentDetails = None,
     refusalToDealWithCheckResult = None,
     deceasedCheckResult = None,
-    hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet
+    hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
+    hasOtherRelevantIndividuals = None,
+    vrns = None,
+    payeRefs = None
   )
 
   def makeNewAgentApplicationLlp(
@@ -71,7 +74,9 @@ class ApplicationFactory @Inject() (
     companyStatusCheckResult = None,
     hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
     numberOfRequiredKeyIndividuals = None,
-    hasOtherRelevantIndividuals = None
+    hasOtherRelevantIndividuals = None,
+    vrns = None,
+    payeRefs = None
   )
 
   def makeNewAgentApplicationLimitedCompany(
@@ -94,7 +99,9 @@ class ApplicationFactory @Inject() (
     companyStatusCheckResult = None,
     hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
     numberOfRequiredKeyIndividuals = None,
-    hasOtherRelevantIndividuals = None
+    hasOtherRelevantIndividuals = None,
+    vrns = None,
+    payeRefs = None
   )
 
   def makeNewAgentApplicationGeneralPartnership(
@@ -116,7 +123,9 @@ class ApplicationFactory @Inject() (
     refusalToDealWithCheckResult = None,
     hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
     numberOfRequiredKeyIndividuals = None,
-    hasOtherRelevantIndividuals = None
+    hasOtherRelevantIndividuals = None,
+    vrns = None,
+    payeRefs = None
   )
 
   def makeNewAgentApplicationLimitedPartnership(
@@ -139,7 +148,9 @@ class ApplicationFactory @Inject() (
     companyStatusCheckResult = None,
     hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
     numberOfRequiredKeyIndividuals = None,
-    hasOtherRelevantIndividuals = None
+    hasOtherRelevantIndividuals = None,
+    vrns = None,
+    payeRefs = None
   )
 
   def makeNewAgentApplicationScottishLimitedPartnership(
@@ -162,7 +173,9 @@ class ApplicationFactory @Inject() (
     companyStatusCheckResult = None,
     hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
     numberOfRequiredKeyIndividuals = None,
-    hasOtherRelevantIndividuals = None
+    hasOtherRelevantIndividuals = None,
+    vrns = None,
+    payeRefs = None
   )
 
   def makeNewAgentApplicationScottishPartnership(
@@ -184,5 +197,7 @@ class ApplicationFactory @Inject() (
     refusalToDealWithCheckResult = None,
     hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
     numberOfRequiredKeyIndividuals = None,
-    hasOtherRelevantIndividuals = None
+    hasOtherRelevantIndividuals = None,
+    vrns = None,
+    payeRefs = None
   )

app/uk/gov/hmrc/agentregistrationfrontend/testsupport/testdata/agentapplication/TdAgentApplicationGeneralPartnership.scala

@@ -49,7 +49,9 @@ trait TdAgentApplicationGeneralPartnership { dependencies: (TdBase & TdSectionAm
       refusalToDealWithCheckResult = None,
       hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
       numberOfRequiredKeyIndividuals = None,
-      hasOtherRelevantIndividuals = None
+      hasOtherRelevantIndividuals = None,
+      vrns = None,
+      payeRefs = None
     )
 
     val afterGrsDataReceived: AgentApplicationGeneralPartnership = afterStarted.copy(

app/uk/gov/hmrc/agentregistrationfrontend/testsupport/testdata/agentapplication/TdAgentApplicationLlp.scala

@@ -49,7 +49,9 @@ trait TdAgentApplicationLlp { dependencies: (TdBase & TdSectionAmls & TdSectionC
       companyStatusCheckResult = None,
       hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
       numberOfRequiredKeyIndividuals = None,
-      hasOtherRelevantIndividuals = None
+      hasOtherRelevantIndividuals = None,
+      vrns = None,
+      payeRefs = None
     )
 
     val afterGrsDataReceived: AgentApplicationLlp = afterStarted.copy(

app/uk/gov/hmrc/agentregistrationfrontend/testsupport/testdata/agentapplication/TdAgentApplicationScottishPartnership.scala

@@ -45,7 +45,9 @@ trait TdAgentApplicationScottishPartnership { dependencies: (TdBase & TdSectionA
       refusalToDealWithCheckResult = None,
       hmrcStandardForAgentsAgreed = StateOfAgreement.NotSet,
       numberOfRequiredKeyIndividuals = None,
-      hasOtherRelevantIndividuals = None
+      hasOtherRelevantIndividuals = None,
+      vrns = None,
+      payeRefs = None
     )
 
     val afterGrsDataReceived: AgentApplicationScottishPartnership = afterStarted.copy(