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. Protected

Instance Constructors

  1. new Endpoints(host: Uri, client: Client[F])(implicit arg0: Sync[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. type Endpoint[A, B] = Kleisli[Effect, A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  6. final class EndpointDocs extends Serializable
    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. type Response[A] = (StatusCode, Headers) => Option[ResponseEntity[A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  18. type ResponseEntity[A] = (org.http4s.Response[Effect]) => Effect[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  19. type ResponseHeaders[A] = (Headers) => Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  20. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  21. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  22. type ServerError = Throwable
    Definition Classes
    BuiltInErrors → Errors
  23. type StatusCode = Status
    Definition Classes
    StatusCodes → StatusCodes
  24. trait Path[A] extends Url[A]
    Definition Classes
    Urls
  25. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  26. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  27. 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 Post: Method
    Definition Classes
    Methods → Methods
  35. def PreconditionFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  36. def PreconditionRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  37. def ProxyAuthenticationRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  38. def Put: Method
    Definition Classes
    Methods → Methods
  39. def RangeNotSatisfiable: Status
    Definition Classes
    StatusCodes → StatusCodes
  40. def RequestHeaderFieldsTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  41. def RequestTimeout: Status
    Definition Classes
    StatusCodes → StatusCodes
  42. def ResetContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  43. def TooEarly: Status
    Definition Classes
    StatusCodes → StatusCodes
  44. def TooManyRequests: Status
    Definition Classes
    StatusCodes → StatusCodes
  45. def Unauthorized: Status
    Definition Classes
    StatusCodes → StatusCodes
  46. def UnavailableForLegalReasons: Status
    Definition Classes
    StatusCodes → StatusCodes
  47. def UnprocessableEntity: Status
    Definition Classes
    StatusCodes → StatusCodes
  48. def UnsupportedMediaType: Status
    Definition Classes
    StatusCodes → StatusCodes
  49. def UpgradeRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  50. def UriTooLong: Status
    Definition Classes
    StatusCodes → StatusCodes
  51. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  52. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  53. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  54. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  55. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  56. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  57. val client: Client[F]
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  58. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  59. def clientErrorsResponseEntity: ResponseEntity[Invalid]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  60. final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    BuiltInErrors → Errors
  61. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  62. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  63. 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
  64. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  65. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  66. def effect: Sync[Effect]
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  67. def emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  68. def emptyRequestHeaders: RequestHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  69. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  70. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  71. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  72. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  73. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  74. 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
  75. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  76. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  77. val host: Uri
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  78. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  79. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  80. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  81. final def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    BuiltInErrors → Errors
  82. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  83. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  84. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  85. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  86. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  87. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  88. 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
  89. def optRequestHeader(name: String, docs: Option[String]): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  90. def optResponseHeader(name: String, docs: Option[String]): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  91. def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  92. 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
  93. val path: Path[Unit]
    Definition Classes
    Urls
  94. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  95. 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
  96. 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
  97. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  98. def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  99. def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  100. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  101. def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  102. 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
  103. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  104. def requestHeader(name: String, docs: Option[String]): RequestHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  105. implicit def requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  106. implicit def requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  107. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  108. 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
  109. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  110. def responseHeader(name: String, docs: Option[String]): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  111. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  112. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  113. implicit def responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  114. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  115. def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  116. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  117. def serverErrorResponseEntity: ResponseEntity[Throwable]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  118. final def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    BuiltInErrors → Errors
  119. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  120. def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  121. def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  122. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  123. def textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  124. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  125. final def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    BuiltInErrors → Errors
  126. def toString(): String
    Definition Classes
    AnyRef → Any
  127. def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  128. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  129. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  130. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  131. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  132. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  133. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  134. 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