@larksuiteoapi/lark-mcp
Version:
Feishu/Lark OpenAPI MCP
719 lines • 1.2 MB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.docxV1Tools = exports.docxV1DocumentRawContent = exports.docxV1DocumentGet = exports.docxV1DocumentCreate = exports.docxV1DocumentBlockPatch = exports.docxV1DocumentBlockList = exports.docxV1DocumentBlockGet = exports.docxV1DocumentBlockDescendantCreate = exports.docxV1DocumentBlockChildrenGet = exports.docxV1DocumentBlockChildrenCreate = exports.docxV1DocumentBlockChildrenBatchDelete = exports.docxV1DocumentBlockBatchUpdate = exports.docxV1ChatAnnouncementGet = exports.docxV1ChatAnnouncementBlockList = exports.docxV1ChatAnnouncementBlockGet = exports.docxV1ChatAnnouncementBlockChildrenGet = exports.docxV1ChatAnnouncementBlockChildrenCreate = exports.docxV1ChatAnnouncementBlockChildrenBatchDelete = exports.docxV1ChatAnnouncementBlockBatchUpdate = void 0;
const zod_1 = require("zod");
exports.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: zod_1.z.object({
requests: zod_1.z
.array(zod_1.z.object({
update_text_elements: zod_1.z
.object({
elements: zod_1.z
.array(zod_1.z.object({
text_run: zod_1.z
.object({
content: zod_1.z.string().describe('文本内容'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: zod_1.z
.object({
user_id: zod_1.z.string().describe('用户 OpenID'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: zod_1.z
.object({
token: zod_1.z.string().describe('云文档 token'),
obj_type: zod_1.z
.number()
.describe('云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)'),
url: zod_1.z.string().describe('云文档链接(需要 url_encode)'),
title: zod_1.z.string().describe('文档标题,只读属性').optional(),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: zod_1.z
.object({
create_user_id: zod_1.z.string().describe('创建者用户 ID'),
is_notify: zod_1.z.boolean().describe('是否通知').optional(),
is_whole_day: zod_1.z.boolean().describe('是日期还是整点小时').optional(),
expire_time: zod_1.z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: zod_1.z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: zod_1.z
.object({
file_token: zod_1.z.string().describe('附件 token').optional(),
source_block_id: zod_1.z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
undefined: zod_1.z.object({}).describe('未支持的 TextElement').optional(),
inline_block: zod_1.z
.object({
block_id: zod_1.z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: zod_1.z
.object({
content: zod_1.z
.string()
.describe('符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}))
.describe('更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个'),
})
.describe('更新文本元素请求')
.optional(),
update_text_style: zod_1.z
.object({
style: zod_1.z.object({
align: zod_1.z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: zod_1.z.boolean().describe('todo 的完成状态').optional(),
folded: zod_1.z.boolean().describe('文本的折叠状态').optional(),
language: zod_1.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: zod_1.z.boolean().describe('代码块是否自动换行').optional(),
background_color: zod_1.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: zod_1.z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
sequence: zod_1.z.string().describe("用于确定有序列表项编号,为具体数值或'auto'").optional(),
}),
fields: zod_1.z
.array(zod_1.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: zod_1.z
.object({
column_width: zod_1.z.number().describe('表格列宽').optional(),
column_index: zod_1.z.number().describe('需要修改列宽的表格列的索引(修改表格列宽时必填)').optional(),
header_row: zod_1.z.boolean().describe('设置首行为标题行').optional(),
header_column: zod_1.z.boolean().describe('设置首列为标题列').optional(),
})
.describe('更新表格属性请求')
.optional(),
insert_table_row: zod_1.z
.object({ row_index: zod_1.z.number().describe('插入的行在表格中的索引。(-1表示在表格末尾插入一行)') })
.describe('表格插入新行请求')
.optional(),
insert_table_column: zod_1.z
.object({ column_index: zod_1.z.number().describe('插入的列在表格中的索引。(-1表示在表格末尾插入一列)') })
.describe('表格插入新列请求')
.optional(),
delete_table_rows: zod_1.z
.object({
row_start_index: zod_1.z.number().describe('行开始索引(区间左闭右开)'),
row_end_index: zod_1.z.number().describe('行结束索引(区间左闭右开)'),
})
.describe('表格批量删除行请求')
.optional(),
delete_table_columns: zod_1.z
.object({
column_start_index: zod_1.z.number().describe('列开始索引(区间左闭右开)'),
column_end_index: zod_1.z.number().describe('列结束索引(区间左闭右开)'),
})
.describe('表格批量删除列请求')
.optional(),
merge_table_cells: zod_1.z
.object({
row_start_index: zod_1.z.number().describe('行起始索引(区间左闭右开)'),
row_end_index: zod_1.z.number().describe('行结束索引(区间左闭右开)'),
column_start_index: zod_1.z.number().describe('列起始索引(区间左闭右开)'),
column_end_index: zod_1.z.number().describe('列结束索引(区间左闭右开)'),
})
.describe('表格合并单元格请求')
.optional(),
unmerge_table_cells: zod_1.z
.object({
row_index: zod_1.z.number().describe('table 行索引'),
column_index: zod_1.z.number().describe('table 列索引'),
})
.describe('表格取消单元格合并状态请求')
.optional(),
insert_grid_column: zod_1.z
.object({
column_index: zod_1.z
.number()
.describe('插入列索引,从 1 开始,如 1 表示在第一列后插入,注意不允许传 0(-1表示在最后一列后插入)'),
})
.describe('分栏插入新的分栏列请求')
.optional(),
delete_grid_column: zod_1.z
.object({
column_index: zod_1.z.number().describe('删除列索引,从 0 开始,如 0 表示删除第一列(-1表示删除最后一列)'),
})
.describe('分栏删除列请求')
.optional(),
update_grid_column_width_ratio: zod_1.z
.object({ width_ratios: zod_1.z.array(zod_1.z.number()).describe('更新列宽比例时,需要传入所有列宽占比') })
.describe('更新分栏列宽比例请求')
.optional(),
replace_image: zod_1.z
.object({
token: zod_1.z.string().describe('图片 token'),
width: zod_1.z.number().describe('图片宽度,单位 px').optional(),
height: zod_1.z.number().describe('图片高度,单位 px').optional(),
align: zod_1.z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
})
.describe('替换图片请求')
.optional(),
replace_file: zod_1.z
.object({ token: zod_1.z.string().describe('附件 token') })
.describe('替换附件请求')
.optional(),
block_id: zod_1.z.string().describe('Block 唯一标识').optional(),
update_text: zod_1.z
.object({
elements: zod_1.z
.array(zod_1.z.object({
text_run: zod_1.z
.object({
content: zod_1.z.string().describe('文本内容'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('文字')
.optional(),
mention_user: zod_1.z
.object({
user_id: zod_1.z.string().describe('用户 OpenID'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@用户')
.optional(),
mention_doc: zod_1.z
.object({
token: zod_1.z.string().describe('云文档 token'),
obj_type: zod_1.z
.number()
.describe('云文档类型 Options:1(Doc),3(Sheet),8(Bitable),11(MindNote),12(File),15(Slide),16(Wiki),22(Docx)'),
url: zod_1.z.string().describe('云文档链接(需要 url_encode)'),
title: zod_1.z.string().describe('文档标题,只读属性').optional(),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('@文档')
.optional(),
reminder: zod_1.z
.object({
create_user_id: zod_1.z.string().describe('创建者用户 ID'),
is_notify: zod_1.z.boolean().describe('是否通知').optional(),
is_whole_day: zod_1.z.boolean().describe('是日期还是整点小时').optional(),
expire_time: zod_1.z.string().describe('事件发生的时间(毫秒级事件戳)'),
notify_time: zod_1.z.string().describe('触发通知的时间(毫秒级时间戳)'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('日期提醒')
.optional(),
file: zod_1.z
.object({
file_token: zod_1.z.string().describe('附件 token').optional(),
source_block_id: zod_1.z.string().describe('当前文档中该附件所处的 block 的 id').optional(),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联附件')
.optional(),
undefined: zod_1.z.object({}).describe('未支持的 TextElement').optional(),
inline_block: zod_1.z
.object({
block_id: zod_1.z.string().describe('关联的内联状态的 block 的 block_id'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('内联 block')
.optional(),
equation: zod_1.z
.object({
content: zod_1.z
.string()
.describe('符合 KaTeX 语法的公式内容,语法规则请参考:https://katex.org/docs/supported.html'),
text_element_style: zod_1.z
.object({
bold: zod_1.z.boolean().describe('加粗').optional(),
italic: zod_1.z.boolean().describe('斜体').optional(),
strikethrough: zod_1.z.boolean().describe('删除线').optional(),
underline: zod_1.z.boolean().describe('下划线').optional(),
inline_code: zod_1.z.boolean().describe('inline 代码').optional(),
background_color: zod_1.z
.number()
.describe('背景色 Options:1(LightPink 浅粉红色),2(LightOrange 浅橙色),3(LightYellow 浅黄色),4(LightGreen 浅绿色),5(LightBlue 浅蓝色),6(LightPurple 浅紫色),7(LightGray 浅灰色),8(DarkPink 暗粉红色),9(DarkOrange 暗橙色),10(DarkYellow 暗黄色),11(DarkGreen 暗绿色),12(DarkBlue 暗蓝色),13(DarkPurple 暗紫色),14(DarkGray 暗灰色),15(DarkSlightGray 暗银灰色)')
.optional(),
text_color: zod_1.z
.number()
.describe('字体颜色 Options:1(Pink 粉红色),2(Orange 橙色),3(Yellow 黄色),4(Green 绿色),5(Blue 蓝色),6(Purple 紫色),7(Gray 灰色)')
.optional(),
link: zod_1.z
.object({ url: zod_1.z.string().describe('超链接指向的 url (需要 url_encode)') })
.describe('链接')
.optional(),
comment_ids: zod_1.z.array(zod_1.z.string()).describe('评论 id 列表').optional(),
})
.describe('文本局部样式')
.optional(),
})
.describe('公式')
.optional(),
}))
.describe('更新的文本元素列表,单次更新中 reminder 上限 30 个,mention_doc 上限 50 个,mention_user 上限 100 个'),
style: zod_1.z
.object({
align: zod_1.z
.number()
.describe('对齐方式 Options:1(Left 居左排版),2(Center 居中排版),3(Right 居右排版)')
.optional(),
done: zod_1.z.boolean().describe('todo 的完成状态').optional(),
folded: zod_1.z.boolean().describe('文本的折叠状态').optional(),
language: zod_1.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: zod_1.z.boolean().describe('代码块是否自动换行').optional(),
background_color: zod_1.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: zod_1.z
.enum(['NoIndent', 'OneLevelIndent'])
.describe('首行缩进级别 Options:NoIndent(无缩进),OneLevelIndent(一级缩进)')
.optional(),
sequence: zod_1.z.string().describe("用于确定有序列表项编号,为具体数值或'auto'").optional(),
})
.describe('更新的文本样式'),
fields: zod_1.z
.array(zod_1.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: zod_1.z
.object({
task_id: zod_1.z
.string()
.describe('任务 ID。该字段仅在首次更新 Task Block 时生效,更新成功后,后续请求中将忽略该字段')
.optional(),
folded: zod_1.z.boolean().describe('折叠状态,字段为空时不更新折叠状态').optional(),
})
.describe('更新任务 Block 请求')
.optional(),
}))
.describe('批量更新 Block')
.optional(),
}),
params: zod_1.z.object({
revision_id: zod_1.z
.number()
.describe('要操作的群公告版本。-1 表示群公告最新版本。群公告创建后,版本为 1。你需确保你已拥有群公告的编辑权限')
.optional(),
client_token: zod_1.z
.string()
.describe('操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作')
.optional(),
user_id_type: zod_1.z.enum(['open_id', 'union_id', 'user_id']).describe('用户ID类型').optional(),
}),
path: zod_1.z.object({ chat_id: zod_1.z.string().describe('群公告对应的群 ID') }),
useUAT: zod_1.z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
exports.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: zod_1.z.object({
start_index: zod_1.z.number().describe('删除的起始索引(操作区间左闭右开)'),
end_index: zod_1.z.number().describe('删除的末尾索引(操作区间左闭右开)'),
}),
params: zod_1.z.object({
revision_id: zod_1.z
.number()
.describe('要操作的群公告版本。-1 表示群公告最新版本。群公告创建后,版本为 1。你需确保你已拥有群公告的编辑权限。你可通过调用获取群公告的最新 revision_id')
.optional(),
client_token: zod_1.z
.string()
.describe('操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作')
.optional(),
}),
path: zod_1.z.object({
chat_id: zod_1.z
.string()
.describe('群 ID。获取方式:- ,从返回结果中获取该群的 chat_id。- 调用接口,可以查询用户或机器人所在群的 chat_id。- 调用,可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。**注意**:单聊(群类型为 `p2p`)不支持获取群公告'),
block_id: zod_1.z
.string()
.describe('父 Block 的唯一标识。你可通过调用接口获取块的 block_id。**注意**:- 此接口不支持删除表格(Table)的行列和删除分栏(Grid)的分栏列。你需通过接口完成相关操作。- 此接口不支持删除表格单元格(Table Cell)、分栏列(Grid Column)和高亮块(Callout)的全部子块'),
}),
useUAT: zod_1.z.boolean().describe('使用用户身份请求, 否则使用应用身份').optional(),
},
};
exports.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: zod_1.z.object({
children: zod_1.z
.array(zod_1.z.object({
block_type: zod_1.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(QuoteCon