Interface: PackDefinition¶
Defined in: types.ts:1852
Deprecated¶
use #PackVersionDefinition
The legacy complete definition of a Pack including un-versioned metadata. This should only be used by legacy pack implementations.
Extends¶
Properties¶
category?¶
optionalcategory:PackCategory
Defined in: types.ts:1858
defaultAuthentication?¶
optionaldefaultAuthentication:Authentication
Defined in: types.ts:1753
If specified, the user must provide personal authentication credentials before using the pack.
Inherited from¶
PackVersionDefinition.defaultAuthentication
description¶
description:
string
Defined in: types.ts:1856
exampleImages?¶
optionalexampleImages:string[]
Defined in: types.ts:1860
exampleVideoIds?¶
optionalexampleVideoIds:string[]
Defined in: types.ts:1861
formats?¶
optionalformats:Format[]
Defined in: types.ts:1794
Definitions of this pack's column formats. See Format.
Inherited from¶
formulaNamespace?¶
optionalformulaNamespace:string
Defined in: types.ts:1782
Deprecated¶
Inherited from¶
PackVersionDefinition.formulaNamespace
formulas?¶
optionalformulas:Formula[]
Defined in: types.ts:1790
Definitions of this pack's formulas. See Formula.
Note that button actions are also defined here. Buttons are simply formulas
with isAction: true.
Inherited from¶
PackVersionDefinition.formulas
id¶
id:
number
Defined in: types.ts:1853
isSystem?¶
optionalisSystem:boolean
Defined in: types.ts:1868
Whether this is a pack that will be used internally and not exposed directly to users.
logoPath¶
logoPath:
string
Defined in: types.ts:1859
minimumFeatureSet?¶
optionalminimumFeatureSet:FeatureSet
Defined in: types.ts:1862
name¶
name:
string
Defined in: types.ts:1854
networkDomains?¶
optionalnetworkDomains:string[]
Defined in: types.ts:1775
Any domain(s) to which this pack makes fetcher requests. The domains this pack connects to must be declared up front here, both to clearly communicate to users what a pack is capable of connecting to, and for security reasons. These network domains are enforced at execution time: any fetcher request to a domain not listed here will be rejected.
Only one network domain is allowed by default. If your pack has needs to connect to multiple domains contact support for approval.
Inherited from¶
PackVersionDefinition.networkDomains
permissionsDescription?¶
optionalpermissionsDescription:string
Defined in: types.ts:1857
quotas?¶
optionalquotas:Partial<{Basic:Quota;Enterprise:Quota;Pro:Quota;Team:Quota; }>
Defined in: types.ts:1863
rateLimits?¶
optionalrateLimits:RateLimits
Defined in: types.ts:1864
shortDescription¶
shortDescription:
string
Defined in: types.ts:1855
skillEntrypoints?¶
optionalskillEntrypoints:SkillEntrypoints
Defined in: types.ts:1833
Mapping of skills to entrypoints that the pack agent can be invoked from.
Inherited from¶
PackVersionDefinition.skillEntrypoints
skills?¶
optionalskills:Skill[]
Defined in: types.ts:1802
Definitions of skills that can be executed within this pack.
Inherited from¶
syncTables?¶
optionalsyncTables:SyncTable[]
Defined in: types.ts:1798
Definitions of this pack's sync tables. See SyncTable.
Inherited from¶
PackVersionDefinition.syncTables
systemConnectionAuthentication?¶
optionalsystemConnectionAuthentication:SystemAuthentication
Defined in: types.ts:1758
If specified, this pack requires system credentials to be set up via the admin console in order to work when no explicit connection is specified by the user.
Inherited from¶
PackVersionDefinition.systemConnectionAuthentication
version¶
version:
string
Defined in: types.ts:1749
The semantic version of the pack. This must be valid semantic version of the form 1, 1.2, or 1.2.3.
When uploading a pack version, the semantic version must be greater than any previously uploaded version.