internal

Enumerations

AccessTypeEnum

• public - Public
• restricted - Restricted
• personal - Personal

Enumeration Members

Enumeration Member	Value
PERSONAL	"personal"
PUBLIC	"public"
RESTRICTED	"restricted"

---

CanvasExcludedComponentTypesEnum

Enumeration Members

Enumeration Member	Value
File	"File"
GridItem	"GridItem"
Root	"Root"
Slide	"Slide"

---

CanvasThemeStatus

Enumeration Members

Enumeration Member	Value
DRAFT	"draft"
READY	"ready"

---

CollaborationRoleEnum

Enumeration Members

Enumeration Member	Value
EDITOR	"editor"
VIEWER	"viewer"

---

ComponentTypes

Enumeration Members

Enumeration Member	Value	Description
Block	"Block"	-
Carousel	"Carousel"	-
Collection	"Collection"	PIT-8015. The React player. CollectionPlayer below is the legacy Vue one and still renders.
CollectionPlayer	"CollectionPlayer"	-
ContentGrid	"ContentGrid"	-
ContentList	"ContentList"	-
CustomDataTable	"CustomDataTable"	-
DataCharts	"DataCharts"	-
DynamicContent	"DynamicContent"	-
DynamicDataTable	"DynamicDataTable"	-
Embeddable	"Embeddable"	-
Grid	"Grid"	-
GridItem	"GridItem"	-
Html	"Html"	-
IFrame	"IFrame"	-
Link	"Link"	-
Multimedia	"Multimedia"	-
Page	"Page"	-
PageBreak	"PageBreak"	-
Root	"Root"	-
Scribble	"Scribble"	-
SectionList	"SectionList"	-
Text	"Text"	-
Timeline	"Timeline"	-

---

ContentGridLayoutTypes

Enumeration Members

Enumeration Member	Value
CAROUSEL	"carousel"
GRID	"grid"
LIST	"list"

---

ContentType

Enumeration Members

Enumeration Member	Value
Application	"application"
Block	"block"
Collection	"collection"

---

CoreFolderEntityType

Enumeration Members

Enumeration Member	Value
Block	"canvas_block"
Canvas	"canvas"
File	"file"
Section	"canvas_section"
Template	"canvas_template"

---

DownloadTypeEnum

• automatic - Automatic
• mandatory - Mandatory
• ondemand - On Demand

Enumeration Members

Enumeration Member	Value
AUTOMATIC	"automatic"
MANDATORY	"mandatory"
ONDEMAND	"ondemand"

---

FileContentTypeEnum

• ar - AR
• attch - Attachment
• font - Font
• image - Image
• pdf - PDF
• video - Video
• web - Web

Enumeration Members

Enumeration Member	Value
AR	"ar"
ATTACHMENT	"attch"
AUDIO	"audio"
FONT	"font"
IMAGE	"image"
PDF	"pdf"
VIDEO	"video"
WEB	"web"

---

FileStatusEnum

• pending - Pending
• viewable - Viewable
• failed - Failed

Enumeration Members

Enumeration Member	Value
FAILED	"failed"
PENDING	"pending"
VIEWABLE	"viewable"

---

FileTypeEnum

• app - App
• asset - Asset
• content - Content

Enumeration Members

Enumeration Member	Value
APP	"app"
ASSET	"asset"
CONTENT	"content"

---

GridLayoutTypes

Enumeration Members

Enumeration Member	Value
FOUR_EQUAL	"four-equal"
ONE	"one"
THREE_EQUAL	"three-equal"
TWO_EQUAL	"two-equal"
TWO_LEFT	"two-left"
TWO_RIGHT	"two-right"

---

InstanceMembershipRoleEnum

• admin - Admin
• editor - Editor
• member - Member

Enumeration Members

Enumeration Member	Value
ADMIN	"admin"
EDITOR	"editor"
MEMBER	"member"

---

LinkAlignmentTypes

Enumeration Members

Enumeration Member	Value
CENTER	"center"
LEFT	"left"
RIGHT	"right"

---

LinkAnchorTypes

Enumeration Members

Enumeration Member	Value
CANVAS_ANCHOR	"canvas-anchor"
FILE	"file"
FOLDER	"folder"
WEB	"web"

---

LinkPreviewTypes

Enumeration Members

Enumeration Member	Value
OUTLINE_BUTTON	"outline-button"
SOLID_BUTTON	"solid-button"
TEXT_LINK	"text-link"

---

MetadataTemplateFieldAppliesToEnum

• all - All
• files - Files
• canvases - Canvases

Enumeration Members

Enumeration Member	Value
ALL	"all"
CANVASES	"canvases"
FILES	"files"

---

MetadataTemplateFieldTypeEnum

• text - Text
• number - Number
• date - Date
• select - Dropdown - Single Select
• multi-select - Dropdown - Multiple Select
• checkbox - Checkbox
• html - HTML

Enumeration Members

Enumeration Member	Value
CHECKBOX	"checkbox"
DATE	"date"
HTML	"html"
MULTI_SELECT	"multi-select"
NUMBER	"number"
SELECT	"select"
TEXT	"text"

---

MultimediaHorizontalAlignmentOptions

Enumeration Members

Enumeration Member	Value
CENTER	"center"
LEFT	"left"
RIGHT	"right"

---

OperatorEnum

• exact - exact
• iexact - iexact
• contains - contains
• icontains - icontains
• in - in
• gt - gt
• gte - gte
• lt - lt
• lte - lte
• startswith - startswith
• istartswith - istartswith
• endswith - endswith
• iendswith - iendswith
• range - range
• date - date
• year - year
• iso_year - iso_year
• month - month
• day - day
• week - week
• week_day - week_day
• iso_week_day - iso_week_day
• quarter - quarter
• time - time
• hour - hour
• minute - minute
• second - second
• isnull - isnull
• regex - regex
• iregex - iregex

Enumeration Members

Enumeration Member	Value
CONTAINS	"contains"
DATE	"date"
DAY	"day"
ENDSWITH	"endswith"
EXACT	"exact"
GT	"gt"
GTE	"gte"
HOUR	"hour"
ICONTAINS	"icontains"
IENDSWITH	"iendswith"
IEXACT	"iexact"
IN	"in"
IREGEX	"iregex"
ISNULL	"isnull"
ISO_WEEK_DAY	"iso_week_day"
ISO_YEAR	"iso_year"
ISTARTSWITH	"istartswith"
LT	"lt"
LTE	"lte"
MINUTE	"minute"
MONTH	"month"
QUARTER	"quarter"
RANGE	"range"
REGEX	"regex"
SECOND	"second"
STARTSWITH	"startswith"
TIME	"time"
WEEK	"week"
WEEK_DAY	"week_day"
YEAR	"year"

---

StorageRegionEnum

• au - Australia
• eu - EU
• us - US

Enumeration Members

Enumeration Member	Value
AU	"au"
EU	"eu"
US	"us"

---

UserRoleEnum

• admin - Admin
• member - Member
• developer - Developer

Enumeration Members

Enumeration Member	Value
ADMIN	"admin"
DEVELOPER	"developer"
MEMBER	"member"

Classes

EventEmitter

Extended by

• LowLevelApi

Type Parameters

Type Parameter
KeyMap extends EventMap

Implements

• Emitter<KeyMap>

Constructors

Constructor

new EventEmitter<KeyMap>(): EventEmitter<KeyMap>

Returns

EventEmitter<KeyMap>

Properties

Property	Type	Default value
listeners	object	{}

Methods

emit()

emit<Key>(eventName, data?): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
data?	KeyMap[Key]

Returns

void

Implementation of

Emitter.emit

off()

off<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<KeyMap[Key]>

Returns

void

Implementation of

Emitter.off

on()

on<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<KeyMap[Key]>

Returns

void

Implementation of

Emitter.on

---

LowLevelApi

Extends

• EventEmitter<ApiEventMap>

Implements

• PitcherAPI

Constructors

Constructor

new LowLevelApi(options?): LowLevelApi

Parameters

Parameter	Type
options?	ApiOptions

Returns

LowLevelApi

Overrides

EventEmitter.constructor

Properties

Property	Type	Default value	Inherited from
callbacks	object	undefined	-
listeners	object	{}	EventEmitter.listeners

Methods

emit()

emit<Key>(eventName, data?): void

Type Parameters

Type Parameter
Key extends "event"

Parameters

Parameter	Type
eventName	Key
data?	ApiEventMap[Key]

Returns

void

Implementation of

PitcherAPI.emit

Inherited from

EventEmitter.emit

off()

off<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends "event"

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<ApiEventMap[Key]>

Returns

void

Implementation of

PitcherAPI.off

Inherited from

EventEmitter.off

on()

on<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends "event"

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<ApiEventMap[Key]>

Returns

void

Implementation of

PitcherAPI.on

Inherited from

EventEmitter.on

request()

request(type, body?): Promise<any>

Parameters

Parameter	Type	Default value
type	string	undefined
body	object | null	null

Returns

Promise<any>

Implementation of

PitcherAPI.request

Interfaces

CanvasIndicator

Properties

Property	Type
background_color?	string
color?	string
icon	string
key	string
text	string
tooltip_text?	string
type?	"default" | "error" | "info" | "warning" | "success" | "primary"

---

CanvasThemeAsset

Properties

Property	Type
id	string
name	string
url	string

---

CanvasThemeRetrieve

Properties

Property	Type
assets?	CanvasThemeAsset[]
created_at	string
created_by	User
id	string
instance_id	string
is_default	boolean
logo?	CanvasThemeAsset
modified_at	string
modified_by?	User
name	string
owned_by	User
settings	CanvasThemeSettings
status	CanvasThemeStatus
typography	Record<string, CanvasTypographyPreset>
used_in_canvases_count?	number

---

CanvasThemeSettings

Properties

Property	Type
assets?	CanvasThemeAsset[]
background_color	string
component_spacing	number
palette	string[]

---

CarouselProps

Properties

Property	Type
images?	object[]
include_all_images_in_pdf?	boolean
placeholder_height?	string

---

CollectionGroupRef

A group built in the content picker. Persisted so the picker gets it back on the next edit.

Properties

Property	Type
id	string
name	string

---

CollectionPageRef

One stop in a Collection (PIT-8015), as persisted in the canvas JSON.

snake_case because this IS canvas JSON — the same convention every other node's data follows (layout_type, hide_footer, data_accessor). The Sharebox's in-memory ShareboxItem (fileId / pageIndex / thumbnailUrl) is a different, camelCase, client-only shape; the writer converts between them.

Only REFERENCES are stored, never file payloads. Expanding a reference into rendered pages needs the file's content_length / content_thumbnails, which the host fetches per file — on iOS via the get_file bridge. Deriving a page count from this JSON instead would silently truncate long decks, because iOS caps content_thumbnails at four entries.

Properties

Property	Type	Description
file_id	string	-
group_id?	string	The CollectionGroupRef the page belongs to. A group's pages are contiguous in pages.
page_index?	number	Omitted = the whole file, expanded at render time into one stop per page.
thumbnail_url?	string	Snapshot from when the page was picked; shown before the resolved file arrives.

---

CollectionProps

Properties

Property	Type	Description
collection_id?	string	Reserved for the live-collection reference (PIT-5124). Resolution is a later step — the field is written by nothing yet and read by nothing yet, and exists so a collection saved today can be reconnected without a data migration.
groups?	CollectionGroupRef[]	The picker's groups, in order, including empty ones. Absent on nodes saved before groups were kept (PIT-8015 QA): those reopen in the picker as one group, as they always did.
hide_footer?	boolean	Mirrors the legacy player's setting: hides the source-file line under the stage.
name	string	-
pages	CollectionPageRef[]	-

---

ComponentNode

Type Parameters

Type Parameter	Default type
T	AvailableComponentProps

Properties

Property	Type
allow_admins_to_overwrite?	boolean
autofill?	"off" | "ai" | "matching_metadata" | "matching_tags" | "matching_metadata_or_tags"
autofill_content_types?	FileContentTypeEnum[] | null
children?	ComponentNode<AvailableComponentProps>[]
data?	T
height?	string
id	string
is_sharebox_target?	boolean
linkable?	ComponentNodeLinkable
print?	ComponentNodePrint
style?	Record<string, any>
tags?	string[]
template_permissions?	object
template_permissions.is_editable	boolean
template_permissions.is_removable	boolean
theme_meta?	ComponentNodeThemeMeta
tracking_id	string
type	ComponentTypes
visible?	ComponentNodeVisible
when_used_in_section?	object
when_used_in_section.is_editable	boolean
when_used_in_section.is_removable	boolean

