flowus-api-sdk/dist/models/Block.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 { User } from './User';
import type { Parent } from './Parent';
import type { BlockData } from './BlockData';
/**
 *
 * @export
 * @interface Block
 */
export interface Block {
    /**
     *
     * @type {string}
     * @memberof Block
     */
    object?: BlockObjectEnum;
    /**
     *
     * @type {string}
     * @memberof Block
     */
    id?: string;
    /**
     *
     * @type {Parent}
     * @memberof Block
     */
    parent?: Parent;
    /**
     *
     * @type {string}
     * @memberof Block
     */
    type?: BlockTypeEnum;
    /**
     *
     * @type {Date}
     * @memberof Block
     */
    created_time?: Date;
    /**
     *
     * @type {User}
     * @memberof Block
     */
    created_by?: User;
    /**
     *
     * @type {Date}
     * @memberof Block
     */
    last_edited_time?: Date;
    /**
     *
     * @type {User}
     * @memberof Block
     */
    last_edited_by?: User;
    /**
     *
     * @type {boolean}
     * @memberof Block
     */
    archived?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof Block
     */
    has_children?: boolean;
    /**
     *
     * @type {BlockData}
     * @memberof Block
     */
    data?: BlockData;
}
/**
 * @export
 */
export declare const BlockObjectEnum: {
    readonly Block: "block";
};
export type BlockObjectEnum = typeof BlockObjectEnum[keyof typeof BlockObjectEnum];
/**
 * @export
 */
export declare const BlockTypeEnum: {
    readonly Paragraph: "paragraph";
    readonly Heading1: "heading_1";
    readonly Heading2: "heading_2";
    readonly Heading3: "heading_3";
    readonly BulletedListItem: "bulleted_list_item";
    readonly NumberedListItem: "numbered_list_item";
    readonly ToDo: "to_do";
    readonly Quote: "quote";
    readonly Toggle: "toggle";
    readonly Code: "code";
    readonly Image: "image";
    readonly File: "file";
    readonly Bookmark: "bookmark";
    readonly Embed: "embed";
    readonly Callout: "callout";
    readonly Equation: "equation";
    readonly LinkToPage: "link_to_page";
    readonly Template: "template";
    readonly SyncedBlock: "synced_block";
    readonly Divider: "divider";
    readonly ColumnList: "column_list";
    readonly Column: "column";
    readonly Table: "table";
    readonly TableRow: "table_row";
    readonly ChildPage: "child_page";
    readonly ChildDatabase: "child_database";
};
export type BlockTypeEnum = typeof BlockTypeEnum[keyof typeof BlockTypeEnum];
/**
 * Check if a given object implements the Block interface.
 */
export declare function instanceOfBlock(value: object): value is Block;
export declare function BlockFromJSON(json: any): Block;
export declare function BlockFromJSONTyped(json: any, ignoreDiscriminator: boolean): Block;
export declare function BlockToJSON(json: any): Block;
export declare function BlockToJSONTyped(value?: Block | null, ignoreDiscriminator?: boolean): any;