@epilot/sdk 2.14.3 → 2.14.5

package/dist/index.d.ts

@@ -15,7 +15,7 @@ import { C as Client$8 } from './blueprint-manifest.d-D2I9nhZa.js';
 import { C as Client$9 } from './calendar.d-BEjLDagH.js';
 import { C as Client$a } from './configuration-hub.d-CbSJDa7k.js';
 import { C as Client$b } from './consent.d-C2PROHhX.js';
-import { C as Client$c } from './customer-portal.d-SlKyKhCa.js';
+import { C as Client$c } from './customer-portal.d-CJgDRoOo.js';
 import { C as Client$d } from './dashboard.d-CsGcA74I.js';
 import { C as Client$e } from './data-governance.d-BbZ466j5.js';
 import { C as Client$f } from './deduplication.d-D5GYddVu.js';
@@ -27,7 +27,7 @@ import { C as Client$k } from './entity.d-fospShiN.js';
 import { C as Client$l } from './entity-mapping.d-DKSW3sfy.js';
 import { C as Client$m } from './environments.d-BvqvN-PD.js';
 import { C as Client$n } from './event-catalog.d-QIhhewVH.js';
-import { C as Client$o } from './file.d-BN417xok.js';
+import { C as Client$o } from './file.d-zFneCEyY.js';
 import { C as Client$p } from './iban.d-BwdiGbxi.js';
 import { C as Client$q } from './integration-toolkit.d-7q19qDTD.js';
 import { C as Client$r } from './journey.d-B1sOeMHw.js';

package/dist/index.js

@@ -63,7 +63,7 @@ import {
 } from "./chunk-M4FO2MI4.js";
 import {
   require_file_runtime
-} from "./chunk-G5KVG3RU.js";
+} from "./chunk-G7IFFKKJ.js";
 import {
   require_iban_runtime
 } from "./chunk-5MFHAXBT.js";
@@ -123,7 +123,7 @@ import {
 } from "./chunk-2BPBDRRO.js";
 import {
   require_customer_portal_runtime
-} from "./chunk-Y5YIU6PG.js";
+} from "./chunk-L4XLUNUO.js";
 import {
   require_dashboard_runtime
 } from "./chunk-SZMCMLOQ.js";
@@ -158,7 +158,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-RSW3OGJC.js";
+} from "./chunk-62BXSTL6.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";

package/docs/customer-portal.md

