@epilot/sdk 2.7.1 → 2.7.2

package/dist/{notes.d-BcV_m5fe.d.cts → notes.d-rbcyHfiB.d.cts}

@@ -149,6 +149,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         /**
          * List of resolved Entity and non-Entity contexts attached to a given Note.
@@ -241,6 +245,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         /**
          * The Note's parent Note
@@ -334,6 +342,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         export interface NotePatchRequestBody {
             /**
@@ -387,6 +399,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         export interface NotePostRequestBody {
             /**
@@ -523,6 +539,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         export interface NoteSearchByContextRequestBody {
             contexts: [
@@ -539,6 +559,7 @@ declare namespace Components {
              * When set, the API resolves related entities of these schemas for the primary entity context and includes their notes in the results.
              */
             include_related_schemas?: string[];
+            filter?: /* Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both. */ NotesListFilter;
             /**
              * The index of the first Note to return in this query
              */
@@ -548,6 +569,10 @@ declare namespace Components {
              */
             size?: number;
         }
+        /**
+         * Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both.
+         */
+        export type NotesListFilter = "all" | "active" | "archived";
         export interface NotesSearchRequestResponse {
             /**
              * The number of Note entries returned in this query
@@ -604,6 +629,20 @@ declare namespace Paths {
             export type $200 = /* A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place. */ Components.Schemas.NoteEntity;
         }
     }
