import { Links, Meta } from './shared';
/**
 * A representation of a single resource.
 */
export interface ResourceObject {
    type: string;
    id: string;
    attributes?: Attributes;
    relationships?: Relationships;
    links?: Links;
    meta?: Meta;
}
/**
 * An array of Resource Objects.
 */
export declare type ResourceObjects = ResourceObject[];
/**
 * Either or a single Resource Object or an array of Resource Objects.
 */
export declare type ResourceObjectOrObjects = ResourceObject | ResourceObjects;
/**
 * A ResourceIdentifier identifies and individual resource.
 */
export declare type ResourceIdentifier<T extends ResourceObject = ResourceObject> = Pick<T, 'type' | 'id' | 'meta'>;
/**
 * A representation of a new Resource Object that
 * originates at the client and is yet to be created
 * on the server. The main difference between a regular
 * Resource Object is that this may not have an `id` yet.
 */
export interface NewResourceObject {
    type: string;
    id?: string;
    attributes?: Attributes;
    relationships?: Relationships;
    links?: Links;
}
/**
 * Attributes describing a Resource Object
 */
export interface Attributes {
    [index: string]: string | number | boolean | object | undefined | null;
}
/**
 * A Resource object's Relationships.
 */
export interface Relationships {
    [index: string]: Relationship;
}
/**
 * Describes a single Relationship type between a
 * Resource Object and one or more other Resource Objects.
 */
export interface Relationship<D extends ResourceObject | ResourceObject[] = ResourceObject | ResourceObject[]> {
    data?: D extends ResourceObject ? ResourceIdentifier<D> : D extends ResourceObject[] ? ResourceIdentifier<D[0]>[] : ResourceIdentifier | ResourceIdentifier[];
    links?: Links;
    meta?: Meta;
}