Skip to content

docgenTemplate.md

Latest commit

 

History

History
183 lines (116 loc) · 4.91 KB

docgenTemplate.md

File metadata and controls

183 lines (116 loc) · 4.91 KB

DocgenTemplateManager

Create Box Doc Gen template

Marks a file as a Box Doc Gen template.

This operation is performed by calling function createDocgenTemplateV2025R0.

See the endpoint docs at API Reference.

await client.docgenTemplate.createDocgenTemplateV2025R0({
  file: new FileReferenceV2025R0({ id: file.id }),
} satisfies DocGenTemplateCreateRequestV2025R0);

Arguments

  • requestBody DocGenTemplateCreateRequestV2025R0
    • Request body of createDocgenTemplateV2025R0 method
  • optionalsInput CreateDocgenTemplateV2025R0OptionalsInput

Returns

This function returns a value of type DocGenTemplateBaseV2025R0.

The file which has now been marked as a Box Doc Gen template.

List Box Doc Gen templates

Lists Box Doc Gen templates on which the user is a collaborator.

This operation is performed by calling function getDocgenTemplatesV2025R0.

See the endpoint docs at API Reference.

await client.docgenTemplate.getDocgenTemplatesV2025R0();

Arguments

  • queryParams GetDocgenTemplatesV2025R0QueryParams
    • Query parameters of getDocgenTemplatesV2025R0 method
  • headersInput GetDocgenTemplatesV2025R0HeadersInput
    • Headers of getDocgenTemplatesV2025R0 method
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type DocGenTemplatesV2025R0.

Returns a collection of templates.

Delete Box Doc Gen template

Unmarks file as Box Doc Gen template.

This operation is performed by calling function deleteDocgenTemplateByIdV2025R0.

See the endpoint docs at API Reference.

await client.docgenTemplate.deleteDocgenTemplateByIdV2025R0(
  createdDocgenTemplate.file!.id,
);

Arguments

  • templateId string
    • ID of the file which will no longer be marked as a Box Doc Gen template. Example: "123"
  • optionalsInput DeleteDocgenTemplateByIdV2025R0OptionalsInput

Returns

This function returns a value of type undefined.

Returns an empty response when a file is no longer marked as a Box Doc Gen template.

Get Box Doc Gen template by ID

Lists details of a specific Box Doc Gen template.

This operation is performed by calling function getDocgenTemplateByIdV2025R0.

See the endpoint docs at API Reference.

await client.docgenTemplate.getDocgenTemplateByIdV2025R0(
  createdDocgenTemplate.file!.id,
);

Arguments

  • templateId string
    • The ID of a Box Doc Gen template. Example: 123
  • optionalsInput GetDocgenTemplateByIdV2025R0OptionalsInput

Returns

This function returns a value of type DocGenTemplateV2025R0.

Returns a template.

List all Box Doc Gen template tags in template

Lists all tags in a Box Doc Gen template.

This operation is performed by calling function getDocgenTemplateTagsV2025R0.

See the endpoint docs at API Reference.

await client.docgenTemplate.getDocgenTemplateTagsV2025R0(
  fetchedDocgenTemplate.file!.id,
);

Arguments

  • templateId string
    • ID of template. Example: 123
  • optionalsInput GetDocgenTemplateTagsV2025R0OptionalsInput

Returns

This function returns a value of type DocGenTagsV2025R0.

A list of document generation template tags.Processing tags for the file.

Get list of all Box Doc Gen jobs for template

Lists the users jobs which use this template.

This operation is performed by calling function getDocgenTemplateJobByIdV2025R0.

See the endpoint docs at API Reference.

await client.docgenTemplate.getDocgenTemplateJobByIdV2025R0(
  fetchedDocgenTemplate.file!.id,
);

Arguments

  • templateId string
    • Id of template to fetch jobs for. Example: 123
  • optionalsInput GetDocgenTemplateJobByIdV2025R0OptionalsInput

Returns

This function returns a value of type DocGenJobsV2025R0.

A single Box Doc Gen template.