@@ -5188,9 +5188,9 @@ const { data } = await client.postOrderAcceptance(
 
 ### `getContractWithTemplates`
 
-Get a contract by id, resolving the provided Handlebars templates against each related meter into templates_output. POST variant of getContract that accepts a request body; the GET remains as a fallba
+Resolve Handlebars templates against a contract's related meters and return the contract with templates_output populated per meter. This is a read-only operation — it does not modify the contract. It 
 
-`POST /v2/portal/contract/{id}`
+`POST /v2/portal/contract/{id}/resolve-templates`
 
 ```ts
 const { data } = await client.getContractWithTemplates(

package/docs/file.md

@@ -39,6 +39,7 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`getCurrentFileSummaryJob`](#getcurrentfilesummaryjob)
 - [`getFileSummaryJob`](#getfilesummaryjob)
 - [`generateFileSummary`](#generatefilesummary)
+- [`getFileText`](#getfiletext)
 - [`verifyCustomDownloadUrl`](#verifycustomdownloadurl)
 - [`uploadFilePublic`](#uploadfilepublic)
 
@@ -76,6 +77,11 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`FileSummaryJobStatus`](#filesummaryjobstatus)
 - [`FileSummaryJob`](#filesummaryjob)
 - [`FileSummary`](#filesummary)
+- [`FileTextStatus`](#filetextstatus)
+- [`FileText`](#filetext)
+- [`FileTextReady`](#filetextready)
+- [`FileTextNotReady`](#filetextnotready)
+- [`FileTextUnsupported`](#filetextunsupported)
 - [`CustomDownloadUrl`](#customdownloadurl)
 - [`CustomDownloadUrlAuth`](#customdownloadurlauth)
 - [`FileEntity`](#fileentity)
@@ -179,6 +185,7 @@ const { data } = await client.saveFileV2(
     mime_type: 'application/pdf',
     size_bytes: 1234,
     readable_size: '1.2 MB',
+    etag: '9bb58f26192e4ba00f01e2e7b136bbd8',
     access_control: 'private',
     public_url: 'https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf',
     custom_download_url: 'https://some-api-url.com/download?file_id=123',
@@ -209,6 +216,7 @@ const { data } = await client.saveFileV2(
   "mime_type": "application/pdf",
   "size_bytes": 1234,
   "readable_size": "1.2 MB",
+  "etag": "9bb58f26192e4ba00f01e2e7b136bbd8",
   "access_control": "private",
   "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",
   "custom_download_url": "https://some-api-url.com/download?file_id=123",
@@ -225,7 +233,8 @@ const { data } = await client.saveFileV2(
       "filename": "document.pdf",
       "size_bytes": 1234,
       "readable_size": "1.2 MB",
-      "mime_type": "image/jpeg"
+      "mime_type": "image/jpeg",
+      "etag": "9bb58f26192e4ba00f01e2e7b136bbd8"
     }
   ],
   "_updated_at": "1970-01-01T00:00:00.000Z",
@@ -281,6 +290,7 @@ const { data } = await client.getFile({
   "mime_type": "application/pdf",
   "size_bytes": 1234,
   "readable_size": "1.2 MB",
+  "etag": "9bb58f26192e4ba00f01e2e7b136bbd8",
   "access_control": "private",
   "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",
   "custom_download_url": "https://some-api-url.com/download?file_id=123",
@@ -297,7 +307,8 @@ const { data } = await client.getFile({
       "filename": "document.pdf",
       "size_bytes": 1234,
       "readable_size": "1.2 MB",
-      "mime_type": "image/jpeg"
+      "mime_type": "image/jpeg",
+      "etag": "9bb58f26192e4ba00f01e2e7b136bbd8"
     }
   ],
   "_updated_at": "1970-01-01T00:00:00.000Z",
@@ -353,6 +364,7 @@ const { data } = await client.deleteFile({
   "mime_type": "application/pdf",
   "size_bytes": 1234,
   "readable_size": "1.2 MB",
+  "etag": "9bb58f26192e4ba00f01e2e7b136bbd8",
   "access_control": "private",
   "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",
   "custom_download_url": "https://some-api-url.com/download?file_id=123",
@@ -369,7 +381,8 @@ const { data } = await client.deleteFile({
       "filename": "document.pdf",
       "size_bytes": 1234,
       "readable_size": "1.2 MB",
-      "mime_type": "image/jpeg"
+      "mime_type": "image/jpeg",
+      "etag": "9bb58f26192e4ba00f01e2e7b136bbd8"
     }
   ],
   "_updated_at": "1970-01-01T00:00:00.000Z",
@@ -659,6 +672,34 @@ const { data } = await client.generateFileSummary({
 
 ---
 
+### `getFileText`
+
+Get the plain-text representation of a file entity. Returns status `not_ready` while text is being prepared and `unsupported` when text is unavailable for the file or organization.
+
+`GET /v1/files/{id}/text`
+
+```ts
+const { data } = await client.getFileText({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "status": "ready",
+  "text": "string",
+  "truncated": true,
+  "total_chars": 0
+}
+```
+
+</details>
+
+---
+
 ### `previewFile`
 
 Generate a thumbnail preview for a file entity.
@@ -1072,6 +1113,7 @@ const { data } = await client.getFilesInCollection({
     "mime_type": "application/pdf",
     "size_bytes": 1234,
     "readable_size": "1.2 MB",
+    "etag": "9bb58f26192e4ba00f01e2e7b136bbd8",
     "access_control": "private",
     "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",
     "custom_download_url": "https://some-api-url.com/download?file_id=123",
@@ -1088,7 +1130,8 @@ const { data } = await client.getFilesInCollection({
         "filename": "document.pdf",
         "size_bytes": 1234,
         "readable_size": "1.2 MB",
-        "mime_type": "image/jpeg"
+        "mime_type": "image/jpeg",
+        "etag": "9bb58f26192e4ba00f01e2e7b136bbd8"
       }
     ],
     "_updated_at": "1970-01-01T00:00:00.000Z",
@@ -1191,6 +1234,7 @@ type FileAttributes = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1243,6 +1287,56 @@ type FileSummary = {
 }
 ```
 
+### `FileTextStatus`
+
+Availability of the plain-text representation for a file entity.
+
+```ts
+type FileTextStatus = "ready" | "not_ready" | "unsupported"
+```
+
+### `FileText`
+
+```ts
+type FileText = {
+  status: "ready"
+  text: string
+  truncated: boolean
+  total_chars: number
+} | {
+  status: "not_ready"
+} | {
+  status: "unsupported"
+}
+```
+
+### `FileTextReady`
+
+```ts
+type FileTextReady = {
+  status: "ready"
+  text: string
+  truncated: boolean
+  total_chars: number
+}
+```
+
+### `FileTextNotReady`
+
+```ts
+type FileTextNotReady = {
+  status: "not_ready"
+}
+```
+
+### `FileTextUnsupported`
+
+```ts
+type FileTextUnsupported = {
+  status: "unsupported"
+}
+```
+
 ### `CustomDownloadUrl`
 
 Custom external download url used for the file
@@ -1275,6 +1369,7 @@ type FileEntity = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1291,6 +1386,7 @@ type FileEntity = {
     size_bytes?: number
     readable_size?: string
     mime_type?: string
+    etag?: string
   }>
   _updated_at?: string // date-time
   _created_at?: string // date-time
@@ -1340,6 +1436,7 @@ type SaveS3FilePayload = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1371,6 +1468,7 @@ type SaveFileFromSourceURLPayload = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1402,6 +1500,7 @@ type SaveCustomFilePayload = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1432,6 +1531,7 @@ type SaveFilePayload = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1457,6 +1557,7 @@ type SaveFilePayload = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1482,6 +1583,7 @@ type SaveFilePayload = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1512,6 +1614,7 @@ type SaveFilePayloadV2 = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1537,6 +1640,7 @@ type SaveFilePayloadV2 = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1562,6 +1666,7 @@ type SaveFilePayloadV2 = {
   mime_type?: string
   size_bytes?: number
   readable_size?: string
+  etag?: string
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
@@ -1691,6 +1796,7 @@ type FileItem = {
   size_bytes?: number
   readable_size?: string
   mime_type?: string
+  etag?: string
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.14.3",
+  "version": "2.14.5",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/chunk-G5KVG3RU.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/file-runtime.json
-var require_file_runtime = __commonJS({
-  "src/definitions/file-runtime.json"(exports, module) {
-    module.exports = { s: "https://file.sls.epilot.io", o: [["uploadFileV2", "post", "/v2/files/upload", [["file_entity_id", "q"]], 1], ["saveFileV2", "post", "/v2/files", [["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["StrictQueryParam"], ["AsyncOperationQueryParam"], ["DeleteTempFileQueryParam"], ["VersionOnlyQueryParam"]], 1], ["uploadFile", "post", "/v1/files/upload", [["file_entity_id", "q"]], 1], ["saveFile", "post", "/v1/files", [["ActivityIdQueryParam"], ["AsyncOperationQueryParam"], ["VersionOnlyQueryParam"]], 1], ["getFile", "get", "/v2/files/{id}", [["id", "p", true], ["source_url", "q"], ["StrictQueryParam"], ["AsyncOperationQueryParam"]]], ["deleteFile", "delete", "/v2/files/{id}", [["id", "p", true], ["purge", "q"], ["ActivityIdQueryParam"], ["StrictQueryParam"]]], ["downloadFile", "get", "/v1/files/{id}/download", [["id", "p", true], ["version", "q"], ["attachment", "q"]]], ["downloadS3File", "post", "/v1/files:downloadS3", [["s3_key", "q", true], ["s3_bucket", "q", true], ["attachment", "q"]]], ["downloadFiles", "post", "/v1/files:downloadFiles", null, 1], ["createZipJob", "post", "/v1/files:zipJob", null, 1], ["getZipJob", "get", "/v1/files:zipJob/{job_id}", [["job_id", "p", true]]], ["getFileSummary", "get", "/v1/files/{id}/summary", [["id", "p", true]]], ["createFileSummaryJob", "post", "/v1/files/{id}/summary-jobs", [["id", "p", true]]], ["getCurrentFileSummaryJob", "get", "/v1/files/{id}/summary-jobs/current", [["id", "p", true]]], ["getFileSummaryJob", "get", "/v1/files/{id}/summary-jobs/{job_id}", [["id", "p", true], ["job_id", "p", true]]], ["generateFileSummary", "post", "/v1/files/{id}/summary:generate", [["id", "p", true]]], ["previewFile", "get", "/v1/files/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"]]], ["previewS3File", "post", "/v1/files:previewS3", [["w", "q"], ["h", "q"]], 1], ["previewS3FileGet", "get", "/v1/files:previewS3", [["key", "q", true], ["bucket", "q", true], ["w", "q"], ["h", "q"]]], ["previewPublicFile", "get", "/v1/files/public/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"], ["org_id", "q"]]], ["getSession", "get", "/v1/files/session"], ["deleteSession", "delete", "/v1/files/session"], ["generatePublicLink", "post", "/v1/files/{id}/public/links", [["id", "p", true]]], ["listPublicLinksForFile", "get", "/v1/files/{id}/public/links", [["id", "p", true]]], ["accessPublicLink", "get", "/v1/files/public/links/{id}/{filename}", [["id", "p", true], ["filename", "p", true], ["hash", "q"]]], ["revokePublicLink", "delete", "/v1/files/public/links/{id}", [["id", "p", true]]], ["verifyCustomDownloadUrl", "post", "/v1/files/download:verify", null, 1], ["uploadFilePublic", "post", "/v1/files/public/upload", null, 1], ["getUserSchemaFileCollections", "get", "/v1/{slug}/collections", [["slug", "p", true]]], ["createUserSchemaFileCollection", "post", "/v1/{slug}/collections", [["slug", "p", true]], 1], ["updateUserSchemaFileCollection", "put", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]], 1], ["deleteUserSchemaFileCollection", "delete", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]]], ["getFilesInCollection", "get", "/v1/entity/{id}/collections/{collectionSlug}/files", [["EntityIdPathParam"], ["collectionSlug", "p", true]]], ["getGlobalFileCollections", "get", "/v1/collections/{schemaSlug}", [["schemaSlug", "p", true]]]], v: "3.0.3", cp: { EntityIdPathParam: ["id", "p", true], StrictQueryParam: ["strict", "q"], ActivityIdQueryParam: ["activity_id", "q"], FillActivityQueryParam: ["fill_activity", "q"], AsyncOperationQueryParam: ["async", "q"], DeleteTempFileQueryParam: ["delete_temp_file", "q"], VersionOnlyQueryParam: ["version_only", "q"] } };
-  }
-});
-
-export {
-  require_file_runtime
-};

package/dist/chunk-LNLUCLPL.cjs

@@ -1,14 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
-
-// src/definitions/file-runtime.json
-var require_file_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
-  "src/definitions/file-runtime.json"(exports, module) {
-    module.exports = { s: "https://file.sls.epilot.io", o: [["uploadFileV2", "post", "/v2/files/upload", [["file_entity_id", "q"]], 1], ["saveFileV2", "post", "/v2/files", [["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["StrictQueryParam"], ["AsyncOperationQueryParam"], ["DeleteTempFileQueryParam"], ["VersionOnlyQueryParam"]], 1], ["uploadFile", "post", "/v1/files/upload", [["file_entity_id", "q"]], 1], ["saveFile", "post", "/v1/files", [["ActivityIdQueryParam"], ["AsyncOperationQueryParam"], ["VersionOnlyQueryParam"]], 1], ["getFile", "get", "/v2/files/{id}", [["id", "p", true], ["source_url", "q"], ["StrictQueryParam"], ["AsyncOperationQueryParam"]]], ["deleteFile", "delete", "/v2/files/{id}", [["id", "p", true], ["purge", "q"], ["ActivityIdQueryParam"], ["StrictQueryParam"]]], ["downloadFile", "get", "/v1/files/{id}/download", [["id", "p", true], ["version", "q"], ["attachment", "q"]]], ["downloadS3File", "post", "/v1/files:downloadS3", [["s3_key", "q", true], ["s3_bucket", "q", true], ["attachment", "q"]]], ["downloadFiles", "post", "/v1/files:downloadFiles", null, 1], ["createZipJob", "post", "/v1/files:zipJob", null, 1], ["getZipJob", "get", "/v1/files:zipJob/{job_id}", [["job_id", "p", true]]], ["getFileSummary", "get", "/v1/files/{id}/summary", [["id", "p", true]]], ["createFileSummaryJob", "post", "/v1/files/{id}/summary-jobs", [["id", "p", true]]], ["getCurrentFileSummaryJob", "get", "/v1/files/{id}/summary-jobs/current", [["id", "p", true]]], ["getFileSummaryJob", "get", "/v1/files/{id}/summary-jobs/{job_id}", [["id", "p", true], ["job_id", "p", true]]], ["generateFileSummary", "post", "/v1/files/{id}/summary:generate", [["id", "p", true]]], ["previewFile", "get", "/v1/files/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"]]], ["previewS3File", "post", "/v1/files:previewS3", [["w", "q"], ["h", "q"]], 1], ["previewS3FileGet", "get", "/v1/files:previewS3", [["key", "q", true], ["bucket", "q", true], ["w", "q"], ["h", "q"]]], ["previewPublicFile", "get", "/v1/files/public/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"], ["org_id", "q"]]], ["getSession", "get", "/v1/files/session"], ["deleteSession", "delete", "/v1/files/session"], ["generatePublicLink", "post", "/v1/files/{id}/public/links", [["id", "p", true]]], ["listPublicLinksForFile", "get", "/v1/files/{id}/public/links", [["id", "p", true]]], ["accessPublicLink", "get", "/v1/files/public/links/{id}/{filename}", [["id", "p", true], ["filename", "p", true], ["hash", "q"]]], ["revokePublicLink", "delete", "/v1/files/public/links/{id}", [["id", "p", true]]], ["verifyCustomDownloadUrl", "post", "/v1/files/download:verify", null, 1], ["uploadFilePublic", "post", "/v1/files/public/upload", null, 1], ["getUserSchemaFileCollections", "get", "/v1/{slug}/collections", [["slug", "p", true]]], ["createUserSchemaFileCollection", "post", "/v1/{slug}/collections", [["slug", "p", true]], 1], ["updateUserSchemaFileCollection", "put", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]], 1], ["deleteUserSchemaFileCollection", "delete", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]]], ["getFilesInCollection", "get", "/v1/entity/{id}/collections/{collectionSlug}/files", [["EntityIdPathParam"], ["collectionSlug", "p", true]]], ["getGlobalFileCollections", "get", "/v1/collections/{schemaSlug}", [["schemaSlug", "p", true]]]], v: "3.0.3", cp: { EntityIdPathParam: ["id", "p", true], StrictQueryParam: ["strict", "q"], ActivityIdQueryParam: ["activity_id", "q"], FillActivityQueryParam: ["fill_activity", "q"], AsyncOperationQueryParam: ["async", "q"], DeleteTempFileQueryParam: ["delete_temp_file", "q"], VersionOnlyQueryParam: ["version_only", "q"] } };
-  }
-});
-
-
-
-exports.require_file_runtime = require_file_runtime;