import type { api_ItemFields } from '../models/api_ItemFields'; import type { internal_notes_CreateNoteHandlerInput } from '../models/internal_notes_CreateNoteHandlerInput'; import type { internal_notes_ListNotesOutput } from '../models/internal_notes_ListNotesOutput'; import type { internal_notes_Note } from '../models/internal_notes_Note'; import type { internal_notes_UpdateNoteInput } from '../models/internal_notes_UpdateNoteInput'; import type { CancelablePromise } from '../core/CancelablePromise'; export declare class NotesService { /** * List notes * * Returns a paginated list of notes. Filter by a client or company by * supplying both entityId and entityType; when neither is supplied, all * notes the caller can access are returned. Supplying entityId without * entityType is rejected. * * @param entityId Filter by the ID of the client or company the note is attached to * @param entityType Filter by entity type * @param limit Maximum number of records to return * @param nextToken Pagination cursor returned by a previous request * * @example * await assembly.listNotes(); */ static listNotes({ entityId, entityType, limit, nextToken, }: { /** * Filter by the ID of the client or company the note is attached to */ entityId?: string; /** * Filter by entity type */ entityType?: 'client' | 'company'; /** * Maximum number of records to return */ limit?: number; /** * Pagination cursor returned by a previous request */ nextToken?: string; }): CancelablePromise; /** * Create a note * * Creates an internal note attached to a client or company. Requires title, * entityId, and entityType; content is optional. Only internal users with * sufficient privileges can create notes. * * @example * await assembly.createNote({ requestBody: ... }); */ static createNote({ requestBody, }: { /** * Note to create */ requestBody: internal_notes_CreateNoteHandlerInput; }): CancelablePromise; /** * Delete a note * * Permanently deletes a note by ID and returns a deletion confirmation. * Only internal users with access to the note's entity can delete it. * * @param id Note ID * * @example * await assembly.deleteNote({ id: ... }); */ static deleteNote({ id, }: { /** * Note ID */ id: string; }): CancelablePromise; /** * Retrieve a note * * Returns a single note by ID. Only internal users with access to the * note's entity can retrieve it. * * @param id Note ID * * @example * await assembly.retrieveNote({ id: ... }); */ static retrieveNote({ id, }: { /** * Note ID */ id: string; }): CancelablePromise; /** * Update a note * * Updates the title and/or content of an existing note. Only the fields * supplied are changed. Only internal users with access to the note's * entity can update it. * * @param id Note ID * * @example * await assembly.updateNote({ id: ..., requestBody: ... }); */ static updateNote({ id, requestBody, }: { /** * Note ID */ id: string; /** * Fields to update */ requestBody: internal_notes_UpdateNoteInput; }): CancelablePromise; }