Type Members

1.  case class Adviser(pidId: String) extends Product with Serializable
2.  case class AlertDetails(templateId: String, recipientName: Option[TaxpayerName], data: Map[String, String]) extends Product with Serializable
3.  trait AlertEmailTemplateMapper extends AnyRef
4.  trait Alertable extends AnyRef
5.  type ContentParameters = JsValue
6.  case class ConversationItem(id: String, subject: String, body: Option[Details], validFrom: LocalDate, content: Option[String]) extends Product with Serializable
7.  case class Details(form: Option[String], type: Option[String], suppressedAt: Option[String], detailsId: Option[String], paperSent: Option[Boolean] = None, batchId: Option[String] = None, issueDate: Option[LocalDate] = Some(LocalDate.now), replyTo: Option[String] = None, threadId: Option[String] = None, enquiryType: Option[String] = None, adviser: Option[Adviser] = None, waitTime: Option[String] = None, topic: Option[String] = None, envelopId: Option[String] = None, properties: Option[JsValue] = None) extends Product with Serializable
8.  case class EmailAlert(emailAddress: Option[String], alertTime: Instant, success: Boolean, failureReason: Option[String]) extends Product with Serializable
9.  final case class Enrolments(main: String, fallback: List[String]) extends Product with Serializable
10.  case class ExternalRef(id: String, source: String) extends Product with Serializable
11.  case class Lifecycle(status: LifecycleStatus, startedAt: Instant, notification: Option[Notification] = None) extends Product with Serializable
12.  case class LifecycleStatus(name: LifecycleStatusType, updated: Instant) extends Product with Serializable
13.  sealed trait LifecycleStatusType extends EnumEntry with UpperSnakecase
14.  sealed trait MailgunStatus extends AnyRef
15.  case class Message(id: ObjectId = new ObjectId, recipient: TaxEntity, subject: String, body: Option[Details], validFrom: LocalDate, alertFrom: Option[LocalDate], alertDetails: AlertDetails, alerts: Option[EmailAlert] = None, alertQueue: Option[String] = None, readTime: Option[Instant] = None, archiveTime: Option[Instant] = None, contentParameters: Option[MessageContentParameters] = None, status: ProcessingStatus = ToDo, rescindment: Option[Rescindment] = None, lastUpdated: Option[Instant], hash: String, statutory: Boolean, renderUrl: RenderUrl, sourceData: Option[String], externalRef: Option[ExternalRef] = None, content: Option[String] = None, emailAlertEventUrl: Option[String] = None, verificationBrake: Option[Boolean] = None, lifecycle: Option[Lifecycle] = None, tags: Option[Map[String, String]] = None, deliveredOn: Option[Instant] = None, mailgunStatus: Option[MailgunStatus] = None) extends Alertable with Product with Serializable
16.  case class MessageContentParameters(data: ContentParameters, templateId: String) extends Product with Serializable
17.  case class MessageDetails(formId: String, statutoryOp: Option[Boolean], paperSentOp: Option[Boolean], sourceData: Option[String], batchId: Option[String], issueDate: Option[LocalDate] = Some(LocalDate.now), replyTo: Option[String], threadId: Option[String] = Some(new ObjectId().toString), enquiryType: Option[String] = None, adviser: Option[Adviser] = None, waitTime: Option[String] = None, topic: Option[String] = None, properties: Option[JsValue] = None) extends Product with Serializable
18.  case class MessageStatus(envelopeId: Option[String], status: Option[LifecycleStatusType]) extends Product with Serializable
19.  final case class MessagesCount(total: Int, unread: Int) extends Product with Serializable
20.  case class Notification(count: Int, lastSent: Instant) extends Product with Serializable
21.  case class Recipient(taxIdentifier: TaxIdWithName, name: Option[TaxpayerName], email: Option[String] = None, regime: Option[Regime.Value] = None) extends Product with Serializable
22.  sealed trait Regime extends AnyRef
23.  case class RenderUrl(service: String, url: String) extends Product with Serializable
24.  case class Rescindment(time: Instant, type: Type, ref: String) extends Product with Serializable
25.  final case class SendAlertResponse(sendAlert: Boolean) extends Product with Serializable
26.  trait SystemTimeSource extends TimeSource
27.  final case class TaxEntity(regime: Regime.Value, identifier: TaxIdWithName, email: Option[String] = None) extends Product with Serializable
28.  case class TaxpayerName(title: Option[String] = None, forename: Option[String] = None, secondForename: Option[String] = None, surname: Option[String] = None, honours: Option[String] = None, line1: Option[String] = None, line2: Option[String] = None, line3: Option[String] = None) extends Product with Serializable
29.  trait TimeSource extends AnyRef