Type Members

1.  class AliasEncoderCompanion[Out <: ResourceLike] extends AnyRef
2.  final case class BareLink(href: String) extends Link with Product with Serializable
3.  sealed trait Data extends AnyRef
4.  case class DeferredEncoding(identifier: ResourceIdentifier, includeSpec: Always, fieldsSpec: FieldsSpec) extends Product with Serializable

   Represents an object that needs to be encoded and included in the final document based on the inclusion rules.

5.  final case class Document(disposition: Disposition, jsonapi: Option[Jsonapi] = None, links: Option[Map[String, Link]] = None) extends HasMeta[Document] with Product with Serializable
6.  case class EncodeContext[F[_]](loader: Loader[F], include: List[String] = Nil, fields: Map[String, Set[String]] = Map.empty, included: Map[String, Map[String, List[ResourceObject]]] = Map.empty)(implicit evidence$1: Monad[F]) extends Product with Serializable
7.  trait EncodeError extends AnyRef
8.  type EncodeResult[+A] = Validated[NonEmptyChain[EncodeError], A]
9.  final case class Error(id: Option[String] = None, links: Option[Map[String, Link]] = None, status: Option[String] = None, code: Option[String] = None, title: Option[String] = None, detail: Option[String] = None, source: Option[ErrorSource] = None, meta: Option[Map[String, JAny]] = None) extends HasMeta[Error] with Product with Serializable
10.  final case class ErrorSource(pointer: Option[String] = None, parameter: Option[String] = None) extends Product with Serializable
11.  case class FallibleFieldsSpec(fields: Map[String, Set[String]], default: Boolean = true) extends FieldsSpec with Product with Serializable

    Used to track sparse fieldsets requested by the caller.

    Used to track sparse fieldsets requested by the caller. See https://jsonapi.org/format/#fetching-sparse-fieldsets

    Note that by specifying field names, you make it possible for encoding to fail due to an unrecognized field name. Contrast this with the InfallibleFieldsSpecs.

    default

    should a field be included if its resourceType is not specified in the map?

12.  sealed trait FieldsSpec extends AnyRef
13.  sealed trait HasMeta[A] extends AnyRef
14.  case class IncludePathTooDeep(path: String, limit: Int) extends EncodeError with Product with Serializable
15.  sealed trait IncludeSpec extends AnyRef

    Used to track the inclusion of related resources.

    Used to track the inclusion of related resources. This represents a node in the tree containing all the include paths.

    https://jsonapi.org/format/#fetching-includes

16.  case class IncludeTooLong(limit: Int) extends EncodeError with Product with Serializable
17.  case class Inclusions(objectMap: Map[String, Map[String, List[ResourceObject]]]) extends Product with Serializable
18.  sealed trait InfallibleFieldsSpec extends FieldsSpec

    Using this to encode can never cause an EncodeError.

19.  sealed trait InfallibleIncludeSpec extends IncludeSpec

    This can't cause a failure during encoding.

20.  case class InvalidFieldName(resourceType: String, field: String) extends EncodeError with Product with Serializable
21.  case class InvalidIncludePath(path: String) extends EncodeError with Product with Serializable
22.  final case class Jsonapi(version: Option[String] = None, meta: Option[Map[String, JAny]] = None) extends Product with Serializable
23.  sealed trait Link extends AnyRef
24.  type Loader[F[_]] = (ResourceIdentifier) => F[Option[ResourceObject]]
25.  sealed trait NullData extends PrimaryData with RelationshipData
26.  sealed trait PrimaryData extends Data
27.  final case class Relationship(data: Option[RelationshipData] = None, meta: Option[Map[String, JAny]] = None, links: Option[Map[String, Link]] = None) extends HasMeta[Relationship] with Product with Serializable
28.  sealed trait RelationshipData extends Data
29.  trait ResourceEncoder[In, +Out <: ResourceLike] extends Encoder[In, Out]
30.  final case class ResourceIdentifier(type: String, id: String, meta: Option[Map[String, JAny]] = None) extends ResourceIdentifierLike with HasMeta[ResourceIdentifier] with Product with Serializable
31.  case class ResourceIdentifierData(data: ResourceIdentifier) extends PrimaryData with RelationshipData with Product with Serializable
32.  type ResourceIdentifierEncoder[A] = ResourceEncoder[A, ResourceIdentifier]
33.  sealed trait ResourceIdentifierLike extends ResourceLike
34.  case class ResourceIdentifiersData(data: List[ResourceIdentifier]) extends PrimaryData with RelationshipData with Product with Serializable
35.  sealed trait ResourceLike extends AnyRef
36.  final case class ResourceObject(type: String, id: String, attributes: Option[Map[String, JAny]] = None, relationships: Option[Map[String, Relationship]] = None, meta: Option[Map[String, JAny]] = None, links: Option[Map[String, Link]] = None) extends ResourceObjectLike with ResourceIdentifierLike with HasMeta[ResourceObject] with Product with Serializable
37.  case class ResourceObjectData(data: ResourceObject) extends PrimaryData with Product with Serializable
38.  type ResourceObjectEncoder[A] = ResourceEncoder[A, ResourceObject]
39.  trait ResourceObjectLike extends ResourceLike
40.  final case class ResourceObjectOptionalId(type: String, id: Option[String] = None, attributes: Option[Map[String, JAny]] = None, relationships: Option[Map[String, Relationship]] = None, meta: Option[Map[String, JAny]] = None, links: Option[Map[String, Link]] = None) extends ResourceObjectLike with HasMeta[ResourceObjectOptionalId] with Product with Serializable
41.  case class ResourceObjectOptionalIdData(data: ResourceObjectOptionalId) extends PrimaryData with Product with Serializable
42.  type ResourceObjectOptionalIdEncoder[A] = ResourceEncoder[A, ResourceObjectOptionalId]
43.  case class ResourceObjectsData(data: List[ResourceObject]) extends PrimaryData with Product with Serializable
44.  final case class RichLink(href: Option[String] = None, meta: Option[Map[String, JAny]] = None) extends Link with HasMeta[RichLink] with Product with Serializable
45.  case class UnavailableIncludePath(path: String) extends EncodeError with Product with Serializable