@epilot/sdk 2.7.0 → 2.7.2

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
@@ -70,6 +70,7 @@ const { data } = await designClient.getAllDesigns(...)
 - [`Theme`](#theme)
 - [`Application`](#application)
 - [`DesignParameters`](#designparameters)
+- [`ParseThemeFromDesignResp`](#parsethemefromdesignresp)
 
 ### `getAllDesigns`
 
@@ -558,7 +559,56 @@ const { data } = await client.getThemeFromDesign({
 <summary>Response</summary>
 
 ```json
-{}
+{
+  "theme": "NEW",
+  "design": {
+    "id": "string",
+    "last_modified_at": "string",
+    "style_name": "string",
+    "style": {
+      "logo": {
+        "main": {
+          "name": "string",
+          "display_name": "string",
+          "file_type": "LOGO",
+          "s3_object_key": "string",
+          "url": "string",
+          "file_id": "string"
+        }
+      },
+      "palette": {
+        "primary": "string",
+        "secondary": "string",
+        "error": "string",
+        "background": "string",
+        "paper": "string",
+        "navbar": "string",
+        "portal_login_background": "string"
+      },
+      "typography": {
+        "font": {
+          "font_id": "string",
+          "font_name": "string",
+          "font_family": "string",
+          "font_weight_regular": "string",
+          "font_weight_medium": "string",
+          "font_weight_bold": "string",
+          "urls": [
+            {
+              "type": "WOFF2",
+              "url": "string"
+            }
+          ]
+        },
+        "primary": "string",
+        "secondary": "string"
+      }
+    },
+    "custom_theme": "string",
+    "use_custom_theme": true,
+    "journey_design_tokens": {}
+  }
+}
 ```
 
 </details>
@@ -584,7 +634,8 @@ const { data } = await client.uploadFile()
   "display_name": "string",
   "file_type": "LOGO",
   "s3_object_key": "string",
-  "url": "string"
+  "url": "string",
+  "file_id": "string"
 }
 ```
 
@@ -614,7 +665,8 @@ const { data } = await client.getFiles({
     "display_name": "string",
     "file_type": "LOGO",
     "s3_object_key": "string",
-    "url": "string"
+    "url": "string",
+    "file_id": "string"
   }
 ]
 ```
@@ -802,6 +854,7 @@ type UploadFileRes = {
   file_type?: "LOGO" | "FONT" | "IMAGE"
   s3_object_key: string
   url: string
+  file_id?: string
 }
 ```
 
@@ -814,6 +867,7 @@ type GetFilesRes = Array<{
   file_type?: "LOGO" | "FONT" | "IMAGE"
   s3_object_key: string
   url: string
+  file_id?: string
 }>
 ```
 
@@ -1517,6 +1571,7 @@ type LogoData = {
     file_type?: "LOGO" | "FONT" | "IMAGE"
     s3_object_key: string
     url: string
+    file_id?: string
   }
 }
 ```
@@ -1617,6 +1672,7 @@ type FileData = {
   file_type?: "LOGO" | "FONT" | "IMAGE"
   s3_object_key: string
   url: string
+  file_id?: string
 }
 ```
 
@@ -1653,3 +1709,24 @@ type DesignParameters = {
   application?: string
 }
 ```
+
+### `ParseThemeFromDesignResp`
+
+```ts
+type ParseThemeFromDesignResp = {
+  theme?: "NEW" | "OLD"
+  design?: {
+    id?: string
+    last_modified_at?: string
+    style_name?: string
+    style?: {
+      logo?: { ... }
+      palette?: { ... }
+      typography?: { ... }
+    }
+    custom_theme?: string
+    use_custom_theme?: boolean
+    journey_design_tokens?: object
+  }
+}
+```

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

package/docs/journey.md

@@ -100,6 +100,7 @@ Get journey by id. Private journeys requires valid private token to be passed
 ```ts
 const { data } = await client.getJourney({
   id: '123e4567-e89b-12d3-a456-426614174000',
+  version: 1,
   source: 'example',
   orgId: 'example',
 })
@@ -1432,6 +1433,7 @@ Get journey by id
 ```ts
 const { data } = await client.getJourneyV2({
   id: '123e4567-e89b-12d3-a456-426614174000',
+  version: 1,
 })
 ```
 

package/docs/notes.md

@@ -36,6 +36,10 @@ const { data } = await notesClient.createNote(...)
 **Pinning**
 - [`pinNote`](#pinnote)
 
+**Archive**
+- [`archiveNote`](#archivenote)
+- [`unarchiveNote`](#unarchivenote)
+
 **Reactions**
 - [`addNoteReaction`](#addnotereaction)
 - [`removeNoteReaction`](#removenotereaction)
@@ -53,6 +57,7 @@ const { data } = await notesClient.createNote(...)
 - [`NoteEntityParent`](#noteentityparent)
 - [`NotePutRequestBody`](#noteputrequestbody)
 - [`NoteSearchByContextRequestBody`](#notesearchbycontextrequestbody)
+- [`NotesListFilter`](#noteslistfilter)
 - [`NotesSearchRequestResponse`](#notessearchrequestresponse)
 - [`NoteContexts`](#notecontexts)
 - [`WorkflowExecution`](#workflowexecution)
@@ -191,7 +196,8 @@ const { data } = await client.updateNote(
       }
     ],
     read_by: ['string'],
-    reactions: {}
+    reactions: {},
+    _archived_at: '1970-01-01T00:00:00.000Z'
   },
 )
 ```
@@ -229,6 +235,7 @@ const { data } = await client.searchNotesByContext(
       }
     ],
     include_related_schemas: ['string'],
+    filter: 'active',
     from: 0,
     size: 10
   },
@@ -251,6 +258,34 @@ const { data } = await client.pinNote({
 
 ---
 
+### `archiveNote`
+
+Archives a root Note entry by setting its `_archived_at` timestamp to the current server time. The same timestamp is cascaded to every comment under the note so the entire thread is hidden from defaul
+
+`POST /v1/note/{id}/archive`
+
+```ts
+const { data } = await client.archiveNote({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+---
+
+### `unarchiveNote`
+
+Unarchives a root Note entry by clearing its `_archived_at` value. The clear cascades to every comment under the note so the entire thread returns to the active view. Returns 400 if the supplied id is
+
+`POST /v1/note/{id}/unarchive`
+
+```ts
+const { data } = await client.unarchiveNote({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+---
+
 ### `getNoteContexts`
 
 Gets all the Entity and non-Entity records the Note is contextually attached to
@@ -491,6 +526,7 @@ type NotePatchRequestBody = {
   }>
   read_by?: string[]
   reactions?: Record<string, string[]>
+  _archived_at?: string // date-time
 }
 ```
 
@@ -577,6 +613,7 @@ type NotePutRequestBody = {
   }>
   read_by?: string[]
   reactions?: Record<string, string[]>
+  _archived_at?: string // date-time
 }
 ```
 
@@ -589,11 +626,20 @@ type NoteSearchByContextRequestBody = {
     id: string
   }>
   include_related_schemas?: string[]
+  filter?: "all" | "active" | "archived"
   from?: number
   size?: number
 }
 ```
 
+### `NotesListFilter`
+
+Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both.
+
+```ts
+type NotesListFilter = "all" | "active" | "archived"
+```
+
 ### `NotesSearchRequestResponse`
 
 ```ts