Packages

class Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoints
  2. BuiltInErrors
  3. EndpointsWithCustomErrors
  4. StatusCodes
  5. Methods
  6. Urls
  7. Endpoints
  8. BuiltInErrors
  9. EndpointsWithCustomErrors
  10. Errors
  11. Responses
  12. StatusCodes
  13. Requests
  14. SemigroupalSyntax
  15. Methods
  16. Urls
  17. PartialInvariantFunctorSyntax
  18. InvariantFunctorSyntax
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Endpoints(host: String, wsClient: WSClient)(implicit executionContext: ExecutionContext)

    host

    Base of the URL of the service that implements the endpoints (e.g. "http://foo.com")

    wsClient

    The underlying client to use

Type Members

  1. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. type ClientErrors = Invalid
    Definition Classes
    BuiltInErrors → Errors
  4. type Endpoint[A, B] = (A) ⇒ Future[B]

    A function that, given an A, eventually attempts to decode the B response.

    A function that, given an A, eventually attempts to decode the B response.

    Communication failures and protocol failures are represented by a Future.failed.

    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  5. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  6. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  7. type Method = (WSRequest) ⇒ WSRequest

    String representation of the method

    String representation of the method

    Definition Classes
    Methods → Methods
  8. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  9. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  10. type QueryStringParam[A] = (A) ⇒ List[String]

    a query string parameter can have zero or several values

    a query string parameter can have zero or several values

    Definition Classes
    Urls → Urls
  11. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  12. type Request[A] = (A) ⇒ Future[WSResponse]

    A function that takes an A information and eventually returns a WSResponse

    A function that takes an A information and eventually returns a WSResponse

    Definition Classes
    EndpointsWithCustomErrors → Requests
  13. type RequestEntity[A] = (A, WSRequest) ⇒ WSRequest

    A function that, given an A information and a WSRequest, returns a WSRequest with a body correctly set

    A function that, given an A information and a WSRequest, returns a WSRequest with a body correctly set

    Definition Classes
    EndpointsWithCustomErrors → Requests
  14. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  15. type RequestHeaders[A] = (A, WSRequest) ⇒ WSRequest

    A function that, given an A and a request model, returns an updated request containing additional headers

    A function that, given an A and a request model, returns an updated request containing additional headers

    Definition Classes
    EndpointsWithCustomErrors → Requests
  16. type Response[A] = (StatusCode, Map[String, Seq[String]]) ⇒ Option[ResponseEntity[A]]

    Function returning the entity decoder from the response status and headers

    Function returning the entity decoder from the response status and headers

    Definition Classes
    EndpointsWithCustomErrors → Responses
  17. type ResponseEntity[A] = (WSResponse) ⇒ Either[Throwable, A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  18. type ResponseHeaders[A] = (Map[String, Seq[String]]) ⇒ Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  19. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  20. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  21. type ServerError = Throwable
    Definition Classes
    BuiltInErrors → Errors
  22. type StatusCode = Int
    Definition Classes
    StatusCodes → StatusCodes
  23. trait Path[A] extends Url[A]
    Definition Classes
    Urls
  24. trait QueryString[A] extends AnyRef
    Definition Classes
    Urls
  25. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  26. trait Url[A] extends AnyRef
    Definition Classes
    Urls

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def Accepted: Int
    Definition Classes
    StatusCodes → StatusCodes
  5. def AlreadyReported: Int
    Definition Classes
    StatusCodes → StatusCodes
  6. def BadRequest: Int
    Definition Classes
    StatusCodes → StatusCodes
  7. def Conflict: Int
    Definition Classes
    StatusCodes → StatusCodes
  8. def Created: Int
    Definition Classes
    StatusCodes → StatusCodes
  9. def Delete: Method
    Definition Classes
    Methods → Methods
  10. def ExpectationFailed: Int
    Definition Classes
    StatusCodes → StatusCodes
  11. def FailedDependency: Int
    Definition Classes
    StatusCodes → StatusCodes
  12. def Forbidden: Int
    Definition Classes
    StatusCodes → StatusCodes
  13. def Get: Method
    Definition Classes
    Methods → Methods
  14. def Gone: Int
    Definition Classes
    StatusCodes → StatusCodes
  15. def IMUsed: Int
    Definition Classes
    StatusCodes → StatusCodes
  16. def InternalServerError: Int
    Definition Classes
    StatusCodes → StatusCodes
  17. def LengthRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  18. def Locked: Int
    Definition Classes
    StatusCodes → StatusCodes
  19. def MethodNotAllowed: Int
    Definition Classes
    StatusCodes → StatusCodes
  20. def MisdirectedRequest: Int
    Definition Classes
    StatusCodes → StatusCodes
  21. def MultiStatus: Int
    Definition Classes
    StatusCodes → StatusCodes
  22. def NoContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  23. def NonAuthoritativeInformation: Int
    Definition Classes
    StatusCodes → StatusCodes
  24. def NotAcceptable: Int
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotFound: Int
    Definition Classes
    StatusCodes → StatusCodes
  26. def NotImplemented: Int
    Definition Classes
    StatusCodes → StatusCodes
  27. def NotModified: Int
    Definition Classes
    StatusCodes → StatusCodes
  28. def OK: Int
    Definition Classes
    StatusCodes → StatusCodes
  29. def Options: Method
    Definition Classes
    Methods → Methods
  30. def PartialContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  31. def Patch: Method
    Definition Classes
    Methods → Methods
  32. def PayloadTooLarge: Int
    Definition Classes
    StatusCodes → StatusCodes
  33. def PaymentRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  34. def Post: Method
    Definition Classes
    Methods → Methods
  35. def PreconditionFailed: Int
    Definition Classes
    StatusCodes → StatusCodes
  36. def PreconditionRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  37. def ProxyAuthenticationRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  38. def Put: Method
    Definition Classes
    Methods → Methods
  39. def RangeNotSatisfiable: Int
    Definition Classes
    StatusCodes → StatusCodes
  40. def RequestHeaderFieldsTooLarge: Int
    Definition Classes
    StatusCodes → StatusCodes
  41. def RequestTimeout: Int
    Definition Classes
    StatusCodes → StatusCodes
  42. def ResetContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  43. def TooEarly: Int
    Definition Classes
    StatusCodes → StatusCodes
  44. def TooManyRequests: Int
    Definition Classes
    StatusCodes → StatusCodes
  45. def Unauthorized: Int
    Definition Classes
    StatusCodes → StatusCodes
  46. def UnavailableForLegalReasons: Int
    Definition Classes
    StatusCodes → StatusCodes
  47. def UnprocessableEntity: Int
    Definition Classes
    StatusCodes → StatusCodes
  48. def UnsupportedMediaType: Int
    Definition Classes
    StatusCodes → StatusCodes
  49. def UpgradeRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  50. def UriTooLong: Int
    Definition Classes
    StatusCodes → StatusCodes
  51. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  52. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  53. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  54. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  55. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  56. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  57. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  58. def clientErrorsResponseEntity: ResponseEntity[Invalid]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  59. final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    BuiltInErrors → Errors
  60. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  61. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  62. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  63. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  64. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  65. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  66. lazy val emptyRequestHeaders: RequestHeaders[Unit]

    Does not modify the request

    Does not modify the request

    Definition Classes
    EndpointsWithCustomErrors → Requests
  67. def emptyResponse: ResponseEntity[Unit]

    Discards response entity

    Discards response entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  68. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  69. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  70. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  71. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  72. implicit val executionContext: ExecutionContext
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  73. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  74. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  75. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  76. val host: String
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  77. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  78. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  79. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  80. final def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    BuiltInErrors → Errors
  81. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  82. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  83. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  84. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  85. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  86. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  87. final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    Responses
  88. def optRequestHeader(name: String, docs: Documentation): (Option[String], WSRequest) ⇒ WSRequest
    Definition Classes
    EndpointsWithCustomErrors → Requests
  89. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  90. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  91. final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  92. val path: Path[Unit]
    Definition Classes
    Urls
  93. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  94. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  95. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  96. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  97. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  98. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  99. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  100. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  101. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  102. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  103. def requestHeader(name: String, docs: Documentation): (String, WSRequest) ⇒ WSRequest
    Definition Classes
    EndpointsWithCustomErrors → Requests
  104. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  105. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  106. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  107. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  108. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  109. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  110. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  111. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  112. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  113. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  114. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  115. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  116. def serverErrorResponseEntity: ResponseEntity[Throwable]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  117. final def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    BuiltInErrors → Errors
  118. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  119. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  120. implicit lazy val stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  121. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  122. lazy val textRequest: (String, WSRequest) ⇒ WSRequest
    Definition Classes
    EndpointsWithCustomErrors → Requests
  123. def textResponse: ResponseEntity[String]

    Decodes a string entity from a response

    Decodes a string entity from a response

    Definition Classes
    EndpointsWithCustomErrors → Responses
  124. final def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    BuiltInErrors → Errors
  125. def toString(): String
    Definition Classes
    AnyRef → Any
  126. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  127. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  128. val utf8Name: String
    Definition Classes
    Urls
  129. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  130. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  131. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  133. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  135. val wsClient: WSClient
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  136. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from BuiltInErrors

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from algebra.BuiltInErrors

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints4s.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped