jsonapi

type APIError struct {
	Status  int
	Code    string // errors[].code, the server's machine-readable reason, when present
	Pointer string // errors[].source.pointer, when present
	Detail  string
	// RetryAfter is the verbatim Retry-After header on a 429. The
	// per-surface request-rate plug sends one (whole seconds, at least
	// 1); a refusal raised inside an action does not, and names its wait
	// in RetryAfterMS instead.
	RetryAfter string
	// RetryAfterMS is `meta.retry_after_ms` on a 429: the wait in
	// milliseconds before the request may be repeated. Zero when the
	// refusal did not carry one (see NeverAdmitted for the null case).
	RetryAfterMS int64
	// NeverAdmitted is set when `meta.retry_after_ms` was null: the
	// request costs more than the limit allows on its own, and no wait
	// admits it. Do not retry.
	NeverAdmitted bool
	// Limit is `meta.limit` on a 429, the limit that refused the request,
	// when carried. Its window is server configuration and is not carried,
	// so it is shown as sent and never assumed to be "per minute".
	Limit int64
	// Sentinel is the class this error belongs to; Unwrap returns it. A
	// resource package may narrow it to one of its own domain sentinels
	// once it has read the structural discriminators, as teams does for
	// the plan-limit and entitlement rejections on create.
	Sentinel error
}

type Config struct {
	APIURL string // e.g. https://www.truestamp.com/api/json
	Team   string // optional tenant id; sent verbatim as the `tenant` header
}

type PageInfo struct {
	// NextCursor is the page[after] value lifted from links.next; empty on
	// the last page. An unparseable link also reads as empty, which is the
	// safe reading: a bad cursor would otherwise loop.
	NextCursor string
	// PrevCursor is the page[before] value lifted from links.prev; empty on
	// the first page.
	PrevCursor string
	// Total is meta.page.total, present only when the request asked for
	// page[count]=true; zero otherwise.
	Total int
	// Limit is meta.page.limit, the page size the server actually used.
	// Every collection clamps page[limit] to its max_page_size (250 by
	// default) rather than refusing it, so this can be smaller than what
	// was asked for; zero when the server did not report one.
	Limit int
}