---

ComponentNodeDynamicDataTableThemeMeta

Extends

• ComponentNodeGenericThemeMeta

Properties

Property	Type	Inherited from
bg_color_palette_index?	number	ComponentNodeGenericThemeMeta.bg_color_palette_index
dt_group_header_bg_palette_index?	number	-
dt_header_bg_palette_index?	number	-

---

ComponentNodeGenericThemeMeta

Extended by

• ComponentNodeDynamicDataTableThemeMeta
• ComponentNodeMultimediaThemeMeta

Properties

Property	Type
bg_color_palette_index?	number

---

ComponentNodeLinkable

Properties

Property	Type
linkable_in_templates	boolean

---

ComponentNodeMultimediaThemeMeta

Extends

• ComponentNodeGenericThemeMeta

Properties

Property	Type	Inherited from
bg_color_palette_index?	number	ComponentNodeGenericThemeMeta.bg_color_palette_index
is_theme_logo?	boolean	-
theme_asset_index?	number	-

---

ComponentNodePrint

Properties

Property	Type
scale_to_fit_page?	boolean

---

ComponentNodeVisible

Properties

Property	Type
edit_mode	boolean
pdf	boolean
presentation_mode	boolean
web	boolean

---

ContentGridProps

Properties

Property	Type	Description
card_shape?	ContentGridCardShape	Carousel layout only. Absent means landscape. Read from the section's own node, never from a canvas override.
data_accessor?	string	-
items	(ContentGridItemSlideProps | ContentGridItemFileProps)[]	-
layout_type?	ContentGridLayoutTypes	-
size?	"medium"	-

---

ContentListProps

Properties

Property	Type
animation_in?	string
is_restricted_to_preselections?	boolean
sections	ContentListSection[]
selection_app_name?	string
selection_strategy?	"app" | "free" | "single" | "at-least-one"

---

ContentListSection

Properties

Property	Type
component_id	string
file_id?	string
id	string
page_index?	number
sequence?	number
type	"file" | "section"

---

CoreFolderRetrieve

Properties

Property	Type
access_type	"private" | "public"
breadcrumbs	object[]
created_at	string
created_by	MiniUser
files_count	number
folders_count	number
id	string
instance_id	string
metadata	Record<string, any>
modified_at	string
modified_by	MiniUser | null
name	string
owned_by	MiniUser
parent_id	string | null
path	string

---

CustomDataTableHierarchyLevel

Properties

Property	Type
group_by_key?	string
path	string
type	"group" | "data"

---

CustomDataTableProps

Properties

Property	Type
columns	DynamicDatatableProperty[]
enable_row_striping?	boolean
filters?	DynamicDatatableFilter[]
footer_path?	string
header_path?	string
hierarchy	CustomDataTableHierarchyLevel[]
striping_color?	string | null
striping_start_from_first?	boolean
theme?	object
theme.background_color?	string | null
theme.font_family?	string
theme.group_header_color?	string | null

---

DeviceFile

Properties

Property	Type
name	string
path	string
size	number
type	string

---

DeviceFileCreateRequest

Extends

• Omit<FileCreateRequest, "content">

Properties

Property	Type	Description	Inherited from
access_type?	AccessTypeEnum	-	Omit.access_type
app_metadata?	Record<string, any>	-	Omit.app_metadata
available_at?	string | null	-	Omit.available_at
content_upload_id?	string	-	Omit.content_upload_id
download_type?	DownloadTypeEnum	-	Omit.download_type
expires_at?	string | null	-	Omit.expires_at
folder_id?	string	-	Omit.folder_id
instance_id	string	-	Omit.instance_id
is_asset?	boolean	Deprecated: Please use the 'type' field instead. This field is maintained for backward compatibility and may be removed in future releases.	Omit.is_asset
metadata?	Record<string, any>	-	Omit.metadata
name?	string	-	Omit.name
owned_by_id?	number | null	-	Omit.owned_by_id
path	string	-	-
permissions?	FilePermissionRequest	-	Omit.permissions
tags?	string[]	-	Omit.tags
thumbnail?	Blob	-	Omit.thumbnail
thumbnail_upload_id?	string	-	Omit.thumbnail_upload_id
type?	FileTypeEnum	-	Omit.type
url?	string	-	Omit.url

---

DynamicContentProps

Properties

Property	Type
category	"content" | "section"
grid_alignment?	"left" | "center" | "right"
heading_alignment?	"left" | "center" | "right"
heading_bold?	boolean
heading_color?	string
heading_font_family?	string
heading_font_size?	number
heading_italic?	boolean
heading_text?	string
heading_underline?	boolean
layout_type?	ContentGridLayoutTypes
limit	number
metric	"recently_added" | "last_modified" | "top_viewed" | "top_trending" | "most_popular" | "most_liked"
show_border?	boolean
show_heading?	boolean

---

DynamicDatatableFilter

Properties

Property	Type
operator	"true" | "false" | "contains" | "not_contains" | "eq" | "neq" | "gt" | "gte" | "lt" | "lte"
property	string
value	string

---

DynamicDatatableProperty

Properties

Property	Type
display_name?	string
format?	object
format.currency?	string
format.dateFormat?	string
format.decimals?	number
format.thousandsSeparator?	boolean
format.type?	"number" | "date" | "currency" | "percentage"
group?	boolean
key	string
printable?	boolean
sort	object
sort.default?	boolean
sort.direction?	"asc" | "desc"
sort.enabled	boolean

---

DynamicDataTableProps

Properties

Property	Type
break_groups_on_new_page?	boolean
enable_row_striping?	boolean
filters?	DynamicDatatableFilter[]
layout	"column" | "row"
page_size?	number
path	string
properties	DynamicDatatableProperty[]
striping_color?	string | null
striping_start_from_first?	boolean
theme?	object
theme.background_color?	string | null
theme.font_family?	string
theme.group_header_color?	string | null

---

EmbeddableProps

Properties

Property	Type
app_name	string
embed_locations?	EmbedLocation[]
file	ContentGridFileProps | null
full_screen_mode?	boolean
headless_locations?	EmbedLocation[]
height?	string
properties_by_embed_location?	Partial<Record<EmbedLocation, EmbeddedLocationProperties>>
settings?	Record<string, unknown>
src	string | null
type	"app"
width?	string

---

Emitter

Extended by

• PitcherAPI
• PitcherInterface

Type Parameters

Type Parameter
KeyMap extends EventMap

Methods

emit()

emit<Key>(eventName, params): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
params	KeyMap[Key]

Returns

void

off()

off<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<KeyMap[Key]>

Returns

void

on()

on<Key>(eventName, fn): void

Type Parameters

Type Parameter
Key extends string

Parameters

Parameter	Type
eventName	Key
fn	EventReceiver<KeyMap[Key]>

Returns

void

---

FileModel

Extends

• FileRetrieve

Properties

Property	Modifier	Type	Description	Inherited from
access_type?	public	AccessTypeEnum	-	FileRetrieve.access_type
app_metadata?	public	Record<string, any>	-	FileRetrieve.app_metadata
available_at?	public	string | null	-	FileRetrieve.available_at
content_extension	readonly	string | null	-	FileRetrieve.content_extension
content_length	readonly	number | null	-	FileRetrieve.content_length
content_thumbnails	readonly	string[]	-	FileRetrieve.content_thumbnails
content_type	readonly	FileContentTypeEnum	-	FileRetrieve.content_type
content_url	readonly	string | null	-	FileRetrieve.content_url
created_at	readonly	string	-	FileRetrieve.created_at
created_by	readonly	MiniUser	-	FileRetrieve.created_by
download_type?	public	DownloadTypeEnum	-	FileRetrieve.download_type
downloaded_at?	readonly	string | null	iOS bridge only — not returned by the REST API.	FileRetrieve.downloaded_at
expires_at?	public	string | null	-	FileRetrieve.expires_at
folder	readonly	MiniFolder	-	FileRetrieve.folder
folder_id?	public	string	-	FileRetrieve.folder_id
global_id	readonly	string	-	FileRetrieve.global_id
id	readonly	string	-	FileRetrieve.id
instance_id	readonly	string	-	FileRetrieve.instance_id
isDeleted	public	boolean	-	-
metadata?	public	Record<string, any>	-	FileRetrieve.metadata
modified_at	readonly	string	-	FileRetrieve.modified_at
modified_by	readonly	MiniUser	-	FileRetrieve.modified_by
name?	public	string	-	FileRetrieve.name
original_extension	readonly	string | null	-	FileRetrieve.original_extension
original_url	readonly	string | null	-	FileRetrieve.original_url
owned_by	readonly	MiniUser	-	FileRetrieve.owned_by
permissions?	public	FilePermission	-	FileRetrieve.permissions
pspdfkit_auth_payload	readonly	Record<string, any> | null	-	FileRetrieve.pspdfkit_auth_payload
pspdfkit_document_id	readonly	string | null	-	FileRetrieve.pspdfkit_document_id
pspdfkit_server_url	readonly	string | null	-	FileRetrieve.pspdfkit_server_url
published_at	readonly	string | null	-	FileRetrieve.published_at
role	readonly	CollaborationRoleEnum	Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.	FileRetrieve.role
shared_annotation_layer?	readonly	boolean	Shared-link (DSR) reads only — PIT-8968. true when Django minted pspdfkit_auth_payload for the link's read-only share_<link_id> Document Engine layer (the sharer's annotations, frozen at link creation). Absent or false everywhere else, including every non-DSR read.	FileRetrieve.shared_annotation_layer
shared_link	readonly	MiniSharedLink	-	FileRetrieve.shared_link
size	readonly	number | null	-	FileRetrieve.size
status	readonly	FileStatusEnum	-	FileRetrieve.status
tags?	public	string[]	-	FileRetrieve.tags
thumbnail_url	readonly	string | null	-	FileRetrieve.thumbnail_url
type	readonly	FileTypeEnum	-	FileRetrieve.type
version	readonly	FileVersion | null	Null when the file has no current-version row: File.version_object is a nullable FK (ng-rest-api/pitcher/models/filemodels.py) exposed through a nested read-only serializer, so DRF emits null rather than omitting it.	FileRetrieve.version
zip_size	readonly	number | null	-	FileRetrieve.zip_size
zip_url	readonly	string | null	-	FileRetrieve.zip_url

---

GetCanvasesParams

Properties

Property	Type	Description
access_type?	string	-
account__id?	string	-
id__in?	string	-
instance_id?	string	-
is_default?	boolean	-
is_draft?	boolean	-
is_editable?	boolean	-
is_master?	boolean	-
is_section?	boolean	-
is_template?	boolean	-
ordering?	string	-
page?	number	-
page_size?	number	-
scope?	"member"	'member' resolves visibility as a plain member even for admins/editors — only canvases distributed to the caller's groups, public ones, or their own are returned (PIT-8022). Honored by the next-core distributed endpoint; ignored (harmless) by the Django list endpoint and the iOS bridge.
search?	string	-
section_ids?	string[]	-
skip_count?	boolean	Skips the COUNT(DISTINCT c.id) pagination query. The response then reports count: 0, so only pass it when the caller does not paginate. Honored by the next-core distributed endpoint; ignored (harmless) elsewhere.
tags__in?	string[]	-
tags__not_in?	string	-
template__id?	string	-

---

GetUsersParams

Parameters for getting users

Properties

Property	Type	Description
filters?	Ref<any, any>	Filters for the user query, can be any type of Vue ref
search?	string | Ref<string, string>	Search term, can be a string or a Vue ref to a string

---

GridItemProps

Properties

Property	Type
span	number
tooltips?	GridItemTooltipProps[]

---

GridItemTooltipProps

Properties

Property	Type
content?	string
content_style?	Record<string, any>
trigger?	string
trigger_style?	Record<string, any>

---

GridProps

Properties

Property	Type
columns	number
layout_type	GridLayoutTypes

---

