@satorijs/adapter-lark 3.10.6 → 3.11.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 (116) hide show
  1. package/lib/index.cjs +2880 -2370
  2. package/lib/internal.d.ts +4 -4
  3. package/lib/types/acs.d.ts +212 -172
  4. package/lib/types/admin.d.ts +331 -291
  5. package/lib/types/aily.d.ts +331 -216
  6. package/lib/types/apaas.d.ts +646 -494
  7. package/lib/types/application.d.ts +559 -458
  8. package/lib/types/approval.d.ts +826 -791
  9. package/lib/types/attendance.d.ts +1094 -994
  10. package/lib/types/auth.d.ts +66 -61
  11. package/lib/types/authen.d.ts +221 -186
  12. package/lib/types/baike.d.ts +258 -233
  13. package/lib/types/base.d.ts +74 -0
  14. package/lib/types/bitable.d.ts +830 -770
  15. package/lib/types/board.d.ts +29 -14
  16. package/lib/types/calendar.d.ts +660 -605
  17. package/lib/types/cardkit.d.ts +149 -134
  18. package/lib/types/compensation.d.ts +84 -49
  19. package/lib/types/contact.d.ts +1279 -1204
  20. package/lib/types/corehr.d.ts +4982 -4526
  21. package/lib/types/directory.d.ts +447 -0
  22. package/lib/types/docs.d.ts +28 -18
  23. package/lib/types/document_ai.d.ts +347 -252
  24. package/lib/types/docx.d.ts +428 -383
  25. package/lib/types/drive.d.ts +1093 -1048
  26. package/lib/types/ehr.d.ts +66 -51
  27. package/lib/types/event.d.ts +16 -6
  28. package/lib/types/helpdesk.d.ts +816 -741
  29. package/lib/types/hire.d.ts +3955 -3589
  30. package/lib/types/human_authentication.d.ts +32 -22
  31. package/lib/types/im.d.ts +1420 -1295
  32. package/lib/types/index.d.ts +1422 -330
  33. package/lib/types/lingo.d.ts +279 -249
  34. package/lib/types/mail.d.ts +1032 -675
  35. package/lib/types/mdm.d.ts +105 -37
  36. package/lib/types/minutes.d.ts +73 -26
  37. package/lib/types/moments.d.ts +23 -13
  38. package/lib/types/okr.d.ts +266 -225
  39. package/lib/types/optical_char_recognition.d.ts +22 -12
  40. package/lib/types/passport.d.ts +58 -48
  41. package/lib/types/payroll.d.ts +210 -53
  42. package/lib/types/performance.d.ts +463 -414
  43. package/lib/types/personal_settings.d.ts +93 -82
  44. package/lib/types/report.d.ts +79 -58
  45. package/lib/types/search.d.ts +265 -235
  46. package/lib/types/security_and_compliance.d.ts +30 -19
  47. package/lib/types/sheets.d.ts +356 -321
  48. package/lib/types/speech_to_text.d.ts +44 -34
  49. package/lib/types/task.d.ts +998 -1087
  50. package/lib/types/tenant.d.ts +25 -15
  51. package/lib/types/translation.d.ts +42 -32
  52. package/lib/types/trust_party.d.ts +81 -0
  53. package/lib/types/vc.d.ts +1218 -1123
  54. package/lib/types/verification.d.ts +11 -6
  55. package/lib/types/wiki.d.ts +270 -235
  56. package/lib/types/workplace.d.ts +58 -38
  57. package/lib/utils.d.ts +2 -2
  58. package/package.json +4 -4
  59. package/src/bot.ts +15 -15
  60. package/src/internal.ts +29 -12
  61. package/src/message.ts +10 -10
  62. package/src/types/acs.ts +234 -186
  63. package/src/types/admin.ts +353 -305
  64. package/src/types/aily.ts +375 -233
  65. package/src/types/apaas.ts +754 -568
  66. package/src/types/application.ts +633 -507
  67. package/src/types/approval.ts +914 -872
  68. package/src/types/attendance.ts +1226 -1104
  69. package/src/types/auth.ts +72 -66
  70. package/src/types/authen.ts +233 -191
  71. package/src/types/baike.ts +276 -246
  72. package/src/types/base.ts +93 -0
  73. package/src/types/bitable.ts +966 -894
  74. package/src/types/board.ts +34 -16
  75. package/src/types/calendar.ts +751 -685
  76. package/src/types/cardkit.ts +164 -146
  77. package/src/types/compensation.ts +97 -55
  78. package/src/types/contact.ts +1465 -1375
  79. package/src/types/corehr.ts +5664 -5077
  80. package/src/types/directory.ts +569 -0
  81. package/src/types/docs.ts +31 -19
  82. package/src/types/document_ai.ts +401 -287
  83. package/src/types/docx.ts +492 -438
  84. package/src/types/drive.ts +1266 -1213
  85. package/src/types/ehr.ts +71 -53
  86. package/src/types/event.ts +19 -7
  87. package/src/types/helpdesk.ts +930 -840
  88. package/src/types/hire.ts +4453 -4019
  89. package/src/types/human_authentication.ts +35 -23
  90. package/src/types/im.ts +1626 -1476
  91. package/src/types/index.ts +1532 -346
  92. package/src/types/lingo.ts +299 -263
  93. package/src/types/mail.ts +1231 -779
  94. package/src/types/mdm.ts +122 -39
  95. package/src/types/minutes.ts +88 -28
  96. package/src/types/moments.ts +26 -14
  97. package/src/types/okr.ts +286 -238
  98. package/src/types/optical_char_recognition.ts +25 -13
  99. package/src/types/passport.ts +62 -50
  100. package/src/types/payroll.ts +254 -57
  101. package/src/types/performance.ts +528 -467
  102. package/src/types/personal_settings.ts +101 -89
  103. package/src/types/report.ts +86 -62
  104. package/src/types/search.ts +285 -249
  105. package/src/types/security_and_compliance.ts +33 -21
  106. package/src/types/sheets.ts +421 -379
  107. package/src/types/speech_to_text.ts +48 -36
  108. package/src/types/task.ts +1152 -1260
  109. package/src/types/tenant.ts +29 -17
  110. package/src/types/translation.ts +46 -34
  111. package/src/types/trust_party.ts +110 -0
  112. package/src/types/vc.ts +1397 -1283
  113. package/src/types/verification.ts +13 -7
  114. package/src/types/wiki.ts +293 -251
  115. package/src/types/workplace.ts +65 -41
  116. package/src/utils.ts +3 -3
