planning-center-monorepo v1.0.0

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

Interface: ResourceObject<TType, TAttrs, TRelMap>

Defined in: packages/planning-center-base-ts/dist/types/json-api.d.ts:57

A representation of a single resource.

Extended by

• EventResource
• CheckInResource
• LocationResource
• EventPeriodResource
• EventTimeResource
• StationResource
• LabelResource
• EventLabelResource
• LocationLabelResource
• OptionResource
• CheckInGroupResource
• CheckInTimeResource
• PersonEventResource
• PreCheckResource
• PassResource
• HeadcountResource
• AttendanceTypeResource
• RosterListPersonResource
• OrganizationResource
• IntegrationLinkResource
• ThemeResource
• LocationEventPeriodResource
• LocationEventTimeResource

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/dist/types/json-api.d.ts:58

id

id: string

Defined in: packages/planning-center-base-ts/dist/types/json-api.d.ts:59

attributes?

optional attributes: TAttrs

Defined in: packages/planning-center-base-ts/dist/types/json-api.d.ts:60

relationships?

optional relationships: TRelMap

Defined in: packages/planning-center-base-ts/dist/types/json-api.d.ts:61

links?

optional links: Links

Defined in: packages/planning-center-base-ts/dist/types/json-api.d.ts:62

meta?

optional meta: Meta

Defined in: packages/planning-center-base-ts/dist/types/json-api.d.ts:63