HtmlProps

Properties

Property	Type
html	string

---

IFrameProps

Properties

Property	Type
add_session_context?	boolean
full_screen_mode?	boolean
height?	string
src	string | null
width?	string

---

LdMultimediaAssetType

Where a Multimedia poster_url came from — shared by every asset variant, because a poster's origin is independent of the media's (an external video can carry an L&D-hosted poster).

poster_url alone is unrefreshable: a short-lived source (an L&D presigned URL, 900s) rots and the canvas has no record of what it was, so nothing can re-resolve it — unlike file.content_url, which Multimedia.vue refreshes at render off file.id. Recording the id plus its backend is what keeps a poster recoverable.

Both are absent for an external-link/Pexels poster (long-lived URL, no Pitcher id to resolve).

poster_asset_type lives on the NODE rather than being read from host state at render, because the render path must work in COURSE (rep playback) — the mode where a poster is guaranteed to be past its TTL — and COURSE cannot supply CanvasBuilderProps.assetType at all (it's ?: never there). (T1.7b / PIT-7742, R4-F1.)

Extends

• MultimediaPosterProvenance

Properties

Property	Type	Inherited from
asset_type	"ld_asset"	-
file	object	-
file.content_url?	string | null	-
file.id	string	-
file.name	string | undefined	-
horizontal_alignment?	MultimediaHorizontalAlignmentOptions	-
poster_asset_type?	"pitcher_asset" | "ld_asset"	MultimediaPosterProvenance.poster_asset_type
poster_background_size?	BackgroundSize	-
poster_file_id?	string	MultimediaPosterProvenance.poster_file_id
poster_url?	string	-
type	"image" | "video"	-

---

LinkProps

Properties

Property	Type
alignment?	LinkAlignmentTypes
background_color?	string
canvas_anchor?	string
color?	string
display_text?	string
file?	Partial<File> & object | null
folder?	{ id: string; name: string; } | null
font_family?	string
font_size?	number
link_type?	LinkAnchorTypes
page_index?	number
preview_type?	LinkPreviewTypes
target?	"_self" | "_blank"
url?	string

---

OrganizationMetadata

Properties

Property	Type
custom_domain?	string
disable_web_catalogiq?	boolean | "true" | "false"
owner?	string

---

PageBreakProps

---

PageProps

Properties

Property	Type
aspect_ratio?	"unlocked" | "contain" | "16:9" | "16:10" | "4:3" | "1:1"
background_video_url?	string

---

PitcherInstance

Extends

• Omit<Instance, "settings">

Properties

Property	Modifier	Type	Inherited from
color?	public	string | null	Omit.color
created_at	readonly	string	Omit.created_at
created_by	readonly	MiniUser	Omit.created_by
environment	readonly	MiniEnvironment	Omit.environment
id	readonly	string	Omit.id
last_login	readonly	string	Omit.last_login
logo?	public	string | null	Omit.logo
modified_at	readonly	string	Omit.modified_at
modified_by	readonly	MiniUser	Omit.modified_by
name	public	string	Omit.name
owned_by	readonly	MiniUser	Omit.owned_by
region	readonly	MiniRegion	Omit.region
role	readonly	InstanceMembershipRoleEnum	Omit.role
settings?	readonly	InstanceSettings	-
storage_region	readonly	StorageRegionEnum	Omit.storage_region

---

PitcherOrg

Extends

• Omit<Organization, "metadata" | "settings">

Properties

Property	Modifier	Type	Inherited from
branding	readonly	OrganizationBranding	Omit.branding
display_name	readonly	string	Omit.display_name
id	readonly	string	Omit.id
metadata	readonly	OrganizationMetadata	-
name	readonly	string	Omit.name
settings	readonly	OrganizationSettings	-

---

RefreshServiceTokenRequest

Request parameters for refreshing a service token

Properties

Property	Type	Description
provider?	string	Optional provider for the service token

---

RefreshServiceTokenResponse

Response from refreshing a service token

Properties

Property	Type	Description
access_token	string	The new access token

---

SectionListProps

Properties

Property	Type
animation_in?	string
is_restricted_to_preselections?	boolean
sections	SectionListSection[]
selection_app_name?	string
selection_strategy?	"app" | "free" | "single" | "at-least-one"

---

SectionListSection

Properties

Property	Type
aspect_ratio?	"unlocked" | "contain" | "16:9" | "16:10" | "4:3" | "1:1"
background_video_url?	string
id	string
style?	Record<string, any>

---

TextProps

Properties

Property	Type
content?	string

---

TimelineEvent

Properties

Property	Type
card_style?	Record<string, any>
description?	string
description_style?	Record<string, any>
icon?	string
icon_style?	Record<string, any>
image_style?	Record<string, any>
image_url?	string
title?	string
title_style?	Record<string, any>
top_hint?	string
top_hint_style?	Record<string, any>

---

TimelineProps

Properties

Property	Type
events	TimelineEvent[]
layout	"vertical" | "horizontal"

---

UpdateLocation

Base interface for update location actions.

Extended by

• UpdateLocationOnRegister
• UpdateLocationOnUnregister
• UpdateLocationOnUpdate
• UpdateLocationOnMounted
• UpdateLocationOnRestore
• UpdateLocationOnRestoreCompleted
• UpdateLocationOnGetRoutesRequest
• UpdateLocationOnGetRoutesResponse

Properties

Property	Type	Description
action	string	The action to be performed.

Type Aliases

Account

Account = object

Properties

id?

optional id?: string

name?

optional name?: string

---

AccountRequest

AccountRequest = object

Properties

id?

optional id?: string

name?

optional name?: string

---

Agenda

Agenda = object

Properties

filters?

optional filters?: Record<string, any>

groups

groups: AgendaGroup[]

name

name: string

---

AgendaGroup

AgendaGroup = object

Properties

id

id: string

items

items: AgendaItem[]

name

name: string

---

AgendaItem

AgendaItem = object

Properties

content

content: CollectionPlayer

id

id: string

type

type: ValuesOf<ContentType>

---

AgendaSelectorProps

AgendaSelectorProps = object

Properties

attachTo?

optional attachTo?: string | HTMLElement

initialAgenda?

optional initialAgenda?: Agenda

openSettings?

optional openSettings?: CollectionSelectorProps["openSettings"]

selectCollectionContent

selectCollectionContent: SelectCollectionContent

zIndex?

optional zIndex?: number

---

AllFileCreateRequest

AllFileCreateRequest = FileCreateRequest | DeviceFileCreateRequest

---

AssetSelection

AssetSelection = object

Properties

fileId

fileId: FileRetrieve["id"]

type

type: "asset"

---

AutohideSectionOnCreated

AutohideSectionOnCreated = object

Properties

autohide_in_shared_link?

optional autohide_in_shared_link?: string

start_date?

optional start_date?: Date

---

AvailableComponentProps

AvailableComponentProps = GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | ContentListProps | HtmlProps | IFrameProps | LinkProps | PageBreakProps | PageProps | TimelineProps | CollectionPlayer | CollectionProps | DynamicContentProps | DynamicDataTableProps | CustomDataTableProps

---

BackgroundSize

BackgroundSize = "auto" | "contain" | "cover" | "100% 100%"

---

Canvas

Canvas = object

Properties

access_type?

optional access_type?: AccessTypeEnum

account?

optional account?: Account | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

expires_at?

optional expires_at?: string | null

folder_id?

optional folder_id?: string | null

id

readonly id: string

indicators?

optional indicators?: Record<string, any> | null

is_block?

optional is_block?: boolean

is_default?

optional is_default?: boolean

is_directly_shared_with_me?

readonly optional is_directly_shared_with_me?: boolean

PIT-8801 — does the REQUESTING user hold a live DIRECT (user_id) collaboration on THIS canvas? Role-blind, deleted_at IS NULL, and with no content-distribution-group term.

The server's answer to "may this viewer edit a master somebody shared with them", so the client cannot offer an edit the API refuses: the write arm asks Canvas.has_direct_collaboration, because a canvas<->CDG Collaboration row is creatable through the public API and would otherwise hand an unbounded group edit rights on somebody else's master. isSharedWithMe on the client is only "the owner is not me" and cannot tell the two apart.

FALSE for the owner — they hold no collaboration on their own canvas — so consumers OR it with their own ownership/admin gate rather than special-casing it.

Read-only, and ABSENT unless requested in ?fields=; an absent value must fail CLOSED (no edit offered).

Three states, not two. Django emits a real boolean whenever the field is serialized, including false for the owner and true on a directly-shared ORDINARY canvas. next-core's PATCH response is narrower on purpose: it echoes only the answer its permission check actually resolved, and OMITS the key otherwise rather than asserting a false it never probed — so an owner's save, and any non-master save, carry no value at all. That is why the type is optional and why undefined must be read as NOT RESOLVED rather than as false: it is safe because every consumer ORs this with its own ownership/admin gate, and because the two client paths that could be hurt by a missing value either merge the response over the existing canvas (the builder) or re-request the full field list (the masters-tab inline rename, which replaces the row outright).

Hand-added (additive) — preserve on type regen.

is_draft?

optional is_draft?: boolean

is_editable?

optional is_editable?: boolean

is_master?

optional is_master?: boolean

is_section?

optional is_section?: boolean

is_template?

optional is_template?: boolean

metadata?

optional metadata?: any

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

shared_link

readonly shared_link: MiniSharedLink

start_at?

optional start_at?: string | null

tags?

optional tags?: string[]

template

readonly template: MiniCanvasWithTags

thumbnail_url?

optional thumbnail_url?: string | null

---

CanvasComponentAvailability

CanvasComponentAvailability = { [component in CanvasComponentTypes]: boolean }

---

CanvasComponentAvailabilityRoles

CanvasComponentAvailabilityRoles = { [component in CanvasComponentTypes]: { admin?: boolean; rep?: boolean } }

---

CanvasComponentTypes

CanvasComponentTypes = Exclude<keyof typeof ComponentTypes, CanvasExcludedComponentTypes>

---

CanvasCreateRequest

CanvasCreateRequest = object

Properties

access_type?

optional access_type?: AccessTypeEnum

account?

optional account?: AccountRequest | null

content?

optional content?: Record<string, any>

context?

optional context?: any

expires_at?

optional expires_at?: string | null

folder_id?

optional folder_id?: string | null

id?

optional id?: string

indicators?

optional indicators?: Record<string, any> | null

instance_id

instance_id: string

is_block?

optional is_block?: boolean

is_default?

optional is_default?: boolean

is_draft?

optional is_draft?: boolean

is_editable?

optional is_editable?: boolean

is_master?

optional is_master?: boolean

is_section?

optional is_section?: boolean

is_template?

optional is_template?: boolean

metadata?

optional metadata?: any

name

name: string

owned_by_id?

optional owned_by_id?: number | null

start_at?

optional start_at?: string | null

tags?

optional tags?: string[]

template_id?

optional template_id?: string | null

theme?

optional theme?: Record<string, any> | null

thumbnail_url?

optional thumbnail_url?: string | null

---

CanvasExcludedComponentTypes

CanvasExcludedComponentTypes = keyof typeof CanvasExcludedComponentTypesEnum

---

CanvasManagerTableColumns

CanvasManagerTableColumns = object

Properties

canvas_templates

canvas_templates: CanvasManagerVisibility

canvases

canvases: CanvasManagerVisibility

master_canvases?

optional master_canvases?: CanvasManagerVisibility

PIT-7488 — the master pitchdeck tab. Optional because the LD flag predates it and no environment configures it yet; getVisibleColumns degrades to "show every column" when the key is absent, so masters must NOT inherit the canvases config (hiding a column on the Pitchdecks tab would otherwise silently hide it here too).

section_templates

section_templates: CanvasManagerVisibility

sections

sections: CanvasManagerVisibility

---

CanvasManagerVisibility

CanvasManagerVisibility = object

Properties

hide

hide: string[]

order

order: string[]

---

CanvasRecommendedFile

CanvasRecommendedFile = object

Properties

access_type?

optional access_type?: AccessTypeEnum

app_metadata?

optional app_metadata?: Record<string, any>

available_at?

optional available_at?: string | null

content_extension

readonly content_extension: string | null

content_length

readonly content_length: number | null

content_type

readonly content_type: FileContentTypeEnum

content_url

readonly content_url: string | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

download_type?

optional download_type?: DownloadTypeEnum

expires_at?

optional expires_at?: string | null

folder

readonly folder: MiniFolder

folder_id?

optional folder_id?: string

global_id

readonly global_id: string

id

readonly id: string

instance_id

readonly instance_id: string

metadata?

optional metadata?: Record<string, any>

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser | null

name?

optional name?: string

original_extension

readonly original_extension: string | null

original_url

readonly original_url: string | null

owned_by

readonly owned_by: MiniUser

permissions?

optional permissions?: FilePermission

published_at

readonly published_at: string | null

role

readonly role: CollaborationRoleEnum

Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.

shared_link

readonly shared_link: MiniSharedLink

size

readonly size: number | null

status

readonly status: FileStatusEnum

tags?

optional tags?: string[]

thumbnail_url

readonly thumbnail_url: string | null

type

readonly type: FileTypeEnum

zip_size

readonly zip_size: number | null

zip_url

readonly zip_url: string | null

---

CanvasRecommendedFiles

CanvasRecommendedFiles = object

Properties

recommended_files

recommended_files: CanvasRecommendedFile[]

---

CanvasRetrieve

CanvasRetrieve = object

Properties

access_type?

optional access_type?: AccessTypeEnum

account?

optional account?: Account | null

content?

optional content?: Record<string, any>

context?

optional context?: any

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

events

readonly events: MiniEvent[]

expires_at?

optional expires_at?: string | null

folder_id?

optional folder_id?: string | null

id

readonly id: string

indicators?

optional indicators?: Record<string, any> | null

instance_id

instance_id: string

is_block?

optional is_block?: boolean

is_default?

optional is_default?: boolean

is_directly_shared_with_me?

readonly optional is_directly_shared_with_me?: boolean

PIT-8801 — does the REQUESTING user hold a live DIRECT (user_id) collaboration on THIS canvas? Role-blind, deleted_at IS NULL, and with no content-distribution-group term.

The server's answer to "may this viewer edit a master somebody shared with them", so the client cannot offer an edit the API refuses: the write arm asks Canvas.has_direct_collaboration, because a canvas<->CDG Collaboration row is creatable through the public API and would otherwise hand an unbounded group edit rights on somebody else's master. isSharedWithMe on the client is only "the owner is not me" and cannot tell the two apart.

FALSE for the owner — they hold no collaboration on their own canvas — so consumers OR it with their own ownership/admin gate rather than special-casing it.

Read-only, and ABSENT unless requested in ?fields=; an absent value must fail CLOSED (no edit offered).

Three states, not two. Django emits a real boolean whenever the field is serialized, including false for the owner and true on a directly-shared ORDINARY canvas. next-core's PATCH response is narrower on purpose: it echoes only the answer its permission check actually resolved, and OMITS the key otherwise rather than asserting a false it never probed — so an owner's save, and any non-master save, carry no value at all. That is why the type is optional and why undefined must be read as NOT RESOLVED rather than as false: it is safe because every consumer ORs this with its own ownership/admin gate, and because the two client paths that could be hurt by a missing value either merge the response over the existing canvas (the builder) or re-request the full field list (the masters-tab inline rename, which replaces the row outright).

Hand-added (additive) — preserve on type regen.

is_draft?

optional is_draft?: boolean

is_editable?

optional is_editable?: boolean

is_master?

optional is_master?: boolean

is_section?

optional is_section?: boolean

is_template?

optional is_template?: boolean

metadata?

optional metadata?: any

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

section_ids?

readonly optional section_ids?: string[]

Opt-in lazy section loading: present (instead of inline sections) only when the canvas was fetched with ?lazy_sections=true AND the org/instance lazy_load_sections setting is on. Ordered referenced section IDs; the client hydrates bodies on demand via getSectionsByIds. Absent on every legacy (fully-expanded) response. Hand-added (additive) — preserve on type regen.

sections

readonly sections: CanvasSection[]

shared_link

readonly shared_link: MiniSharedLink

start_at?

optional start_at?: string | null

tags?

optional tags?: string[]

template

readonly template: MiniCanvasWithTags

theme?

optional theme?: Record<string, any> | null

thumbnail_url?

optional thumbnail_url?: string | null

---

CanvasSection

CanvasSection = object

Serializer used solely for defining the OpenAPI schema in extend_schema_field.

Properties

content

content: Record<string, any>

id

readonly id: string

is_draft

is_draft: boolean

metadata?

optional metadata?: Record<string, any>

name

name: string

theme?

optional theme?: Record<string, any> | null

---

CanvasSelection

CanvasSelection = object

Properties

id

id: Canvas["id"]

---

CanvasTypographyPreset

CanvasTypographyPreset = object

Properties

color

color: string

font_family

font_family: string

font_size

font_size: string

font_weight

font_weight: "400" | "700"

id

id: CanvasTypographyPresetId

letter_spacing

letter_spacing: string

line_height

line_height: string

text_transform

text_transform: "capitalize" | "lowercase" | "none" | "uppercase"

---

CanvasTypographyPresetId

CanvasTypographyPresetId = "h_1" | "h_2" | "h_3" | "big_text" | "normal_text" | "small_text"

---

CollectionFile

CollectionFile = object

Properties

file

file: CollectionFileEntity

id

id: string

type

type: "file"

---

CollectionFileEntity

CollectionFileEntity = Pick<FileRetrieve, "id" | "name" | "type" | "tags" | "metadata" | "thumbnail_url" | "permissions" | "content_url" | "content_type" | "pspdfkit_auth_payload" | "pspdfkit_document_id" | "pspdfkit_server_url" | "expires_at">

---

CollectionGroup

CollectionGroup = object

Properties

id

id: string

name

name: string

slides

slides: CollectionSlide[]

---

CollectionPage

CollectionPage = object

Properties

file

file: CollectionFileEntity

id

id: string

slide

slide: object

Name	Type
index	number
url	FileRetrieve["thumbnail_url"]

type

type: "slide"

---

CollectionPlayer

CollectionPlayer = object

Properties

data_accessor?

optional data_accessor?: string

filters?

optional filters?: Record<string, any>

groups

groups: CollectionGroup[]

hide_footer?

optional hide_footer?: boolean

name

name: string

---

CollectionSelectorProps

CollectionSelectorProps = object

Properties

attachTo?

optional attachTo?: string | HTMLElement

closeOnSettings?

optional closeOnSettings?: boolean

fetchFile

fetchFile: (id) => Promise<FileRetrieve>

Parameters

Parameter	Type
id	string

Returns

Promise<FileRetrieve>

fetchFileList

fetchFileList: FetchFileList

hideClose?

optional hideClose?: boolean

initialData?

optional initialData?: CollectionPlayer

initialMetadataFilters?

optional initialMetadataFilters?: Record<string, any>

openSettings?

optional openSettings?: () => void

Returns

void

readonlyName?

optional readonlyName?: boolean

selectFileContent

selectFileContent: SelectFileContent

translations?

optional translations?: Translations

zIndex?

optional zIndex?: number

---

CollectionSlide

CollectionSlide = CollectionPage | CollectionFile

---

ComponentNodeThemeMeta

ComponentNodeThemeMeta = ComponentNodeGenericThemeMeta | ComponentNodeDynamicDataTableThemeMeta | ComponentNodeMultimediaThemeMeta

---

ConnectedService

ConnectedService = object

Properties

access_token?

optional access_token?: string

connection_id

connection_id: string

name

name: string

provider

provider: string

type

type: string

urls?

optional urls?: Record<string, string>

user_id?

optional user_id?: string

---

ContentGridCardShape

ContentGridCardShape = typeof ContentGridCardShapes[keyof typeof ContentGridCardShapes]

---

ContentGridCommonFileProps

ContentGridCommonFileProps = object

Properties

content_extension?

optional content_extension?: FileRetrieve["content_extension"]

content_type?

optional content_type?: FileContentTypeEnum | null

content_url?

optional content_url?: FileRetrieve["content_url"]

expires_at?

optional expires_at?: FileRetrieve["expires_at"]

id

id: FileRetrieve["id"]

is_deleted?

optional is_deleted?: boolean

name

name: FileRetrieve["name"]

permissions?

optional permissions?: FileRetrieve["permissions"]

snapshot_id?

optional snapshot_id?: FileRetrieve["id"]

tags?

optional tags?: FileRetrieve["tags"]

---

ContentGridFileProps

ContentGridFileProps = ContentGridCommonFileProps & object

Type Declaration

content_extension

content_extension: FileRetrieve["content_extension"]

content_length?

readonly optional content_length?: FileRetrieve["content_length"]

content_thumbnails?

optional content_thumbnails?: FileRetrieve["content_thumbnails"] | null

content_type

content_type: FileContentTypeEnum | null

content_url

content_url: FileRetrieve["content_url"]

pspdfkit_auth_payload?

readonly optional pspdfkit_auth_payload?: FileModel["pspdfkit_auth_payload"]

pspdfkit_server_url?

readonly optional pspdfkit_server_url?: FileModel["pspdfkit_server_url"]

thumbnail_url?

optional thumbnail_url?: FileRetrieve["thumbnail_url"]

---

ContentGridItemFileProps

ContentGridItemFileProps = object

Properties

file

file: ContentGridFileProps

type

type: "file"

---

ContentGridItemSlideProps

ContentGridItemSlideProps = object

Properties

file

file: ContentGridCommonFileProps

slide

slide: object

Name	Type
index	number
url?	FileRetrieve["content_thumbnails"][number]

type

type: "slide"

---

ContentMatchRule

ContentMatchRule = object

Forward stub for PIT-6124 content-recommendation matching. Maps a CRM/context source field to a canvas/file metadata key so recommendations can be filtered or ranked by metadata alignment.

Properties

required?

optional required?: boolean

source_field

source_field: string

target_metadata_key

target_metadata_key: string

---

ContentSelection

ContentSelection = object

Properties

file?

optional file?: Pick<FileRetrieve, "id" | "name">

fileId

fileId: FileRetrieve["id"]

name?

optional name?: string

pageIndex?

optional pageIndex?: number

type

type: "file" | "page"

---

CoreFolderContentsRetrieve

CoreFolderContentsRetrieve = object

Properties

contents

contents: CanvasRetrieve[]

folders

folders: CoreFolderRetrieve[]

id

id: string

name

name: string

path?

optional path?: any[]

---

EmbeddedLocationProperties

EmbeddedLocationProperties = object

Properties

start_in_loading_mode?

optional start_in_loading_mode?: boolean

---

EmbedLocation

EmbedLocation = "ui_app" | "canvas" | "dsr" | "admin_instance" | "overlay_app" | "canvas_section_execution" | "canvas_drawer"

---

Enumerate

Enumerate<N, Acc> = Acc["length"] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc["length"]]>

