opensavvy.spine.client

Types

SpineReceptionException

class SpineReceptionException(val response: HttpResponse, body: String) : RuntimeException

The exception thrown by bodyOrThrow.

SpineResponse

class SpineResponse<Out : Any, out Failure : FailureSpec>(val httpResponse: HttpResponse, val failureSpec: Failure)

The type returned by request, encapsulating an HTTP response.

Functions

request

inline suspend fun <Out : Any, Failure : FailureSpec> HttpClient.request(
    endpoint: ResolvedEndpoint<Endpoint<Unit, Out, Failure, Parameters.Empty>>, 
    contentType: ContentType = ContentType.Application.Json, 
    crossinline configure: HttpRequestBuilder.() -> Unit = {}
): SpineResponse<Out, Failure>

Invokes a Ktor typesafe endpoint.

inline suspend fun <In : Any, Out : Any, Failure : FailureSpec> HttpClient.request(
    endpoint: ResolvedEndpoint<Endpoint<In, Out, Failure, Parameters.Empty>>, 
    input: In, 
    contentType: ContentType = ContentType.Application.Json, 
    crossinline configure: HttpRequestBuilder.() -> Unit = {}
): SpineResponse<Out, Failure>

Invokes a Ktor typesafe endpoint.

inline suspend fun <Out : Any, Failure : FailureSpec, Params : Parameters> HttpClient.request(
    endpoint: ResolvedEndpoint<Endpoint<Unit, Out, Failure, Params>>, 
    crossinline parameters: Params.() -> Unit, 
    contentType: ContentType = ContentType.Application.Json, 
    crossinline configure: HttpRequestBuilder.() -> Unit = {}
): SpineResponse<Out, Failure>

Invokes a Ktor typesafe endpoint.

inline suspend fun <In : Any, Out : Any, Failure : FailureSpec, Params : Parameters> HttpClient.request(
    endpoint: ResolvedEndpoint<Endpoint<In, Out, Failure, Params>>, 
    input: In, 
    crossinline parameters: Params.() -> Unit, 
    contentType: ContentType = ContentType.Application.Json, 
    crossinline configure: HttpRequestBuilder.() -> Unit = {}
): SpineResponse<Out, Failure>

Invokes a Ktor typesafe endpoint.