@@ -1,23 +1,29 @@
1
- import { Verification } from '.'
1
+ import * as Lark from '.'
2
2
  import { Internal } from '../internal'
3
3
 
4
4
  declare module '../internal' {
5
5
  interface Internal {
6
+ verification: Verification.Methods
7
+ }
8
+ }
9
+
10
+ export namespace Verification {
11
+ export interface Methods {
6
12
  /**
7
13
  * 获取认证信息
8
14
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/verification-v1/verification/get
9
15
  */
10
- getVerification(): Promise<GetVerificationResponse>
16
+ get(): Promise<GetResponse>
11
17
  }
12
- }
13
18
 
14
- export interface GetVerificationResponse {
15
- /** 认证信息 */
16
- verification?: Verification
19
+ export interface GetResponse {
20
+ /** 认证信息 */
21
+ verification?: Lark.Verification
22
+ }
17
23
  }
18
24
 
19
25
  Internal.define({
20
26
  '/verification/v1/verification': {
21
- GET: 'getVerification',
27
+ GET: 'verification.get',
22
28
  },
23
29
  })
package/src/types/wiki.ts CHANGED
@@ -1,313 +1,355 @@
1
- import { Member, Node, Setting, Space, TaskResult } from '.'
2
- import { Internal, Pagination } from '../internal'
1
+ import * as Lark from '.'
2
+ import { Internal, Paginated, Pagination } from '../internal'
3
3
 
