@epilot/sdk 2.8.0-rc.0 → 2.8.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