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

Official SDK for Box Platform APIs

import { HubDocumentPagesV2025R0 } from '../schemas/v2025R0/hubDocumentPagesV2025R0.js';
import { BoxVersionHeaderV2025R0 } from '../parameters/v2025R0/boxVersionHeaderV2025R0.js';
import { HubDocumentBlocksV2025R0 } from '../schemas/v2025R0/hubDocumentBlocksV2025R0.js';
import { Authentication } from '../networking/auth.js';
import { NetworkSession } from '../networking/network.js';
import { CancellationToken } from '../internal/utils.js';
export declare class GetHubDocumentPagesV2025R0Optionals {
    readonly headers: GetHubDocumentPagesV2025R0Headers;
    readonly cancellationToken?: CancellationToken;
    constructor(fields: Omit<GetHubDocumentPagesV2025R0Optionals, 'headers' | 'cancellationToken'> & Partial<Pick<GetHubDocumentPagesV2025R0Optionals, 'headers' | 'cancellationToken'>>);
}
export interface GetHubDocumentPagesV2025R0OptionalsInput {
    readonly headers?: GetHubDocumentPagesV2025R0Headers;
    readonly cancellationToken?: CancellationToken;
}
export declare class GetHubDocumentBlocksV2025R0Optionals {
    readonly headers: GetHubDocumentBlocksV2025R0Headers;
    readonly cancellationToken?: CancellationToken;
    constructor(fields: Omit<GetHubDocumentBlocksV2025R0Optionals, 'headers' | 'cancellationToken'> & Partial<Pick<GetHubDocumentBlocksV2025R0Optionals, 'headers' | 'cancellationToken'>>);
}
export interface GetHubDocumentBlocksV2025R0OptionalsInput {
    readonly headers?: GetHubDocumentBlocksV2025R0Headers;
    readonly cancellationToken?: CancellationToken;
}
export interface GetHubDocumentPagesV2025R0QueryParams {
    /**
     * The unique identifier that represent a hub.
     *
     * The ID for any hub can be determined
     * by visiting this hub in the web application
     * and copying the ID from the URL. For example,
     * for the URL `https://*.app.box.com/hubs/123`
     * the `hub_id` is `123`. */
    readonly hubId: string;
    /**
     * Defines the position marker at which to begin returning results. This is
     * used when paginating using marker-based pagination. */
    readonly marker?: string;
    /**
     * The maximum number of items to return per page. */
    readonly limit?: number;
}
export declare class GetHubDocumentPagesV2025R0Headers {
    /**
     * Version header. */
    readonly boxVersion: BoxVersionHeaderV2025R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
    constructor(fields: Omit<GetHubDocumentPagesV2025R0Headers, 'boxVersion' | 'extraHeaders'> & Partial<Pick<GetHubDocumentPagesV2025R0Headers, 'boxVersion' | 'extraHeaders'>>);
}
export interface GetHubDocumentPagesV2025R0HeadersInput {
    /**
     * Version header. */
    readonly boxVersion?: BoxVersionHeaderV2025R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
}
export interface GetHubDocumentBlocksV2025R0QueryParams {
    /**
     * The unique identifier that represent a hub.
     *
     * The ID for any hub can be determined
     * by visiting this hub in the web application
     * and copying the ID from the URL. For example,
     * for the URL `https://*.app.box.com/hubs/123`
     * the `hub_id` is `123`. */
    readonly hubId: string;
    /**
     * The unique identifier of a page within the Box Hub. */
    readonly pageId: string;
    /**
     * Defines the position marker at which to begin returning results. This is
     * used when paginating using marker-based pagination. */
    readonly marker?: string;
    /**
     * The maximum number of items to return per page. */
    readonly limit?: number;
}
export declare class GetHubDocumentBlocksV2025R0Headers {
    /**
     * Version header. */
    readonly boxVersion: BoxVersionHeaderV2025R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
    constructor(fields: Omit<GetHubDocumentBlocksV2025R0Headers, 'boxVersion' | 'extraHeaders'> & Partial<Pick<GetHubDocumentBlocksV2025R0Headers, 'boxVersion' | 'extraHeaders'>>);
}
export interface GetHubDocumentBlocksV2025R0HeadersInput {
    /**
     * Version header. */
    readonly boxVersion?: BoxVersionHeaderV2025R0;
    /**
     * Extra headers that will be included in the HTTP request. */
    readonly extraHeaders?: {
        readonly [key: string]: undefined | string;
    };
}
export declare class HubDocumentManager {
    readonly auth?: Authentication;
    readonly networkSession: NetworkSession;
    constructor(fields: Omit<HubDocumentManager, 'networkSession' | 'getHubDocumentPagesV2025R0' | 'getHubDocumentBlocksV2025R0'> & Partial<Pick<HubDocumentManager, 'networkSession'>>);
    /**
     * Retrieves a list of Hub Document Pages for the specified hub.
     * Includes both root-level pages and sub pages.
     * @param {GetHubDocumentPagesV2025R0QueryParams} queryParams Query parameters of getHubDocumentPagesV2025R0 method
     * @param {GetHubDocumentPagesV2025R0OptionalsInput} optionalsInput
     * @returns {Promise<HubDocumentPagesV2025R0>}
     */
    getHubDocumentPagesV2025R0(queryParams: GetHubDocumentPagesV2025R0QueryParams, optionalsInput?: GetHubDocumentPagesV2025R0OptionalsInput): Promise<HubDocumentPagesV2025R0>;
    /**
     * Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items.
     * Blocks are hierarchically organized by their `parent_id`.
     * Blocks are sorted in order based on user specification in the user interface.
     * The response will only include content blocks that belong to the specified page. This will not include sub pages or sub page content blocks.
     * @param {GetHubDocumentBlocksV2025R0QueryParams} queryParams Query parameters of getHubDocumentBlocksV2025R0 method
     * @param {GetHubDocumentBlocksV2025R0OptionalsInput} optionalsInput
     * @returns {Promise<HubDocumentBlocksV2025R0>}
     */
    getHubDocumentBlocksV2025R0(queryParams: GetHubDocumentBlocksV2025R0QueryParams, optionalsInput?: GetHubDocumentBlocksV2025R0OptionalsInput): Promise<HubDocumentBlocksV2025R0>;
}
export interface HubDocumentManagerInput {
    readonly auth?: Authentication;
    readonly networkSession?: NetworkSession;
}
//# sourceMappingURL=hubDocument.d.ts.map