attio-js/dist/commonjs/sdk/notes.d.ts

Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.

import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import { DeleteV2NotesNoteIdRequest, DeleteV2NotesNoteIdResponse } from "../models/operations/deletev2notesnoteid.js";
import { GetV2NotesRequest, GetV2NotesResponse } from "../models/operations/getv2notes.js";
import { GetV2NotesNoteIdRequest, GetV2NotesNoteIdResponse } from "../models/operations/getv2notesnoteid.js";
import { PostV2NotesRequest, PostV2NotesResponse } from "../models/operations/postv2notes.js";
export declare class Notes extends ClientSDK {
    /**
     * List notes
     *
     * @remarks
     * List notes for all records or for a specific record.
     *
     * Required scopes: `note:read`, `object_configuration:read`, `record_permission:read`.
     */
    list(request: GetV2NotesRequest, options?: RequestOptions): Promise<GetV2NotesResponse>;
    /**
     * Create a note
     *
     * @remarks
     * Creates a new note for a given record.
     *
     * Required scopes: `note:read-write`, `object_configuration:read`, `record_permission:read`.
     */
    create(request: PostV2NotesRequest, options?: RequestOptions): Promise<PostV2NotesResponse>;
    /**
     * Get a note
     *
     * @remarks
     * Get a single note by ID.
     *
     * Required scopes: `note:read`, `object_configuration:read`, `record_permission:read`.
     */
    get(request: GetV2NotesNoteIdRequest, options?: RequestOptions): Promise<GetV2NotesNoteIdResponse>;
    /**
     * Delete a note
     *
     * @remarks
     * Delete a single note by ID.
     *
     * Required scopes: `note:read-write`.
     */
    delete(request: DeleteV2NotesNoteIdRequest, options?: RequestOptions): Promise<DeleteV2NotesNoteIdResponse>;
}
//# sourceMappingURL=notes.d.ts.map