core/it.maicol07.spraypaintkt

Package-level declarations

Types

CollectionProxy

data class CollectionProxy<R : Resource>(val data: List<R>, val meta: Map<String, Any>, val raw: JsonApiCollectionResponse)

A wrapper for a collection of resources.

JsonApiCollectionResponse

class JsonApiCollectionResponse(response: Map<String, Any>) : JsonApiResponse

A collection JSON:API response

@Serializable

data class JsonApiError(val id: String? = null, val links: JsonApiError.Links? = null, val status: String? = null, val code: String? = null, val title: String? = null, val detail: String? = null, val source: JsonApiError.Source? = null, val meta: JsonObject? = null)

An error returned by the JSON:API server.

JsonApiErrorResponse

@Serializable

data class JsonApiErrorResponse(val errors: List<JsonApiError>)

An error returned by the JSON:API server.

JsonApiException

@Serializable

class JsonApiException(val statusCode: Int, val body: String) : RuntimeException

An exception thrown by the JSON:API server.

JsonApiRelationship

class JsonApiRelationship(response: Map<String, Any>) : Map<String, Any?>

A JSON:API relationship

JsonApiRelationshipData

class JsonApiRelationshipData(response: Map<String, Any>) : Map<String, Any?>

A JSON:API relationship data

JsonApiRelationshipLinks

class JsonApiRelationshipLinks(response: Map<String, Any>) : Map<String, Any?>

A JSON:API relationship links

JsonApiResource

class JsonApiResource(response: Map<String, Any>) : Map<String, Any?>

A JSON:API resource

JsonApiResponse

abstract class JsonApiResponse(response: Map<String, Any>) : Map<String, Any?>

Base fields for a JSON:API response

JsonApiSingleResponse

class JsonApiSingleResponse(response: Map<String, Any>) : JsonApiResponse

A single JSON:API response

PaginationStrategy

enum PaginationStrategy : Enum<PaginationStrategy>

The strategy to use for pagination.

data class RecordProxy<R : Resource>(val data: R, val meta: Map<String, Any>, val raw: JsonApiSingleResponse)

A wrapper for a single resource.

@Serializable(with = ResourceSerializer::class)

abstract class Resource

A JSON:API resource.

ResourceRegistry

object ResourceRegistry

A JSON:API resource.

ResourceSerializer

object ResourceSerializer : KSerializer<Resource>

class Scope<R : Resource>(resourceClass: KClass<R>, options: Scope<R>.() -> Unit = {})

A scope for querying the server.

ScopePagination

data class ScopePagination(var number: Number? = null, var size: Number? = null, var limit: Number? = null, var offset: Number? = null)

The pagination options.

enum SortDirection : Enum<SortDirection>

The direction of the sorting.