@epilot/sdk 2.6.0 → 2.7.1

package/docs/email-settings.md

@@ -71,9 +71,11 @@ const { data } = await emailSettingsClient.provisionEpilotEmailAddress(...)
 - [`deleteDomain`](#deletedomain)
 - [`getDomains`](#getdomains)
 - [`verifyNameServers`](#verifynameservers)
+- [`verifyDnsRecords`](#verifydnsrecords)
 - [`verifyDomain`](#verifydomain)
 
 **Schemas**
+- [`ConnectOutlookRequest`](#connectoutlookrequest)
 - [`MailboxSyncStatus`](#mailboxsyncstatus)
 - [`MailboxSyncStatuses`](#mailboxsyncstatuses)
 - [`MailboxSyncFolderStatuses`](#mailboxsyncfolderstatuses)
@@ -562,12 +564,18 @@ const { data } = await client.listInboxBuckets()
 
 ### `connectOutlook`
 
-Returns Microsoft authorization URL for Outlook OAuth.
+Returns the Microsoft authorization URL for Outlook OAuth.
 
-`GET /v2/outlook/connect`
+`POST /v2/outlook/connect`
 
 ```ts
-const { data } = await client.connectOutlook()
+const { data } = await client.connectOutlook(
+  null,
+  {
+    mail: true,
+    calendar: true
+  },
+)
 ```
 
 <details>
@@ -603,6 +611,7 @@ const { data } = await client.getOutlookConnectionStatus()
     {
       "status": "connected",
       "action": "connect",
+      "action_reason": "expired",
       "connected_by_display_name": "string",
       "connected_by_email": "user@example.com",
       "connected_by_user_id": "string",
@@ -1240,6 +1249,46 @@ const { data } = await client.verifyNameServers(
 
 ---
 
+### `verifyDnsRecords`
+
+Verifies that the domain's DNS records (MX, TXT, CNAME) are correctly configured
+in the customer's DNS provider.
+
+`POST /v1/email-settings/domain/dns-records:verify`
+
+```ts
+const { data } = await client.verifyDnsRecords(
+  null,
+  {
+    domain: 'mail.yourcompany.com'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+[
+  {
+    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",
+    "name": "Default Signature",
+    "org_id": "org-123",
+    "type": "signature",
+    "value": "Best regards, The Team",
+    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",
+    "created_at": "2024-01-15T10:30:00Z",
+    "updated_at": "2024-01-20T14:45:00Z",
+    "created_by": "user-123",
+    "updated_by": "user-456"
+  }
+]
+```
+
+</details>
+
+---
+
 ### `verifyDomain`
 
 Verifies ownership and configuration of a custom email domain.
@@ -1281,6 +1330,20 @@ const { data } = await client.verifyDomain(
 
 ## Schemas
 
+### `ConnectOutlookRequest`
+
+Feature flags selecting which Microsoft Graph scopes to request.
+At least one flag must be true. Passing a superset of previously
+granted features triggers incremental consent for the delta only.
+
+
+```ts
+type ConnectOutlookRequest = {
+  mail?: boolean
+  calendar?: boolean
+}
+```
+
 ### `MailboxSyncStatus`
 
 ```ts
@@ -1542,6 +1605,7 @@ type OutlookConnectionError = {
 type OutlookConnectionStatus = {
   status: "connected" | "expired" | "pending_auth" | "not_connected"
   action: "connect" | "authorize" | "reconnect" | "none"
+  action_reason?: "expired" | "permission_update"
   connected_by_display_name?: string
   connected_by_email?: string // email
   connected_by_user_id?: string

package/docs/event-catalog.md

@@ -31,6 +31,8 @@ const { data } = await eventCatalogClient.listEvents(...)
 - [`getEventJSONSchema`](#geteventjsonschema)
 - [`getEventExample`](#geteventexample)
 - [`searchEventHistory`](#searcheventhistory)
+- [`searchEventHistoryV2`](#searcheventhistoryv2)
+- [`getHistoricalEvent`](#gethistoricalevent)
 - [`triggerEvent`](#triggerevent)
 
 **Schemas**
@@ -39,18 +41,22 @@ const { data } = await eventCatalogClient.listEvents(...)
 - [`UpdateEventPayload`](#updateeventpayload)
 - [`PrimitiveField`](#primitivefield)
 - [`ContextEntity`](#contextentity)
+- [`AttachmentField`](#attachmentfield)
 - [`SchemaField`](#schemafield)
 - [`CommonEventMetadata`](#commoneventmetadata)
 - [`EventJsonSchema`](#eventjsonschema)
 - [`Event`](#event)
+- [`EventSummary`](#eventsummary)
 - [`GraphDefinition`](#graphdefinition)
 - [`GraphNode`](#graphnode)
 - [`GraphEdge`](#graphedge)
 - [`EntityOperationTrigger`](#entityoperationtrigger)
 - [`SearchOptions`](#searchoptions)
+- [`SearchOptionsV2`](#searchoptionsv2)
 - [`FieldsParam`](#fieldsparam)
 - [`TriggerEventPayload`](#triggereventpayload)
 - [`TriggerEventResponse`](#triggereventresponse)
+- [`EventAttachment`](#eventattachment)
 
 ### `listEvents`
 
@@ -470,6 +476,108 @@ const { data } = await client.searchEventHistory(
 
 ---
 
+### `searchEventHistoryV2`
+
+Paginated history of events with projected/lightweight payload (v2).
+
+`POST /v2/events/{event_name}:history`
+
+```ts
+const { data } = await client.searchEventHistoryV2(
+  {
+    event_name: 'example',
+  },
+  {
+    limit: 10,
+    cursor: {
+      event_time: '2025-10-31 12:34:56',
+      event_id: 'evt_1234567890abcdef'
+    },
+    timestamp: {
+      from: '2025-10-01T00:00:00Z',
+      to: '2025-10-31T23:59:59Z'
+    },
+    event_id: 'evt_1234567890abcdef',
+    fields: ['_id', '_title', 'first_name', 'account', '!account.*._files', '**._product']
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "results": [
+    {
+      "_org_id": "string",
+      "_event_time": "1970-01-01T00:00:00.000Z",
+      "_event_id": "string",
+      "_event_name": "string",
+      "_event_version": "1.0.0",
+      "_event_source": "string",
+      "_trigger_source_type": "api",
+      "_trigger_source": "string",
+      "_ack_id": "string"
+    }
+  ],
+  "next_cursor": {
+    "event_time": "2025-10-31T12:34:56Z",
+    "event_id": "evt_1234567890abcdef"
+  }
+}
+```
+
+</details>
+
+---
+
+### `getHistoricalEvent`
+
+Fetch a single historical event by id with full hydration
+
+`GET /v2/events/{event_name}/history/{event_id}`
+
+```ts
+const { data } = await client.getHistoricalEvent({
+  event_name: 'example',
+  event_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "_org_id": "org_123456",
+  "_event_time": "2024-01-01T12:00:00Z",
+  "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",
+  "_event_name": "MeterReading",
+  "_event_version": "1.0.0",
+  "_event_source": "api",
+  "_trigger_source_type": "api",
+  "_trigger_source": "user_123456",
+  "reading_value": 123.45,
+  "reading_date": "2024-01-01T11:59:00Z",
+  "read_by": "John Doe",
+  "reason": "regular",
+  "direction": "feed-out",
+  "source": "portal",
+  "meter_id": "550e8400-e29b-41d4-a716-446655440000",
+  "counter_id": "660e8400-e29b-41d4-a716-446655440000",
+  "meter_number": "MT123456789",
+  "obis_number": "1-0:1.8.0",
+  "unit": "kWh",
+  "customer_id": "770e8400-e29b-41d4-a716-446655440000",
+  "contract_id": "880e8400-e29b-41d4-a716-446655440000"
+}
+```
+
+</details>
+
+---
+
 ### `triggerEvent`
 
 Explicitly trigger an event by providing input field values and an optional entity seed
@@ -531,6 +639,17 @@ type EventConfigBase = {
   } | {
     entity_schema: string
     required?: boolean
+  } | {
+    items: {
+      entity_id: { ... }
+      filename?: { ... }
+      mime_type?: { ... }
+      size_bytes?: { ... }
+      s3ref?: { ... }
+      version_index: { ... }
+      readable_size?: { ... }
+    }
+    required?: boolean
   }>
   entity_graph?: {
     nodes: Array<{
@@ -575,6 +694,17 @@ type EventConfig = {
   } | {
     entity_schema: string
     required?: boolean
+  } | {
+    items: {
+      entity_id: { ... }
+      filename?: { ... }
+      mime_type?: { ... }
+      size_bytes?: { ... }
+      s3ref?: { ... }
+      version_index: { ... }
+      readable_size?: { ... }
+    }
+    required?: boolean
   }>
   entity_graph?: {
     nodes: Array<{
@@ -604,7 +734,7 @@ type EventConfig = {
 
 Payload for updating an event configuration.
 Accepts the same fields as EventConfig (all optional for PATCH).
-Currently only `enabled` and `auto_trigger` fields are processed, other fields are ignored.
+Currently `enabled` and `auto_trigger` fields are processed.
 
 
 ```ts
@@ -622,6 +752,17 @@ type UpdateEventPayload = {
   } | {
     entity_schema: string
     required?: boolean
+  } | {
+    items: {
+      entity_id: { ... }
+      filename?: { ... }
+      mime_type?: { ... }
+      size_bytes?: { ... }
+      s3ref?: { ... }
+      version_index: { ... }
+      readable_size?: { ... }
+    }
+    required?: boolean
   }>
   entity_graph?: {
     nodes: Array<{
@@ -668,6 +809,30 @@ type ContextEntity = {
 }
 ```
 
+### `AttachmentField`
+
+A schema field representing file attachments associated with the event.
+Present in schema_fields for events tagged with "attachment".
+
+
+```ts
+type AttachmentField = {
+  items: {
+    entity_id: string // uuid
+    filename?: string
+    mime_type?: string
+    size_bytes?: number
+    s3ref?: {
+      bucket: { ... }
+      key: { ... }
+    }
+    version_index: number
+    readable_size?: string
+  }
+  required?: boolean
+}
+```
+
 ### `SchemaField`
 
 ```ts
@@ -678,6 +843,20 @@ type SchemaField = {
 } | {
   entity_schema: string
   required?: boolean
+} | {
+  items: {
+    entity_id: string // uuid
+    filename?: string
+    mime_type?: string
+    size_bytes?: number
+    s3ref?: {
+      bucket: { ... }
+      key: { ... }
+    }
+    version_index: number
+    readable_size?: string
+  }
+  required?: boolean
 }
 ```
 
@@ -715,6 +894,29 @@ type Event = {
 }
 ```
 
+### `EventSummary`
+
+A lightweight event summary returned by the v2 history endpoint.
+
+Includes the standard `_*` metadata fields plus a projected subset of the
+event payload. Hydrated entity objects (values carrying `_schema` or `_id`
+and arrays of such objects) are stripped — fetch via
+`GET /v2/events/{event_name}/his
+
+```ts
+type EventSummary = {
+  _org_id: string
+  _event_time: string // date-time
+  _event_id: string
+  _event_name: string
+  _event_version: string
+  _event_source: string
+  _trigger_source_type?: string
+  _trigger_source?: string
+  _ack_id?: string
+}
+```
+
 ### `GraphDefinition`
 
 Entity graph definition for resolving related entities
@@ -792,6 +994,31 @@ type SearchOptions = {
 }
 ```
 
+### `SearchOptionsV2`
+
+Search options for the v2 history endpoint.
+
+Extends `SearchOptions` with an optional `fields` projection. When `fields`
+is omitted, the response includes all `_*` metadata plus all scalar payload
+fields (and primitive arrays / empty objects/arrays) after entity stripping.
+When `fields` is provided,
+
+```ts
+type SearchOptionsV2 = {
+  limit?: number
+  cursor?: {
+    event_time?: string
+    event_id?: string
+  }
+  timestamp?: {
+    from?: string // date-time
+    to?: string // date-time
+  }
+  event_id?: string
+  fields?: string[]
+}
+```
+
 ### `FieldsParam`
 
 List of entity fields to include or exclude in the response
@@ -833,3 +1060,22 @@ type TriggerEventResponse = {
   event_bridge_event_id?: string
 }
 ```
+
+### `EventAttachment`
+
+A file attachment associated with an event
+
+```ts
+type EventAttachment = {
+  entity_id: string // uuid
+  filename?: string
+  mime_type?: string
+  size_bytes?: number
+  s3ref?: {
+    bucket: string
+    key: string
+  }
+  version_index: number
+  readable_size?: string
+}
+```

package/docs/file.md

@@ -32,6 +32,8 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`downloadFile`](#downloadfile)
 - [`downloadS3File`](#downloads3file)
 - [`downloadFiles`](#downloadfiles)
+- [`createZipJob`](#createzipjob)
+- [`getZipJob`](#getzipjob)
 - [`verifyCustomDownloadUrl`](#verifycustomdownloadurl)
 - [`uploadFilePublic`](#uploadfilepublic)
 
@@ -78,6 +80,8 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`UploadFilePayload`](#uploadfilepayload)
 - [`FileUpload`](#fileupload)
 - [`DownloadFilesPayload`](#downloadfilespayload)
+- [`CreateZipJobPayload`](#createzipjobpayload)
+- [`ZipJob`](#zipjob)
 - [`VerifyCustomDownloadUrlPayload`](#verifycustomdownloadurlpayload)
 - [`S3Reference`](#s3reference)
 - [`S3Ref`](#s3ref)
@@ -448,6 +452,63 @@ const { data } = await client.downloadFiles(
 
 ---
 
+### `createZipJob`
+
+Create a background job to ZIP multiple files and send a download link via email.
+
+`POST /v1/files:zipJob`
+
+```ts
+const { data } = await client.createZipJob(
+  null,
+  {},
+)
+```
+
+---
+
+### `getZipJob`
+
+Get the status of a ZIP job
+
+`GET /v1/files:zipJob/{job_id}`
+
+```ts
+const { data } = await client.getZipJob({
+  job_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "status": "completed",
+  "progress": {
+    "total_files": 100,
+    "downloaded_files": 75,
+    "failed_files": 2
+  },
+  "result": {
+    "file_entity_id": "ef7d985c-2385-44f4-9c71-ae06a52264f8",
+    "download_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/files.zip?X-Amz-...",
+    "expires_at": "2024-01-02T12:00:00Z",
+    "zip_size_bytes": 104857600
+  },
+  "error": "Failed to download file: access denied",
+  "created_at": "2024-01-01T12:00:00Z",
+  "created_by": "10234",
+  "org_id": "123",
+  "updated_at": "2024-01-01T12:05:00Z"
+}
+```
+
+</details>
+
+---
+
 ### `previewFile`
 
 Generate a thumbnail preview for a file entity.
@@ -567,7 +628,7 @@ const { data } = await client.generatePublicLink({
 
 ### `listPublicLinksForFile`
 
-**Not yet implemented.**
+Fetches all public links previously generated for a file
 
 `GET /v1/files/{id}/public/links`
 
@@ -614,7 +675,7 @@ const { data } = await client.accessPublicLink({
 
 ### `revokePublicLink`
 
-**Not yet implemented.**
+Revokes a given public link by ID
 
 `DELETE /v1/files/public/links/{id}`
 
@@ -1304,6 +1365,44 @@ type DownloadFilesPayload = Array<{
 }>
 ```
 
+### `CreateZipJobPayload`
+
+Request payload to create a ZIP job for bulk file download.
+Provide either an explicit list of `file_entity_ids` (up to 1000) or an
+`entity_query` that resolves to file entities (up to 10000).
+
+
+```ts
+type CreateZipJobPayload = unknown | unknown
+```
+
+### `ZipJob`
+
+ZIP job status and result
+
+```ts
+type ZipJob = {
+  job_id?: string // uuid
+  status?: "queued" | "downloading" | "zipping" | "uploading" | "sending_notification" | "completed" | "failed"
+  progress?: {
+    total_files?: number
+    downloaded_files?: number
+    failed_files?: number
+  }
+  result?: {
+    file_entity_id?: string // uuid
+    download_url?: string // uri
+    expires_at?: string // date-time
+    zip_size_bytes?: number
+  }
+  error?: string
+  created_at?: string // date-time
+  created_by?: string
+  org_id?: string
+  updated_at?: string // date-time
+}
+```
+
 ### `VerifyCustomDownloadUrlPayload`
 
 ```ts

package/docs/webhooks.md

@@ -875,7 +875,9 @@ type WebhookConfig = {
   deliveryMode?: "json_base64" | "binary_multipart"
   multipartConfig?: {
     fileFieldName?: string
-    metadataFieldName?: string
+    fileFieldStrategy?: "single" | "multi"
+    fileSource?: string
+    extraFields?: Record<string, string>
   }
   filterConditions?: {
     conditions?: Array<{

package/package.json

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

package/dist/chunk-4W22EIRF.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], ["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;