Trait

endpoints.scalaj.client

Endpoints

Related Doc: package client

Permalink

trait Endpoints extends algebra.Endpoints with Requests with Responses

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

Type Members

  1. case class Endpoint[Req, Resp](request: Endpoints.Request[Req], response: Endpoints.Response[Resp]) extends Product with Serializable

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

    Permalink
    Definition Classes
    InvariantFunctorSyntax
  3. type Method = String

    Permalink
    Definition Classes
    Methods → Methods
  4. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    PartialInvariantFunctorSyntax
  5. case class Path[A](toStr: (A) ⇒ String) extends Url[A] with Product with Serializable

    Permalink
    Definition Classes
    Urls
  6. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls
  7. type QueryString[A] = (A) ⇒ Seq[(String, String)]

    Permalink
    Definition Classes
    Urls → Urls
  8. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls
  9. type QueryStringParam[A] = (A) ⇒ List[String]

    Permalink
    Definition Classes
    Urls → Urls
  10. type Request[A] = (A) ⇒ HttpRequest

    Permalink
    Definition Classes
    Requests → Requests
  11. type RequestEntity[A] = (A, HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Requests → Requests
  12. type RequestHeaders[A] = (A) ⇒ Seq[(String, String)]

    Permalink
    Definition Classes
    Requests → Requests
  13. type Response[A] = (HttpResponse[String]) ⇒ Either[Throwable, A]

    Permalink
    Definition Classes
    Responses → Responses
  14. implicit class ResponseExtensions[A] extends AnyRef

    Permalink
    Definition Classes
    Responses
  15. type Segment[A] = (A) ⇒ String

    Permalink
    Definition Classes
    Urls → Urls
  16. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    SemigroupalSyntax
  17. type StatusCode = Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  18. class Url[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

Abstract Value Members

  1. abstract def address: String

    Permalink
    Definition Classes
    Urls

Concrete 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: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  5. def Delete: Method

    Permalink
    Definition Classes
    Methods → Methods
  6. def Get: Method

    Permalink
    Definition Classes
    Methods → Methods
  7. def NotFound: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  8. def OK: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  9. def Options: Method

    Permalink
    Definition Classes
    Methods → Methods
  10. def Patch: Method

    Permalink
    Definition Classes
    Methods → Methods
  11. def Post: Method

    Permalink
    Definition Classes
    Methods → Methods
  12. def Put: Method

    Permalink
    Definition Classes
    Methods → Methods
  13. def Unauthorized: Int

    Permalink
    Definition Classes
    StatusCodes → StatusCodes
  14. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  15. implicit def booleanQueryString: QueryStringParam[Boolean]

    Permalink
    Definition Classes
    Urls
  16. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Permalink
    Definition Classes
    Urls → Urls
  17. def clone(): AnyRef

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

    Permalink
    Definition Classes
    Urls → Urls
  19. 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
  20. implicit def doubleQueryString: QueryStringParam[Double]

    Permalink
    Definition Classes
    Urls
  21. implicit def doubleSegment: Segment[Double]

    Permalink
    Definition Classes
    Urls
  22. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

    Permalink
    Definition Classes
    Urls
  23. def emptyHeaders: RequestHeaders[Unit]

    Permalink
    Definition Classes
    Requests → Requests
  24. def emptyRequest: RequestEntity[Unit]

    Permalink
    Definition Classes
    Requests → Requests
  25. def emptyResponse(docs: Documentation): Response[Unit]

    Permalink
    Definition Classes
    Responses → Responses
  26. 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
  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  29. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. 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
  31. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  32. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  33. def header(name: String, docs: Documentation): (String) ⇒ Seq[(String, String)]

    Permalink
    Definition Classes
    Requests → Requests
  34. implicit def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls
  35. implicit def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls
  36. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  37. implicit def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls
  38. implicit def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls
  39. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  40. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  41. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  42. def optHeader(name: String, docs: Documentation): (Option[String]) ⇒ Seq[(String, String)]

    Permalink
    Definition Classes
    Requests → Requests
  43. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

    Permalink
    Definition Classes
    Urls → Urls
  44. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls
  45. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Permalink
    Definition Classes
    Urls → Urls
  46. 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
  47. def protocol: String

    Permalink
    Definition Classes
    Urls
  48. 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
  49. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

    Permalink
    Definition Classes
    Urls → Urls
  50. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

    Permalink
    Definition Classes
    Urls → Urls
  51. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

    Permalink
    Definition Classes
    Urls → Urls
  52. def remainingSegments(name: String, docs: Documentation): Path[String]

    Permalink
    Definition Classes
    Urls → Urls
  53. 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
  54. implicit def reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    Requests → Requests
  55. implicit def reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    Requests → Requests
  56. implicit def reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    Requests → Requests
  57. def request[U, E, H, UE, Out](method: Method, url: Url[U], entity: RequestEntity[E] = emptyRequest, headers: RequestHeaders[H] = emptyHeaders)(implicit tuplerUE: Tupler.Aux[U, E, UE], tuplerUEH: Tupler.Aux[UE, H, Out]): Request[Out]

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

    Permalink
    Definition Classes
    Urls → Urls
  59. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

    Permalink
    Definition Classes
    Urls → Urls
  60. def staticPathSegment(segment: String): Path[Unit]

    Permalink
    Definition Classes
    Urls → Urls
  61. implicit def stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls
  62. implicit def stringSegment: Segment[String]

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

    Permalink
    Definition Classes
    AnyRef
  64. def textRequest(docs: Option[String]): (String, HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    Requests → Requests
  65. def textResponse(docs: Documentation): Response[String]

    Permalink
    Definition Classes
    Responses → Responses
  66. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  67. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]

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

    Permalink

    Builds an URL from the given path and query string

    Builds an URL from the given path and query string

    Definition Classes
    Urls → Urls
  69. implicit def uuidQueryString: QueryStringParam[UUID]

    Permalink
    Definition Classes
    Urls
  70. implicit def uuidSegment: Segment[UUID]

    Permalink
    Definition Classes
    Urls
  71. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. def wheneverFound[A](inner: (HttpResponse[String]) ⇒ Either[Throwable, A], notFoundDocs: Documentation): (HttpResponse[String]) ⇒ Either[Throwable, Option[A]]

    Permalink
    Definition Classes
    Responses → Responses

Inherited from Responses

Inherited from StatusCodes

Inherited from Requests

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from algebra.Responses

Inherited from algebra.StatusCodes

Inherited from algebra.Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped