@epilot/sdk 2.7.1 → 2.7.3

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/file.md

@@ -34,6 +34,7 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`downloadFiles`](#downloadfiles)
 - [`createZipJob`](#createzipjob)
 - [`getZipJob`](#getzipjob)
+- [`generateFileSummary`](#generatefilesummary)
 - [`verifyCustomDownloadUrl`](#verifycustomdownloadurl)
 - [`uploadFilePublic`](#uploadfilepublic)
 
@@ -68,6 +69,8 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`FileEntityId`](#fileentityid)
 - [`FileAttributes`](#fileattributes)
 - [`FileType`](#filetype)
+- [`FileSummaryStatus`](#filesummarystatus)
+- [`FileSummaryGenerationStatus`](#filesummarygenerationstatus)
 - [`CustomDownloadUrl`](#customdownloadurl)
 - [`FileEntity`](#fileentity)
 - [`CommonSaveFilePayload`](#commonsavefilepayload)
@@ -173,6 +176,9 @@ const { data } = await client.saveFileV2(
     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',
+    preview_summary: 'string',
+    short_summary: 'string',
+    summary_status: 'processing',
     s3ref: {}
   },
 )
@@ -198,6 +204,9 @@ const { data } = await client.saveFileV2(
   "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",
+  "preview_summary": "string",
+  "short_summary": "string",
+  "summary_status": "processing",
   "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
   "s3ref": {},
   "versions": [
@@ -265,6 +274,9 @@ const { data } = await client.getFile({
   "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",
+  "preview_summary": "string",
+  "short_summary": "string",
+  "summary_status": "processing",
   "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
   "s3ref": {},
   "versions": [
@@ -332,6 +344,9 @@ const { data } = await client.deleteFile({
   "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",
+  "preview_summary": "string",
+  "short_summary": "string",
+  "summary_status": "processing",
   "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
   "s3ref": {},
   "versions": [
@@ -509,6 +524,20 @@ const { data } = await client.getZipJob({
 
 ---
 
+### `generateFileSummary`
+
+Request AI generation of preview and short summaries for a file entity.
+
+`POST /v1/files/{id}/summary:generate`
+
+```ts
+const { data } = await client.generateFileSummary({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+---
+
 ### `previewFile`
 
 Generate a thumbnail preview for a file entity.
@@ -925,6 +954,9 @@ const { data } = await client.getFilesInCollection({
     "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",
+    "preview_summary": "string",
+    "short_summary": "string",
+    "summary_status": "processing",
     "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
     "s3ref": {},
     "versions": [
@@ -1039,6 +1071,9 @@ type FileAttributes = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 
@@ -1048,6 +1083,22 @@ type FileAttributes = {
 type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"
 ```
 
+### `FileSummaryStatus`
+
+Current AI summary generation state for the file.
+
+```ts
+type FileSummaryStatus = "processing" | "completed" | "failed" | "unsupported"
+```
+
+### `FileSummaryGenerationStatus`
+
+```ts
+type FileSummaryGenerationStatus = {
+  status: "processing" | "completed" | "failed" | "unsupported"
+}
+```
+
 ### `CustomDownloadUrl`
 
 Custom external download url used for the file
@@ -1075,6 +1126,9 @@ type FileEntity = {
   access_control: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string
   s3ref?: object
   versions: Array<{
@@ -1135,6 +1189,9 @@ type SaveS3FilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   s3ref?: unknown
 }
 ```
@@ -1161,6 +1218,9 @@ type SaveFileFromSourceURLPayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string // uri
 }
 ```
@@ -1187,6 +1247,9 @@ type SaveCustomFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 
@@ -1212,6 +1275,9 @@ type SaveFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   s3ref?: unknown
 } | {
   _id?: object
@@ -1232,6 +1298,9 @@ type SaveFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string // uri
 } | {
   _id?: object
@@ -1252,6 +1321,9 @@ type SaveFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 
@@ -1277,6 +1349,9 @@ type SaveFilePayloadV2 = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   s3ref?: unknown
 } | {
   _id?: object
@@ -1297,6 +1372,9 @@ type SaveFilePayloadV2 = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string // uri
 } | {
   _id?: object
@@ -1317,6 +1395,9 @@ type SaveFilePayloadV2 = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 

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