flowus-api-sdk
Version:
Official TypeScript/JavaScript SDK for FlowUs API - Create, manage, and interact with FlowUs pages, databases, and blocks
218 lines (217 loc) • 9.19 kB
TypeScript
/**
* 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 * as runtime from '../runtime';
import type { AppendBlockChildrenRequest, AppendBlockChildrenResponse, Block, CreateDatabaseRequest, CreatePageRequest, CreatePageResponse, Database, DeleteBlockResponse, GetBlockChildrenResponse, Page, QueryDatabaseRequest, QueryDatabaseResponse, SearchRequest, SearchResult, UpdateBlockRequest, UpdateDatabaseRequest, UpdatePageRequest, UserMe, V1SearchRequest, V1SearchResponse } from '../models/index';
export interface AppendBlockChildrenOperationRequest {
blockId: string;
appendBlockChildrenRequest: AppendBlockChildrenRequest;
}
export interface CreateDatabaseOperationRequest {
createDatabaseRequest: CreateDatabaseRequest;
}
export interface CreatePageOperationRequest {
createPageRequest: CreatePageRequest;
}
export interface DeleteBlockRequest {
blockId: string;
}
export interface GetBlockRequest {
blockId: string;
}
export interface GetBlockChildrenRequest {
blockId: string;
startCursor?: string;
pageSize?: number;
}
export interface GetDatabaseRequest {
databaseId: string;
}
export interface GetPageRequest {
pageId: string;
}
export interface QueryDatabaseOperationRequest {
databaseId: string;
queryDatabaseRequest?: QueryDatabaseRequest;
}
export interface SearchPagesRequest {
searchRequest: SearchRequest;
}
export interface UpdateBlockOperationRequest {
blockId: string;
updateBlockRequest: UpdateBlockRequest;
}
export interface UpdateDatabaseOperationRequest {
databaseId: string;
updateDatabaseRequest: UpdateDatabaseRequest;
}
export interface UpdatePageOperationRequest {
pageId: string;
updatePageRequest: UpdatePageRequest;
}
export interface V1SearchOperationRequest {
v1SearchRequest: V1SearchRequest;
}
/**
*
*/
export declare class DefaultApi extends runtime.BaseAPI {
/**
* 向指定块追加一个或多个子块
* 追加子块
*/
appendBlockChildrenRaw(requestParameters: AppendBlockChildrenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AppendBlockChildrenResponse>>;
/**
* 向指定块追加一个或多个子块
* 追加子块
*/
appendBlockChildren(requestParameters: AppendBlockChildrenOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AppendBlockChildrenResponse>;
/**
* 在现有页面下创建一个新的数据库
* 创建数据库
*/
createDatabaseRaw(requestParameters: CreateDatabaseOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Database>>;
/**
* 在现有页面下创建一个新的数据库
* 创建数据库
*/
createDatabase(requestParameters: CreateDatabaseOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Database>;
/**
* 在页面或数据库中创建新页面
* 创建页面
*/
createPageRaw(requestParameters: CreatePageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatePageResponse>>;
/**
* 在页面或数据库中创建新页面
* 创建页面
*/
createPage(requestParameters: CreatePageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatePageResponse>;
/**
* 删除指定块及其所有子块
* 删除块
*/
deleteBlockRaw(requestParameters: DeleteBlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteBlockResponse>>;
/**
* 删除指定块及其所有子块
* 删除块
*/
deleteBlock(requestParameters: DeleteBlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteBlockResponse>;
/**
* 根据ID获取块对象
* 获取块
*/
getBlockRaw(requestParameters: GetBlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Block>>;
/**
* 根据ID获取块对象
* 获取块
*/
getBlock(requestParameters: GetBlockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Block>;
/**
* 获取指定块的子块列表
* 获取子块
*/
getBlockChildrenRaw(requestParameters: GetBlockChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBlockChildrenResponse>>;
/**
* 获取指定块的子块列表
* 获取子块
*/
getBlockChildren(requestParameters: GetBlockChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBlockChildrenResponse>;
/**
* 根据ID获取数据库对象
* 获取数据库
*/
getDatabaseRaw(requestParameters: GetDatabaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Database>>;
/**
* 根据ID获取数据库对象
* 获取数据库
*/
getDatabase(requestParameters: GetDatabaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Database>;
/**
* 获取当前机器人的创建者用户信息
* 获取机器人创建者信息
*/
getMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserMe>>;
/**
* 获取当前机器人的创建者用户信息
* 获取机器人创建者信息
*/
getMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserMe>;
/**
* 根据ID获取页面对象
* 获取页面
*/
getPageRaw(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Page>>;
/**
* 根据ID获取页面对象
* 获取页面
*/
getPage(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Page>;
/**
* 获取数据库中的页面列表，支持分页
* 查询数据库
*/
queryDatabaseRaw(requestParameters: QueryDatabaseOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryDatabaseResponse>>;
/**
* 获取数据库中的页面列表，支持分页
* 查询数据库
*/
queryDatabase(requestParameters: QueryDatabaseOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryDatabaseResponse>;
/**
* 通过向量搜索在空间中查找相关页面和内容
* 搜索页面
*/
searchPagesRaw(requestParameters: SearchPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchResult>>;
/**
* 通过向量搜索在空间中查找相关页面和内容
* 搜索页面
*/
searchPages(requestParameters: SearchPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchResult>;
/**
* 更新指定块的内容或属性
* 更新块
*/
updateBlockRaw(requestParameters: UpdateBlockOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Block>>;
/**
* 更新指定块的内容或属性
* 更新块
*/
updateBlock(requestParameters: UpdateBlockOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Block>;
/**
* 更新数据库的属性
* 更新数据库
*/
updateDatabaseRaw(requestParameters: UpdateDatabaseOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Database>>;
/**
* 更新数据库的属性
* 更新数据库
*/
updateDatabase(requestParameters: UpdateDatabaseOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Database>;
/**
* 更新页面的属性
* 更新页面属性
*/
updatePageRaw(requestParameters: UpdatePageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Page>>;
/**
* 更新页面的属性
* 更新页面属性
*/
updatePage(requestParameters: UpdatePageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Page>;
/**
* 在机器人授权的页面范围内搜索相关内容
* 搜索页面
*/
v1SearchRaw(requestParameters: V1SearchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1SearchResponse>>;
/**
* 在机器人授权的页面范围内搜索相关内容
* 搜索页面
*/
v1Search(requestParameters: V1SearchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1SearchResponse>;
}