flowus-api-sdk/dist/models/BlockData.d.ts

Official TypeScript/JavaScript SDK for FlowUs API - Create, manage, and interact with FlowUs pages, databases, and blocks

/**
 * FlowUs API
 * FlowUs Developer API
 *
 * The version of the OpenAPI document: 1.0.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { BlockDataExternal } from './BlockDataExternal';
import type { RichTextItem } from './RichTextItem';
import type { BlockDataFile } from './BlockDataFile';
import type { BlockDataSyncedFrom } from './BlockDataSyncedFrom';
import type { Icon } from './Icon';
/**
 * 块类型特定的数据内容
 * @export
 * @interface BlockData
 */
export interface BlockData {
    /**
     * 富文本内容
     * @type {Array<RichTextItem>}
     * @memberof BlockData
     */
    rich_text?: Array<RichTextItem>;
    /**
     * 文本颜色
     * @type {string}
     * @memberof BlockData
     */
    text_color?: BlockDataTextColorEnum;
    /**
     * 背景颜色
     * @type {string}
     * @memberof BlockData
     */
    background_color?: BlockDataBackgroundColorEnum;
    /**
     * 待办事项是否完成
     * @type {boolean}
     * @memberof BlockData
     */
    checked?: boolean;
    /**
     * 代码块语言
     * @type {string}
     * @memberof BlockData
     */
    language?: string;
    /**
     * 链接地址
     * @type {string}
     * @memberof BlockData
     */
    url?: string;
    /**
     * 说明文字
     * @type {Array<RichTextItem>}
     * @memberof BlockData
     */
    caption?: Array<RichTextItem>;
    /**
     * 图标
     * @type {Icon}
     * @memberof BlockData
     */
    icon?: Icon;
    /**
     * 数学公式表达式
     * @type {string}
     * @memberof BlockData
     */
    expression?: string;
    /**
     * 页面引用ID
     * @type {string}
     * @memberof BlockData
     */
    page_id?: string;
    /**
     * 表格列数
     * @type {number}
     * @memberof BlockData
     */
    table_width?: number;
    /**
     * 是否有列标题
     * @type {boolean}
     * @memberof BlockData
     */
    has_column_header?: boolean;
    /**
     * 是否有行标题
     * @type {boolean}
     * @memberof BlockData
     */
    has_row_header?: boolean;
    /**
     * 表格单元格内容
     * @type {Array<Array<RichTextItem>>}
     * @memberof BlockData
     */
    cells?: Array<Array<RichTextItem>>;
    /**
     * 子页面或子数据库标题
     * @type {string}
     * @memberof BlockData
     */
    title?: string;
    /**
     *
     * @type {BlockDataSyncedFrom}
     * @memberof BlockData
     */
    synced_from?: BlockDataSyncedFrom;
    /**
     *
     * @type {BlockDataFile}
     * @memberof BlockData
     */
    file?: BlockDataFile;
    /**
     *
     * @type {BlockDataExternal}
     * @memberof BlockData
     */
    external?: BlockDataExternal;
}
/**
 * @export
 */
export declare const BlockDataTextColorEnum: {
    readonly Default: "default";
    readonly Gray: "gray";
    readonly Brown: "brown";
    readonly Orange: "orange";
    readonly Yellow: "yellow";
    readonly Green: "green";
    readonly Blue: "blue";
    readonly Purple: "purple";
    readonly Pink: "pink";
    readonly Red: "red";
};
export type BlockDataTextColorEnum = typeof BlockDataTextColorEnum[keyof typeof BlockDataTextColorEnum];
/**
 * @export
 */
export declare const BlockDataBackgroundColorEnum: {
    readonly Default: "default";
    readonly Gray: "gray";
    readonly Brown: "brown";
    readonly Orange: "orange";
    readonly Yellow: "yellow";
    readonly Green: "green";
    readonly Blue: "blue";
    readonly Purple: "purple";
    readonly Pink: "pink";
    readonly Red: "red";
};
export type BlockDataBackgroundColorEnum = typeof BlockDataBackgroundColorEnum[keyof typeof BlockDataBackgroundColorEnum];
/**
 * Check if a given object implements the BlockData interface.
 */
export declare function instanceOfBlockData(value: object): value is BlockData;
export declare function BlockDataFromJSON(json: any): BlockData;
export declare function BlockDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): BlockData;
export declare function BlockDataToJSON(json: any): BlockData;
export declare function BlockDataToJSONTyped(value?: BlockData | null, ignoreDiscriminator?: boolean): any;