planning-center-monorepo v1.0.0

planning-center-monorepo / planning-center-base-ts/src / ResourceObject

Interface: ResourceObject<TType, TAttrs, TRelMap>

Defined in: packages/planning-center-base-ts/src/types/json-api.ts:83 

A representation of a single resource.

Type Parameters

TType

TType extends string = string

TAttrs

TAttrs extends Attributes = Attributes

TRelMap

TRelMap = Record<string, Relationship>

Properties

type

type: TType

Defined in: packages/planning-center-base-ts/src/types/json-api.ts:88 

id

id: string

Defined in: packages/planning-center-base-ts/src/types/json-api.ts:89 

attributes?

optional attributes: TAttrs

Defined in: packages/planning-center-base-ts/src/types/json-api.ts:90 

relationships?

optional relationships: TRelMap

Defined in: packages/planning-center-base-ts/src/types/json-api.ts:91 

links?

optional links: Links

Defined in: packages/planning-center-base-ts/src/types/json-api.ts:92 

meta?

optional meta: Meta

Defined in: packages/planning-center-base-ts/src/types/json-api.ts:93