+    namespace ArchiveNote {
+        namespace Parameters {
+            /**
+             * The Entity ID of the Note entry to archive
+             */
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: /* The Entity ID of the Note entry to archive */ Parameters.Id;
+        }
+        namespace Responses {
+            export type $200 = /* A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place. */ Components.Schemas.NoteEntity;
+        }
+    }
     namespace CreateNote {
         export type RequestBody = Components.Schemas.NotePostRequestBody;
         namespace Responses {
@@ -670,6 +709,7 @@ declare namespace Paths {
              * The ID of the Contextual Entity from where to retrieve Notes
              */
             export type EntityId = string;
+            export type Filter = /* Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both. */ Components.Schemas.NotesListFilter;
             /**
              * The index of the first Note to return in this query
              */
@@ -684,6 +724,7 @@ declare namespace Paths {
         }
         export interface QueryParameters {
             contexts?: Parameters.Contexts;
+            filter?: Parameters.Filter;
             from?: /* The index of the first Note to return in this query */ Parameters.From;
             size?: /* The number of Note entries to return in this query */ Parameters.Size;
         }
@@ -761,6 +802,20 @@ declare namespace Paths {
             export type $200 = /* A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place. */ Components.Schemas.NoteEntity;
         }
     }
+    namespace UnarchiveNote {
+        namespace Parameters {
+            /**
+             * The Entity ID of the Note entry to unarchive
+             */
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: /* The Entity ID of the Note entry to unarchive */ Parameters.Id;
+        }
+        namespace Responses {
+            export type $200 = /* A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place. */ Components.Schemas.NoteEntity;
+        }
+    }
     namespace UpdateNote {
         namespace Parameters {
             /**
@@ -778,7 +833,6 @@ declare namespace Paths {
     }
 }
 
-
 interface OperationMethods {
   /**
    * createNote - createNote
@@ -861,6 +915,26 @@ interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.PinNote.Responses.$200>
+  /**
+   * archiveNote - 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 default listings. Returns 400 if the supplied id is a comment.
+   */
+  'archiveNote'(
+    parameters?: Parameters<Paths.ArchiveNote.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ArchiveNote.Responses.$200>
+  /**
+   * unarchiveNote - 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 a comment.
+   */
+  'unarchiveNote'(
+    parameters?: Parameters<Paths.UnarchiveNote.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UnarchiveNote.Responses.$200>
   /**
    * getNoteContexts - getNoteContexts
    * 
@@ -995,6 +1069,30 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.PinNote.Responses.$200>
   }
+  ['/v1/note/{id}/archive']: {
+    /**
+     * archiveNote - 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 default listings. Returns 400 if the supplied id is a comment.
+     */
+    'post'(
+      parameters?: Parameters<Paths.ArchiveNote.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ArchiveNote.Responses.$200>
+  }
+  ['/v1/note/{id}/unarchive']: {
+    /**
+     * unarchiveNote - 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 a comment.
+     */
+    'post'(
+      parameters?: Parameters<Paths.UnarchiveNote.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UnarchiveNote.Responses.$200>
+  }
   ['/v1/note/{id}/context']: {
     /**
      * getNoteContexts - getNoteContexts
@@ -1047,7 +1145,6 @@ interface PathsDictionary {
 
 type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
-
 type ContextType = Components.Schemas.ContextType;
 type CreatedByType = Components.Schemas.CreatedByType;
 type Entity = Components.Schemas.Entity;
@@ -1060,9 +1157,10 @@ type NotePatchRequestBody = Components.Schemas.NotePatchRequestBody;
 type NotePostRequestBody = Components.Schemas.NotePostRequestBody;
 type NotePutRequestBody = Components.Schemas.NotePutRequestBody;
 type NoteSearchByContextRequestBody = Components.Schemas.NoteSearchByContextRequestBody;
+type NotesListFilter = Components.Schemas.NotesListFilter;
 type NotesSearchRequestResponse = Components.Schemas.NotesSearchRequestResponse;
 type ReactionRequest = Components.Schemas.ReactionRequest;
 type ToggleReactionsRequest = Components.Schemas.ToggleReactionsRequest;
 type WorkflowExecution = Components.Schemas.WorkflowExecution;
 
-export { type Client as C, type Entity as E, type NonHydratedNoteEntity as N, type OperationMethods as O, Paths as P, type ReactionRequest as R, type ToggleReactionsRequest as T, type WorkflowExecution as W, Components as a, type PathsDictionary as b, type ContextType as c, type CreatedByType as d, type NoteContexts as e, type NoteEntity as f, type NoteEntityParent as g, type NoteGetRequestResponse as h, type NotePatchRequestBody as i, type NotePostRequestBody as j, type NotePutRequestBody as k, type NoteSearchByContextRequestBody as l, type NotesSearchRequestResponse as m };
+export { type Client as C, type Entity as E, type NonHydratedNoteEntity as N, type OperationMethods as O, Paths as P, type ReactionRequest as R, type ToggleReactionsRequest as T, type WorkflowExecution as W, Components as a, type PathsDictionary as b, type ContextType as c, type CreatedByType as d, type NoteContexts as e, type NoteEntity as f, type NoteEntityParent as g, type NoteGetRequestResponse as h, type NotePatchRequestBody as i, type NotePostRequestBody as j, type NotePutRequestBody as k, type NoteSearchByContextRequestBody as l, type NotesListFilter as m, type NotesSearchRequestResponse as n };

package/dist/{notes.d-BcV_m5fe.d.ts → notes.d-rbcyHfiB.d.ts}

@@ -149,6 +149,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         /**
          * List of resolved Entity and non-Entity contexts attached to a given Note.
@@ -241,6 +245,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         /**
          * The Note's parent Note
@@ -334,6 +342,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         export interface NotePatchRequestBody {
             /**
@@ -387,6 +399,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         export interface NotePostRequestBody {
             /**
@@ -523,6 +539,10 @@ declare namespace Components {
             reactions?: {
                 [name: string]: string[];
             };
+            /**
+             * The timestamp of when this Note was archived. Absent or null means the Note is active.
+             */
+            _archived_at?: string | null; // date-time
         }
         export interface NoteSearchByContextRequestBody {
             contexts: [
@@ -539,6 +559,7 @@ declare namespace Components {
              * When set, the API resolves related entities of these schemas for the primary entity context and includes their notes in the results.
              */
             include_related_schemas?: string[];
+            filter?: /* Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both. */ NotesListFilter;
             /**
              * The index of the first Note to return in this query
              */
@@ -548,6 +569,10 @@ declare namespace Components {
              */
             size?: number;
         }
+        /**
+         * Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both.
+         */
+        export type NotesListFilter = "all" | "active" | "archived";
         export interface NotesSearchRequestResponse {
             /**
              * The number of Note entries returned in this query
@@ -604,6 +629,20 @@ declare namespace Paths {
             export type $200 = /* A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place. */ Components.Schemas.NoteEntity;
         }
     }
+    namespace ArchiveNote {
+        namespace Parameters {
+            /**
+             * The Entity ID of the Note entry to archive
+             */
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: /* The Entity ID of the Note entry to archive */ Parameters.Id;
+        }
+        namespace Responses {
+            export type $200 = /* A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place. */ Components.Schemas.NoteEntity;
+        }
+    }
     namespace CreateNote {
         export type RequestBody = Components.Schemas.NotePostRequestBody;
         namespace Responses {
@@ -670,6 +709,7 @@ declare namespace Paths {
              * The ID of the Contextual Entity from where to retrieve Notes
              */
             export type EntityId = string;
+            export type Filter = /* Archive-state filter. 'active' (default) returns non-archived notes only, 'archived' returns only archived notes, 'all' returns both. */ Components.Schemas.NotesListFilter;
             /**
              * The index of the first Note to return in this query
              */
@@ -684,6 +724,7 @@ declare namespace Paths {
         }
         export interface QueryParameters {
             contexts?: Parameters.Contexts;
+            filter?: Parameters.Filter;
             from?: /* The index of the first Note to return in this query */ Parameters.From;
             size?: /* The number of Note entries to return in this query */ Parameters.Size;
         }
@@ -761,6 +802,20 @@ declare namespace Paths {
             export type $200 = /* A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place. */ Components.Schemas.NoteEntity;
         }
     }
+    namespace UnarchiveNote {
+        namespace Parameters {
+            /**
+             * The Entity ID of the Note entry to unarchive
+             */
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: /* The Entity ID of the Note entry to unarchive */ Parameters.Id;
+        }
+        namespace Responses {
+            export type $200 = /* A note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place. */ Components.Schemas.NoteEntity;
+        }
+    }
     namespace UpdateNote {
         namespace Parameters {
             /**
@@ -778,7 +833,6 @@ declare namespace Paths {
     }
 }
 
-
 interface OperationMethods {
   /**
    * createNote - createNote
@@ -861,6 +915,26 @@ interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.PinNote.Responses.$200>
+  /**
+   * archiveNote - 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 default listings. Returns 400 if the supplied id is a comment.
+   */
+  'archiveNote'(
+    parameters?: Parameters<Paths.ArchiveNote.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ArchiveNote.Responses.$200>
+  /**
+   * unarchiveNote - 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 a comment.
+   */
+  'unarchiveNote'(
+    parameters?: Parameters<Paths.UnarchiveNote.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UnarchiveNote.Responses.$200>
   /**
    * getNoteContexts - getNoteContexts
    * 
@@ -995,6 +1069,30 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.PinNote.Responses.$200>
   }
+  ['/v1/note/{id}/archive']: {
+    /**
+     * archiveNote - 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 default listings. Returns 400 if the supplied id is a comment.
+     */
+    'post'(
+      parameters?: Parameters<Paths.ArchiveNote.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ArchiveNote.Responses.$200>
+  }
+  ['/v1/note/{id}/unarchive']: {
+    /**
+     * unarchiveNote - 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 a comment.
+     */
+    'post'(
+      parameters?: Parameters<Paths.UnarchiveNote.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UnarchiveNote.Responses.$200>
+  }
   ['/v1/note/{id}/context']: {
     /**
      * getNoteContexts - getNoteContexts
@@ -1047,7 +1145,6 @@ interface PathsDictionary {
 
 type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
-
 type ContextType = Components.Schemas.ContextType;
 type CreatedByType = Components.Schemas.CreatedByType;
 type Entity = Components.Schemas.Entity;
@@ -1060,9 +1157,10 @@ type NotePatchRequestBody = Components.Schemas.NotePatchRequestBody;
 type NotePostRequestBody = Components.Schemas.NotePostRequestBody;
 type NotePutRequestBody = Components.Schemas.NotePutRequestBody;
 type NoteSearchByContextRequestBody = Components.Schemas.NoteSearchByContextRequestBody;
+type NotesListFilter = Components.Schemas.NotesListFilter;
 type NotesSearchRequestResponse = Components.Schemas.NotesSearchRequestResponse;
 type ReactionRequest = Components.Schemas.ReactionRequest;
 type ToggleReactionsRequest = Components.Schemas.ToggleReactionsRequest;
 type WorkflowExecution = Components.Schemas.WorkflowExecution;
 
-export { type Client as C, type Entity as E, type NonHydratedNoteEntity as N, type OperationMethods as O, Paths as P, type ReactionRequest as R, type ToggleReactionsRequest as T, type WorkflowExecution as W, Components as a, type PathsDictionary as b, type ContextType as c, type CreatedByType as d, type NoteContexts as e, type NoteEntity as f, type NoteEntityParent as g, type NoteGetRequestResponse as h, type NotePatchRequestBody as i, type NotePostRequestBody as j, type NotePutRequestBody as k, type NoteSearchByContextRequestBody as l, type NotesSearchRequestResponse as m };
+export { type Client as C, type Entity as E, type NonHydratedNoteEntity as N, type OperationMethods as O, Paths as P, type ReactionRequest as R, type ToggleReactionsRequest as T, type WorkflowExecution as W, Components as a, type PathsDictionary as b, type ContextType as c, type CreatedByType as d, type NoteContexts as e, type NoteEntity as f, type NoteEntityParent as g, type NoteGetRequestResponse as h, type NotePatchRequestBody as i, type NotePostRequestBody as j, type NotePutRequestBody as k, type NoteSearchByContextRequestBody as l, type NotesListFilter as m, type NotesSearchRequestResponse as n };