Endpoints

Instance Constructors

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

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
Endpoints → Endpoints
implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
InvariantFunctorSyntax
type Method = (WSRequest) ⇒ WSRequest

String representation of the method
String representation of the method

Definition Classes
Methods → Methods
trait Path[A] extends Url[A]

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Definition Classes
Urls
trait QueryString[A] extends AnyRef

Definition Classes
Urls
implicit class QueryStringOps[A] extends AnyRef

Definition Classes
Urls
type QueryStringParam[A] = (A) ⇒ String

Definition Classes
Urls → Urls
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
Endpoints → Requests
type RequestEntity[A] = (A, WSRequest) ⇒ WSRequest

A function that, given an A information and a WSRequest, eventually returns a WSResponse
A function that, given an A information and a WSRequest, eventually returns a WSResponse

Definition Classes
Endpoints → Requests
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
Endpoints → Requests
type Response[A] = (WSResponse) ⇒ Either[Throwable, A]

Attempts to decode an A from a WSResponse.
Attempts to decode an A from a WSResponse.

Definition Classes
Endpoints → Responses
trait Segment[A] extends AnyRef

Definition Classes
Urls
implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

Definition Classes
SemigroupalSyntax
trait Url[A] extends AnyRef

Definition Classes
Urls

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def Delete: Method

Definition Classes
Methods → Methods
def Get: Method

Definition Classes
Methods → Methods
def Options: Method

Definition Classes
Methods → Methods
def Patch: Method

Definition Classes
Methods → Methods
def Post: Method

Definition Classes
Methods → Methods
def Put: Method

Definition Classes
Methods → Methods
final def asInstanceOf[T0]: T0

Definition Classes
Any
def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Definition Classes
Urls → Urls
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Definition Classes
Urls → Urls
implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

Definition Classes
Urls
lazy val emptyHeaders: RequestHeaders[Unit]

Does not modify the request
Does not modify the request

Definition Classes
Endpoints → Requests
lazy val emptyRequest: RequestEntity[Unit]

Definition Classes
Endpoints → Requests
def emptyResponse(docs: Documentation): Response[Unit]

Successfully decodes no information from a response
Successfully decodes no information from a response

Definition Classes
Endpoints → Responses
def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation): Endpoint[A, B]

Definition Classes
Endpoints → Endpoints
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
implicit val executionContext: ExecutionContext
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[UrlP, HeadersP](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerAC: Tupler[UrlP, HeadersP]): Request[Out]

Definition Classes
Requests
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def header(name: String, docs: Documentation): (String, WSRequest) ⇒ WSRequest

Definition Classes
Endpoints → Requests
implicit lazy val intQueryString: QueryStringParam[Int]

Definition Classes
Urls → Urls
implicit lazy val intSegment: Segment[Int]

Definition Classes
Urls → Urls
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit lazy val longQueryString: QueryStringParam[Long]

Definition Classes
Urls → Urls
implicit lazy val longSegment: Segment[Long]

Definition Classes
Urls → Urls
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def optHeader(name: String, docs: Documentation): (Option[String], WSRequest) ⇒ WSRequest

Definition Classes
Endpoints → Requests
def optQs[A](name: String, docs: Documentation)(implicit value: (A) ⇒ String): QueryString[Option[A]]

Definition Classes
Urls → Urls
def option[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

Definition Classes
Endpoints → Responses
val path: Path[Unit]

Definition Classes
Urls
final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerAB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerABC: Tupler[UrlAndBodyPTupled, HeadersP]): Request[Out]

Definition Classes
Requests
def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

Definition Classes
Urls → Urls
implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

Definition Classes
Endpoints → Requests
implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

Definition Classes
Endpoints → Requests
implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

Definition Classes
Endpoints → Requests
def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

Definition Classes
Endpoints → Requests
def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

Definition Classes
Urls → Urls
def staticPathSegment(segment: String): Path[Unit] with Serializable

Definition Classes
Urls → Urls
implicit lazy val stringQueryString: QueryStringParam[String]

Definition Classes
Urls → Urls
implicit lazy val stringSegment: Segment[String]

Definition Classes
Urls → Urls
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def textRequest(docs: Documentation): (String, WSRequest) ⇒ WSRequest

Definition Classes
Endpoints → Requests
def textResponse(docs: Documentation): Response[String]

Successfully decodes string information from a response
Successfully decodes string information from a response

Definition Classes
Endpoints → Responses
def toString(): String

Definition Classes
AnyRef → Any
implicit lazy val urlInvFunctor: InvariantFunctor[Url]

Definition Classes
Urls → Urls
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Definition Classes
Urls → Urls
val utf8Name: String

Definition Classes
Urls
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Endpoints | package client

class Endpoints extends algebra.Endpoints with Urls with Methods

Instance Constructors

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

Type Members

type Endpoint[A, B] = (A) ⇒ Future[B]

implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

type Method = (WSRequest) ⇒ WSRequest

trait Path[A] extends Url[A]

implicit class PathOps[A] extends AnyRef

trait QueryString[A] extends AnyRef

implicit class QueryStringOps[A] extends AnyRef

type QueryStringParam[A] = (A) ⇒ String

type Request[A] = (A) ⇒ Future[WSResponse]

type RequestEntity[A] = (A, WSRequest) ⇒ WSRequest

type RequestHeaders[A] = (A, WSRequest) ⇒ WSRequest

type Response[A] = (WSResponse) ⇒ Either[Throwable, A]

trait Segment[A] extends AnyRef

implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

trait Url[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def Delete: Method

def Get: Method

def Options: Method

def Patch: Method

def Post: Method

def Put: Method

final def asInstanceOf[T0]: T0

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

def clone(): AnyRef

def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

lazy val emptyHeaders: RequestHeaders[Unit]

lazy val emptyRequest: RequestEntity[Unit]

def emptyResponse(docs: Documentation): Response[Unit]

def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation): Endpoint[A, B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit val executionContext: ExecutionContext

def finalize(): Unit

final def get[UrlP, HeadersP](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerAC: Tupler[UrlP, HeadersP]): Request[Out]

final def getClass(): Class[_]

def hashCode(): Int

def header(name: String, docs: Documentation): (String, WSRequest) ⇒ WSRequest

implicit lazy val intQueryString: QueryStringParam[Int]

implicit lazy val intSegment: Segment[Int]

final def isInstanceOf[T0]: Boolean

implicit lazy val longQueryString: QueryStringParam[Long]

implicit lazy val longSegment: Segment[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def optHeader(name: String, docs: Documentation): (Option[String], WSRequest) ⇒ WSRequest

def optQs[A](name: String, docs: Documentation)(implicit value: (A) ⇒ String): QueryString[Option[A]]

def option[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

val path: Path[Unit]

final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerAB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerABC: Tupler[UrlAndBodyPTupled, HeadersP]): Request[Out]

def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

def staticPathSegment(segment: String): Path[Unit] with Serializable

implicit lazy val stringQueryString: QueryStringParam[String]

implicit lazy val stringSegment: Segment[String]

final def synchronized[T0](arg0: ⇒ T0): T0

def textRequest(docs: Documentation): (String, WSRequest) ⇒ WSRequest

def textResponse(docs: Documentation): Response[String]

def toString(): String

implicit lazy val urlInvFunctor: InvariantFunctor[Url]

def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

val utf8Name: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit