Packages

trait Requests extends algebra.Requests with Urls with Methods

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Requests
  2. Methods
  3. Urls
  4. Requests
  5. SemigroupalSyntax
  6. Methods
  7. Urls
  8. PartialInvariantFunctorSyntax
  9. InvariantFunctorSyntax
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait Method extends AnyRef
    Definition Classes
    Methods
  2. case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema) extends Product with Serializable
  3. case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable

    value

    List of request header names (e.g. “Authorization”)

  4. case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: DocumentedHeaders, documentation: Documentation, entity: Map[String, MediaType]) extends Product with Serializable
  5. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  6. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  7. type Path[A] = DocumentedUrl
    Definition Classes
    Urls → Urls
  8. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  9. type QueryString[A] = DocumentedQueryString
    Definition Classes
    Urls → Urls
  10. type QueryStringParam[A] = DocumentedQueryStringParam
    Definition Classes
    Urls → Urls
  11. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  12. type Request[A] = DocumentedRequest
    Definition Classes
    Requests → Requests
  13. type RequestEntity[A] = Map[String, MediaType]
    Definition Classes
    Requests → Requests
  14. type RequestHeaders[A] = DocumentedHeaders
    Definition Classes
    Requests → Requests
  15. type Segment[A] = Schema
    Definition Classes
    Urls → Urls
  16. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  17. type Url[A] = DocumentedUrl
    Definition Classes
    Urls → Urls
  18. case class DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema) extends Product with Serializable

    name

    Name of the parameter

    required

    Whether this parameter is required or not (MUST be true for path parameters)

    Definition Classes
    Urls
  19. case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable

    parameters

    List of query string parameters

    Definition Classes
    Urls
  20. case class DocumentedQueryStringParam(schema: Schema, isRequired: Boolean) extends Product with Serializable
    Definition Classes
    Urls
  21. case class DocumentedUrl(path: List[Either[String, DocumentedParameter]], queryParameters: List[DocumentedParameter]) extends Product with Serializable

    path

    List of path segments. Left is a static segment, right is a path parameter

    queryParameters

    Query string parameters

    Definition Classes
    Urls

Value Members

  1. object Delete extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  2. object Get extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  3. object Options extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  4. object Patch extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  5. object Post extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  6. object Put extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  7. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def ##(): Int
    Definition Classes
    AnyRef → Any
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls → Urls
  12. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  15. 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
  16. def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls → Urls
  17. def doubleSegment: Segment[Double]
    Definition Classes
    Urls → Urls
  18. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]
    Definition Classes
    Urls
  19. def emptyHeaders: DocumentedHeaders
    Definition Classes
    Requests → Requests
  20. lazy val emptyRequest: Map[String, MediaType]
    Definition Classes
    Requests → Requests
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  24. 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
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def header(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    Requests → Requests
  28. def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls → Urls
  29. def intSegment: Segment[Int]
    Definition Classes
    Urls → Urls
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls → Urls
  32. def longSegment: Segment[Long]
    Definition Classes
    Urls → Urls
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    Requests → Requests
  37. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  38. val path: Path[Unit]
    Definition Classes
    Urls
  39. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  40. 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
  41. 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
  42. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  43. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  44. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  45. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  46. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  47. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]
    Definition Classes
    Requests → Requests
  48. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]
    Definition Classes
    Requests → Requests
  49. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    Requests → Requests
  50. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
    Definition Classes
    Requests → Requests
  51. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  52. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  53. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  54. def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  55. def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  56. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  57. lazy val textRequest: Map[String, MediaType]
    Definition Classes
    Requests → Requests
  58. def toString(): String
    Definition Classes
    AnyRef → Any
  59. def tryParseString[A](type: String)(parse: (String) => A): (String) => Validated[A]
    Definition Classes
    Urls
  60. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  61. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  62. def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls → Urls
  63. def uuidSegment: Segment[UUID]
    Definition Classes
    Urls → Urls
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Methods

Inherited from Urls

Inherited from algebra.Requests

Inherited from endpoints.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped