| Property | Value |
|---|---|
| Product | Publishing (pco.publishing, API version 2024-03-25) |
| Resource type | EpisodeResource |
| TypeScript | Publishing.EpisodeResource, attributes Publishing.EpisodeResourceAttributes, schema Publishing.EpisodeResourceSchema |
| Planning Center path | /publishing/v2/episodes/{episode_id}/episode_resources |
| Planning Center docs | EpisodeResource |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.publishing.episodes.id(episodeId).episode_resources |
Collection | Yes |
From a collection, .id(episodeResourceId) addresses one EpisodeResource: pco.publishing.episodes.id(episodeId).episode_resources.id(episodeResourceId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Publishing.EpisodeResourceAttributes. Every resource also has id and type ('EpisodeResource') next to its attributes.
| Name | Type | Description |
|---|---|---|
featured |
boolean | null |
|
icon |
string | null |
|
kind |
string | null |
Possible values: giving_fund, people_form, generic_url, services_public_page |
position |
number | null |
|
title |
string | null |
|
type |
string | null |
|
url |
string | null |
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: position.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on episode_resources on Episode |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as Publishing.EpisodeResourceSchema['create'].
| Attribute | Type |
|---|---|
_destroy |
unknown |
featured |
boolean | null |
icon |
string | null |
position |
number | null |
title |
string | null |
type |
string | null |
url |
string | null |
Update attributes
Typed as Publishing.EpisodeResourceSchema['update'].
| Attribute | Type |
|---|---|
_destroy |
unknown |
featured |
boolean | null |
icon |
string | null |
position |
number | null |
title |
string | null |
type |
string | null |
url |
string | null |
See Writing data.
Example
import type { Publishing } from '@mackenly/planningcenterkit';
const episodeId = '1'; // Episode id
const page = await pco.publishing.episodes.id(episodeId).episode_resources.order('position').perPage(25).list();
const items: Publishing.EpisodeResource[] = page.data;