@epilot/sdk 2.20.25 → 2.20.27

package/dist/{document.d-DN37pjdx.d.ts → document.d-B0zC-R8x.d.ts}

@@ -1,8 +1,6 @@
 import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
 
 /* Auto-copied from document-client */
-/* eslint-disable */
-
 
 
 declare namespace Components {
@@ -303,9 +301,10 @@ declare namespace Components {
          * - 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.
+         * - TEMPLATE_NOT_FOUND - Template file was not found in S3. This indicates the template was likely deleted.
          *
          */
-        export type ErrorCode = "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT";
+        export type ErrorCode = "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT" | "TEMPLATE_NOT_FOUND";
         export interface ErrorOutput {
             /**
              * Error message
@@ -317,6 +316,7 @@ declare namespace Components {
              * - 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.
+             * - TEMPLATE_NOT_FOUND - Template file was not found in S3. This indicates the template was likely deleted.
              *
              */
             ErrorCode;
@@ -395,6 +395,75 @@ declare namespace Components {
              */
             key: string;
         }
+        /**
+         * A single template syntax problem, and the repair proposed for it
+         */
+        export interface TemplateIssue {
+            /**
+             * Problem kind. Reuses docxtemplater's error vocabulary where one exists
+             * (`unopened_tag`, `unclosed_tag`, `duplicate_open_tag`, `duplicate_close_tag`), plus
+             * `malformed_tag` for single-brace placeholders and `typographic_characters` for
+             * editor-substituted characters inside an otherwise valid tag.
+             *
+             * example:
+             * unopened_tag
+             */
+            id?: string;
+            /**
+             * Zip part the problem was found in
+             * example:
+             * xl/sharedStrings.xml
+             */
+            file?: string;
+            /**
+             * Where the user can find it — a cell reference for spreadsheets, a part label
+             * (`Document body`, `Header 1`, `Slide 3`) otherwise.
+             *
+             * example:
+             * Tabelle1!N4
+             */
+            location?: string;
+            /**
+             * The offending text with surrounding context
+             * example:
+             * …Datum: {system.date}} Unterschrift…
+             */
+            context?: string;
+            /**
+             * Why the template parser rejects it
+             * example:
+             * The tag is missing an opening brace.
+             */
+            explanation?: string;
+            /**
+             * Whether the proposed repair was applied to the fixed copy
+             * example:
+             * true
+             */
+            fixable?: boolean;
+            /**
+             * How sure we are that the repair is what the author meant
+             */
+            confidence?: "high" | "medium" | "low";
+            /**
+             * The repair rule that produced `after`
+             * example:
+             * balance_opening_delimiter
+             */
+            rule?: string;
+            /**
+             * The text as it is in the template
+             * example:
+             * {system.date}}
+             */
+            before?: string;
+            /**
+             * The text as it would be in the fixed copy
+             * example:
+             * {{system.date}}
+             */
+            after?: string;
+        }
         /**
          * Template Settings for document generation
          */
@@ -466,10 +535,81 @@ declare namespace Components {
             /**
              * The file entity id, used when persisting a new template version with updated settings
              * example:
-             * 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p
+             * 123e4567-e89b-12d3-a456-426614174000
              */
             file_entity_id?: string; // uuid
         }
+        export interface TemplateValidationRequest {
+            /**
+             * Input template document
+             */
+            template_document: {
+                /**
+                 * Document original filename, used to name the fixed copy
+                 * example:
+                 * Umzugsmeldung.xlsx
+                 */
+                filename?: string;
+                s3ref: S3Reference;
+            };
+            /**
+             * Attempt to produce a hotfixed copy of the template. When false, the template is only
+             * inspected and no file is written.
+             *
+             */
+            fix?: boolean;
+            /**
+             * How far the hotfix may go:
+             * - safe - only repairs where the author's intent is unambiguous from the syntax
+             *   (unbalanced or duplicated braces, editor-substituted characters inside a tag).
+             * - aggressive - additionally promotes single-brace placeholders such as `{contact.name}`
+             *   to `{{contact.name}}`. These are common in customer templates but indistinguishable
+             *   from prose that uses braces, so they are reported with `confidence: low`.
+             *
+             */
+            fix_level?: "safe" | "aggressive";
+        }
+        export interface TemplateValidationResponse {
+            /**
+             * Whether the template compiled cleanly before any repair was attempted
+             * example:
+             * false
+             */
+            valid?: boolean;
+            /**
+             * Whether a corrected copy of the template could be produced
+             * example:
+             * true
+             */
+            fixed?: boolean;
+            /**
+             * Everything found in the template, whether or not it could be repaired
+             */
+            issues?: /* A single template syntax problem, and the repair proposed for it */ TemplateIssue[];
+            /**
+             * Parser errors that remain after the hotfix (or the original errors when nothing was
+             * fixed). Empty when the template is valid.
+             *
+             */
+            unresolved_errors?: /* DocxTemplater error detail */ DocxTemplaterErrorDetail[];
+            /**
+             * The corrected copy, for the user to review and accept. Absent when no repair was
+             * applied. The original template is left untouched.
+             *
+             */
+            fixed_document?: {
+                s3ref?: S3Reference;
+                /**
+                 * example:
+                 * Umzugsmeldung (fixed).xlsx
+                 */
+                filename?: string;
+                /**
+                 * Short-lived download link for the corrected copy
+                 */
+                preview_url?: string; // uri
+            };
+        }
     }
 }
 declare namespace Paths {
@@ -482,13 +622,33 @@ declare namespace Paths {
     namespace GenerateDocumentV2 {
         namespace Parameters {
             export type JobId = string;
+            /**
+             * - partial_generation: Generates a partial document for user validation before final generation
+             * - full_generation: Completes the entire document generation process in one step
+             *
+             */
             export type Mode = "partial_generation" | "full_generation";
+            /**
+             * - open: Preview URL opens the file directly in browser
+             * - download: Preview URL triggers a download of the file
+             *
+             */
             export type PreviewMode = "open" | "download";
         }
         export interface QueryParameters {
             job_id?: Parameters.JobId;
-            mode?: Parameters.Mode;
-            preview_mode?: Parameters.PreviewMode;
+            mode?: /**
+             * - partial_generation: Generates a partial document for user validation before final generation
+             * - full_generation: Completes the entire document generation process in one step
+             *
+             */
+            Parameters.Mode;
+            preview_mode?: /**
+             * - open: Preview URL opens the file directly in browser
+             * - download: Preview URL triggers a download of the file
+             *
+             */
+            Parameters.PreviewMode;
         }
         export type RequestBody = Components.Schemas.DocumentGenerationV2Request;
         namespace Responses {
@@ -504,6 +664,15 @@ declare namespace Paths {
             export type $415 = Components.Schemas.ErrorOutput;
         }
     }
+    namespace ValidateTemplate {
+        export type RequestBody = Components.Schemas.TemplateValidationRequest;
+        namespace Responses {
+            export type $200 = Components.Schemas.TemplateValidationResponse;
+            export type $403 = Components.Schemas.ErrorOutput;
+            export type $413 = Components.Schemas.ErrorOutput;
+            export type $415 = Components.Schemas.ErrorOutput;
+        }
+    }
 }
 
 
@@ -561,6 +730,33 @@ interface OperationMethods {
     data?: Paths.ConvertDocument.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ConvertDocument.Responses.$200>
+  /**
+   * validateTemplate - validateTemplate
+   * 
+   * Validates a document template's variable syntax and, optionally, proposes a hotfixed copy of it.
+   * 
+   * The endpoint compiles the template with docxtemplater's core parser (the xlsx module for
+   * spreadsheets), so a delimiter or tag error reported here is one generation would fail on.
+   * Failures specific to the image or HTML modules are not covered. Every problem it can repair
+   * unambiguously — a missing brace, an extra brace, a smart quote or a non-breaking space that
+   * Word substituted inside a tag — is applied to a **copy** of the template, which is uploaded
+   * and returned as `fixed_document`.
+   * 
+   * The original template is never modified. Accepting the fix is an explicit, separate step:
+   * the caller shows the user `issues` (each with its `before`/`after`), lets them download
+   * `fixed_document.preview_url`, and only then replaces the template.
+   * 
+   * Supported input document types:
+   * - .docx, .docm, .dotx
+   * - .xlsx, .xlsm
+   * - .pptx
+   * 
+   */
+  'validateTemplate'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.ValidateTemplate.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ValidateTemplate.Responses.$200>
 }
 
 interface PathsDictionary {
@@ -623,6 +819,35 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ConvertDocument.Responses.$200>
   }
+  ['/v2/templates:validate']: {
+    /**
+     * validateTemplate - validateTemplate
+     * 
+     * Validates a document template's variable syntax and, optionally, proposes a hotfixed copy of it.
+     * 
+     * The endpoint compiles the template with docxtemplater's core parser (the xlsx module for
+     * spreadsheets), so a delimiter or tag error reported here is one generation would fail on.
+     * Failures specific to the image or HTML modules are not covered. Every problem it can repair
+     * unambiguously — a missing brace, an extra brace, a smart quote or a non-breaking space that
+     * Word substituted inside a tag — is applied to a **copy** of the template, which is uploaded
+     * and returned as `fixed_document`.
+     * 
+     * The original template is never modified. Accepting the fix is an explicit, separate step:
+     * the caller shows the user `issues` (each with its `before`/`after`), lets them download
+     * `fixed_document.preview_url`, and only then replaces the template.
+     * 
+     * Supported input document types:
+     * - .docx, .docm, .dotx
+     * - .xlsx, .xlsm
+     * - .pptx
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.ValidateTemplate.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ValidateTemplate.Responses.$200>
+  }
 }
 
 type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -643,6 +868,9 @@ type InternalErrorDetails = Components.Schemas.InternalErrorDetails;
 type InvalidCustomVariableErrorDetail = Components.Schemas.InvalidCustomVariableErrorDetail;
 type InvalidCustomVariableErrorDetails = Components.Schemas.InvalidCustomVariableErrorDetails;
 type S3Reference = Components.Schemas.S3Reference;
+type TemplateIssue = Components.Schemas.TemplateIssue;
 type TemplateSettings = Components.Schemas.TemplateSettings;
+type TemplateValidationRequest = Components.Schemas.TemplateValidationRequest;
+type TemplateValidationResponse = Components.Schemas.TemplateValidationResponse;
 
-export { type Client as C, type DocumentGenerationV2Request as D, type ErrorCode as E, type InternalErrorDetail as I, type OperationMethods as O, Paths as P, type S3Reference as S, type TemplateSettings as T, Components as a, type PathsDictionary as b, type ConvertDocumentRequest as c, type ConvertDocumentResponse as d, type DocumentGenerationV2Response as e, type DocumentMetaRequest as f, type DocumentMetaResponse as g, type DocxTemplaterErrorDetail as h, type DocxTemplaterErrorDetails as i, type ErrorOutput as j, type InternalErrorDetails as k, type InvalidCustomVariableErrorDetail as l, type InvalidCustomVariableErrorDetails as m };
+export { type Client as C, type DocumentGenerationV2Request as D, type ErrorCode as E, type InternalErrorDetail as I, type OperationMethods as O, Paths as P, type S3Reference as S, type TemplateIssue as T, Components as a, type PathsDictionary as b, type ConvertDocumentRequest as c, type ConvertDocumentResponse as d, type DocumentGenerationV2Response as e, type DocumentMetaRequest as f, type DocumentMetaResponse as g, type DocxTemplaterErrorDetail as h, type DocxTemplaterErrorDetails as i, type ErrorOutput as j, type InternalErrorDetails as k, type InvalidCustomVariableErrorDetail as l, type InvalidCustomVariableErrorDetails as m, type TemplateSettings as n, type TemplateValidationRequest as o, type TemplateValidationResponse as p };

package/dist/index.cjs

@@ -96,7 +96,7 @@ var _chunkBEJ5NIRCcjs = require('./chunk-BEJ5NIRC.cjs');
 var _chunk7P7O46NWcjs = require('./chunk-7P7O46NW.cjs');
 
 
-var _chunkM56QQHVAcjs = require('./chunk-M56QQHVA.cjs');
+var _chunkE2EHXQRPcjs = require('./chunk-E2EHXQRP.cjs');
 
 
 var _chunkAWJHA3GGcjs = require('./chunk-AWJHA3GG.cjs');
@@ -161,7 +161,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
 
 
 
-var _chunkPZ4TXAF5cjs = require('./chunk-PZ4TXAF5.cjs');
+var _chunkUM53DB6Tcjs = require('./chunk-UM53DB6T.cjs');
 
 
 var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -228,7 +228,7 @@ var resolveClient = (params) => {
   }
   if (!entry.instance) {
     const definition = entry.loader();
-    entry.instance = _chunkPZ4TXAF5cjs.createApiClient.call(void 0, {
+    entry.instance = _chunkUM53DB6Tcjs.createApiClient.call(void 0, {
       definition,
       token: state.token,
       headers: state.globalHeaders,
@@ -261,7 +261,7 @@ var resetAllClients = (registry) => {
 };
 
 // src/apis/_registry.ts
-var expandDef = (mod) => _chunkPZ4TXAF5cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+var expandDef = (mod) => _chunkUM53DB6Tcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
@@ -356,7 +356,7 @@ var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
     name: "document",
-    loader: () => expandDef(_chunkM56QQHVAcjs.require_document_runtime.call(void 0, ))
+    loader: () => expandDef(_chunkE2EHXQRPcjs.require_document_runtime.call(void 0, ))
   });
   registerApi({
     registry,
@@ -609,9 +609,9 @@ var createSDK = () => {
       const available = [...registry.keys()].join(", ");
       throw new Error(`Unknown API: "${name}". Available: ${available}`);
     }
-    return _chunkPZ4TXAF5cjs.createApiHandle.call(void 0, {
+    return _chunkUM53DB6Tcjs.createApiHandle.call(void 0, {
       resolveClient: () => resolveClient({ registry, name, state }),
-      createClient: () => _chunkPZ4TXAF5cjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
+      createClient: () => _chunkUM53DB6Tcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
       apiName: name
     });
   };
@@ -659,9 +659,9 @@ var createSDK = () => {
           return interceptorUse;
         }
         case "help":
-          return (apiName) => _chunkPZ4TXAF5cjs.help.call(void 0, apiName);
+          return (apiName) => _chunkUM53DB6Tcjs.help.call(void 0, apiName);
         case "openapi":
-          return (apiName) => _chunkPZ4TXAF5cjs.openapi.call(void 0, apiName);
+          return (apiName) => _chunkUM53DB6Tcjs.openapi.call(void 0, apiName);
         case "then":
         case "catch":
         case "finally":
@@ -691,4 +691,4 @@ var epilot = createSDK();
 
 
 
-exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkPZ4TXAF5cjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkPZ4TXAF5cjs.help; exports.openapi = _chunkPZ4TXAF5cjs.openapi;
+exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkUM53DB6Tcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkUM53DB6Tcjs.help; exports.openapi = _chunkUM53DB6Tcjs.openapi;

package/dist/index.d.cts

@@ -14,14 +14,14 @@ import { C as Client$7 } from './billing.d-DA3sViEF.cjs';
 import { C as Client$8 } from './blueprint-manifest.d-B8YKYzSJ.cjs';
 import { C as Client$9 } from './calendar.d-mk-ltGpk.cjs';
 import { C as Client$a } from './chat.d-CQ5eRtNU.cjs';
-import { C as Client$b } from './configuration-hub.d-Dv41yC3b.cjs';
+import { C as Client$b } from './configuration-hub.d-DhPrjJkE.cjs';
 import { C as Client$c } from './consent.d-C2PROHhX.cjs';
 import { C as Client$d } from './customer-portal.d-DF4g7c3i.cjs';
 import { C as Client$e } from './dashboard.d-BSevFHjf.cjs';
 import { C as Client$f } from './data-governance.d-BbZ466j5.cjs';
 import { C as Client$g } from './deduplication.d-Cueh8bDD.cjs';
 import { C as Client$h } from './design.d-CYHbiaq_.cjs';
-import { C as Client$i } from './document.d-DN37pjdx.cjs';
+import { C as Client$i } from './document.d-B0zC-R8x.cjs';
 import { C as Client$j } from './email-settings.d-DViLYaOl.cjs';
 import { C as Client$k } from './email-template.d-gtQkdaXM.cjs';
 import { C as Client$l } from './entity.d-GfKqzFGA.cjs';
@@ -31,7 +31,7 @@ import { C as Client$o } from './event-catalog.d-CCE1qmBN.cjs';
 import { C as Client$p } from './file.d-DELNV63w.cjs';
 import { C as Client$q } from './iban.d-BwdiGbxi.cjs';
 import { C as Client$r } from './integration-toolkit.d--hon4GPp.cjs';
-import { C as Client$s } from './journey.d-DvwLALwc.cjs';
+import { C as Client$s } from './journey.d-Dj93v-Lw.cjs';
 import { C as Client$t } from './kanban.d-BHnSRCYW.cjs';
 import { C as Client$u } from './message.d-DwnqO-Us.cjs';
 import { C as Client$v } from './metering.d-DomHYl06.cjs';

package/dist/index.d.ts

@@ -14,14 +14,14 @@ import { C as Client$7 } from './billing.d-DA3sViEF.js';
 import { C as Client$8 } from './blueprint-manifest.d-B8YKYzSJ.js';
 import { C as Client$9 } from './calendar.d-mk-ltGpk.js';
 import { C as Client$a } from './chat.d-CQ5eRtNU.js';
-import { C as Client$b } from './configuration-hub.d-Dv41yC3b.js';
+import { C as Client$b } from './configuration-hub.d-DhPrjJkE.js';
 import { C as Client$c } from './consent.d-C2PROHhX.js';
 import { C as Client$d } from './customer-portal.d-DF4g7c3i.js';
 import { C as Client$e } from './dashboard.d-BSevFHjf.js';
 import { C as Client$f } from './data-governance.d-BbZ466j5.js';
 import { C as Client$g } from './deduplication.d-Cueh8bDD.js';
 import { C as Client$h } from './design.d-CYHbiaq_.js';
-import { C as Client$i } from './document.d-DN37pjdx.js';
+import { C as Client$i } from './document.d-B0zC-R8x.js';
 import { C as Client$j } from './email-settings.d-DViLYaOl.js';
 import { C as Client$k } from './email-template.d-gtQkdaXM.js';
 import { C as Client$l } from './entity.d-GfKqzFGA.js';
@@ -31,7 +31,7 @@ import { C as Client$o } from './event-catalog.d-CCE1qmBN.js';
 import { C as Client$p } from './file.d-DELNV63w.js';
 import { C as Client$q } from './iban.d-BwdiGbxi.js';
 import { C as Client$r } from './integration-toolkit.d--hon4GPp.js';
-import { C as Client$s } from './journey.d-DvwLALwc.js';
+import { C as Client$s } from './journey.d-Dj93v-Lw.js';
 import { C as Client$t } from './kanban.d-BHnSRCYW.js';
 import { C as Client$u } from './message.d-DwnqO-Us.js';
 import { C as Client$v } from './metering.d-DomHYl06.js';

package/dist/index.js

@@ -96,7 +96,7 @@ import {
 } from "./chunk-GAINSJUJ.js";
 import {
   require_document_runtime
-} from "./chunk-75EI2Q64.js";
+} from "./chunk-LR7LGGRU.js";
 import {
   require_email_settings_runtime
 } from "./chunk-7HQ3GMYQ.js";
@@ -161,7 +161,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-X742W7MI.js";
+} from "./chunk-W5PMKQO7.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";