@epilot/sdk 2.20.26 → 2.20.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (135) hide show
  1. package/definitions/document-runtime.json +1 -1
  2. package/definitions/document.json +218 -4
  3. package/definitions/erp-integration-runtime.json +1 -0
  4. package/definitions/erp-integration.json +7936 -0
  5. package/dist/apis/access-token.cjs +6 -6
  6. package/dist/apis/access-token.js +1 -1
  7. package/dist/apis/address-suggestions.cjs +6 -6
  8. package/dist/apis/address-suggestions.js +1 -1
  9. package/dist/apis/address.cjs +6 -6
  10. package/dist/apis/address.js +1 -1
  11. package/dist/apis/ai-agents.cjs +6 -6
  12. package/dist/apis/ai-agents.js +1 -1
  13. package/dist/apis/app.cjs +6 -6
  14. package/dist/apis/app.js +1 -1
  15. package/dist/apis/audit-logs.cjs +6 -6
  16. package/dist/apis/audit-logs.js +1 -1
  17. package/dist/apis/automation.cjs +6 -6
  18. package/dist/apis/automation.js +1 -1
  19. package/dist/apis/billing.cjs +6 -6
  20. package/dist/apis/billing.js +1 -1
  21. package/dist/apis/blueprint-manifest.cjs +6 -6
  22. package/dist/apis/blueprint-manifest.js +1 -1
  23. package/dist/apis/calendar.cjs +6 -6
  24. package/dist/apis/calendar.js +1 -1
  25. package/dist/apis/chat.cjs +6 -6
  26. package/dist/apis/chat.js +1 -1
  27. package/dist/apis/configuration-hub.cjs +6 -6
  28. package/dist/apis/configuration-hub.d.cts +2 -2
  29. package/dist/apis/configuration-hub.d.ts +2 -2
  30. package/dist/apis/configuration-hub.js +1 -1
  31. package/dist/apis/consent.cjs +6 -6
  32. package/dist/apis/consent.js +1 -1
  33. package/dist/apis/customer-portal.cjs +6 -6
  34. package/dist/apis/customer-portal.js +1 -1
  35. package/dist/apis/dashboard.cjs +6 -6
  36. package/dist/apis/dashboard.js +1 -1
  37. package/dist/apis/data-governance.cjs +6 -6
  38. package/dist/apis/data-governance.js +1 -1
  39. package/dist/apis/deduplication.cjs +6 -6
  40. package/dist/apis/deduplication.js +1 -1
  41. package/dist/apis/design.cjs +6 -6
  42. package/dist/apis/design.js +1 -1
  43. package/dist/apis/document.cjs +8 -8
  44. package/dist/apis/document.d.cts +2 -2
  45. package/dist/apis/document.d.ts +2 -2
  46. package/dist/apis/document.js +2 -2
  47. package/dist/apis/email-settings.cjs +6 -6
  48. package/dist/apis/email-settings.js +1 -1
  49. package/dist/apis/email-template.cjs +6 -6
  50. package/dist/apis/email-template.js +1 -1
  51. package/dist/apis/entity-mapping.cjs +6 -6
  52. package/dist/apis/entity-mapping.js +1 -1
  53. package/dist/apis/entity.cjs +6 -6
  54. package/dist/apis/entity.js +1 -1
  55. package/dist/apis/environments.cjs +6 -6
  56. package/dist/apis/environments.js +1 -1
  57. package/dist/apis/event-catalog.cjs +6 -6
  58. package/dist/apis/event-catalog.js +1 -1
  59. package/dist/apis/file.cjs +6 -6
  60. package/dist/apis/file.js +1 -1
  61. package/dist/apis/iban.cjs +6 -6
  62. package/dist/apis/iban.js +1 -1
  63. package/dist/apis/integration-toolkit.cjs +6 -6
  64. package/dist/apis/integration-toolkit.js +1 -1
  65. package/dist/apis/journey.cjs +6 -6
  66. package/dist/apis/journey.js +1 -1
  67. package/dist/apis/kanban.cjs +6 -6
  68. package/dist/apis/kanban.js +1 -1
  69. package/dist/apis/message.cjs +6 -6
  70. package/dist/apis/message.js +1 -1
  71. package/dist/apis/metering.cjs +6 -6
  72. package/dist/apis/metering.js +1 -1
  73. package/dist/apis/notes.cjs +6 -6
  74. package/dist/apis/notes.js +1 -1
  75. package/dist/apis/notification.cjs +6 -6
  76. package/dist/apis/notification.js +1 -1
  77. package/dist/apis/organization.cjs +6 -6
  78. package/dist/apis/organization.js +1 -1
  79. package/dist/apis/partner-directory.cjs +6 -6
  80. package/dist/apis/partner-directory.js +1 -1
  81. package/dist/apis/permissions.cjs +6 -6
  82. package/dist/apis/permissions.js +1 -1
  83. package/dist/apis/pricing-tier.cjs +6 -6
  84. package/dist/apis/pricing-tier.js +1 -1
  85. package/dist/apis/pricing.cjs +6 -6
  86. package/dist/apis/pricing.js +1 -1
  87. package/dist/apis/purpose.cjs +6 -6
  88. package/dist/apis/purpose.js +1 -1
  89. package/dist/apis/query.cjs +6 -6
  90. package/dist/apis/query.js +1 -1
  91. package/dist/apis/sandbox.cjs +6 -6
  92. package/dist/apis/sandbox.js +1 -1
  93. package/dist/apis/sharing.cjs +6 -6
  94. package/dist/apis/sharing.js +1 -1
  95. package/dist/apis/snapshot.cjs +6 -6
  96. package/dist/apis/snapshot.js +1 -1
  97. package/dist/apis/submission.cjs +6 -6
  98. package/dist/apis/submission.js +1 -1
  99. package/dist/apis/target.cjs +6 -6
  100. package/dist/apis/target.js +1 -1
  101. package/dist/apis/targeting.cjs +6 -6
  102. package/dist/apis/targeting.js +1 -1
  103. package/dist/apis/template-variables.cjs +6 -6
  104. package/dist/apis/template-variables.js +1 -1
  105. package/dist/apis/user.cjs +6 -6
  106. package/dist/apis/user.js +1 -1
  107. package/dist/apis/validation-rules.cjs +6 -6
  108. package/dist/apis/validation-rules.js +1 -1
  109. package/dist/apis/webhooks.cjs +6 -6
  110. package/dist/apis/webhooks.js +1 -1
  111. package/dist/apis/workflow-definition.cjs +6 -6
  112. package/dist/apis/workflow-definition.js +1 -1
  113. package/dist/apis/workflow.cjs +6 -6
  114. package/dist/apis/workflow.js +1 -1
  115. package/dist/{chunk-M56QQHVA.cjs → chunk-E2EHXQRP.cjs} +1 -1
  116. package/dist/{chunk-75EI2Q64.js → chunk-LR7LGGRU.js} +1 -1
  117. package/dist/{chunk-6CWZ6WAC.cjs → chunk-UM53DB6T.cjs} +2 -2
  118. package/dist/{chunk-ELW5R5D6.js → chunk-W5PMKQO7.js} +2 -2
  119. package/dist/{configuration-hub.d-Dv41yC3b.d.cts → configuration-hub.d-DhPrjJkE.d.cts} +142 -142
  120. package/dist/{configuration-hub.d-Dv41yC3b.d.ts → configuration-hub.d-DhPrjJkE.d.ts} +142 -142
  121. package/dist/document-UGT6DAXC.cjs +7 -0
  122. package/dist/document-UR5WWZEA.js +7 -0
  123. package/dist/{document-runtime-GFEBGNMS.js → document-runtime-LFOBMSE4.js} +1 -1
  124. package/dist/{document-runtime-RG3F4R6O.cjs → document-runtime-QM4H7DLT.cjs} +2 -2
  125. package/dist/{document.d-DN37pjdx.d.cts → document.d-B0zC-R8x.d.cts} +235 -7
  126. package/dist/{document.d-DN37pjdx.d.ts → document.d-B0zC-R8x.d.ts} +235 -7
  127. package/dist/index.cjs +10 -10
  128. package/dist/index.d.cts +2 -2
  129. package/dist/index.d.ts +2 -2
  130. package/dist/index.js +2 -2
  131. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  132. package/docs/document.md +145 -6
  133. package/package.json +12 -11
  134. package/dist/document-CY2A2OE7.js +0 -7
  135. package/dist/document-RYQ7MF6U.cjs +0 -7
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/sdk",
3
- "version": "2.20.26",
3
+ "version": "2.20.27",
4
4
  "description": "JavaScript/TypeScript SDK for epilot APIs",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -328,6 +328,16 @@
328
328
  },
329
329
  "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
330
330
  },
331
+ "scripts": {
332
+ "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
333
+ "build": "tsup",
334
+ "build:watch": "tsup --watch",
335
+ "test": "vitest run",
336
+ "test:watch": "vitest",
337
+ "lint": "biome check src",
338
+ "lint:fix": "biome check src --fix",
339
+ "prepublishOnly": "npm run build"
340
+ },
331
341
  "keywords": [
332
342
  "epilot",
333
343
  "sdk",
@@ -524,14 +534,5 @@
524
534
  "./dist/apis/workflow-definition.d.ts"
525
535
  ]
526
536
  }
527
- },
528
- "scripts": {
529
- "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
530
- "build": "tsup",
531
- "build:watch": "tsup --watch",
532
- "test": "vitest run",
533
- "test:watch": "vitest",
534
- "lint": "biome check src",
535
- "lint:fix": "biome check src --fix"
536
537
  }
537
- }
538
+ }
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/document.json
4
- 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';
5
- export {
6
- document_default as default
7
- };
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/document.json
4
- 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';
5
-
6
-
7
- exports.default = document_default;