@satorijs/adapter-lark 3.10.6 → 3.11.1

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 (119) hide show
  1. package/lib/content.d.ts +211 -93
  2. package/lib/index.cjs +2954 -2474
  3. package/lib/internal.d.ts +4 -4
  4. package/lib/message.d.ts +2 -3
  5. package/lib/types/acs.d.ts +212 -172
  6. package/lib/types/admin.d.ts +331 -291
  7. package/lib/types/aily.d.ts +331 -216
  8. package/lib/types/apaas.d.ts +646 -494
  9. package/lib/types/application.d.ts +559 -458
  10. package/lib/types/approval.d.ts +826 -791
  11. package/lib/types/attendance.d.ts +1094 -994
  12. package/lib/types/auth.d.ts +66 -61
  13. package/lib/types/authen.d.ts +221 -186
  14. package/lib/types/baike.d.ts +258 -233
  15. package/lib/types/base.d.ts +74 -0
  16. package/lib/types/bitable.d.ts +830 -770
  17. package/lib/types/board.d.ts +29 -14
  18. package/lib/types/calendar.d.ts +660 -605
  19. package/lib/types/cardkit.d.ts +149 -134
  20. package/lib/types/compensation.d.ts +84 -49
  21. package/lib/types/contact.d.ts +1279 -1204
  22. package/lib/types/corehr.d.ts +4982 -4526
  23. package/lib/types/directory.d.ts +447 -0
  24. package/lib/types/docs.d.ts +28 -18
  25. package/lib/types/document_ai.d.ts +347 -252
  26. package/lib/types/docx.d.ts +428 -383
  27. package/lib/types/drive.d.ts +1093 -1048
  28. package/lib/types/ehr.d.ts +66 -51
  29. package/lib/types/event.d.ts +16 -6
  30. package/lib/types/helpdesk.d.ts +816 -741
  31. package/lib/types/hire.d.ts +3955 -3589
  32. package/lib/types/human_authentication.d.ts +32 -22
  33. package/lib/types/im.d.ts +1420 -1295
  34. package/lib/types/index.d.ts +1422 -330
  35. package/lib/types/lingo.d.ts +279 -249
  36. package/lib/types/mail.d.ts +1032 -675
  37. package/lib/types/mdm.d.ts +105 -37
  38. package/lib/types/minutes.d.ts +73 -26
  39. package/lib/types/moments.d.ts +23 -13
  40. package/lib/types/okr.d.ts +266 -225
  41. package/lib/types/optical_char_recognition.d.ts +22 -12
  42. package/lib/types/passport.d.ts +58 -48
  43. package/lib/types/payroll.d.ts +210 -53
  44. package/lib/types/performance.d.ts +463 -414
  45. package/lib/types/personal_settings.d.ts +93 -82
  46. package/lib/types/report.d.ts +79 -58
  47. package/lib/types/search.d.ts +265 -235
  48. package/lib/types/security_and_compliance.d.ts +30 -19
  49. package/lib/types/sheets.d.ts +356 -321
  50. package/lib/types/speech_to_text.d.ts +44 -34
  51. package/lib/types/task.d.ts +998 -1087
  52. package/lib/types/tenant.d.ts +25 -15
  53. package/lib/types/translation.d.ts +42 -32
  54. package/lib/types/trust_party.d.ts +81 -0
  55. package/lib/types/vc.d.ts +1218 -1123
  56. package/lib/types/verification.d.ts +11 -6
  57. package/lib/types/wiki.d.ts +270 -235
  58. package/lib/types/workplace.d.ts +58 -38
  59. package/lib/utils.d.ts +2 -2
  60. package/package.json +4 -4
  61. package/src/bot.ts +15 -15
  62. package/src/content.ts +230 -107
  63. package/src/internal.ts +29 -12
  64. package/src/message.ts +82 -111
  65. package/src/types/acs.ts +234 -186
  66. package/src/types/admin.ts +353 -305
  67. package/src/types/aily.ts +375 -233
  68. package/src/types/apaas.ts +754 -568
  69. package/src/types/application.ts +633 -507
  70. package/src/types/approval.ts +914 -872
  71. package/src/types/attendance.ts +1226 -1104
  72. package/src/types/auth.ts +72 -66
  73. package/src/types/authen.ts +233 -191
  74. package/src/types/baike.ts +276 -246
  75. package/src/types/base.ts +93 -0
  76. package/src/types/bitable.ts +966 -894
  77. package/src/types/board.ts +34 -16
  78. package/src/types/calendar.ts +751 -685
  79. package/src/types/cardkit.ts +164 -146
  80. package/src/types/compensation.ts +97 -55
  81. package/src/types/contact.ts +1465 -1375
  82. package/src/types/corehr.ts +5664 -5077
  83. package/src/types/directory.ts +569 -0
  84. package/src/types/docs.ts +31 -19
  85. package/src/types/document_ai.ts +401 -287
  86. package/src/types/docx.ts +492 -438
  87. package/src/types/drive.ts +1266 -1213
  88. package/src/types/ehr.ts +71 -53
  89. package/src/types/event.ts +19 -7
  90. package/src/types/helpdesk.ts +930 -840
  91. package/src/types/hire.ts +4453 -4019
  92. package/src/types/human_authentication.ts +35 -23
  93. package/src/types/im.ts +1626 -1476
  94. package/src/types/index.ts +1532 -346
  95. package/src/types/lingo.ts +299 -263
  96. package/src/types/mail.ts +1231 -779
  97. package/src/types/mdm.ts +122 -39
  98. package/src/types/minutes.ts +88 -28
  99. package/src/types/moments.ts +26 -14
  100. package/src/types/okr.ts +286 -238
  101. package/src/types/optical_char_recognition.ts +25 -13
  102. package/src/types/passport.ts +62 -50
  103. package/src/types/payroll.ts +254 -57
  104. package/src/types/performance.ts +528 -467
  105. package/src/types/personal_settings.ts +101 -89
  106. package/src/types/report.ts +86 -62
  107. package/src/types/search.ts +285 -249
  108. package/src/types/security_and_compliance.ts +33 -21
  109. package/src/types/sheets.ts +421 -379
  110. package/src/types/speech_to_text.ts +48 -36
  111. package/src/types/task.ts +1152 -1260
  112. package/src/types/tenant.ts +29 -17
  113. package/src/types/translation.ts +46 -34
  114. package/src/types/trust_party.ts +110 -0
  115. package/src/types/vc.ts +1397 -1283
  116. package/src/types/verification.ts +13 -7
  117. package/src/types/wiki.ts +293 -251
  118. package/src/types/workplace.ts +65 -41
  119. package/src/utils.ts +3 -3
@@ -1,1053 +1,1098 @@
1
- import { BaseMember, ExportTask, File, FileComment, FileCommentReply, FileLike, FileStatistics, FileViewRecord, ImportTask, ImportTaskMountPoint, Member, Meta, MetaFailed, PermissionPublic, Property, ReferEntity, ReplyContent, ReplyList, RequestDoc, TmpDownloadUrl, Version } from '.';
2
- import { Pagination } from '../internal';
1
+ import * as Lark from '.';
2
+ import { Paginated, Pagination } from '../internal';
3
3
  declare module '../internal' {
4
4
  interface Internal {
5
- /**
6
- * 获取文件夹中的文件清单
7
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list
8
- */
9
- listDriveV1File(query?: ListDriveV1FileQuery): Promise<ListDriveV1FileResponse> & AsyncIterableIterator<File>;
10
- /**
11
- * 新建文件夹
12
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder
13
- */
14
- createFolderDriveV1File(body: CreateFolderDriveV1FileRequest): Promise<CreateFolderDriveV1FileResponse>;
15
- /**
16
- * 查询异步任务状态
17
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check
18
- */
19
- taskCheckDriveV1File(query?: TaskCheckDriveV1FileQuery): Promise<TaskCheckDriveV1FileResponse>;
20
- /**
21
- * 获取文件元数据
22
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/meta/batch_query
23
- */
24
- batchQueryDriveV1Meta(body: BatchQueryDriveV1MetaRequest, query?: BatchQueryDriveV1MetaQuery): Promise<BatchQueryDriveV1MetaResponse>;
25
- /**
26
- * 获取文件统计信息
27
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-statistics/get
28
- */
29
- getDriveV1FileStatistics(file_token: string, query?: GetDriveV1FileStatisticsQuery): Promise<GetDriveV1FileStatisticsResponse>;
30
- /**
31
- * 获取文件访问记录
32
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-view_record/list
33
- */
34
- listDriveV1FileViewRecord(file_token: string, query?: ListDriveV1FileViewRecordQuery): Paginated<FileViewRecord>;
35
- /**
36
- * 复制文件
37
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy
38
- */
39
- copyDriveV1File(file_token: string, body: CopyDriveV1FileRequest, query?: CopyDriveV1FileQuery): Promise<CopyDriveV1FileResponse>;
40
- /**
41
- * 移动文件或文件夹
42
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/move
43
- */
44
- moveDriveV1File(file_token: string, body: MoveDriveV1FileRequest): Promise<MoveDriveV1FileResponse>;
45
- /**
46
- * 删除文件或文件夹
47
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete
48
- */
49
- deleteDriveV1File(file_token: string, query?: DeleteDriveV1FileQuery): Promise<DeleteDriveV1FileResponse>;
50
- /**
51
- * 创建文件快捷方式
52
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_shortcut
53
- */
54
- createShortcutDriveV1File(body: CreateShortcutDriveV1FileRequest, query?: CreateShortcutDriveV1FileQuery): Promise<CreateShortcutDriveV1FileResponse>;
55
- /**
56
- * 上传文件
57
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_all
58
- */
59
- uploadAllDriveV1File(form: UploadAllDriveV1FileForm): Promise<UploadAllDriveV1FileResponse>;
60
- /**
61
- * 分片上传文件-预上传
62
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare
63
- */
64
- uploadPrepareDriveV1File(body: UploadPrepareDriveV1FileRequest): Promise<UploadPrepareDriveV1FileResponse>;
65
- /**
66
- * 分片上传文件-上传分片
67
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part
68
- */
69
- uploadPartDriveV1File(form: UploadPartDriveV1FileForm): Promise<void>;
70
- /**
71
- * 分片上传文件-完成上传
72
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_finish
73
- */
74
- uploadFinishDriveV1File(body: UploadFinishDriveV1FileRequest): Promise<UploadFinishDriveV1FileResponse>;
75
- /**
76
- * 下载文件
77
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/download
78
- */
79
- downloadDriveV1File(file_token: string): Promise<ArrayBuffer>;
80
- /**
81
- * 创建导入任务
82
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/create
83
- */
84
- createDriveV1ImportTask(body: CreateDriveV1ImportTaskRequest): Promise<CreateDriveV1ImportTaskResponse>;
85
- /**
86
- * 查询导入任务结果
87
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/get
88
- */
89
- getDriveV1ImportTask(ticket: string): Promise<GetDriveV1ImportTaskResponse>;
90
- /**
91
- * 创建导出任务
92
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/create
93
- */
94
- createDriveV1ExportTask(body: CreateDriveV1ExportTaskRequest): Promise<CreateDriveV1ExportTaskResponse>;
95
- /**
96
- * 查询导出任务结果
97
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/get
98
- */
99
- getDriveV1ExportTask(ticket: string, query?: GetDriveV1ExportTaskQuery): Promise<GetDriveV1ExportTaskResponse>;
100
- /**
101
- * 下载导出文件
102
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/download
103
- */
104
- downloadDriveV1ExportTask(file_token: string): Promise<ArrayBuffer>;
105
- /**
106
- * 上传素材
107
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_all
108
- */
109
- uploadAllDriveV1Media(form: UploadAllDriveV1MediaForm): Promise<UploadAllDriveV1MediaResponse>;
110
- /**
111
- * 分片上传素材-预上传
112
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_prepare
113
- */
114
- uploadPrepareDriveV1Media(body: UploadPrepareDriveV1MediaRequest): Promise<UploadPrepareDriveV1MediaResponse>;
115
- /**
116
- * 分片上传素材-上传分片
117
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_part
118
- */
119
- uploadPartDriveV1Media(form: UploadPartDriveV1MediaForm): Promise<void>;
120
- /**
121
- * 分片上传素材-完成上传
122
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_finish
123
- */
124
- uploadFinishDriveV1Media(body: UploadFinishDriveV1MediaRequest): Promise<UploadFinishDriveV1MediaResponse>;
125
- /**
126
- * 下载素材
127
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/download
128
- */
129
- downloadDriveV1Media(file_token: string, query?: DownloadDriveV1MediaQuery): Promise<ArrayBuffer>;
130
- /**
131
- * 获取素材临时下载链接
132
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/batch_get_tmp_download_url
133
- */
134
- batchGetTmpDownloadUrlDriveV1Media(query?: BatchGetTmpDownloadUrlDriveV1MediaQuery): Promise<BatchGetTmpDownloadUrlDriveV1MediaResponse>;
135
- /**
136
- * 创建文档版本
137
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/create
138
- */
139
- createDriveV1FileVersion(file_token: string, body: CreateDriveV1FileVersionRequest, query?: CreateDriveV1FileVersionQuery): Promise<CreateDriveV1FileVersionResponse>;
140
- /**
141
- * 获取文档版本列表
142
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/list
143
- */
144
- listDriveV1FileVersion(file_token: string, query?: ListDriveV1FileVersionQuery): Paginated<Version>;
145
- /**
146
- * 获取文档版本信息
147
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/get
148
- */
149
- getDriveV1FileVersion(file_token: string, version_id: string, query?: GetDriveV1FileVersionQuery): Promise<GetDriveV1FileVersionResponse>;
150
- /**
151
- * 删除文档版本
152
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/delete
153
- */
154
- deleteDriveV1FileVersion(file_token: string, version_id: string, query?: DeleteDriveV1FileVersionQuery): Promise<void>;
155
- /**
156
- * 获取云文档的点赞者列表
157
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/file-like/list
158
- */
159
- listDriveV2FileLike(file_token: string, query?: ListDriveV2FileLikeQuery): Paginated<FileLike>;
160
- /**
161
- * 订阅云文档事件
162
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/subscribe
163
- */
164
- subscribeDriveV1File(file_token: string, query?: SubscribeDriveV1FileQuery): Promise<void>;
165
- /**
166
- * 查询云文档事件订阅状态
167
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/get_subscribe
168
- */
169
- getSubscribeDriveV1File(file_token: string, query?: GetSubscribeDriveV1FileQuery): Promise<GetSubscribeDriveV1FileResponse>;
170
- /**
171
- * 取消云文档事件订阅
172
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete_subscribe
173
- */
174
- deleteSubscribeDriveV1File(file_token: string, query?: DeleteSubscribeDriveV1FileQuery): Promise<void>;
175
- /**
176
- * 批量增加协作者权限
177
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/batch_create
178
- */
179
- batchCreateDriveV1PermissionMember(token: string, body: BatchCreateDriveV1PermissionMemberRequest, query?: BatchCreateDriveV1PermissionMemberQuery): Promise<BatchCreateDriveV1PermissionMemberResponse>;
180
- /**
181
- * 转移所有者
182
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/transfer_owner
183
- */
184
- transferOwnerDriveV1PermissionMember(token: string, body: TransferOwnerDriveV1PermissionMemberRequest, query?: TransferOwnerDriveV1PermissionMemberQuery): Promise<void>;
185
- /**
186
- * 判断当前用户是否有某权限
187
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/auth
188
- */
189
- authDriveV1PermissionMember(token: string, query?: AuthDriveV1PermissionMemberQuery): Promise<AuthDriveV1PermissionMemberResponse>;
190
- /**
191
- * 获取协作者列表
192
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/list
193
- */
194
- listDriveV1PermissionMember(token: string, query?: ListDriveV1PermissionMemberQuery): Promise<ListDriveV1PermissionMemberResponse>;
195
- /**
196
- * 增加协作者权限
197
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create
198
- */
199
- createDriveV1PermissionMember(token: string, body: CreateDriveV1PermissionMemberRequest, query?: CreateDriveV1PermissionMemberQuery): Promise<CreateDriveV1PermissionMemberResponse>;
200
- /**
201
- * 更新协作者权限
202
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/update
203
- */
204
- updateDriveV1PermissionMember(token: string, member_id: string, body: UpdateDriveV1PermissionMemberRequest, query?: UpdateDriveV1PermissionMemberQuery): Promise<UpdateDriveV1PermissionMemberResponse>;
205
- /**
206
- * 移除协作者权限
207
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/delete
208
- */
209
- deleteDriveV1PermissionMember(token: string, member_id: string, body: DeleteDriveV1PermissionMemberRequest, query?: DeleteDriveV1PermissionMemberQuery): Promise<void>;
210
- /**
211
- * 开启密码
212
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/create
213
- */
214
- createDriveV1PermissionPublicPassword(token: string, query?: CreateDriveV1PermissionPublicPasswordQuery): Promise<CreateDriveV1PermissionPublicPasswordResponse>;
215
- /**
216
- * 刷新密码
217
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/update
218
- */
219
- updateDriveV1PermissionPublicPassword(token: string, query?: UpdateDriveV1PermissionPublicPasswordQuery): Promise<UpdateDriveV1PermissionPublicPasswordResponse>;
220
- /**
221
- * 关闭密码
222
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/delete
223
- */
224
- deleteDriveV1PermissionPublicPassword(token: string, query?: DeleteDriveV1PermissionPublicPasswordQuery): Promise<void>;
225
- /**
226
- * 获取云文档权限设置
227
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public/get
228
- */
229
- getDriveV1PermissionPublic(token: string, query?: GetDriveV1PermissionPublicQuery): Promise<GetDriveV1PermissionPublicResponse>;
230
- /**
231
- * 更新云文档权限设置
232
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public/patch
233
- */
234
- patchDriveV1PermissionPublic(token: string, body: PatchDriveV1PermissionPublicRequest, query?: PatchDriveV1PermissionPublicQuery): Promise<PatchDriveV1PermissionPublicResponse>;
235
- /**
236
- * 获取云文档权限设置
237
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get
238
- */
239
- getDriveV2PermissionPublic(token: string, query?: GetDriveV2PermissionPublicQuery): Promise<GetDriveV2PermissionPublicResponse>;
240
- /**
241
- * 更新云文档权限设置
242
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/patch
243
- */
244
- patchDriveV2PermissionPublic(token: string, body: PatchDriveV2PermissionPublicRequest, query?: PatchDriveV2PermissionPublicQuery): Promise<PatchDriveV2PermissionPublicResponse>;
245
- /**
246
- * 获取云文档所有评论
247
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list
248
- */
249
- listDriveV1FileComment(file_token: string, query?: ListDriveV1FileCommentQuery): Paginated<FileComment>;
250
- /**
251
- * 批量获取评论
252
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/batch_query
253
- */
254
- batchQueryDriveV1FileComment(file_token: string, body: BatchQueryDriveV1FileCommentRequest, query?: BatchQueryDriveV1FileCommentQuery): Promise<BatchQueryDriveV1FileCommentResponse>;
255
- /**
256
- * 解决/恢复评论
257
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/patch
258
- */
259
- patchDriveV1FileComment(file_token: string, comment_id: string, body: PatchDriveV1FileCommentRequest, query?: PatchDriveV1FileCommentQuery): Promise<void>;
260
- /**
261
- * 添加全文评论
262
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/create
263
- */
264
- createDriveV1FileComment(file_token: string, body: CreateDriveV1FileCommentRequest, query?: CreateDriveV1FileCommentQuery): Promise<CreateDriveV1FileCommentResponse>;
265
- /**
266
- * 获取全文评论
267
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/get
268
- */
269
- getDriveV1FileComment(file_token: string, comment_id: string, query?: GetDriveV1FileCommentQuery): Promise<GetDriveV1FileCommentResponse>;
270
- /**
271
- * 获取回复信息
272
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/list
273
- */
274
- listDriveV1FileCommentReply(file_token: string, comment_id: string, query?: ListDriveV1FileCommentReplyQuery): Paginated<FileCommentReply>;
275
- /**
276
- * 更新回复的内容
277
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/update
278
- */
279
- updateDriveV1FileCommentReply(file_token: string, comment_id: string, reply_id: string, body: UpdateDriveV1FileCommentReplyRequest, query?: UpdateDriveV1FileCommentReplyQuery): Promise<void>;
280
- /**
281
- * 删除回复
282
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/delete
283
- */
284
- deleteDriveV1FileCommentReply(file_token: string, comment_id: string, reply_id: string, query?: DeleteDriveV1FileCommentReplyQuery): Promise<void>;
285
- /**
286
- * 获取订阅状态
287
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/get
288
- */
289
- getDriveV1FileSubscription(file_token: string, subscription_id: string, body: GetDriveV1FileSubscriptionRequest): Promise<GetDriveV1FileSubscriptionResponse>;
290
- /**
291
- * 创建订阅
292
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/create
293
- */
294
- createDriveV1FileSubscription(file_token: string, body: CreateDriveV1FileSubscriptionRequest): Promise<CreateDriveV1FileSubscriptionResponse>;
295
- /**
296
- * 更新订阅状态
297
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/patch
298
- */
299
- patchDriveV1FileSubscription(file_token: string, subscription_id: string, body: PatchDriveV1FileSubscriptionRequest): Promise<PatchDriveV1FileSubscriptionResponse>;
5
+ drive: Drive.Methods;
300
6
  }
301
7
  }
302
- export interface ListDriveV1FileQuery extends Pagination {
303
- /** 文件夹的token(若不填写该参数或填写空字符串,则默认获取用户云空间下的清单,且不支持分页) */
304
- folder_token?: string;
305
- /** 排序规则 */
306
- order_by?: 'EditedTime' | 'CreatedTime';
307
- /** 升序降序 */
308
- direction?: 'ASC' | 'DESC';
309
- /** 此次调用中使用的用户ID的类型 */
310
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
311
- }
312
- export interface ListDriveV1FileResponse {
313
- /** 文档详细信息 */
314
- files?: File[];
315
- /** 下一页分页参数 */
316
- next_page_token?: string;
317
- /** 是否有下一页 */
318
- has_more?: boolean;
319
- }
320
- export interface CreateFolderDriveV1FileRequest {
321
- /** 文件夹名称 */
322
- name: string;
323
- /** 父文件夹token */
324
- folder_token: string;
325
- }
326
- export interface CreateFolderDriveV1FileResponse {
327
- /** 新创建的文件夹 Token */
328
- token?: string;
329
- /** 创建文件夹的访问 URL */
330
- url?: string;
331
- }
332
- export interface TaskCheckDriveV1FileQuery {
333
- /** 文件相关异步任务id */
334
- task_id: string;
335
- }
336
- export interface TaskCheckDriveV1FileResponse {
337
- /** 异步任务的执行状态 */
338
- status?: string;
339
- }
340
- export interface BatchQueryDriveV1MetaRequest {
341
- /** 请求文档, 一次不超过200个 */
342
- request_docs: RequestDoc[];
343
- /** 是否获取文档链接 */
344
- with_url?: boolean;
345
- }
346
- export interface BatchQueryDriveV1MetaQuery {
347
- /** 此次调用中使用的用户ID的类型 */
348
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
349
- }
350
- export interface BatchQueryDriveV1MetaResponse {
351
- metas: Meta[];
352
- failed_list?: MetaFailed[];
353
- }
354
- export interface GetDriveV1FileStatisticsQuery {
355
- /** 文档类型 */
356
- file_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'wiki' | 'file' | 'docx';
357
- }
358
- export interface GetDriveV1FileStatisticsResponse {
359
- /** 文档token */
360
- file_token?: string;
361
- /** 文档类型 */
362
- file_type?: string;
363
- /** 文档统计信息 */
364
- statistics?: FileStatistics;
365
- }
366
- export interface ListDriveV1FileViewRecordQuery extends Pagination {
367
- /** 文档类型 */
368
- file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'mindnote' | 'wiki' | 'file';
369
- /** 此次调用中使用的访问者 ID 的类型 */
370
- viewer_id_type?: 'user_id' | 'union_id' | 'open_id';
371
- }
372
- export interface CopyDriveV1FileRequest {
373
- /** 被复制文件的新名称 */
374
- name: string;
375
- /** 被复制文件的类型,如果该值为空或者与文件实际类型不匹配,接口会返回失败。 */
376
- type?: 'file' | 'doc' | 'sheet' | 'bitable' | 'docx' | 'mindnote' | 'slides';
377
- /** 文件被复制到的目标文件夹token */
378
- folder_token: string;
379
- /** 用户自定义请求附加参数,用于实现特殊的复制语义 */
380
- extra?: Property[];
381
- }
382
- export interface CopyDriveV1FileQuery {
383
- /** 此次调用中使用的用户ID的类型 */
384
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
385
- }
386
- export interface CopyDriveV1FileResponse {
387
- /** 复制后的文件资源 */
388
- file?: File;
389
- }
390
- export interface MoveDriveV1FileRequest {
391
- /** 文件类型,如果该值为空或者与文件实际类型不匹配,接口会返回失败。 */
392
- type?: 'file' | 'docx' | 'bitable' | 'doc' | 'sheet' | 'mindnote' | 'folder' | 'slides';
393
- /** 目标文件夹token */
394
- folder_token?: string;
395
- }
396
- export interface MoveDriveV1FileResponse {
397
- /** 异步任务id,移动文件夹时返回 */
398
- task_id?: string;
399
- }
400
- export interface DeleteDriveV1FileQuery {
401
- /** 被删除文件的类型 */
402
- type: 'file' | 'docx' | 'bitable' | 'folder' | 'doc' | 'sheet' | 'mindnote' | 'shortcut' | 'slides';
403
- }
404
- export interface DeleteDriveV1FileResponse {
405
- /** 异步任务id,删除文件夹时返回 */
406
- task_id?: string;
407
- }
408
- export interface CreateShortcutDriveV1FileRequest {
409
- /** 创建快捷方式的目标父文件夹 token */
410
- parent_token: string;
411
- /** 快捷方式映射到的文档和文件列表信息 */
412
- refer_entity: ReferEntity;
413
- }
414
- export interface CreateShortcutDriveV1FileQuery {
415
- /** 此次调用中使用的用户ID的类型 */
416
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
417
- }
418
- export interface CreateShortcutDriveV1FileResponse {
419
- /** 返回创建成功的shortcut节点 */
420
- succ_shortcut_node?: File;
421
- }
422
- export interface UploadAllDriveV1FileForm {
423
- /** 文件名。 */
424
- file_name: string;
425
- /** 上传点类型。 */
426
- parent_type: 'explorer';
427
- /** 文件夹token,获取方式见 [概述](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction) */
428
- parent_node: string;
429
- /** 文件大小(以字节为单位)。 */
430
- size: number;
431
- /** 文件adler32校验和(可选)。 */
432
- checksum?: string;
433
- /** 文件二进制内容。 */
434
- file: Blob;
435
- }
436
- export interface UploadAllDriveV1FileResponse {
437
- file_token?: string;
438
- }
439
- export interface UploadPrepareDriveV1FileRequest {
440
- /** 文件名 */
441
- file_name: string;
442
- /** 上传点类型 */
443
- parent_type: 'explorer';
444
- /** 文件夹的token */
445
- parent_node: string;
446
- /** 文件大小 */
447
- size: number;
448
- }
449
- export interface UploadPrepareDriveV1FileResponse {
450
- /** 分片上传事务ID */
451
- upload_id?: string;
452
- /** 分片大小策略 */
453
- block_size?: number;
454
- /** 分片数量 */
455
- block_num?: number;
456
- }
457
- export interface UploadPartDriveV1FileForm {
458
- /** 分片上传事务ID。 */
459
- upload_id: string;
460
- /** 块号,从0开始计数。 */
461
- seq: number;
462
- /** 块大小(以字节为单位)。 */
463
- size: number;
464
- /** 文件分块adler32校验和(可选)。 */
465
- checksum?: string;
466
- /** 文件分片二进制内容。 */
467
- file: Blob;
468
- }
469
- export interface UploadFinishDriveV1FileRequest {
470
- /** 分片上传事务ID */
471
- upload_id: string;
472
- /** 分片数量 */
473
- block_num: number;
474
- }
475
- export interface UploadFinishDriveV1FileResponse {
476
- file_token?: string;
477
- }
478
- export interface CreateDriveV1ImportTaskRequest {
479
- /** 导入文件格式后缀 */
480
- file_extension: string;
481
- /** 导入的文件 Token */
482
- file_token: string;
483
- /** 导入目标云文档类型,支持的类型 新版文档:docx;电子表格:sheet;多维表格:bitable */
484
- type: string;
485
- /** 目标云文档的标题,若为空,则使用导入文件的名字 */
486
- file_name?: string;
487
- /** 挂载点 */
488
- point: ImportTaskMountPoint;
489
- }
490
- export interface CreateDriveV1ImportTaskResponse {
491
- /** 导入任务ID */
492
- ticket?: string;
493
- }
494
- export interface GetDriveV1ImportTaskResponse {
495
- /** 导入任务 */
496
- result?: ImportTask;
497
- }
498
- export interface CreateDriveV1ExportTaskRequest {
499
- /** 导出文件扩展名 */
500
- file_extension: 'docx' | 'pdf' | 'xlsx' | 'csv';
501
- /** 导出文档 Token */
502
- token: string;
503
- /** 导出文档类型 */
504
- type: 'doc' | 'sheet' | 'bitable' | 'docx';
505
- /** 导出子表 ID,仅当将 sheet/bitable 导出为 csv 时使用 */
506
- sub_id?: string;
507
- }
508
- export interface CreateDriveV1ExportTaskResponse {
509
- /** 导出任务ID */
510
- ticket?: string;
511
- }
512
- export interface GetDriveV1ExportTaskQuery {
513
- /** 导出文档的 token */
514
- token: string;
515
- }
516
- export interface GetDriveV1ExportTaskResponse {
517
- /** 导出结果 */
518
- result?: ExportTask;
519
- }
520
- export interface UploadAllDriveV1MediaForm {
521
- /** 文件名。 */
522
- file_name: string;
523
- /** 上传点类型。 */
524
- parent_type: 'doc_image' | 'docx_image' | 'sheet_image' | 'doc_file' | 'docx_file' | 'sheet_file' | 'vc_virtual_background' | 'bitable_image' | 'bitable_file' | 'moments' | 'ccm_import_open' | 'calendar' | 'base_global' | 'lark_ai_media_analysis';
525
- /** 上传点的token。 */
526
- parent_node: string;
527
- /** 文件大小(以字节为单位)。 */
528
- size: number;
529
- /** 文件adler32校验和(可选)。 */
530
- checksum?: string;
531
- /** 扩展信息(可选)。 */
532
- extra?: string;
533
- /** 文件二进制内容。 */
534
- file: Blob;
535
- }
536
- export interface UploadAllDriveV1MediaResponse {
537
- file_token?: string;
538
- }
539
- export interface UploadPrepareDriveV1MediaRequest {
540
- /** 文件名 */
541
- file_name: string;
542
- /** 上传点类型 */
543
- parent_type: 'doc_image' | 'docx_image' | 'sheet_image' | 'doc_file' | 'docx_file' | 'sheet_file' | 'vc_virtual_background' | 'bitable_image' | 'bitable_file' | 'moments' | 'ccm_import_open' | 'calendar' | 'base_global' | 'lark_ai_media_analysis';
544
- /** 文件大小 */
545
- size: number;
546
- /** 上传点的标识符 */
547
- parent_node?: string;
548
- /** 扩展信息(可选) */
549
- extra?: string;
550
- }
551
- export interface UploadPrepareDriveV1MediaResponse {
552
- /** 分片上传事务ID */
553
- upload_id?: string;
554
- /** 分片大小策略 */
555
- block_size?: number;
556
- /** 分片数量 */
557
- block_num?: number;
558
- }
559
- export interface UploadPartDriveV1MediaForm {
560
- /** 分片上传事务ID。 */
561
- upload_id: string;
562
- /** 块号,从0开始计数。 */
563
- seq: number;
564
- /** 块大小(以字节为单位)。 */
565
- size: number;
566
- /** 文件分块adler32校验和(可选)。 */
567
- checksum?: string;
568
- /** 文件分片二进制内容。 */
569
- file: Blob;
570
- }
571
- export interface UploadFinishDriveV1MediaRequest {
572
- /** 分片上传事务ID */
573
- upload_id: string;
574
- /** 分片数量 */
575
- block_num: number;
576
- }
577
- export interface UploadFinishDriveV1MediaResponse {
578
- file_token?: string;
579
- }
580
- export interface DownloadDriveV1MediaQuery {
581
- /** 扩展信息 */
582
- extra?: string;
583
- }
584
- export interface BatchGetTmpDownloadUrlDriveV1MediaQuery {
585
- /** 文件标识符列表 */
586
- file_tokens: string[];
587
- /** 拓展信息(可选) */
588
- extra?: string;
589
- }
590
- export interface BatchGetTmpDownloadUrlDriveV1MediaResponse {
591
- /** 临时下载列表 */
592
- tmp_download_urls?: TmpDownloadUrl[];
593
- }
594
- export interface CreateDriveV1FileVersionRequest {
595
- /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
596
- name?: string;
597
- /** 版本文档类型 */
598
- obj_type?: 'docx' | 'sheet';
599
- }
600
- export interface CreateDriveV1FileVersionQuery {
601
- /** 此次调用中使用的用户ID的类型 */
602
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
603
- }
604
- export interface CreateDriveV1FileVersionResponse {
605
- /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
606
- name?: string;
607
- /** 版本文档版本号 */
608
- version?: string;
609
- /** 源文档token */
610
- parent_token?: string;
611
- /** 版本文档所有者id */
612
- owner_id?: string;
613
- /** 版本文档创建者id */
614
- creator_id?: string;
615
- /** 版本文档创建时间 */
616
- create_time?: string;
617
- /** 版本文档更新时间 */
618
- update_time?: string;
619
- /** 版本文档状态 */
620
- status?: '0' | '1' | '2';
621
- /** 版本文档类型 */
622
- obj_type?: 'docx' | 'sheet';
623
- /** 源文档类型 */
624
- parent_type?: 'docx' | 'sheet';
625
- }
626
- export interface ListDriveV1FileVersionQuery extends Pagination {
627
- /** 原文档类型 */
628
- obj_type: 'docx' | 'sheet';
629
- /** 用户id类型 */
630
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
631
- }
632
- export interface GetDriveV1FileVersionQuery {
633
- /** 文档类型 */
634
- obj_type: 'docx' | 'sheet';
635
- /** 用户ID类型 */
636
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
637
- }
638
- export interface GetDriveV1FileVersionResponse {
639
- /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
640
- name?: string;
641
- /** 版本文档版本号 */
642
- version?: string;
643
- /** 源文档token */
644
- parent_token?: string;
645
- /** 版本文档所有者id */
646
- owner_id?: string;
647
- /** 版本文档创建者id */
648
- creator_id?: string;
649
- /** 版本文档创建时间 */
650
- create_time?: string;
651
- /** 版本文档更新时间 */
652
- update_time?: string;
653
- /** 版本文档状态 */
654
- status?: '0' | '1' | '2';
655
- /** 版本文档类型 */
656
- obj_type?: 'docx' | 'sheet';
657
- /** 源文档类型 */
658
- parent_type?: 'docx' | 'sheet';
659
- }
660
- export interface DeleteDriveV1FileVersionQuery {
661
- /** 文档类型 */
662
- obj_type: 'docx' | 'sheet';
663
- /** 用户ID类型 */
664
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
665
- }
666
- export interface ListDriveV2FileLikeQuery extends Pagination {
667
- /** 文件类型,如果该值为空或者与文件实际类型不匹配,接口会返回失败。 */
668
- file_type: 'doc' | 'docx' | 'file';
669
- /** 此次调用中使用的用户ID的类型 */
670
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
671
- }
672
- export interface SubscribeDriveV1FileQuery {
673
- /** 文档类型 */
674
- file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'folder';
675
- /** 事件类型 */
676
- event_type?: string;
677
- }
678
- export interface GetSubscribeDriveV1FileQuery {
679
- /** 文档类型 */
680
- file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'file' | 'folder';
681
- /** 事件类型 */
682
- event_type?: string;
683
- }
684
- export interface GetSubscribeDriveV1FileResponse {
685
- /** 是否有订阅,取值 true 表示已订阅;false 表示未订阅 */
686
- is_subscribe?: boolean;
687
- }
688
- export interface DeleteSubscribeDriveV1FileQuery {
689
- /** 文档类型 */
690
- file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'file' | 'folder';
691
- /** 事件类型 */
692
- event_type?: string;
693
- }
694
- export interface BatchCreateDriveV1PermissionMemberRequest {
695
- /** 协作者列表 */
696
- members: BaseMember[];
697
- }
698
- export interface BatchCreateDriveV1PermissionMemberQuery {
699
- /** 文件的类型 */
700
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides';
701
- /** 添加权限后是否通知对方 */
702
- need_notification?: boolean;
703
- }
704
- export interface BatchCreateDriveV1PermissionMemberResponse {
705
- /** 协作者列表 */
706
- members?: BaseMember[];
707
- }
708
- export interface TransferOwnerDriveV1PermissionMemberRequest {
709
- /** 文档拥有者的ID类型 */
710
- member_type: 'email' | 'openid' | 'userid';
711
- /** 文档拥有者的ID,与文档拥有者的ID类型需要对应 */
712
- member_id: string;
713
- }
714
- export interface TransferOwnerDriveV1PermissionMemberQuery {
715
- /** 文件类型,需要与文件的 token 相匹配 */
716
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' | 'folder';
717
- /** 是否需要通知新 Owner */
718
- need_notification?: boolean;
719
- /** 转移后是否需要移除原 Owner 的权限 */
720
- remove_old_owner?: boolean;
721
- /** 仅当内容不在共享文件夹中,此参数才会生效。如果设为false,系统会将该内容移至新所有者的个人空间根文件夹。如果设为 true,则留在原位置。 */
722
- stay_put?: boolean;
723
- /** 仅当 remove_old_owner = false 时,此参数才会生效 保留原文件所有者指定的权限角色 */
724
- old_owner_perm?: string;
725
- }
726
- export interface AuthDriveV1PermissionMemberQuery {
727
- /** 文件类型,需要与文件的 token 相匹配 */
728
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
729
- /** 需要判断的权限 */
730
- action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public';
731
- }
732
- export interface AuthDriveV1PermissionMemberResponse {
733
- /** 是否有权限 */
734
- auth_result: boolean;
735
- }
736
- export interface ListDriveV1PermissionMemberQuery {
737
- /** 文件类型,需要与文件的 token 相匹配 */
738
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
739
- /** 指定返回的协作者字段信息,如无指定则默认不返回**可选值有:** - `name`:协作者名- `type`:协作者类型- `avatar`:头像- `external_label`:外部标签**注意:** - 你可以使用特殊值`*`指定返回目前支持的所有字段- 你可以使用`,`分隔若干个你想指定返回的字段,如:`name,avatar`- 按需指定返回字段接口性能更好 */
740
- fields?: string;
741
- /** 协作者的权限角色类型 */
742
- perm_type?: 'container' | 'single_page';
743
- }
744
- export interface ListDriveV1PermissionMemberResponse {
745
- /** 返回的列表数据 */
746
- items?: Member[];
747
- }
748
- export interface CreateDriveV1PermissionMemberRequest {
749
- /** 协作者ID类型 */
750
- member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid';
751
- /** 协作者ID,与协作者ID类型需要对应 */
752
- member_id: string;
753
- /** 协作者的权限角色 */
754
- perm: 'view' | 'edit' | 'full_access';
755
- /** 协作者的权限角色类型 */
756
- perm_type?: 'container' | 'single_page';
757
- /** 协作者类型 */
758
- type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
759
- }
760
- export interface CreateDriveV1PermissionMemberQuery {
761
- /** 文件类型,需要与文件的 token 相匹配 */
762
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides';
763
- /** 添加权限后是否通知对方 */
764
- need_notification?: boolean;
765
- }
766
- export interface CreateDriveV1PermissionMemberResponse {
767
- /** 本次添加权限的用户信息 */
768
- member?: BaseMember;
769
- }
770
- export interface UpdateDriveV1PermissionMemberRequest {
771
- /** 协作者ID类型 */
772
- member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid';
773
- /** 协作者的权限角色 */
774
- perm: 'view' | 'edit' | 'full_access';
775
- /** 协作者的权限角色类型 */
776
- perm_type?: 'container' | 'single_page';
777
- /** 协作者类型 */
778
- type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
779
- }
780
- export interface UpdateDriveV1PermissionMemberQuery {
781
- /** 更新权限后是否通知对方**注意:** 使用`tenant_access_token`访问不支持该参数 */
782
- need_notification?: boolean;
783
- /** 文件类型,放于query参数中,如:`?type=doc` */
784
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
785
- }
786
- export interface UpdateDriveV1PermissionMemberResponse {
787
- /** 本次更新权限的用户信息 */
788
- member?: BaseMember;
789
- }
790
- export interface DeleteDriveV1PermissionMemberRequest {
791
- /** 协作者类型 */
792
- type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
793
- /** 协作者的权限角色类型 */
794
- perm_type?: 'container' | 'single_page';
795
- }
796
- export interface DeleteDriveV1PermissionMemberQuery {
797
- /** 文件类型,放于query参数中,如:`?type=doc` */
798
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides';
799
- /** 权限成员类型,放于query参数中,如:`?member_type=openid` */
800
- member_type: 'email' | 'openid' | 'openchat' | 'opendepartmentid' | 'userid' | 'unionid' | 'groupid' | 'wikispaceid';
801
- }
802
- export interface CreateDriveV1PermissionPublicPasswordQuery {
803
- /** 文件类型,需要与文件的 token 相匹配 */
804
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
805
- }
806
- export interface CreateDriveV1PermissionPublicPasswordResponse {
807
- /** 密码 */
808
- password?: string;
809
- }
810
- export interface UpdateDriveV1PermissionPublicPasswordQuery {
811
- /** 文件类型,需要与文件的 token 相匹配 */
812
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
813
- }
814
- export interface UpdateDriveV1PermissionPublicPasswordResponse {
815
- /** 密码 */
816
- password?: string;
817
- }
818
- export interface DeleteDriveV1PermissionPublicPasswordQuery {
819
- /** 文件类型,需要与文件的 token 相匹配 */
820
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
821
- }
822
- export interface GetDriveV1PermissionPublicQuery {
823
- /** 文件类型,放于query参数中,如:`?type=doc` */
824
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
825
- }
826
- export interface GetDriveV1PermissionPublicResponse {
827
- /** 返回的文档公共设置 */
828
- permission_public?: PermissionPublic;
829
- }
830
- export interface PatchDriveV1PermissionPublicRequest {
831
- /** 允许内容被分享到组织外 */
832
- external_access?: boolean;
833
- /** 谁可以复制内容、创建副本、打印、下载 */
834
- security_entity?: 'anyone_can_view' | 'anyone_can_edit' | 'only_full_access';
835
- /** 谁可以评论 */
836
- comment_entity?: 'anyone_can_view' | 'anyone_can_edit';
837
- /** 谁可以添加和管理协作者 */
838
- share_entity?: 'anyone' | 'same_tenant' | 'only_full_access';
839
- /** 链接分享设置 */
840
- link_share_entity?: 'tenant_readable' | 'tenant_editable' | 'anyone_readable' | 'anyone_editable' | 'closed';
841
- /** 允许非「可管理权限」的人分享到组织外 */
842
- invite_external?: boolean;
843
- }
844
- export interface PatchDriveV1PermissionPublicQuery {
845
- /** 文件类型,放于query参数中,如:`?type=doc` */
846
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
847
- }
848
- export interface PatchDriveV1PermissionPublicResponse {
849
- /** 本次更新后的文档公共设置 */
850
- permission_public?: PermissionPublic;
851
- }
852
- export interface GetDriveV2PermissionPublicQuery {
853
- /** 文件类型,需要与文件的 token 相匹配 */
854
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
855
- }
856
- export interface GetDriveV2PermissionPublicResponse {
857
- /** 返回的文档公共设置 */
858
- permission_public?: PermissionPublic;
859
- }
860
- export interface PatchDriveV2PermissionPublicRequest {
861
- /** 允许内容被分享到组织外 */
862
- external_access_entity?: 'open' | 'closed' | 'allow_share_partner_tenant';
863
- /** 谁可以创建副本、打印、下载 */
864
- security_entity?: 'anyone_can_view' | 'anyone_can_edit' | 'only_full_access';
865
- /** 谁可以评论 */
866
- comment_entity?: 'anyone_can_view' | 'anyone_can_edit';
867
- /** 谁可以添加和管理协作者-组织维度 */
868
- share_entity?: 'anyone' | 'same_tenant';
869
- /** 谁可以添加和管理协作者-协作者维度 */
870
- manage_collaborator_entity?: 'collaborator_can_view' | 'collaborator_can_edit' | 'collaborator_full_access';
871
- /** 链接分享设置 */
872
- link_share_entity?: 'tenant_readable' | 'tenant_editable' | 'partner_tenant_readable' | 'partner_tenant_editable' | 'anyone_readable' | 'anyone_editable' | 'closed';
873
- /** 谁可以复制内容 */
874
- copy_entity?: 'anyone_can_view' | 'anyone_can_edit' | 'only_full_access';
875
- }
876
- export interface PatchDriveV2PermissionPublicQuery {
877
- /** 文件类型,需要与文件的 token 相匹配 */
878
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
879
- }
880
- export interface PatchDriveV2PermissionPublicResponse {
881
- /** 本次更新后文档公共设置 */
882
- permission_public?: PermissionPublic;
883
- }
884
- export interface ListDriveV1FileCommentQuery extends Pagination {
885
- /** 文档类型 */
886
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
887
- /** 是否全文评论 */
888
- is_whole?: boolean;
889
- /** 是否已解决(可选) */
890
- is_solved?: boolean;
891
- /** 此次调用中使用的用户ID的类型 */
892
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
893
- }
894
- export interface BatchQueryDriveV1FileCommentRequest {
895
- /** 需要获取数据的评论id */
896
- comment_ids: string[];
897
- }
898
- export interface BatchQueryDriveV1FileCommentQuery {
899
- /** 文档类型 */
900
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
901
- /** 此次调用中使用的用户ID的类型 */
902
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
903
- }
904
- export interface BatchQueryDriveV1FileCommentResponse {
905
- /** 评论的相关信息、回复的信息、回复分页的信息 */
906
- items?: FileComment[];
907
- }
908
- export interface PatchDriveV1FileCommentRequest {
909
- /** 评论解决标志 */
910
- is_solved: boolean;
911
- }
912
- export interface PatchDriveV1FileCommentQuery {
913
- /** 文档类型 */
914
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
915
- }
916
- export interface CreateDriveV1FileCommentRequest {
917
- /** 评论里的回复列表 */
918
- reply_list?: ReplyList;
919
- }
920
- export interface CreateDriveV1FileCommentQuery {
921
- /** 文档类型 */
922
- file_type: 'doc' | 'docx';
923
- /** 此次调用中使用的用户 ID 的类型 */
924
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
925
- }
926
- export interface CreateDriveV1FileCommentResponse {
927
- /** 评论 ID */
928
- comment_id?: string;
929
- /** 用户 ID */
930
- user_id?: string;
931
- /** 创建时间 */
932
- create_time?: number;
933
- /** 更新时间 */
934
- update_time?: number;
935
- /** 是否已解决 */
936
- is_solved?: boolean;
937
- /** 解决评论时间 */
938
- solved_time?: number;
939
- /** 解决评论者的用户 ID */
940
- solver_user_id?: string;
941
- /** 是否有更多回复 */
942
- has_more?: boolean;
943
- /** 回复分页标记 */
944
- page_token?: string;
945
- /** 是否是全文评论 */
946
- is_whole?: boolean;
947
- /** 局部评论的引用字段 */
948
- quote?: string;
949
- /** 评论里的回复列表 */
950
- reply_list?: ReplyList;
951
- }
952
- export interface GetDriveV1FileCommentQuery {
953
- /** 文档类型 */
954
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
955
- /** 此次调用中使用的用户 ID 的类型 */
956
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
957
- }
958
- export interface GetDriveV1FileCommentResponse {
959
- /** 评论 ID */
960
- comment_id?: string;
961
- /** 用户 ID */
962
- user_id?: string;
963
- /** 创建时间 */
964
- create_time?: number;
965
- /** 更新时间 */
966
- update_time?: number;
967
- /** 是否已解决 */
968
- is_solved?: boolean;
969
- /** 解决评论时间 */
970
- solved_time?: number;
971
- /** 解决评论者的用户 ID */
972
- solver_user_id?: string;
973
- /** 是否有更多回复 */
974
- has_more?: boolean;
975
- /** 回复分页标记 */
976
- page_token?: string;
977
- /** 是否是全文评论 */
978
- is_whole?: boolean;
979
- /** 局部评论的引用字段 */
980
- quote?: string;
981
- /** 评论里的回复列表 */
982
- reply_list?: ReplyList;
983
- }
984
- export interface ListDriveV1FileCommentReplyQuery extends Pagination {
985
- /** 文档类型 */
986
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
987
- /** 此次调用中使用的用户ID的类型 */
988
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
989
- }
990
- export interface UpdateDriveV1FileCommentReplyRequest {
991
- /** 回复内容 */
992
- content: ReplyContent;
993
- }
994
- export interface UpdateDriveV1FileCommentReplyQuery {
995
- /** 文档类型 */
996
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
997
- /** 此次调用中使用的用户ID的类型 */
998
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
999
- }
1000
- export interface DeleteDriveV1FileCommentReplyQuery {
1001
- /** 文档类型 */
1002
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
1003
- }
1004
- export interface GetDriveV1FileSubscriptionRequest {
1005
- /** 文档类型 */
1006
- file_type: 'doc' | 'docx' | 'wiki';
1007
- }
1008
- export interface GetDriveV1FileSubscriptionResponse {
1009
- /** 订阅关系ID */
1010
- subscription_id: string;
1011
- /** 订阅类型 */
1012
- subscription_type?: 'comment_update';
1013
- /** 是否订阅 */
1014
- is_subcribe?: boolean;
1015
- /** 文档类型 */
1016
- file_type?: 'doc' | 'docx' | 'wiki';
1017
- }
1018
- export interface CreateDriveV1FileSubscriptionRequest {
1019
- /** 订阅关系ID */
1020
- subscription_id?: string;
1021
- /** 订阅类型 */
1022
- subscription_type: 'comment_update';
1023
- /** 是否订阅 */
1024
- is_subcribe?: boolean;
1025
- /** 文档类型 */
1026
- file_type: 'doc' | 'docx' | 'wiki';
1027
- }
1028
- export interface CreateDriveV1FileSubscriptionResponse {
1029
- /** 订阅关系ID */
1030
- subscription_id?: string;
1031
- /** 订阅类型 */
1032
- subscription_type?: 'comment_update';
1033
- /** 是否订阅 */
1034
- is_subcribe?: boolean;
1035
- /** 文档类型 */
1036
- file_type?: 'doc' | 'docx' | 'wiki';
1037
- }
1038
- export interface PatchDriveV1FileSubscriptionRequest {
1039
- /** 是否订阅 */
1040
- is_subscribe: boolean;
1041
- /** 文档类型 */
1042
- file_type: 'doc' | 'docx' | 'wiki';
1043
- }
1044
- export interface PatchDriveV1FileSubscriptionResponse {
1045
- /** 订阅关系ID */
1046
- subscription_id?: string;
1047
- /** 订阅类型 */
1048
- subscription_type?: 'comment_update';
1049
- /** 是否订阅 */
1050
- is_subcribe?: boolean;
1051
- /** 文档类型 */
1052
- file_type?: 'doc' | 'docx' | 'wiki';
8
+ export declare namespace Drive {
9
+ interface Methods {
10
+ file: File.Methods;
11
+ meta: Meta.Methods;
12
+ importTask: ImportTask.Methods;
13
+ exportTask: ExportTask.Methods;
14
+ media: Media.Methods;
15
+ permission: Permission.Methods;
16
+ }
17
+ namespace File {
18
+ interface Methods {
19
+ statistics: Statistics.Methods;
20
+ viewRecord: ViewRecord.Methods;
21
+ version: Version.Methods;
22
+ like: Like.Methods;
23
+ comment: Comment.Methods;
24
+ subscription: Subscription.Methods;
25
+ /**
26
+ * 获取文件夹中的文件清单
27
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list
28
+ */
29
+ list(query?: ListQuery): Promise<ListResponse> & AsyncIterableIterator<Lark.File>;
30
+ /**
31
+ * 新建文件夹
32
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder
33
+ */
34
+ createFolder(body: CreateFolderRequest): Promise<CreateFolderResponse>;
35
+ /**
36
+ * 查询异步任务状态
37
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/task_check
38
+ */
39
+ taskCheck(query?: TaskCheckQuery): Promise<TaskCheckResponse>;
40
+ /**
41
+ * 复制文件
42
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy
43
+ */
44
+ copy(file_token: string, body: CopyRequest, query?: CopyQuery): Promise<CopyResponse>;
45
+ /**
46
+ * 移动文件或文件夹
47
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/move
48
+ */
49
+ move(file_token: string, body: MoveRequest): Promise<MoveResponse>;
50
+ /**
51
+ * 删除文件或文件夹
52
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete
53
+ */
54
+ delete(file_token: string, query?: DeleteQuery): Promise<DeleteResponse>;
55
+ /**
56
+ * 创建文件快捷方式
57
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_shortcut
58
+ */
59
+ createShortcut(body: CreateShortcutRequest, query?: CreateShortcutQuery): Promise<CreateShortcutResponse>;
60
+ /**
61
+ * 上传文件
62
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_all
63
+ */
64
+ uploadAll(form: UploadAllForm): Promise<UploadAllResponse>;
65
+ /**
66
+ * 分片上传文件-预上传
67
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_prepare
68
+ */
69
+ uploadPrepare(body: UploadPrepareRequest): Promise<UploadPrepareResponse>;
70
+ /**
71
+ * 分片上传文件-上传分片
72
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_part
73
+ */
74
+ uploadPart(form: UploadPartForm): Promise<void>;
75
+ /**
76
+ * 分片上传文件-完成上传
77
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/upload_finish
78
+ */
79
+ uploadFinish(body: UploadFinishRequest): Promise<UploadFinishResponse>;
80
+ /**
81
+ * 下载文件
82
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/download
83
+ */
84
+ download(file_token: string): Promise<ArrayBuffer>;
85
+ /**
86
+ * 订阅云文档事件
87
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/subscribe
88
+ */
89
+ subscribe(file_token: string, query?: SubscribeQuery): Promise<void>;
90
+ /**
91
+ * 查询云文档事件订阅状态
92
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/get_subscribe
93
+ */
94
+ getSubscribe(file_token: string, query?: GetSubscribeQuery): Promise<GetSubscribeResponse>;
95
+ /**
96
+ * 取消云文档事件订阅
97
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete_subscribe
98
+ */
99
+ deleteSubscribe(file_token: string, query?: DeleteSubscribeQuery): Promise<void>;
100
+ }
101
+ interface ListQuery extends Pagination {
102
+ /** 文件夹的token(若不填写该参数或填写空字符串,则默认获取用户云空间下的清单,且不支持分页) */
103
+ folder_token?: string;
104
+ /** 排序规则 */
105
+ order_by?: 'EditedTime' | 'CreatedTime';
106
+ /** 升序降序 */
107
+ direction?: 'ASC' | 'DESC';
108
+ /** 此次调用中使用的用户ID的类型 */
109
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
110
+ }
111
+ interface ListResponse {
112
+ /** 文档详细信息 */
113
+ files?: Lark.File[];
114
+ /** 下一页分页参数 */
115
+ next_page_token?: string;
116
+ /** 是否有下一页 */
117
+ has_more?: boolean;
118
+ }
119
+ interface CreateFolderRequest {
120
+ /** 文件夹名称 */
121
+ name: string;
122
+ /** 父文件夹token */
123
+ folder_token: string;
124
+ }
125
+ interface CreateFolderResponse {
126
+ /** 新创建的文件夹 Token */
127
+ token?: string;
128
+ /** 创建文件夹的访问 URL */
129
+ url?: string;
130
+ }
131
+ interface TaskCheckQuery {
132
+ /** 文件相关异步任务id */
133
+ task_id: string;
134
+ }
135
+ interface TaskCheckResponse {
136
+ /** 异步任务的执行状态 */
137
+ status?: string;
138
+ }
139
+ interface CopyRequest {
140
+ /** 被复制文件的新名称 */
141
+ name: string;
142
+ /** 被复制文件的类型,如果该值为空或者与文件实际类型不匹配,接口会返回失败。 */
143
+ type?: 'file' | 'doc' | 'sheet' | 'bitable' | 'docx' | 'mindnote' | 'slides';
144
+ /** 文件被复制到的目标文件夹token */
145
+ folder_token: string;
146
+ /** 用户自定义请求附加参数,用于实现特殊的复制语义 */
147
+ extra?: Lark.Property[];
148
+ }
149
+ interface CopyQuery {
150
+ /** 此次调用中使用的用户ID的类型 */
151
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
152
+ }
153
+ interface CopyResponse {
154
+ /** 复制后的文件资源 */
155
+ file?: Lark.File;
156
+ }
157
+ interface MoveRequest {
158
+ /** 文件类型,如果该值为空或者与文件实际类型不匹配,接口会返回失败。 */
159
+ type?: 'file' | 'docx' | 'bitable' | 'doc' | 'sheet' | 'mindnote' | 'folder' | 'slides';
160
+ /** 目标文件夹token */
161
+ folder_token?: string;
162
+ }
163
+ interface MoveResponse {
164
+ /** 异步任务id,移动文件夹时返回 */
165
+ task_id?: string;
166
+ }
167
+ interface DeleteQuery {
168
+ /** 被删除文件的类型 */
169
+ type: 'file' | 'docx' | 'bitable' | 'folder' | 'doc' | 'sheet' | 'mindnote' | 'shortcut' | 'slides';
170
+ }
171
+ interface DeleteResponse {
172
+ /** 异步任务id,删除文件夹时返回 */
173
+ task_id?: string;
174
+ }
175
+ interface CreateShortcutRequest {
176
+ /** 创建快捷方式的目标父文件夹 token */
177
+ parent_token: string;
178
+ /** 快捷方式映射到的文档和文件列表信息 */
179
+ refer_entity: Lark.ReferEntity;
180
+ }
181
+ interface CreateShortcutQuery {
182
+ /** 此次调用中使用的用户ID的类型 */
183
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
184
+ }
185
+ interface CreateShortcutResponse {
186
+ /** 返回创建成功的shortcut节点 */
187
+ succ_shortcut_node?: Lark.File;
188
+ }
189
+ interface UploadAllForm {
190
+ /** 文件名。 */
191
+ file_name: string;
192
+ /** 上传点类型。 */
193
+ parent_type: 'explorer';
194
+ /** 文件夹token,获取方式见 [概述](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction) */
195
+ parent_node: string;
196
+ /** 文件大小(以字节为单位)。 */
197
+ size: number;
198
+ /** 文件adler32校验和(可选)。 */
199
+ checksum?: string;
200
+ /** 文件二进制内容。 */
201
+ file: Blob;
202
+ }
203
+ interface UploadAllResponse {
204
+ file_token?: string;
205
+ }
206
+ interface UploadPrepareRequest {
207
+ /** 文件名 */
208
+ file_name: string;
209
+ /** 上传点类型 */
210
+ parent_type: 'explorer';
211
+ /** 文件夹的token */
212
+ parent_node: string;
213
+ /** 文件大小 */
214
+ size: number;
215
+ }
216
+ interface UploadPrepareResponse {
217
+ /** 分片上传事务ID */
218
+ upload_id?: string;
219
+ /** 分片大小策略 */
220
+ block_size?: number;
221
+ /** 分片数量 */
222
+ block_num?: number;
223
+ }
224
+ interface UploadPartForm {
225
+ /** 分片上传事务ID。 */
226
+ upload_id: string;
227
+ /** 块号,从0开始计数。 */
228
+ seq: number;
229
+ /** 块大小(以字节为单位)。 */
230
+ size: number;
231
+ /** 文件分块adler32校验和(可选)。 */
232
+ checksum?: string;
233
+ /** 文件分片二进制内容。 */
234
+ file: Blob;
235
+ }
236
+ interface UploadFinishRequest {
237
+ /** 分片上传事务ID */
238
+ upload_id: string;
239
+ /** 分片数量 */
240
+ block_num: number;
241
+ }
242
+ interface UploadFinishResponse {
243
+ file_token?: string;
244
+ }
245
+ interface SubscribeQuery {
246
+ /** 文档类型 */
247
+ file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'folder';
248
+ /** 事件类型 */
249
+ event_type?: string;
250
+ }
251
+ interface GetSubscribeQuery {
252
+ /** 文档类型 */
253
+ file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'file' | 'folder';
254
+ /** 事件类型 */
255
+ event_type?: string;
256
+ }
257
+ interface GetSubscribeResponse {
258
+ /** 是否有订阅,取值 true 表示已订阅;false 表示未订阅 */
259
+ is_subscribe?: boolean;
260
+ }
261
+ interface DeleteSubscribeQuery {
262
+ /** 文档类型 */
263
+ file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'file' | 'folder';
264
+ /** 事件类型 */
265
+ event_type?: string;
266
+ }
267
+ namespace Statistics {
268
+ interface Methods {
269
+ /**
270
+ * 获取文件统计信息
271
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-statistics/get
272
+ */
273
+ get(file_token: string, query?: GetQuery): Promise<GetResponse>;
274
+ }
275
+ interface GetQuery {
276
+ /** 文档类型 */
277
+ file_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'wiki' | 'file' | 'docx';
278
+ }
279
+ interface GetResponse {
280
+ /** 文档token */
281
+ file_token?: string;
282
+ /** 文档类型 */
283
+ file_type?: string;
284
+ /** 文档统计信息 */
285
+ statistics?: Lark.FileStatistics;
286
+ }
287
+ }
288
+ namespace ViewRecord {
289
+ interface Methods {
290
+ /**
291
+ * 获取文件访问记录
292
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-view_record/list
293
+ */
294
+ list(file_token: string, query?: ListQuery): Paginated<Lark.FileViewRecord>;
295
+ }
296
+ interface ListQuery extends Pagination {
297
+ /** 文档类型 */
298
+ file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'mindnote' | 'wiki' | 'file';
299
+ /** 此次调用中使用的访问者 ID 的类型 */
300
+ viewer_id_type?: 'user_id' | 'union_id' | 'open_id';
301
+ }
302
+ }
303
+ namespace Version {
304
+ interface Methods {
305
+ /**
306
+ * 创建文档版本
307
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/create
308
+ */
309
+ create(file_token: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
310
+ /**
311
+ * 获取文档版本列表
312
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/list
313
+ */
314
+ list(file_token: string, query?: ListQuery): Paginated<Lark.Version>;
315
+ /**
316
+ * 获取文档版本信息
317
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/get
318
+ */
319
+ get(file_token: string, version_id: string, query?: GetQuery): Promise<GetResponse>;
320
+ /**
321
+ * 删除文档版本
322
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-version/delete
323
+ */
324
+ delete(file_token: string, version_id: string, query?: DeleteQuery): Promise<void>;
325
+ }
326
+ interface CreateRequest {
327
+ /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
328
+ name?: string;
329
+ /** 版本文档类型 */
330
+ obj_type?: 'docx' | 'sheet';
331
+ }
332
+ interface CreateQuery {
333
+ /** 此次调用中使用的用户ID的类型 */
334
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
335
+ }
336
+ interface CreateResponse {
337
+ /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
338
+ name?: string;
339
+ /** 版本文档版本号 */
340
+ version?: string;
341
+ /** 源文档token */
342
+ parent_token?: string;
343
+ /** 版本文档所有者id */
344
+ owner_id?: string;
345
+ /** 版本文档创建者id */
346
+ creator_id?: string;
347
+ /** 版本文档创建时间 */
348
+ create_time?: string;
349
+ /** 版本文档更新时间 */
350
+ update_time?: string;
351
+ /** 版本文档状态 */
352
+ status?: '0' | '1' | '2';
353
+ /** 版本文档类型 */
354
+ obj_type?: 'docx' | 'sheet';
355
+ /** 源文档类型 */
356
+ parent_type?: 'docx' | 'sheet';
357
+ }
358
+ interface ListQuery extends Pagination {
359
+ /** 原文档类型 */
360
+ obj_type: 'docx' | 'sheet';
361
+ /** 用户id类型 */
362
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
363
+ }
364
+ interface GetQuery {
365
+ /** 文档类型 */
366
+ obj_type: 'docx' | 'sheet';
367
+ /** 用户ID类型 */
368
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
369
+ }
370
+ interface GetResponse {
371
+ /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
372
+ name?: string;
373
+ /** 版本文档版本号 */
374
+ version?: string;
375
+ /** 源文档token */
376
+ parent_token?: string;
377
+ /** 版本文档所有者id */
378
+ owner_id?: string;
379
+ /** 版本文档创建者id */
380
+ creator_id?: string;
381
+ /** 版本文档创建时间 */
382
+ create_time?: string;
383
+ /** 版本文档更新时间 */
384
+ update_time?: string;
385
+ /** 版本文档状态 */
386
+ status?: '0' | '1' | '2';
387
+ /** 版本文档类型 */
388
+ obj_type?: 'docx' | 'sheet';
389
+ /** 源文档类型 */
390
+ parent_type?: 'docx' | 'sheet';
391
+ }
392
+ interface DeleteQuery {
393
+ /** 文档类型 */
394
+ obj_type: 'docx' | 'sheet';
395
+ /** 用户ID类型 */
396
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
397
+ }
398
+ }
399
+ namespace Like {
400
+ interface Methods {
401
+ /**
402
+ * 获取云文档的点赞者列表
403
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/file-like/list
404
+ */
405
+ list(file_token: string, query?: ListQuery): Paginated<Lark.FileLike>;
406
+ }
407
+ interface ListQuery extends Pagination {
408
+ /** 文件类型,如果该值为空或者与文件实际类型不匹配,接口会返回失败。 */
409
+ file_type: 'doc' | 'docx' | 'file';
410
+ /** 此次调用中使用的用户ID的类型 */
411
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
412
+ }
413
+ }
414
+ namespace Comment {
415
+ interface Methods {
416
+ reply: Reply.Methods;
417
+ /**
418
+ * 获取云文档所有评论
419
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list
420
+ */
421
+ list(file_token: string, query?: ListQuery): Paginated<Lark.FileComment>;
422
+ /**
423
+ * 批量获取评论
424
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/batch_query
425
+ */
426
+ batchQuery(file_token: string, body: BatchQueryRequest, query?: BatchQueryQuery): Promise<BatchQueryResponse>;
427
+ /**
428
+ * 解决/恢复评论
429
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/patch
430
+ */
431
+ patch(file_token: string, comment_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
432
+ /**
433
+ * 添加全文评论
434
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/create
435
+ */
436
+ create(file_token: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
437
+ /**
438
+ * 获取全文评论
439
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/get
440
+ */
441
+ get(file_token: string, comment_id: string, query?: GetQuery): Promise<GetResponse>;
442
+ }
443
+ interface ListQuery extends Pagination {
444
+ /** 文档类型 */
445
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
446
+ /** 是否全文评论 */
447
+ is_whole?: boolean;
448
+ /** 是否已解决(可选) */
449
+ is_solved?: boolean;
450
+ /** 此次调用中使用的用户ID的类型 */
451
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
452
+ }
453
+ interface BatchQueryRequest {
454
+ /** 需要获取数据的评论id */
455
+ comment_ids: string[];
456
+ }
457
+ interface BatchQueryQuery {
458
+ /** 文档类型 */
459
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
460
+ /** 此次调用中使用的用户ID的类型 */
461
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
462
+ }
463
+ interface BatchQueryResponse {
464
+ /** 评论的相关信息、回复的信息、回复分页的信息 */
465
+ items?: Lark.FileComment[];
466
+ }
467
+ interface PatchRequest {
468
+ /** 评论解决标志 */
469
+ is_solved: boolean;
470
+ }
471
+ interface PatchQuery {
472
+ /** 文档类型 */
473
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
474
+ }
475
+ interface CreateRequest {
476
+ /** 评论里的回复列表 */
477
+ reply_list?: Lark.ReplyList;
478
+ }
479
+ interface CreateQuery {
480
+ /** 文档类型 */
481
+ file_type: 'doc' | 'docx';
482
+ /** 此次调用中使用的用户 ID 的类型 */
483
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
484
+ }
485
+ interface CreateResponse {
486
+ /** 评论 ID */
487
+ comment_id?: string;
488
+ /** 用户 ID */
489
+ user_id?: string;
490
+ /** 创建时间 */
491
+ create_time?: number;
492
+ /** 更新时间 */
493
+ update_time?: number;
494
+ /** 是否已解决 */
495
+ is_solved?: boolean;
496
+ /** 解决评论时间 */
497
+ solved_time?: number;
498
+ /** 解决评论者的用户 ID */
499
+ solver_user_id?: string;
500
+ /** 是否有更多回复 */
501
+ has_more?: boolean;
502
+ /** 回复分页标记 */
503
+ page_token?: string;
504
+ /** 是否是全文评论 */
505
+ is_whole?: boolean;
506
+ /** 局部评论的引用字段 */
507
+ quote?: string;
508
+ /** 评论里的回复列表 */
509
+ reply_list?: Lark.ReplyList;
510
+ }
511
+ interface GetQuery {
512
+ /** 文档类型 */
513
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
514
+ /** 此次调用中使用的用户 ID 的类型 */
515
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
516
+ }
517
+ interface GetResponse {
518
+ /** 评论 ID */
519
+ comment_id?: string;
520
+ /** 用户 ID */
521
+ user_id?: string;
522
+ /** 创建时间 */
523
+ create_time?: number;
524
+ /** 更新时间 */
525
+ update_time?: number;
526
+ /** 是否已解决 */
527
+ is_solved?: boolean;
528
+ /** 解决评论时间 */
529
+ solved_time?: number;
530
+ /** 解决评论者的用户 ID */
531
+ solver_user_id?: string;
532
+ /** 是否有更多回复 */
533
+ has_more?: boolean;
534
+ /** 回复分页标记 */
535
+ page_token?: string;
536
+ /** 是否是全文评论 */
537
+ is_whole?: boolean;
538
+ /** 局部评论的引用字段 */
539
+ quote?: string;
540
+ /** 评论里的回复列表 */
541
+ reply_list?: Lark.ReplyList;
542
+ }
543
+ namespace Reply {
544
+ interface Methods {
545
+ /**
546
+ * 获取回复信息
547
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/list
548
+ */
549
+ list(file_token: string, comment_id: string, query?: ListQuery): Paginated<Lark.FileCommentReply>;
550
+ /**
551
+ * 更新回复的内容
552
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/update
553
+ */
554
+ update(file_token: string, comment_id: string, reply_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<void>;
555
+ /**
556
+ * 删除回复
557
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment-reply/delete
558
+ */
559
+ delete(file_token: string, comment_id: string, reply_id: string, query?: DeleteQuery): Promise<void>;
560
+ }
561
+ interface ListQuery extends Pagination {
562
+ /** 文档类型 */
563
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
564
+ /** 此次调用中使用的用户ID的类型 */
565
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
566
+ }
567
+ interface UpdateRequest {
568
+ /** 回复内容 */
569
+ content: Lark.ReplyContent;
570
+ }
571
+ interface UpdateQuery {
572
+ /** 文档类型 */
573
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
574
+ /** 此次调用中使用的用户ID的类型 */
575
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
576
+ }
577
+ interface DeleteQuery {
578
+ /** 文档类型 */
579
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
580
+ }
581
+ }
582
+ }
583
+ namespace Subscription {
584
+ interface Methods {
585
+ /**
586
+ * 获取订阅状态
587
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/get
588
+ */
589
+ get(file_token: string, subscription_id: string, body: GetRequest): Promise<GetResponse>;
590
+ /**
591
+ * 创建订阅
592
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/create
593
+ */
594
+ create(file_token: string, body: CreateRequest): Promise<CreateResponse>;
595
+ /**
596
+ * 更新订阅状态
597
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-subscription/patch
598
+ */
599
+ patch(file_token: string, subscription_id: string, body: PatchRequest): Promise<PatchResponse>;
600
+ }
601
+ interface GetRequest {
602
+ /** 文档类型 */
603
+ file_type: 'doc' | 'docx' | 'wiki';
604
+ }
605
+ interface GetResponse {
606
+ /** 订阅关系ID */
607
+ subscription_id: string;
608
+ /** 订阅类型 */
609
+ subscription_type?: 'comment_update';
610
+ /** 是否订阅 */
611
+ is_subcribe?: boolean;
612
+ /** 文档类型 */
613
+ file_type?: 'doc' | 'docx' | 'wiki';
614
+ }
615
+ interface CreateRequest {
616
+ /** 订阅关系ID */
617
+ subscription_id?: string;
618
+ /** 订阅类型 */
619
+ subscription_type: 'comment_update';
620
+ /** 是否订阅 */
621
+ is_subcribe?: boolean;
622
+ /** 文档类型 */
623
+ file_type: 'doc' | 'docx' | 'wiki';
624
+ }
625
+ interface CreateResponse {
626
+ /** 订阅关系ID */
627
+ subscription_id?: string;
628
+ /** 订阅类型 */
629
+ subscription_type?: 'comment_update';
630
+ /** 是否订阅 */
631
+ is_subcribe?: boolean;
632
+ /** 文档类型 */
633
+ file_type?: 'doc' | 'docx' | 'wiki';
634
+ }
635
+ interface PatchRequest {
636
+ /** 是否订阅 */
637
+ is_subscribe: boolean;
638
+ /** 文档类型 */
639
+ file_type: 'doc' | 'docx' | 'wiki';
640
+ }
641
+ interface PatchResponse {
642
+ /** 订阅关系ID */
643
+ subscription_id?: string;
644
+ /** 订阅类型 */
645
+ subscription_type?: 'comment_update';
646
+ /** 是否订阅 */
647
+ is_subcribe?: boolean;
648
+ /** 文档类型 */
649
+ file_type?: 'doc' | 'docx' | 'wiki';
650
+ }
651
+ }
652
+ }
653
+ namespace Meta {
654
+ interface Methods {
655
+ /**
656
+ * 获取文件元数据
657
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/meta/batch_query
658
+ */
659
+ batchQuery(body: BatchQueryRequest, query?: BatchQueryQuery): Promise<BatchQueryResponse>;
660
+ }
661
+ interface BatchQueryRequest {
662
+ /** 请求文档, 一次不超过200个 */
663
+ request_docs: Lark.RequestDoc[];
664
+ /** 是否获取文档链接 */
665
+ with_url?: boolean;
666
+ }
667
+ interface BatchQueryQuery {
668
+ /** 此次调用中使用的用户ID的类型 */
669
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
670
+ }
671
+ interface BatchQueryResponse {
672
+ metas: Lark.Meta[];
673
+ failed_list?: Lark.MetaFailed[];
674
+ }
675
+ }
676
+ namespace ImportTask {
677
+ interface Methods {
678
+ /**
679
+ * 创建导入任务
680
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/create
681
+ */
682
+ create(body: CreateRequest): Promise<CreateResponse>;
683
+ /**
684
+ * 查询导入任务结果
685
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/import_task/get
686
+ */
687
+ get(ticket: string): Promise<GetResponse>;
688
+ }
689
+ interface CreateRequest {
690
+ /** 导入文件格式后缀 */
691
+ file_extension: string;
692
+ /** 导入的文件 Token */
693
+ file_token: string;
694
+ /** 导入目标云文档类型,支持的类型 新版文档:docx;电子表格:sheet;多维表格:bitable */
695
+ type: string;
696
+ /** 目标云文档的标题,若为空,则使用导入文件的名字 */
697
+ file_name?: string;
698
+ /** 挂载点 */
699
+ point: Lark.ImportTaskMountPoint;
700
+ }
701
+ interface CreateResponse {
702
+ /** 导入任务ID */
703
+ ticket?: string;
704
+ }
705
+ interface GetResponse {
706
+ /** 导入任务 */
707
+ result?: Lark.ImportTask;
708
+ }
709
+ }
710
+ namespace ExportTask {
711
+ interface Methods {
712
+ /**
713
+ * 创建导出任务
714
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/create
715
+ */
716
+ create(body: CreateRequest): Promise<CreateResponse>;
717
+ /**
718
+ * 查询导出任务结果
719
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/get
720
+ */
721
+ get(ticket: string, query?: GetQuery): Promise<GetResponse>;
722
+ /**
723
+ * 下载导出文件
724
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/export_task/download
725
+ */
726
+ download(file_token: string): Promise<ArrayBuffer>;
727
+ }
728
+ interface CreateRequest {
729
+ /** 导出文件扩展名 */
730
+ file_extension: 'docx' | 'pdf' | 'xlsx' | 'csv';
731
+ /** 导出文档 Token */
732
+ token: string;
733
+ /** 导出文档类型 */
734
+ type: 'doc' | 'sheet' | 'bitable' | 'docx';
735
+ /** 导出子表 ID,仅当将 sheet/bitable 导出为 csv 时使用 */
736
+ sub_id?: string;
737
+ }
738
+ interface CreateResponse {
739
+ /** 导出任务ID */
740
+ ticket?: string;
741
+ }
742
+ interface GetQuery {
743
+ /** 导出文档的 token */
744
+ token: string;
745
+ }
746
+ interface GetResponse {
747
+ /** 导出结果 */
748
+ result?: Lark.ExportTask;
749
+ }
750
+ }
751
+ namespace Media {
752
+ interface Methods {
753
+ /**
754
+ * 上传素材
755
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_all
756
+ */
757
+ uploadAll(form: UploadAllForm): Promise<UploadAllResponse>;
758
+ /**
759
+ * 分片上传素材-预上传
760
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_prepare
761
+ */
762
+ uploadPrepare(body: UploadPrepareRequest): Promise<UploadPrepareResponse>;
763
+ /**
764
+ * 分片上传素材-上传分片
765
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_part
766
+ */
767
+ uploadPart(form: UploadPartForm): Promise<void>;
768
+ /**
769
+ * 分片上传素材-完成上传
770
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/upload_finish
771
+ */
772
+ uploadFinish(body: UploadFinishRequest): Promise<UploadFinishResponse>;
773
+ /**
774
+ * 下载素材
775
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/download
776
+ */
777
+ download(file_token: string, query?: DownloadQuery): Promise<ArrayBuffer>;
778
+ /**
779
+ * 获取素材临时下载链接
780
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/media/batch_get_tmp_download_url
781
+ */
782
+ batchGetTmpDownloadUrl(query?: BatchGetTmpDownloadUrlQuery): Promise<BatchGetTmpDownloadUrlResponse>;
783
+ }
784
+ interface UploadAllForm {
785
+ /** 文件名。 */
786
+ file_name: string;
787
+ /** 上传点类型。 */
788
+ parent_type: 'doc_image' | 'docx_image' | 'sheet_image' | 'doc_file' | 'docx_file' | 'sheet_file' | 'vc_virtual_background' | 'bitable_image' | 'bitable_file' | 'moments' | 'ccm_import_open' | 'calendar' | 'base_global' | 'lark_ai_media_analysis';
789
+ /** 上传点的token。 */
790
+ parent_node: string;
791
+ /** 文件大小(以字节为单位)。 */
792
+ size: number;
793
+ /** 文件adler32校验和(可选)。 */
794
+ checksum?: string;
795
+ /** 扩展信息(可选)。 */
796
+ extra?: string;
797
+ /** 文件二进制内容。 */
798
+ file: Blob;
799
+ }
800
+ interface UploadAllResponse {
801
+ file_token?: string;
802
+ }
803
+ interface UploadPrepareRequest {
804
+ /** 文件名 */
805
+ file_name: string;
806
+ /** 上传点类型 */
807
+ parent_type: 'doc_image' | 'docx_image' | 'sheet_image' | 'doc_file' | 'docx_file' | 'sheet_file' | 'vc_virtual_background' | 'bitable_image' | 'bitable_file' | 'moments' | 'ccm_import_open' | 'calendar' | 'base_global' | 'lark_ai_media_analysis';
808
+ /** 文件大小 */
809
+ size: number;
810
+ /** 上传点的标识符 */
811
+ parent_node?: string;
812
+ /** 扩展信息(可选) */
813
+ extra?: string;
814
+ }
815
+ interface UploadPrepareResponse {
816
+ /** 分片上传事务ID */
817
+ upload_id?: string;
818
+ /** 分片大小策略 */
819
+ block_size?: number;
820
+ /** 分片数量 */
821
+ block_num?: number;
822
+ }
823
+ interface UploadPartForm {
824
+ /** 分片上传事务ID。 */
825
+ upload_id: string;
826
+ /** 块号,从0开始计数。 */
827
+ seq: number;
828
+ /** 块大小(以字节为单位)。 */
829
+ size: number;
830
+ /** 文件分块adler32校验和(可选)。 */
831
+ checksum?: string;
832
+ /** 文件分片二进制内容。 */
833
+ file: Blob;
834
+ }
835
+ interface UploadFinishRequest {
836
+ /** 分片上传事务ID */
837
+ upload_id: string;
838
+ /** 分片数量 */
839
+ block_num: number;
840
+ }
841
+ interface UploadFinishResponse {
842
+ file_token?: string;
843
+ }
844
+ interface DownloadQuery {
845
+ /** 扩展信息 */
846
+ extra?: string;
847
+ }
848
+ interface BatchGetTmpDownloadUrlQuery {
849
+ /** 文件标识符列表 */
850
+ file_tokens: string[];
851
+ /** 拓展信息(可选) */
852
+ extra?: string;
853
+ }
854
+ interface BatchGetTmpDownloadUrlResponse {
855
+ /** 临时下载列表 */
856
+ tmp_download_urls?: Lark.TmpDownloadUrl[];
857
+ }
858
+ }
859
+ namespace Permission {
860
+ interface Methods {
861
+ member: Member.Methods;
862
+ public: Public.Methods;
863
+ }
864
+ namespace Member {
865
+ interface Methods {
866
+ /**
867
+ * 批量增加协作者权限
868
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/batch_create
869
+ */
870
+ batchCreate(token: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>;
871
+ /**
872
+ * 转移所有者
873
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/transfer_owner
874
+ */
875
+ transferOwner(token: string, body: TransferOwnerRequest, query?: TransferOwnerQuery): Promise<void>;
876
+ /**
877
+ * 判断当前用户是否有某权限
878
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/auth
879
+ */
880
+ auth(token: string, query?: AuthQuery): Promise<AuthResponse>;
881
+ /**
882
+ * 获取协作者列表
883
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/list
884
+ */
885
+ list(token: string, query?: ListQuery): Promise<ListResponse>;
886
+ /**
887
+ * 增加协作者权限
888
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create
889
+ */
890
+ create(token: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
891
+ /**
892
+ * 更新协作者权限
893
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/update
894
+ */
895
+ update(token: string, member_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
896
+ /**
897
+ * 移除协作者权限
898
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/delete
899
+ */
900
+ delete(token: string, member_id: string, body: DeleteRequest, query?: DeleteQuery): Promise<void>;
901
+ }
902
+ interface BatchCreateRequest {
903
+ /** 协作者列表 */
904
+ members: Lark.BaseMember[];
905
+ }
906
+ interface BatchCreateQuery {
907
+ /** 文件的类型 */
908
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides';
909
+ /** 添加权限后是否通知对方 */
910
+ need_notification?: boolean;
911
+ }
912
+ interface BatchCreateResponse {
913
+ /** 协作者列表 */
914
+ members?: Lark.BaseMember[];
915
+ }
916
+ interface TransferOwnerRequest {
917
+ /** 文档拥有者的ID类型 */
918
+ member_type: 'email' | 'openid' | 'userid';
919
+ /** 文档拥有者的ID,与文档拥有者的ID类型需要对应 */
920
+ member_id: string;
921
+ }
922
+ interface TransferOwnerQuery {
923
+ /** 文件类型,需要与文件的 token 相匹配 */
924
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' | 'folder';
925
+ /** 是否需要通知新 Owner */
926
+ need_notification?: boolean;
927
+ /** 转移后是否需要移除原 Owner 的权限 */
928
+ remove_old_owner?: boolean;
929
+ /** 仅当内容不在共享文件夹中,此参数才会生效。如果设为false,系统会将该内容移至新所有者的个人空间根文件夹。如果设为 true,则留在原位置。 */
930
+ stay_put?: boolean;
931
+ /** 仅当 remove_old_owner = false 时,此参数才会生效 保留原文件所有者指定的权限角色 */
932
+ old_owner_perm?: string;
933
+ }
934
+ interface AuthQuery {
935
+ /** 文件类型,需要与文件的 token 相匹配 */
936
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
937
+ /** 需要判断的权限 */
938
+ action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public';
939
+ }
940
+ interface AuthResponse {
941
+ /** 是否有权限 */
942
+ auth_result: boolean;
943
+ }
944
+ interface ListQuery {
945
+ /** 文件类型,需要与文件的 token 相匹配 */
946
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
947
+ /** 指定返回的协作者字段信息,如无指定则默认不返回**可选值有:** - `name`:协作者名- `type`:协作者类型- `avatar`:头像- `external_label`:外部标签**注意:** - 你可以使用特殊值`*`指定返回目前支持的所有字段- 你可以使用`,`分隔若干个你想指定返回的字段,如:`name,avatar`- 按需指定返回字段接口性能更好 */
948
+ fields?: string;
949
+ /** 协作者的权限角色类型 */
950
+ perm_type?: 'container' | 'single_page';
951
+ }
952
+ interface ListResponse {
953
+ /** 返回的列表数据 */
954
+ items?: Lark.Member[];
955
+ }
956
+ interface CreateRequest {
957
+ /** 协作者ID类型 */
958
+ member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid';
959
+ /** 协作者ID,与协作者ID类型需要对应 */
960
+ member_id: string;
961
+ /** 协作者的权限角色 */
962
+ perm: 'view' | 'edit' | 'full_access';
963
+ /** 协作者的权限角色类型 */
964
+ perm_type?: 'container' | 'single_page';
965
+ /** 协作者类型 */
966
+ type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
967
+ }
968
+ interface CreateQuery {
969
+ /** 文件类型,需要与文件的 token 相匹配 */
970
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides';
971
+ /** 添加权限后是否通知对方 */
972
+ need_notification?: boolean;
973
+ }
974
+ interface CreateResponse {
975
+ /** 本次添加权限的用户信息 */
976
+ member?: Lark.BaseMember;
977
+ }
978
+ interface UpdateRequest {
979
+ /** 协作者ID类型 */
980
+ member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid';
981
+ /** 协作者的权限角色 */
982
+ perm: 'view' | 'edit' | 'full_access';
983
+ /** 协作者的权限角色类型 */
984
+ perm_type?: 'container' | 'single_page';
985
+ /** 协作者类型 */
986
+ type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
987
+ }
988
+ interface UpdateQuery {
989
+ /** 更新权限后是否通知对方**注意:** 使用`tenant_access_token`访问不支持该参数 */
990
+ need_notification?: boolean;
991
+ /** 文件类型,放于query参数中,如:`?type=doc` */
992
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
993
+ }
994
+ interface UpdateResponse {
995
+ /** 本次更新权限的用户信息 */
996
+ member?: Lark.BaseMember;
997
+ }
998
+ interface DeleteRequest {
999
+ /** 协作者类型 */
1000
+ type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
1001
+ /** 协作者的权限角色类型 */
1002
+ perm_type?: 'container' | 'single_page';
1003
+ }
1004
+ interface DeleteQuery {
1005
+ /** 文件类型,放于query参数中,如:`?type=doc` */
1006
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides';
1007
+ /** 权限成员类型,放于query参数中,如:`?member_type=openid` */
1008
+ member_type: 'email' | 'openid' | 'openchat' | 'opendepartmentid' | 'userid' | 'unionid' | 'groupid' | 'wikispaceid';
1009
+ }
1010
+ }
1011
+ namespace Public {
1012
+ interface Methods {
1013
+ password: Password.Methods;
1014
+ /**
1015
+ * 获取云文档权限设置
1016
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get
1017
+ */
1018
+ get(token: string, query?: GetQuery): Promise<GetResponse>;
1019
+ /**
1020
+ * 更新云文档权限设置
1021
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/patch
1022
+ */
1023
+ patch(token: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
1024
+ }
1025
+ interface GetQuery {
1026
+ /** 文件类型,需要与文件的 token 相匹配 */
1027
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
1028
+ }
1029
+ interface GetResponse {
1030
+ /** 返回的文档公共设置 */
1031
+ permission_public?: Lark.PermissionPublic;
1032
+ }
1033
+ interface PatchRequest {
1034
+ /** 允许内容被分享到组织外 */
1035
+ external_access_entity?: 'open' | 'closed' | 'allow_share_partner_tenant';
1036
+ /** 谁可以创建副本、打印、下载 */
1037
+ security_entity?: 'anyone_can_view' | 'anyone_can_edit' | 'only_full_access';
1038
+ /** 谁可以评论 */
1039
+ comment_entity?: 'anyone_can_view' | 'anyone_can_edit';
1040
+ /** 谁可以添加和管理协作者-组织维度 */
1041
+ share_entity?: 'anyone' | 'same_tenant';
1042
+ /** 谁可以添加和管理协作者-协作者维度 */
1043
+ manage_collaborator_entity?: 'collaborator_can_view' | 'collaborator_can_edit' | 'collaborator_full_access';
1044
+ /** 链接分享设置 */
1045
+ link_share_entity?: 'tenant_readable' | 'tenant_editable' | 'partner_tenant_readable' | 'partner_tenant_editable' | 'anyone_readable' | 'anyone_editable' | 'closed';
1046
+ /** 谁可以复制内容 */
1047
+ copy_entity?: 'anyone_can_view' | 'anyone_can_edit' | 'only_full_access';
1048
+ }
1049
+ interface PatchQuery {
1050
+ /** 文件类型,需要与文件的 token 相匹配 */
1051
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
1052
+ }
1053
+ interface PatchResponse {
1054
+ /** 本次更新后文档公共设置 */
1055
+ permission_public?: Lark.PermissionPublic;
1056
+ }
1057
+ namespace Password {
1058
+ interface Methods {
1059
+ /**
1060
+ * 开启密码
1061
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/create
1062
+ */
1063
+ create(token: string, query?: CreateQuery): Promise<CreateResponse>;
1064
+ /**
1065
+ * 刷新密码
1066
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/update
1067
+ */
1068
+ update(token: string, query?: UpdateQuery): Promise<UpdateResponse>;
1069
+ /**
1070
+ * 关闭密码
1071
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/delete
1072
+ */
1073
+ delete(token: string, query?: DeleteQuery): Promise<void>;
1074
+ }
1075
+ interface CreateQuery {
1076
+ /** 文件类型,需要与文件的 token 相匹配 */
1077
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
1078
+ }
1079
+ interface CreateResponse {
1080
+ /** 密码 */
1081
+ password?: string;
1082
+ }
1083
+ interface UpdateQuery {
1084
+ /** 文件类型,需要与文件的 token 相匹配 */
1085
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
1086
+ }
1087
+ interface UpdateResponse {
1088
+ /** 密码 */
1089
+ password?: string;
1090
+ }
1091
+ interface DeleteQuery {
1092
+ /** 文件类型,需要与文件的 token 相匹配 */
1093
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
1094
+ }
1095
+ }
1096
+ }
1097
+ }
1053
1098
  }