4
4
  declare module '../internal' {
5
5
  interface Internal {
6
- /**
7
- * 获取知识空间列表
8
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list
9
- */
10
- listWikiSpace(query?: ListWikiSpaceQuery): Paginated<Space>
11
- /**
12
- * 获取知识空间信息
13
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get
14
- */
15
- getWikiSpace(space_id: string, query?: GetWikiSpaceQuery): Promise<GetWikiSpaceResponse>
16
- /**
17
- * 创建知识空间
18
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/create
19
- */
20
- createWikiSpace(body: CreateWikiSpaceRequest): Promise<CreateWikiSpaceResponse>
21
- /**
22
- * 获取知识空间成员列表
23
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/list
24
- */
25
- listWikiSpaceMember(space_id: string, query?: Pagination): Paginated<Member, 'members'>
26
- /**
27
- * 添加知识空间成员
28
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/create
29
- */
30
- createWikiSpaceMember(space_id: string, body: CreateWikiSpaceMemberRequest, query?: CreateWikiSpaceMemberQuery): Promise<CreateWikiSpaceMemberResponse>
31
- /**
32
- * 删除知识空间成员
33
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/delete
34
- */
35
- deleteWikiSpaceMember(space_id: string, member_id: string, body: DeleteWikiSpaceMemberRequest): Promise<DeleteWikiSpaceMemberResponse>
36
- /**
37
- * 更新知识空间设置
38
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-setting/update
39
- */
40
- updateWikiSpaceSetting(space_id: string, body: UpdateWikiSpaceSettingRequest): Promise<UpdateWikiSpaceSettingResponse>
41
- /**
42
- * 创建知识空间节点
43
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/create
44
- */
45
- createWikiSpaceNode(space_id: string, body: CreateWikiSpaceNodeRequest): Promise<CreateWikiSpaceNodeResponse>
46
- /**
47
- * 获取知识空间节点信息
48
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node
49
- */
50
- getNodeWikiSpace(query?: GetNodeWikiSpaceQuery): Promise<GetNodeWikiSpaceResponse>
51
- /**
52
- * 获取知识空间子节点列表
53
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/list
54
- */
55
- listWikiSpaceNode(space_id: string, query?: ListWikiSpaceNodeQuery): Paginated<Node>
56
- /**
57
- * 移动知识空间节点
58
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move
59
- */
60
- moveWikiSpaceNode(space_id: string, node_token: string, body: MoveWikiSpaceNodeRequest): Promise<MoveWikiSpaceNodeResponse>
61
- /**
62
- * 更新知识空间节点标题
63
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/update_title
64
- */
65
- updateTitleWikiSpaceNode(space_id: string, node_token: string, body: UpdateTitleWikiSpaceNodeRequest): Promise<void>
66
- /**
67
- * 创建知识空间节点副本
68
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/copy
69
- */
70
- copyWikiSpaceNode(space_id: string, node_token: string, body: CopyWikiSpaceNodeRequest): Promise<CopyWikiSpaceNodeResponse>
71
- /**
72
- * 移动云空间文档至知识空间
73
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move_docs_to_wiki
74
- */
75
- moveDocsToWikiWikiSpaceNode(space_id: string, body: MoveDocsToWikiWikiSpaceNodeRequest): Promise<MoveDocsToWikiWikiSpaceNodeResponse>
76
- /**
77
- * 获取任务结果
78
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/task/get
79
- */
80
- getWikiTask(task_id: string, query?: GetWikiTaskQuery): Promise<GetWikiTaskResponse>
81
- /**
82
- * 搜索 Wiki
83
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uEzN0YjLxcDN24SM3QjN/search_wiki
84
- */
85
- searchWikiNode(body: SearchWikiNodeRequest, query?: Pagination): Paginated<Node>
6
+ wiki: Wiki.Methods
86
7
  }
87
8
  }
88
9
 
89
- export interface ListWikiSpaceQuery extends Pagination {
90
- /** 当查询个人文档库时,指定返回的文档库名称展示语言。可选值有:zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */
91
- lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW'
92
- }
10
+ export namespace Wiki {
11
+ export interface Methods {
12
+ space: Space.Methods
13
+ task: Task.Methods
14
+ node: Node.Methods
15
+ }
93
16
 
94
- export interface GetWikiSpaceQuery {
95
- /** 当查询个人文档库时,指定返回的文档库名称展示语言。可选值有:zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */
96
- lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW'
97
- }
17
+ export namespace Space {
18
+ export interface Methods {
19
+ member: Member.Methods
20
+ setting: Setting.Methods
21
+ node: Node.Methods
22
+ /**
23
+ * 获取知识空间列表
24
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/list
25
+ */
26
+ list(query?: ListQuery): Paginated<Lark.Space>
27
+ /**
28
+ * 获取知识空间信息
29
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get
30
+ */
31
+ get(space_id: string, query?: GetQuery): Promise<GetResponse>
32
+ /**
33
+ * 创建知识空间
34
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/create
35
+ */
36
+ create(body: CreateRequest): Promise<CreateResponse>
37
+ /**
38
+ * 获取知识空间节点信息
39
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node
40
+ */
41
+ getNode(query?: GetNodeQuery): Promise<GetNodeResponse>
42
+ }
98
43
 
99
- export interface GetWikiSpaceResponse {
100
- /** 知识空间 */
101
- space?: Space
102
- }
44
+ export interface ListQuery extends Pagination {
45
+ /** 当查询个人文档库时,指定返回的文档库名称展示语言。可选值有:zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */
46
+ lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW'
47
+ }
103
48
 
104
- export interface CreateWikiSpaceRequest {
105
- /** 知识空间名称 */
106
- name?: string
107
- /** 知识空间描述 */
108
- description?: string
109
- /** 表示知识空间的分享状态 */
110
- open_sharing?: 'open' | 'closed'
111
- }
49
+ export interface GetQuery {
50
+ /** 当查询个人文档库时,指定返回的文档库名称展示语言。可选值有:zh, id, de, en, es, fr, it, pt, vi, ru, hi, th, ko, ja, zh-HK, zh-TW。 */
51
+ lang?: 'zh' | 'id' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'vi' | 'ru' | 'hi' | 'th' | 'ko' | 'ja' | 'zh-HK' | 'zh-TW'
52
+ }
112
53
 
113
- export interface CreateWikiSpaceResponse {
114
- /** 知识空间信息 */
115
- space?: Space
116
- }
54
+ export interface GetResponse {
55
+ /** 知识空间 */
56
+ space?: Lark.Space
57
+ }
117
58
 
118
- export interface CreateWikiSpaceMemberRequest {
119
- /** 知识库协作者 ID 类型 */
120
- member_type: string
121
- /** 知识库协作者 ID */
122
- member_id: string
123
- /** 知识库协作者角色 */
124
- member_role: string
125
- }
59
+ export interface CreateRequest {
60
+ /** 知识空间名称 */
61
+ name?: string
62
+ /** 知识空间描述 */
63
+ description?: string
64
+ /** 表示知识空间的分享状态 */
65
+ open_sharing?: 'open' | 'closed'
66
+ }
126
67
 
127
- export interface CreateWikiSpaceMemberQuery {
128
- /** 添加权限后是否通知对方 */
129
- need_notification?: boolean
130
- }
68
+ export interface CreateResponse {
69
+ /** 知识空间信息 */
70
+ space?: Lark.Space
71
+ }
131
72
 
132
- export interface CreateWikiSpaceMemberResponse {
133
- /** 知识库协作者 */
134
- member?: Member
135
- }
73
+ export interface GetNodeQuery {
74
+ /** 文档的wiki token */
75
+ token: string
76
+ /** 文档类型 */
77
+ obj_type?: 'doc' | 'docx' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'slides' | 'wiki'
78
+ }
136
79
 
137
- export interface DeleteWikiSpaceMemberRequest {
138
- /** 知识库协作者 ID 类型 */
139
- member_type: string
140
- /** 知识库协作者角色 */
141
- member_role: string
142
- /** 知识库协作者类型 */
143
- type?: 'user' | 'chat' | 'department'
144
- }
80
+ export interface GetNodeResponse {
81
+ /** 节点信息 */
82
+ node?: Lark.Node
83
+ }
145
84
 
146
- export interface DeleteWikiSpaceMemberResponse {
147
- /** 成员信息 */
148
- member: Member
149
- }
85
+ export namespace Member {
86
+ export interface Methods {
87
+ /**
88
+ * 获取知识空间成员列表
89
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/list
90
+ */
91
+ list(space_id: string, query?: Pagination): Paginated<Lark.Member, 'members'>
92
+ /**
93
+ * 添加知识空间成员
94
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/create
95
+ */
96
+ create(space_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
97
+ /**
98
+ * 删除知识空间成员
99
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-member/delete
100
+ */
101
+ delete(space_id: string, member_id: string, body: DeleteRequest): Promise<DeleteResponse>
102
+ }
150
103
 
151
- export interface UpdateWikiSpaceSettingRequest {
152
- /** 谁可以创建空间的一级页面: "admin_and_member" = 管理员和成员 "admin" - 仅管理员 */
153
- create_setting?: string
154
- /** 可阅读用户可否创建副本/打印/导出/复制: "allow" - 允许 "not_allow" - 不允许 */
155
- security_setting?: string
156
- /** 可阅读用户可否评论: "allow" - 允许 "not_allow" - 不允许 */
157
- comment_setting?: string
158
- }
104
+ export interface CreateRequest {
105
+ /** 知识库协作者 ID 类型 */
106
+ member_type: string
107
+ /** 知识库协作者 ID */
108
+ member_id: string
109
+ /** 知识库协作者角色 */
110
+ member_role: string
111
+ }
159
112
 
160
- export interface UpdateWikiSpaceSettingResponse {
161
- /** 空间设置 */
162
- setting?: Setting
163
- }
113
+ export interface CreateQuery {
114
+ /** 添加权限后是否通知对方 */
115
+ need_notification?: boolean
116
+ }
164
117
 
165
- export interface CreateWikiSpaceNodeRequest {
166
- /** 文档类型,对于快捷方式,该字段是对应的实体的obj_type。 */
167
- obj_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'docx' | 'slides'
168
- /** 父节点 token。若当前节点为一级节点,父节点 token 为空。 */
169
- parent_node_token?: string
170
- /** 节点类型 */
171
- node_type: 'origin' | 'shortcut'
172
- /** 快捷方式对应的实体node_token,当节点为快捷方式时,该值不为空。 */
173
- origin_node_token?: string
174
- /** 文档标题 */
175
- title?: string
176
- }
118
+ export interface CreateResponse {
119
+ /** 知识库协作者 */
120
+ member?: Lark.Member
121
+ }
177
122
 
178
- export interface CreateWikiSpaceNodeResponse {
179
- /** 节点 */
180
- node?: Node
181
- }
123
+ export interface DeleteRequest {
124
+ /** 知识库协作者 ID 类型 */
125
+ member_type: string
126
+ /** 知识库协作者角色 */
127
+ member_role: string
128
+ /** 知识库协作者类型 */
129
+ type?: 'user' | 'chat' | 'department'
130
+ }
182
131
 
183
- export interface GetNodeWikiSpaceQuery {
184
- /** 文档的wiki token */
185
- token: string
186
- /** 文档类型 */
187
- obj_type?: 'doc' | 'docx' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'slides' | 'wiki'
188
- }
132
+ export interface DeleteResponse {
133
+ /** 成员信息 */
134
+ member: Lark.Member
135
+ }
136
+ }
189
137
 
190
- export interface GetNodeWikiSpaceResponse {
191
- /** 节点信息 */
192
- node?: Node
193
- }
138
+ export namespace Setting {
139
+ export interface Methods {
140
+ /**
141
+ * 更新知识空间设置
142
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-setting/update
143
+ */
144
+ update(space_id: string, body: UpdateRequest): Promise<UpdateResponse>
145
+ }
194
146
 
195
- export interface ListWikiSpaceNodeQuery extends Pagination {
196
- /** 父节点token */
197
- parent_node_token?: string
198
- }
147
+ export interface UpdateRequest {
148
+ /** 谁可以创建空间的一级页面: "admin_and_member" = 管理员和成员 "admin" - 仅管理员 */
149
+ create_setting?: string
150
+ /** 可阅读用户可否创建副本/打印/导出/复制: "allow" - 允许 "not_allow" - 不允许 */
151
+ security_setting?: string
152
+ /** 可阅读用户可否评论: "allow" - 允许 "not_allow" - 不允许 */
153
+ comment_setting?: string
154
+ }
199
155
 
200
- export interface MoveWikiSpaceNodeRequest {
201
- /** 移动到的父节点token */
202
- target_parent_token?: string
203
- /** 移动到的知识空间ID */
204
- target_space_id?: string
205
- }
156
+ export interface UpdateResponse {
157
+ /** 空间设置 */
158
+ setting?: Lark.Setting
159
+ }
160
+ }
206
161
 
207
- export interface MoveWikiSpaceNodeResponse {
208
- /** 移动后的节点信息 */
209
- node?: Node
210
- }
162
+ export namespace Node {
163
+ export interface Methods {
164
+ /**
165
+ * 创建知识空间节点
166
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/create
167
+ */
168
+ create(space_id: string, body: CreateRequest): Promise<CreateResponse>
169
+ /**
170
+ * 获取知识空间子节点列表
171
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/list
172
+ */
173
+ list(space_id: string, query?: ListQuery): Paginated<Lark.Node>
174
+ /**
175
+ * 移动知识空间节点
176
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move
177
+ */
178
+ move(space_id: string, node_token: string, body: MoveRequest): Promise<MoveResponse>
179
+ /**
180
+ * 更新知识空间节点标题
181
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/update_title
182
+ */
183
+ updateTitle(space_id: string, node_token: string, body: UpdateTitleRequest): Promise<void>
184
+ /**
185
+ * 创建知识空间节点副本
186
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/copy
187
+ */
188
+ copy(space_id: string, node_token: string, body: CopyRequest): Promise<CopyResponse>
189
+ /**
190
+ * 移动云空间文档至知识空间
191
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space-node/move_docs_to_wiki
192
+ */
193
+ moveDocsToWiki(space_id: string, body: MoveDocsToWikiRequest): Promise<MoveDocsToWikiResponse>
194
+ }
211
195
 
212
- export interface UpdateTitleWikiSpaceNodeRequest {
213
- /** 节点新标题 */
214
- title: string
215
- }
196
+ export interface CreateRequest {
197
+ /** 文档类型,对于快捷方式,该字段是对应的实体的obj_type。 */
198
+ obj_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'file' | 'docx' | 'slides'
199
+ /** 父节点 token。若当前节点为一级节点,父节点 token 为空。 */
200
+ parent_node_token?: string
201
+ /** 节点类型 */
202
+ node_type: 'origin' | 'shortcut'
203
+ /** 快捷方式对应的实体node_token,当节点为快捷方式时,该值不为空。 */
204
+ origin_node_token?: string
205
+ /** 文档标题 */
206
+ title?: string
207
+ }
216
208
 
217
- export interface CopyWikiSpaceNodeRequest {
218
- /** 目标父节点token */
219
- target_parent_token?: string
220
- /** 目标知识空间id */
221
- target_space_id?: string
222
- /** 复制后的新标题。如果填空,则新标题为空。如果不填,则使用原节点标题。 */
223
- title?: string
224
- }
209
+ export interface CreateResponse {
210
+ /** 节点 */
211
+ node?: Lark.Node
212
+ }
225
213
 
226
- export interface CopyWikiSpaceNodeResponse {
227
- /** copy后的节点 */
228
- node: Node
229
- }
214
+ export interface ListQuery extends Pagination {
215
+ /** 父节点token */
216
+ parent_node_token?: string
217
+ }
230
218
 
231
- export interface MoveDocsToWikiWikiSpaceNodeRequest {
232
- /** 节点的父亲token */
233
- parent_wiki_token?: string
234
- /** 文档类型 */
235
- obj_type: 'doc' | 'sheet' | 'bitable' | 'mindnote' | 'docx' | 'file' | 'slides'
236
- /** 文档token */
237
- obj_token: string
238
- /** 没有权限时,是否申请迁入文档 */
239
- apply?: boolean
240
- }
219
+ export interface MoveRequest {
220
+ /** 移动到的父节点token */
221
+ target_parent_token?: string
222
+ /** 移动到的知识空间ID */
223
+ target_space_id?: string
224
+ }
241
225
 
242
- export interface MoveDocsToWikiWikiSpaceNodeResponse {
243
- /** 移动后的知识库token */
244
- wiki_token?: string
245
- /** 任务id */
246
- task_id?: string
247
- /** 是否提交了文档迁入申请 */
248
- applied?: boolean
249
- }
226
+ export interface MoveResponse {
227
+ /** 移动后的节点信息 */
228
+ node?: Lark.Node
229
+ }
250
230
 
251
- export interface GetWikiTaskQuery {
252
- /** 任务类型 */
253
- task_type: 'move'
254
- }
231
+ export interface UpdateTitleRequest {
232
+ /** 节点新标题 */
233
+ title: string
234
+ }
255
235
 
256
- export interface GetWikiTaskResponse {
257
- /** 任务结果 */
258
- task: TaskResult
259
- }
236
+ export interface CopyRequest {
237
+ /** 目标父节点token */
238
+ target_parent_token?: string
239
+ /** 目标知识空间id */
240
+ target_space_id?: string
241
+ /** 复制后的新标题。如果填空,则新标题为空。如果不填,则使用原节点标题。 */
242
+ title?: string
243
+ }
244
+
245
+ export interface CopyResponse {
246
+ /** copy后的节点 */
247
+ node: Lark.Node
248
+ }
260
249
 
261
- export interface SearchWikiNodeRequest {
262
- /** 搜索关键词 */
263
- query: string
264
- /** 文档所属的知识空间ID,为空搜索所有 wiki */
265
- space_id?: string
266
- /** wiki token,不为空搜索该节点及其所有子节点,为空搜索所有 wiki(根据 space_id 选择 space) */
267
- node_id?: string
250
+ export interface MoveDocsToWikiRequest {
251
+ /** 节点的父亲token */
252
+ parent_wiki_token?: string
253
+ /** 文档类型 */
254
+ obj_type: 'doc' | 'sheet' | 'bitable' | 'mindnote' | 'docx' | 'file' | 'slides'
255
+ /** 文档token */
256
+ obj_token: string
257
+ /** 没有权限时,是否申请迁入文档 */
258
+ apply?: boolean
259
+ }
260
+
261
+ export interface MoveDocsToWikiResponse {
262
+ /** 移动后的知识库token */
263
+ wiki_token?: string
264
+ /** 任务id */
265
+ task_id?: string
266
+ /** 是否提交了文档迁入申请 */
267
+ applied?: boolean
268
+ }
269
+ }
270
+ }
271
+
272
+ export namespace Task {
273
+ export interface Methods {
274
+ /**
275
+ * 获取任务结果
276
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/task/get
277
+ */
278
+ get(task_id: string, query?: GetQuery): Promise<GetResponse>
279
+ }
280
+
281
+ export interface GetQuery {
282
+ /** 任务类型 */
283
+ task_type: 'move'
284
+ }
285
+
286
+ export interface GetResponse {
287
+ /** 任务结果 */
288
+ task: Lark.TaskResult
289
+ }
290
+ }
291
+
292
+ export namespace Node {
293
+ export interface Methods {
294
+ /**
295
+ * 搜索 Wiki
296
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uEzN0YjLxcDN24SM3QjN/search_wiki
297
+ */
298
+ search(body: SearchRequest, query?: Pagination): Paginated<Lark.Node>
299
+ }
300
+
301
+ export interface SearchRequest {
302
+ /** 搜索关键词 */
303
+ query: string
304
+ /** 文档所属的知识空间ID,为空搜索所有 wiki */
305
+ space_id?: string
306
+ /** wiki token,不为空搜索该节点及其所有子节点,为空搜索所有 wiki(根据 space_id 选择 space) */
307
+ node_id?: string
308
+ }
309
+ }
268
310
  }
269
311
 
270
312
  Internal.define({
271
313
  '/wiki/v2/spaces': {
272
- GET: { name: 'listWikiSpace', pagination: { argIndex: 0 } },
273
- POST: 'createWikiSpace',
314
+ GET: { name: 'wiki.space.list', pagination: { argIndex: 0 } },
315
+ POST: 'wiki.space.create',
274
316
  },
275
317
  '/wiki/v2/spaces/{space_id}': {
276
- GET: 'getWikiSpace',
318
+ GET: 'wiki.space.get',
277
319
  },
278
320
  '/wiki/v2/spaces/{space_id}/members': {
279
- GET: { name: 'listWikiSpaceMember', pagination: { argIndex: 1, itemsKey: 'members' } },
280
- POST: 'createWikiSpaceMember',
321
+ GET: { name: 'wiki.space.member.list', pagination: { argIndex: 1, itemsKey: 'members' } },
322
+ POST: 'wiki.space.member.create',
281
323
  },
282
324
  '/wiki/v2/spaces/{space_id}/members/{member_id}': {
283
- DELETE: 'deleteWikiSpaceMember',
325
+ DELETE: 'wiki.space.member.delete',
284
326
  },
285
327
  '/wiki/v2/spaces/{space_id}/setting': {
286
- PUT: 'updateWikiSpaceSetting',
328
+ PUT: 'wiki.space.setting.update',
287
329
  },
288
330
  '/wiki/v2/spaces/{space_id}/nodes': {
289
- POST: 'createWikiSpaceNode',
290
- GET: { name: 'listWikiSpaceNode', pagination: { argIndex: 1 } },
331
+ POST: 'wiki.space.node.create',
332
+ GET: { name: 'wiki.space.node.list', pagination: { argIndex: 1 } },
291
333
  },
292
334
  '/wiki/v2/spaces/get_node': {
293
- GET: 'getNodeWikiSpace',
335
+ GET: 'wiki.space.getNode',
294
336
  },
295
337
  '/wiki/v2/spaces/{space_id}/nodes/{node_token}/move': {
296
- POST: 'moveWikiSpaceNode',
338
+ POST: 'wiki.space.node.move',
297
339
  },
298
340
  '/wiki/v2/spaces/{space_id}/nodes/{node_token}/update_title': {
299
- POST: 'updateTitleWikiSpaceNode',
341
+ POST: 'wiki.space.node.updateTitle',
300
342
  },
301
343
  '/wiki/v2/spaces/{space_id}/nodes/{node_token}/copy': {
302
- POST: 'copyWikiSpaceNode',
344
+ POST: 'wiki.space.node.copy',
303
345
  },
304
346
  '/wiki/v2/spaces/{space_id}/nodes/move_docs_to_wiki': {
305
- POST: 'moveDocsToWikiWikiSpaceNode',
347
+ POST: 'wiki.space.node.moveDocsToWiki',
306
348
  },
307
349
  '/wiki/v2/tasks/{task_id}': {
308
- GET: 'getWikiTask',
350
+ GET: 'wiki.task.get',
309
351
  },
310
352
  '/wiki/v1/nodes/search': {
311
- POST: { name: 'searchWikiNode', pagination: { argIndex: 1 } },
353
+ POST: { name: 'wiki.node.search', pagination: { argIndex: 1 } },
312
354
  },
313
355
  })