@satorijs/adapter-lark 3.8.6 → 3.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/lib/bot.d.ts +1 -1
  2. package/lib/content.d.ts +433 -0
  3. package/lib/http.d.ts +1 -1
  4. package/lib/index.cjs +2787 -1714
  5. package/lib/index.cjs.map +6 -0
  6. package/lib/index.d.ts +4 -2
  7. package/lib/internal.d.ts +38 -0
  8. package/lib/message.d.ts +2 -0
  9. package/lib/types/acs.d.ts +177 -0
  10. package/lib/types/admin.d.ts +270 -0
  11. package/lib/types/aily.d.ts +221 -0
  12. package/lib/types/apaas.d.ts +499 -0
  13. package/lib/types/api.d.ts +1 -14
  14. package/lib/types/application.d.ts +406 -0
  15. package/lib/types/approval.d.ts +779 -0
  16. package/lib/types/attendance.d.ts +957 -0
  17. package/lib/types/auth.d.ts +86 -0
  18. package/lib/types/authen.d.ts +191 -0
  19. package/lib/types/baike.d.ts +239 -0
  20. package/lib/types/bitable.d.ts +691 -0
  21. package/lib/types/board.d.ts +19 -0
  22. package/lib/types/calendar.d.ts +653 -0
  23. package/lib/types/cardkit.d.ts +139 -0
  24. package/lib/types/compensation.d.ts +54 -0
  25. package/lib/types/contact.d.ts +1137 -0
  26. package/lib/types/corehr.d.ts +4383 -0
  27. package/lib/types/docs.d.ts +23 -0
  28. package/lib/types/document_ai.d.ts +257 -0
  29. package/lib/types/docx.d.ts +380 -0
  30. package/lib/types/drive.d.ts +1045 -0
  31. package/lib/types/ehr.d.ts +32 -0
  32. package/lib/types/event.d.ts +9 -18
  33. package/lib/types/guild.d.ts +59 -0
  34. package/lib/types/helpdesk.d.ts +738 -0
  35. package/lib/types/hire.d.ts +3150 -0
  36. package/lib/types/human_authentication.d.ts +27 -0
  37. package/lib/types/im.d.ts +1300 -0
  38. package/lib/types/index.d.ts +16432 -34
  39. package/lib/types/lingo.d.ts +254 -0
  40. package/lib/types/mail.d.ts +680 -0
  41. package/lib/types/mdm.d.ts +42 -0
  42. package/lib/types/message/asset.d.ts +40 -0
  43. package/lib/types/minutes.d.ts +31 -0
  44. package/lib/types/moments.d.ts +18 -0
  45. package/lib/types/okr.d.ts +205 -0
  46. package/lib/types/optical_char_recognition.d.ts +17 -0
  47. package/lib/types/passport.d.ts +45 -0
  48. package/lib/types/payroll.d.ts +50 -0
  49. package/lib/types/performance.d.ts +413 -0
  50. package/lib/types/personal_settings.d.ts +87 -0
  51. package/lib/types/report.d.ts +57 -0
  52. package/lib/types/search.d.ts +216 -0
  53. package/lib/types/security_and_compliance.d.ts +24 -0
  54. package/lib/types/sheets.d.ts +326 -0
  55. package/lib/types/speech_to_text.d.ts +39 -0
  56. package/lib/types/task.d.ts +1153 -0
  57. package/lib/types/tenant.d.ts +23 -0
  58. package/lib/types/translation.d.ts +37 -0
  59. package/lib/types/user.d.ts +78 -0
  60. package/lib/types/utils.d.ts +9 -0
  61. package/lib/types/vc.d.ts +948 -0
  62. package/lib/types/verification.d.ts +14 -0
  63. package/lib/types/wiki.d.ts +240 -0
  64. package/lib/types/workplace.d.ts +43 -0
  65. package/lib/utils.d.ts +143 -7
  66. package/package.json +6 -4
  67. package/src/bot.ts +19 -3
  68. package/src/{types/message/content.ts → content.ts} +1 -0
  69. package/src/http.ts +1 -3
  70. package/src/index.ts +4 -2
  71. package/src/internal.ts +144 -0
  72. package/src/message.ts +13 -11
  73. package/src/types/acs.ts +236 -0
  74. package/src/types/admin.ts +328 -0
  75. package/src/types/aily.ts +288 -0
  76. package/src/types/apaas.ts +646 -0
  77. package/src/types/application.ts +520 -0
  78. package/src/types/approval.ts +924 -0
  79. package/src/types/attendance.ts +1153 -0
  80. package/src/types/auth.ts +114 -0
  81. package/src/types/authen.ts +220 -0
  82. package/src/types/baike.ts +306 -0
  83. package/src/types/bitable.ts +879 -0
  84. package/src/types/board.ts +31 -0
  85. package/src/types/calendar.ts +817 -0
  86. package/src/types/cardkit.ts +182 -0
  87. package/src/types/compensation.ts +79 -0
  88. package/src/types/contact.ts +1411 -0
  89. package/src/types/corehr.ts +5288 -0
  90. package/src/types/docs.ts +33 -0
  91. package/src/types/document_ai.ts +352 -0
  92. package/src/types/docx.ts +471 -0
  93. package/src/types/drive.ts +1312 -0
  94. package/src/types/ehr.ts +43 -0
  95. package/src/types/event.ts +15 -21
  96. package/src/types/helpdesk.ts +916 -0
  97. package/src/types/hire.ts +3918 -0
  98. package/src/types/human_authentication.ts +38 -0
  99. package/src/types/im.ts +1605 -0
  100. package/src/types/index.ts +17754 -39
  101. package/src/types/lingo.ts +321 -0
  102. package/src/types/mail.ts +851 -0
  103. package/src/types/mdm.ts +57 -0
  104. package/src/types/minutes.ts +46 -0
  105. package/src/types/moments.ts +28 -0
  106. package/src/types/okr.ts +261 -0
  107. package/src/types/optical_char_recognition.ts +27 -0
  108. package/src/types/passport.ts +61 -0
  109. package/src/types/payroll.ts +69 -0
  110. package/src/types/performance.ts +524 -0
  111. package/src/types/personal_settings.ts +116 -0
  112. package/src/types/report.ts +77 -0
  113. package/src/types/search.ts +268 -0
  114. package/src/types/security_and_compliance.ts +33 -0
  115. package/src/types/sheets.ts +425 -0
  116. package/src/types/speech_to_text.ts +54 -0
  117. package/src/types/task.ts +1464 -0
  118. package/src/types/tenant.ts +36 -0
  119. package/src/types/translation.ts +52 -0
  120. package/src/types/vc.ts +1197 -0
  121. package/src/types/verification.ts +23 -0
  122. package/src/types/wiki.ts +313 -0
  123. package/src/types/workplace.ts +59 -0
  124. package/src/utils.ts +160 -8
  125. package/src/types/api.ts +0 -30848
  126. package/src/types/internal.ts +0 -84
  127. package/src/types/message/index.ts +0 -97
