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. Requests
  4. Methods
  5. Urls
  6. Endpoints
  7. Responses
  8. Requests
  9. SemigroupalSyntax
  10. InvariantFunctorSyntax
  11. Methods
  12. Urls
  13. AnyRef
  14. 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. case class Path[A](toStr: (A) ⇒ String) extends Url[A] with Product with Serializable

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    SemigroupalSyntax
  16. 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 Delete: Method

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

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

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

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

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

    Permalink
    Definition Classes
    Methods → Methods
  10. final def asInstanceOf[T0]: T0

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

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

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

    Permalink
    Definition Classes
    Urls → Urls
  14. 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
  15. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Requests → Requests
  36. def optQs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

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

    Permalink
    Definition Classes
    Urls
  38. 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
  39. def protocol: String

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

    Permalink
    Definition Classes
    Urls → Urls
  42. implicit def reqEntityInvFunctor: InvariantFunctor[RequestEntity]

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

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

    Permalink
    Definition Classes
    Requests → Requests
  45. 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
  46. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Urls → Urls
  55. 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
  56. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. 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 Requests

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from algebra.Responses

Inherited from algebra.Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped