@epilot/sdk 2.7.0 → 2.8.0-rc.0

package/docs/data-governance.md

@@ -125,7 +125,7 @@ const { data } = await client.createJob(
   {
     type: 'deletion',
     config_id: 'string',
-    scheduled_for: '1970-01-01',
+    scheduled_for: 'string',
     status: 'in_progress',
     started_at: '1970-01-01T00:00:00.000Z'
   },
@@ -141,7 +141,7 @@ const { data } = await client.createJob(
   "type": "deletion",
   "config_id": "string",
   "entity_schema": "string",
-  "scheduled_for": "1970-01-01",
+  "scheduled_for": "string",
   "status": "in_progress",
   "details": {},
   "started_at": "1970-01-01T00:00:00.000Z",
@@ -198,7 +198,7 @@ const { data } = await client.updateJob(
   "type": "deletion",
   "config_id": "string",
   "entity_schema": "string",
-  "scheduled_for": "1970-01-01",
+  "scheduled_for": "string",
   "status": "in_progress",
   "details": {},
   "started_at": "1970-01-01T00:00:00.000Z",
@@ -241,7 +241,7 @@ const { data } = await client.getJob({
   "type": "deletion",
   "config_id": "string",
   "entity_schema": "string",
-  "scheduled_for": "1970-01-01",
+  "scheduled_for": "string",
   "status": "in_progress",
   "details": {},
   "started_at": "1970-01-01T00:00:00.000Z",
@@ -325,13 +325,13 @@ const { data } = await client.getConfig({
   "schedule": {
     "frequency": "interval",
     "interval_days": 1,
-    "start_date": "1970-01-01",
-    "end_date": "1970-01-01"
+    "start_date": "string",
+    "end_date": "string"
   },
   "enabled": true,
   "created_at": "1970-01-01T00:00:00.000Z",
   "last_updated_at": "1970-01-01T00:00:00.000Z",
-  "next_run_at": "1970-01-01",
+  "next_run_at": "string",
   "relations_for_deletion": ["contact"],
   "last_run_at": "1970-01-01T00:00:00.000Z"
 }
@@ -362,7 +362,7 @@ const { data } = await client.createJobForConfig({
   "type": "deletion",
   "config_id": "string",
   "entity_schema": "string",
-  "scheduled_for": "1970-01-01",
+  "scheduled_for": "string",
   "status": "in_progress",
   "details": {},
   "started_at": "1970-01-01T00:00:00.000Z",
@@ -413,8 +413,8 @@ const { data } = await client.upsertConfig(
     schedule: {
       frequency: 'interval',
       interval_days: 1,
-      start_date: '1970-01-01',
-      end_date: '1970-01-01'
+      start_date: 'string',
+      end_date: 'string'
     },
     relations_for_deletion: ['contact'],
     enabled: true
@@ -446,13 +446,13 @@ const { data } = await client.upsertConfig(
   "schedule": {
     "frequency": "interval",
     "interval_days": 1,
-    "start_date": "1970-01-01",
-    "end_date": "1970-01-01"
+    "start_date": "string",
+    "end_date": "string"
   },
   "enabled": true,
   "created_at": "1970-01-01T00:00:00.000Z",
   "last_updated_at": "1970-01-01T00:00:00.000Z",
-  "next_run_at": "1970-01-01",
+  "next_run_at": "string",
   "relations_for_deletion": ["contact"],
   "last_run_at": "1970-01-01T00:00:00.000Z"
 }
@@ -505,13 +505,13 @@ const { data } = await client.listConfigs({
       "schedule": {
         "frequency": "interval",
         "interval_days": 1,
-        "start_date": "1970-01-01",
-        "end_date": "1970-01-01"
+        "start_date": "string",
+        "end_date": "string"
       },
       "enabled": true,
       "created_at": "1970-01-01T00:00:00.000Z",
       "last_updated_at": "1970-01-01T00:00:00.000Z",
-      "next_run_at": "1970-01-01",
+      "next_run_at": "string",
       "relations_for_deletion": ["contact"],
       "last_run_at": "1970-01-01T00:00:00.000Z"
     }
@@ -552,7 +552,7 @@ const { data } = await client.listJobs({
       "type": "deletion",
       "config_id": "string",
       "entity_schema": "string",
-      "scheduled_for": "1970-01-01",
+      "scheduled_for": "string",
       "status": "in_progress",
       "details": {},
       "started_at": "1970-01-01T00:00:00.000Z",

package/docs/design.md

@@ -1,6 +1,6 @@
 # Design Builder API v2
 
-- **Base URL:** `https://design-builder-api.{environment}.epilot.io`
+- **Base URL:** `https://design-builder-api.sls.epilot.io`
 - **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)
 
 ## Usage

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/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