@@ -0,0 +1,471 @@
1
+ import { Block, BlockIdRelation, DeleteGridColumnRequest, DeleteTableColumnsRequest, DeleteTableRowsRequest, Document, InsertGridColumnRequest, InsertTableColumnRequest, InsertTableRowRequest, MergeTableCellsRequest, ReplaceFileRequest, ReplaceImageRequest, UnmergeTableCellsRequest, UpdateBlockRequest, UpdateGridColumnWidthRatioRequest, UpdateTablePropertyRequest, UpdateTaskRequest, UpdateTextElementsRequest, UpdateTextRequest, UpdateTextStyleRequest } from '.'
2
+ import { Internal, Pagination } from '../internal'
3
+
4
+ declare module '../internal' {
5
+ interface Internal {
6
+ /**
7
+ * 获取群公告基本信息
8
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement/get
9
+ */
10
+ getDocxChatAnnouncement(chat_id: string, query?: GetDocxChatAnnouncementQuery): Promise<GetDocxChatAnnouncementResponse>
11
+ /**
12
+ * 获取群公告所有块
13
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/list
14
+ */
15
+ listDocxChatAnnouncementBlock(chat_id: string, query?: ListDocxChatAnnouncementBlockQuery): Paginated<Block>
16
+ /**
17
+ * 在群公告中创建块
18
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/create
19
+ */
20
+ createDocxChatAnnouncementBlockChildren(chat_id: string, block_id: string, body: CreateDocxChatAnnouncementBlockChildrenRequest, query?: CreateDocxChatAnnouncementBlockChildrenQuery): Promise<CreateDocxChatAnnouncementBlockChildrenResponse>
21
+ /**
22
+ * 批量更新群公告块的内容
23
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/batch_update
24
+ */
25
+ batchUpdateDocxChatAnnouncementBlock(chat_id: string, body: BatchUpdateDocxChatAnnouncementBlockRequest, query?: BatchUpdateDocxChatAnnouncementBlockQuery): Promise<BatchUpdateDocxChatAnnouncementBlockResponse>
26
+ /**
27
+ * 获取群公告块的内容
28
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block/get
29
+ */
30
+ getDocxChatAnnouncementBlock(chat_id: string, block_id: string, query?: GetDocxChatAnnouncementBlockQuery): Promise<GetDocxChatAnnouncementBlockResponse>
31
+ /**
32
+ * 获取所有子块
33
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/get
34
+ */
35
+ getDocxChatAnnouncementBlockChildren(chat_id: string, block_id: string, query?: GetDocxChatAnnouncementBlockChildrenQuery): Paginated<Block>
36
+ /**
37
+ * 删除群公告中的块
38
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/chat-announcement-block-children/batch_delete
39
+ */
40
+ batchDeleteDocxChatAnnouncementBlockChildren(chat_id: string, block_id: string, body: BatchDeleteDocxChatAnnouncementBlockChildrenRequest, query?: BatchDeleteDocxChatAnnouncementBlockChildrenQuery): Promise<BatchDeleteDocxChatAnnouncementBlockChildrenResponse>
41
+ /**
42
+ * 创建文档
43
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/create
44
+ */
45
+ createDocxDocument(body: CreateDocxDocumentRequest): Promise<CreateDocxDocumentResponse>
46
+ /**
47
+ * 获取文档基本信息
48
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/get
49
+ */
50
+ getDocxDocument(document_id: string): Promise<GetDocxDocumentResponse>
51
+ /**
52
+ * 获取文档纯文本内容
53
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/raw_content
54
+ */
55
+ rawContentDocxDocument(document_id: string, query?: RawContentDocxDocumentQuery): Promise<RawContentDocxDocumentResponse>
56
+ /**
57
+ * 获取文档所有块
58
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/list
59
+ */
60
+ listDocxDocumentBlock(document_id: string, query?: ListDocxDocumentBlockQuery): Paginated<Block>
61
+ /**
62
+ * 创建块
63
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/create
64
+ */
65
+ createDocxDocumentBlockChildren(document_id: string, block_id: string, body: CreateDocxDocumentBlockChildrenRequest, query?: CreateDocxDocumentBlockChildrenQuery): Promise<CreateDocxDocumentBlockChildrenResponse>
66
+ /**
67
+ * 创建嵌套块
68
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-descendant/create
69
+ */
70
+ createDocxDocumentBlockDescendant(document_id: string, block_id: string, body: CreateDocxDocumentBlockDescendantRequest, query?: CreateDocxDocumentBlockDescendantQuery): Promise<CreateDocxDocumentBlockDescendantResponse>
71
+ /**
72
+ * 更新块的内容
73
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/patch
74
+ */
75
+ patchDocxDocumentBlock(document_id: string, block_id: string, body: PatchDocxDocumentBlockRequest, query?: PatchDocxDocumentBlockQuery): Promise<PatchDocxDocumentBlockResponse>
76
+ /**
77
+ * 获取块的内容
78
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/get
79
+ */
80
+ getDocxDocumentBlock(document_id: string, block_id: string, query?: GetDocxDocumentBlockQuery): Promise<GetDocxDocumentBlockResponse>
81
+ /**
82
+ * 批量更新块的内容
83
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block/batch_update
84
+ */
85
+ batchUpdateDocxDocumentBlock(document_id: string, body: BatchUpdateDocxDocumentBlockRequest, query?: BatchUpdateDocxDocumentBlockQuery): Promise<BatchUpdateDocxDocumentBlockResponse>
86
+ /**
87
+ * 获取所有子块
88
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/get
89
+ */
90
+ getDocxDocumentBlockChildren(document_id: string, block_id: string, query?: GetDocxDocumentBlockChildrenQuery): Paginated<Block>
91
+ /**
92
+ * 删除块
93
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document-block-children/batch_delete
94
+ */
95
+ batchDeleteDocxDocumentBlockChildren(document_id: string, block_id: string, body: BatchDeleteDocxDocumentBlockChildrenRequest, query?: BatchDeleteDocxDocumentBlockChildrenQuery): Promise<BatchDeleteDocxDocumentBlockChildrenResponse>
96
+ }
97
+ }
98
+
99
+ export interface GetDocxChatAnnouncementQuery {
100
+ /** 此次调用中使用的用户ID的类型 */
101
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
102
+ }
103
+
104
+ export interface ListDocxChatAnnouncementBlockQuery extends Pagination {
105
+ /** 查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的编辑权限。 */
106
+ revision_id?: number
107
+ /** 此次调用中使用的用户ID的类型 */
108
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
109
+ }
110
+
111
+ export interface CreateDocxChatAnnouncementBlockChildrenRequest {
112
+ /** 添加的孩子列表。 */
113
+ children?: Block[]
114
+ /** 当前 block 在 children 中的插入位置,起始值为 0,最大值为原 children 长度 */
115
+ index?: number
116
+ }
117
+
118
+ export interface CreateDocxChatAnnouncementBlockChildrenQuery {
119
+ /** 要操作的群公告版本。-1 表示群公告最新版本。群公告创建后,版本为 1。你需确保你已拥有群公告的编辑权限 */
120
+ revision_id?: number
121
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
122
+ client_token?: string
123
+ /** 此次调用中使用的用户ID的类型 */
124
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
125
+ }
126
+
127
+ export interface BatchUpdateDocxChatAnnouncementBlockRequest {
128
+ /** 批量更新 Block */
129
+ requests?: UpdateBlockRequest[]
130
+ }
131
+
132
+ export interface BatchUpdateDocxChatAnnouncementBlockQuery {
133
+ /** 要操作的群公告版本。-1 表示群公告最新版本。群公告创建后,版本为 1。你需确保你已拥有群公告的编辑权限。 */
134
+ revision_id?: number
135
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
136
+ client_token?: string
137
+ /** 此次调用中使用的用户ID的类型 */
138
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
139
+ }
140
+
141
+ export interface GetDocxChatAnnouncementBlockQuery {
142
+ /** 查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的更新权限 */
143
+ revision_id?: number
144
+ /** 此次调用中使用的用户ID的类型 */
145
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
146
+ }
147
+
148
+ export interface GetDocxChatAnnouncementBlockChildrenQuery extends Pagination {
149
+ /** 查询的群公告版本,-1 表示群公告最新版本。群公告创建后,版本为 1。若查询的版本为群公告最新版本,则需要持有群公告的阅读权限;若查询的版本为群公告的历史版本,则需要持有群公告的更新权限。 */
150
+ revision_id?: number
151
+ /** 此次调用中使用的用户ID的类型 */
152
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
153
+ }
154
+
155
+ export interface BatchDeleteDocxChatAnnouncementBlockChildrenRequest {
156
+ /** 删除的起始索引(操作区间左闭右开) */
157
+ start_index: number
158
+ /** 删除的末尾索引(操作区间左闭右开) */
159
+ end_index: number
160
+ }
161
+
162
+ export interface BatchDeleteDocxChatAnnouncementBlockChildrenQuery {
163
+ /** 要操作的群公告版本。-1 表示群公告最新版本。群公告创建后,版本为 1。你需确保你已拥有群公告的编辑权限 */
164
+ revision_id?: number
165
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
166
+ client_token?: string
167
+ }
168
+
169
+ export interface CreateDocxDocumentRequest {
170
+ /** 文件夹 token,获取方式见云文档接口快速入门;空表示根目录,tenant_access_token应用权限仅允许操作应用创建的目录 */
171
+ folder_token?: string
172
+ /** 文档标题,只支持纯文本 */
173
+ title?: string
174
+ }
175
+
176
+ export interface RawContentDocxDocumentQuery {
177
+ /** 语言(用于 MentionUser 语言的选取) */
178
+ lang?: 0 | 1 | 2
179
+ }
180
+
181
+ export interface ListDocxDocumentBlockQuery extends Pagination {
182
+ /** 查询的文档版本,-1表示文档最新版本。若此时查询的版本为文档最新版本,则需要持有文档的阅读权限;若此时查询的版本为文档的历史版本,则需要持有文档的编辑权限。 */
183
+ document_revision_id?: number
184
+ /** 此次调用中使用的用户ID的类型 */
185
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
186
+ }
187
+
188
+ export interface CreateDocxDocumentBlockChildrenRequest {
189
+ /** 添加的孩子列表。 */
190
+ children?: Block[]
191
+ /** 当前 block 在 children 中的插入位置,起始值为 0,最大值为原 children 长度 */
192
+ index?: number
193
+ }
194
+
195
+ export interface CreateDocxDocumentBlockChildrenQuery {
196
+ /** 操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。 */
197
+ document_revision_id?: number
198
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
199
+ client_token?: string
200
+ /** 此次调用中使用的用户ID的类型 */
201
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
202
+ }
203
+
204
+ export interface CreateDocxDocumentBlockDescendantRequest {
205
+ /** 添加的孩子 BlockID 列表 */
206
+ children_id: string[]
207
+ /** 当前 Block 在 Children 中的插入位置,起始值为 0,最大值为原 Children 长度 */
208
+ index?: number
209
+ /** 添加的子孙列表,包括孩子 */
210
+ descendants: Block[]
211
+ }
212
+
213
+ export interface CreateDocxDocumentBlockDescendantQuery {
214
+ /** 操作的文档版本,-1 表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限 */
215
+ document_revision_id?: number
216
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作 */
217
+ client_token?: string
218
+ /** 此次调用中使用的用户ID的类型 */
219
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
220
+ }
221
+
222
+ export interface PatchDocxDocumentBlockRequest {
223
+ /** 更新文本元素请求 */
224
+ update_text_elements?: UpdateTextElementsRequest
225
+ /** 更新文本样式请求 */
226
+ update_text_style?: UpdateTextStyleRequest
227
+ /** 更新表格属性请求 */
228
+ update_table_property?: UpdateTablePropertyRequest
229
+ /** 表格插入新行请求 */
230
+ insert_table_row?: InsertTableRowRequest
231
+ /** 表格插入新列请求 */
232
+ insert_table_column?: InsertTableColumnRequest
233
+ /** 表格批量删除行请求 */
234
+ delete_table_rows?: DeleteTableRowsRequest
235
+ /** 表格批量删除列请求 */
236
+ delete_table_columns?: DeleteTableColumnsRequest
237
+ /** 表格合并单元格请求 */
238
+ merge_table_cells?: MergeTableCellsRequest
239
+ /** 表格取消单元格合并状态请求 */
240
+ unmerge_table_cells?: UnmergeTableCellsRequest
241
+ /** 分栏插入新的分栏列请求 */
242
+ insert_grid_column?: InsertGridColumnRequest
243
+ /** 分栏删除列请求 */
244
+ delete_grid_column?: DeleteGridColumnRequest
245
+ /** 更新分栏列宽比例请求 */
246
+ update_grid_column_width_ratio?: UpdateGridColumnWidthRatioRequest
247
+ /** 替换图片请求 */
248
+ replace_image?: ReplaceImageRequest
249
+ /** 替换附件请求 */
250
+ replace_file?: ReplaceFileRequest
251
+ /** 更新文本元素及样式请求 */
252
+ update_text?: UpdateTextRequest
253
+ /** 更新任务 Block 请求 */
254
+ update_task?: UpdateTaskRequest
255
+ }
256
+
257
+ export interface PatchDocxDocumentBlockQuery {
258
+ /** 操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。 */
259
+ document_revision_id?: number
260
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
261
+ client_token?: string
262
+ /** 此次调用中使用的用户ID的类型 */
263
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
264
+ }
265
+
266
+ export interface GetDocxDocumentBlockQuery {
267
+ /** 查询的文档版本,-1表示文档最新版本。若此时查询的版本为文档最新版本,则需要持有文档的阅读权限;若此时查询的版本为文档的历史版本,则需要持有文档的编辑权限。 */
268
+ document_revision_id?: number
269
+ /** 此次调用中使用的用户ID的类型 */
270
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
271
+ }
272
+
273
+ export interface BatchUpdateDocxDocumentBlockRequest {
274
+ /** 批量更新 Block */
275
+ requests: UpdateBlockRequest[]
276
+ }
277
+
278
+ export interface BatchUpdateDocxDocumentBlockQuery {
279
+ /** 操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。 */
280
+ document_revision_id?: number
281
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
282
+ client_token?: string
283
+ /** 此次调用中使用的用户ID的类型 */
284
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
285
+ }
286
+
287
+ export interface GetDocxDocumentBlockChildrenQuery extends Pagination {
288
+ /** 操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。 */
289
+ document_revision_id?: number
290
+ /** 此次调用中使用的用户ID的类型 */
291
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
292
+ }
293
+
294
+ export interface BatchDeleteDocxDocumentBlockChildrenRequest {
295
+ /** 删除的起始索引(操作区间左闭右开) */
296
+ start_index: number
297
+ /** 删除的末尾索引(操作区间左闭右开) */
298
+ end_index: number
299
+ }
300
+
301
+ export interface BatchDeleteDocxDocumentBlockChildrenQuery {
302
+ /** 操作的文档版本,-1表示文档最新版本。若此时操作的版本为文档最新版本,则需要持有文档的阅读权限;若此时操作的版本为文档的历史版本,则需要持有文档的编辑权限。 */
303
+ document_revision_id?: number
304
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
305
+ client_token?: string
306
+ }
307
+
308
+ export interface GetDocxChatAnnouncementResponse {
309
+ /** 当前版本号 */
310
+ revision_id?: number
311
+ /** 群公告生成的时间戳(秒) */
312
+ create_time?: string
313
+ /** 群公告更新的时间戳(秒) */
314
+ update_time?: string
315
+ /** 群公告所有者 ID,ID 值与 owner_id_type 中的ID类型对应 */
316
+ owner_id?: string
317
+ /** 群公告所有者的 ID 类型 */
318
+ owner_id_type?: 'user_id' | 'union_id' | 'open_id'
319
+ /** 群公告最新修改者 ID,ID 值与 modifier_id_type 中的ID类型对应 */
320
+ modifier_id?: string
321
+ /** 群公告最新修改者 id 类型 */
322
+ modifier_id_type?: 'user_id' | 'union_id' | 'open_id'
323
+ /** 群公告类型 */
324
+ announcement_type?: 'docx' | 'doc'
325
+ }
326
+
327
+ export interface CreateDocxChatAnnouncementBlockChildrenResponse {
328
+ /** 所添加的孩子的 Block 信息 */
329
+ children?: Block[]
330
+ /** 当前 Block Children 创建成功后群公告的版本号 */
331
+ revision_id?: number
332
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
333
+ client_token?: string
334
+ }
335
+
336
+ export interface BatchUpdateDocxChatAnnouncementBlockResponse {
337
+ /** 批量更新的 Block */
338
+ blocks?: Block[]
339
+ /** 当前更新成功后群公告的版本号 */
340
+ revision_id?: number
341
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
342
+ client_token?: string
343
+ }
344
+
345
+ export interface GetDocxChatAnnouncementBlockResponse {
346
+ /** 查询的 Block 的信息 */
347
+ block?: Block
348
+ }
349
+
350
+ export interface BatchDeleteDocxChatAnnouncementBlockChildrenResponse {
351
+ /** 当前删除操作成功后群公告的版本号 */
352
+ revision_id?: number
353
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
354
+ client_token?: string
355
+ }
356
+
357
+ export interface CreateDocxDocumentResponse {
358
+ /** 新建文档的文档信息 */
359
+ document?: Document
360
+ }
361
+
362
+ export interface GetDocxDocumentResponse {
363
+ /** 文档信息 */
364
+ document?: Document
365
+ }
366
+
367
+ export interface RawContentDocxDocumentResponse {
368
+ /** 文档纯文本 */
369
+ content?: string
370
+ }
371
+
372
+ export interface CreateDocxDocumentBlockChildrenResponse {
373
+ /** 所添加的孩子的 Block 信息 */
374
+ children?: Block[]
375
+ /** 当前 block children 创建成功后文档的版本号 */
376
+ document_revision_id?: number
377
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
378
+ client_token: string
379
+ }
380
+
381
+ export interface CreateDocxDocumentBlockDescendantResponse {
382
+ /** 所添加的孩子的 Block 信息 */
383
+ children?: Block[]
384
+ /** 当前提交的 Block 创建成功后文档的版本号 */
385
+ document_revision_id?: number
386
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
387
+ client_token?: string
388
+ /** 传入的临时 BlockID 与真实 BlockID 映射关系 */
389
+ block_id_relations?: BlockIdRelation[]
390
+ }
391
+
392
+ export interface PatchDocxDocumentBlockResponse {
393
+ /** 更新后的 block 信息 */
394
+ block?: Block
395
+ /** 当前更新成功后文档的版本号 */
396
+ document_revision_id?: number
397
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
398
+ client_token: string
399
+ }
400
+
401
+ export interface GetDocxDocumentBlockResponse {
402
+ /** 查询的 Block 的信息 */
403
+ block?: Block
404
+ }
405
+
406
+ export interface BatchUpdateDocxDocumentBlockResponse {
407
+ /** 批量更新的 Block */
408
+ blocks?: Block[]
409
+ /** 当前更新成功后文档的版本号 */
410
+ document_revision_id?: number
411
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
412
+ client_token: string
413
+ }
414
+
415
+ export interface BatchDeleteDocxDocumentBlockChildrenResponse {
416
+ /** 当前删除操作成功后文档的版本号 */
417
+ document_revision_id?: number
418
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
419
+ client_token: string
420
+ }
421
+
422
+ Internal.define({
423
+ '/docx/v1/chats/{chat_id}/announcement': {
424
+ GET: 'getDocxChatAnnouncement',
425
+ },
426
+ '/docx/v1/chats/{chat_id}/announcement/blocks': {
427
+ GET: { name: 'listDocxChatAnnouncementBlock', pagination: { argIndex: 1 } },
428
+ },
429
+ '/docx/v1/chats/{chat_id}/announcement/blocks/{block_id}/children': {
430
+ POST: 'createDocxChatAnnouncementBlockChildren',
431
+ GET: { name: 'getDocxChatAnnouncementBlockChildren', pagination: { argIndex: 2 } },
432
+ },
433
+ '/docx/v1/chats/{chat_id}/announcement/blocks/batch_update': {
434
+ PATCH: 'batchUpdateDocxChatAnnouncementBlock',
435
+ },
436
+ '/docx/v1/chats/{chat_id}/announcement/blocks/{block_id}': {
437
+ GET: 'getDocxChatAnnouncementBlock',
438
+ },
439
+ '/docx/v1/chats/{chat_id}/announcement/blocks/{block_id}/children/batch_delete': {
440
+ DELETE: 'batchDeleteDocxChatAnnouncementBlockChildren',
441
+ },
442
+ '/docx/v1/documents': {
443
+ POST: 'createDocxDocument',
444
+ },
445
+ '/docx/v1/documents/{document_id}': {
446
+ GET: 'getDocxDocument',
447
+ },
448
+ '/docx/v1/documents/{document_id}/raw_content': {
449
+ GET: 'rawContentDocxDocument',
450
+ },
451
+ '/docx/v1/documents/{document_id}/blocks': {
452
+ GET: { name: 'listDocxDocumentBlock', pagination: { argIndex: 1 } },
453
+ },
454
+ '/docx/v1/documents/{document_id}/blocks/{block_id}/children': {
455
+ POST: 'createDocxDocumentBlockChildren',
456
+ GET: { name: 'getDocxDocumentBlockChildren', pagination: { argIndex: 2 } },
457
+ },
458
+ '/docx/v1/documents/{document_id}/blocks/{block_id}/descendant': {
459
+ POST: 'createDocxDocumentBlockDescendant',
460
+ },
461
+ '/docx/v1/documents/{document_id}/blocks/{block_id}': {
462
+ PATCH: 'patchDocxDocumentBlock',
463
+ GET: 'getDocxDocumentBlock',
464
+ },
465
+ '/docx/v1/documents/{document_id}/blocks/batch_update': {
466
+ PATCH: 'batchUpdateDocxDocumentBlock',
467
+ },
468
+ '/docx/v1/documents/{document_id}/blocks/{block_id}/children/batch_delete': {
469
+ DELETE: 'batchDeleteDocxDocumentBlockChildren',
470
+ },
471
+ })