PdfTemplateApi

All URIs are relative to /api

create

PdfTemplate create(createPdfTemplateDto, limit, offset, order, filter, or, expand)

Create a template

Create a new PDF template (Admin only)

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { CreateRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // CreatePdfTemplateDto
    createPdfTemplateDto: ...,
    // number (optional)
    limit: 8.14,
    // number (optional)
    offset: 8.14,
    // Array<string> (optional)
    order: ...,
    // Array<string> (optional)
    filter: ...,
    // Array<string> (optional)
    or: ...,
    // Array<string> (optional)
    expand: ...,
  } satisfies CreateRequest;

  try {
    const data = await api.create(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

PdfTemplate

Authorization

api-key

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createFiles

Array<TemplateFilesResponseDto> createFiles(id)

Upload template files

Upload HTML/CSS/JS files for a template. Send files as multipart form fields keyed by filename.

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { CreateFilesRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // string | Template ID
    id: id_example,
  } satisfies CreateFilesRequest;

  try {
    const data = await api.createFiles(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

Array<TemplateFilesResponseDto>

Authorization

api-key

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createFromZip

createFromZip(file)

Create template from ZIP

Upload a ZIP archive to create a new template. If a template.yaml is present, its whitelisted settings are applied (including the template name).

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { CreateFromZipRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // Blob | ZIP file containing template files (optional)
    file: BINARY_DATA_HERE,
  } satisfies CreateFromZipRequest;

  try {
    const data = await api.createFromZip(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

void (Empty response body)

Authorization

api-key

HTTP request headers

• Content-Type: multipart/form-data
• Accept: Not defined

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteFile

deleteFile(id, file)

Delete a file

Delete a file from a template

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { DeleteFileRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // string | Template ID
    id: id_example,
    // any | File path relative to template root
    file: ...,
  } satisfies DeleteFileRequest;

  try {
    const data = await api.deleteFile(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

void (Empty response body)

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

destroy

destroy(lookup)

Delete a template

Delete a template and all its files (Admin only)

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { DestroyRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // number
    lookup: 8.14,
  } satisfies DestroyRequest;

  try {
    const data = await api.destroy(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

void (Empty response body)

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

exportAsZip

exportAsZip(id)

Export template files as ZIP archive

Download all template files bundled as a ZIP archive. Includes a Content-Disposition header with the template name.

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { ExportAsZipRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // string | Template ID
    id: id_example,
  } satisfies ExportAsZipRequest;

  try {
    const data = await api.exportAsZip(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

void (Empty response body)

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getContextSchema

GetContextSchema200Response getContextSchema(id)

Get JSON schema for template variables

Returns the JSON schema that can be used to validate variable values for a template

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { GetContextSchemaRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // string | Template ID
    id: id_example,
  } satisfies GetContextSchemaRequest;

  try {
    const data = await api.getContextSchema(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

GetContextSchema200Response

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDefaultValues

GetDefaultValues200Response getDefaultValues(id)

Get template variable default values

Returns the default values and metadata for a template

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { GetDefaultValuesRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // string | Template ID
    id: id_example,
  } satisfies GetDefaultValuesRequest;

  try {
    const data = await api.getDefaultValues(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

GetDefaultValues200Response

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFileContent

Blob getFileContent(id, file, ifNoneMatch)

Download file content

Download a template file by path. Supports ETag-based caching.

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { GetFileContentRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // string | Template ID
    id: id_example,
    // string | File path relative to template root
    file: file_example,
    // string | ETag from previous response for conditional download (optional)
    ifNoneMatch: ifNoneMatch_example,
  } satisfies GetFileContentRequest;

  try {
    const data = await api.getFileContent(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

Blob

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: */*, application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFileType

TemplateFile getFileType(id, file)

Get file type

Get the MIME type of a template file

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { GetFileTypeRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // string | Template ID
    id: id_example,
    // any | File path relative to template root
    file: ...,
  } satisfies GetFileTypeRequest;

  try {
    const data = await api.getFileType(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

TemplateFile

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

importZip

importZip(id, file)

Upload files from ZIP

Upload a ZIP archive containing template files. Files are extracted and stored under the template.

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { ImportZipRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // string | Template ID
    id: id_example,
    // Blob | ZIP file containing template files (optional)
    file: BINARY_DATA_HERE,
  } satisfies ImportZipRequest;

  try {
    const data = await api.importZip(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

void (Empty response body)

Authorization

api-key

HTTP request headers

• Content-Type: multipart/form-data
• Accept: Not defined

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PdfTemplateListResponseDto list(limit, offset, order, filter, or, expand)

List templates

Returns a paginated list of PDF templates for the organization

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { ListRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // number (optional)
    limit: 8.14,
    // number (optional)
    offset: 8.14,
    // Array<string> (optional)
    order: ...,
    // Array<string> (optional)
    filter: ...,
    // Array<string> (optional)
    or: ...,
    // Array<string> (optional)
    expand: ...,
  } satisfies ListRequest;

  try {
    const data = await api.list(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

PdfTemplateListResponseDto

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listFiles

FileListResultDto listFiles(id, start, limit, nameFilter)

List template files

List all files for a template

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { ListFilesRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // string | Template ID
    id: id_example,
    // string | Pagination start token (optional)
    start: start_example,
    // number | Maximum number of files to return (optional)
    limit: 8.14,
    // string | Filter by filename (partial match) (optional)
    nameFilter: nameFilter_example,
  } satisfies ListFilesRequest;

  try {
    const data = await api.listFiles(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

FileListResultDto

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

render

RenderPdfResultDto render(renderPdfTemplateDto)

Render a PDF

Render a PDF from a template. Provide template ID, context variables, and optional metadata. The rendered PDF is saved and its download key is returned.

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { RenderRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // RenderPdfTemplateDto
    renderPdfTemplateDto: ...,
  } satisfies RenderRequest;

  try {
    const data = await api.render(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

RenderPdfResultDto

Authorization

api-key

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace

PdfTemplate replace(lookup, createPdfTemplateDto, limit, offset, order, filter, or, expand)

Replace a template

Fully replace a template (Admin only)

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { ReplaceRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // number
    lookup: 8.14,
    // CreatePdfTemplateDto
    createPdfTemplateDto: ...,
    // number (optional)
    limit: 8.14,
    // number (optional)
    offset: 8.14,
    // Array<string> (optional)
    order: ...,
    // Array<string> (optional)
    filter: ...,
    // Array<string> (optional)
    or: ...,
    // Array<string> (optional)
    expand: ...,
  } satisfies ReplaceRequest;

  try {
    const data = await api.replace(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

PdfTemplate

Authorization

api-key

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve

PdfTemplate retrieve(lookup, limit, offset, order, filter, or, expand)

Get a template

Get a single PDF template by ID

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { RetrieveRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // number
    lookup: 8.14,
    // number (optional)
    limit: 8.14,
    // number (optional)
    offset: 8.14,
    // Array<string> (optional)
    order: ...,
    // Array<string> (optional)
    filter: ...,
    // Array<string> (optional)
    or: ...,
    // Array<string> (optional)
    expand: ...,
  } satisfies RetrieveRequest;

  try {
    const data = await api.retrieve(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

PdfTemplate

Authorization

api-key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

PdfTemplate update(lookup, updatePdfTemplateDto, limit, offset, order, filter, or, expand)

Update a template

Partially update a template (Admin only)

Example

import {
  Configuration,
  PdfTemplateApi,
} from '@pdf-generator/client';
import type { UpdateRequest } from '@pdf-generator/client';

async function example() {
  console.log("🚀 Testing @pdf-generator/client SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: api-key
    apiKey: "YOUR API KEY",
  });
  const api = new PdfTemplateApi(config);

  const body = {
    // number
    lookup: 8.14,
    // UpdatePdfTemplateDto
    updatePdfTemplateDto: ...,
    // number (optional)
    limit: 8.14,
    // number (optional)
    offset: 8.14,
    // Array<string> (optional)
    order: ...,
    // Array<string> (optional)
    filter: ...,
    // Array<string> (optional)
    or: ...,
    // Array<string> (optional)
    expand: ...,
  } satisfies UpdateRequest;

  try {
    const data = await api.update(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Return type

PdfTemplate

Authorization

api-key

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

[Back to top] [Back to API list] [Back to Model list] [Back to README]