Skip to content

docgen.md

Latest commit

 

History

History
132 lines (87 loc) · 3.39 KB

docgen.md

File metadata and controls

132 lines (87 loc) · 3.39 KB

DocgenManager

Get Box Doc Gen job by ID

Get details of the Box Doc Gen job.

This operation is performed by calling function getDocgenJobByIdV2025R0.

See the endpoint docs at API Reference.

await client.docgen.getDocgenJobByIdV2025R0(docgenJobItemFromList.id);

Arguments

  • jobId string
    • Box Doc Gen job ID. Example: 123
  • optionalsInput GetDocgenJobByIdV2025R0OptionalsInput

Returns

This function returns a value of type DocGenJobV2025R0.

Details of the Box Doc Gen job.

List all Box Doc Gen jobs

Lists all Box Doc Gen jobs for a user.

This operation is performed by calling function getDocgenJobsV2025R0.

See the endpoint docs at API Reference.

await client.docgen.getDocgenJobsV2025R0({
  limit: 10000,
} satisfies GetDocgenJobsV2025R0QueryParams);

Arguments

  • queryParams GetDocgenJobsV2025R0QueryParams
    • Query parameters of getDocgenJobsV2025R0 method
  • headersInput GetDocgenJobsV2025R0HeadersInput
    • Headers of getDocgenJobsV2025R0 method
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type DocGenJobsFullV2025R0.

A list of Box Doc Gen jobs.

Get Box Doc Gen jobs by batch ID

Lists Box Doc Gen jobs in a batch.

This operation is performed by calling function getDocgenBatchJobByIdV2025R0.

See the endpoint docs at API Reference.

await client.docgen.getDocgenBatchJobByIdV2025R0(docgenBatch.id);

Arguments

  • batchId string
    • Box Doc Gen batch ID. Example: 123
  • optionalsInput GetDocgenBatchJobByIdV2025R0OptionalsInput

Returns

This function returns a value of type DocGenJobsV2025R0.

Returns a list of Box Doc Gen jobs in a Box Doc Gen batch.

Generate document using Box Doc Gen template

Generates a document using a Box Doc Gen template.

This operation is performed by calling function createDocgenBatchV2025R0.

See the endpoint docs at API Reference.

await client.docgen.createDocgenBatchV2025R0({
  file: new FileReferenceV2025R0({ id: uploadedFileDocx.id }),
  inputSource: 'api',
  destinationFolder: new DocGenBatchCreateRequestV2025R0DestinationFolderField({
    id: folder.id,
  }),
  outputType: 'pdf',
  documentGenerationData: [
    {
      generatedFileName: 'test',
      userInput: { ['abc']: 'xyz' },
    } satisfies DocGenDocumentGenerationDataV2025R0,
  ],
} satisfies DocGenBatchCreateRequestV2025R0);

Arguments

  • requestBody DocGenBatchCreateRequestV2025R0
    • Request body of createDocgenBatchV2025R0 method
  • optionalsInput CreateDocgenBatchV2025R0OptionalsInput

Returns

This function returns a value of type DocGenBatchBaseV2025R0.

The created Batch ID.