@epilot/document-client 0.16.0 → 0.16.2

package/dist/client.d.ts

@@ -0,0 +1,2 @@
+import { Client } from './openapi';
+export declare const getClient: () => Client;

package/dist/client.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClient = void 0;
+var openapi_client_axios_1 = __importDefault(require("openapi-client-axios"));
+var definition_1 = __importDefault(require("./definition"));
+var getClient = function () {
+    var api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
+    return api.initSync();
+};
+exports.getClient = getClient;
+//# sourceMappingURL=client.js.map

package/dist/definition.d.ts

@@ -0,0 +1,3 @@
+import type { Document } from 'openapi-client-axios';
+declare const _default: Document;
+export default _default;

package/dist/definition.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={914:function(e,t,r){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=o(r(534));t.default=n.default},534:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"Document API","version":"1.0.0","description":"A document generation API that allows you to generate documents from templates with variables.\\n\\n[Feature Documentation](https://docs.epilot.io/docs/files/document-generation)\\n"},"tags":[{"name":"Documents","description":"Document Generation"}],"security":[{"EpilotAuth":[]}],"paths":{"/v2/documents:meta":{"post":{"operationId":"getTemplateMeta","summary":"getTemplateMeta","description":"Get metadata for a document template\\n\\nSupported input document types:\\n- .docx\\n","tags":["Documents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentMetaRequest"}}}},"responses":{"200":{"description":"Document metadata","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentMetaResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOutput"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOutput"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorOutput"}}}}}}},"/v2/documents:generate":{"post":{"operationId":"generateDocumentV2","summary":"generateDocumentV2","description":"Generates documents from templates with variables.\\n\\nSupported document types as input:\\n- .docx\\n- .ics\\n\\nSupported document types as output:\\n- .pdf\\n- .docx but limited to only text based variables\\n- .ics\\n\\nUses [Template Variable API](https://docs.epilot.io/api/template-variables) to replace variables in the input document.\\n","parameters":[{"in":"query","name":"job_id","description":"Job ID for tracking the status of document generation action","schema":{"type":"string"}},{"in":"query","name":"mode","description":"Type of mode used for document generation flow:\\n- partial_generation will have a intermediate step for users to validate and replace the variable values before generating the final document.\\n- full_generation, goes through all the steps for the full generation of final document\\n","schema":{"type":"string","enum":["partial_generation","full_generation"],"default":"full_generation"}},{"in":"query","name":"preview_mode","description":"Type of mode used for document generation preview:\\n- open - preview_url provides a link to open the file in a browser\\n- download - preview_url provides a link to download the file\\n","schema":{"type":"string","enum":["open","download"],"default":"open"}}],"tags":["Documents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentGenerationV2Request"}}}},"responses":{"200":{"description":"Generated document output","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentGenerationV2Response"}}}}}}},"/v2/documents:convert":{"post":{"operationId":"convertDocument","summary":"convertDocument","description":"Converts a document to a different format.\\n\\nSupported input document types:\\n- .docx\\n\\nSupported output document types:\\n- .pdf\\n","tags":["Documents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentRequest"}}}},"responses":{"200":{"description":"Conversion job output","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentResponse"}}}}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"}},"schemas":{"S3Reference":{"type":"object","properties":{"bucket":{"type":"string","example":"document-api-prod"},"key":{"type":"string","example":"uploads/my-template.pdf"}},"required":["bucket","key"]},"ErrorOutput":{"type":"object","properties":{"error_message":{"description":"Error message","type":"string"},"error_code":{"$ref":"#/components/schemas/ErrorCode"},"error_details":{"anyOf":[{"$ref":"#/components/schemas/InvalidCustomVariableErrorDetails"},{"$ref":"#/components/schemas/InternalErrorDetails"},{"$ref":"#/components/schemas/DocxTemplaterErrorDetails"}]}}},"InvalidCustomVariableErrorDetails":{"description":"Error details for invalid custom variables. This error will appear under \'PARSE_ERROR\' error code.","type":"array","items":{"$ref":"#/components/schemas/InvalidCustomVariableErrorDetail"}},"InvalidCustomVariableErrorDetail":{"type":"object","additionalProperties":true,"properties":{"explanation":{"description":"Explanation for the error","type":"string"},"context":{"description":"Context for the error","type":"object","properties":{"invalid_variables":{"description":"List of invalid variables","type":"array","items":{"type":"object","description":"Invalid variable","properties":{"variable":{"description":"Variable name","type":"string"},"error":{"description":"Explanation for the error","type":"string"}}}}}}}},"InternalErrorDetails":{"description":"Error details for internal error. This error will appear under \'INTERNAL_ERROR\' error code.","type":"array","items":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/InternalErrorDetail"}}}},"InternalErrorDetail":{"type":"object","description":"Internal error detail","properties":{"name":{"description":"Name of the error","type":"string"},"message":{"description":"Error message","type":"string"},"stack":{"description":"Stack trace","type":"string"},"cause":{"description":"Cause of the error","type":"string"}}},"DocxTemplaterErrorDetails":{"description":"Error details for DocxTemplater error. This error will appear under \'PARSE_ERROR\' error code.\\nSee https://docxtemplater.com/docs/errors/#error-schema for more details.\\n","type":"array","items":{"$ref":"#/components/schemas/DocxTemplaterErrorDetail"}},"DocxTemplaterErrorDetail":{"type":"object","description":"DocxTemplater error detail","properties":{"id":{"description":"Id of the error","type":"string"},"context":{"description":"Context of the error","type":"string"},"explanation":{"description":"Explanation of the error","type":"string"}}},"ErrorCode":{"description":"Error codes for document generation:\\n- PARSE_ERROR - Error while parsing the document. Normally related with a bad template using the wrong DocxTemplater syntax.\\n- DOC_TO_PDF_CONVERT_ERROR - Error while converting the document to PDF. Normally related with a ConvertAPI failure.\\n- INTERNAL_ERROR - Internal error. Please contact support.\\n- INVALID_TEMPLATE_FORMAT - Invalid template format (only .docx is supported). This can happen due to a bad word file or an unsupported file extension.\\n","type":"string","enum":["PARSE_ERROR","DOC_TO_PDF_CONVERT_ERROR","INTERNAL_ERROR","INVALID_TEMPLATE_FORMAT"]},"TemplateSettings":{"type":"object","description":"Template Settings for document generation","properties":{"custom_margins":{"description":"Custom margins for the document","type":"object","properties":{"top":{"description":"Top margin in cm","type":"number","example":2.54},"bottom":{"description":"Bottom margin in cm","type":"number","example":2.54}}},"suggested_margins":{"description":"Suggested margins for the document","type":"object","properties":{"top":{"description":"Top margin in cm","type":"number","example":2.54},"bottom":{"description":"Bottom margin in cm","type":"number","example":2.54}}},"display_margin_guidelines":{"description":"Display margin guidelines (applicable to partial generation only)","type":"boolean","example":true},"enable_data_table_margin_autofix":{"description":"Enable data table margin autofix","type":"boolean","example":false},"template_with_datatable":{"description":"A flag that indicates whether the template has 1 or more data tables in it","type":"boolean","example":false},"enabled_template_settings_persistence":{"description":"Enables the persistance of template settings","type":"boolean","example":false},"misconfigured_margins":{"description":"An indication that the page margins are misconfigured","type":"boolean","example":false},"file_entity_id":{"description":"The file entity id, used when persisting a new template version with updated settings","type":"string","format":"uuid","example":"1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p"}}},"DocumentMetaRequest":{"type":"object","properties":{"template_document":{"description":"Input template document","type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}}}}},"DocumentMetaResponse":{"type":"object","properties":{"page_margins":{"description":"Page margins for the document","type":"object","properties":{"top":{"description":"Top margin in cm","type":"number","example":2.54},"bottom":{"description":"Bottom margin in cm","type":"number","example":2.54},"left":{"description":"Left margin in cm","type":"number","example":2.54},"right":{"description":"Right margin in cm","type":"number","example":2.54},"header":{"description":"Header margin in cm","type":"number","example":2.54},"footer":{"description":"Footer margin in cm","type":"number","example":2.54}}},"variables":{"description":"List of variables in the document","type":"array","items":{"type":"string"},"example":["order.billing_contact.0.salutation","order.billing_contact.0.title","order_table","stayHardStatic","opportunity[attribute_name]","opportunity[\\"attribute_name\\"]","opportunity.[attribute_name]","attribute_name","opportunities.0.attribute_name","opportunities[0].attribute_name","contact.opportunities[0].attribute_name","opportunities[Primary].attribute_name"]}}},"DocumentGenerationV2Request":{"type":"object","properties":{"template_document":{"description":"Input template document","type":"object","properties":{"filename":{"type":"string","description":"Document original filename","example":"my-template-{{order.order_number}}.docx"},"s3ref":{"$ref":"#/components/schemas/S3Reference"}}},"context_entity_id":{"type":"string","format":"uuid","description":"Entity to use for variable context","example":"bcd0aab9-b544-42b0-8bfb-6d449d02eacc"},"user_id":{"type":"string","description":"User Id for variable context","example":100321},"language":{"type":"string","description":"Language","example":"en"},"variable_payload":{"description":"Custom values for variables in the template. Takes the higher precedence than others.","type":"object","properties":{"additionalProperties":{"type":"string"}}},"context_data":{"description":"Custom values for variables in the template. Takes the higher precedence than others.","type":"object","properties":{"additionalProperties":{"type":"string"}}},"template_settings":{"$ref":"#/components/schemas/TemplateSettings"}},"required":["template_document"]},"DocumentGenerationV2Response":{"type":"object","properties":{"job_id":{"type":"string","format":"uuid"},"job_status":{"description":"Status of the job","type":"string","enum":["STARTED","PROCESSING","SUCCESS","FAILED"]},"message":{"description":"A message explaining the progress","type":"string"},"ics_output":{"type":"object","properties":{"output_document":{"type":"object","properties":{"filename":{"description":"Generated document filename for ICS","type":"string","example":"my-appointment-OR-001.ics"},"s3ref":{"$ref":"#/components/schemas/S3Reference"}},"example":{"s3ref":{"bucket":"document-api-preview-prod","key":"preview/my-appointment.ics"}}}}},"pdf_output":{"type":"object","properties":{"preview_url":{"description":"Pre-signed S3 GET URL for PDF preview","type":"string","example":"https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf"},"output_document":{"type":"object","properties":{"filename":{"description":"Generated document filename for PDF","type":"string","example":"my-template-OR-001.pdf"},"s3ref":{"$ref":"#/components/schemas/S3Reference"}},"example":{"s3ref":{"bucket":"document-api-preview-prod","key":"preview/my-template.pdf"}}}}},"docx_output":{"type":"object","properties":{"preview_url":{"description":"Pre-signed S3 GET URL for DOCX preview","type":"string","example":"https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx"},"output_document":{"type":"object","properties":{"filename":{"description":"Generated document filename for DOCX","type":"string","example":"my-template-OR-001.docx"},"s3ref":{"$ref":"#/components/schemas/S3Reference"}},"example":{"s3ref":{"bucket":"document-api-preview-prod","key":"preview/my-template.docx"}}}}},"error_output":{"$ref":"#/components/schemas/ErrorOutput"},"variable_payload":{"description":"List of variables and its corresponding replaced values from the document template","type":"object","properties":{"additionalProperties":{"type":"string"}}},"template_settings":{"$ref":"#/components/schemas/TemplateSettings"}}},"ConvertDocumentRequest":{"type":"object","properties":{"input_document":{"description":"Input document","type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}},"required":["s3ref"]},"output_format":{"description":"Output format of the document","type":"string","enum":["pdf"]},"output_filename":{"description":"Filename of the output document (optional)","type":"string","example":"converted.pdf"}},"required":["input_document","output_format"]},"ConvertDocumentResponse":{"type":"object","properties":{"output_document":{"type":"object","properties":{"preview_url":{"description":"Pre-signed URL for the converted document","type":"string","example":"https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/converted.pdf"},"s3ref":{"$ref":"#/components/schemas/S3Reference"}}}}}}},"servers":[{"url":"https://document.sls.epilot.io"}]}')}},t={},r=function r(o){var n=t[o];if(void 0!==n)return n.exports;var i=t[o]={exports:{}};return e[o].call(i.exports,i,i.exports,r),i.exports}(914),o=exports;for(var n in r)o[n]=r[n];r.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})();

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './openapi';
+export type { OpenAPIClient, OpenAPIClientAxios, Document } from 'openapi-client-axios';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+//# sourceMappingURL=index.js.map