Type Parameters

Type Parameter	Default type
N extends number	-
Acc extends number[]	[]

---

EventKey

EventKey<KeyMap> = string & keyof KeyMap

Type Parameters

Type Parameter
KeyMap extends EventMap

---

EventMap

EventMap = Record<string, any>

---

EventReceiver

EventReceiver<KeyMap> = (params) => void

Type Parameters

Type Parameter
KeyMap

Parameters

Parameter	Type
params	KeyMap

Returns

void

---

ExternalLinkSelection

ExternalLinkSelection = object

Properties

content_type

content_type: "video" | "image"

from

from: "custom" | "pexels" | "unsplash" | "ai"

type

type: "external_link"

url

url: string

---

ExternalMultimediaAssetType

ExternalMultimediaAssetType = object & MultimediaPosterProvenance

Type Declaration

asset_type

asset_type: typeof MULTIMEDIA_IMG_TYPE.external

external_url

external_url: string

from?

optional from?: "custom" | "pexels" | "unsplash" | "ai"

horizontal_alignment?

optional horizontal_alignment?: MultimediaHorizontalAlignmentOptions

poster_background_size?

optional poster_background_size?: BackgroundSize

poster_url?

optional poster_url?: string

type

type: "image" | "video"

---

FetchFileList

FetchFileList = <T>(payload) => Promise<File[]>

Type Parameters

Type Parameter
T extends object

Parameters

Parameter	Type
payload	T

Returns

Promise<File[]>

---

FetchMode

FetchMode = "postmessage" | "prefer-online"

---

File

File = object

Properties

access_type?

optional access_type?: AccessTypeEnum

app_metadata?

optional app_metadata?: Record<string, any>

available_at?

optional available_at?: string | null

content_extension

readonly content_extension: string | null

content_length

readonly content_length: number | null

content_type

readonly content_type: FileContentTypeEnum

content_url

readonly content_url: string | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

download_type?

optional download_type?: DownloadTypeEnum

downloaded_at?

readonly optional downloaded_at?: string | null

iOS bridge only — not returned by the REST API.

expires_at?

optional expires_at?: string | null

folder

readonly folder: MiniFolder

folder_id?

optional folder_id?: string

global_id

readonly global_id: string

id

readonly id: string

instance_id

readonly instance_id: string

metadata?

optional metadata?: Record<string, any>

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser | null

name?

optional name?: string

original_extension

readonly original_extension: string | null

original_url

readonly original_url: string | null

owned_by

readonly owned_by: MiniUser

permissions?

optional permissions?: FilePermission

published_at

readonly published_at: string | null

role

readonly role: CollaborationRoleEnum

Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.

shared_link

readonly shared_link: MiniSharedLink

size

readonly size: number | null

status

readonly status: FileStatusEnum

tags?

optional tags?: string[]

thumbnail_url

readonly thumbnail_url: string | null

type

readonly type: FileTypeEnum

zip_size

readonly zip_size: number | null

zip_url

readonly zip_url: string | null

---

FileCreateRequest

FileCreateRequest = object

Properties

access_type?

optional access_type?: AccessTypeEnum

app_metadata?

optional app_metadata?: Record<string, any>

available_at?

optional available_at?: string | null

content?

optional content?: Blob

content_upload_id?

optional content_upload_id?: string

download_type?

optional download_type?: DownloadTypeEnum

expires_at?

optional expires_at?: string | null

folder_id?

optional folder_id?: string

instance_id

instance_id: string

is_asset?

optional is_asset?: boolean

Deprecated: Please use the 'type' field instead. This field is maintained for backward compatibility and may be removed in future releases.

metadata?

optional metadata?: Record<string, any>

name?

optional name?: string

owned_by_id?

optional owned_by_id?: number | null

permissions?

optional permissions?: FilePermissionRequest

tags?

optional tags?: string[]

thumbnail?

optional thumbnail?: Blob

thumbnail_upload_id?

optional thumbnail_upload_id?: string

type?

optional type?: FileTypeEnum

url?

optional url?: string

---

FilePermission

FilePermission = object

Properties

can_be_divided?

optional can_be_divided?: boolean

can_download?

optional can_download?: boolean

can_print

readonly can_print: boolean

can_share?

optional can_share?: boolean

---

FilePermissionRequest

FilePermissionRequest = object

Properties

can_be_divided?

optional can_be_divided?: boolean

can_download?

optional can_download?: boolean

can_print?

optional can_print?: boolean

can_share?

optional can_share?: boolean

---

FileRetrieve

FileRetrieve = object

Extended by

• FileModel

Properties

access_type?

optional access_type?: AccessTypeEnum

app_metadata?

optional app_metadata?: Record<string, any>

available_at?

optional available_at?: string | null

content_extension

readonly content_extension: string | null

content_length

readonly content_length: number | null

content_thumbnails

readonly content_thumbnails: string[]

content_type

readonly content_type: FileContentTypeEnum

content_url

readonly content_url: string | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

download_type?

optional download_type?: DownloadTypeEnum

downloaded_at?

readonly optional downloaded_at?: string | null

iOS bridge only — not returned by the REST API.

expires_at?

optional expires_at?: string | null

folder

readonly folder: MiniFolder

folder_id?

optional folder_id?: string

global_id

readonly global_id: string

id

readonly id: string

instance_id

readonly instance_id: string

metadata?

optional metadata?: Record<string, any>

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name?

optional name?: string

original_extension

readonly original_extension: string | null

original_url

readonly original_url: string | null

owned_by

readonly owned_by: MiniUser

permissions?

optional permissions?: FilePermission

pspdfkit_auth_payload

readonly pspdfkit_auth_payload: Record<string, any> | null

pspdfkit_document_id

readonly pspdfkit_document_id: string | null

pspdfkit_server_url

readonly pspdfkit_server_url: string | null

published_at

readonly published_at: string | null

role

readonly role: CollaborationRoleEnum

Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.

shared_annotation_layer?

readonly optional shared_annotation_layer?: boolean

Shared-link (DSR) reads only — PIT-8968. true when Django minted pspdfkit_auth_payload for the link's read-only share_<link_id> Document Engine layer (the sharer's annotations, frozen at link creation). Absent or false everywhere else, including every non-DSR read.

shared_link

readonly shared_link: MiniSharedLink

size

readonly size: number | null

status

readonly status: FileStatusEnum

tags?

optional tags?: string[]

thumbnail_url

readonly thumbnail_url: string | null

type

readonly type: FileTypeEnum

version

readonly version: FileVersion | null

Null when the file has no current-version row: File.version_object is a nullable FK (ng-rest-api/pitcher/models/filemodels.py) exposed through a nested read-only serializer, so DRF emits null rather than omitting it.

zip_size

readonly zip_size: number | null

zip_url

readonly zip_url: string | null

---

FileRevision

FileRevision = object

Properties

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

id

readonly id: string

name

name: string

---

FileUpdateRequest

FileUpdateRequest = object

Properties

access_type?

optional access_type?: AccessTypeEnum

app_metadata?

optional app_metadata?: Record<string, any>

available_at?

optional available_at?: string | null

content?

optional content?: Blob

content_upload_id?

optional content_upload_id?: string

download_type?

optional download_type?: DownloadTypeEnum

expires_at?

optional expires_at?: string | null

folder_id?

optional folder_id?: string

metadata?

optional metadata?: Record<string, any>

name?

optional name?: string

owned_by_id?

optional owned_by_id?: number | null

permissions?

optional permissions?: FilePermissionRequest

tags?

optional tags?: string[]

thumbnail?

optional thumbnail?: Blob

thumbnail_upload_id?

optional thumbnail_upload_id?: string

url?

optional url?: string

---

FileVersion

FileVersion = object

Properties

comment

readonly comment: string

created_at

readonly created_at: string

id

readonly id: string

---

Folder

Folder = object

Properties

access_type?

optional access_type?: AccessTypeEnum

content_type

readonly content_type: string

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

file_thumbnail_urls

readonly file_thumbnail_urls: string[]

id

readonly id: string

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

parent_folder_id

readonly parent_folder_id: string | null

path

path: string

rules?

optional rules?: FolderRule[]

thumbnail_url

readonly thumbnail_url: string | null

---

FolderCanvas

FolderCanvas = object

Properties

created_by

readonly created_by: MiniUser

id

readonly id: string

modified_at

readonly modified_at: string

name

name: string

owned_by

readonly owned_by: MiniUser

tags

readonly tags: string[]

thumbnail_url?

optional thumbnail_url?: string | null

---

FolderCreateRequest

FolderCreateRequest = object

Serializer class for creating folder records. Available fields for creating a folder:

• id
• name
• parent_folder_id
• instance_id

Properties

access_type?

optional access_type?: AccessTypeEnum

id?

optional id?: string

name

name: string

owned_by_id?

optional owned_by_id?: number | null

parent_folder_id

parent_folder_id: string

rules?

optional rules?: FolderRuleRequest[]

thumbnail_id?

optional thumbnail_id?: string | null

---

FolderFile

FolderFile = object

Properties

access_type?

optional access_type?: AccessTypeEnum

available_at

readonly available_at: string | null

content_type

readonly content_type: FileContentTypeEnum

created_by

readonly created_by: MiniUser

expires_at

readonly expires_at: string | null

id

readonly id: string

metadata

readonly metadata: Record<string, any>

modified_at

readonly modified_at: string

name

readonly name: string

original_extension

readonly original_extension: string | null

original_url

readonly original_url: string | null

owned_by

readonly owned_by: MiniUser

permissions?

optional permissions?: FilePermission

status

readonly status: FileStatusEnum

tags

readonly tags: string[]

thumbnail_url

readonly thumbnail_url: string

---

FolderFolder

FolderFolder = object

Mixin for common file access filtering logic.

Properties

available_files_count

readonly available_files_count: number

available_folders_count

readonly available_folders_count: number

canvas_thumbnail_urls

readonly canvas_thumbnail_urls: string[]

canvases_count

readonly canvases_count: number

file_thumbnail_urls

readonly file_thumbnail_urls: string[]

files_count

readonly files_count: number

folders_count

readonly folders_count: number

id

readonly id: string

name

name: string

order?

optional order?: number | null

Manual custom-sort position among siblings. Null when no custom order is set.

thumbnail_url

readonly thumbnail_url: string | null

---

FolderRetrieve

FolderRetrieve = object

Mixin for common file access filtering logic.

Properties

access_type?

optional access_type?: AccessTypeEnum

canvases

readonly canvases: FolderCanvas[]

content_type

readonly content_type: string

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

file_thumbnail_urls

readonly file_thumbnail_urls: string[]

Override to apply user permissions when filtering files for thumbnails.

files

readonly files: FolderFile[]

folders

readonly folders: FolderFolder[]

id

readonly id: string

instance_id

readonly instance_id: string

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

parent_folder_id

readonly parent_folder_id: string | null

path

readonly path: FolderFolder[]

rules?

optional rules?: FolderRule[]

thumbnail_url

readonly thumbnail_url: string | null

---

FolderRule

FolderRule = object

Properties

field

field: string

operator

operator: OperatorEnum

value

value: string

---

FolderRuleRequest

FolderRuleRequest = object

Properties

field

field: string

operator

operator: OperatorEnum

value

value: string

---

FolderUpdateRequest

FolderUpdateRequest = object

Serializer class for updating folder records. Available fields to update:

• name
• access_type
• parent_folder_id

Properties

access_type?

optional access_type?: AccessTypeEnum

name

name: string

owned_by_id?

optional owned_by_id?: number | null

parent_folder_id?

optional parent_folder_id?: string

rules?

optional rules?: FolderRuleRequest[]

thumbnail_id?

optional thumbnail_id?: string | null

---

FullscreenMode

FullscreenMode = "focus" | "fullscreen"

---

Instance

Instance = object

Properties

color?

optional color?: string | null

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

environment

readonly environment: MiniEnvironment

id

readonly id: string

last_login

readonly last_login: string

logo?

optional logo?: string | null

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

name

name: string

owned_by

readonly owned_by: MiniUser

region

readonly region: MiniRegion

role

readonly role: InstanceMembershipRoleEnum

settings?

optional settings?: Record<string, any>

storage_region

readonly storage_region: StorageRegionEnum

---

InstanceSettings

InstanceSettings = OrganizationSettings & object

Type Declaration

admin_landing_page?

optional admin_landing_page?: string

canvas?

optional canvas?: object

canvas.async_download_api_url?

optional async_download_api_url?: string

canvas.async_download_callback_url?

optional async_download_callback_url?: string

canvas.async_download_expiration_hours?

optional async_download_expiration_hours?: number

canvas.autohide_section_on_created?

optional autohide_section_on_created?: AutohideSectionOnCreated

canvas.capture_component_enter_exit_events?

optional capture_component_enter_exit_events?: "all" | "named_components"

canvas.component_availability?

optional component_availability?: CanvasComponentAvailability & object

Type Declaration

Name	Type
apps?	Record<string, boolean>

canvas.component_availability_roles?

optional component_availability_roles?: CanvasComponentAvailabilityRoles & object

Type Declaration

Name	Type
apps?	Record<string, { admin?: boolean; rep?: boolean; }>

canvas.content_grid_autofill_files_filter_iteratee?

optional content_grid_autofill_files_filter_iteratee?: string

canvas.correlation_id_cleanup_delay?

optional correlation_id_cleanup_delay?: number

canvas.disable_display_index_in_toc?

optional disable_display_index_in_toc?: boolean

canvas.disable_rep_canvas_creation?

optional disable_rep_canvas_creation?: boolean

canvas.disable_shared_link_creation?

optional disable_shared_link_creation?: boolean

