box-node-sdk/lib/managers/notes.d.ts

Official SDK for Box Platform APIs

import { NotesConvertRequestBodyV2026R0Input } from '../schemas/v2026R0/notesConvertRequestBodyV2026R0.js';
import { NotesConvertResponseV2026R0 } from '../schemas/v2026R0/notesConvertResponseV2026R0.js';
import { BoxVersionHeaderV2026R0 } from '../parameters/v2026R0/boxVersionHeaderV2026R0.js';
import { Authentication } from '../networking/auth.js';
import { NetworkSession } from '../networking/network.js';
import { CancellationToken } from '../internal/utils.js';
export declare class CreateNoteConvertV2026R0Optionals {
    readonly headers: CreateNoteConvertV2026R0Headers;
    readonly cancellationToken?: CancellationToken;
    constructor(fields: Omit<CreateNoteConvertV2026R0Optionals, 'headers' | 'cancellationToken'> & Partial<Pick<CreateNoteConvertV2026R0Optionals, 'headers' | 'cancellationToken'>>);
}
export interface CreateNoteConvertV2026R0OptionalsInput {
    readonly headers?: CreateNoteConvertV2026R0Headers;
    readonly cancellationToken?: CancellationToken;
}
export declare class CreateNoteConvertV2026R0Headers {
    /**
     * Version header. */
    readonly boxVersion: BoxVersionHeaderV2026R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
    constructor(fields: Omit<CreateNoteConvertV2026R0Headers, 'boxVersion' | 'extraHeaders'> & Partial<Pick<CreateNoteConvertV2026R0Headers, 'boxVersion' | 'extraHeaders'>>);
}
export interface CreateNoteConvertV2026R0HeadersInput {
    /**
     * Version header. */
    readonly boxVersion?: BoxVersionHeaderV2026R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
}
export declare class NotesManager {
    readonly auth?: Authentication;
    readonly networkSession: NetworkSession;
    constructor(fields: Omit<NotesManager, 'networkSession' | 'createNoteConvertV2026R0'> & Partial<Pick<NotesManager, 'networkSession'>>);
    /**
     * Creates a Box Note (`.boxnote` file) from supported source content. See the `content_format` field for supported formats.
     * @param {NotesConvertRequestBodyV2026R0Input} requestBodyInput Request body of createNoteConvertV2026R0 method
     * @param {CreateNoteConvertV2026R0OptionalsInput} optionalsInput
     * @returns {Promise<NotesConvertResponseV2026R0>}
     */
    createNoteConvertV2026R0(requestBodyInput: NotesConvertRequestBodyV2026R0Input, optionalsInput?: CreateNoteConvertV2026R0OptionalsInput): Promise<NotesConvertResponseV2026R0>;
}
export interface NotesManagerInput {
    readonly auth?: Authentication;
    readonly networkSession?: NetworkSession;
}
//# sourceMappingURL=notes.d.ts.map