dc-message-library
API
Generated with
dc-message-library/uk.gov.hmrc.common.message/uk.gov.hmrc.common.message.model

uk.gov.hmrc.common.message.model

package uk.gov.hmrc.common.message.model

Members list

Type members

Classlikes

case class Adviser(pidId: String)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Adviser

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Adviser.type
final case class Alert(templateId: String, parameters: Option[Map[String, String]])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Alert

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Alert.type
case class AlertDetails(templateId: String, recipientName: Option[TaxpayerName], data: Map[String, String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AlertDetails

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait AlertEmailTemplateMapper

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AlertQueueTypes

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait Alertable

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Message
case class ConversationItem(id: String, subject: String, body: Option[Details], validFrom: LocalDate, content: Option[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConversationItem

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object DateFormats

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case object Delivered extends MailgunStatus

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Delivered.type
case class Details(form: Option[String], `type`: Option[String], suppressedAt: Option[String], detailsId: Option[String], paperSent: Option[Boolean], batchId: Option[String], issueDate: Option[LocalDate], replyTo: Option[String], threadId: Option[String], enquiryType: Option[String], adviser: Option[Adviser], waitTime: Option[String], topic: Option[String], envelopId: Option[String], properties: Option[JsValue])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Details

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Details.type
case class EmailAlert(emailAddress: Option[String], alertTime: Instant, success: Boolean, failureReason: Option[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EmailAlert

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
EmailAlert.type
final case class Enrolments(main: String, fallback: List[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Enrolments

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Enrolments.type
case class ExternalRef(id: String, source: String)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ExternalRef

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum Language(val entryName: String)

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Language

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Language.type
case class Lifecycle(status: LifecycleStatus, startedAt: Instant, notification: Option[Notification])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Lifecycle

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Lifecycle.type
case class LifecycleStatus(name: LifecycleStatusType, updated: Instant)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LifecycleStatus

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum LifecycleStatusType(val entryName: String)

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LifecycleStatusType

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait MailgunStatus

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Delivered
object MailgunStatus

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Message(id: ObjectId, recipient: TaxEntity, subject: String, body: Option[Details], validFrom: LocalDate, alertFrom: Option[LocalDate], alertDetails: AlertDetails, alerts: Option[EmailAlert], alertQueue: Option[String], readTime: Option[Instant], archiveTime: Option[Instant], contentParameters: Option[MessageContentParameters], status: ProcessingStatus, rescindment: Option[Rescindment], lastUpdated: Option[Instant], hash: String, statutory: Boolean, renderUrl: RenderUrl, sourceData: Option[String], externalRef: Option[ExternalRef], content: Option[String], emailAlertEventUrl: Option[String], verificationBrake: Option[Boolean], lifecycle: Option[Lifecycle], tags: Option[Map[String, String]], deliveredOn: Option[Instant], mailgunStatus: Option[MailgunStatus]) extends Alertable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Alertable
class Object
trait Matchable
class Any
Show all
object Message

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Message.type
case class MessageContentParameters(data: ContentParameters, templateId: String)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessageContentParameters

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class MessageDetails(formId: String, statutoryOp: Option[Boolean], paperSentOp: Option[Boolean], sourceData: Option[String], batchId: Option[String], issueDate: Option[LocalDate], replyTo: Option[String], threadId: Option[String], enquiryType: Option[String], adviser: Option[Adviser], waitTime: Option[String], topic: Option[String], properties: Option[JsValue])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessageDetails

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object MessageMongoFormats

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object MessageRESTFormats extends AlertEmailTemplateMapper

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class MessageStatus(envelopeId: Option[String], status: Option[LifecycleStatusType])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessageStatus

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class MessagesCount(total: Int, unread: Int)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MessagesCount

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object MongoTaxIdentifierFormats

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class Notification(count: Int, lastSent: Instant)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Notification

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Recipient(taxIdentifier: TaxIdWithName, name: Option[TaxpayerName], email: Option[String], regime: Option[Value])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Recipient

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Recipient.type
object RecipientNonQuadientErrorFormats

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait Regime

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Regime extends Enumeration

Attributes

Companion
trait
Supertypes
class Enumeration
trait Serializable
class Object
trait Matchable
class Any
Self type
Regime.type
case class RenderUrl(service: String, url: String)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RenderUrl

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
RenderUrl.type
case class Rescindment(time: Instant, `type`: RescindmentType, ref: String)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Rescindment

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
enum RescindmentType

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RescindmentType

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class SendAlertResponse(sendAlert: Boolean)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SendAlertResponse

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait SystemTimeSource extends TimeSource

Attributes

Companion
object
Supertypes
trait TimeSource
class Object
trait Matchable
class Any
Known subtypes
object SystemTimeSource extends SystemTimeSource

Attributes

Companion
trait
Supertypes
trait TimeSource
class Object
trait Matchable
class Any
Self type
final case class TaxEntity(regime: Value, identifier: TaxIdWithName, email: Option[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TaxEntity

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
TaxEntity.type
object TaxIdentifierRESTV2Formats

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class TaxpayerName(title: Option[String], forename: Option[String], secondForename: Option[String], surname: Option[String], honours: Option[String], line1: Option[String], line2: Option[String], line3: Option[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TaxpayerName

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait TimeSource

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes

Types

type ContentParameters = JsValue

Value members

Concrete methods

def formatDate(date: LocalDate): String
def localDateReads: Reads[LocalDate]

Concrete fields

val defaultDateFormat: String
Generated with