import { APIResource } from "../core/resource.js";
import { APIPromise } from "../core/api-promise.js";
import { RequestOptions } from "../internal/request-options.js";
export declare class Beta extends APIResource {
    /**
     * Retrieve labels automatically detected for cells and ranges in the workbook.
     */
    getWorkbookLabels(id: string, options?: RequestOptions): APIPromise<BetaGetWorkbookLabelsResponse>;
    /**
     * Retrieve labels automatically detected for cells and ranges in the workbook.
     */
    getWorkbookParameters(id: string, options?: RequestOptions): APIPromise<BetaGetWorkbookParametersResponse>;
    /**
     * Search data labels across all spreadsheets uploaded to an account
     */
    searchLabels(body: BetaSearchLabelsParams, options?: RequestOptions): APIPromise<BetaSearchLabelsResponse>;
}
export interface BetaGetWorkbookLabelsResponse {
    /**
     * The date/time the labels were detected and stored
     */
    created: string;
    /**
     * The labels associated with the workbook
     */
    labels: Array<BetaGetWorkbookLabelsResponse.Label>;
    /**
     * The id of the workbook the labels belong to
     */
    workbook_id: string;
    /**
     * The version of the workbook the labels belong to
     */
    workbook_version: number;
}
export declare namespace BetaGetWorkbookLabelsResponse {
    interface Label {
        /**
         * The cell address/reference which the label applies to
         */
        at: string;
        /**
         * The cell address/reference which the label applies to
         */
        for: string;
        /**
         * The label string
         */
        text: string;
        /**
         * The type of the label, almost always text, not to be confused with cell type
         */
        type?: string | null;
    }
}
export interface BetaGetWorkbookParametersResponse {
    /**
     * The date/time the parameters were detected and stored
     */
    created: string;
    /**
     * The parameters associated with the workbook
     */
    parameters: Array<BetaGetWorkbookParametersResponse.Parameter>;
    /**
     * The id of the workbook the labels belong to
     */
    workbook_id: string;
    /**
     * The version of the workbook the labels belong to
     */
    workbook_version: number;
}
export declare namespace BetaGetWorkbookParametersResponse {
    interface Parameter {
        /**
         * The labels associated with the parameter
         */
        labels: Array<Parameter.Label>;
        /**
         * The cell address/reference containing the parameter
         */
        ref: string;
        /**
         * The type of value found in the parameter cell
         */
        type: 'blank' | 'date' | 'number' | 'string' | 'boolean' | 'error';
        /**
         * The value in the parameter cell, type is determined by the type field
         */
        value?: string | number | boolean | null;
    }
    namespace Parameter {
        interface Label {
            /**
             * The cell address/reference which the label applies to
             */
            at: string;
            /**
             * The label string
             */
            text: string;
        }
    }
}
/**
 * The results of a spreadsheet data label search.
 */
export interface BetaSearchLabelsResponse {
    results: Array<BetaSearchLabelsResponse.Result>;
}
export declare namespace BetaSearchLabelsResponse {
    /**
     * Contains a workbook that includes data labels that match the search query.
     */
    interface Result {
        /**
         * UUID for the user that uploaded the workbook. This will always be the UUID of
         * the account linked to the API key used in the request.
         */
        creator_id: string;
        /**
         * Generated description summarising the contents of the workbook
         */
        description: string;
        /**
         * Original filename of the workbook
         */
        filename: string;
        /**
         * Array of labels within the workbook that match the search query
         */
        labels: Array<Result.Label>;
        /**
         * Most recent version number of the workbook
         */
        latest_version: number;
        /**
         * Absolute URL for a thumbnail of the workbook's first sheet
         */
        thumbnail_url: string;
        /**
         * UUID for the workbook
         */
        workbook_id: string;
        /**
         * Relevance ranking of the workbook in relation to the search results (higher is
         * better)
         */
        score?: number | null;
    }
    namespace Result {
        /**
         * A label search result. Includes the location, text content, value, and score.
         */
        interface Label {
            /**
             * Cell reference or range that contains the labelled data
             */
            for: string;
            /**
             * Text content of the label
             */
            text: string;
            /**
             * The labelled data value(s). If a range of data is labelled, this will be a
             * stringified JSON array
             */
            value: string;
            /**
             * Relevance ranking of the workbook in relation to the search results (higher is
             * better)
             */
            score?: number | null;
        }
    }
}
export interface BetaSearchLabelsParams {
    query: string;
    /**
     * Maximum number of labels to return per workbook
     */
    max_labels?: number | null;
    /**
     * Maximum number of workbooks to return results for
     */
    max_results?: number | null;
}
export declare namespace Beta {
    export { type BetaGetWorkbookLabelsResponse as BetaGetWorkbookLabelsResponse, type BetaGetWorkbookParametersResponse as BetaGetWorkbookParametersResponse, type BetaSearchLabelsResponse as BetaSearchLabelsResponse, type BetaSearchLabelsParams as BetaSearchLabelsParams, };
}
//# sourceMappingURL=beta.d.ts.map