Class Templates

Class providing methods for working with a team's own saved templates. Templates are usable as a reference or copied into new scenarios.

Index

Constructors

Methods

create delete get getBlueprint list update

Constructors

constructor

new Templates(fetch: FetchFunction): Templates
Create a new Templates instance.
Parameters
- fetch: FetchFunction
  Function for making API requests
Returns Templates
- Defined in src/endpoints/templates.ts:225

Methods

create

create(body: CreateTemplateBody): Promise<Template>
Create a new template.
Parameters
- body: CreateTemplateBody
  Parameters for the template to create
Returns Promise<Template>
Promise with the created template
- Defined in src/endpoints/templates.ts:284

delete

delete(id: number): Promise<number>
Delete a template.
Parameters
- id: number
  The template ID to delete
Returns Promise<number>
Promise with the deleted template's ID
- Defined in src/endpoints/templates.ts:313

get

get<C extends keyof Template = never>(
id: number,
options?: GetTemplateOptions<C>,
): Promise<PickColumns<Template, C>>
Get a single template by its ID.
Type Parameters
- C extends keyof Template = never
Parameters
- id: number
  The template ID
- options: GetTemplateOptions<C> = {}
  Optional parameters for field selection
Returns Promise<PickColumns<Template, C>>
Promise with the template details
- Defined in src/endpoints/templates.ts:256

getBlueprint

getBlueprint(
id: number,
options?: GetTemplateBlueprintOptions,
): Promise<TemplateBlueprintEnvelope>
Get the blueprint (scenario definition) for a template by its ID.
Parameters
- id: number
  The template ID
- options: GetTemplateBlueprintOptions = {}
  Optional parameters, e.g. whether the blueprint is being fetched for use
Returns Promise<TemplateBlueprintEnvelope>
Promise with the full blueprint envelope
- Defined in src/endpoints/templates.ts:273

list

list<C extends keyof Template = never>(
options?: ListTemplatesOptions<C>,
): Promise<PickColumns<Template, C>[]>
List templates, optionally scoped to a team and filtered by apps used or public status.
Type Parameters
- C extends keyof Template = never
Parameters
- options: ListTemplatesOptions<C> = {}
  Optional parameters for filtering and pagination
Returns Promise<PickColumns<Template, C>[]>
Promise with the list of templates
- Defined in src/endpoints/templates.ts:234

update

update(id: number, body: UpdateTemplateBody): Promise<Template>
Update a template.
Parameters
- id: number
  The template ID to update
- body: UpdateTemplateBody
  Parameters to update in the template
Returns Promise<Template>
Promise with the updated template
- Defined in src/endpoints/templates.ts:299