docx_v1.ts•1.19 MB
import { z } from 'zod';
export type docxV1ToolName =
| 'docx.v1.chatAnnouncementBlock.batchUpdate'
| 'docx.v1.chatAnnouncementBlockChildren.batchDelete'
| 'docx.v1.chatAnnouncementBlockChildren.create'
| 'docx.v1.chatAnnouncementBlockChildren.get'
| 'docx.v1.chatAnnouncementBlock.get'
| 'docx.v1.chatAnnouncementBlock.list'
| 'docx.v1.chatAnnouncement.get'
| 'docx.v1.documentBlock.batchUpdate'
| 'docx.v1.documentBlockChildren.batchDelete'
| 'docx.v1.documentBlockChildren.create'
| 'docx.v1.documentBlockChildren.get'
| 'docx.v1.documentBlockDescendant.create'
| 'docx.v1.documentBlock.get'
| 'docx.v1.documentBlock.list'
| 'docx.v1.documentBlock.patch'
| 'docx.v1.document.create'
| 'docx.v1.document.get'
| 'docx.v1.document.rawContent';
export const docxV1ChatAnnouncementBlockBatchUpdate = {
project: 'docx',
name: 'docx.v1.chatAnnouncementBlock.batchUpdate',
sdkName: 'docx.v1.chatAnnouncementBlock.batchUpdate',
path: '/open-apis/docx/v1/chats/:chat_id/announcement/blocks/batch_update',
httpMethod: 'PATCH',
description: '[Feishu/Lark]-群组-新版群公告-块-批量更新群公告块的内容',
accessTokens: ['tenant', 'user'],
schema: {
data: z.object({
requests: z
.array(
z.object({
update_text_elements: z
.object({
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
title: z.string().describe('文档标题,只读属性').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_notify: z.boolean().describe('是否通知').optional(),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
undefined: z.record(z.any()).describe('未支持的 TextElement').optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe(
'更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个',
),
})
.describe('更新文本元素请求')
.optional(),
update_text_style: z
.object({
style: z.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
sequence: z.string().describe("用于确定有序列表项编号,为具体数值或'auto'").optional(),
}),
fields: z
.array(
z
.number()
.describe(
'Options:1(align 修改 Block 的对齐方式),2(done 修改 todo block 的完成状态),3(folded 修改 block 的折叠状态),4(language 修改代码块的语言类型),5(wrap 修改代码块的折叠状态),6(background_color 块背景色(rgb|rgba 格式)),7(indentation_level 首段缩进级别)',
),
)
.describe('应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]'),
})
.describe('更新文本样式请求')
.optional(),
update_table_property: z
.object({
column_width: z.number().describe('表格列宽').optional(),
column_index: z.number().describe('需要修改列宽的表格列的索引(修改表格列宽时必填)').optional(),
header_row: z.boolean().describe('设置首行为标题行').optional(),
header_column: z.boolean().describe('设置首列为标题列').optional(),
})
.describe('更新表格属性请求')
.optional(),
insert_table_row: z
.object({ row_index: z.number().describe('插入的行在表格中的索引。(-1表示在表格末尾插入一行)') })
.describe('表格插入新行请求')
.optional(),
insert_table_column: z
.object({ column_index: z.number().describe('插入的列在表格中的索引。(-1表示在表格末尾插入一列)') })
.describe('表格插入新列请求')
.optional(),
delete_table_rows: z
.object({
row_start_index: z.number().describe('行开始索引(区间左闭右开)'),
row_end_index: z.number().describe('行结束索引(区间左闭右开)'),
})
.describe('表格批量删除行请求')
.optional(),
delete_table_columns: z
.object({
column_start_index: z.number().describe('列开始索引(区间左闭右开)'),
column_end_index: z.number().describe('列结束索引(区间左闭右开)'),
})
.describe('表格批量删除列请求')
.optional(),
merge_table_cells: z
.object({
row_start_index: z.number().describe('行起始索引(区间左闭右开)'),
row_end_index: z.number().describe('行结束索引(区间左闭右开)'),
column_start_index: z.number().describe('列起始索引(区间左闭右开)'),
column_end_index: z.number().describe('列结束索引(区间左闭右开)'),
})
.describe('表格合并单元格请求')
.optional(),
unmerge_table_cells: z
.object({
row_index: z.number().describe('table 行索引'),
column_index: z.number().describe('table 列索引'),
})
.describe('表格取消单元格合并状态请求')
.optional(),
insert_grid_column: z
.object({
column_index: z
.number()
.describe('插入列索引,从 1 开始,如 1 表示在第一列后插入,注意不允许传 0(-1表示在最后一列后插入)'),
})
.describe('分栏插入新的分栏列请求')
.optional(),
delete_grid_column: z
.object({
column_index: z.number().describe('删除列索引,从 0 开始,如 0 表示删除第一列(-1表示删除最后一列)'),
})
.describe('分栏删除列请求')
.optional(),
update_grid_column_width_ratio: z
.object({ width_ratios: z.array(z.number()).describe('更新列宽比例时,需要传入所有列宽占比') })
.describe('更新分栏列宽比例请求')
.optional(),
replace_image: z
.object({
token: z.string().describe('图片 token'),
width: z.number().describe('图片宽度,单位 px').optional(),
height: z.number().describe('图片高度,单位 px').optional(),
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
})
.describe('替换图片请求')
.optional(),
replace_file: z
.object({ token: z.string().describe('附件 token') })
.describe('替换附件请求')
.optional(),
block_id: z.string().describe('Block 唯一标识').optional(),
update_text: z
.object({
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
title: z.string().describe('文档标题,只读属性').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_notify: z.boolean().describe('是否通知').optional(),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
undefined: z.record(z.any()).describe('未支持的 TextElement').optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe(
'更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个',
),
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
sequence: z.string().describe("用于确定有序列表项编号,为具体数值或'auto'").optional(),
})
.describe('更新的文本样式'),
fields: z
.array(
z
.number()
.describe(
'Options:1(align 修改 Block 的对齐方式),2(done 修改 todo block 的完成状态),3(folded 修改 block 的折叠状态),4(language 修改代码块的语言类型),5(wrap 修改代码块的折叠状态),6(background_color 块背景色(rgb|rgba 格式)),7(indentation_level 首段缩进级别)',
),
)
.describe(
'文本样式中应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]',
),
})
.describe('更新文本元素及样式请求')
.optional(),
update_task: z
.object({
task_id: z
.string()
.describe('任务 ID。该字段仅在首次更新 Task Block 时生效,更新成功后,后续请求中将忽略该字段')
.optional(),
folded: z.boolean().describe('折叠状态,字段为空时不更新折叠状态').optional(),
})
.describe('更新任务 Block 请求')
.optional(),
}),
)
.describe('批量更新 Block')
.optional(),
}),
params: z.object({
revision_id: z
.number()
.describe('要操作的群公告版本。-1 表示群公告最新版本。群公告创建后,版本为 1。你需确保你已拥有群公告的编辑权限')
.optional(),
client_token: z
.string()
.describe(
'操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({ chat_id: z.string().describe('群公告对应的群 ID') }),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1ChatAnnouncementBlockChildrenBatchDelete = {
project: 'docx',
name: 'docx.v1.chatAnnouncementBlockChildren.batchDelete',
sdkName: 'docx.v1.chatAnnouncementBlockChildren.batchDelete',
path: '/open-apis/docx/v1/chats/:chat_id/announcement/blocks/:block_id/children/batch_delete',
httpMethod: 'DELETE',
description:
'[Feishu/Lark]-群组-新版群公告-块-删除群公告中的块-指定需要操作的块,删除其指定范围的子块。如果操作成功,接口将返回应用删除操作后的群公告版本号',
accessTokens: ['tenant', 'user'],
schema: {
data: z.object({
start_index: z.number().describe('删除的起始索引(操作区间左闭右开)'),
end_index: z.number().describe('删除的末尾索引(操作区间左闭右开)'),
}),
params: z.object({
revision_id: z
.number()
.describe(
'要操作的群公告版本。-1 表示群公告最新版本。群公告创建后,版本为 1。你需确保你已拥有群公告的编辑权限。你可通过调用获取群公告的最新 revision_id',
)
.optional(),
client_token: z
.string()
.describe(
'操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作',
)
.optional(),
}),
path: z.object({
chat_id: z
.string()
.describe(
'群 ID。获取方式:- ,从返回结果中获取该群的 chat_id。- 调用接口,可以查询用户或机器人所在群的 chat_id。- 调用,可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。**注意**:单聊(群类型为 `p2p`)不支持获取群公告',
),
block_id: z
.string()
.describe(
'父 Block 的唯一标识。你可通过调用接口获取块的 block_id。**注意**:- 此接口不支持删除表格(Table)的行列和删除分栏(Grid)的分栏列。你需通过接口完成相关操作。- 此接口不支持删除表格单元格(Table Cell)、分栏列(Grid Column)和高亮块(Callout)的全部子块',
),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1ChatAnnouncementBlockChildrenCreate = {
project: 'docx',
name: 'docx.v1.chatAnnouncementBlockChildren.create',
sdkName: 'docx.v1.chatAnnouncementBlockChildren.create',
path: '/open-apis/docx/v1/chats/:chat_id/announcement/blocks/:block_id/children',
httpMethod: 'POST',
description: '[Feishu/Lark]-群组-新版群公告-块-在群公告中创建块',
accessTokens: ['tenant', 'user'],
schema: {
data: z.object({
children: z
.array(
z.object({
block_type: z
.number()
.describe(
'block 类型 Options:1(Page 页面 Block),2(Text 文本 Block),3(Heading1 标题 1 Block),4(Heading2 标题 2 Block),5(Heading3 标题 3 Block),6(Heading4 标题 4 Block),7(Heading5 标题 5 Block),8(Heading6 标题 6 Block),9(Heading7 标题 7 Block),10(Heading8 标题 8 Block),11(Heading9 标题 9 Block),12(Bullet 无序列表 Block),13(Ordered 有序列表 Block),14(Code 代码块 Block),15(Quote 引用 Block),17(Todo 待办事项 Block),18(Bitable 多维表格 Block),19(Callout 高亮块 Block),20(ChatCard 会话卡片 Block),21(Diagram 流程图 & UML Block),22(Divider 分割线 Block),23(File 文件 Block),24(Grid 分栏 Block),25(GridColumn 分栏列 Block),26(Iframe 内嵌 Block Block),27(Image 图片 Block),28(ISV 开放平台小组件 Block),29(Mindnote 思维笔记 Block),30(Sheet 电子表格 Block),31(Table 表格 Block),32(TableCell 表格单元格 Block),33(View 视图 Block),34(QuoteContainer 引用容器 Block),35(Task 任务 Block),36(Okr OKR Block),37(OkrObjective OKR Objective),38(OkrKeyResult OKR Key Result),39(OkrProgress OKR 进展),40(AddOns 文档小组件),41(JiraIssue Jira Issue),42(WikiCatalog Wiki 子目录 Block),43(Board 画板 Block),44(Agenda 议程 Block),45(AgendaItem 议程项 Block),46(AgendaItemTitle 议程项标题 Block),47(AgendaItemContent 议程项内容 Block),48(LinkPreview 链接预览 Block),999(Undefined 未支持 Block)',
),
text: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('文本 Block')
.optional(),
heading1: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('一级标题 Block')
.optional(),
heading2: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('二级标题 Block')
.optional(),
heading3: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('三级标题 Block')
.optional(),
heading4: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('四级标题 Block')
.optional(),
heading5: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('五级标题 Block')
.optional(),
heading6: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('六级标题 Block')
.optional(),
heading7: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('七级标题 Block')
.optional(),
heading8: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('八级标题 Block')
.optional(),
heading9: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('九级标题 Block')
.optional(),
bullet: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('无序列表 Block')
.optional(),
ordered: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('有序列表 Block')
.optional(),
code: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('代码块 Block')
.optional(),
quote: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('引用 Block')
.optional(),
equation: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('公式 Block')
.optional(),
todo: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
background_color: z
.enum([
'LightGrayBackground',
'LightRedBackground',
'LightOrangeBackground',
'LightYellowBackground',
'LightGreenBackground',
'LightBlueBackground',
'LightPurpleBackground',
'PaleGrayBackground',
'DarkGrayBackground',
'DarkRedBackground',
'DarkOrangeBackground',
'DarkYellowBackground',
'DarkGreenBackground',
'DarkBlueBackground',
'DarkPurpleBackground',
])
.describe(
'块背景色 Options:LightGrayBackground(浅灰色),LightRedBackground(浅红色),LightOrangeBackground(浅橙色),LightYellowBackground(浅黄色),LightGreenBackground(浅绿色),LightBlueBackground(浅蓝色),LightPurpleBackground(浅紫色),PaleGrayBackground(淡灰色),DarkGrayBackground(深灰色),DarkRedBackground(深红色),DarkOrangeBackground(深橙色),DarkYellowBackground(深黄色),DarkGreenBackground(深绿色),DarkBlueBackground(深蓝色),DarkPurpleBackground(深紫色)',
)
.optional(),
indentation_level: z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('任务 Block')
.optional(),
bitable: z
.object({ view_type: z.number().describe('类型 Options:1(Grid 数据表),2(Kanban 看板)').optional() })
.describe('多维表格 Block')
.optional(),
callout: z
.object({
background_color: z
.number()
.describe(
'Options:1(LightRed 浅红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightNeutral 浅灰色),8(DarkRed 暗红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkNeutral 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
border_color: z
.number()
.describe(
'Options:1(Red 红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Neutral 灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
})
.describe('高亮块 Block')
.optional(),
chat_card: z
.object({
chat_id: z.string().describe('群聊天会话 ID'),
align: z.number().describe('对齐方式 Options:1(Left ),2(Center ),3(Right )').optional(),
})
.describe('群聊卡片 Block')
.optional(),
divider: z.record(z.any()).describe('分割线 Block').optional(),
file: z
.object({
view_type: z
.number()
.describe('视图类型,卡片视图(默认)或预览视图 Options:1(Card 卡片视图),2(Preview 预览视图)')
.optional(),
})
.describe('文件 Block')
.optional(),
grid: z
.object({ column_size: z.number().describe('分栏列数量') })
.describe('分栏 Block')
.optional(),
iframe: z
.object({
component: z
.object({
iframe_type: z
.number()
.describe(
'iframe 类型 Options:1(Bilibili 哔哩哔哩),2(XiGua 西瓜视频),3(Youku 优酷),4(Airtable),5(BaiduMap 百度地图),6(Amap 高德地图),7(TikTok Undefined),8(Figma),9(Modao 墨刀),10(Canva),11(CodePen),12(FeiShuWenJuan 飞书问卷),13(JinShuJu 金数据),14(GoogleMap Undefined),15(Youtube Undefined),99(Other)',
)
.optional(),
url: z.string().describe('iframe 目标 url(需要进行 url_encode)'),
})
.describe('iframe 的组成元素'),
})
.describe('内嵌 Block')
.optional(),
image: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
})
.describe('图片 Block')
.optional(),
isv: z.record(z.any()).describe('三方 Block').optional(),
add_ons: z
.object({
component_id: z.string().describe('团队互动应用唯一ID').optional(),
component_type_id: z.string().describe('团队互动应用类型,比如问答互动"blk_636a0a6657db8001c8df5488"'),
record: z.string().describe('文档小组件内容数据,JSON 字符串').optional(),
})
.describe('Add-ons')
.optional(),
sheet: z
.object({
row_size: z.number().describe('电子表格行数量').optional(),
column_size: z.number().describe('电子表格列数量').optional(),
})
.describe('电子表格 Block')
.optional(),
table: z
.object({
property: z
.object({
row_size: z.number().describe('行数'),
column_size: z.number().describe('列数'),
column_width: z.array(z.number()).describe('列宽,单位px').optional(),
merge_info: z
.array(
z.object({
row_span: z.number().describe('从当前行索引起被合并的连续行数').optional(),
col_span: z.number().describe('从当前列索引起被合并的连续列数').optional(),
}),
)
.describe('单元格合并信息')
.optional(),
header_row: z.boolean().describe('设置首行为标题行').optional(),
header_column: z.boolean().describe('设置首列为标题列').optional(),
})
.describe('表格属性'),
})
.describe('表格 Block')
.optional(),
quote_container: z.record(z.any()).describe('引用容器 Block').optional(),
task: z
.object({ folded: z.boolean().describe('折叠状态').optional() })
.describe('任务 Block')
.optional(),
okr: z
.object({
okr_id: z.string().describe('OKR ID').optional(),
objectives: z
.array(
z.object({
objective_id: z.string().describe('okr 中 objective 的 ID').optional(),
kr_ids: z
.array(z.string())
.describe('key result 的 ID 列表,此值为空时插入当前 objective 下的所有 key result')
.optional(),
}),
)
.describe(
'OKR Block 中的 objective ID 和 key result ID,此值为空时插入 okr 下所有的 objective 和 key result',
)
.optional(),
})
.describe('OKR Block')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
wiki_catalog: z
.object({ wiki_token: z.string().describe('知识库 token').optional() })
.describe('Wiki 子目录 Block')
.optional(),
board: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
width: z
.number()
.describe('宽度,单位 px;不填时自动适应文档宽度;值超出文档最大宽度时,页面渲染为文档最大宽度')
.optional(),
height: z
.number()
.describe('高度,单位 px;不填时自动根据画板内容计算;值超出屏幕两倍高度时,页面渲染为屏幕两倍高度')
.optional(),
})
.describe('画板 Block')
.optional(),
link_preview: z
.object({
url: z.string().describe('链接'),
url_type: z
.enum(['MessageLink', 'Undefined'])
.describe('链接类型 Options:MessageLink(消息链接),Undefined(未定义的链接类型)'),
})
.describe('链接预览 Block')
.optional(),
}),
)
.describe('添加的孩子列表')
.optional(),
index: z
.number()
.describe('当前 block 在 children 中的插入位置,起始值为 0,最大值为原 children 长度')
.optional(),
}),
params: z.object({
revision_id: z
.number()
.describe('要操作的群公告版本。-1 表示群公告最新版本。群公告创建后,版本为 1。你需确保你已拥有群公告的编辑权限')
.optional(),
client_token: z
.string()
.describe(
'操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
chat_id: z.string().describe('群公告对应的群 ID'),
block_id: z.string().describe('Block 的唯一标识'),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1ChatAnnouncementBlockChildrenGet = {
project: 'docx',
name: 'docx.v1.chatAnnouncementBlockChildren.get',
sdkName: 'docx.v1.chatAnnouncementBlockChildren.get',
path: '/open-apis/docx/v1/chats/:chat_id/announcement/blocks/:block_id/children',
httpMethod: 'GET',
description: '[Feishu/Lark]-群组-新版群公告-块-获取所有子块',
accessTokens: ['tenant', 'user'],
schema: {
params: z.object({
revision_id: z
.number()
.describe(
'查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的更新权限',
)
.optional(),
page_token: z
.string()
.describe(
'分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果',
)
.optional(),
page_size: z.number().describe('分页大小').optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
chat_id: z.string().describe('群公告对应的群 ID'),
block_id: z.string().describe('Block 的唯一标识'),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1ChatAnnouncementBlockGet = {
project: 'docx',
name: 'docx.v1.chatAnnouncementBlock.get',
sdkName: 'docx.v1.chatAnnouncementBlock.get',
path: '/open-apis/docx/v1/chats/:chat_id/announcement/blocks/:block_id',
httpMethod: 'GET',
description: '[Feishu/Lark]-群组-新版群公告-块-获取群公告块的内容',
accessTokens: ['tenant', 'user'],
schema: {
params: z.object({
revision_id: z
.number()
.describe(
'查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的更新权限',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
chat_id: z.string().describe('群公告对应的群 ID'),
block_id: z.string().describe('Block 的唯一标识'),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1ChatAnnouncementBlockList = {
project: 'docx',
name: 'docx.v1.chatAnnouncementBlock.list',
sdkName: 'docx.v1.chatAnnouncementBlock.list',
path: '/open-apis/docx/v1/chats/:chat_id/announcement/blocks',
httpMethod: 'GET',
description: '[Feishu/Lark]-群组-新版群公告-群公告-获取群公告所有块',
accessTokens: ['tenant', 'user'],
schema: {
params: z.object({
page_size: z.number().describe('分页大小').optional(),
page_token: z
.string()
.describe(
'分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果',
)
.optional(),
revision_id: z
.number()
.describe(
'查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的编辑权限',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({ chat_id: z.string().describe('群公告对应的群 ID') }),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1ChatAnnouncementGet = {
project: 'docx',
name: 'docx.v1.chatAnnouncement.get',
sdkName: 'docx.v1.chatAnnouncement.get',
path: '/open-apis/docx/v1/chats/:chat_id/announcement',
httpMethod: 'GET',
description: '[Feishu/Lark]-群组-新版群公告-群公告-获取群公告基本信息-获取指定群组中的群公告基本信息',
accessTokens: ['tenant', 'user'],
schema: {
params: z.object({ user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional() }),
path: z.object({
chat_id: z
.string()
.describe(
'群 ID。获取方式:- ,从返回结果中获取该群的 chat_id。- 调用接口,可以查询用户或机器人所在群的 chat_id。- 调用,可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。**注意**:单聊(群类型为 `p2p`)不支持获取群公告',
),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentBlockBatchUpdate = {
project: 'docx',
name: 'docx.v1.documentBlock.batchUpdate',
sdkName: 'docx.v1.documentBlock.batchUpdate',
path: '/open-apis/docx/v1/documents/:document_id/blocks/batch_update',
httpMethod: 'PATCH',
description: '[Feishu/Lark]-云文档-文档-块-批量更新块的内容-批量更新块的富文本内容',
accessTokens: ['tenant', 'user'],
schema: {
data: z.object({
requests: z
.array(
z.object({
update_text_elements: z
.object({
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
title: z.string().describe('文档标题,只读属性').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_notify: z.boolean().describe('是否通知').optional(),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
undefined: z.record(z.any()).describe('未支持的 TextElement').optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe(
'更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个',
),
})
.describe('更新文本元素请求')
.optional(),
update_text_style: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式'),
fields: z
.array(
z
.number()
.describe(
'Options:1(align 修改 Block 的对齐方式),2(done 修改 todo block 的完成状态),3(folded 修改 block 的折叠状态),4(language 修改代码块的语言类型),5(wrap 修改代码块的折叠状态)',
),
)
.describe('应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]'),
})
.describe('更新文本样式请求')
.optional(),
update_table_property: z
.object({
column_width: z.number().describe('表格列宽'),
column_index: z.number().describe('需要修改列宽的表格列的索引'),
})
.describe('更新表格属性请求')
.optional(),
insert_table_row: z
.object({ row_index: z.number().describe('插入的行在表格中的索引。(-1表示在表格末尾插入一行)') })
.describe('表格插入新行请求')
.optional(),
insert_table_column: z
.object({ column_index: z.number().describe('插入的列在表格中的索引。(-1表示在表格末尾插入一列)') })
.describe('表格插入新列请求')
.optional(),
delete_table_rows: z
.object({
row_start_index: z.number().describe('行开始索引(区间左闭右开)'),
row_end_index: z.number().describe('行结束索引(区间左闭右开)'),
})
.describe('表格批量删除行请求')
.optional(),
delete_table_columns: z
.object({
column_start_index: z.number().describe('列开始索引(区间左闭右开)'),
column_end_index: z.number().describe('列结束索引(区间左闭右开)'),
})
.describe('表格批量删除列请求')
.optional(),
merge_table_cells: z
.object({
row_start_index: z.number().describe('行起始索引(区间左闭右开)'),
row_end_index: z.number().describe('行结束索引(区间左闭右开)'),
column_start_index: z.number().describe('列起始索引(区间左闭右开)'),
column_end_index: z.number().describe('列结束索引(区间左闭右开)'),
})
.describe('表格合并单元格请求')
.optional(),
unmerge_table_cells: z
.object({
row_index: z.number().describe('table 行索引'),
column_index: z.number().describe('table 列索引'),
})
.describe('表格取消单元格合并状态请求')
.optional(),
insert_grid_column: z
.object({
column_index: z
.number()
.describe('插入列索引,从 1 开始,如 1 表示在第一列后插入,注意不允许传 0(-1表示在最后一列后插入)'),
})
.describe('分栏插入新的分栏列请求')
.optional(),
delete_grid_column: z
.object({
column_index: z.number().describe('删除列索引,从 0 开始,如 0 表示删除第一列(-1表示删除最后一列)'),
})
.describe('分栏删除列请求')
.optional(),
update_grid_column_width_ratio: z
.object({ width_ratios: z.array(z.number()).describe('更新列宽比例时,需要传入所有列宽占比') })
.describe('更新分栏列宽比例请求')
.optional(),
replace_image: z
.object({ token: z.string().describe('图片 token') })
.describe('替换图片请求')
.optional(),
replace_file: z
.object({ token: z.string().describe('附件 token') })
.describe('替换附件请求')
.optional(),
block_id: z.string().describe('Block 唯一标识').optional(),
update_text: z
.object({
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
title: z.string().describe('文档标题,只读属性').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_notify: z.boolean().describe('是否通知').optional(),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
undefined: z.record(z.any()).describe('未支持的 TextElement').optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe(
'更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个',
),
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('更新的文本样式'),
fields: z
.array(
z
.number()
.describe(
'Options:1(align 修改 Block 的对齐方式),2(done 修改 todo block 的完成状态),3(folded 修改 block 的折叠状态),4(language 修改代码块的语言类型),5(wrap 修改代码块的折叠状态)',
),
)
.describe(
'文本样式中应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]',
),
})
.describe('更新文本元素及样式请求')
.optional(),
}),
)
.describe('批量更新 Block'),
}),
params: z.object({
document_revision_id: z
.number()
.describe(
'操作的文档版本,-1 表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限',
)
.optional(),
client_token: z
.string()
.describe(
'操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
document_id: z
.string()
.describe(
'文档唯一标识。对应新版文档 Token,',
)
.optional(),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentBlockChildrenBatchDelete = {
project: 'docx',
name: 'docx.v1.documentBlockChildren.batchDelete',
sdkName: 'docx.v1.documentBlockChildren.batchDelete',
path: '/open-apis/docx/v1/documents/:document_id/blocks/:block_id/children/batch_delete',
httpMethod: 'DELETE',
description:
'[Feishu/Lark]-云文档-文档-块-删除块-指定需要操作的块,删除其指定范围的子块。如果操作成功,接口将返回应用删除操作后的文档版本号',
accessTokens: ['tenant', 'user'],
schema: {
data: z.object({
start_index: z.number().describe('删除的起始索引(操作区间左闭右开)'),
end_index: z.number().describe('删除的末尾索引(操作区间左闭右开)'),
}),
params: z.object({
document_revision_id: z
.number()
.describe(
'操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限',
)
.optional(),
client_token: z
.string()
.describe(
'操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作',
)
.optional(),
}),
path: z.object({
document_id: z
.string()
.describe(
'文档唯一标识。对应新版文档 Token,',
),
block_id: z.string().describe('父 Block 的唯一标识'),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentBlockChildrenCreate = {
project: 'docx',
name: 'docx.v1.documentBlockChildren.create',
sdkName: 'docx.v1.documentBlockChildren.create',
path: '/open-apis/docx/v1/documents/:document_id/blocks/:block_id/children',
httpMethod: 'POST',
description:
'[Feishu/Lark]-云文档-文档-块-创建块-指定需要操作的块,为其创建一批子块,并插入到指定位置。如果操作成功,接口将返回新创建子块的富文本内容',
accessTokens: ['tenant', 'user'],
schema: {
data: z.object({
children: z
.array(
z.object({
block_type: z
.number()
.describe(
'block 类型 Options:1(Page 页面 Block),2(Text 文本 Block),3(Heading1 标题 1 Block),4(Heading2 标题 2 Block),5(Heading3 标题 3 Block),6(Heading4 标题 4 Block),7(Heading5 标题 5 Block),8(Heading6 标题 6 Block),9(Heading7 标题 7 Block),10(Heading8 标题 8 Block),11(Heading9 标题 9 Block),12(Bullet 无序列表 Block),13(Ordered 有序列表 Block),14(Code 代码块 Block),15(Quote 引用 Block),17(Todo 待办事项 Block),18(Bitable 多维表格 Block),19(Callout 高亮块 Block),20(ChatCard 会话卡片 Block),21(Diagram 流程图 & UML Block),22(Divider 分割线 Block),23(File 文件 Block),24(Grid 分栏 Block),25(GridColumn 分栏列 Block),26(Iframe 内嵌 Block Block),27(Image 图片 Block),28(ISV 开放平台小组件 Block),29(Mindnote 思维笔记 Block),30(Sheet 电子表格 Block),31(Table 表格 Block),32(TableCell 表格单元格 Block),33(View 视图 Block),34(QuoteContainer 引用容器 Block),35(Task 任务 Block),36(Okr OKR Block),37(OkrObjective OKR Objective Block),38(OkrKeyResult OKR Key Result Block),39(OkrProgress OKR 进展 Block),40(AddOns 文档小组件),999(Undefined 未支持 Block)',
),
text: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('文本 Block')
.optional(),
heading1: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('一级标题 Block')
.optional(),
heading2: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('二级标题 Block')
.optional(),
heading3: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('三级标题 Block')
.optional(),
heading4: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('四级标题 Block')
.optional(),
heading5: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('五级标题 Block')
.optional(),
heading6: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('六级标题 Block')
.optional(),
heading7: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('七级标题 Block')
.optional(),
heading8: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('八级标题 Block')
.optional(),
heading9: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('九级标题 Block')
.optional(),
bullet: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('无序列表 Block')
.optional(),
ordered: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('有序列表 Block')
.optional(),
code: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('代码块 Block')
.optional(),
quote: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('引用 Block')
.optional(),
equation: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('公式 Block')
.optional(),
todo: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('待办事项 Block')
.optional(),
bitable: z
.object({ view_type: z.number().describe('类型 Options:1(Grid 数据表),2(Kanban 看板)').optional() })
.describe('多维表格 Block')
.optional(),
callout: z
.object({
background_color: z
.number()
.describe(
'高亮块背景色 Options:1(LightRed 浅红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightNeutral 浅灰色),8(DarkRed 暗红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkNeutral 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
border_color: z
.number()
.describe(
'边框色 Options:1(Red 红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Neutral 灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'文字颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
})
.describe('高亮块 Block')
.optional(),
chat_card: z
.object({
chat_id: z.string().describe('群聊天会话 ID'),
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
})
.describe('群聊卡片 Block')
.optional(),
divider: z.record(z.any()).describe('分割线 Block').optional(),
file: z.record(z.any()).describe('文件 Block').optional(),
grid: z
.object({ column_size: z.number().describe('分栏列数量') })
.describe('分栏 Block')
.optional(),
iframe: z
.object({
component: z
.object({
iframe_type: z
.number()
.describe(
'iframe 类型 Options:1(Bilibili 哔哩哔哩),2(XiGua 西瓜视频),3(Youku 优酷),4(Airtable),5(BaiduMap 百度地图),6(Amap 高德地图),7(TikTok Undefined),8(Figma),9(Modao 墨刀),10(Canva),11(CodePen),12(FeiShuWenJuan 飞书问卷),13(JinShuJu 金数据),14(GoogleMap Undefined),15(Youtube Undefined),99(Other)',
)
.optional(),
url: z.string().describe('iframe 目标 url(需要进行 url_encode)'),
})
.describe('iframe 的组成元素'),
})
.describe('内嵌 Block')
.optional(),
image: z.record(z.any()).describe('图片 Block').optional(),
isv: z.record(z.any()).describe('三方 Block').optional(),
add_ons: z
.object({
component_id: z.string().describe('文档小组件 ID').optional(),
component_type_id: z.string().describe('文档小组件类型,比如问答互动"blk_636a0a6657db8001c8df5488"'),
record: z.string().describe('文档小组件内容数据,JSON 字符串').optional(),
})
.describe('Add-ons')
.optional(),
sheet: z
.object({
row_size: z.number().describe('电子表格行数量').optional(),
column_size: z.number().describe('电子表格列数量').optional(),
})
.describe('电子表格 Block')
.optional(),
table: z
.object({
property: z
.object({
row_size: z.number().describe('行数'),
column_size: z.number().describe('列数'),
merge_info: z
.array(
z.object({
row_span: z.number().describe('从当前行索引起被合并的连续行数').optional(),
col_span: z.number().describe('从当前列索引起被合并的连续列数').optional(),
}),
)
.describe(
'单元格合并信息。在创建 Table 时候此属性是只读的,将由后端进行生成。如果需要对单元格进行合并操作,可以通过更新块的子请求 merge_table_cells 来实现',
)
.optional(),
})
.describe('表格属性'),
})
.describe('表格 Block')
.optional(),
quote_container: z.record(z.any()).describe('引用容器 Block').optional(),
okr: z
.object({
okr_id: z
.string()
.describe(
'OKR ID,获取需要插入的 OKR ID 可见',
)
.optional(),
objectives: z
.array(
z.object({
objective_id: z.string().describe('OKR 中 Objective 的 ID').optional(),
kr_ids: z
.array(z.string())
.describe('Key Result 的 ID 列表,此值为空时插入当前 Objective 下的所有 Key Result')
.optional(),
}),
)
.describe(
'OKR Block 中的 Objective ID 和 Key Result ID,此值为空时插入 OKR 下所有的 Objective 和 Key Result',
)
.optional(),
})
.describe('OKR Block,仅可在使用 `user_access_token` 时创建')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
}),
)
.describe('添加的孩子列表')
.optional(),
index: z
.number()
.describe('当前 block 在 children 中的插入位置,起始值为 0,最大值为原 children 长度')
.optional(),
}),
params: z.object({
document_revision_id: z
.number()
.describe(
'操作的文档版本,-1 表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限',
)
.optional(),
client_token: z
.string()
.describe(
'操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
document_id: z
.string()
.describe(
'文档唯一标识。对应新版文档 Token,',
),
block_id: z.string().describe('Block 的唯一标识'),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentBlockChildrenGet = {
project: 'docx',
name: 'docx.v1.documentBlockChildren.get',
sdkName: 'docx.v1.documentBlockChildren.get',
path: '/open-apis/docx/v1/documents/:document_id/blocks/:block_id/children',
httpMethod: 'GET',
description:
'[Feishu/Lark]-云文档-文档-块-获取所有子块-给定一个指定版本的文档,并指定需要操作的块,分页遍历其所有子块富文本内容 。如果不指定版本,则会默认查询最新版本',
accessTokens: ['tenant', 'user'],
schema: {
params: z.object({
document_revision_id: z
.number()
.describe(
'操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限',
)
.optional(),
page_token: z
.string()
.describe(
'分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果',
)
.optional(),
page_size: z.number().describe('分页大小').optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
document_id: z
.string()
.describe(
'文档唯一标识。对应新版文档 Token,',
),
block_id: z.string().describe('Block 的唯一标识'),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentBlockDescendantCreate = {
project: 'docx',
name: 'docx.v1.documentBlockDescendant.create',
sdkName: 'docx.v1.documentBlockDescendant.create',
path: '/open-apis/docx/v1/documents/:document_id/blocks/:block_id/descendant',
httpMethod: 'POST',
description: '[Feishu/Lark]-云文档-文档-块-创建嵌套块',
accessTokens: ['tenant', 'user'],
schema: {
data: z.object({
children_id: z.array(z.string()).describe('添加的孩子 BlockID 列表'),
index: z
.number()
.describe('当前 Block 在 Children 中的插入位置,起始值为 0,最大值为原 Children 长度')
.optional(),
descendants: z
.array(
z.object({
block_type: z
.number()
.describe(
'block 类型 Options:1(Page 页面 Block),2(Text 文本 Block),3(Heading1 标题 1 Block),4(Heading2 标题 2 Block),5(Heading3 标题 3 Block),6(Heading4 标题 4 Block),7(Heading5 标题 5 Block),8(Heading6 标题 6 Block),9(Heading7 标题 7 Block),10(Heading8 标题 8 Block),11(Heading9 标题 9 Block),12(Bullet 无序列表 Block),13(Ordered 有序列表 Block),14(Code 代码块 Block),15(Quote 引用 Block),17(Todo 待办事项 Block),18(Bitable 多维表格 Block),19(Callout 高亮块 Block),20(ChatCard 会话卡片 Block),21(Diagram 流程图 & UML Block),22(Divider 分割线 Block),23(File 文件 Block),24(Grid 分栏 Block),25(GridColumn 分栏列 Block),26(Iframe 内嵌 Block Block),27(Image 图片 Block),28(ISV 开放平台小组件 Block),29(Mindnote 思维笔记 Block),30(Sheet 电子表格 Block),31(Table 表格 Block),32(TableCell 表格单元格 Block),33(View 视图 Block),34(QuoteContainer 引用容器 Block),35(Task 任务 Block),36(Okr OKR Block),37(OkrObjective OKR Objective),38(OkrKeyResult OKR Key Result),39(OkrProgress OKR 进展),40(AddOns 文档小组件),41(JiraIssue Jira Issue),42(WikiCatalog Wiki 子目录 Block),999(Undefined 未支持 Block)',
),
text: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('文本 Block')
.optional(),
heading1: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('一级标题 Block')
.optional(),
heading2: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('二级标题 Block')
.optional(),
heading3: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('三级标题 Block')
.optional(),
heading4: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('四级标题 Block')
.optional(),
heading5: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('五级标题 Block')
.optional(),
heading6: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('六级标题 Block')
.optional(),
heading7: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('七级标题 Block')
.optional(),
heading8: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('八级标题 Block')
.optional(),
heading9: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('九级标题 Block')
.optional(),
bullet: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('无序列表 Block')
.optional(),
ordered: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('有序列表 Block')
.optional(),
code: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('代码块 Block')
.optional(),
quote: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('引用 Block')
.optional(),
equation: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('公式 Block')
.optional(),
todo: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro FoxPro(已废弃)),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo Logo(已废弃)),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL OpenEdgeABL(已废弃)),43(PHP),44(Perl),45(PostScript PostScript(已废弃)),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG RPG(已废弃)),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch Scratch(已废弃)),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式')
.optional(),
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe(
'符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html',
),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe('文本元素'),
})
.describe('任务 Block')
.optional(),
bitable: z
.object({ view_type: z.number().describe('类型 Options:1(Grid 数据表),2(Kanban 看板)').optional() })
.describe('多维表格 Block')
.optional(),
callout: z
.object({
background_color: z
.number()
.describe(
'Options:1(LightRed 浅红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightNeutral 浅灰色),8(DarkRed 暗红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkNeutral 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
border_color: z
.number()
.describe(
'Options:1(Red 红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Neutral 灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
})
.describe('高亮块 Block')
.optional(),
chat_card: z
.object({
chat_id: z.string().describe('群聊天会话 ID'),
align: z.number().describe('对齐方式 Options:1(Left ),2(Center ),3(Right )').optional(),
})
.describe('群聊卡片 Block')
.optional(),
divider: z.record(z.any()).describe('分割线 Block').optional(),
file: z
.object({
view_type: z
.number()
.describe('视图类型,卡片视图(默认)或预览视图 Options:1(Card 卡片视图),2(Preview 预览视图)')
.optional(),
})
.describe('文件 Block')
.optional(),
grid: z
.object({ column_size: z.number().describe('分栏列数量') })
.describe('分栏 Block')
.optional(),
iframe: z
.object({
component: z
.object({
iframe_type: z
.number()
.describe(
'iframe 类型 Options:1(Bilibili 哔哩哔哩),2(XiGua 西瓜视频),3(Youku 优酷),4(Airtable),5(BaiduMap 百度地图),6(Amap 高德地图),7(TikTok Undefined),8(Figma),9(Modao 墨刀),10(Canva),11(CodePen),12(FeiShuWenJuan 飞书问卷),13(JinShuJu 金数据),14(GoogleMap Undefined),15(Youtube Undefined),99(Other)',
)
.optional(),
url: z.string().describe('iframe 目标 url(需要进行 url_encode)'),
})
.describe('iframe 的组成元素'),
})
.describe('内嵌 Block')
.optional(),
image: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
})
.describe('图片 Block')
.optional(),
isv: z.record(z.any()).describe('三方 Block').optional(),
add_ons: z
.object({
component_id: z.string().describe('团队互动应用唯一ID').optional(),
component_type_id: z.string().describe('团队互动应用类型,比如问答互动"blk_636a0a6657db8001c8df5488"'),
record: z.string().describe('文档小组件内容数据,JSON 字符串').optional(),
})
.describe('Add-ons')
.optional(),
sheet: z
.object({
row_size: z.number().describe('电子表格行数量').optional(),
column_size: z.number().describe('电子表格列数量').optional(),
})
.describe('电子表格 Block')
.optional(),
table: z
.object({
property: z
.object({
row_size: z.number().describe('行数'),
column_size: z.number().describe('列数'),
column_width: z.array(z.number()).describe('列宽,单位px').optional(),
merge_info: z
.array(
z.object({
row_span: z.number().describe('从当前行索引起被合并的连续行数').optional(),
col_span: z.number().describe('从当前列索引起被合并的连续列数').optional(),
}),
)
.describe('单元格合并信息')
.optional(),
header_row: z.boolean().describe('设置首行为标题行').optional(),
header_column: z.boolean().describe('设置首列为标题列').optional(),
})
.describe('表格属性'),
})
.describe('表格 Block')
.optional(),
quote_container: z.record(z.any()).describe('引用容器 Block').optional(),
okr: z
.object({
okr_id: z.string().describe('OKR ID').optional(),
objectives: z
.array(
z.object({
objective_id: z.string().describe('okr 中 objective 的 ID').optional(),
kr_ids: z
.array(z.string())
.describe('key result 的 ID 列表,此值为空时插入当前 objective 下的所有 key result')
.optional(),
}),
)
.describe(
'OKR Block 中的 objective ID 和 key result ID,此值为空时插入 okr 下所有的 objective 和 key result',
)
.optional(),
})
.describe('OKR Block')
.optional(),
comment_ids: z.array(z.string()).describe('评论 id 列表').optional(),
wiki_catalog: z
.object({ wiki_token: z.string().describe('知识库 token').optional() })
.describe('Wiki 子目录 Block')
.optional(),
}),
)
.describe('添加的子孙列表,包括孩子'),
}),
params: z.object({
document_revision_id: z
.number()
.describe(
'操作的文档版本,-1 表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限',
)
.optional(),
client_token: z
.string()
.describe(
'操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
document_id: z.string().describe('文档的唯一标识').optional(),
block_id: z.string().describe('Block 的唯一标识').optional(),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentBlockGet = {
project: 'docx',
name: 'docx.v1.documentBlock.get',
sdkName: 'docx.v1.documentBlock.get',
path: '/open-apis/docx/v1/documents/:document_id/blocks/:block_id',
httpMethod: 'GET',
description: '[Feishu/Lark]-云文档-文档-块-获取块的内容-获取指定块的富文本内容',
accessTokens: ['tenant', 'user'],
schema: {
params: z.object({
document_revision_id: z
.number()
.describe(
'查询的文档版本,-1 表示文档最新版本。若此时查询的版本为文档最新版本,则需要持有文档的阅读权限;若此时查询的版本为文档的历史版本,则需要持有文档的编辑权限',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
document_id: z
.string()
.describe(
'文档唯一标识。对应新版文档 Token,',
),
block_id: z.string().describe('Block 的唯一标识'),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentBlockList = {
project: 'docx',
name: 'docx.v1.documentBlock.list',
sdkName: 'docx.v1.documentBlock.list',
path: '/open-apis/docx/v1/documents/:document_id/blocks',
httpMethod: 'GET',
description: '[Feishu/Lark]-云文档-文档-文档-获取文档所有块-获取文档所有块的富文本内容并分页返回',
accessTokens: ['tenant', 'user'],
schema: {
params: z.object({
page_size: z.number().describe('分页大小').optional(),
page_token: z
.string()
.describe(
'分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果',
)
.optional(),
document_revision_id: z
.number()
.describe(
'查询的文档版本,-1表示文档最新版本。若此时查询的版本为文档最新版本,则需要持有文档的阅读权限;若此时查询的版本为文档的历史版本,则需要持有文档的编辑权限',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
document_id: z
.string()
.describe(
'文档的唯一标识。对应新版文档 Token,',
),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentBlockPatch = {
project: 'docx',
name: 'docx.v1.documentBlock.patch',
sdkName: 'docx.v1.documentBlock.patch',
path: '/open-apis/docx/v1/documents/:document_id/blocks/:block_id',
httpMethod: 'PATCH',
description: '[Feishu/Lark]-云文档-文档-块-更新块的内容-更新指定的块',
accessTokens: ['tenant', 'user'],
schema: {
data: z.object({
update_text_elements: z
.object({
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe('符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe(
'更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个',
),
})
.describe('更新文本元素请求')
.optional(),
update_text_style: z
.object({
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('文本样式'),
fields: z
.array(
z
.number()
.describe(
'Options:1(align 修改 Block 的对齐方式),2(done 修改 todo block 的完成状态),3(folded 修改 block 的折叠状态),4(language 修改代码块的语言类型),5(wrap 修改代码块的折叠状态)',
),
)
.describe('应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]'),
})
.describe('更新文本样式请求')
.optional(),
update_table_property: z
.object({
column_width: z.number().describe('表格列宽'),
column_index: z.number().describe('需要修改列宽的表格列的索引'),
})
.describe('更新表格属性请求')
.optional(),
insert_table_row: z
.object({ row_index: z.number().describe('插入的行在表格中的索引。(-1表示在表格末尾插入一行)') })
.describe('表格插入新行请求')
.optional(),
insert_table_column: z
.object({ column_index: z.number().describe('插入的列在表格中的索引。(-1表示在表格末尾插入一列)') })
.describe('表格插入新列请求')
.optional(),
delete_table_rows: z
.object({
row_start_index: z.number().describe('行开始索引(区间左闭右开)'),
row_end_index: z.number().describe('行结束索引(区间左闭右开)'),
})
.describe('表格批量删除行请求')
.optional(),
delete_table_columns: z
.object({
column_start_index: z.number().describe('列开始索引(区间左闭右开)'),
column_end_index: z.number().describe('列结束索引(区间左闭右开)'),
})
.describe('表格批量删除列请求')
.optional(),
merge_table_cells: z
.object({
row_start_index: z.number().describe('行起始索引(区间左闭右开)'),
row_end_index: z.number().describe('行结束索引(区间左闭右开)'),
column_start_index: z.number().describe('列起始索引(区间左闭右开)'),
column_end_index: z.number().describe('列结束索引(区间左闭右开)'),
})
.describe('表格合并单元格请求')
.optional(),
unmerge_table_cells: z
.object({ row_index: z.number().describe('table 行索引'), column_index: z.number().describe('table 列索引') })
.describe('表格取消单元格合并状态请求')
.optional(),
insert_grid_column: z
.object({
column_index: z
.number()
.describe('插入列索引,从 1 开始,如 1 表示在第一列后插入,注意不允许传 0(-1表示在最后一列后插入)'),
})
.describe('分栏插入新的分栏列请求')
.optional(),
delete_grid_column: z
.object({
column_index: z.number().describe('删除列索引,从 0 开始,如 0 表示删除第一列(-1表示删除最后一列)'),
})
.describe('分栏删除列请求')
.optional(),
update_grid_column_width_ratio: z
.object({ width_ratios: z.array(z.number()).describe('更新列宽比例时,需要传入所有列宽占比') })
.describe('更新分栏列宽比例请求')
.optional(),
replace_image: z
.object({ token: z.string().describe('图片 token') })
.describe('替换图片请求')
.optional(),
replace_file: z
.object({ token: z.string().describe('附件 token') })
.describe('替换附件请求')
.optional(),
update_text: z
.object({
elements: z
.array(
z.object({
text_run: z
.object({
content: z.string().describe('文本内容'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: z
.object({
user_id: z.string().describe('用户 OpenID'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: z
.object({
token: z.string().describe('云文档 token'),
obj_type: z
.number()
.describe(
'云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)',
),
url: z.string().describe('云文档链接(需要 url_encode)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: z
.object({
create_user_id: z.string().describe('创建者用户 ID'),
is_whole_day: z.boolean().describe('是日期还是整点小时').optional(),
expire_time: z.string().describe('事件发生的时间(毫秒级时间戳)'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: z
.object({
file_token: z.string().describe('附件 token').optional(),
source_block_id: z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
inline_block: z
.object({
block_id: z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: z
.object({
content: z
.string()
.describe('符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html'),
text_element_style: z
.object({
bold: z.boolean().describe('加粗').optional(),
italic: z.boolean().describe('斜体').optional(),
strikethrough: z.boolean().describe('删除线').optional(),
underline: z.boolean().describe('下划线').optional(),
inline_code: z.boolean().describe('inline 代码').optional(),
background_color: z
.number()
.describe(
'背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)',
)
.optional(),
text_color: z
.number()
.describe(
'字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)',
)
.optional(),
link: z
.object({ url: z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: z
.array(z.string())
.describe(
'评论 ID 列表。在创建 Block 时,不支持传入评论 ID;在更新文本 Block 的 Element 时,允许将对应版本已存在的评论 ID 移动到同一个 Block 内的任意 Element 中,但不支持传入新的评论 ID。如需查询评论内容请阅览「」',
)
.optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}),
)
.describe(
'更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个',
),
style: z
.object({
align: z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: z.boolean().describe('todo 的完成状态').optional(),
folded: z.boolean().describe('文本的折叠状态').optional(),
language: z
.number()
.describe(
'代码块语言 Options:1(PlainText),2(ABAP),3(Ada),4(Apache),5(Apex),6(AssemblyLanguage Assembly Language),7(Bash),8(CSharp),9(CPlusPlus C++),10(C),11(COBOL),12(CSS),13(CoffeeScript),14(D),15(Dart),16(Delphi),17(Django),18(Dockerfile),19(Erlang),20(Fortran),21(FoxPro),22(Go),23(Groovy),24(HTML),25(HTMLBars),26(HTTP),27(Haskell),28(JSON),29(Java),30(JavaScript),31(Julia),32(Kotlin),33(LateX),34(Lisp),35(Logo),36(Lua),37(MATLAB),38(Makefile),39(Markdown),40(Nginx),41(ObjectiveC Objective-C),42(OpenEdgeABL),43(PHP),44(Perl),45(PostScript),46(PowerShell Power Shell),47(Prolog),48(ProtoBuf),49(Python),50(R),51(RPG),52(Ruby),53(Rust),54(SAS),55(SCSS),56(SQL),57(Scala),58(Scheme),59(Scratch),60(Shell),61(Swift),62(Thrift),63(TypeScript),64(VBScript),65(VisualBasic Visual Basic),66(XML),67(YAML),68(CMake),69(Diff),70(Gherkin),71(GraphQL),72(OpenGLShadingLanguage OpenGL Shading Language),73(Properties),74(Solidity),75(TOML)',
)
.optional(),
wrap: z.boolean().describe('代码块是否自动换行').optional(),
})
.describe('更新的文本样式'),
fields: z
.array(
z
.number()
.describe(
'Options:1(align 修改 Block 的对齐方式),2(done 修改 todo block 的完成状态),3(folded 修改 block 的折叠状态),4(language 修改代码块的语言类型),5(wrap 修改代码块的折叠状态)',
),
)
.describe(
'文本样式中应更新的字段,必须至少指定一个字段。例如,要调整 Block 对齐方式,请设置 fields 为 [1]',
),
})
.describe('更新文本元素及样式请求')
.optional(),
}),
params: z.object({
document_revision_id: z
.number()
.describe(
'操作的文档版本,-1 表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限',
)
.optional(),
client_token: z
.string()
.describe(
'操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作',
)
.optional(),
user_id_type: z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: z.object({
document_id: z
.string()
.describe(
'文档唯一标识。对应新版文档 Token,',
),
block_id: z.string().describe('Block 的唯一标识'),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentCreate = {
project: 'docx',
name: 'docx.v1.document.create',
sdkName: 'docx.v1.document.create',
path: '/open-apis/docx/v1/documents',
httpMethod: 'POST',
description: '[Feishu/Lark]-云文档-文档-文档-创建文档-创建文档类型为 docx 的文档。你可选择传入文档标题和文件夹',
accessTokens: ['tenant', 'user'],
schema: {
data: z.object({
folder_token: z
.string()
.describe(
'指定文档所在文件夹 的 Token。不传或传空表示根目录。了解如何获取文件夹 Token,参考。若应用使用的是 `tenant_access_token` 权限,此处仅可指定应用创建的文件夹',
)
.optional(),
title: z.string().describe('文档标题,只支持纯文本').optional(),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentGet = {
project: 'docx',
name: 'docx.v1.document.get',
sdkName: 'docx.v1.document.get',
path: '/open-apis/docx/v1/documents/:document_id',
httpMethod: 'GET',
description: '[Feishu/Lark]-云文档-文档-文档-获取文档基本信息-获取文档标题和最新版本 ID',
accessTokens: ['tenant', 'user'],
schema: {
path: z.object({
document_id: z
.string()
.describe(
'文档的唯一标识。你可通过以下方式获取文档的 `document_id`。了解更多,参考。- 若文档存储在云盘中,你可通过 URL 地址或通过 获取其中文档资源的 `document_id`。- 若文档挂载在知识库中,你需通过知识库相关接口获取该节点下挂载的云资源的 `obj_token` 和 `obj_type`。在该情况下,`obj_type` 为 `docx` 时,其对应的 `obj_token` 即为文档的 `document_id`。**注意**:对于知识库(wiki)中的文档,其 URL 地址中的 token 并不是该文档的 `document_id`。使用时请注意区分',
),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1DocumentRawContent = {
project: 'docx',
name: 'docx.v1.document.rawContent',
sdkName: 'docx.v1.document.rawContent',
path: '/open-apis/docx/v1/documents/:document_id/raw_content',
httpMethod: 'GET',
description: '[Feishu/Lark]-云文档-文档-文档-获取文档纯文本内容-获取文档的纯文本内容',
accessTokens: ['tenant', 'user'],
schema: {
params: z.object({
lang: z
.number()
.describe(
'指定返回的 MentionUser 即 @用户 的语言 Options:0(ZH 该用户的默认名称。如:@张敏),1(EN 该用户的英文名称。如:@Min Zhang),2(JP 暂不支持该枚举,使用时返回该用户的默认名称)',
)
.optional(),
}),
path: z.object({
document_id: z
.string()
.describe(
'文档的唯一标识。点击了解如何获取文档的 `document_id`',
),
}),
useUAT: z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
export const docxV1Tools = [
docxV1ChatAnnouncementBlockBatchUpdate,
docxV1ChatAnnouncementBlockChildrenBatchDelete,
docxV1ChatAnnouncementBlockChildrenCreate,
docxV1ChatAnnouncementBlockChildrenGet,
docxV1ChatAnnouncementBlockGet,
docxV1ChatAnnouncementBlockList,
docxV1ChatAnnouncementGet,
docxV1DocumentBlockBatchUpdate,
docxV1DocumentBlockChildrenBatchDelete,
docxV1DocumentBlockChildrenCreate,
docxV1DocumentBlockChildrenGet,
docxV1DocumentBlockDescendantCreate,
docxV1DocumentBlockGet,
docxV1DocumentBlockList,
docxV1DocumentBlockPatch,
docxV1DocumentCreate,
docxV1DocumentGet,
docxV1DocumentRawContent,
];