core/it.maicol07.spraypaintkt

Package-level declarations

Types

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

A wrapper for a collection of resources.

JsonApiCollectionResponse

data class JsonApiCollectionResponse(val data: List<JsonApiResource>, val meta: Map<String, <Error class: unknown class>> = emptyMap(), val links: JsonApiLinks? = null, val included: List<JsonApiResource> = emptyList(), val jsonapi: JsonApiObject? = null) : JsonApiResponse

A collection JSON:API response.

JsonApiError

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: Map<String, <Error class: unknown class>>? = null)

An error returned by the JSON:API server.

JsonApiErrorResponse

data class JsonApiErrorResponse(val errors: List<JsonApiError>, val meta: Map<String, <Error class: unknown class>> = emptyMap(), val links: JsonApiLinks? = null, val jsonapi: JsonApiObject? = null)

An error returned by the JSON:API server.

JsonApiException

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

An exception thrown by the JSON:API server.

JsonApiLink

sealed interface JsonApiLink

A JSON:API link.

JsonApiLinkage

sealed interface JsonApiLinkage

JSON:API relationship linkage.

JsonApiLinks

data class JsonApiLinks(val self: JsonApiLink? = null, val related: JsonApiLink? = null, val first: JsonApiLink? = null, val last: JsonApiLink? = null, val prev: JsonApiLink? = null, val next: JsonApiLink? = null, val describedBy: JsonApiLink? = null)

A JSON:API links object.

JsonApiObject

data class JsonApiObject(val version: String? = null, val ext: List<String> = emptyList(), val profile: List<String> = emptyList(), val meta: Map<String, <Error class: unknown class>> = emptyMap())

Information about the server's JSON:API implementation.

JsonApiRelationship

data class JsonApiRelationship(val data: JsonApiLinkage = JsonApiLinkage.Missing, val links: JsonApiLinks? = null, val meta: Map<String, <Error class: unknown class>> = emptyMap())

A JSON:API relationship.

JsonApiRelationshipData

data class JsonApiRelationshipData(val id: String, val type: String)

A JSON:API relationship linkage object.

JsonApiRelationshipLinks

typealias JsonApiRelationshipLinks = JsonApiLinks

JsonApiResource

data class JsonApiResource(val id: String, val type: String, val attributes: Map<String, <Error class: unknown class>> = emptyMap(), val relationships: Map<String, JsonApiRelationship> = emptyMap(), val links: JsonApiLinks? = null, val meta: Map<String, <Error class: unknown class>> = emptyMap())

A JSON:API resource.

JsonApiResponse

sealed interface JsonApiResponse

Base fields for a JSON:API response.

JsonApiSingleResponse

data class JsonApiSingleResponse(val data: JsonApiResource? = null, val meta: Map<String, <Error class: unknown class>> = emptyMap(), val links: JsonApiLinks? = null, val included: List<JsonApiResource> = emptyList(), val jsonapi: JsonApiObject? = null) : JsonApiResponse

A single JSON:API response.

PaginationStrategy

enum PaginationStrategy : Enum<PaginationStrategy>

The strategy to use for pagination.

RecordProxy

data class RecordProxy<R>(val data: R, val meta: Map<String, <Error class: unknown class>>, val raw: JsonApiSingleResponse, val error: JsonApiException? = null)

A wrapper for a single resource.

Resource

interface Resource

A JSON:API resource.

ResourceRegistry

object ResourceRegistry

A JSON:API resource.

ResourceSerializer

abstract class ResourceSerializer<R : Resource>

Scope

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.

SortDirection

enum SortDirection : Enum<SortDirection>

The direction of the sorting.