PIL-1917 Update Obligations and Submissions stub

app/models/obligationsandsubmissions/Obligation.scala

@@ -37,6 +37,6 @@ sealed trait ObligationType extends EnumEntry
 object ObligationType extends Enum[ObligationType] with PlayJsonEnum[ObligationType] {
   val values: IndexedSeq[ObligationType] = findValues
 
-  case object Pillar2TaxReturn extends ObligationType
-  case object GlobeInformationReturn extends ObligationType
+  case object UKTR extends ObligationType
+  case object GIR extends ObligationType
 }

app/models/obligationsandsubmissions/Submission.scala

@@ -34,11 +34,17 @@ sealed trait SubmissionType extends EnumEntry {
 object SubmissionType extends Enum[SubmissionType] with PlayJsonEnum[SubmissionType] {
   val values: IndexedSeq[SubmissionType] = findValues
 
-  case object UKTR extends SubmissionType {
+  case object UKTR_CREATE extends SubmissionType {
     override val fullName: String = "UK Tax Return"
   }
-  case object ORN extends SubmissionType {
-    override val fullName: String = "Overseas Return Notification"
+  case object UKTR_AMEND extends SubmissionType {
+    override val fullName: String = "UK Tax Return Amend"
+  }
+  case object ORN_CREATE extends SubmissionType {
+    override val fullName: String = "Overseas Return Notification Create"
+  }
+  case object ORN_AMEND extends SubmissionType {
+    override val fullName: String = "Overseas Return Notification Amend"
   }
   case object BTN extends SubmissionType {
     override val fullName: String = "Below-Threshold Notification"

conf/messages.en

@@ -284,8 +284,8 @@ dueAndOverdueReturns.table.returnType = Type of return
 dueAndOverdueReturns.table.dueDate = Due date
 dueAndOverdueReturns.table.status = Status
 dueAndOverdueReturns.table.action = Action
-dueAndOverdueReturns.obligationType.Pillar2TaxReturn = UK Tax Return
-dueAndOverdueReturns.obligationType.GlobeInformationReturn = Information return
+dueAndOverdueReturns.obligationType.UKTR = UK Tax Return
+dueAndOverdueReturns.obligationType.GIR = Information return
 dueAndOverdueReturns.status.overdue = Overdue
 dueAndOverdueReturns.status.due = Due
 dueAndOverdueReturns.submissionHistory = Submission history

test/base/SpecBase.scala

@@ -96,7 +96,7 @@ trait SpecBase
         underEnquiry = false,
         obligations = Seq(
           Obligation(
-            obligationType = ObligationType.Pillar2TaxReturn,
+            obligationType = ObligationType.UKTR,
             status = status,
             canAmend = false,
             submissions = Seq.empty

test/controllers/helpers/SubmissionHistoryDataFixture.scala

@@ -17,8 +17,8 @@
 package controllers.helpers
 
 import models.obligationsandsubmissions.ObligationStatus.Fulfilled
-import models.obligationsandsubmissions.ObligationType.Pillar2TaxReturn
-import models.obligationsandsubmissions.SubmissionType.UKTR
+import models.obligationsandsubmissions.ObligationType.UKTR
+import models.obligationsandsubmissions.SubmissionType.UKTR_CREATE
 import models.obligationsandsubmissions._
 
 import java.time.{LocalDate, ZonedDateTime}
@@ -35,17 +35,17 @@ trait SubmissionHistoryDataFixture {
         underEnquiry = false,
         Seq(
           Obligation(
-            Pillar2TaxReturn,
+            UKTR,
             Fulfilled,
             canAmend = true,
             Seq(
               Submission(
-                UKTR,
+                UKTR_CREATE,
                 ZonedDateTime.now,
                 None
               ),
               Submission(
-                UKTR,
+                UKTR_CREATE,
                 ZonedDateTime.now,
                 None
               )
@@ -60,12 +60,12 @@ trait SubmissionHistoryDataFixture {
         underEnquiry = false,
         Seq(
           Obligation(
-            Pillar2TaxReturn,
+            UKTR,
             Fulfilled,
             canAmend = true,
             Seq(
               Submission(
-                UKTR,
+                UKTR_CREATE,
                 ZonedDateTime.now,
                 None
               )

test/helpers/DueAndOverdueReturnsDataFixture.scala

@@ -33,7 +33,7 @@ trait DueAndOverdueReturnsDataFixture {
   val futureDueDate: LocalDate = currentDate.plusDays(30) // Always due
 
   def createObligation(
-    obligationType: ObligationType = ObligationType.Pillar2TaxReturn,
+    obligationType: ObligationType = ObligationType.UKTR,
     status:         ObligationStatus = ObligationStatus.Open,
     canAmend:       Boolean = true
   ): Obligation =
@@ -72,7 +72,7 @@ trait DueAndOverdueReturnsDataFixture {
         obligations = Seq(
           createObligation(status = ObligationStatus.Fulfilled),
           createObligation(
-            obligationType = ObligationType.GlobeInformationReturn,
+            obligationType = ObligationType.GIR,
             status = ObligationStatus.Fulfilled
           )
         )
@@ -112,7 +112,7 @@ trait DueAndOverdueReturnsDataFixture {
         obligations = Seq(
           createObligation(),
           createObligation(
-            obligationType = ObligationType.GlobeInformationReturn,
+            obligationType = ObligationType.GIR,
             status = ObligationStatus.Fulfilled
           )
         )
@@ -136,7 +136,7 @@ trait DueAndOverdueReturnsDataFixture {
         obligations = Seq(
           createObligation(),
           createObligation(
-            obligationType = ObligationType.GlobeInformationReturn
+            obligationType = ObligationType.GIR
           )
         )
       )

test/helpers/TestDataFixture.scala

@@ -18,8 +18,7 @@ package helpers
 
 import models.btn.BTNStatus
 import models.obligationsandsubmissions.ObligationStatus.Fulfilled
-import models.obligationsandsubmissions.ObligationType.Pillar2TaxReturn
-import models.obligationsandsubmissions.SubmissionType.UKTR
+import models.obligationsandsubmissions.SubmissionType.UKTR_CREATE
 import models.obligationsandsubmissions._
 import models.subscription._
 import models.{MneOrDomestic, NonUKAddress, UserAnswers}
@@ -54,10 +53,10 @@ trait TestDataFixture extends SubscriptionLocalDataFixture {
 
   def obligationsAndSubmissionsSuccessResponse(
     underEnquiry:   Boolean = false,
-    obligationType: ObligationType = Pillar2TaxReturn,
+    obligationType: ObligationType = ObligationType.UKTR,
     status:         ObligationStatus = Fulfilled,
     canAmend:       Boolean = true,
-    submissionType: SubmissionType = UKTR,
+    submissionType: SubmissionType = UKTR_CREATE,
     receivedDate:   ZonedDateTime = testZonedDateTime,
     country:        Option[String] = None
   ): ObligationsAndSubmissionsSuccessResponse =

test/views/helpers/SubmissionHistoryHelperSpec.scala

@@ -17,8 +17,8 @@
 package views.helpers
 
 import models.obligationsandsubmissions.ObligationStatus.{Fulfilled, Open}
-import models.obligationsandsubmissions.ObligationType.{GlobeInformationReturn, Pillar2TaxReturn}
-import models.obligationsandsubmissions.SubmissionType.{GIR, UKTR}
+import models.obligationsandsubmissions.ObligationType
+import models.obligationsandsubmissions.SubmissionType
 import models.obligationsandsubmissions.{AccountingPeriodDetails, Obligation, Submission}
 import org.mockito.Mockito.when
 import org.scalatest.matchers.should.Matchers
@@ -40,12 +40,12 @@ class SubmissionHistoryHelperSpec extends AnyWordSpec with Matchers with Mockito
       val startDate2 = LocalDate.of(2023, 1, 1)
       val endDate2   = LocalDate.of(2023, 12, 31)
 
-      val submission1 = Submission(UKTR, ZonedDateTime.now, None)
-      val submission2 = Submission(GIR, ZonedDateTime.now, None)
+      val submission1 = Submission(SubmissionType.UKTR_CREATE, ZonedDateTime.now, None)
+      val submission2 = Submission(SubmissionType.GIR, ZonedDateTime.now, None)
 
-      val obligation1 = Obligation(Pillar2TaxReturn, Open, canAmend = true, Seq(submission1, submission2))
-      val obligation2 = Obligation(GlobeInformationReturn, Fulfilled, canAmend = false, Seq(submission1))
-      val obligation3 = Obligation(Pillar2TaxReturn, Open, canAmend = true, Seq.empty)
+      val obligation1 = Obligation(ObligationType.UKTR, Open, canAmend = true, Seq(submission1, submission2))
+      val obligation2 = Obligation(ObligationType.GIR, Fulfilled, canAmend = false, Seq(submission1))
+      val obligation3 = Obligation(ObligationType.UKTR, Open, canAmend = true, Seq.empty)
 
       val accountingPeriods = Seq(
         AccountingPeriodDetails(startDate1, endDate1, LocalDate.now, underEnquiry = false, Seq(obligation1)),
@@ -75,7 +75,7 @@ class SubmissionHistoryHelperSpec extends AnyWordSpec with Matchers with Mockito
     "create table rows correctly" in {
       val submissionDate = ZonedDateTime.now.format(DateTimeFormatter.ofPattern("d MMMM yyyy"))
 
-      val submission = Submission(UKTR, ZonedDateTime.now, None)
+      val submission = Submission(SubmissionType.UKTR_CREATE, ZonedDateTime.now, None)
       val rows       = SubmissionHistoryHelper.createTableRows(submission)
       rows                should have length 2
       rows.head.content shouldBe Text("UK Tax Return")