uk.gov.hmrc.auth.core

# retrieve

#### package retrieve

Visibility

1. Public
2. All

### Type Members

1. #### case class AgentInformation(agentId: Option[String], agentCode: Option[String], agentFriendlyName: Option[String]) extends Product with Serializable

2. #### case class CompositeRetrieval[A, B](retrievalA: Retrieval[A], retrievalB: Retrieval[B]) extends Retrieval[~[A, B]] with Product with Serializable

   A Retrieval for two properties on successful authorisation

3. #### case class Credentials(providerId: String, providerType: String) extends Product with Serializable

4. #### case class Email(value: String) extends Product with Serializable

5. #### case class GGCredId(credId: String) extends LegacyCredentials with Product with Serializable

6. #### case class GatewayInformation(gatewayToken: Option[String]) extends Product with Serializable

7. #### case class ItmpAddress(line1: Option[String], line2: Option[String], line3: Option[String], line4: Option[String], line5: Option[String], postCode: Option[String], countryName: Option[String], countryCode: Option[String]) extends Product with Serializable

8. #### case class ItmpName(givenName: Option[String], middleName: Option[String], familyName: Option[String]) extends Product with Serializable

9. #### trait LegacyCredentials extends AnyRef

10. #### case class LoginTimes(currentLogin: DateTime, previousLogin: Option[DateTime]) extends Product with Serializable

11. #### case class MdtpInformation(deviceId: String, sessionId: String) extends Product with Serializable

12. #### case class Name(name: Option[String], lastName: Option[String]) extends Product with Serializable

13. #### case class OptionalRetrieval[A](propertyName: String, valueReads: Reads[A]) extends Retrieval[Option[A]] with Product with Serializable

    A Retrieval that will return only a single, optional property on successful authorisation

    A Retrieval that will return only a single, optional property on successful authorisation

    propertyName

      The name of the property to return from auth on success. Must be a supported property in auth.

    valueReads

      The JSON Reads to apply to the returned JSON property in case it is present

14. #### case class PAClientId(clientId: String) extends LegacyCredentials with Product with Serializable

15. #### case class PostCode(value: String) extends Product with Serializable

16. #### trait Retrieval[A] extends AnyRef

    A typed class that models what will be returned from auth upon a successful authorisation call

17. #### case class SimpleRetrieval[A](propertyName: String, valueReads: Reads[A]) extends Retrieval[A] with Product with Serializable

    A Retrieval that will return only a single property on successful authorisation

    A Retrieval that will return only a single property on successful authorisation

    propertyName

      The name of the property to return from auth on success. Must be a supported property in auth.

    valueReads

      The JSON Reads to apply to the returned JSON property

18. #### case class VerifyPid(pid: String) extends LegacyCredentials with Product with Serializable

19. #### case class ~[+A, +B](a: A, b: B) extends Product with Serializable

    Some type-trickery to allow composing of multiple retrievals at the call site

20. #### trait Retrievals extends AnyRef

    Annotations
      @deprecated
    Deprecated

### Value Members

1. #### object AgentInformation extends Serializable

2. #### object Credentials extends Serializable

3. #### object Email extends Serializable

4. #### object EmptyRetrieval extends Retrieval[Unit]

   Simple modelling of a Retrieval that returns nothing (would be a simple authorise-only call)

5. #### object GatewayInformation extends Serializable

6. #### object ItmpAddress extends Serializable

7. #### object ItmpName extends Serializable

8. #### object LegacyCredentials

9. #### object LoginTimes extends Serializable

10. #### object MdtpInformation extends Serializable

11. #### object Name extends Serializable

12. #### object OneTimeLogin extends LegacyCredentials with Product with Serializable

13. #### object PostCode extends Serializable

14. #### package v2

### Deprecated Value Members

1. #### object Retrievals extends Retrievals

   Annotations
     @deprecated
   Deprecated

### Ungrouped