@epilot/sdk 2.20.25 → 2.20.27

package/dist/{journey.d-DvwLALwc.d.ts → journey.d-Dj93v-Lw.d.ts}

@@ -22,6 +22,39 @@ declare namespace Components {
              */
             label?: string;
         }
+        /**
+         * One link a customer clicks. `label` and `description` are each either a
+         * plain string or one string per language, deciding that independently.
+         * Mirrors environments-api's `LinkFields`.
+         *
+         */
+        export interface EnvironmentLink {
+            url: string;
+            label: string | {
+                [name: string]: string;
+            };
+            description?: string | {
+                [name: string]: string;
+            };
+        }
+        /**
+         * A list of links, served under this service's own `List<Link>` type
+         * token. environments-api types the variable `List` and declares the
+         * element type inside the value; journey-api composes the two so a
+         * consumer needs only one discriminant.
+         *
+         */
+        export interface EnvironmentLinkList {
+            itemType: "Link";
+            fallbackLanguage?: string;
+            items: /**
+             * One link a customer clicks. `label` and `description` are each either a
+             * plain string or one string per language, deciding that independently.
+             * Mirrors environments-api's `LinkFields`.
+             *
+             */
+            EnvironmentLink[];
+        }
         export interface EnvironmentMap {
             fallbackLanguage?: string;
             options: EnvironmentMapEntry[];
@@ -990,8 +1023,15 @@ declare namespace Components {
         export interface JourneyEnvironmentResponse {
             items: {
                 datasourceId: string;
-                type: "Text" | "Number" | "Boolean" | "Map";
-                value: string | number | boolean | EnvironmentMap;
+                type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>";
+                value: string | number | boolean | EnvironmentMap | /**
+                 * A list of links, served under this service's own `List<Link>` type
+                 * token. environments-api types the variable `List` and declares the
+                 * element type inside the value; journey-api composes the two so a
+                 * consumer needs only one discriminant.
+                 *
+                 */
+                EnvironmentLinkList;
             }[];
             errors: {
                 datasourceId: string;
@@ -1001,8 +1041,15 @@ declare namespace Components {
         export interface JourneyEnvironmentVariablesResponse {
             items: {
                 key: string;
-                type: "Map";
-                value: EnvironmentMap;
+                type: "Map" | "List<Link>";
+                value: EnvironmentMap | /**
+                 * A list of links, served under this service's own `List<Link>` type
+                 * token. environments-api types the variable `List` and declares the
+                 * element type inside the value; journey-api composes the two so a
+                 * consumer needs only one discriminant.
+                 *
+                 */
+                EnvironmentLinkList;
                 description?: string;
             }[];
         }
@@ -3777,6 +3824,8 @@ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 
 type ButtonOption = Components.Schemas.ButtonOption;
+type EnvironmentLink = Components.Schemas.EnvironmentLink;
+type EnvironmentLinkList = Components.Schemas.EnvironmentLinkList;
 type EnvironmentMap = Components.Schemas.EnvironmentMap;
 type EnvironmentMapEntry = Components.Schemas.EnvironmentMapEntry;
 type GenerateDocumentRequest = Components.Schemas.GenerateDocumentRequest;
@@ -3812,4 +3861,4 @@ type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
 type TemplateSettings = Components.Schemas.TemplateSettings;
 type ValidationRuleRef = Components.Schemas.ValidationRuleRef;
 
-export { type PublishRevisionRequest as A, type ButtonOption as B, type Client as C, type SearchJourneysQueryRequest as D, type EnvironmentMap as E, type SearchJourneysResponse as F, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentMapEntry as c, type GenerateDocumentResponse as d, type GetJourneysResponse as e, GetSettingsForJourney as f, type JourneyActivationGuarantee as g, type JourneyAuditInfo as h, type JourneyCreationRequest as i, type JourneyCreationRequestV2 as j, type JourneyEnvironmentResponse as k, type JourneyEnvironmentVariablesResponse as l, type JourneyFeatureFlags as m, type JourneyProductsResponse as n, type JourneyPublishState as o, type JourneyResponse as p, type JourneyRevision as q, type JourneyRevisionConflict as r, type JourneyRevisionList as s, type JourneyRevisionRequest as t, type JourneyRevisionSummary as u, type JourneyServedRevision as v, type JourneyValidationError as w, type JourneyValidationResponse as x, type PatchUpdateJourneyRequest as y, type PublishResult as z };
+export { type PatchUpdateJourneyRequest as A, type ButtonOption as B, type Client as C, type PublishResult as D, type EnvironmentLink as E, type PublishRevisionRequest as F, type GenerateDocumentRequest as G, type SearchJourneysQueryRequest as H, type SearchJourneysResponse as I, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentLinkList as c, type EnvironmentMap as d, type EnvironmentMapEntry as e, type GenerateDocumentResponse as f, type GetJourneysResponse as g, GetSettingsForJourney as h, type JourneyActivationGuarantee as i, type JourneyAuditInfo as j, type JourneyCreationRequest as k, type JourneyCreationRequestV2 as l, type JourneyEnvironmentResponse as m, type JourneyEnvironmentVariablesResponse as n, type JourneyFeatureFlags as o, type JourneyProductsResponse as p, type JourneyPublishState as q, type JourneyResponse as r, type JourneyRevision as s, type JourneyRevisionConflict as t, type JourneyRevisionList as u, type JourneyRevisionRequest as v, type JourneyRevisionSummary as w, type JourneyServedRevision as x, type JourneyValidationError as y, type JourneyValidationResponse as z };

package/docs/document.md

@@ -28,6 +28,7 @@ const { data } = await documentClient.getTemplateMeta(...)
 - [`getTemplateMeta`](#gettemplatemeta)
 - [`generateDocumentV2`](#generatedocumentv2)
 - [`convertDocument`](#convertdocument)
+- [`validateTemplate`](#validatetemplate)
 
 **Schemas**
 - [`S3Reference`](#s3reference)
@@ -39,6 +40,9 @@ const { data } = await documentClient.getTemplateMeta(...)
 - [`DocxTemplaterErrorDetails`](#docxtemplatererrordetails)
 - [`DocxTemplaterErrorDetail`](#docxtemplatererrordetail)
 - [`ErrorCode`](#errorcode)
+- [`TemplateValidationRequest`](#templatevalidationrequest)
+- [`TemplateValidationResponse`](#templatevalidationresponse)
+- [`TemplateIssue`](#templateissue)
 - [`TemplateSettings`](#templatesettings)
 - [`DocumentMetaRequest`](#documentmetarequest)
 - [`DocumentMetaResponse`](#documentmetaresponse)
@@ -110,7 +114,7 @@ const { data } = await client.generateDocumentV2(
       }
     },
     context_entity_id: 'bcd0aab9-b544-42b0-8bfb-6d449d02eacc',
-    user_id: 100321,
+    user_id: '100321',
     language: 'de',
     variable_payload: {
       additionalProperties: 'string'
@@ -132,7 +136,7 @@ const { data } = await client.generateDocumentV2(
       template_with_datatable: false,
       enabled_template_settings_persistence: false,
       misconfigured_margins: false,
-      file_entity_id: '1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p'
+      file_entity_id: '123e4567-e89b-12d3-a456-426614174000'
     }
   },
 )
@@ -215,7 +219,7 @@ const { data } = await client.generateDocumentV2(
     "template_with_datatable": false,
     "enabled_template_settings_persistence": false,
     "misconfigured_margins": false,
-    "file_entity_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p"
+    "file_entity_id": "123e4567-e89b-12d3-a456-426614174000"
   }
 }
 ```
@@ -266,6 +270,72 @@ const { data } = await client.convertDocument(
 
 ---
 
+### `validateTemplate`
+
+Validates a document template's variable syntax and, optionally, proposes a hotfixed copy of it.
+
+`POST /v2/templates:validate`
+
+```ts
+const { data } = await client.validateTemplate(
+  null,
+  {
+    template_document: {
+      filename: 'Umzugsmeldung.xlsx',
+      s3ref: {
+        bucket: 'document-api-prod',
+        key: 'uploads/my-template.pdf'
+      }
+    },
+    fix: true,
+    fix_level: 'safe'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "valid": false,
+  "fixed": true,
+  "issues": [
+    {
+      "id": "unopened_tag",
+      "file": "xl/sharedStrings.xml",
+      "location": "Tabelle1!N4",
+      "context": "…Datum: {system.date}} Unterschrift…",
+      "explanation": "The tag is missing an opening brace.",
+      "fixable": true,
+      "confidence": "high",
+      "rule": "balance_opening_delimiter",
+      "before": "{system.date}}",
+      "after": "{{system.date}}"
+    }
+  ],
+  "unresolved_errors": [
+    {
+      "id": "string",
+      "context": "string",
+      "explanation": "string"
+    }
+  ],
+  "fixed_document": {
+    "s3ref": {
+      "bucket": "document-api-prod",
+      "key": "uploads/my-template.pdf"
+    },
+    "filename": "Umzugsmeldung (fixed).xlsx",
+    "preview_url": "https://example.com/path"
+  }
+}
+```
+
+</details>
+
+---
+
 ## Schemas
 
 ### `S3Reference`
@@ -282,7 +352,7 @@ type S3Reference = {
 ```ts
 type ErrorOutput = {
   error_message?: string
-  error_code?: "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT"
+  error_code?: "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT" | "TEMPLATE_NOT_FOUND"
   error_details?: Array<{
     explanation?: string
     context?: {
@@ -395,7 +465,76 @@ Error codes for document generation:
 - INTERNAL_ERROR - In
 
 ```ts
-type ErrorCode = "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT"
+type ErrorCode = "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT" | "TEMPLATE_NOT_FOUND"
+```
+
+### `TemplateValidationRequest`
+
+```ts
+type TemplateValidationRequest = {
+  template_document: {
+    filename?: string
+    s3ref: {
+      bucket: { ... }
+      key: { ... }
+    }
+  }
+  fix?: boolean
+  fix_level?: "safe" | "aggressive"
+}
+```
+
+### `TemplateValidationResponse`
+
+```ts
+type TemplateValidationResponse = {
+  valid?: boolean
+  fixed?: boolean
+  issues?: Array<{
+    id?: string
+    file?: string
+    location?: string
+    context?: string
+    explanation?: string
+    fixable?: boolean
+    confidence?: "high" | "medium" | "low"
+    rule?: string
+    before?: string
+    after?: string
+  }>
+  unresolved_errors?: Array<{
+    id?: string
+    context?: string
+    explanation?: string
+  }>
+  fixed_document?: {
+    s3ref?: {
+      bucket: { ... }
+      key: { ... }
+    }
+    filename?: string
+    preview_url?: string // uri
+  }
+}
+```
+
+### `TemplateIssue`
+
+A single template syntax problem, and the repair proposed for it
+
+```ts
+type TemplateIssue = {
+  id?: string
+  file?: string
+  location?: string
+  context?: string
+  explanation?: string
+  fixable?: boolean
+  confidence?: "high" | "medium" | "low"
+  rule?: string
+  before?: string
+  after?: string
+}
 ```
 
 ### `TemplateSettings`
@@ -525,7 +664,7 @@ type DocumentGenerationV2Response = {
   }
   error_output?: {
     error_message?: string
-    error_code?: "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT"
+    error_code?: "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT" | "TEMPLATE_NOT_FOUND"
     error_details?: Array<{
       explanation?: { ... }
       context?: { ... }

package/docs/journey.md

@@ -54,6 +54,8 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
 **Schemas**
 - [`EnvironmentMapEntry`](#environmentmapentry)
 - [`EnvironmentMap`](#environmentmap)
+- [`EnvironmentLink`](#environmentlink)
+- [`EnvironmentLinkList`](#environmentlinklist)
 - [`JourneyEnvironmentResponse`](#journeyenvironmentresponse)
 - [`JourneyEnvironmentVariablesResponse`](#journeyenvironmentvariablesresponse)
 - [`GetJourneysResponse`](#getjourneysresponse)
@@ -2198,16 +2200,55 @@ type EnvironmentMap = {
 }
 ```
 
+### `EnvironmentLink`
+
+One link a customer clicks. `label` and `description` are each either a
+plain string or one string per language, deciding that independently.
+Mirrors environments-api's `LinkFields`.
+
+
+```ts
+type EnvironmentLink = {
+  url: string
+  label: string | Record<string, string>
+  description?: string | Record<string, string>
+}
+```
+
+### `EnvironmentLinkList`
+
+A list of links, served under this service's own `List`<Link>`` type
+token. environments-api types the variable `List` and declares the
+element type inside the value; journey-api composes the two so a
+consumer needs only one discriminant.
+
+
+```ts
+type EnvironmentLinkList = {
+  itemType: "Link"
+  fallbackLanguage?: string
+  items: Array<{
+    url: string
+    label: string | Record<string, string>
+    description?: string | Record<string, string>
+  }>
+}
+```
+
 ### `JourneyEnvironmentResponse`
 
 ```ts
 type JourneyEnvironmentResponse = {
   items: Array<{
     datasourceId: string
-    type: "Text" | "Number" | "Boolean" | "Map"
+    type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>"
     value: string | number | boolean | {
       fallbackLanguage?: { ... }
       options: { ... }
+    } | {
+      itemType: { ... }
+      fallbackLanguage?: { ... }
+      items: { ... }
     }
   }>
   errors: Array<{
@@ -2223,10 +2264,14 @@ type JourneyEnvironmentResponse = {
 type JourneyEnvironmentVariablesResponse = {
   items: Array<{
     key: string
-    type: "Map"
+    type: "Map" | "List<Link>"
     value: {
       fallbackLanguage?: { ... }
       options: { ... }
+    } | {
+      itemType: { ... }
+      fallbackLanguage?: { ... }
+      items: { ... }
     }
     description?: string
   }>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.25",
+  "version": "2.20.27",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -328,6 +328,16 @@
     },
     "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
   },
+  "scripts": {
+    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check src",
+    "lint:fix": "biome check src --fix",
+    "prepublishOnly": "npm run build"
+  },
   "keywords": [
     "epilot",
     "sdk",
@@ -524,14 +534,5 @@
         "./dist/apis/workflow-definition.d.ts"
       ]
     }
-  },
-  "scripts": {
-    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "biome check src",
-    "lint:fix": "biome check src --fix"
   }
-}
+}

package/dist/document-CY2A2OE7.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/document.json
-var document_default = '# Document API\n\n- **Base URL:** `https://document.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/document](https://docs.epilot.io/api/document)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.document.getTemplateMeta(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/document\'\n\nconst documentClient = getClient()\nauthorize(documentClient, () => \'<token>\')\nconst { data } = await documentClient.getTemplateMeta(...)\n```\n\n## Operations\n\n**Documents**\n- [`getTemplateMeta`](#gettemplatemeta)\n- [`generateDocumentV2`](#generatedocumentv2)\n- [`convertDocument`](#convertdocument)\n\n**Schemas**\n- [`S3Reference`](#s3reference)\n- [`ErrorOutput`](#erroroutput)\n- [`InvalidCustomVariableErrorDetails`](#invalidcustomvariableerrordetails)\n- [`InvalidCustomVariableErrorDetail`](#invalidcustomvariableerrordetail)\n- [`InternalErrorDetails`](#internalerrordetails)\n- [`InternalErrorDetail`](#internalerrordetail)\n- [`DocxTemplaterErrorDetails`](#docxtemplatererrordetails)\n- [`DocxTemplaterErrorDetail`](#docxtemplatererrordetail)\n- [`ErrorCode`](#errorcode)\n- [`TemplateSettings`](#templatesettings)\n- [`DocumentMetaRequest`](#documentmetarequest)\n- [`DocumentMetaResponse`](#documentmetaresponse)\n- [`DocumentGenerationV2Request`](#documentgenerationv2request)\n- [`DocumentGenerationV2Response`](#documentgenerationv2response)\n- [`ConvertDocumentRequest`](#convertdocumentrequest)\n- [`ConvertDocumentResponse`](#convertdocumentresponse)\n\n### `getTemplateMeta`\n\nGet metadata for a document template\n\n`POST /v2/documents:meta`\n\n```ts\nconst { data } = await client.getTemplateMeta(\n  null,\n  {\n    template_document: {\n      s3ref: {\n        bucket: \'document-api-prod\',\n        key: \'uploads/my-template.pdf\'\n      }\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "page_margins": {\n    "top": 2.54,\n    "bottom": 2.54,\n    "left": 2.54,\n    "right": 2.54,\n    "header": 2.54,\n    "footer": 2.54\n  },\n  "variables": ["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"]\n}\n```\n\n</details>\n\n---\n\n### `generateDocumentV2`\n\nGenerates documents from templates with variables.\n\n`POST /v2/documents:generate`\n\n```ts\nconst { data } = await client.generateDocumentV2(\n  {\n    job_id: \'example\',\n    mode: \'example\',\n    preview_mode: \'example\',\n  },\n  {\n    template_document: {\n      filename: \'my-template-{{order.order_number}}.docx\',\n      s3ref: {\n        bucket: \'document-api-prod\',\n        key: \'uploads/my-template.pdf\'\n      }\n    },\n    context_entity_id: \'bcd0aab9-b544-42b0-8bfb-6d449d02eacc\',\n    user_id: 100321,\n    language: \'de\',\n    variable_payload: {\n      additionalProperties: \'string\'\n    },\n    context_data: {\n      additionalProperties: \'string\'\n    },\n    template_settings: {\n      custom_margins: {\n        top: 2.54,\n        bottom: 2.54\n      },\n      suggested_margins: {\n        top: 2.54,\n        bottom: 2.54\n      },\n      display_margin_guidelines: true,\n      enable_data_table_margin_autofix: false,\n      template_with_datatable: false,\n      enabled_template_settings_persistence: false,\n      misconfigured_margins: false,\n      file_entity_id: \'1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "job_status": "STARTED",\n  "message": "string",\n  "ics_output": {\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-appointment.ics"\n      }\n    }\n  },\n  "pdf_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.pdf"\n      }\n    }\n  },\n  "docx_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.docx"\n      }\n    }\n  },\n  "xlsx_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.xlsx",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.xlsx"\n      }\n    }\n  },\n  "error_output": {\n    "error_message": "string",\n    "error_code": "PARSE_ERROR",\n    "error_details": [\n      {\n        "explanation": "string",\n        "context": {\n          "invalid_variables": [\n            {\n              "variable": "string",\n              "error": "string"\n            }\n          ]\n        }\n      }\n    ]\n  },\n  "variable_payload": {\n    "additionalProperties": "string"\n  },\n  "template_settings": {\n    "custom_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "suggested_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "display_margin_guidelines": true,\n    "enable_data_table_margin_autofix": false,\n    "template_with_datatable": false,\n    "enabled_template_settings_persistence": false,\n    "misconfigured_margins": false,\n    "file_entity_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p"\n  }\n}\n```\n\n</details>\n\n---\n\n### `convertDocument`\n\nConverts a document to a different format.\n\n`POST /v2/documents:convert`\n\n```ts\nconst { data } = await client.convertDocument(\n  null,\n  {\n    language: \'de\',\n    input_document: {\n      s3ref: {\n        bucket: \'document-api-prod\',\n        key: \'uploads/my-template.pdf\'\n      }\n    },\n    output_format: \'pdf\',\n    output_filename: \'converted.pdf\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "output_document": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/converted.pdf",\n    "s3ref": {\n      "bucket": "document-api-prod",\n      "key": "uploads/my-template.pdf"\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `S3Reference`\n\n```ts\ntype S3Reference = {\n  bucket: string\n  key: string\n}\n```\n\n### `ErrorOutput`\n\n```ts\ntype ErrorOutput = {\n  error_message?: string\n  error_code?: "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT"\n  error_details?: Array<{\n    explanation?: string\n    context?: {\n      invalid_variables?: { ... }\n    }\n  }> | Array<{\n    items?: {\n      name?: { ... }\n      message?: { ... }\n      stack?: { ... }\n      cause?: { ... }\n    }\n  }> | Array<{\n    id?: string\n    context?: string\n    explanation?: string\n  }>\n}\n```\n\n### `InvalidCustomVariableErrorDetails`\n\nError details for invalid custom variables. This error will appear under \'PARSE_ERROR\' error code.\n\n```ts\ntype InvalidCustomVariableErrorDetails = Array<{\n  explanation?: string\n  context?: {\n    invalid_variables?: Array<{\n      variable?: { ... }\n      error?: { ... }\n    }>\n  }\n}>\n```\n\n### `InvalidCustomVariableErrorDetail`\n\n```ts\ntype InvalidCustomVariableErrorDetail = {\n  explanation?: string\n  context?: {\n    invalid_variables?: Array<{\n      variable?: { ... }\n      error?: { ... }\n    }>\n  }\n}\n```\n\n### `InternalErrorDetails`\n\nError details for internal error. This error will appear under \'INTERNAL_ERROR\' error code.\n\n```ts\ntype InternalErrorDetails = Array<{\n  items?: {\n    name?: string\n    message?: string\n    stack?: string\n    cause?: string\n  }\n}>\n```\n\n### `InternalErrorDetail`\n\nInternal error detail\n\n```ts\ntype InternalErrorDetail = {\n  name?: string\n  message?: string\n  stack?: string\n  cause?: string\n}\n```\n\n### `DocxTemplaterErrorDetails`\n\nError 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\n\n```ts\ntype DocxTemplaterErrorDetails = Array<{\n  id?: string\n  context?: string\n  explanation?: string\n}>\n```\n\n### `DocxTemplaterErrorDetail`\n\nDocxTemplater error detail\n\n```ts\ntype DocxTemplaterErrorDetail = {\n  id?: string\n  context?: string\n  explanation?: string\n}\n```\n\n### `ErrorCode`\n\nError 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 - In\n\n```ts\ntype ErrorCode = "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT"\n```\n\n### `TemplateSettings`\n\nTemplate Settings for document generation\n\n```ts\ntype TemplateSettings = {\n  custom_margins?: {\n    top?: number\n    bottom?: number\n  }\n  suggested_margins?: {\n    top?: number\n    bottom?: number\n  }\n  display_margin_guidelines?: boolean\n  enable_data_table_margin_autofix?: boolean\n  template_with_datatable?: boolean\n  enabled_template_settings_persistence?: boolean\n  misconfigured_margins?: boolean\n  file_entity_id?: string // uuid\n}\n```\n\n### `DocumentMetaRequest`\n\n```ts\ntype DocumentMetaRequest = {\n  template_document?: {\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n  }\n}\n```\n\n### `DocumentMetaResponse`\n\n```ts\ntype DocumentMetaResponse = {\n  page_margins?: {\n    top?: number\n    bottom?: number\n    left?: number\n    right?: number\n    header?: number\n    footer?: number\n  }\n  variables?: string[]\n}\n```\n\n### `DocumentGenerationV2Request`\n\n```ts\ntype DocumentGenerationV2Request = {\n  template_document: {\n    filename?: string\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n  }\n  context_entity_id?: string // uuid\n  user_id?: string\n  language?: string\n  variable_payload?: {\n    additionalProperties?: string\n  }\n  context_data?: {\n    additionalProperties?: string\n  }\n  template_settings?: {\n    custom_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    suggested_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    display_margin_guidelines?: boolean\n    enable_data_table_margin_autofix?: boolean\n    template_with_datatable?: boolean\n    enabled_template_settings_persistence?: boolean\n    misconfigured_margins?: boolean\n    file_entity_id?: string // uuid\n  }\n}\n```\n\n### `DocumentGenerationV2Response`\n\n```ts\ntype DocumentGenerationV2Response = {\n  job_id?: string // uuid\n  job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED"\n  message?: string\n  ics_output?: {\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  pdf_output?: {\n    preview_url?: string\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  docx_output?: {\n    preview_url?: string\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  xlsx_output?: {\n    preview_url?: string\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  error_output?: {\n    error_message?: string\n    error_code?: "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT"\n    error_details?: Array<{\n      explanation?: { ... }\n      context?: { ... }\n    }> | Array<{\n      items?: { ... }\n    }> | Array<{\n      id?: { ... }\n      context?: { ... }\n      explanation?: { ... }\n    }>\n  }\n  variable_payload?: {\n    additionalProperties?: string\n  }\n  template_settings?: {\n    custom_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    suggested_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    display_margin_guidelines?: boolean\n    enable_data_table_margin_autofix?: boolean\n    template_with_datatable?: boolean\n    enabled_template_settings_persistence?: boolean\n    misconfigured_margins?: boolean\n    file_entity_id?: string // uuid\n  }\n}\n```\n\n### `ConvertDocumentRequest`\n\n```ts\ntype ConvertDocumentRequest = {\n  language?: string\n  input_document: {\n    s3ref: {\n      bucket: { ... }\n      key: { ... }\n    }\n  }\n  output_format: "pdf"\n  output_filename?: string\n}\n```\n\n### `ConvertDocumentResponse`\n\n```ts\ntype ConvertDocumentResponse = {\n  output_document?: {\n    preview_url?: string\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n  }\n}\n```\n';
-export {
-  document_default as default
-};

package/dist/document-RYQ7MF6U.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/document.json
-var document_default = '# Document API\n\n- **Base URL:** `https://document.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/document](https://docs.epilot.io/api/document)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.document.getTemplateMeta(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/document\'\n\nconst documentClient = getClient()\nauthorize(documentClient, () => \'<token>\')\nconst { data } = await documentClient.getTemplateMeta(...)\n```\n\n## Operations\n\n**Documents**\n- [`getTemplateMeta`](#gettemplatemeta)\n- [`generateDocumentV2`](#generatedocumentv2)\n- [`convertDocument`](#convertdocument)\n\n**Schemas**\n- [`S3Reference`](#s3reference)\n- [`ErrorOutput`](#erroroutput)\n- [`InvalidCustomVariableErrorDetails`](#invalidcustomvariableerrordetails)\n- [`InvalidCustomVariableErrorDetail`](#invalidcustomvariableerrordetail)\n- [`InternalErrorDetails`](#internalerrordetails)\n- [`InternalErrorDetail`](#internalerrordetail)\n- [`DocxTemplaterErrorDetails`](#docxtemplatererrordetails)\n- [`DocxTemplaterErrorDetail`](#docxtemplatererrordetail)\n- [`ErrorCode`](#errorcode)\n- [`TemplateSettings`](#templatesettings)\n- [`DocumentMetaRequest`](#documentmetarequest)\n- [`DocumentMetaResponse`](#documentmetaresponse)\n- [`DocumentGenerationV2Request`](#documentgenerationv2request)\n- [`DocumentGenerationV2Response`](#documentgenerationv2response)\n- [`ConvertDocumentRequest`](#convertdocumentrequest)\n- [`ConvertDocumentResponse`](#convertdocumentresponse)\n\n### `getTemplateMeta`\n\nGet metadata for a document template\n\n`POST /v2/documents:meta`\n\n```ts\nconst { data } = await client.getTemplateMeta(\n  null,\n  {\n    template_document: {\n      s3ref: {\n        bucket: \'document-api-prod\',\n        key: \'uploads/my-template.pdf\'\n      }\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "page_margins": {\n    "top": 2.54,\n    "bottom": 2.54,\n    "left": 2.54,\n    "right": 2.54,\n    "header": 2.54,\n    "footer": 2.54\n  },\n  "variables": ["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"]\n}\n```\n\n</details>\n\n---\n\n### `generateDocumentV2`\n\nGenerates documents from templates with variables.\n\n`POST /v2/documents:generate`\n\n```ts\nconst { data } = await client.generateDocumentV2(\n  {\n    job_id: \'example\',\n    mode: \'example\',\n    preview_mode: \'example\',\n  },\n  {\n    template_document: {\n      filename: \'my-template-{{order.order_number}}.docx\',\n      s3ref: {\n        bucket: \'document-api-prod\',\n        key: \'uploads/my-template.pdf\'\n      }\n    },\n    context_entity_id: \'bcd0aab9-b544-42b0-8bfb-6d449d02eacc\',\n    user_id: 100321,\n    language: \'de\',\n    variable_payload: {\n      additionalProperties: \'string\'\n    },\n    context_data: {\n      additionalProperties: \'string\'\n    },\n    template_settings: {\n      custom_margins: {\n        top: 2.54,\n        bottom: 2.54\n      },\n      suggested_margins: {\n        top: 2.54,\n        bottom: 2.54\n      },\n      display_margin_guidelines: true,\n      enable_data_table_margin_autofix: false,\n      template_with_datatable: false,\n      enabled_template_settings_persistence: false,\n      misconfigured_margins: false,\n      file_entity_id: \'1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "job_status": "STARTED",\n  "message": "string",\n  "ics_output": {\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-appointment.ics"\n      }\n    }\n  },\n  "pdf_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.pdf"\n      }\n    }\n  },\n  "docx_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.docx"\n      }\n    }\n  },\n  "xlsx_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.xlsx",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.xlsx"\n      }\n    }\n  },\n  "error_output": {\n    "error_message": "string",\n    "error_code": "PARSE_ERROR",\n    "error_details": [\n      {\n        "explanation": "string",\n        "context": {\n          "invalid_variables": [\n            {\n              "variable": "string",\n              "error": "string"\n            }\n          ]\n        }\n      }\n    ]\n  },\n  "variable_payload": {\n    "additionalProperties": "string"\n  },\n  "template_settings": {\n    "custom_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "suggested_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "display_margin_guidelines": true,\n    "enable_data_table_margin_autofix": false,\n    "template_with_datatable": false,\n    "enabled_template_settings_persistence": false,\n    "misconfigured_margins": false,\n    "file_entity_id": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p"\n  }\n}\n```\n\n</details>\n\n---\n\n### `convertDocument`\n\nConverts a document to a different format.\n\n`POST /v2/documents:convert`\n\n```ts\nconst { data } = await client.convertDocument(\n  null,\n  {\n    language: \'de\',\n    input_document: {\n      s3ref: {\n        bucket: \'document-api-prod\',\n        key: \'uploads/my-template.pdf\'\n      }\n    },\n    output_format: \'pdf\',\n    output_filename: \'converted.pdf\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "output_document": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/converted.pdf",\n    "s3ref": {\n      "bucket": "document-api-prod",\n      "key": "uploads/my-template.pdf"\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `S3Reference`\n\n```ts\ntype S3Reference = {\n  bucket: string\n  key: string\n}\n```\n\n### `ErrorOutput`\n\n```ts\ntype ErrorOutput = {\n  error_message?: string\n  error_code?: "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT"\n  error_details?: Array<{\n    explanation?: string\n    context?: {\n      invalid_variables?: { ... }\n    }\n  }> | Array<{\n    items?: {\n      name?: { ... }\n      message?: { ... }\n      stack?: { ... }\n      cause?: { ... }\n    }\n  }> | Array<{\n    id?: string\n    context?: string\n    explanation?: string\n  }>\n}\n```\n\n### `InvalidCustomVariableErrorDetails`\n\nError details for invalid custom variables. This error will appear under \'PARSE_ERROR\' error code.\n\n```ts\ntype InvalidCustomVariableErrorDetails = Array<{\n  explanation?: string\n  context?: {\n    invalid_variables?: Array<{\n      variable?: { ... }\n      error?: { ... }\n    }>\n  }\n}>\n```\n\n### `InvalidCustomVariableErrorDetail`\n\n```ts\ntype InvalidCustomVariableErrorDetail = {\n  explanation?: string\n  context?: {\n    invalid_variables?: Array<{\n      variable?: { ... }\n      error?: { ... }\n    }>\n  }\n}\n```\n\n### `InternalErrorDetails`\n\nError details for internal error. This error will appear under \'INTERNAL_ERROR\' error code.\n\n```ts\ntype InternalErrorDetails = Array<{\n  items?: {\n    name?: string\n    message?: string\n    stack?: string\n    cause?: string\n  }\n}>\n```\n\n### `InternalErrorDetail`\n\nInternal error detail\n\n```ts\ntype InternalErrorDetail = {\n  name?: string\n  message?: string\n  stack?: string\n  cause?: string\n}\n```\n\n### `DocxTemplaterErrorDetails`\n\nError 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\n\n```ts\ntype DocxTemplaterErrorDetails = Array<{\n  id?: string\n  context?: string\n  explanation?: string\n}>\n```\n\n### `DocxTemplaterErrorDetail`\n\nDocxTemplater error detail\n\n```ts\ntype DocxTemplaterErrorDetail = {\n  id?: string\n  context?: string\n  explanation?: string\n}\n```\n\n### `ErrorCode`\n\nError 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 - In\n\n```ts\ntype ErrorCode = "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT"\n```\n\n### `TemplateSettings`\n\nTemplate Settings for document generation\n\n```ts\ntype TemplateSettings = {\n  custom_margins?: {\n    top?: number\n    bottom?: number\n  }\n  suggested_margins?: {\n    top?: number\n    bottom?: number\n  }\n  display_margin_guidelines?: boolean\n  enable_data_table_margin_autofix?: boolean\n  template_with_datatable?: boolean\n  enabled_template_settings_persistence?: boolean\n  misconfigured_margins?: boolean\n  file_entity_id?: string // uuid\n}\n```\n\n### `DocumentMetaRequest`\n\n```ts\ntype DocumentMetaRequest = {\n  template_document?: {\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n  }\n}\n```\n\n### `DocumentMetaResponse`\n\n```ts\ntype DocumentMetaResponse = {\n  page_margins?: {\n    top?: number\n    bottom?: number\n    left?: number\n    right?: number\n    header?: number\n    footer?: number\n  }\n  variables?: string[]\n}\n```\n\n### `DocumentGenerationV2Request`\n\n```ts\ntype DocumentGenerationV2Request = {\n  template_document: {\n    filename?: string\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n  }\n  context_entity_id?: string // uuid\n  user_id?: string\n  language?: string\n  variable_payload?: {\n    additionalProperties?: string\n  }\n  context_data?: {\n    additionalProperties?: string\n  }\n  template_settings?: {\n    custom_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    suggested_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    display_margin_guidelines?: boolean\n    enable_data_table_margin_autofix?: boolean\n    template_with_datatable?: boolean\n    enabled_template_settings_persistence?: boolean\n    misconfigured_margins?: boolean\n    file_entity_id?: string // uuid\n  }\n}\n```\n\n### `DocumentGenerationV2Response`\n\n```ts\ntype DocumentGenerationV2Response = {\n  job_id?: string // uuid\n  job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED"\n  message?: string\n  ics_output?: {\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  pdf_output?: {\n    preview_url?: string\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  docx_output?: {\n    preview_url?: string\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  xlsx_output?: {\n    preview_url?: string\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  error_output?: {\n    error_message?: string\n    error_code?: "PARSE_ERROR" | "DOC_TO_PDF_CONVERT_ERROR" | "INTERNAL_ERROR" | "INVALID_TEMPLATE_FORMAT"\n    error_details?: Array<{\n      explanation?: { ... }\n      context?: { ... }\n    }> | Array<{\n      items?: { ... }\n    }> | Array<{\n      id?: { ... }\n      context?: { ... }\n      explanation?: { ... }\n    }>\n  }\n  variable_payload?: {\n    additionalProperties?: string\n  }\n  template_settings?: {\n    custom_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    suggested_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    display_margin_guidelines?: boolean\n    enable_data_table_margin_autofix?: boolean\n    template_with_datatable?: boolean\n    enabled_template_settings_persistence?: boolean\n    misconfigured_margins?: boolean\n    file_entity_id?: string // uuid\n  }\n}\n```\n\n### `ConvertDocumentRequest`\n\n```ts\ntype ConvertDocumentRequest = {\n  language?: string\n  input_document: {\n    s3ref: {\n      bucket: { ... }\n      key: { ... }\n    }\n  }\n  output_format: "pdf"\n  output_filename?: string\n}\n```\n\n### `ConvertDocumentResponse`\n\n```ts\ntype ConvertDocumentResponse = {\n  output_document?: {\n    preview_url?: string\n    s3ref?: {\n      bucket: { ... }\n      key: { ... }\n    }\n  }\n}\n```\n';
-
-
-exports.default = document_default;