package/dist/openapi.d.ts

@@ -0,0 +1,615 @@
+/* eslint-disable */
+
+import type {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios';
+
+declare namespace Components {
+    namespace Schemas {
+        export interface ConvertDocumentRequest {
+            /**
+             * Input document
+             */
+            input_document: {
+                s3ref: S3Reference;
+            };
+            /**
+             * Output format of the document
+             */
+            output_format: "pdf";
+            /**
+             * Filename of the output document (optional)
+             * example:
+             * converted.pdf
+             */
+            output_filename?: string;
+        }
+        export interface ConvertDocumentResponse {
+            output_document?: {
+                /**
+                 * Pre-signed URL for the converted document
+                 * example:
+                 * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/converted.pdf
+                 */
+                preview_url?: string;
+                s3ref?: S3Reference;
+            };
+        }
+        export interface DocumentGenerationV2Request {
+            /**
+             * Input template document
+             */
+            template_document: {
+                /**
+                 * Document original filename
+                 * example:
+                 * my-template-{{order.order_number}}.docx
+                 */
+                filename?: string;
+                s3ref?: S3Reference;
+            };
+            /**
+             * Entity to use for variable context
+             * example:
+             * bcd0aab9-b544-42b0-8bfb-6d449d02eacc
+             */
+            context_entity_id?: string; // uuid
+            /**
+             * User Id for variable context
+             * example:
+             * 100321
+             */
+            user_id?: string;
+            /**
+             * Language
+             * example:
+             * en
+             */
+            language?: string;
+            /**
+             * Custom values for variables in the template. Takes the higher precedence than others.
+             */
+            variable_payload?: {
+                additionalProperties?: string;
+            };
+            /**
+             * Custom values for variables in the template. Takes the higher precedence than others.
+             */
+            context_data?: {
+                additionalProperties?: string;
+            };
+            template_settings?: /* Template Settings for document generation */ TemplateSettings;
+        }
+        export interface DocumentGenerationV2Response {
+            job_id?: string; // uuid
+            /**
+             * Status of the job
+             */
+            job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED";
+            /**
+             * A message explaining the progress
+             */
+            message?: string;
+            ics_output?: {
+                /**
+                 * example:
+                 * {
+                 *   "s3ref": {
+                 *     "bucket": "document-api-preview-prod",
+                 *     "key": "preview/my-appointment.ics"
+                 *   }
+                 * }
+                 */
+                output_document?: {
+                    /**
+                     * Generated document filename for ICS
+                     * example:
+                     * my-appointment-OR-001.ics
+                     */
+                    filename?: string;
+                    s3ref?: S3Reference;
+                };
+            };
+            pdf_output?: {
+                /**
+                 * Pre-signed S3 GET URL for PDF preview
+                 * example:
+                 * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf
+                 */
+                preview_url?: string;
+                /**
+                 * example:
+                 * {
+                 *   "s3ref": {
+                 *     "bucket": "document-api-preview-prod",
+                 *     "key": "preview/my-template.pdf"
+                 *   }
+                 * }
+                 */
+                output_document?: {
+                    /**
+                     * Generated document filename for PDF
+                     * example:
+                     * my-template-OR-001.pdf
+                     */
+                    filename?: string;
+                    s3ref?: S3Reference;
+                };
+            };
+            docx_output?: {
+                /**
+                 * Pre-signed S3 GET URL for DOCX preview
+                 * example:
+                 * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx
+                 */
+                preview_url?: string;
+                /**
+                 * example:
+                 * {
+                 *   "s3ref": {
+                 *     "bucket": "document-api-preview-prod",
+                 *     "key": "preview/my-template.docx"
+                 *   }
+                 * }
+                 */
+                output_document?: {
+                    /**
+                     * Generated document filename for DOCX
+                     * example:
+                     * my-template-OR-001.docx
+                     */
+                    filename?: string;
+                    s3ref?: S3Reference;
+                };
+            };
+            error_output?: ErrorOutput;
+            /**
+             * List of variables and its corresponding replaced values from the document template
+             */
+            variable_payload?: {
+                additionalProperties?: string;
+            };
+            template_settings?: /* Template Settings for document generation */ TemplateSettings;
+        }
+        export interface DocumentMetaRequest {
+            /**
+             * Input template document
+             */
+            template_document?: {
+                s3ref?: S3Reference;
+            };
+        }
+        export interface DocumentMetaResponse {
+            /**
+             * Page margins for the document
+             */
+            page_margins?: {
+                /**
+                 * Top margin in cm
+                 * example:
+                 * 2.54
+                 */
+                top?: number;
+                /**
+                 * Bottom margin in cm
+                 * example:
+                 * 2.54
+                 */
+                bottom?: number;
+                /**
+                 * Left margin in cm
+                 * example:
+                 * 2.54
+                 */
+                left?: number;
+                /**
+                 * Right margin in cm
+                 * example:
+                 * 2.54
+                 */
+                right?: number;
+                /**
+                 * Header margin in cm
+                 * example:
+                 * 2.54
+                 */
+                header?: number;
+                /**
+                 * Footer margin in cm
+                 * example:
+                 * 2.54
+                 */
+                footer?: number;
+            };
+            /**
+             * List of variables in the document
+             * example:
+             * [
+             *   "order.billing_contact.0.salutation",
+             *   "order.billing_contact.0.title",
+             *   "order_table",
+             *   "stayHardStatic",
+             *   "opportunity[attribute_name]",
+             *   "opportunity[\"attribute_name\"]",
+             *   "opportunity.[attribute_name]",
+             *   "attribute_name",
+             *   "opportunities.0.attribute_name",
+             *   "opportunities[0].attribute_name",
+             *   "contact.opportunities[0].attribute_name",
+             *   "opportunities[Primary].attribute_name"
+             * ]
+             */
+            variables?: string[];
+        }
+        /**
+         * DocxTemplater error detail
+         */
+        export interface DocxTemplaterErrorDetail {
+            /**
+             * Id of the error
+             */
+            id?: string;
+            /**
+             * Context of the error
+             */
+            context?: string;
+            /**
+             * Explanation of the error
+             */
+            explanation?: string;
+        }
+        /**
+         * Error details for DocxTemplater error. This error will appear under 'PARSE_ERROR' error code.
+         * See https://docxtemplater.com/docs/errors/#error-schema for more details.
+         *
+         */
+        export type DocxTemplaterErrorDetails = /* DocxTemplater error detail */ DocxTemplaterErrorDetail[];
+        /**
+         * Error codes for document generation:
+         * - PARSE_ERROR - Error while parsing the document. Normally related with a bad template using the wrong DocxTemplater syntax.
+         * - DOC_TO_PDF_CONVERT_ERROR - Error while converting the document to PDF. Normally related with a ConvertAPI failure.
+         * - INTERNAL_ERROR - Internal error. Please contact support.
+         * - INVALID_TEMPLATE_FORMAT - Invalid template format (only .docx is supported). This can happen due to a bad word file or an unsupported file extension.
+         *
+         */
+        export type ErrorCode = "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT";
+        export interface ErrorOutput {
+            /**
+             * Error message
+             */
+            error_message?: string;
+            error_code?: /**
+             * Error codes for document generation:
+             * - PARSE_ERROR - Error while parsing the document. Normally related with a bad template using the wrong DocxTemplater syntax.
+             * - DOC_TO_PDF_CONVERT_ERROR - Error while converting the document to PDF. Normally related with a ConvertAPI failure.
+             * - INTERNAL_ERROR - Internal error. Please contact support.
+             * - INVALID_TEMPLATE_FORMAT - Invalid template format (only .docx is supported). This can happen due to a bad word file or an unsupported file extension.
+             *
+             */
+            ErrorCode;
+            error_details?: /* Error details for invalid custom variables. This error will appear under 'PARSE_ERROR' error code. */ InvalidCustomVariableErrorDetails | /* Error details for internal error. This error will appear under 'INTERNAL_ERROR' error code. */ InternalErrorDetails | /**
+             * Error details for DocxTemplater error. This error will appear under 'PARSE_ERROR' error code.
+             * See https://docxtemplater.com/docs/errors/#error-schema for more details.
+             *
+             */
+            DocxTemplaterErrorDetails;
+        }
+        /**
+         * Internal error detail
+         */
+        export interface InternalErrorDetail {
+            /**
+             * Name of the error
+             */
+            name?: string;
+            /**
+             * Error message
+             */
+            message?: string;
+            /**
+             * Stack trace
+             */
+            stack?: string;
+            /**
+             * Cause of the error
+             */
+            cause?: string;
+        }
+        /**
+         * Error details for internal error. This error will appear under 'INTERNAL_ERROR' error code.
+         */
+        export type InternalErrorDetails = {
+            items?: /* Internal error detail */ InternalErrorDetail;
+        }[];
+        export interface InvalidCustomVariableErrorDetail {
+            [name: string]: any;
+            /**
+             * Explanation for the error
+             */
+            explanation?: string;
+            /**
+             * Context for the error
+             */
+            context?: {
+                /**
+                 * List of invalid variables
+                 */
+                invalid_variables?: {
+                    /**
+                     * Variable name
+                     */
+                    variable?: string;
+                    /**
+                     * Explanation for the error
+                     */
+                    error?: string;
+                }[];
+            };
+        }
+        /**
+         * Error details for invalid custom variables. This error will appear under 'PARSE_ERROR' error code.
+         */
+        export type InvalidCustomVariableErrorDetails = InvalidCustomVariableErrorDetail[];
+        export interface S3Reference {
+            /**
+             * example:
+             * document-api-prod
+             */
+            bucket: string;
+            /**
+             * example:
+             * uploads/my-template.pdf
+             */
+            key: string;
+        }
+        /**
+         * Template Settings for document generation
+         */
+        export interface TemplateSettings {
+            /**
+             * Custom margins for the document
+             */
+            custom_margins?: {
+                /**
+                 * Top margin in cm
+                 * example:
+                 * 2.54
+                 */
+                top?: number;
+                /**
+                 * Bottom margin in cm
+                 * example:
+                 * 2.54
+                 */
+                bottom?: number;
+            };
+            /**
+             * Suggested margins for the document
+             */
+            suggested_margins?: {
+                /**
+                 * Top margin in cm
+                 * example:
+                 * 2.54
+                 */
+                top?: number;
+                /**
+                 * Bottom margin in cm
+                 * example:
+                 * 2.54
+                 */
+                bottom?: number;
+            };
+            /**
+             * Display margin guidelines (applicable to partial generation only)
+             * example:
+             * true
+             */
+            display_margin_guidelines?: boolean;
+            /**
+             * Enable data table margin autofix
+             * example:
+             * false
+             */
+            enable_data_table_margin_autofix?: boolean;
+            /**
+             * A flag that indicates whether the template has 1 or more data tables in it
+             * example:
+             * false
+             */
+            template_with_datatable?: boolean;
+            /**
+             * Enables the persistance of template settings
+             * example:
+             * false
+             */
+            enabled_template_settings_persistence?: boolean;
+            /**
+             * An indication that the page margins are misconfigured
+             * example:
+             * false
+             */
+            misconfigured_margins?: boolean;
+            /**
+             * The file entity id, used when persisting a new template version with updated settings
+             * example:
+             * 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p
+             */
+            file_entity_id?: string; // uuid
+        }
+    }
+}
+declare namespace Paths {
+    namespace ConvertDocument {
+        export type RequestBody = Components.Schemas.ConvertDocumentRequest;
+        namespace Responses {
+            export type $200 = Components.Schemas.ConvertDocumentResponse;
+        }
+    }
+    namespace GenerateDocumentV2 {
+        namespace Parameters {
+            export type JobId = string;
+            export type Mode = "partial_generation" | "full_generation";
+            export type PreviewMode = "open" | "download";
+        }
+        export interface QueryParameters {
+            job_id?: Parameters.JobId;
+            mode?: Parameters.Mode;
+            preview_mode?: Parameters.PreviewMode;
+        }
+        export type RequestBody = Components.Schemas.DocumentGenerationV2Request;
+        namespace Responses {
+            export type $200 = Components.Schemas.DocumentGenerationV2Response;
+        }
+    }
+    namespace GetTemplateMeta {
+        export type RequestBody = Components.Schemas.DocumentMetaRequest;
+        namespace Responses {
+            export type $200 = Components.Schemas.DocumentMetaResponse;
+            export type $400 = Components.Schemas.ErrorOutput;
+            export type $403 = Components.Schemas.ErrorOutput;
+            export type $415 = Components.Schemas.ErrorOutput;
+        }
+    }
+}
+
+export interface OperationMethods {
+  /**
+   * getTemplateMeta - getTemplateMeta
+   * 
+   * Get metadata for a document template
+   * 
+   * Supported input document types:
+   * - .docx
+   * 
+   */
+  'getTemplateMeta'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.GetTemplateMeta.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetTemplateMeta.Responses.$200>
+  /**
+   * generateDocumentV2 - generateDocumentV2
+   * 
+   * Generates documents from templates with variables.
+   * 
+   * Supported document types as input:
+   * - .docx
+   * - .ics
+   * 
+   * Supported document types as output:
+   * - .pdf
+   * - .docx but limited to only text based variables
+   * - .ics
+   * 
+   * Uses [Template Variable API](https://docs.epilot.io/api/template-variables) to replace variables in the input document.
+   * 
+   */
+  'generateDocumentV2'(
+    parameters?: Parameters<Paths.GenerateDocumentV2.QueryParameters> | null,
+    data?: Paths.GenerateDocumentV2.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GenerateDocumentV2.Responses.$200>
+  /**
+   * convertDocument - convertDocument
+   * 
+   * Converts a document to a different format.
+   * 
+   * Supported input document types:
+   * - .docx
+   * 
+   * Supported output document types:
+   * - .pdf
+   * 
+   */
+  'convertDocument'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.ConvertDocument.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ConvertDocument.Responses.$200>
+}
+
+export interface PathsDictionary {
+  ['/v2/documents:meta']: {
+    /**
+     * getTemplateMeta - getTemplateMeta
+     * 
+     * Get metadata for a document template
+     * 
+     * Supported input document types:
+     * - .docx
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.GetTemplateMeta.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetTemplateMeta.Responses.$200>
+  }
+  ['/v2/documents:generate']: {
+    /**
+     * generateDocumentV2 - generateDocumentV2
+     * 
+     * Generates documents from templates with variables.
+     * 
+     * Supported document types as input:
+     * - .docx
+     * - .ics
+     * 
+     * Supported document types as output:
+     * - .pdf
+     * - .docx but limited to only text based variables
+     * - .ics
+     * 
+     * Uses [Template Variable API](https://docs.epilot.io/api/template-variables) to replace variables in the input document.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<Paths.GenerateDocumentV2.QueryParameters> | null,
+      data?: Paths.GenerateDocumentV2.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GenerateDocumentV2.Responses.$200>
+  }
+  ['/v2/documents:convert']: {
+    /**
+     * convertDocument - convertDocument
+     * 
+     * Converts a document to a different format.
+     * 
+     * Supported input document types:
+     * - .docx
+     * 
+     * Supported output document types:
+     * - .pdf
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.ConvertDocument.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ConvertDocument.Responses.$200>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
+
+export type ConvertDocumentRequest = Components.Schemas.ConvertDocumentRequest;
+export type ConvertDocumentResponse = Components.Schemas.ConvertDocumentResponse;
+export type DocumentGenerationV2Request = Components.Schemas.DocumentGenerationV2Request;
+export type DocumentGenerationV2Response = Components.Schemas.DocumentGenerationV2Response;
+export type DocumentMetaRequest = Components.Schemas.DocumentMetaRequest;
+export type DocumentMetaResponse = Components.Schemas.DocumentMetaResponse;
+export type DocxTemplaterErrorDetail = Components.Schemas.DocxTemplaterErrorDetail;
+export type DocxTemplaterErrorDetails = Components.Schemas.DocxTemplaterErrorDetails;
+export type ErrorCode = Components.Schemas.ErrorCode;
+export type ErrorOutput = Components.Schemas.ErrorOutput;
+export type InternalErrorDetail = Components.Schemas.InternalErrorDetail;
+export type InternalErrorDetails = Components.Schemas.InternalErrorDetails;
+export type InvalidCustomVariableErrorDetail = Components.Schemas.InvalidCustomVariableErrorDetail;
+export type InvalidCustomVariableErrorDetails = Components.Schemas.InvalidCustomVariableErrorDetails;
+export type S3Reference = Components.Schemas.S3Reference;
+export type TemplateSettings = Components.Schemas.TemplateSettings;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/document-client",
-  "version": "0.16.0",
+  "version": "0.16.2",
   "description": "API Client for epilot document API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",