api-platform-application-domain
API
Generated with
api-platform-application-domain/uk.gov.hmrc.apiplatform.modules/uk.gov.hmrc.apiplatform.modules.applications/uk.gov.hmrc.apiplatform.modules.applications.core/uk.gov.hmrc.apiplatform.modules.applications.core.domain.models

uk.gov.hmrc.apiplatform.modules.applications.core.domain.models

package uk.gov.hmrc.apiplatform.modules.applications.core.domain.models

Members list

Type members

Classlikes

trait AppLocking

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
Self type
object ApplicationName

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case object ApplicationNameInvalidCharacters extends ApplicationNameValidationFailed

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
case object ApplicationNameInvalidLength extends ApplicationNameValidationFailed

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
trait ApplicationNameValidationFailed

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ApplicationState(name: State = ..., requestedByEmailAddress: Option[String] = ..., requestedByName: Option[String] = ..., verificationCode: Option[String] = ..., updatedOn: Instant)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ApplicationToken(clientId: ClientId, accessToken: String, clientSecrets: List[ClientSecret], lastAccessTokenUsage: Option[Instant])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ApplicationWithCollaborators(details: CoreApplication, collaborators: Set[Collaborator]) extends HasEnvironment, HasState, AppLocking, HasAccess, HasCollaborators

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAccess
trait AppLocking
trait HasState
class Object
trait Matchable
class Any
Show all
object ApplicationWithCollaborators

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ApplicationWithSubscriptionFields(details: CoreApplication, collaborators: Set[Collaborator], subscriptions: Set[ApiIdentifier], fieldValues: ApiFieldMap[FieldValue]) extends HasEnvironment, HasState, AppLocking, HasAccess, HasCollaborators

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAccess
trait AppLocking
trait HasState
class Object
trait Matchable
class Any
Show all
object ApplicationWithSubscriptionFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ApplicationWithSubscriptions(details: CoreApplication, collaborators: Set[Collaborator], subscriptions: Set[ApiIdentifier]) extends HasEnvironment, HasState, AppLocking, HasAccess, HasCollaborators

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAccess
trait AppLocking
trait HasState
class Object
trait Matchable
class Any
Show all
object ApplicationWithSubscriptions

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CheckInformation(contactDetails: Option[ContactDetails] = ..., confirmedName: Boolean = ..., apiSubscriptionsConfirmed: Boolean = ..., apiSubscriptionConfigurationsConfirmed: Boolean = ..., providedPrivacyPolicyURL: Boolean = ..., providedTermsAndConditionsURL: Boolean = ..., applicationDetails: Option[String] = ..., teamConfirmed: Boolean = ..., termsOfUseAgreements: List[TermsOfUseAgreement] = ...)

Attributes

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

Attributes

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

This should also do validation of the CidrBlock as already happens in TPDFE. We should add this later.

This should also do validation of the CidrBlock as already happens in TPDFE. We should add this later.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
CidrBlock.type
case class ClientSecret(id: Id, name: String, createdOn: Instant, lastAccess: Option[Instant] = ...)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ClientSecretsHashingConfig(config: Config)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Collaborator

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Developer
object Collaborator

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object Collaborators

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class ContactDetails(fullname: FullName, email: LaxEmailAddress, telephoneNumber: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CoreApplication(id: ApplicationId, token: ApplicationToken, gatewayId: String, name: ApplicationName, deployedTo: Environment, description: Option[String], createdOn: Instant, lastAccess: Option[Instant], grantLength: GrantLength, access: Access, state: ApplicationState, rateLimitTier: RateLimitTier, checkInformation: Option[CheckInformation], blocked: Boolean, ipAllowlist: IpAllowlist, lastActionActor: ActorType, deleteRestriction: DeleteRestriction, organisationId: Option[OrganisationId]) extends HasEnvironment, HasState, AppLocking, HasAccess

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HasAccess
trait AppLocking
trait HasState
class Object
trait Matchable
class Any
Show all
object CoreApplication

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait DeleteRestriction

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DoNotDelete
object NoRestriction
object DeleteRestriction

Attributes

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

Attributes

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

Attributes

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

This class is retained for as long as there are GrantLengthAsInt floating around

This class is retained for as long as there are GrantLengthAsInt floating around

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object FIVE_YEARS
object FOUR_HOURS
object ONE_DAY
object ONE_MONTH
object ONE_YEAR
object SIX_MONTHS
object TEN_YEARS
object THREE_MONTHS
object THREE_YEARS
Show all
object GrantLength

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait HasAccess

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait HasCollaborators

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait HasEnvironment

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait HasState

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class InvalidStateTransition(invalidFrom: State, to: State, expectedFrom: State) extends RuntimeException

Attributes

Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class IpAllowlist(required: Boolean = ..., allowlist: Set[String] = ...)

Attributes

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

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class PaginatedApplications(applications: List[ApplicationWithCollaborators], page: Int, pageSize: Int, total: Int, matching: Int)

Attributes

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

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
enum RateLimitTier(val orderIndex: Int)

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object RedirectUri

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
enum State

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
State.type
case class StateHistory(applicationId: ApplicationId, state: State, actor: Actor, previousState: Option[State] = ..., notes: Option[String] = ..., changedAt: Instant)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class TermsOfUseAgreement(emailAddress: LaxEmailAddress, timeStamp: Instant, version: String)

Attributes

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

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

Types

opaque type ApplicationName
opaque type CidrBlock
opaque type LoginRedirectUri
opaque type PostLogoutRedirectUri
Generated with