Skip to content

docgen.md

Latest commit

 

History

History
148 lines (103 loc) · 4.27 KB

docgen.md

File metadata and controls

148 lines (103 loc) · 4.27 KB

DocgenManager

Get Box Doc Gen job by ID

Get details of the Box Doc Gen job.

This operation is performed by calling function get_docgen_job_by_id_v2025_r0.

See the endpoint docs at API Reference.

client.docgen.get_docgen_job_by_id_v2025_r0(docgen_job_item_from_list.id)

Arguments

  • job_id str
    • Box Doc Gen job ID. Example: 123
  • box_version BoxVersionHeaderV2025R0
    • Version header.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 get_docgen_jobs_v2025_r0.

See the endpoint docs at API Reference.

client.docgen.get_docgen_jobs_v2025_r0(limit=10000)

Arguments

  • marker Optional[str]
    • Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
  • limit Optional[int]
    • The maximum number of items to return per page.
  • box_version BoxVersionHeaderV2025R0
    • Version header.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 get_docgen_batch_job_by_id_v2025_r0.

See the endpoint docs at API Reference.

client.docgen.get_docgen_batch_job_by_id_v2025_r0(docgen_batch.id)

Arguments

  • batch_id str
    • Box Doc Gen batch ID. Example: 123
  • marker Optional[str]
    • Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
  • limit Optional[int]
    • The maximum number of items to return per page.
  • box_version BoxVersionHeaderV2025R0
    • Version header.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 create_docgen_batch_v2025_r0.

See the endpoint docs at API Reference.

client.docgen.create_docgen_batch_v2025_r0(
    FileReferenceV2025R0(id=uploaded_file_docx.id),
    "api",
    CreateDocgenBatchV2025R0DestinationFolder(id=folder.id),
    "pdf",
    [
        DocGenDocumentGenerationDataV2025R0(
            generated_file_name="test", user_input={"abc": "xyz"}
        )
    ],
)

Arguments

  • file FileReferenceV2025R0
  • file_version Optional[FileVersionBaseV2025R0]
  • input_source str
    • Source of input. The value has to be api for all the API-based document generation requests.
  • destination_folder CreateDocgenBatchV2025R0DestinationFolder
  • output_type str
    • Type of the output file.
  • document_generation_data List[DocGenDocumentGenerationDataV2025R0]
  • box_version BoxVersionHeaderV2025R0
    • Version header.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type DocGenBatchBaseV2025R0.

The created Batch ID.