@pdf-generator/client@1.0

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @pdf-generator/client --save

Next, try it out.

import {
  Configuration,
  DocumentsApi,
} from '@pdf-generator/client';
import type { DeleteRequest } 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 DocumentsApi(config);

  const body = {
    // string | Document filename
    lookup: lookup_example,
  } satisfies DeleteRequest;

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

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

Documentation

API Endpoints

All URIs are relative to /api

Class	Method	HTTP request	Description
DocumentsApi	_delete	DELETE /documents/{lookup}	Delete document(s) by name
DocumentsApi	list	GET /documents	List documents
DocumentsApi	retrieve	GET /documents/{key}	Download a document
PdfTemplateApi	create	POST /pdf-template	Create a template
PdfTemplateApi	createFiles	POST /pdf-template/{id}/files	Upload template files
PdfTemplateApi	createFromZip	POST /pdf-template/from-zip	Create template from ZIP
PdfTemplateApi	deleteFile	DELETE /pdf-template/{id}/files/{file}	Delete a file
PdfTemplateApi	destroy	DELETE /pdf-template/{lookup}	Delete a template
PdfTemplateApi	exportAsZip	GET /pdf-template/{id}/files/export-zip	Export template files as ZIP archive
PdfTemplateApi	getContextSchema	GET /pdf-template/{id}/context-schema	Get JSON schema for template variables
PdfTemplateApi	getDefaultValues	GET /pdf-template/{id}/variables-default-values	Get template variable default values
PdfTemplateApi	getFileContent	GET /pdf-template/{id}/files/content/{file}	Download file content
PdfTemplateApi	getFileType	GET /pdf-template/{id}/files/type/{file}	Get file type
PdfTemplateApi	importZip	POST /pdf-template/{id}/files/import-zip	Upload files from ZIP
PdfTemplateApi	list	GET /pdf-template	List templates
PdfTemplateApi	listFiles	GET /pdf-template/{id}/files	List template files
PdfTemplateApi	render	POST /pdf-template/render	Render a PDF
PdfTemplateApi	replace	PUT /pdf-template/{lookup}	Replace a template
PdfTemplateApi	retrieve	GET /pdf-template/{lookup}	Get a template
PdfTemplateApi	update	PATCH /pdf-template/{lookup}	Update a template
TemplateVariablesApi	create	POST /template-variables	Create a variable
TemplateVariablesApi	destroy	DELETE /template-variables/{lookup}	Delete a variable
TemplateVariablesApi	list	GET /template-variables	List template variables
TemplateVariablesApi	replace	PUT /template-variables/{lookup}	Replace a variable
TemplateVariablesApi	retrieve	GET /template-variables/{lookup}	Get a variable
TemplateVariablesApi	update	PATCH /template-variables/{lookup}	Update a variable

Models

Authorization

Authentication schemes defined for the API:

api-key

Type: API key
API key parameter name: Api-Key
Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 1.0
Package version: 1.0
Generator version: 7.23.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish