class Endpoints[F[_]] extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoints
  2. BuiltInErrors
  3. EndpointsWithCustomErrors
  4. Methods
  5. Urls
  6. StatusCodes
  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(authority: Authority, scheme: Scheme, client: Client[F])(implicit arg0: Concurrent[F])

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 Effect[A] = F[A]
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  5. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  6. implicit final class EndpointSyntax[A, B] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  7. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  8. type Method = org.http4s.Method
    Definition Classes
    Methods → Methods
  9. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  10. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  11. type QueryString[A] = (A) ⇒ Query
    Definition Classes
    Urls → Urls
  12. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  13. type Request[A] = (A) ⇒ Effect[org.http4s.Request[Effect]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  14. type RequestEntity[A] = (A, org.http4s.Request[Effect]) ⇒ org.http4s.Request[Effect]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  15. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  16. type RequestHeaders[A] = (A, org.http4s.Request[Effect]) ⇒ org.http4s.Request[Effect]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  17. implicit final class RequestSyntax[A] extends AnyRef
    Definition Classes
    Requests
  18. type Response[A] = (StatusCode, Headers) ⇒ Option[ResponseEntity[A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  19. type ResponseEntity[A] = (org.http4s.Response[Effect]) ⇒ Effect[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  20. type ResponseHeaders[A] = (Headers) ⇒ Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  21. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  22. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  23. type ServerError = Throwable
    Definition Classes
    BuiltInErrors → Errors
  24. type StatusCode = Status
    Definition Classes
    StatusCodes → StatusCodes
  25. type WithDefault[A] = Option[A]
    Definition Classes
    Urls → Urls
  26. final class Endpoint[A, B] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  27. trait Path[A] extends Url[A]
    Definition Classes
    Urls
  28. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  29. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  30. 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: Status
    Definition Classes
    StatusCodes → StatusCodes
  5. def AlreadyReported: Status
    Definition Classes
    StatusCodes → StatusCodes
  6. def BadRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  7. def Conflict: Status
    Definition Classes
    StatusCodes → StatusCodes
  8. def Created: Status
    Definition Classes
    StatusCodes → StatusCodes
  9. def Delete: Method
    Definition Classes
    Methods → Methods
  10. def ExpectationFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  11. def FailedDependency: Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def Forbidden: Status
    Definition Classes
    StatusCodes → StatusCodes
  13. def Get: Method
    Definition Classes
    Methods → Methods
  14. def Gone: Status
    Definition Classes
    StatusCodes → StatusCodes
  15. def IMUsed: Status
    Definition Classes
    StatusCodes → StatusCodes
  16. def InternalServerError: Status
    Definition Classes
    StatusCodes → StatusCodes
  17. def LengthRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  18. def Locked: Status
    Definition Classes
    StatusCodes → StatusCodes
  19. def MethodNotAllowed: Status
    Definition Classes
    StatusCodes → StatusCodes
  20. def MisdirectedRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  21. def MultiStatus: Status
    Definition Classes
    StatusCodes → StatusCodes
  22. def NoContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  23. def NonAuthoritativeInformation: Status
    Definition Classes
    StatusCodes → StatusCodes
  24. def NotAcceptable: Status
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotFound: Status
    Definition Classes
    StatusCodes → StatusCodes
  26. def NotImplemented: Status
    Definition Classes
    StatusCodes → StatusCodes
  27. def NotModified: Status
    Definition Classes
    StatusCodes → StatusCodes
  28. def OK: Status
    Definition Classes
    StatusCodes → StatusCodes
  29. def Options: Method
    Definition Classes
    Methods → Methods
  30. def PartialContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  31. def Patch: Method
    Definition Classes
    Methods → Methods
  32. def PayloadTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  33. def PaymentRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  34. def PermanentRedirect: Status
    Definition Classes
    StatusCodes → StatusCodes
  35. def Post: Method
    Definition Classes
    Methods → Methods
  36. def PreconditionFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  37. def PreconditionRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  38. def ProxyAuthenticationRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  39. def Put: Method
    Definition Classes
    Methods → Methods
  40. def RangeNotSatisfiable: Status
    Definition Classes
    StatusCodes → StatusCodes
  41. def RequestHeaderFieldsTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  42. def RequestTimeout: Status
    Definition Classes
    StatusCodes → StatusCodes
  43. def ResetContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  44. def TemporaryRedirect: Status
    Definition Classes
    StatusCodes → StatusCodes
  45. def TooEarly: Status
    Definition Classes
    StatusCodes → StatusCodes
  46. def TooManyRequests: Status
    Definition Classes
    StatusCodes → StatusCodes
  47. def Unauthorized: Status
    Definition Classes
    StatusCodes → StatusCodes
  48. def UnavailableForLegalReasons: Status
    Definition Classes
    StatusCodes → StatusCodes
  49. def UnprocessableEntity: Status
    Definition Classes
    StatusCodes → StatusCodes
  50. def UnsupportedMediaType: Status
    Definition Classes
    StatusCodes → StatusCodes
  51. def UpgradeRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  52. def UriTooLong: Status
    Definition Classes
    StatusCodes → StatusCodes
  53. def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  54. def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  55. def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  56. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  57. val authority: Authority

    The authority to use to access the endpoints

    The authority to use to access the endpoints

    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  58. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  59. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  60. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  61. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  62. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  63. val client: Client[F]
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  64. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  65. def clientErrorsResponseEntity: ResponseEntity[Invalid]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  66. final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    BuiltInErrors → Errors
  67. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  68. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  69. 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
  70. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  71. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  72. def effect: Concurrent[Effect]
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  73. def emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  74. def emptyRequestHeaders: RequestHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  75. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  76. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  77. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  78. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  79. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  80. 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
  81. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  82. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  83. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  84. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  85. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  86. final def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    BuiltInErrors → Errors
  87. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  88. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  89. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  90. def mapEndpointDocs[A, B](currentEndpoint: Endpoint[A, B], func: (EndpointDocs) ⇒ EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  91. def mapEndpointRequest[A, B, C](currentEndpoint: Endpoint[A, B], func: (Request[A]) ⇒ Request[C]): Endpoint[C, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  92. def mapEndpointResponse[A, B, C](currentEndpoint: Endpoint[A, B], func: (Response[B]) ⇒ Response[C]): Endpoint[A, C]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  93. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  94. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  95. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  96. 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
  97. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
    Definition Classes
    Urls → Urls
  98. def optRequestHeader(name: String, docs: Option[String]): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  99. def optResponseHeader(name: String, docs: Option[String]): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  100. def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  101. 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
  102. val path: Path[Unit]
    Definition Classes
    Urls
  103. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  104. 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
  105. 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
  106. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  107. def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  108. def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  109. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  110. 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
  111. def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, 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
    EndpointsWithCustomErrors → Requests
  112. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  113. def requestHeader(name: String, docs: Option[String]): RequestHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  114. implicit def requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  115. implicit def requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  116. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  117. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  118. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  119. def responseHeader(name: String, docs: Option[String]): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  120. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  121. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  122. implicit def responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  123. val scheme: Scheme

    The scheme to use to access the endpoints

    The scheme to use to access the endpoints

    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  124. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  125. def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  126. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  127. def serverErrorResponseEntity: ResponseEntity[Throwable]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  128. final def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    BuiltInErrors → Errors
  129. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  130. def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  131. def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  132. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  133. def textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  134. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  135. final def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    BuiltInErrors → Errors
  136. def toString(): String
    Definition Classes
    AnyRef → Any
  137. def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  138. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  139. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  140. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  141. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  142. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  143. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  144. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses

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 Methods

Inherited from Urls

Inherited from StatusCodes

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