Skip to content

Interface: PackDefinition

Defined in: types.ts:1828

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?

optional category: PackCategory

Defined in: types.ts:1834


defaultAuthentication?

optional defaultAuthentication: Authentication

Defined in: types.ts:1729

If specified, the user must provide personal authentication credentials before using the pack.

Inherited from

PackVersionDefinition.defaultAuthentication


description

description: string

Defined in: types.ts:1832


exampleImages?

optional exampleImages: string[]

Defined in: types.ts:1836


exampleVideoIds?

optional exampleVideoIds: string[]

Defined in: types.ts:1837


formats?

optional formats: Format[]

Defined in: types.ts:1770

Definitions of this pack's column formats. See Format.

Inherited from

PackVersionDefinition.formats


formulaNamespace?

optional formulaNamespace: string

Defined in: types.ts:1758

Deprecated

Inherited from

PackVersionDefinition.formulaNamespace


formulas?

optional formulas: Formula[]

Defined in: types.ts:1766

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:1829


isSystem?

optional isSystem: boolean

Defined in: types.ts:1844

Whether this is a pack that will be used internally and not exposed directly to users.


logoPath

logoPath: string

Defined in: types.ts:1835


minimumFeatureSet?

optional minimumFeatureSet: FeatureSet

Defined in: types.ts:1838


name

name: string

Defined in: types.ts:1830


networkDomains?

optional networkDomains: string[]

Defined in: types.ts:1751

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?

optional permissionsDescription: string

Defined in: types.ts:1833


quotas?

optional quotas: Partial<{ Basic: Quota; Enterprise: Quota; Pro: Quota; Team: Quota; }>

Defined in: types.ts:1839


rateLimits?

optional rateLimits: RateLimits

Defined in: types.ts:1840


shortDescription

shortDescription: string

Defined in: types.ts:1831


skillEntrypoints?

optional skillEntrypoints: SkillEntrypoints

Defined in: types.ts:1809

Mapping of skills to entrypoints that the pack agent can be invoked from.

Inherited from

PackVersionDefinition.skillEntrypoints


skills?

optional skills: Skill[]

Defined in: types.ts:1778

Definitions of skills that can be executed within this pack.

Inherited from

PackVersionDefinition.skills


syncTables?

optional syncTables: SyncTable[]

Defined in: types.ts:1774

Definitions of this pack's sync tables. See SyncTable.

Inherited from

PackVersionDefinition.syncTables


systemConnectionAuthentication?

optional systemConnectionAuthentication: SystemAuthentication

Defined in: types.ts:1734

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:1725

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.

Inherited from

PackVersionDefinition.version