Class

endpoints.akkahttp.client

Endpoints

Related Doc: package client

Permalink

class Endpoints extends algebra.Endpoints with Urls with Methods with StatusCodes

Source
Endpoints.scala
Linear Supertypes
StatusCodes, Methods, Urls, algebra.Endpoints, Responses, algebra.StatusCodes, Requests, endpoints.SemigroupalSyntax, endpoints.PartialInvariantFunctorSyntax, endpoints.InvariantFunctorSyntax, algebra.Methods, algebra.Urls, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoints
  2. StatusCodes
  3. Methods
  4. Urls
  5. Endpoints
  6. Responses
  7. StatusCodes
  8. Requests
  9. SemigroupalSyntax
  10. PartialInvariantFunctorSyntax
  11. InvariantFunctorSyntax
  12. Methods
  13. Urls
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Endpoints(settings: EndpointsSettings)(implicit EC: ExecutionContext, M: Materializer)

    Permalink

Type Members

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

    Permalink
    Definition Classes
    Endpoints → Endpoints

  2. case class InvalidHeaderDefinition(parsingResult: ParsingResult) extends RuntimeException with Product with Serializable

    Permalink

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

    Permalink
    Definition Classes
    InvariantFunctorSyntax

  4. type Method = (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Methods → Methods

  5. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    PartialInvariantFunctorSyntax

  6. trait Path[A] extends Url[A]

    Permalink
    Definition Classes
    Urls

  7. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  8. trait QueryString[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  9. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  10. type QueryStringParam[A] = (A) ⇒ List[String]

    Permalink

    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. type Request[A] = (A) ⇒ Future[HttpResponse]

    Permalink
    Definition Classes
    Endpoints → Requests

  12. type RequestEntity[A] = (A, HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Endpoints → Requests

  13. type RequestHeaders[A] = (A, List[HttpHeader]) ⇒ List[HttpHeader]

    Permalink
    Definition Classes
    Endpoints → Requests

  14. type Response[A] = (HttpResponse) ⇒ Future[Either[Throwable, A]]

    Permalink
    Definition Classes
    Endpoints → Responses

  15. implicit class ResponseExtensions[A] extends AnyRef

    Permalink
    Definition Classes
    Responses

  16. trait Segment[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    SemigroupalSyntax

  18. type StatusCode = akka.http.scaladsl.model.StatusCode

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  19. trait Url[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def BadRequest: ClientError

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  5. def Delete: (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Methods → Methods

  6. implicit val EC: ExecutionContext

    Permalink

  7. def Get: (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Methods → Methods

  8. implicit val M: Materializer

    Permalink

  9. def NotFound: ClientError

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  10. def OK: Success

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  11. def Options: (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Methods → Methods

  12. def Patch: (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Methods → Methods

  13. def Post: (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Methods → Methods

  14. def Put: (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Methods → Methods

  15. def Unauthorized: ClientError

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  16. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  17. implicit def booleanQueryString: QueryStringParam[Boolean]

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  19. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    Urls → Urls

  21. def createHeader(name: String, value: String): HttpHeader

    Permalink
    Attributes
    protected

  22. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests

  23. implicit def doubleQueryString: QueryStringParam[Double]

    Permalink
    Definition Classes
    Urls

  24. implicit def doubleSegment: Segment[Double]

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Urls

  26. lazy val emptyHeaders: RequestHeaders[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  27. lazy val emptyRequest: RequestEntity[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  28. def emptyResponse(docs: Documentation): (HttpResponse) ⇒ Future[Either[Throwable, Unit]]

    Permalink
    Definition Classes
    Endpoints → Responses

  29. def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation, tags: List[String]): Endpoint[A, B]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  30. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  31. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  32. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  33. final def get[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests

  34. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  35. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  36. def header(name: String, docs: Option[String]): (String, List[HttpHeader]) ⇒ List[HttpHeader]

    Permalink
    Definition Classes
    Endpoints → Requests

  37. implicit def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls

  38. implicit def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls

  39. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  40. implicit def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls

  41. implicit def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls

  42. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  43. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  44. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  45. def optHeader(name: String, docs: Option[String]): (Option[String], List[HttpHeader]) ⇒ List[HttpHeader]

    Permalink
    Definition Classes
    Endpoints → Requests

  46. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

    Permalink
    Definition Classes
    Urls → Urls

  47. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls

  48. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Requests

  50. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests

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

    Permalink
    Definition Classes
    Urls → Urls

  52. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

    Permalink
    Definition Classes
    Urls → Urls

  53. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

    Permalink
    Definition Classes
    Urls → Urls

  54. def remainingSegments(name: String, docs: Documentation): Path[String]

    Permalink
    Definition Classes
    Urls → Urls

  55. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

    Permalink
    Definition Classes
    Urls → Urls

  56. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    Endpoints → Requests

  57. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

  58. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Urls → Urls

  61. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

    Permalink
    Definition Classes
    Urls → Urls

  62. val settings: EndpointsSettings

    Permalink

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

    Permalink
    Definition Classes
    Urls → Urls

  64. implicit lazy val stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls

  65. implicit lazy val stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    AnyRef

  67. def textRequest(docs: Option[String]): (String, HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Endpoints → Requests

  68. def textResponse(docs: Documentation): (HttpResponse) ⇒ Future[Either[Throwable, String]]

    Permalink
    Definition Classes
    Endpoints → Responses

  69. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  70. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  72. val utf8Name: String

    Permalink
    Definition Classes
    Urls

  73. implicit def uuidQueryString: QueryStringParam[UUID]

    Permalink
    Definition Classes
    Urls

  74. implicit def uuidSegment: Segment[UUID]

    Permalink
    Definition Classes
    Urls

  75. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  77. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  78. def wheneverFound[A](inner: (HttpResponse) ⇒ Future[Either[Throwable, A]], notFoundDocs: Documentation): (HttpResponse) ⇒ Future[Either[Throwable, Option[A]]]

    Permalink
    Definition Classes
    Endpoints → Responses

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints.SemigroupalSyntax

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped