PDFGeneratorAPI.TemplatesApi

All URIs are relative to https://us1.pdfgeneratorapi.com/api/v4

Method	HTTP request	Description
copyTemplate	POST /templates/{templateId}/copy	Copy template
createTemplate	POST /templates	Create template
deleteTemplate	DELETE /templates/{templateId}	Delete template
getTemplate	GET /templates/{templateId}	Get template
getTemplateData	GET /templates/{templateId}/data	Get template data fields
getTemplateSchema	GET /templates/schema	Get schema
getTemplates	GET /templates	Get templates
importTemplate	POST /templates/import	Import template
openEditor	POST /templates/{templateId}/editor	Open editor
updateTemplate	PUT /templates/{templateId}	Update template
validateTemplate	POST /templates/validate	Validate template

copyTemplate

InlineObject16 copyTemplate(template_id, opts)

Copy template

Creates a copy of a template to the workspace specified in authentication parameters.

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let template_id = 19375; // Number | Template unique identifier
let opts = {
  'copy_template_request': new PDFGeneratorAPI.CopyTemplateRequest() // CopyTemplateRequest | 
};
apiInstance.copyTemplate(template_id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
template_id	Number	Template unique identifier
copy_template_request	CopyTemplateRequest		[optional]

Return type

InlineObject16

Authorization

JSONWebTokenAuth

HTTP request headers

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

createTemplate

InlineObject16 createTemplate(template_definition_new)

Create template

Creates a new template. If template configuration is not specified in the request body then an empty template is created. Template is placed to the workspace specified in authentication params. Template configuration must be sent in the request body.

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let template_definition_new = new PDFGeneratorAPI.TemplateDefinitionNew(); // TemplateDefinitionNew | Template configuration
apiInstance.createTemplate(template_definition_new, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
template_definition_new	TemplateDefinitionNew	Template configuration

Return type

InlineObject16

Authorization

JSONWebTokenAuth

HTTP request headers

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

deleteTemplate

deleteTemplate(template_id)

Delete template

Deletes the template from workspace

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let template_id = 19375; // Number | Template unique identifier
apiInstance.deleteTemplate(template_id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
template_id	Number	Template unique identifier

Return type

null (empty response body)

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTemplate

InlineObject16 getTemplate(template_id)

Get template

Returns template configuration

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let template_id = 19375; // Number | Template unique identifier
apiInstance.getTemplate(template_id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
template_id	Number	Template unique identifier

Return type

InlineObject16

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTemplateData

InlineObject2 getTemplateData(template_id)

Get template data fields

Returns all data fields used in the template. Returns structured JSON data that can be used to check which data fields are used in template or autogenerate sample data.

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let template_id = 19375; // Number | Template unique identifier
apiInstance.getTemplateData(template_id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
template_id	Number	Template unique identifier

Return type

InlineObject2

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTemplateSchema

Object getTemplateSchema()

Get schema

Returns Template JSON Schema which defines the structure of the Template Definition.

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
apiInstance.getTemplateSchema((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTemplates

InlineObject4 getTemplates(opts)

Get templates

Returns a list of templates available for the authenticated workspace

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let opts = {
  'name': "name_example", // String | Filter template by name
  'tags': "tags_example", // String | Filter template by tags
  'access': "private", // String | Filter template by access type. No values returns all templates. private - returns only private templates, organization - returns only organization templates.
  'page': 1, // Number | Pagination: page to return
  'per_page': 20 // Number | Pagination: How many records to return per page
};
apiInstance.getTemplates(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
name	String	Filter template by name	[optional]
tags	String	Filter template by tags	[optional]
access	String	Filter template by access type. No values returns all templates. private - returns only private templates, organization - returns only organization templates.	[optional] [default to '']
page	Number	Pagination: page to return	[optional] [default to 1]
per_page	Number	Pagination: How many records to return per page	[optional] [default to 15]

Return type

InlineObject4

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

importTemplate

InlineObject16 importTemplate(import_template_request)

Import template

Creates a template from existing PDF

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let import_template_request = new PDFGeneratorAPI.ImportTemplateRequest(); // ImportTemplateRequest | Import a PDF via URL or base64 string as template
apiInstance.importTemplate(import_template_request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
import_template_request	ImportTemplateRequest	Import a PDF via URL or base64 string as template

Return type

InlineObject16

Authorization

JSONWebTokenAuth

HTTP request headers

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

openEditor

InlineObject3 openEditor(template_id, open_editor_request)

Open editor

Returns an unique URL which you can use to redirect your user to the editor from your application or use the generated URL as iframe source to show the editor within your application. When using iframe, make sure that your browser allows third-party cookies.

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let template_id = 19375; // Number | Template unique identifier
let open_editor_request = new PDFGeneratorAPI.OpenEditorRequest(); // OpenEditorRequest | 
apiInstance.openEditor(template_id, open_editor_request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
template_id	Number	Template unique identifier
open_editor_request	OpenEditorRequest

Return type

InlineObject3

Authorization

JSONWebTokenAuth

HTTP request headers

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

updateTemplate

InlineObject16 updateTemplate(template_id, template_definition_new)

Update template

Updates template configuration. The template configuration for pages and layout must be complete as the entire configuration is replaced and not merged.

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let template_id = 19375; // Number | Template unique identifier
let template_definition_new = new PDFGeneratorAPI.TemplateDefinitionNew(); // TemplateDefinitionNew | Template configuration
apiInstance.updateTemplate(template_id, template_definition_new, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
template_id	Number	Template unique identifier
template_definition_new	TemplateDefinitionNew	Template configuration

Return type

InlineObject16

Authorization

JSONWebTokenAuth

HTTP request headers

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

validateTemplate

InlineObject1 validateTemplate(template_definition_new)

Validate template

Validates if the provided template configuration matches the template JSON schema.

Example

import PDFGeneratorAPI from 'pdf-generator-api-client';
let defaultClient = PDFGeneratorAPI.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: JSONWebTokenAuth
let JSONWebTokenAuth = defaultClient.authentications['JSONWebTokenAuth'];
JSONWebTokenAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new PDFGeneratorAPI.TemplatesApi();
let template_definition_new = new PDFGeneratorAPI.TemplateDefinitionNew(); // TemplateDefinitionNew | Template configuration
apiInstance.validateTemplate(template_definition_new, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
template_definition_new	TemplateDefinitionNew	Template configuration

Return type

InlineObject1

Authorization

JSONWebTokenAuth

HTTP request headers

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

FilesExpand file tree

TemplatesApi.md

Latest commit

History

TemplatesApi.md

File metadata and controls

PDFGeneratorAPI.TemplatesApi

copyTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

createTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

getTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

getTemplateData

Example

Parameters

Return type

Authorization

HTTP request headers

getTemplateSchema

Example

Parameters

Return type

Authorization

HTTP request headers

getTemplates

Example

Parameters

Return type

Authorization

HTTP request headers

importTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

openEditor

Example

Parameters

Return type

Authorization

HTTP request headers

updateTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

validateTemplate

Example

Parameters

Return type

Authorization

HTTP request headers