canvas.dynamic_content_date_created_field?

optional dynamic_content_date_created_field?: string

canvas.dynamic_content_date_modified_field?

optional dynamic_content_date_modified_field?: string

canvas.enable_collection_player_component?

optional enable_collection_player_component?: boolean

canvas.hide_meeting_bar?

optional hide_meeting_bar?: boolean

canvas.hide_page_break_in_toc?

optional hide_page_break_in_toc?: boolean

canvas.pptx_slide_image_width?

optional pptx_slide_image_width?: number

canvas.require_account_on_canvas_creation?

optional require_account_on_canvas_creation?: boolean

canvas.section_content_grid_autofill_files_filter_iteratee?

optional section_content_grid_autofill_files_filter_iteratee?: string

canvas.section_list_mode?

optional section_list_mode?: "pagination" | "collapsibles"

canvas.show_extra_exit_button_in_fullscreen_mode?

optional show_extra_exit_button_in_fullscreen_mode?: boolean

canvas.show_fallback_section_name_on_collapsibles?

optional show_fallback_section_name_on_collapsibles?: boolean

canvas.show_home_template_in_create_canvas_modal?

optional show_home_template_in_create_canvas_modal?: boolean

canvas.sync_from_template?

optional sync_from_template?: string[]

custom_event?

optional custom_event?: string

date_format?

optional date_format?: string

enable_multipeer_connectivity?

optional enable_multipeer_connectivity?: boolean

enable_rep_to_rep_impersonation?

optional enable_rep_to_rep_impersonation?: boolean

enable_sync_file_filtering?

optional enable_sync_file_filtering?: boolean

enable_syncbox?

optional enable_syncbox?: boolean

ios?

optional ios?: InstanceSettings

is_file_expiration_mandatory?

optional is_file_expiration_mandatory?: boolean

rep_uploads_folder_name?

optional rep_uploads_folder_name?: string

time_format?

optional time_format?: string

---

LaunchDarklyBooleanFlagKey

LaunchDarklyBooleanFlagKey = "allow_ai_prompts_in_canvas_text" | "allow_bulk_actions_canvases_files" | "allow_content_grid_autofill" | "allow_canvas_duplication" | "allow_canvases_tables_columns_settings" | "allow_table_column_resizing" | "allow_creating_canvas_with_no_template" | "allow_dynamic_data_table_for_scribble_component" | "allow_html_for_scribble_component" | "allow_embeddable_for_scribble_component" | "allow_embeddable_hiding" | "allow_multimedia_for_scribble_component" | "allow_note_taking" | "allow_rep_canvas_metadata_edit" | "allow_rep_file_distributions" | "allow_rep_file_rating" | "allow_rep_file_upload" | "allow_saving_annotations_in_personal_layer" | "allow_user_to_edit_font_size_and_color_in_canvas_tokens" | "are_sections_system_controlled" | "enable_canvas_core_distributions" | "copy_context_to_canvas" | "copy_template_metadata_to_canvas" | "disable_canvas_edit_for_reps" | "disable_custom_tooltips" | "disable_file_edit_content" | "enable_inline_wopi_edit_button" | "disable_fullscreen_canvas_builder" | "disable_impact_web_browser_fullscreen" | "disable_user_invitations" | "display_section_list_name" | "disable_download_canvas" | "enable_ai_generated_thumbnails" | "enable_analytics" | "enable_app_developer_role" | "enable_background_image_theme_options" | "enable_better_canvas_builder_control_bars_on_zoom" | "enable_bulk_update_file_attributes" | "enable_canvas_as_home" | "enable_canvas_blocks" | "enable_canvas_node_debugging" | "enable_canvas_freeze" | "enable_canvas_locks" | "enable_canvas_template_edit_in_impact" | "enable_canvas_tokens" | "enable_collaborations" | "enable_collection_player_data_accessor" | "enable_content_grid_data_accessor" | "enable_content_translation" | "enable_content_type_change_in_content_selector" | "enable_cross_tab_instance_reload_for_ld_sync" | "enable_create_section_from_section_template" | "enable_custom_display_overrides" | "enable_default_crm_shape" | "enable_detailed_date_format" | "enable_dsr_readonly_annotations" | "enable_dnd_html_editor" | "enable_dynamic_content_component" | "enable_dynamic_data_table_component" | "enable_custom_data_tables" | "enable_embedded_video_autoplay" | "enable_embedded_video" | "enable_enhanced_canvas_drawer_app" | "enable_enhanced_indicators" | "enable_enhanced_section_execution_states" | "enable_experimental_canvas_builder_dnd" | "enable_extra_file_data" | "enable_file_copy" | "enable_file_pages_metadata" | "enable_file_revisions" | "enable_file_divisible_permission" | "enable_folder_details_edit" | "enable_folder_distributions" | "enable_handlebar_template_support" | "enable_height_in_component_theming" | "enable_home_customization" | "enable_hotspot_visibility" | "enable_improved_canvas_node_updating" | "enable_individual_users_in_file_distribution" | "enable_inline_filter_options" | "enable_insearch_in_section_selector" | "enable_instance_cloner" | "enable_advanced_cloner" | "enable_content_promotion" | "enable_instance_editor_role" | "enable_instance_navigation_from_management" | "enable_knock_notifications" | "enable_maintain_section_theme_control" | "enable_master_pitchdecks" | "enable_metadata_in_file_uploads_with_default_values" | "enable_more_intuitive_component_spacing" | "enable_multi_destination_upload" | "enable_new_meeting_bar" | "enable_provider_agnostic_meeting_bar" | "enable_original_pdf_link" | "enable_scale_content" | "enable_sorting_in_tiptap_table" | "enable_stt_dictation" | "enable_cloud_stt_fallback" | "enable_tts_neural" | "enable_theme_assets" | "enable_toc_enhancements_to_support_same_section_in_section_list" | "enable_pia_assistant" | "enable_pipe_character_multi_search" | "enable_popup_apps" | "enable_pre_send_validation" | "enable_reorder_search" | "enable_reorder_scribble_isolation" | "enable_reorder_component_options_menu" | "enable_resizable_multimedia_component" | "enable_responsive_scribble_component" | "enable_saved_canvases_filters" | "enable_short_tag_column_in_tables" | "enable_scribble_component" | "enable_scribble_content_as_background" | "enable_search_and_filters_in_multimedia_component" | "enable_section_context_in_dsr" | "enable_selectors_dnd" | "enable_section_selector_edit_section" | "enable_smart_folders" | "enable_smart_folders_for_sections" | "enable_smart_folders_in_section_selector" | "enable_smart_folders_in_files" | "enable_sorting_in_sections" | "enable_suggested_tags" | "enable_template_component_permissions" | "enable_template_folders" | "enable_theme_options_border_radius" | "enable_themes" | "hide_asset_uploader" | "hide_user_feedback_widget" | "include_files_content_in_print" | "interpolate_rep_canvases_on_edit_mode" | "is_timeline_component_allowed" | "launch_in_full_screen_on_present_mode" | "prefer_online_handlers" | "restrict_owned_files_from_admins" | "show_asset_manager_for_multimedia" | "show_clear_all_annotations_button" | "show_content_selector_list_view" | "show_metadata_filters_in_all_canvas_things" | "show_only_preview_mode_for_html_component" | "show_popularity_icons" | "use_core_endpoint_for_analytics" | "convert_pptx_to_section_with_scribble_pdfjs" | "use_short_url_for_shared_link" | "use_zoho_instead_of_ms_wopi" | "enable_new_section_list" | "enable_sharebox_apps" | "enable_sharebox_bulk_filtering" | "enable_back_to_previous_location_in_canvas" | "enable_crm_shape_for_external_links" | "enable_adaptive_popup_apps" | "enable_file_version_polling" | "skip_pspdfkit_wait_for_high_res_thumbs" | "enable_reactive_scribble_component_toolbar" | "enable_embeddable_full_screen_mode" | "enable_enhanced_user_management" | "enable_impersonation" | "enable_instance_admin_user_assignment" | "keep_static_pptx_editable" | "enable_canvas_pdf_dimensions" | "enable_editable_pptx_of_canvas" | "enable_editable_pptx_of_canvas_with_fonts" | "enable_aspose_pptx_of_canvas" | "enable_canvas_control_bars_collapse" | "enable_rep_app_visibility_order" | "enable_file_sharing_print_permissions" | "enable_section_sharing_print_permissions" | "enable_marketplace_tab" | "enable_sfdc_account_visibility_for_canvases" | "sfdc_offline_enabled" | "enable_granular_permissions" | "enable_hub_recommended_smart_folder" | "enable_custom_user_properties" | "enable_users_export"

---

LaunchDarklyEnv

LaunchDarklyEnv = { [K in LaunchDarklyBooleanFlagKey]?: boolean } & { [K in LaunchDarklyStringFlagKey]?: LaunchDarklyStringFlagValue<K> } & { [K in LaunchDarklyNumberFlagKey]?: number } & { [K in keyof LaunchDarklyObjectFlags]?: LaunchDarklyObjectFlags[K] } & object

---

LaunchDarklyNumberFlagKey

LaunchDarklyNumberFlagKey = "canvas_section_selector_page_size" | "canvas_section_selector_selected_items_with_thumbnail_size"

---

LaunchDarklyObjectFlags

LaunchDarklyObjectFlags = object

Properties

canvas_manager_table_columns

canvas_manager_table_columns: CanvasManagerTableColumns

context_crm_shape

context_crm_shape: Record<string, any>

pia_search_config

pia_search_config: PiaSearchConfig

---

LaunchDarklyStringFlagKey

LaunchDarklyStringFlagKey = keyof typeof _LaunchDarklyStringFlags

---

LaunchDarklyStringFlagValue

LaunchDarklyStringFlagValue<K> = K extends LaunchDarklyStringFlagKey ? typeof _LaunchDarklyStringFlags[K][number] : never

Type Parameters

Type Parameter	Default type
K extends LaunchDarklyStringFlagKey	LaunchDarklyStringFlagKey

---

MetadataHighlightProperty

MetadataHighlightProperty = object

Properties

background_color?

optional background_color?: string

color?

optional color?: string

icon?

optional icon?: string

key

key: string

match_value

match_value: string | string[] | number | boolean

text

text: string

---

MetadataTemplate

MetadataTemplate = object

Properties

created_at

readonly created_at: string

created_by

readonly created_by: MiniUser

file

readonly file: MiniFile

id

readonly id: string

instance

readonly instance: MiniInstance

modified_at

readonly modified_at: string

modified_by

readonly modified_by: MiniUser

owned_by

readonly owned_by: MiniUser

sections?

optional sections?: MetadataTemplateSection[]

---

MetadataTemplateField

MetadataTemplateField = object

Properties

applies_to?

optional applies_to?: MetadataTemplateFieldAppliesToEnum

default?

optional default?: string | boolean | number | null

help_text?

optional help_text?: string

is_badge?

optional is_badge?: boolean

is_filterable?

optional is_filterable?: boolean

is_required?

optional is_required?: boolean

is_sortable?

optional is_sortable?: boolean

label

label: string

name

name: string

options?

optional options?: MetadataTemplateOption[]

type

type: MetadataTemplateFieldTypeEnum

---

MetadataTemplateOption

MetadataTemplateOption = object

Properties

label

label: string

value

value: string

---

MetadataTemplateSection

MetadataTemplateSection = object

Properties

are_fields_dependent?

optional are_fields_dependent?: boolean

fields

fields: MetadataTemplateField[]

label

label: string

---

MiniCanvasWithTags

MiniCanvasWithTags = object

Properties

id

readonly id: string

name

name: string

tags?

readonly optional tags?: string[]

---

MiniEnvironment

MiniEnvironment = object

Properties

color?

optional color?: string | null

id

readonly id: number

name

name: string

---

MiniEvent

MiniEvent = object

Properties

id

readonly id: string

start_at

start_at: string

subject

subject: string

---

MiniFile

MiniFile = object

Properties

id

readonly id: string

name

name: string

---

MiniFolder

MiniFolder = object

Properties

id

readonly id: string

name

name: string

---

MiniInstance

MiniInstance = object

Properties

id

readonly id: string

name

name: string

---

MiniRegion

MiniRegion = object

Properties

id

