Type Members

1.  case class AccessGroup(_id: ObjectId, arn: Arn, groupName: String, created: LocalDateTime, lastUpdated: LocalDateTime, createdBy: AgentUser, lastUpdatedBy: AgentUser, teamMembers: Option[Set[AgentUser]], clients: Option[Set[Client]]) extends Product with Serializable
2.  case class AccessGroupSummary(groupId: String, groupName: String, clientCount: Option[Int], teamMemberCount: Int, isCustomGroup: Boolean) extends Product with Serializable
3.  case class AgentUser(id: String, name: String) extends Product with Serializable
4.  case class Arn(value: String) extends TaxIdentifier with Product with Serializable
5.  case class AssignedClient(clientEnrolmentKey: String, friendlyName: Option[String], assignedTo: String) extends Product with Serializable

   Represents client assigned to users in the ES21 APi response.

6.  case class CgtRef(value: String) extends TaxIdentifier with Product with Serializable
7.  case class Client(enrolmentKey: String, friendlyName: String) extends Product with Serializable
8.  sealed abstract class ClientIdType[+T <: TaxIdentifier] extends AnyRef
9.  case class ClientIdentifier[T <: TaxIdentifier](underlying: T) extends Product with Serializable
10.  case class ClientList(assigned: Set[Client], unassigned: Set[Client]) extends Product with Serializable
11.  case class Enrolment(service: String, state: String, friendlyName: String, identifiers: Seq[Identifier], activationDate: Option[String] = None, enrolmentDate: Option[String] = None) extends Product with Serializable
12.  case class Eori(value: String) extends TaxIdentifier with Product with Serializable
13.  case class GroupDelegatedEnrolments(clients: Seq[AssignedClient]) extends Product with Serializable
14.  case class GroupId(arn: Arn, groupName: String) extends Product with Serializable
15.  case class Identifier(key: String, value: String) extends Product with Serializable
16.  case class InvitationId(value: String) extends Product with Serializable
17.  case class MtdItId(value: String) extends TaxIdentifier with Product with Serializable
18.  case class OptinEvent(optinEventType: OptinEventType, user: AgentUser, eventDateTime: LocalDateTime) extends Product with Serializable
19.  sealed trait OptinEventType extends AnyRef
20.  case class OptinRecord(arn: Arn, history: List[OptinEvent]) extends Product with Serializable
21.  sealed trait OptinStatus extends AnyRef
22.  case class PaginatedList[T](pageContent: Seq[T], paginationMetaData: PaginationMetaData) extends Product with Serializable
23.  case class PaginationMetaData(lastPage: Boolean, firstPage: Boolean, totalSize: Int, totalPages: Int, pageSize: Int, currentPageNumber: Int, currentPageSize: Int) extends Product with Serializable
24.  case class PptRef(value: String) extends TaxIdentifier with Product with Serializable
25.  sealed abstract class Service extends AnyRef
26.  case class SuspensionDetails(suspensionStatus: Boolean, regimes: Option[Set[String]]) extends Product with Serializable
27.  case class SuspensionDetailsNotFound(message: String) extends Exception with Product with Serializable
28.  case class TaxServiceAccessGroup(_id: ObjectId, arn: Arn, groupName: String, created: LocalDateTime, lastUpdated: LocalDateTime, createdBy: AgentUser, lastUpdatedBy: AgentUser, teamMembers: Option[Set[AgentUser]], service: String, automaticUpdates: Boolean, excludedClients: Option[Set[Client]]) extends Product with Serializable
29.  trait TrustTaxIdentifier extends AnyRef
30.  case class Urn(value: String) extends TaxIdentifier with TrustTaxIdentifier with Product with Serializable
31.  case class UserDetails(userId: Option[String] = None, credentialRole: Option[String] = None, name: Option[String] = None, email: Option[String] = None) extends Product with Serializable

    Cut down version of UserDetails from users-groups-search.

    Cut down version of UserDetails from users-groups-search. Contains only the fields we are interested in.

32.  case class UserEnrolment(userId: String, enrolmentKey: String) extends Product with Serializable
33.  case class UserEnrolmentAssignments(assign: Set[UserEnrolment], unassign: Set[UserEnrolment], arn: Arn) extends Product with Serializable

    Represents the user/client combinations to assign and unassign in EACD.

    Represents the user/client combinations to assign and unassign in EACD.

    assign

    combinations to assign using ES11 API

    unassign

    combinations to unassign using ES12 API

34.  case class Utr(value: String) extends TaxIdentifier with TrustTaxIdentifier with Product with Serializable
35.  case class Vrn(value: String) extends TaxIdentifier with Product with Serializable