readonly id: number

name

name: string

---

MiniSharedLink

MiniSharedLink = object

Properties

short_url?

optional short_url?: string | null

url

readonly url: string

---

MiniUser

MiniUser = object

Properties

email?

optional email?: string

id

readonly id: number

name

readonly name: string

---

MultimediaPosterProvenance

MultimediaPosterProvenance = object

Where a Multimedia poster_url came from — shared by every asset variant, because a poster's origin is independent of the media's (an external video can carry an L&D-hosted poster).

poster_url alone is unrefreshable: a short-lived source (an L&D presigned URL, 900s) rots and the canvas has no record of what it was, so nothing can re-resolve it — unlike file.content_url, which Multimedia.vue refreshes at render off file.id. Recording the id plus its backend is what keeps a poster recoverable.

Both are absent for an external-link/Pexels poster (long-lived URL, no Pitcher id to resolve).

poster_asset_type lives on the NODE rather than being read from host state at render, because the render path must work in COURSE (rep playback) — the mode where a poster is guaranteed to be past its TTL — and COURSE cannot supply CanvasBuilderProps.assetType at all (it's ?: never there). (T1.7b / PIT-7742, R4-F1.)

Extended by

• LdMultimediaAssetType

Properties

poster_asset_type?

optional poster_asset_type?: "pitcher_asset" | "ld_asset"

poster_file_id?

optional poster_file_id?: string

---

MultimediaProps

MultimediaProps = ExternalMultimediaAssetType | PitcherMultimediaAssetType | LdMultimediaAssetType

---

Mutable

Mutable<T> = { -readonly [P in keyof T]: T[P] }

Type Parameters

Type Parameter
T

---

Organization

Organization = object

Properties

branding

readonly branding: OrganizationBranding

display_name

readonly display_name: string

id

readonly id: string

metadata

readonly metadata: Record<string, any>

name

readonly name: string

settings

readonly settings: Record<string, any>

---

OrganizationBranding

OrganizationBranding = object

Properties

colors?

optional colors?: OrganizationBrandingColors | null

logo_url?

optional logo_url?: string

---

OrganizationBrandingColors

OrganizationBrandingColors = object

Properties

page_background?

optional page_background?: string

primary?

optional primary?: string

---

OrganizationSettings

OrganizationSettings = object

Properties

ai_tasks?

optional ai_tasks?: object

Name	Type
disabled?	string[]

allow_dsr_forwarding?

optional allow_dsr_forwarding?: boolean

allow_revoke_shared_link?

optional allow_revoke_shared_link?: boolean

alternative_canvas_fullscreen?

optional alternative_canvas_fullscreen?: boolean

api_client_timeout?

optional api_client_timeout?: number

assets_route_order?

optional assets_route_order?: number

auto_assignment_rules?

optional auto_assignment_rules?: object[]

Name	Type
connection_id	string
groups?	string[]
target_instance_id	string

business_logic_ids_to_section_ids_resolver?

optional business_logic_ids_to_section_ids_resolver?: string

canvas?

optional canvas?: object

Name	Type
account_context_fields?	string[]
enable_edit_opens_completion_wizard?	boolean
enable_hub_bottom_sheet?	boolean
enable_pdf_compression?	boolean
enable_presentation_tools?	boolean
enable_react_completion_wizard?	boolean
enable_read_only_canvas_creation_account?	boolean
enable_toc_open_by_default?	boolean
enable_v_trusted_js_in_html?	boolean
enable_wizard_add_group?	boolean
enable_wizard_preview_button?	boolean
locks_polling_interval?	number
presentation_tools_frameless?	boolean
scribble_file_renderer?	"image" | "pdfjs" | "pspdfkit"
shared_link?	object
shared_link.communication_templates_by_lang?	Record<string, { body: string; subject: string; }>
shared_link.disable_rep_changing_allow_download?	boolean
shared_link.email_disclaimer?	string
shared_link.initial_allow_download?	boolean
shared_link.logo_style?	Record<string, any>
shared_link.logo_url?	string
shared_link.title?	string
shared_link.valid_until_options?	object[]
use_canvas_exit_confirmation?	boolean
use_linkable_in_catalogiq?	boolean

canvases_route_order?

optional canvases_route_order?: number

content_browser_route_order?

optional content_browser_route_order?: number

content_recommendation?

optional content_recommendation?: object

Name	Type
match_rules?	ContentMatchRule[]

convert_pptx_to_html?

optional convert_pptx_to_html?: boolean

convert_pptx_to_html_default_value?

optional convert_pptx_to_html_default_value?: boolean

create_canvas_default_name_fn?

optional create_canvas_default_name_fn?: string

default_pdf_page_dimensions?

optional default_pdf_page_dimensions?: object

Name	Type
height?	number | string
print_scale?	number
width?	number | string

default_presentation_fullscreen_mode?

optional default_presentation_fullscreen_mode?: FullscreenMode

disable_browser_search_context?

optional disable_browser_search_context?: boolean

disable_core_canvas_metadata?

optional disable_core_canvas_metadata?: boolean

disable_postcall?

optional disable_postcall?: boolean

display_metadata_filters_in_modal?

optional display_metadata_filters_in_modal?: boolean

enable_account_only_meeting_notes?

optional enable_account_only_meeting_notes?: boolean

enable_account_widgets?

optional enable_account_widgets?: boolean

enable_admin_asset_manager?

optional enable_admin_asset_manager?: boolean

enable_content_rating_in_call?

optional enable_content_rating_in_call?: boolean

enable_crm_privacy_mode?

optional enable_crm_privacy_mode?: boolean

enable_custom_folder_order?

optional enable_custom_folder_order?: boolean

enable_download_original_file_in_impact?

optional enable_download_original_file_in_impact?: boolean

enable_folder_description_via_name?

optional enable_folder_description_via_name?: boolean

enable_impact_web_presentation_browser_fullscreen?

optional enable_impact_web_presentation_browser_fullscreen?: boolean

enable_indicators?

optional enable_indicators?: boolean

enable_js_api_recommended_files?

optional enable_js_api_recommended_files?: boolean

enable_metadata_info_in_list_item?

optional enable_metadata_info_in_list_item?: boolean

enable_monaco_html_editor?

optional enable_monaco_html_editor?: boolean

enable_multi_language?

optional enable_multi_language?: boolean

enable_multipeer_connectivity?

optional enable_multipeer_connectivity?: boolean

enable_ppt_converter_in_canvas_templates?

optional enable_ppt_converter_in_canvas_templates?: boolean

enable_pptx_to_sections_conversion_in_upload?

optional enable_pptx_to_sections_conversion_in_upload?: boolean

enable_presentation_annotations?

optional enable_presentation_annotations?: boolean

enable_quick_filters_for_search_metadata_filters?

optional enable_quick_filters_for_search_metadata_filters?: boolean

enable_search_filter_with_suggestions?

optional enable_search_filter_with_suggestions?: boolean

enable_search_with_suggestions?

optional enable_search_with_suggestions?: boolean

enable_slotty_ui_asset_manager?

optional enable_slotty_ui_asset_manager?: boolean

enable_speaker_notes?

optional enable_speaker_notes?: boolean

enable_syncbox?

optional enable_syncbox?: boolean

enable_thumbnails_for_templates_and_blocks?

optional enable_thumbnails_for_templates_and_blocks?: boolean

file_annotations_mode?

optional file_annotations_mode?: "admin" | "personal"

full_text_search_config?

optional full_text_search_config?: string

generate_only_sections_in_ppt_converter?

optional generate_only_sections_in_ppt_converter?: boolean

impact_show_only_saved_canvases_in_canvas_manager?

optional impact_show_only_saved_canvases_in_canvas_manager?: boolean

ios?

optional ios?: OrganizationSettings

is_meeting_bar_account_selection_disabled?

optional is_meeting_bar_account_selection_disabled?: boolean

launch_in_present_mode_on_creation?

optional launch_in_present_mode_on_creation?: boolean

lazy_load_sections?

optional lazy_load_sections?: boolean

location_prompt_message?

optional location_prompt_message?: string

location_prompt_type?

optional location_prompt_type?: "warning" | "block"

max_files_limit?

optional max_files_limit?: number

mcp?

optional mcp?: object

Name	Type
access?	"off" | "read_only" | "full"

meeting_bar_allow_attendee_edit_on_existing_events?

optional meeting_bar_allow_attendee_edit_on_existing_events?: boolean

meeting_bar_show_account_context?

optional meeting_bar_show_account_context?: "off" | "no-call-only" | "always"

meeting_bar_show_meetings?

optional meeting_bar_show_meetings?: boolean

metadata_highlight_properties?

optional metadata_highlight_properties?: MetadataHighlightProperty[]

minimum_event_duration_in_call?

optional minimum_event_duration_in_call?: number

pipe_multi_search_separator?

optional pipe_multi_search_separator?: string

postcall_event_hooks?

optional postcall_event_hooks?: object

Name	Type
on_cancel?	Record<string, string | number | boolean | null>
on_submit?	Record<string, string | number | boolean | null>

pptx_auto_convert_to_sections_mode?

optional pptx_auto_convert_to_sections_mode?: "always_skip" | "always_include" | "show_toggle"

pptx_auto_convert_to_sections_toggle_default?

optional pptx_auto_convert_to_sections_toggle_default?: boolean

presentation_history_section_metadata_keys?

optional presentation_history_section_metadata_keys?: string[]

PIT-8654 — top-level section-canvas metadata keys copied onto a section's call.presentationHistory item (and so onto postcall's presented_content), e.g. ["module_id"]. Unset or empty = sections carry no metadata. Section metadata is often tens of KB (PPTX conversion stores pptx_data_backup, slide_preview, … at the top level), so only the listed keys travel, and a section whose listed subset serializes to more than 2048 characters records none of it (slotty sectionHistoryMetadata.util.ts).

List small scalar keys only (ids, codes, short labels). The 2048 limit is per section, not per call: the history holds up to 1000 items and the whole localStorage['call'] value is rewritten on every enter/exit, so keys near the limit on a long deck grow that value toward megabytes — the quota risk PIT-3941 was reverted for.

An instance-level list REPLACES the org-level one wholesale, so read it with resolveSectionMetadataKeys from the raw org/instance settings, never through createPitcherSettings, whose lodash merge combines arrays element-wise. The ios settings overrides are not applied to this key.

preserve_account_after_call_stop?

optional preserve_account_after_call_stop?: boolean

section_thumbnail_url_transformer?

optional section_thumbnail_url_transformer?: string

sfdc?

optional sfdc?: object

Name	Type
api_version?	string
use_static_ip_proxy?	boolean

shared_link_brands?

optional shared_link_brands?: object[]

PIT-7682 — open-ended list of brands the rep can pick from when creating a shared link. Supersedes the single-value shared_link_brand_slug / canvas_dot_page_subdomain_to_use keys, which stay readable as a fallback while instances are migrated.

An instance-level list REPLACES the org-level one wholesale (that is how Django merges settings — its deep merge recurses into objects only), so never resolve it through createPitcherSettings, whose lodash merge combines arrays element-wise instead.

Per entry: id is the stable reference sent to the API as brand_id, name is the rep-facing label, and at least one of subdomain (needs one-time Rebrandly setup) or slug (self-serve) must be set or the entry is skipped. subdomain wins over slug.

Name	Type
id	string
is_default?	boolean
name?	string
slug?	string
subdomain?	string

skip_metadata_keys_in_list_item?

optional skip_metadata_keys_in_list_item?: string[]

slotty_ui_route_config?

optional slotty_ui_route_config?: object[]

Name	Type
enabled	boolean
name	string
sidebar_name?	string
type	"base" | "app"

smart_folder_rule_attributes?

optional smart_folder_rule_attributes?: SmartFolderRuleAttributes

translation_overrides?

optional translation_overrides?: TranslationOverrides

use_collection_player_as_default_file_viewer?

optional use_collection_player_as_default_file_viewer?: boolean

use_collection_player_as_default_file_viewer_for_content_extensions?

optional use_collection_player_as_default_file_viewer_for_content_extensions?: string[]

use_collection_player_as_default_file_viewer_for_original_extensions?

optional use_collection_player_as_default_file_viewer_for_original_extensions?: string[]

use_collection_player_with_annotations?

optional use_collection_player_with_annotations?: boolean

---

PaginatedData

PaginatedData<Data> = object

Type Parameters

Type Parameter
Data

Properties

count

count: number

next

next: string | null

previous

previous: string | null

results

results: Data[]

---

PaginatedFileList

PaginatedFileList = object

Properties

count

count: number

next?

optional next?: string | null

previous?

optional previous?: string | null

results

results: File[]

---

PaginatedFolderList

PaginatedFolderList = object

Properties

count

count: number

next?

optional next?: string | null

previous?

optional previous?: string | null

results

results: Folder[]

---

PaginatedMetadataTemplateList

PaginatedMetadataTemplateList = object

Properties

count

count: number

next?

optional next?: string | null

previous?

optional previous?: string | null

results

results: MetadataTemplate[]

---

PatchedCanvasUpdateRequest

PatchedCanvasUpdateRequest = object

Properties

access_type?

optional access_type?: AccessTypeEnum

account?

optional account?: AccountRequest | null

content?

optional content?: Record<string, any>

context?

optional context?: any

expires_at?

optional expires_at?: string | null

folder_id?

optional folder_id?: string | null

indicators?

optional indicators?: Record<string, any> | null

instance_id?

optional instance_id?: string

is_block?

optional is_block?: boolean

is_default?

optional is_default?: boolean

is_draft?

optional is_draft?: boolean

is_editable?

optional is_editable?: boolean

is_master?

optional is_master?: boolean

is_section?

optional is_section?: boolean

is_template?

optional is_template?: boolean

metadata?

optional metadata?: any

name?

optional name?: string

owned_by_id?

optional owned_by_id?: number | null

start_at?

optional start_at?: string | null

tags?

optional tags?: string[]

theme?

optional theme?: Record<string, any> | null

thumbnail_url?

optional thumbnail_url?: string | null

---

PiaSearchConfig

PiaSearchConfig = object

pia_search_config LD flag value — selects how PIA Search serves inference. Object-valued (not a bare boolean) so the mode can grow sibling config later without a second flag; mode is the only field today.

Properties

mode?

optional mode?: PiaSearchMode

---

PiaSearchMode

PiaSearchMode = "off" | "on_device" | "online"

How PIA Search serves inference (PIT-6863).

---

PitcherMultimediaAssetType

PitcherMultimediaAssetType = object & MultimediaPosterProvenance

Type Declaration

asset_type

asset_type: typeof MULTIMEDIA_IMG_TYPE.pitcher_asset

file

file: object

file.content_url?

optional content_url?: File["content_url"]

file.id

id: File["id"]

file.name

name: File["name"]

horizontal_alignment?

optional horizontal_alignment?: MultimediaHorizontalAlignmentOptions

poster_background_size?

optional poster_background_size?: BackgroundSize

poster_url?

optional poster_url?: string

type

type: "image" | "video"

---

Range

Range<F, T> = Exclude<Enumerate<T>, Enumerate<F>> | T

Type Parameters

Type Parameter
F extends number
T extends number

---

SelectCollectionContent

SelectCollectionContent = (payload) => Promise<{ content?: CollectionPlayer; user_action: string; }>

Parameters

Parameter	Type
payload	{ attach_to?: HTMLElement | string; initial_data?: CollectionPlayer; initial_metadata_filters?: Record<string, any>; open_settings?: CollectionSelectorProps["openSettings"]; readonly_name?: CollectionSelectorProps["readonlyName"]; }
payload.attach_to?	HTMLElement | string
payload.initial_data?	CollectionPlayer
payload.initial_metadata_filters?	Record<string, any>
payload.open_settings?	CollectionSelectorProps["openSettings"]
payload.readonly_name?	CollectionSelectorProps["readonlyName"]

Returns

Promise<{ content?: CollectionPlayer; user_action: string; }>

---

SelectedFile

SelectedFile = FolderFile & object

Type Declaration

type

type: "file"

---

SelectedPage

SelectedPage = object

Properties

file

file: object

Name	Type
id	File["id"]
name	File["name"]

id

id: string

name?

optional name?: string

page_index

page_index: number

permissions?

optional permissions?: File["permissions"]

thumbnail_url?

optional thumbnail_url?: string

type

type: "page"

---

SelectFileContent

SelectFileContent = (payload) => Promise<{ content?: (SelectedFile | SelectedPage)[]; user_action: string; }>

Parameters

Parameter	Type
payload	{ allow_converted_deck_pages?: boolean; allowed_asset_content_types?: FileContentTypeEnum[]; allowed_content_types?: FileContentTypeEnum[]; allowed_selector_types?: SelectorType[]; attach_to?: HTMLElement | string; initial_metadata_filters?: Record<string, any>; selections?: Selection[]; }
payload.allow_converted_deck_pages?	boolean
payload.allowed_asset_content_types?	FileContentTypeEnum[]
payload.allowed_content_types?	FileContentTypeEnum[]
payload.allowed_selector_types?	SelectorType[]
payload.attach_to?	HTMLElement | string
payload.initial_metadata_filters?	Record<string, any>
payload.selections?	Selection[]

Returns

Promise<{ content?: (SelectedFile | SelectedPage)[]; user_action: string; }>

---

Selection

Selection = ContentSelection | ExternalLinkSelection | AssetSelection

---

SelectorType

SelectorType = "content" | "assets" | "external_links" | "pexels_images" | "theme" | `multimedia-selector-${string}`

---

SfEvent

SfEvent = object

Properties

Account?

optional Account?: object

Name	Type
Name?	string

AccountId?

optional AccountId?: string

Description?

optional Description?: string

DurationInMinutes?

optional DurationInMinutes?: string

EndDateTime?

optional EndDateTime?: string

EventWhoIds?

optional EventWhoIds?: string[]

Id?

optional Id?: string

is_executed_condition?

optional is_executed_condition?: string

IsAllDayEvent?

optional IsAllDayEvent?: boolean

isTot?

optional isTot?: boolean

Name?

optional Name?: string

OwnerId?

optional OwnerId?: string

StartDateTime?

optional StartDateTime?: string

Subject?

optional Subject?: string

Type?

optional Type?: string

WhatCount?

optional WhatCount?: number

WhatId?

optional WhatId?: string

WhoCount?

optional WhoCount?: number

WhoId?

optional WhoId?: string

---

SharedLink

SharedLink = object

Properties

brand_fallback_applied?

optional brand_fallback_applied?: boolean

PIT-7682 - CLIENT-SET, never returned by the API. Marks a link that was re-created without the rep's chosen brand after the server rejected it, so the UI can say the pick was not applied. Set by canvas.api.ts on web and by the iOS bridge handler (brand_fallback_applied).

canvas

readonly canvas: SharedLinkCanvas

file

readonly file: Record<string, any> | null

id

readonly id: string

instance

readonly instance: SharedLinkInstance

organization

readonly organization: SharedLinkOrganization

short_url?

optional short_url?: string | null

status

readonly status: string

type

readonly type: string

url

readonly url: string

---

SharedLinkCanvas

SharedLinkCanvas = object

Properties

content?

optional content?: Record<string, any>

context?

optional context?: any

id

readonly id: string

name

name: string

sections

readonly sections: CanvasSection[]

theme?

optional theme?: Record<string, any> | null

thumbnail_url?

optional thumbnail_url?: string | null

---

SharedLinkInstance

SharedLinkInstance = object

Properties

color?

optional color?: string | null

environment

readonly environment: Record<string, any>

id

readonly id: string

logo?

optional logo?: string | null

name

name: string

settings?

optional settings?: any

---

SharedLinkOrganization

SharedLinkOrganization = object

Properties

display_name?

optional display_name?: string | null

id

id: string

metadata?

optional metadata?: any

name

name: string

settings?

optional settings?: any

---

SmartFolderRuleAttribute

SmartFolderRuleAttribute = object

Properties

accessor

accessor: string

display_name

display_name: string

name

name: string

type

type: "string" | "boolean" | "number" | "date" | "array"

---

SmartFolderRuleAttributes

SmartFolderRuleAttributes = object

Properties

canvas?

optional canvas?: SmartFolderRuleAttribute[]

canvas_templates?

optional canvas_templates?: SmartFolderRuleAttribute[]

files?

optional files?: SmartFolderRuleAttribute[]

max_sync_limit?

optional max_sync_limit?: number

section?

optional section?: SmartFolderRuleAttribute[]

sync?

optional sync?: boolean

sync_chunk_size?

optional sync_chunk_size?: number

---

SupportedLocale

SupportedLocale = "en" | "da" | "de" | "pl" | "tr" | "el" | "fr" | "es" | "th" | "ja" | "zh" | "it" | "pt" | "pt-br" | "nl"

---

TranslationOverrides

TranslationOverrides = { [K in SupportedLocale]?: Record<string, string> }

---

Translations

Translations = object

Properties

createGroup?

optional createGroup?: string

title?

optional title?: string

warningMessage?

optional warningMessage?: string

---

UpdateEnvParams

UpdateEnvParams = Pick<User, "language">

---

UpdateFolderPayload

UpdateFolderPayload = FolderUpdateRequest & object

Type Declaration

id

id: Folder["id"]

---

User

User = object

Properties

activated_at

readonly activated_at: string | null

connected_services

readonly connected_services: ConnectedService[]

connection

readonly connection: string | null

deactivated_at

readonly deactivated_at: string | null

email

readonly email: string

first_name?

optional first_name?: string

id

readonly id: number

is_active

readonly is_active: boolean

joined_date

readonly joined_date: string

language?

optional language?: string

last_login_date

readonly last_login_date: string | null

last_name?

optional last_name?: string

name

readonly name: string

Get user name without connection info - connection info is available in the 'connection' field.

picture

readonly picture: string | null

preferred_username?

optional preferred_username?: string

role?

optional role?: UserRoleEnum

tags?

optional tags?: string[] | null

timezone?

optional timezone?: string

user_properties?

readonly optional user_properties?: Record<string, unknown>

---

ValuesOf

ValuesOf<T> = T[keyof T]

Type Parameters

Type Parameter
T

Variables

_LaunchDarklyStringFlags

const _LaunchDarklyStringFlags: object

Type Declaration

batch_open_content_grid_ar_files

readonly batch_open_content_grid_ar_files: readonly ["off", "simultaneous", "swap"]

canvas_component_grouping

readonly canvas_component_grouping: readonly ["page", "page_break", "none"]

dsr_remote_script_url

readonly dsr_remote_script_url: readonly ["https://anyvalidurl.xyz", ""]

pspdfkit_client_version

readonly pspdfkit_client_version: readonly ["", "pspdfkit-web/1.14.0/nutrient-viewer.js", "pspdfkit-web/1.18.0/nutrient-viewer.js", "https://anyvalidurl.xyz"]

selectors_dnd_batch_add_style

readonly selectors_dnd_batch_add_style: readonly ["button", "buttons", "dropdown"]

sharebox_format

readonly sharebox_format: readonly ["content-grid", "content-grid-default", "collection-player-default", "collection-default"]

slotty_ui_remote_script_url

readonly slotty_ui_remote_script_url: readonly ["https://anyvalidurl.xyz", ""]

---

CLIENT_TYPE

const CLIENT_TYPE: object

Type Declaration

admin

readonly admin: "admin" = 'admin'

course

readonly course: "course" = 'course'

dsr

readonly dsr: "dsr" = 'dsr'

impact

readonly impact: "impact" = 'impact'

impactCanvasHome

readonly impactCanvasHome: "impact-canvas-home" = 'impact-canvas-home'

---

ContentGridCardShapes

const ContentGridCardShapes: object

Type Declaration

LANDSCAPE

readonly LANDSCAPE: "landscape" = 'landscape'

PORTRAIT

readonly PORTRAIT: "portrait" = 'portrait'

---

PLATFORM_TYPE

const PLATFORM_TYPE: object

Type Declaration

android

readonly android: "android" = 'android'

ios

readonly ios: "ios" = 'ios'

macos

readonly macos: "macos" = 'macos'

web

readonly web: "web" = 'web'

windows

readonly windows: "windows" = 'windows'

Functions

Function	Description
createHighLevelApi	Creates a high-level API instance and caches it. Reterns a new instance only if new options are provided.