@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.
- package/lib/content.d.ts +211 -93
- package/lib/index.cjs +2954 -2474
- package/lib/internal.d.ts +4 -4
- package/lib/message.d.ts +2 -3
- package/lib/types/acs.d.ts +212 -172
- package/lib/types/admin.d.ts +331 -291
- package/lib/types/aily.d.ts +331 -216
- package/lib/types/apaas.d.ts +646 -494
- package/lib/types/application.d.ts +559 -458
- package/lib/types/approval.d.ts +826 -791
- package/lib/types/attendance.d.ts +1094 -994
- package/lib/types/auth.d.ts +66 -61
- package/lib/types/authen.d.ts +221 -186
- package/lib/types/baike.d.ts +258 -233
- package/lib/types/base.d.ts +74 -0
- package/lib/types/bitable.d.ts +830 -770
- package/lib/types/board.d.ts +29 -14
- package/lib/types/calendar.d.ts +660 -605
- package/lib/types/cardkit.d.ts +149 -134
- package/lib/types/compensation.d.ts +84 -49
- package/lib/types/contact.d.ts +1279 -1204
- package/lib/types/corehr.d.ts +4982 -4526
- package/lib/types/directory.d.ts +447 -0
- package/lib/types/docs.d.ts +28 -18
- package/lib/types/document_ai.d.ts +347 -252
- package/lib/types/docx.d.ts +428 -383
- package/lib/types/drive.d.ts +1093 -1048
- package/lib/types/ehr.d.ts +66 -51
- package/lib/types/event.d.ts +16 -6
- package/lib/types/helpdesk.d.ts +816 -741
- package/lib/types/hire.d.ts +3955 -3589
- package/lib/types/human_authentication.d.ts +32 -22
- package/lib/types/im.d.ts +1420 -1295
- package/lib/types/index.d.ts +1422 -330
- package/lib/types/lingo.d.ts +279 -249
- package/lib/types/mail.d.ts +1032 -675
- package/lib/types/mdm.d.ts +105 -37
- package/lib/types/minutes.d.ts +73 -26
- package/lib/types/moments.d.ts +23 -13
- package/lib/types/okr.d.ts +266 -225
- package/lib/types/optical_char_recognition.d.ts +22 -12
- package/lib/types/passport.d.ts +58 -48
- package/lib/types/payroll.d.ts +210 -53
- package/lib/types/performance.d.ts +463 -414
- package/lib/types/personal_settings.d.ts +93 -82
- package/lib/types/report.d.ts +79 -58
- package/lib/types/search.d.ts +265 -235
- package/lib/types/security_and_compliance.d.ts +30 -19
- package/lib/types/sheets.d.ts +356 -321
- package/lib/types/speech_to_text.d.ts +44 -34
- package/lib/types/task.d.ts +998 -1087
- package/lib/types/tenant.d.ts +25 -15
- package/lib/types/translation.d.ts +42 -32
- package/lib/types/trust_party.d.ts +81 -0
- package/lib/types/vc.d.ts +1218 -1123
- package/lib/types/verification.d.ts +11 -6
- package/lib/types/wiki.d.ts +270 -235
- package/lib/types/workplace.d.ts +58 -38
- package/lib/utils.d.ts +2 -2
- package/package.json +4 -4
- package/src/bot.ts +15 -15
- package/src/content.ts +230 -107
- package/src/internal.ts +29 -12
- package/src/message.ts +82 -111
- package/src/types/acs.ts +234 -186
- package/src/types/admin.ts +353 -305
- package/src/types/aily.ts +375 -233
- package/src/types/apaas.ts +754 -568
- package/src/types/application.ts +633 -507
- package/src/types/approval.ts +914 -872
- package/src/types/attendance.ts +1226 -1104
- package/src/types/auth.ts +72 -66
- package/src/types/authen.ts +233 -191
- package/src/types/baike.ts +276 -246
- package/src/types/base.ts +93 -0
- package/src/types/bitable.ts +966 -894
- package/src/types/board.ts +34 -16
- package/src/types/calendar.ts +751 -685
- package/src/types/cardkit.ts +164 -146
- package/src/types/compensation.ts +97 -55
- package/src/types/contact.ts +1465 -1375
- package/src/types/corehr.ts +5664 -5077
- package/src/types/directory.ts +569 -0
- package/src/types/docs.ts +31 -19
- package/src/types/document_ai.ts +401 -287
- package/src/types/docx.ts +492 -438
- package/src/types/drive.ts +1266 -1213
- package/src/types/ehr.ts +71 -53
- package/src/types/event.ts +19 -7
- package/src/types/helpdesk.ts +930 -840
- package/src/types/hire.ts +4453 -4019
- package/src/types/human_authentication.ts +35 -23
- package/src/types/im.ts +1626 -1476
- package/src/types/index.ts +1532 -346
- package/src/types/lingo.ts +299 -263
- package/src/types/mail.ts +1231 -779
- package/src/types/mdm.ts +122 -39
- package/src/types/minutes.ts +88 -28
- package/src/types/moments.ts +26 -14
- package/src/types/okr.ts +286 -238
- package/src/types/optical_char_recognition.ts +25 -13
- package/src/types/passport.ts +62 -50
- package/src/types/payroll.ts +254 -57
- package/src/types/performance.ts +528 -467
- package/src/types/personal_settings.ts +101 -89
- package/src/types/report.ts +86 -62
- package/src/types/search.ts +285 -249
- package/src/types/security_and_compliance.ts +33 -21
- package/src/types/sheets.ts +421 -379
- package/src/types/speech_to_text.ts +48 -36
- package/src/types/task.ts +1152 -1260
- package/src/types/tenant.ts +29 -17
- package/src/types/translation.ts +46 -34
- package/src/types/trust_party.ts +110 -0
- package/src/types/vc.ts +1397 -1283
- package/src/types/verification.ts +13 -7
- package/src/types/wiki.ts +293 -251
- package/src/types/workplace.ts +65 -41
- package/src/utils.ts +3 -3
package/lib/types/task.d.ts
CHANGED
|
@@ -1,1159 +1,1070 @@
|
|
|
1
|
-
import
|
|
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
|
+
task: Task.Methods;
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
|
+
export declare namespace Task {
|
|
9
|
+
interface Methods {
|
|
10
|
+
subtask: Subtask.Methods;
|
|
11
|
+
tasklist: Tasklist.Methods;
|
|
12
|
+
comment: Comment.Methods;
|
|
13
|
+
attachment: Attachment.Methods;
|
|
14
|
+
section: Section.Methods;
|
|
15
|
+
customField: CustomField.Methods;
|
|
16
|
+
reminder: Reminder.Methods;
|
|
17
|
+
follower: Follower.Methods;
|
|
18
|
+
collaborator: Collaborator.Methods;
|
|
5
19
|
/**
|
|
6
20
|
* 创建任务
|
|
7
21
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/create
|
|
8
22
|
*/
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
* 获取任务详情
|
|
12
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/get
|
|
13
|
-
*/
|
|
14
|
-
getTaskV2(task_guid: string, query?: GetTaskV2Query): Promise<GetTaskV2Response>;
|
|
23
|
+
create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
15
24
|
/**
|
|
16
25
|
* 更新任务
|
|
17
26
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/patch
|
|
18
27
|
*/
|
|
19
|
-
|
|
28
|
+
patch(task_guid: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
|
|
29
|
+
/**
|
|
30
|
+
* 获取任务详情
|
|
31
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/get
|
|
32
|
+
*/
|
|
33
|
+
get(task_guid: string, query?: GetQuery): Promise<GetResponse>;
|
|
20
34
|
/**
|
|
21
35
|
* 删除任务
|
|
22
36
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/delete
|
|
23
37
|
*/
|
|
24
|
-
|
|
38
|
+
delete(task_guid: string): Promise<void>;
|
|
25
39
|
/**
|
|
26
40
|
* 添加任务成员
|
|
27
41
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_members
|
|
28
42
|
*/
|
|
29
|
-
|
|
43
|
+
addMembers(task_guid: string, body: AddMembersRequest, query?: AddMembersQuery): Promise<AddMembersResponse>;
|
|
30
44
|
/**
|
|
31
45
|
* 移除任务成员
|
|
32
46
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_members
|
|
33
47
|
*/
|
|
34
|
-
|
|
48
|
+
removeMembers(task_guid: string, body: RemoveMembersRequest, query?: RemoveMembersQuery): Promise<RemoveMembersResponse>;
|
|
35
49
|
/**
|
|
36
50
|
* 列取任务列表
|
|
37
51
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/list
|
|
38
52
|
*/
|
|
39
|
-
|
|
53
|
+
list(query?: ListQuery): Paginated<Lark.Task>;
|
|
40
54
|
/**
|
|
41
55
|
* 列取任务所在清单
|
|
42
56
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/tasklists
|
|
43
57
|
*/
|
|
44
|
-
|
|
58
|
+
tasklists(task_guid: string): Promise<TasklistsResponse>;
|
|
45
59
|
/**
|
|
46
60
|
* 任务加入清单
|
|
47
61
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_tasklist
|
|
48
62
|
*/
|
|
49
|
-
|
|
63
|
+
addTasklist(task_guid: string, body: AddTasklistRequest, query?: AddTasklistQuery): Promise<AddTasklistResponse>;
|
|
50
64
|
/**
|
|
51
65
|
* 任务移出清单
|
|
52
66
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_tasklist
|
|
53
67
|
*/
|
|
54
|
-
|
|
68
|
+
removeTasklist(task_guid: string, body: RemoveTasklistRequest, query?: RemoveTasklistQuery): Promise<RemoveTasklistResponse>;
|
|
55
69
|
/**
|
|
56
70
|
* 添加任务提醒
|
|
57
71
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_reminders
|
|
58
72
|
*/
|
|
59
|
-
|
|
73
|
+
addReminders(task_guid: string, body: AddRemindersRequest, query?: AddRemindersQuery): Promise<AddRemindersResponse>;
|
|
60
74
|
/**
|
|
61
75
|
* 移除任务提醒
|
|
62
76
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_reminders
|
|
63
77
|
*/
|
|
64
|
-
|
|
78
|
+
removeReminders(task_guid: string, body: RemoveRemindersRequest, query?: RemoveRemindersQuery): Promise<RemoveRemindersResponse>;
|
|
65
79
|
/**
|
|
66
80
|
* 添加依赖
|
|
67
81
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/add_dependencies
|
|
68
82
|
*/
|
|
69
|
-
|
|
83
|
+
addDependencies(task_guid: string, body: AddDependenciesRequest): Promise<AddDependenciesResponse>;
|
|
70
84
|
/**
|
|
71
85
|
* 移除依赖
|
|
72
86
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/remove_dependencies
|
|
73
87
|
*/
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
* 创建子任务
|
|
77
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/create
|
|
78
|
-
*/
|
|
79
|
-
createTaskV2TaskSubtask(task_guid: string, body: CreateTaskV2TaskSubtaskRequest, query?: CreateTaskV2TaskSubtaskQuery): Promise<CreateTaskV2TaskSubtaskResponse>;
|
|
80
|
-
/**
|
|
81
|
-
* 获取任务的子任务列表
|
|
82
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/list
|
|
83
|
-
*/
|
|
84
|
-
listTaskV2TaskSubtask(task_guid: string, query?: ListTaskV2TaskSubtaskQuery): Paginated<Task>;
|
|
85
|
-
/**
|
|
86
|
-
* 创建清单
|
|
87
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/create
|
|
88
|
-
*/
|
|
89
|
-
createTaskV2Tasklist(body: CreateTaskV2TasklistRequest, query?: CreateTaskV2TasklistQuery): Promise<CreateTaskV2TasklistResponse>;
|
|
90
|
-
/**
|
|
91
|
-
* 获取清单详情
|
|
92
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/get
|
|
93
|
-
*/
|
|
94
|
-
getTaskV2Tasklist(tasklist_guid: string, query?: GetTaskV2TasklistQuery): Promise<GetTaskV2TasklistResponse>;
|
|
95
|
-
/**
|
|
96
|
-
* 更新清单
|
|
97
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/patch
|
|
98
|
-
*/
|
|
99
|
-
patchTaskV2Tasklist(tasklist_guid: string, body: PatchTaskV2TasklistRequest, query?: PatchTaskV2TasklistQuery): Promise<PatchTaskV2TasklistResponse>;
|
|
100
|
-
/**
|
|
101
|
-
* 删除清单
|
|
102
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/delete
|
|
103
|
-
*/
|
|
104
|
-
deleteTaskV2Tasklist(tasklist_guid: string): Promise<void>;
|
|
105
|
-
/**
|
|
106
|
-
* 添加清单成员
|
|
107
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/add_members
|
|
108
|
-
*/
|
|
109
|
-
addMembersTaskV2Tasklist(tasklist_guid: string, body: AddMembersTaskV2TasklistRequest, query?: AddMembersTaskV2TasklistQuery): Promise<AddMembersTaskV2TasklistResponse>;
|
|
110
|
-
/**
|
|
111
|
-
* 移除清单成员
|
|
112
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/remove_members
|
|
113
|
-
*/
|
|
114
|
-
removeMembersTaskV2Tasklist(tasklist_guid: string, body: RemoveMembersTaskV2TasklistRequest, query?: RemoveMembersTaskV2TasklistQuery): Promise<RemoveMembersTaskV2TasklistResponse>;
|
|
115
|
-
/**
|
|
116
|
-
* 获取清单任务列表
|
|
117
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/tasks
|
|
118
|
-
*/
|
|
119
|
-
tasksTaskV2Tasklist(tasklist_guid: string, query?: TasksTaskV2TasklistQuery): Paginated<TaskSummary>;
|
|
120
|
-
/**
|
|
121
|
-
* 获取清单列表
|
|
122
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/list
|
|
123
|
-
*/
|
|
124
|
-
listTaskV2Tasklist(query?: ListTaskV2TasklistQuery): Paginated<Tasklist>;
|
|
125
|
-
/**
|
|
126
|
-
* 创建动态订阅
|
|
127
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/create
|
|
128
|
-
*/
|
|
129
|
-
createTaskV2TasklistActivitySubscription(tasklist_guid: string, body: CreateTaskV2TasklistActivitySubscriptionRequest, query?: CreateTaskV2TasklistActivitySubscriptionQuery): Promise<CreateTaskV2TasklistActivitySubscriptionResponse>;
|
|
130
|
-
/**
|
|
131
|
-
* 获取动态订阅
|
|
132
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/get
|
|
133
|
-
*/
|
|
134
|
-
getTaskV2TasklistActivitySubscription(tasklist_guid: string, activity_subscription_guid: string, query?: GetTaskV2TasklistActivitySubscriptionQuery): Promise<GetTaskV2TasklistActivitySubscriptionResponse>;
|
|
135
|
-
/**
|
|
136
|
-
* 列取动态订阅
|
|
137
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/list
|
|
138
|
-
*/
|
|
139
|
-
listTaskV2TasklistActivitySubscription(tasklist_guid: string, query?: ListTaskV2TasklistActivitySubscriptionQuery): Promise<ListTaskV2TasklistActivitySubscriptionResponse>;
|
|
140
|
-
/**
|
|
141
|
-
* 更新动态订阅
|
|
142
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/patch
|
|
143
|
-
*/
|
|
144
|
-
patchTaskV2TasklistActivitySubscription(tasklist_guid: string, activity_subscription_guid: string, body: PatchTaskV2TasklistActivitySubscriptionRequest, query?: PatchTaskV2TasklistActivitySubscriptionQuery): Promise<PatchTaskV2TasklistActivitySubscriptionResponse>;
|
|
145
|
-
/**
|
|
146
|
-
* 删除动态订阅
|
|
147
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/delete
|
|
148
|
-
*/
|
|
149
|
-
deleteTaskV2TasklistActivitySubscription(tasklist_guid: string, activity_subscription_guid: string): Promise<void>;
|
|
150
|
-
/**
|
|
151
|
-
* 创建评论
|
|
152
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/create
|
|
153
|
-
*/
|
|
154
|
-
createTaskV2Comment(body: CreateTaskV2CommentRequest, query?: CreateTaskV2CommentQuery): Promise<CreateTaskV2CommentResponse>;
|
|
155
|
-
/**
|
|
156
|
-
* 获取评论详情
|
|
157
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/get
|
|
158
|
-
*/
|
|
159
|
-
getTaskV2Comment(comment_id: string, query?: GetTaskV2CommentQuery): Promise<GetTaskV2CommentResponse>;
|
|
160
|
-
/**
|
|
161
|
-
* 更新评论
|
|
162
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/patch
|
|
163
|
-
*/
|
|
164
|
-
patchTaskV2Comment(comment_id: string, body: PatchTaskV2CommentRequest, query?: PatchTaskV2CommentQuery): Promise<PatchTaskV2CommentResponse>;
|
|
165
|
-
/**
|
|
166
|
-
* 删除评论
|
|
167
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/delete
|
|
168
|
-
*/
|
|
169
|
-
deleteTaskV2Comment(comment_id: string): Promise<void>;
|
|
170
|
-
/**
|
|
171
|
-
* 获取评论列表
|
|
172
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/list
|
|
173
|
-
*/
|
|
174
|
-
listTaskV2Comment(query?: ListTaskV2CommentQuery): Paginated<Comment>;
|
|
175
|
-
/**
|
|
176
|
-
* 上传附件
|
|
177
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/upload
|
|
178
|
-
*/
|
|
179
|
-
uploadTaskV2Attachment(form: UploadTaskV2AttachmentForm, query?: UploadTaskV2AttachmentQuery): Promise<UploadTaskV2AttachmentResponse>;
|
|
180
|
-
/**
|
|
181
|
-
* 列取附件
|
|
182
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/list
|
|
183
|
-
*/
|
|
184
|
-
listTaskV2Attachment(query?: ListTaskV2AttachmentQuery): Paginated<Attachment>;
|
|
185
|
-
/**
|
|
186
|
-
* 获取附件
|
|
187
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/get
|
|
188
|
-
*/
|
|
189
|
-
getTaskV2Attachment(attachment_guid: string, query?: GetTaskV2AttachmentQuery): Promise<GetTaskV2AttachmentResponse>;
|
|
190
|
-
/**
|
|
191
|
-
* 删除附件
|
|
192
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/delete
|
|
193
|
-
*/
|
|
194
|
-
deleteTaskV2Attachment(attachment_guid: string): Promise<void>;
|
|
195
|
-
/**
|
|
196
|
-
* 创建自定义分组
|
|
197
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/create
|
|
198
|
-
*/
|
|
199
|
-
createTaskV2Section(body: CreateTaskV2SectionRequest, query?: CreateTaskV2SectionQuery): Promise<CreateTaskV2SectionResponse>;
|
|
200
|
-
/**
|
|
201
|
-
* 获取自定义分组详情
|
|
202
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/get
|
|
203
|
-
*/
|
|
204
|
-
getTaskV2Section(section_guid: string, query?: GetTaskV2SectionQuery): Promise<GetTaskV2SectionResponse>;
|
|
205
|
-
/**
|
|
206
|
-
* 更新自定义分组
|
|
207
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/patch
|
|
208
|
-
*/
|
|
209
|
-
patchTaskV2Section(section_guid: string, body: PatchTaskV2SectionRequest, query?: PatchTaskV2SectionQuery): Promise<PatchTaskV2SectionResponse>;
|
|
210
|
-
/**
|
|
211
|
-
* 删除自定义分组
|
|
212
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/delete
|
|
213
|
-
*/
|
|
214
|
-
deleteTaskV2Section(section_guid: string): Promise<void>;
|
|
215
|
-
/**
|
|
216
|
-
* 获取自定义分组列表
|
|
217
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/list
|
|
218
|
-
*/
|
|
219
|
-
listTaskV2Section(query?: ListTaskV2SectionQuery): Paginated<SectionSummary>;
|
|
220
|
-
/**
|
|
221
|
-
* 获取自定义分组任务列表
|
|
222
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/tasks
|
|
223
|
-
*/
|
|
224
|
-
tasksTaskV2Section(section_guid: string, query?: TasksTaskV2SectionQuery): Paginated<TaskSummary>;
|
|
225
|
-
/**
|
|
226
|
-
* 创建自定义字段
|
|
227
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/create
|
|
228
|
-
*/
|
|
229
|
-
createTaskV2CustomField(body: CreateTaskV2CustomFieldRequest, query?: CreateTaskV2CustomFieldQuery): Promise<CreateTaskV2CustomFieldResponse>;
|
|
230
|
-
/**
|
|
231
|
-
* 获取自定义字段
|
|
232
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/get
|
|
233
|
-
*/
|
|
234
|
-
getTaskV2CustomField(custom_field_guid: string, query?: GetTaskV2CustomFieldQuery): Promise<GetTaskV2CustomFieldResponse>;
|
|
235
|
-
/**
|
|
236
|
-
* 更新自定义字段
|
|
237
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/patch
|
|
238
|
-
*/
|
|
239
|
-
patchTaskV2CustomField(custom_field_guid: string, body: PatchTaskV2CustomFieldRequest, query?: PatchTaskV2CustomFieldQuery): Promise<PatchTaskV2CustomFieldResponse>;
|
|
240
|
-
/**
|
|
241
|
-
* 列取自定义字段
|
|
242
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/list
|
|
243
|
-
*/
|
|
244
|
-
listTaskV2CustomField(query?: ListTaskV2CustomFieldQuery): Paginated<CustomField>;
|
|
245
|
-
/**
|
|
246
|
-
* 将自定义字段加入资源
|
|
247
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/add
|
|
248
|
-
*/
|
|
249
|
-
addTaskV2CustomField(custom_field_guid: string, body: AddTaskV2CustomFieldRequest): Promise<void>;
|
|
250
|
-
/**
|
|
251
|
-
* 将自定义字段移出资源
|
|
252
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/remove
|
|
253
|
-
*/
|
|
254
|
-
removeTaskV2CustomField(custom_field_guid: string, body: RemoveTaskV2CustomFieldRequest): Promise<void>;
|
|
255
|
-
/**
|
|
256
|
-
* 创建自定义任务选项
|
|
257
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/create
|
|
258
|
-
*/
|
|
259
|
-
createTaskV2CustomFieldOption(custom_field_guid: string, body: CreateTaskV2CustomFieldOptionRequest): Promise<CreateTaskV2CustomFieldOptionResponse>;
|
|
260
|
-
/**
|
|
261
|
-
* 更新自定义字段选项
|
|
262
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/patch
|
|
263
|
-
*/
|
|
264
|
-
patchTaskV2CustomFieldOption(custom_field_guid: string, option_guid: string, body: PatchTaskV2CustomFieldOptionRequest): Promise<PatchTaskV2CustomFieldOptionResponse>;
|
|
265
|
-
/**
|
|
266
|
-
* 创建任务
|
|
267
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/create
|
|
268
|
-
*/
|
|
269
|
-
createTaskV1(body: CreateTaskV1Request, query?: CreateTaskV1Query): Promise<CreateTaskV1Response>;
|
|
270
|
-
/**
|
|
271
|
-
* 删除任务
|
|
272
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/delete
|
|
273
|
-
*/
|
|
274
|
-
deleteTaskV1(task_id: string): Promise<void>;
|
|
275
|
-
/**
|
|
276
|
-
* 更新任务
|
|
277
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/patch
|
|
278
|
-
*/
|
|
279
|
-
patchTaskV1(task_id: string, body: PatchTaskV1Request, query?: PatchTaskV1Query): Promise<PatchTaskV1Response>;
|
|
88
|
+
removeDependencies(task_guid: string, body: RemoveDependenciesRequest): Promise<RemoveDependenciesResponse>;
|
|
280
89
|
/**
|
|
281
90
|
* 完成任务
|
|
282
91
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/complete
|
|
283
92
|
*/
|
|
284
|
-
|
|
93
|
+
complete(task_id: string): Promise<void>;
|
|
285
94
|
/**
|
|
286
95
|
* 取消完成任务
|
|
287
96
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/uncomplete
|
|
288
97
|
*/
|
|
289
|
-
|
|
290
|
-
/**
|
|
291
|
-
* 查询指定任务
|
|
292
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/get
|
|
293
|
-
*/
|
|
294
|
-
getTaskV1(task_id: string, query?: GetTaskV1Query): Promise<GetTaskV1Response>;
|
|
295
|
-
/**
|
|
296
|
-
* 查询所有任务
|
|
297
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/list
|
|
298
|
-
*/
|
|
299
|
-
listTaskV1(query?: ListTaskV1Query): Paginated<Task>;
|
|
300
|
-
/**
|
|
301
|
-
* 新增提醒时间
|
|
302
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/create
|
|
303
|
-
*/
|
|
304
|
-
createTaskV1TaskReminder(task_id: string, body: CreateTaskV1TaskReminderRequest): Promise<CreateTaskV1TaskReminderResponse>;
|
|
305
|
-
/**
|
|
306
|
-
* 删除提醒时间
|
|
307
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/delete
|
|
308
|
-
*/
|
|
309
|
-
deleteTaskV1TaskReminder(task_id: string, reminder_id: string): Promise<void>;
|
|
310
|
-
/**
|
|
311
|
-
* 查询提醒时间列表
|
|
312
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/list
|
|
313
|
-
*/
|
|
314
|
-
listTaskV1TaskReminder(task_id: string, query?: Pagination): Paginated<Reminder>;
|
|
315
|
-
/**
|
|
316
|
-
* 创建评论
|
|
317
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/create
|
|
318
|
-
*/
|
|
319
|
-
createTaskV1TaskComment(task_id: string, body: CreateTaskV1TaskCommentRequest, query?: CreateTaskV1TaskCommentQuery): Promise<CreateTaskV1TaskCommentResponse>;
|
|
320
|
-
/**
|
|
321
|
-
* 删除评论
|
|
322
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/delete
|
|
323
|
-
*/
|
|
324
|
-
deleteTaskV1TaskComment(task_id: string, comment_id: string): Promise<void>;
|
|
325
|
-
/**
|
|
326
|
-
* 更新评论
|
|
327
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/update
|
|
328
|
-
*/
|
|
329
|
-
updateTaskV1TaskComment(task_id: string, comment_id: string, body: UpdateTaskV1TaskCommentRequest, query?: UpdateTaskV1TaskCommentQuery): Promise<UpdateTaskV1TaskCommentResponse>;
|
|
330
|
-
/**
|
|
331
|
-
* 获取评论详情
|
|
332
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/get
|
|
333
|
-
*/
|
|
334
|
-
getTaskV1TaskComment(task_id: string, comment_id: string, query?: GetTaskV1TaskCommentQuery): Promise<GetTaskV1TaskCommentResponse>;
|
|
335
|
-
/**
|
|
336
|
-
* 获取评论列表
|
|
337
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/list
|
|
338
|
-
*/
|
|
339
|
-
listTaskV1TaskComment(task_id: string, query?: ListTaskV1TaskCommentQuery): Paginated<Comment>;
|
|
340
|
-
/**
|
|
341
|
-
* 新增关注人
|
|
342
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/create
|
|
343
|
-
*/
|
|
344
|
-
createTaskV1TaskFollower(task_id: string, body: CreateTaskV1TaskFollowerRequest, query?: CreateTaskV1TaskFollowerQuery): Promise<CreateTaskV1TaskFollowerResponse>;
|
|
345
|
-
/**
|
|
346
|
-
* 删除指定关注人
|
|
347
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/delete
|
|
348
|
-
*/
|
|
349
|
-
deleteTaskV1TaskFollower(task_id: string, follower_id: string, query?: DeleteTaskV1TaskFollowerQuery): Promise<void>;
|
|
98
|
+
uncomplete(task_id: string): Promise<void>;
|
|
350
99
|
/**
|
|
351
100
|
* 批量删除关注人
|
|
352
101
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/batch_delete_follower
|
|
353
102
|
*/
|
|
354
|
-
|
|
355
|
-
/**
|
|
356
|
-
* 获取关注人列表
|
|
357
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/list
|
|
358
|
-
*/
|
|
359
|
-
listTaskV1TaskFollower(task_id: string, query?: ListTaskV1TaskFollowerQuery): Paginated<Follower>;
|
|
360
|
-
/**
|
|
361
|
-
* 新增执行者
|
|
362
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/create
|
|
363
|
-
*/
|
|
364
|
-
createTaskV1TaskCollaborator(task_id: string, body: CreateTaskV1TaskCollaboratorRequest, query?: CreateTaskV1TaskCollaboratorQuery): Promise<CreateTaskV1TaskCollaboratorResponse>;
|
|
365
|
-
/**
|
|
366
|
-
* 删除指定执行者
|
|
367
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/delete
|
|
368
|
-
*/
|
|
369
|
-
deleteTaskV1TaskCollaborator(task_id: string, collaborator_id: string, query?: DeleteTaskV1TaskCollaboratorQuery): Promise<void>;
|
|
103
|
+
batchDeleteFollower(task_id: string, body: BatchDeleteFollowerRequest, query?: BatchDeleteFollowerQuery): Promise<BatchDeleteFollowerResponse>;
|
|
370
104
|
/**
|
|
371
105
|
* 批量删除执行者
|
|
372
106
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task/batch_delete_collaborator
|
|
373
107
|
*/
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
108
|
+
batchDeleteCollaborator(task_id: string, body: BatchDeleteCollaboratorRequest, query?: BatchDeleteCollaboratorQuery): Promise<BatchDeleteCollaboratorResponse>;
|
|
109
|
+
}
|
|
110
|
+
interface CreateRequest {
|
|
111
|
+
/** 任务标题 */
|
|
112
|
+
summary: string;
|
|
113
|
+
/** 任务描述 */
|
|
114
|
+
description?: string;
|
|
115
|
+
/** 任务截止时间戳(ms),截止时间戳和截止日期选择一个填写。 */
|
|
116
|
+
due?: Lark.Due;
|
|
117
|
+
/** 任务关联的第三方平台来源信息 */
|
|
118
|
+
origin?: Lark.Origin;
|
|
119
|
+
/** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */
|
|
120
|
+
extra?: string;
|
|
121
|
+
/** 任务的完成时刻时间戳(ms) */
|
|
122
|
+
completed_at?: string;
|
|
123
|
+
/** 任务成员列表 */
|
|
124
|
+
members?: Lark.Member[];
|
|
125
|
+
/** 如果设置,则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */
|
|
126
|
+
repeat_rule?: string;
|
|
127
|
+
/** 如果设置,则将任务设计为“自定义完成”。用户在任务中心点击“完成”时,不会直接完成任务,而是跳转到第三方配置好的地址或者现实自定义提示。 */
|
|
128
|
+
custom_complete?: Lark.CustomComplete;
|
|
129
|
+
/** 任务所在清单的信息 */
|
|
130
|
+
tasklists?: Lark.TaskInTasklistInfo[];
|
|
131
|
+
/** 幂等token,如果填写则触发幂等行为。 */
|
|
132
|
+
client_token?: string;
|
|
133
|
+
/** 任务的开始时间(ms) */
|
|
134
|
+
start?: Lark.Start;
|
|
135
|
+
/** 任务提醒 */
|
|
136
|
+
reminders?: Lark.Reminder[];
|
|
137
|
+
/** 任务完成模式, 1 - 会签任务; 2 - 或签任务 */
|
|
138
|
+
mode?: number;
|
|
139
|
+
/** 是否是里程碑任务 */
|
|
140
|
+
is_milestone?: boolean;
|
|
141
|
+
/** 自定义字段值 */
|
|
142
|
+
custom_fields?: Lark.InputCustomFieldValue[];
|
|
143
|
+
/** 任务的新版云文档来源 */
|
|
144
|
+
docx_source?: Lark.DocxSource;
|
|
145
|
+
}
|
|
146
|
+
interface CreateQuery {
|
|
147
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
148
|
+
user_id_type?: string;
|
|
149
|
+
}
|
|
150
|
+
interface CreateResponse {
|
|
151
|
+
/** 产生的任务 */
|
|
152
|
+
task?: Lark.Task;
|
|
153
|
+
}
|
|
154
|
+
interface PatchRequest {
|
|
155
|
+
/** 要更新的任务数据,只需要写明要更新的字段 */
|
|
156
|
+
task?: Lark.InputTask;
|
|
157
|
+
/** 要更新的字段名称。支持summary, description, due, start, completed_at, extra, repeat_rule, custom_complete, mode, is_milestone, custom_fields。 */
|
|
158
|
+
update_fields: string[];
|
|
159
|
+
}
|
|
160
|
+
interface PatchQuery {
|
|
161
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
162
|
+
user_id_type?: string;
|
|
163
|
+
}
|
|
164
|
+
interface PatchResponse {
|
|
165
|
+
/** 更新后的任务 */
|
|
166
|
+
task?: Lark.Task;
|
|
167
|
+
}
|
|
168
|
+
interface GetQuery {
|
|
169
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
170
|
+
user_id_type?: string;
|
|
171
|
+
}
|
|
172
|
+
interface GetResponse {
|
|
173
|
+
/** 获得的任务实体 */
|
|
174
|
+
task?: Lark.Task;
|
|
175
|
+
}
|
|
176
|
+
interface AddMembersRequest {
|
|
177
|
+
/** 要添加的members列表 */
|
|
178
|
+
members: Lark.Member[];
|
|
179
|
+
/** 幂等token,如果提供则实现幂等行为 */
|
|
180
|
+
client_token?: string;
|
|
181
|
+
}
|
|
182
|
+
interface AddMembersQuery {
|
|
183
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
184
|
+
user_id_type?: string;
|
|
185
|
+
}
|
|
186
|
+
interface AddMembersResponse {
|
|
187
|
+
/** 更新完成后的任务实体数据 */
|
|
188
|
+
task?: Lark.Task;
|
|
189
|
+
}
|
|
190
|
+
interface RemoveMembersRequest {
|
|
191
|
+
/** 要移除的member列表 */
|
|
192
|
+
members: Lark.Member[];
|
|
193
|
+
}
|
|
194
|
+
interface RemoveMembersQuery {
|
|
195
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
196
|
+
user_id_type?: string;
|
|
197
|
+
}
|
|
198
|
+
interface RemoveMembersResponse {
|
|
199
|
+
/** 移除成员后的任务数据 */
|
|
200
|
+
task?: Lark.Task;
|
|
201
|
+
}
|
|
202
|
+
interface ListQuery extends Pagination {
|
|
203
|
+
/** 是否按任务完成进行过滤。不填写表示不过滤。 */
|
|
204
|
+
completed?: boolean;
|
|
205
|
+
/** 查询任务的范围 */
|
|
206
|
+
type?: string;
|
|
207
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
208
|
+
user_id_type?: string;
|
|
209
|
+
}
|
|
210
|
+
interface TasklistsResponse {
|
|
211
|
+
/** 任务所在清单的摘要信息 */
|
|
212
|
+
tasklists?: Lark.TaskInTasklistInfo[];
|
|
213
|
+
}
|
|
214
|
+
interface AddTasklistRequest {
|
|
215
|
+
/** 要添加到的清单的全局唯一ID */
|
|
216
|
+
tasklist_guid: string;
|
|
217
|
+
/** 要添加到清单的自定义分组全局唯一ID,如不填写表示添加到默认分组 */
|
|
218
|
+
section_guid?: string;
|
|
219
|
+
}
|
|
220
|
+
interface AddTasklistQuery {
|
|
221
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
222
|
+
user_id_type?: string;
|
|
223
|
+
}
|
|
224
|
+
interface AddTasklistResponse {
|
|
225
|
+
/** 添加后的任务详情 */
|
|
226
|
+
task?: Lark.Task;
|
|
227
|
+
}
|
|
228
|
+
interface RemoveTasklistRequest {
|
|
229
|
+
/** 要移除的清单的全局唯一ID */
|
|
230
|
+
tasklist_guid: string;
|
|
231
|
+
}
|
|
232
|
+
interface RemoveTasklistQuery {
|
|
233
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
234
|
+
user_id_type?: string;
|
|
235
|
+
}
|
|
236
|
+
interface RemoveTasklistResponse {
|
|
237
|
+
/** 添加后的任务详情 */
|
|
238
|
+
task?: Lark.Task;
|
|
239
|
+
}
|
|
240
|
+
interface AddRemindersRequest {
|
|
241
|
+
/** 要添加的reminder的列表 */
|
|
242
|
+
reminders: Lark.Reminder[];
|
|
243
|
+
}
|
|
244
|
+
interface AddRemindersQuery {
|
|
245
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
246
|
+
user_id_type?: string;
|
|
247
|
+
}
|
|
248
|
+
interface AddRemindersResponse {
|
|
249
|
+
/** 更新完成后的任务实体 */
|
|
250
|
+
task?: Lark.Task;
|
|
251
|
+
}
|
|
252
|
+
interface RemoveRemindersRequest {
|
|
253
|
+
/** 要移除的reminder的id列表 */
|
|
254
|
+
reminder_ids: string[];
|
|
255
|
+
}
|
|
256
|
+
interface RemoveRemindersQuery {
|
|
257
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
258
|
+
user_id_type?: string;
|
|
259
|
+
}
|
|
260
|
+
interface RemoveRemindersResponse {
|
|
261
|
+
/** 移除提醒后的任务详情 */
|
|
262
|
+
task?: Lark.Task;
|
|
263
|
+
}
|
|
264
|
+
interface AddDependenciesRequest {
|
|
265
|
+
/** 要添加的依赖 */
|
|
266
|
+
dependencies?: Lark.TaskDependency[];
|
|
267
|
+
}
|
|
268
|
+
interface AddDependenciesResponse {
|
|
269
|
+
/** 被添加后任务的所有依赖 */
|
|
270
|
+
dependencies?: Lark.TaskDependency[];
|
|
271
|
+
}
|
|
272
|
+
interface RemoveDependenciesRequest {
|
|
273
|
+
/** 要移除的依赖 */
|
|
274
|
+
dependencies: Lark.TaskDependency[];
|
|
275
|
+
}
|
|
276
|
+
interface RemoveDependenciesResponse {
|
|
277
|
+
/** 移除之后的任务GUID */
|
|
278
|
+
dependencies?: Lark.TaskDependency[];
|
|
279
|
+
}
|
|
280
|
+
interface BatchDeleteFollowerRequest {
|
|
281
|
+
/** 要添加为关注人的user_id */
|
|
282
|
+
id_list?: string[];
|
|
283
|
+
}
|
|
284
|
+
interface BatchDeleteFollowerQuery {
|
|
285
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
286
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
287
|
+
}
|
|
288
|
+
interface BatchDeleteFollowerResponse {
|
|
289
|
+
/** 实际删除的关注人用户ID列表 */
|
|
290
|
+
followers?: string[];
|
|
291
|
+
}
|
|
292
|
+
interface BatchDeleteCollaboratorRequest {
|
|
293
|
+
/** 协作人的用户ID列表 */
|
|
294
|
+
id_list?: string[];
|
|
295
|
+
}
|
|
296
|
+
interface BatchDeleteCollaboratorQuery {
|
|
297
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
298
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
299
|
+
}
|
|
300
|
+
interface BatchDeleteCollaboratorResponse {
|
|
301
|
+
/** 实际删除的执行人用户ID列表 */
|
|
302
|
+
collaborators?: string[];
|
|
303
|
+
}
|
|
304
|
+
namespace Subtask {
|
|
305
|
+
interface Methods {
|
|
306
|
+
/**
|
|
307
|
+
* 创建子任务
|
|
308
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/create
|
|
309
|
+
*/
|
|
310
|
+
create(task_guid: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
311
|
+
/**
|
|
312
|
+
* 获取任务的子任务列表
|
|
313
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task-subtask/list
|
|
314
|
+
*/
|
|
315
|
+
list(task_guid: string, query?: ListQuery): Paginated<Lark.Task>;
|
|
316
|
+
}
|
|
317
|
+
interface CreateRequest {
|
|
318
|
+
/** 任务标题 */
|
|
319
|
+
summary: string;
|
|
320
|
+
/** 任务描述 */
|
|
321
|
+
description?: string;
|
|
322
|
+
/** 任务截止时间戳(ms),截止时间戳和截止日期选择一个填写。 */
|
|
323
|
+
due?: Lark.Due;
|
|
324
|
+
/** 任务关联的第三方平台来源信息 */
|
|
325
|
+
origin?: Lark.Origin;
|
|
326
|
+
/** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */
|
|
327
|
+
extra?: string;
|
|
328
|
+
/** 任务的完成时刻时间戳(ms) */
|
|
329
|
+
completed_at?: string;
|
|
330
|
+
/** 任务成员列表 */
|
|
331
|
+
members?: Lark.Member[];
|
|
332
|
+
/** 如果设置,则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */
|
|
333
|
+
repeat_rule?: string;
|
|
334
|
+
/** 如果设置,则将任务设计为“自定义完成”。用户在任务中心点击“完成”时,不会直接完成任务,而是跳转到第三方配置好的地址或者现实自定义提示。 */
|
|
335
|
+
custom_complete?: Lark.CustomComplete;
|
|
336
|
+
/** 任务所在清单的信息 */
|
|
337
|
+
tasklists?: Lark.TaskInTasklistInfo[];
|
|
338
|
+
/** 幂等token,如果填写则触发幂等行为。 */
|
|
339
|
+
client_token?: string;
|
|
340
|
+
/** 任务的开始时间(ms) */
|
|
341
|
+
start?: Lark.Start;
|
|
342
|
+
/** 任务提醒 */
|
|
343
|
+
reminders?: Lark.Reminder[];
|
|
344
|
+
/** 任务完成模式, 1 - 会签任务; 2 - 或签任务 */
|
|
345
|
+
mode?: number;
|
|
346
|
+
/** 是否是里程碑任务 */
|
|
347
|
+
is_milestone?: boolean;
|
|
348
|
+
/** 自定义字段值 */
|
|
349
|
+
custom_fields?: Lark.InputCustomFieldValue[];
|
|
350
|
+
/** 任务的新版云文档来源 */
|
|
351
|
+
docx_source?: Lark.DocxSource;
|
|
352
|
+
}
|
|
353
|
+
interface CreateQuery {
|
|
354
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
355
|
+
user_id_type?: string;
|
|
356
|
+
}
|
|
357
|
+
interface CreateResponse {
|
|
358
|
+
/** 创建的任务 */
|
|
359
|
+
subtask?: Lark.Task;
|
|
360
|
+
}
|
|
361
|
+
interface ListQuery extends Pagination {
|
|
362
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
363
|
+
user_id_type?: string;
|
|
364
|
+
}
|
|
365
|
+
}
|
|
366
|
+
namespace Tasklist {
|
|
367
|
+
interface Methods {
|
|
368
|
+
activitySubscription: ActivitySubscription.Methods;
|
|
369
|
+
/**
|
|
370
|
+
* 创建清单
|
|
371
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/create
|
|
372
|
+
*/
|
|
373
|
+
create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
374
|
+
/**
|
|
375
|
+
* 获取清单详情
|
|
376
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/get
|
|
377
|
+
*/
|
|
378
|
+
get(tasklist_guid: string, query?: GetQuery): Promise<GetResponse>;
|
|
379
|
+
/**
|
|
380
|
+
* 更新清单
|
|
381
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/patch
|
|
382
|
+
*/
|
|
383
|
+
patch(tasklist_guid: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
|
|
384
|
+
/**
|
|
385
|
+
* 删除清单
|
|
386
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/delete
|
|
387
|
+
*/
|
|
388
|
+
delete(tasklist_guid: string): Promise<void>;
|
|
389
|
+
/**
|
|
390
|
+
* 添加清单成员
|
|
391
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/add_members
|
|
392
|
+
*/
|
|
393
|
+
addMembers(tasklist_guid: string, body: AddMembersRequest, query?: AddMembersQuery): Promise<AddMembersResponse>;
|
|
394
|
+
/**
|
|
395
|
+
* 移除清单成员
|
|
396
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/remove_members
|
|
397
|
+
*/
|
|
398
|
+
removeMembers(tasklist_guid: string, body: RemoveMembersRequest, query?: RemoveMembersQuery): Promise<RemoveMembersResponse>;
|
|
399
|
+
/**
|
|
400
|
+
* 获取清单任务列表
|
|
401
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/tasks
|
|
402
|
+
*/
|
|
403
|
+
tasks(tasklist_guid: string, query?: TasksQuery): Paginated<Lark.TaskSummary>;
|
|
404
|
+
/**
|
|
405
|
+
* 获取清单列表
|
|
406
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist/list
|
|
407
|
+
*/
|
|
408
|
+
list(query?: ListQuery): Paginated<Lark.Tasklist>;
|
|
409
|
+
}
|
|
410
|
+
interface CreateRequest {
|
|
411
|
+
/** 清单名称 */
|
|
412
|
+
name: string;
|
|
413
|
+
/** 清单的成员列表 */
|
|
414
|
+
members?: Lark.Member[];
|
|
415
|
+
}
|
|
416
|
+
interface CreateQuery {
|
|
417
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
418
|
+
user_id_type?: string;
|
|
419
|
+
}
|
|
420
|
+
interface CreateResponse {
|
|
421
|
+
/** 创建的清单数据 */
|
|
422
|
+
tasklist?: Lark.Tasklist;
|
|
423
|
+
}
|
|
424
|
+
interface GetQuery {
|
|
425
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
426
|
+
user_id_type?: string;
|
|
427
|
+
}
|
|
428
|
+
interface GetResponse {
|
|
429
|
+
/** 清单详情 */
|
|
430
|
+
tasklist?: Lark.Tasklist;
|
|
431
|
+
}
|
|
432
|
+
interface PatchRequest {
|
|
433
|
+
/** 要更新清单的数据 */
|
|
434
|
+
tasklist: Lark.InputTasklist;
|
|
435
|
+
/** 要更新的字段名,只支持更新"owner", "name"两个字段 */
|
|
436
|
+
update_fields: string[];
|
|
437
|
+
/** 该字段表示如果更新了新的负责人,则将原负责人设为指定的协作人角色。仅在update_fields包含owner字段时生效。根据清单的角色设计方式,不允许提前为清单的负责人添加其他角色,但负责人更新后,原有负责人会无法访问该清单。该字段可以帮助避免原负责人彻底退出清单。 */
|
|
438
|
+
origin_owner_to_role?: 'editor' | 'viewer' | 'none';
|
|
439
|
+
}
|
|
440
|
+
interface PatchQuery {
|
|
441
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
442
|
+
user_id_type?: string;
|
|
443
|
+
}
|
|
444
|
+
interface PatchResponse {
|
|
445
|
+
/** 修改后的任务清单 */
|
|
446
|
+
tasklist?: Lark.Tasklist;
|
|
447
|
+
}
|
|
448
|
+
interface AddMembersRequest {
|
|
449
|
+
/** 要添加的成员列表 */
|
|
450
|
+
members: Lark.Member[];
|
|
451
|
+
}
|
|
452
|
+
interface AddMembersQuery {
|
|
453
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
454
|
+
user_id_type?: string;
|
|
455
|
+
}
|
|
456
|
+
interface AddMembersResponse {
|
|
457
|
+
/** 完成更新后的清单实体 */
|
|
458
|
+
tasklist?: Lark.Tasklist;
|
|
459
|
+
}
|
|
460
|
+
interface RemoveMembersRequest {
|
|
461
|
+
/** 要移除的member列表 */
|
|
462
|
+
members: Lark.Member[];
|
|
463
|
+
}
|
|
464
|
+
interface RemoveMembersQuery {
|
|
465
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
466
|
+
user_id_type?: string;
|
|
467
|
+
}
|
|
468
|
+
interface RemoveMembersResponse {
|
|
469
|
+
/** 修改完成后的清单实体 */
|
|
470
|
+
tasklist?: Lark.Tasklist;
|
|
471
|
+
}
|
|
472
|
+
interface TasksQuery extends Pagination {
|
|
473
|
+
/** 只查看特定完成状态的任务,不填写表示不按完成状态过滤 */
|
|
474
|
+
completed?: boolean;
|
|
475
|
+
/** 任务创建的起始时间戳(ms),闭区间,不填写默认为首个任务的创建时间戳 */
|
|
476
|
+
created_from?: string;
|
|
477
|
+
/** 任务创建的结束时间戳(ms),闭区间,不填写默认为最后创建任务的创建时间戳 */
|
|
478
|
+
created_to?: string;
|
|
479
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
480
|
+
user_id_type?: string;
|
|
481
|
+
}
|
|
482
|
+
interface ListQuery extends Pagination {
|
|
483
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
484
|
+
user_id_type?: string;
|
|
485
|
+
}
|
|
486
|
+
namespace ActivitySubscription {
|
|
487
|
+
interface Methods {
|
|
488
|
+
/**
|
|
489
|
+
* 创建动态订阅
|
|
490
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/create
|
|
491
|
+
*/
|
|
492
|
+
create(tasklist_guid: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
493
|
+
/**
|
|
494
|
+
* 获取动态订阅
|
|
495
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/get
|
|
496
|
+
*/
|
|
497
|
+
get(tasklist_guid: string, activity_subscription_guid: string, query?: GetQuery): Promise<GetResponse>;
|
|
498
|
+
/**
|
|
499
|
+
* 列取动态订阅
|
|
500
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/list
|
|
501
|
+
*/
|
|
502
|
+
list(tasklist_guid: string, query?: ListQuery): Promise<ListResponse>;
|
|
503
|
+
/**
|
|
504
|
+
* 更新动态订阅
|
|
505
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/patch
|
|
506
|
+
*/
|
|
507
|
+
patch(tasklist_guid: string, activity_subscription_guid: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
|
|
508
|
+
/**
|
|
509
|
+
* 删除动态订阅
|
|
510
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/tasklist-activity_subscription/delete
|
|
511
|
+
*/
|
|
512
|
+
delete(tasklist_guid: string, activity_subscription_guid: string): Promise<void>;
|
|
513
|
+
}
|
|
514
|
+
interface CreateRequest {
|
|
515
|
+
/** 订阅名称 */
|
|
516
|
+
name: string;
|
|
517
|
+
/** 订阅者列表 */
|
|
518
|
+
subscribers: Lark.Member[];
|
|
519
|
+
/** 订阅的事件key列表 */
|
|
520
|
+
include_keys: number[];
|
|
521
|
+
/** 该订阅是否为停用 */
|
|
522
|
+
disabled?: boolean;
|
|
523
|
+
}
|
|
524
|
+
interface CreateQuery {
|
|
525
|
+
/** 用户ID类型 */
|
|
526
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
527
|
+
}
|
|
528
|
+
interface CreateResponse {
|
|
529
|
+
/** 清单动态订阅 */
|
|
530
|
+
activity_subscription?: Lark.TasklistActivitySubscription;
|
|
531
|
+
}
|
|
532
|
+
interface GetQuery {
|
|
533
|
+
/** 用户ID类型 */
|
|
534
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
535
|
+
}
|
|
536
|
+
interface GetResponse {
|
|
537
|
+
/** 订阅详情 */
|
|
538
|
+
activity_subscription?: Lark.TasklistActivitySubscription;
|
|
539
|
+
}
|
|
540
|
+
interface ListQuery {
|
|
541
|
+
/** 返回结果的最大数量 */
|
|
542
|
+
limit?: number;
|
|
543
|
+
/** 用户ID类型 */
|
|
544
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
545
|
+
}
|
|
546
|
+
interface ListResponse {
|
|
547
|
+
/** 清单的动态订阅数据 */
|
|
548
|
+
items?: Lark.TasklistActivitySubscription[];
|
|
549
|
+
}
|
|
550
|
+
interface PatchRequest {
|
|
551
|
+
/** 要更新的订阅数据 */
|
|
552
|
+
activity_subscription: Lark.TasklistActivitySubscription;
|
|
553
|
+
/** 要更新的字段 */
|
|
554
|
+
update_fields: ('name' | 'include_keys' | 'subscribers' | 'disabled')[];
|
|
555
|
+
}
|
|
556
|
+
interface PatchQuery {
|
|
557
|
+
/** 用户ID类型 */
|
|
558
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
559
|
+
}
|
|
560
|
+
interface PatchResponse {
|
|
561
|
+
/** 更新后的订阅 */
|
|
562
|
+
activity_subscription?: Lark.TasklistActivitySubscription;
|
|
563
|
+
}
|
|
564
|
+
}
|
|
565
|
+
}
|
|
566
|
+
namespace Comment {
|
|
567
|
+
interface Methods {
|
|
568
|
+
/**
|
|
569
|
+
* 创建评论
|
|
570
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/create
|
|
571
|
+
*/
|
|
572
|
+
create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
573
|
+
/**
|
|
574
|
+
* 获取评论详情
|
|
575
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/get
|
|
576
|
+
*/
|
|
577
|
+
get(comment_id: string, query?: GetQuery): Promise<GetResponse>;
|
|
578
|
+
/**
|
|
579
|
+
* 更新评论
|
|
580
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/patch
|
|
581
|
+
*/
|
|
582
|
+
patch(comment_id: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
|
|
583
|
+
/**
|
|
584
|
+
* 删除评论
|
|
585
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/delete
|
|
586
|
+
*/
|
|
587
|
+
delete(comment_id: string): Promise<void>;
|
|
588
|
+
/**
|
|
589
|
+
* 获取评论列表
|
|
590
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/comment/list
|
|
591
|
+
*/
|
|
592
|
+
list(query?: ListQuery): Paginated<Lark.Comment>;
|
|
593
|
+
/**
|
|
594
|
+
* 更新评论
|
|
595
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-comment/update
|
|
596
|
+
*/
|
|
597
|
+
update(task_id: string, comment_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
|
|
598
|
+
}
|
|
599
|
+
interface CreateRequest {
|
|
600
|
+
/** 评论内容 */
|
|
601
|
+
content: string;
|
|
602
|
+
/** 回复给评论的id */
|
|
603
|
+
reply_to_comment_id?: string;
|
|
604
|
+
/** 评论归属的资源类型 */
|
|
605
|
+
resource_type?: string;
|
|
606
|
+
/** 评论归属的资源ID */
|
|
607
|
+
resource_id?: string;
|
|
608
|
+
}
|
|
609
|
+
interface CreateQuery {
|
|
610
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
611
|
+
user_id_type?: string;
|
|
612
|
+
}
|
|
613
|
+
interface CreateResponse {
|
|
614
|
+
/** 创建的评论详情 */
|
|
615
|
+
comment?: Lark.Comment;
|
|
616
|
+
}
|
|
617
|
+
interface GetQuery {
|
|
618
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
619
|
+
user_id_type?: string;
|
|
620
|
+
}
|
|
621
|
+
interface GetResponse {
|
|
622
|
+
/** 评论详情 */
|
|
623
|
+
comment?: Lark.Comment;
|
|
624
|
+
}
|
|
625
|
+
interface PatchRequest {
|
|
626
|
+
/** 要更新的评论数据,支持更新content, md_content */
|
|
627
|
+
comment: Lark.InputComment;
|
|
628
|
+
/** 要更新的字段 */
|
|
629
|
+
update_fields: string[];
|
|
630
|
+
}
|
|
631
|
+
interface PatchQuery {
|
|
632
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
633
|
+
user_id_type?: string;
|
|
634
|
+
}
|
|
635
|
+
interface PatchResponse {
|
|
636
|
+
/** 更新后的评论 */
|
|
637
|
+
comment?: Lark.Comment;
|
|
638
|
+
}
|
|
639
|
+
interface ListQuery extends Pagination {
|
|
640
|
+
/** 要获取评论列表的资源类型 */
|
|
641
|
+
resource_type?: string;
|
|
642
|
+
/** 要获取评论的资源ID。例如要获取任务的评论列表,此处应该填写任务全局唯一ID */
|
|
643
|
+
resource_id: string;
|
|
644
|
+
/** 返回数据的排序方式 */
|
|
645
|
+
direction?: 'asc' | 'desc';
|
|
646
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
647
|
+
user_id_type?: string;
|
|
648
|
+
}
|
|
649
|
+
interface UpdateRequest {
|
|
650
|
+
/** 新的评论内容 */
|
|
651
|
+
content?: string;
|
|
652
|
+
/** 新的富文本评论内容(优先使用) */
|
|
653
|
+
rich_content?: string;
|
|
654
|
+
}
|
|
655
|
+
interface UpdateQuery {
|
|
656
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
657
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
658
|
+
}
|
|
659
|
+
interface UpdateResponse {
|
|
660
|
+
/** 返回修改后的任务评论详情 */
|
|
661
|
+
comment?: Lark.Comment;
|
|
662
|
+
}
|
|
663
|
+
}
|
|
664
|
+
namespace Attachment {
|
|
665
|
+
interface Methods {
|
|
666
|
+
/**
|
|
667
|
+
* 上传附件
|
|
668
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/upload
|
|
669
|
+
*/
|
|
670
|
+
upload(form: UploadForm, query?: UploadQuery): Promise<UploadResponse>;
|
|
671
|
+
/**
|
|
672
|
+
* 列取附件
|
|
673
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/list
|
|
674
|
+
*/
|
|
675
|
+
list(query?: ListQuery): Paginated<Lark.Attachment>;
|
|
676
|
+
/**
|
|
677
|
+
* 获取附件
|
|
678
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/get
|
|
679
|
+
*/
|
|
680
|
+
get(attachment_guid: string, query?: GetQuery): Promise<GetResponse>;
|
|
681
|
+
/**
|
|
682
|
+
* 删除附件
|
|
683
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/attachment/delete
|
|
684
|
+
*/
|
|
685
|
+
delete(attachment_guid: string): Promise<void>;
|
|
686
|
+
}
|
|
687
|
+
interface UploadForm {
|
|
688
|
+
/** 附件归属资源的类型 */
|
|
689
|
+
resource_type?: string;
|
|
690
|
+
/** 附件要归属资源的id。例如,要给任务添加附件,这里要填入任务的全局唯一ID */
|
|
691
|
+
resource_id: string;
|
|
692
|
+
/** 要上传的文件 */
|
|
693
|
+
file: Blob;
|
|
694
|
+
}
|
|
695
|
+
interface UploadQuery {
|
|
696
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
697
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
698
|
+
}
|
|
699
|
+
interface UploadResponse {
|
|
700
|
+
/** 上传的附件列表 */
|
|
701
|
+
items?: Lark.Attachment[];
|
|
702
|
+
}
|
|
703
|
+
interface ListQuery extends Pagination {
|
|
704
|
+
/** 附件归属的资源类型 */
|
|
705
|
+
resource_type?: string;
|
|
706
|
+
/** 附件归属资源的id,配合resource_type使用。例如希望获取任务的附件,需要设置 resource_type为task, resource_id为任务的全局唯一ID */
|
|
707
|
+
resource_id: string;
|
|
708
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
709
|
+
user_id_type?: string;
|
|
710
|
+
}
|
|
711
|
+
interface GetQuery {
|
|
712
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
713
|
+
user_id_type?: string;
|
|
714
|
+
}
|
|
715
|
+
interface GetResponse {
|
|
716
|
+
/** 附件详情 */
|
|
717
|
+
attachment?: Lark.Attachment;
|
|
718
|
+
}
|
|
719
|
+
}
|
|
720
|
+
namespace Section {
|
|
721
|
+
interface Methods {
|
|
722
|
+
/**
|
|
723
|
+
* 创建自定义分组
|
|
724
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/create
|
|
725
|
+
*/
|
|
726
|
+
create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
727
|
+
/**
|
|
728
|
+
* 获取自定义分组详情
|
|
729
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/get
|
|
730
|
+
*/
|
|
731
|
+
get(section_guid: string, query?: GetQuery): Promise<GetResponse>;
|
|
732
|
+
/**
|
|
733
|
+
* 更新自定义分组
|
|
734
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/patch
|
|
735
|
+
*/
|
|
736
|
+
patch(section_guid: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
|
|
737
|
+
/**
|
|
738
|
+
* 删除自定义分组
|
|
739
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/delete
|
|
740
|
+
*/
|
|
741
|
+
delete(section_guid: string): Promise<void>;
|
|
742
|
+
/**
|
|
743
|
+
* 获取自定义分组列表
|
|
744
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/list
|
|
745
|
+
*/
|
|
746
|
+
list(query?: ListQuery): Paginated<Lark.SectionSummary>;
|
|
747
|
+
/**
|
|
748
|
+
* 获取自定义分组任务列表
|
|
749
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/section/tasks
|
|
750
|
+
*/
|
|
751
|
+
tasks(section_guid: string, query?: TasksQuery): Paginated<Lark.TaskSummary>;
|
|
752
|
+
}
|
|
753
|
+
interface CreateRequest {
|
|
754
|
+
/** 自定义分组名称 */
|
|
755
|
+
name: string;
|
|
756
|
+
/** 自定义分组归属的资源类型,支持"tasklist"或者"my_tasks" */
|
|
757
|
+
resource_type: string;
|
|
758
|
+
/** 自定义分组要归属的资源id */
|
|
759
|
+
resource_id?: string;
|
|
760
|
+
/** 要将新分组插入到自定义分分组的前面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */
|
|
761
|
+
insert_before?: string;
|
|
762
|
+
/** 要将新分组插入到自定义分分组的后面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */
|
|
763
|
+
insert_after?: string;
|
|
764
|
+
}
|
|
765
|
+
interface CreateQuery {
|
|
766
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
767
|
+
user_id_type?: string;
|
|
768
|
+
}
|
|
769
|
+
interface CreateResponse {
|
|
770
|
+
/** 创建的自定义分组数据 */
|
|
771
|
+
section?: Lark.Section;
|
|
772
|
+
}
|
|
773
|
+
interface GetQuery {
|
|
774
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
775
|
+
user_id_type?: string;
|
|
776
|
+
}
|
|
777
|
+
interface GetResponse {
|
|
778
|
+
/** 获取的自定义分组详情 */
|
|
779
|
+
section?: Lark.Section;
|
|
780
|
+
}
|
|
781
|
+
interface PatchRequest {
|
|
782
|
+
/** 要更新的自定义分组的数据,仅支持name, insert_after, insert_before */
|
|
783
|
+
section: Lark.InputSection;
|
|
784
|
+
/** 要更新的字段名 */
|
|
785
|
+
update_fields: string[];
|
|
786
|
+
}
|
|
787
|
+
interface PatchQuery {
|
|
788
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
789
|
+
user_id_type?: string;
|
|
790
|
+
}
|
|
791
|
+
interface PatchResponse {
|
|
792
|
+
/** 更新后的自定义分组 */
|
|
793
|
+
section?: Lark.Section;
|
|
794
|
+
}
|
|
795
|
+
interface ListQuery extends Pagination {
|
|
796
|
+
/** 自定义分组所属的资源类型。支持"my_tasks"(我负责的)和"tasklist"(清单)。当使用"tasklist"时,需要用resource_id提供清单GUID。 */
|
|
797
|
+
resource_type: string;
|
|
798
|
+
/** 如`resource_type`为"tasklist",这里需要填写要列取自定义分组的清单的GUID。 */
|
|
799
|
+
resource_id?: string;
|
|
800
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
801
|
+
user_id_type?: string;
|
|
802
|
+
}
|
|
803
|
+
interface TasksQuery extends Pagination {
|
|
804
|
+
/** 按照任务状态过滤,如果不填写则表示不按完成状态过滤 */
|
|
805
|
+
completed?: boolean;
|
|
806
|
+
/** 按照创建时间筛选的起始时间戳(ms),如不填写则为首个任务的创建时刻 */
|
|
807
|
+
created_from?: string;
|
|
808
|
+
/** 按照创建时间筛选的起始时间戳(ms),如不填写则为最后任务的创建时刻 */
|
|
809
|
+
created_to?: string;
|
|
810
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
811
|
+
user_id_type?: string;
|
|
812
|
+
}
|
|
813
|
+
}
|
|
814
|
+
namespace CustomField {
|
|
815
|
+
interface Methods {
|
|
816
|
+
option: Option.Methods;
|
|
817
|
+
/**
|
|
818
|
+
* 创建自定义字段
|
|
819
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/create
|
|
820
|
+
*/
|
|
821
|
+
create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
822
|
+
/**
|
|
823
|
+
* 获取自定义字段
|
|
824
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/get
|
|
825
|
+
*/
|
|
826
|
+
get(custom_field_guid: string, query?: GetQuery): Promise<GetResponse>;
|
|
827
|
+
/**
|
|
828
|
+
* 更新自定义字段
|
|
829
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/patch
|
|
830
|
+
*/
|
|
831
|
+
patch(custom_field_guid: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>;
|
|
832
|
+
/**
|
|
833
|
+
* 列取自定义字段
|
|
834
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/list
|
|
835
|
+
*/
|
|
836
|
+
list(query?: ListQuery): Paginated<Lark.CustomField>;
|
|
837
|
+
/**
|
|
838
|
+
* 将自定义字段加入资源
|
|
839
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/add
|
|
840
|
+
*/
|
|
841
|
+
add(custom_field_guid: string, body: AddRequest): Promise<void>;
|
|
842
|
+
/**
|
|
843
|
+
* 将自定义字段移出资源
|
|
844
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/remove
|
|
845
|
+
*/
|
|
846
|
+
remove(custom_field_guid: string, body: RemoveRequest): Promise<void>;
|
|
847
|
+
}
|
|
848
|
+
interface CreateRequest {
|
|
849
|
+
/** 自定义字段要归属的资源类型,支持"tasklist" */
|
|
850
|
+
resource_type: string;
|
|
851
|
+
/** 自定义字段要归属的资源ID,可以填写清单的tasklist_guid */
|
|
852
|
+
resource_id: string;
|
|
853
|
+
/** 字段名称 */
|
|
854
|
+
name: string;
|
|
855
|
+
/** 自定义字段类型,支持"number", "datetime", "member", "single_select", "multi_select" */
|
|
856
|
+
type: 'number' | 'datetime' | 'member' | 'single_select' | 'multi_select' | 'text';
|
|
857
|
+
/** 数字类型的字段设置 */
|
|
858
|
+
number_setting?: Lark.NumberSetting;
|
|
859
|
+
/** 人员类型的字段设置 */
|
|
860
|
+
member_setting?: Lark.MemberSetting;
|
|
861
|
+
/** 时间日期类型的字段设置 */
|
|
862
|
+
datetime_setting?: Lark.DatetimeSetting;
|
|
863
|
+
/** 单选设置 */
|
|
864
|
+
single_select_setting?: Lark.SelectSetting;
|
|
865
|
+
/** 多选设置 */
|
|
866
|
+
multi_select_setting?: Lark.SelectSetting;
|
|
867
|
+
/** 文本类型 */
|
|
868
|
+
text_setting?: Lark.TextSetting;
|
|
869
|
+
}
|
|
870
|
+
interface CreateQuery {
|
|
871
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
872
|
+
user_id_type?: 'open_id' | 'user_id' | 'union_id';
|
|
873
|
+
}
|
|
874
|
+
interface CreateResponse {
|
|
875
|
+
/** 创建的自定义字段 */
|
|
876
|
+
custom_field?: Lark.CustomField;
|
|
877
|
+
}
|
|
878
|
+
interface GetQuery {
|
|
879
|
+
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
880
|
+
user_id_type?: 'open_id' | 'user_id' | 'union_id';
|
|
881
|
+
}
|
|
882
|
+
interface GetResponse {
|
|
883
|
+
/** 获取的自定义字段数据 */
|
|
884
|
+
custom_field?: Lark.CustomField;
|
|
885
|
+
}
|
|
886
|
+
interface PatchRequest {
|
|
887
|
+
/** 要修改的自定义字段数据 */
|
|
888
|
+
custom_field?: Lark.InputCustomField;
|
|
889
|
+
/** 要修改的自定义字段类型,支持name, member_setting, number_setting, datetime_setting, single_select_setting, multi_select_setting */
|
|
890
|
+
update_fields?: string[];
|
|
891
|
+
}
|
|
892
|
+
interface PatchQuery {
|
|
893
|
+
/** 用户ID格式 */
|
|
894
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
895
|
+
}
|
|
896
|
+
interface PatchResponse {
|
|
897
|
+
/** 修改后的自定义字段设置 */
|
|
898
|
+
custom_field?: Lark.CustomField;
|
|
899
|
+
}
|
|
900
|
+
interface ListQuery extends Pagination {
|
|
901
|
+
/** 用户ID格式,支持open_id, user_id, union_id */
|
|
902
|
+
user_id_type?: 'open_id' | 'user_id' | 'union_id';
|
|
903
|
+
/** 资源类型,如提供表示仅查询特定资源下的自定义字段。目前只支持tasklist。 */
|
|
904
|
+
resource_type?: string;
|
|
905
|
+
/** 要查询自定义字段的归属resource_id */
|
|
906
|
+
resource_id?: string;
|
|
907
|
+
}
|
|
908
|
+
interface AddRequest {
|
|
909
|
+
/** 要将自定义字段添加到一个资源的资源类型。目前只支持tasklist */
|
|
910
|
+
resource_type: string;
|
|
911
|
+
/** 要将自定义字段添加到的资源id,目前只支持tasklist_guid */
|
|
912
|
+
resource_id: string;
|
|
913
|
+
}
|
|
914
|
+
interface RemoveRequest {
|
|
915
|
+
/** 要从某个资源移除自定义字段的资源类型,目前只支持清单"tasklist"。 */
|
|
916
|
+
resource_type: string;
|
|
917
|
+
/** 要从某个资源移除自定义字段的资源id,`resource_type`为"tasklist"时,需填写清单的GUID */
|
|
918
|
+
resource_id: string;
|
|
919
|
+
}
|
|
920
|
+
namespace Option {
|
|
921
|
+
interface Methods {
|
|
922
|
+
/**
|
|
923
|
+
* 创建自定义任务选项
|
|
924
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/create
|
|
925
|
+
*/
|
|
926
|
+
create(custom_field_guid: string, body: CreateRequest): Promise<CreateResponse>;
|
|
927
|
+
/**
|
|
928
|
+
* 更新自定义字段选项
|
|
929
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field-option/patch
|
|
930
|
+
*/
|
|
931
|
+
patch(custom_field_guid: string, option_guid: string, body: PatchRequest): Promise<PatchResponse>;
|
|
932
|
+
}
|
|
933
|
+
interface CreateRequest {
|
|
934
|
+
/** 选项名 */
|
|
935
|
+
name: string;
|
|
936
|
+
/** 颜色索引值,支持0~54中的一个数字。如果不填写,则会随机选一个。 */
|
|
937
|
+
color_index?: number;
|
|
938
|
+
/** 要放到某个option之前的option_guid */
|
|
939
|
+
insert_before?: string;
|
|
940
|
+
/** 要放到某个option之后的option_guid */
|
|
941
|
+
insert_after?: string;
|
|
942
|
+
/** 是否隐藏 */
|
|
943
|
+
is_hidden?: boolean;
|
|
944
|
+
}
|
|
945
|
+
interface CreateResponse {
|
|
946
|
+
/** 创建的选项 */
|
|
947
|
+
option?: Lark.Option;
|
|
948
|
+
}
|
|
949
|
+
interface PatchRequest {
|
|
950
|
+
/** 要更新的option数据 */
|
|
951
|
+
option?: Lark.InputOption;
|
|
952
|
+
/** 要更新的字段名,支持name,color,is_hidden,insert_before,insert_after */
|
|
953
|
+
update_fields?: string[];
|
|
954
|
+
}
|
|
955
|
+
interface PatchResponse {
|
|
956
|
+
/** 更新后的option数据 */
|
|
957
|
+
option?: Lark.Option;
|
|
958
|
+
}
|
|
959
|
+
}
|
|
960
|
+
}
|
|
961
|
+
namespace Reminder {
|
|
962
|
+
interface Methods {
|
|
963
|
+
/**
|
|
964
|
+
* 新增提醒时间
|
|
965
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/create
|
|
966
|
+
*/
|
|
967
|
+
create(task_id: string, body: CreateRequest): Promise<CreateResponse>;
|
|
968
|
+
/**
|
|
969
|
+
* 删除提醒时间
|
|
970
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/delete
|
|
971
|
+
*/
|
|
972
|
+
delete(task_id: string, reminder_id: string): Promise<void>;
|
|
973
|
+
/**
|
|
974
|
+
* 查询提醒时间列表
|
|
975
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-reminder/list
|
|
976
|
+
*/
|
|
977
|
+
list(task_id: string, query?: Pagination): Paginated<Lark.Reminder>;
|
|
978
|
+
}
|
|
979
|
+
interface CreateRequest {
|
|
980
|
+
/** 相对于截止时间的提醒时间(如提前 30 分钟,截止时间后 30 分钟,则为 -30) */
|
|
981
|
+
relative_fire_minute: number;
|
|
982
|
+
}
|
|
983
|
+
interface CreateResponse {
|
|
984
|
+
/** 返回创建成功的提醒时间 */
|
|
985
|
+
reminder?: Lark.Reminder;
|
|
986
|
+
}
|
|
987
|
+
}
|
|
988
|
+
namespace Follower {
|
|
989
|
+
interface Methods {
|
|
990
|
+
/**
|
|
991
|
+
* 新增关注人
|
|
992
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/create
|
|
993
|
+
*/
|
|
994
|
+
create(task_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
995
|
+
/**
|
|
996
|
+
* 删除指定关注人
|
|
997
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/delete
|
|
998
|
+
*/
|
|
999
|
+
delete(task_id: string, follower_id: string, query?: DeleteQuery): Promise<void>;
|
|
1000
|
+
/**
|
|
1001
|
+
* 获取关注人列表
|
|
1002
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-follower/list
|
|
1003
|
+
*/
|
|
1004
|
+
list(task_id: string, query?: ListQuery): Paginated<Lark.Follower>;
|
|
1005
|
+
}
|
|
1006
|
+
interface CreateRequest {
|
|
1007
|
+
/** 任务关注者 ID */
|
|
1008
|
+
id?: string;
|
|
1009
|
+
/** 要添加为关注人的user_id */
|
|
1010
|
+
id_list?: string[];
|
|
1011
|
+
}
|
|
1012
|
+
interface CreateQuery {
|
|
1013
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1014
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1015
|
+
}
|
|
1016
|
+
interface CreateResponse {
|
|
1017
|
+
/** 创建后的任务关注者 */
|
|
1018
|
+
follower: Lark.Follower;
|
|
1019
|
+
}
|
|
1020
|
+
interface DeleteQuery {
|
|
1021
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1022
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1023
|
+
}
|
|
1024
|
+
interface ListQuery extends Pagination {
|
|
1025
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1026
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1027
|
+
}
|
|
1028
|
+
}
|
|
1029
|
+
namespace Collaborator {
|
|
1030
|
+
interface Methods {
|
|
1031
|
+
/**
|
|
1032
|
+
* 新增执行者
|
|
1033
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/create
|
|
1034
|
+
*/
|
|
1035
|
+
create(task_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
|
|
1036
|
+
/**
|
|
1037
|
+
* 删除指定执行者
|
|
1038
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/delete
|
|
1039
|
+
*/
|
|
1040
|
+
delete(task_id: string, collaborator_id: string, query?: DeleteQuery): Promise<void>;
|
|
1041
|
+
/**
|
|
1042
|
+
* 获取执行者列表
|
|
1043
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/task-collaborator/list
|
|
1044
|
+
*/
|
|
1045
|
+
list(task_id: string, query?: ListQuery): Paginated<Lark.Collaborator>;
|
|
1046
|
+
}
|
|
1047
|
+
interface CreateRequest {
|
|
1048
|
+
/** 任务协作者的 ID */
|
|
1049
|
+
id?: string;
|
|
1050
|
+
/** 协作人的用户ID列表 */
|
|
1051
|
+
id_list?: string[];
|
|
1052
|
+
}
|
|
1053
|
+
interface CreateQuery {
|
|
1054
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1055
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1056
|
+
}
|
|
1057
|
+
interface CreateResponse {
|
|
1058
|
+
/** 返回创建成功后的任务协作者 */
|
|
1059
|
+
collaborator: Lark.Collaborator;
|
|
1060
|
+
}
|
|
1061
|
+
interface DeleteQuery {
|
|
1062
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1063
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1064
|
+
}
|
|
1065
|
+
interface ListQuery extends Pagination {
|
|
1066
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1067
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1068
|
+
}
|
|
380
1069
|
}
|
|
381
|
-
}
|
|
382
|
-
export interface CreateTaskV2Request {
|
|
383
|
-
/** 任务标题 */
|
|
384
|
-
summary: string;
|
|
385
|
-
/** 任务描述 */
|
|
386
|
-
description?: string;
|
|
387
|
-
/** 任务截止时间戳(ms),截止时间戳和截止日期选择一个填写。 */
|
|
388
|
-
due?: Due;
|
|
389
|
-
/** 任务关联的第三方平台来源信息 */
|
|
390
|
-
origin?: Origin;
|
|
391
|
-
/** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */
|
|
392
|
-
extra?: string;
|
|
393
|
-
/** 任务的完成时刻时间戳(ms) */
|
|
394
|
-
completed_at?: string;
|
|
395
|
-
/** 任务成员列表 */
|
|
396
|
-
members?: Member[];
|
|
397
|
-
/** 如果设置,则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */
|
|
398
|
-
repeat_rule?: string;
|
|
399
|
-
/** 如果设置,则将任务设计为“自定义完成”。用户在任务中心点击“完成”时,不会直接完成任务,而是跳转到第三方配置好的地址或者现实自定义提示。 */
|
|
400
|
-
custom_complete?: CustomComplete;
|
|
401
|
-
/** 任务所在清单的信息 */
|
|
402
|
-
tasklists?: TaskInTasklistInfo[];
|
|
403
|
-
/** 幂等token,如果填写则触发幂等行为。 */
|
|
404
|
-
client_token?: string;
|
|
405
|
-
/** 任务的开始时间(ms) */
|
|
406
|
-
start?: Start;
|
|
407
|
-
/** 任务提醒 */
|
|
408
|
-
reminders?: Reminder[];
|
|
409
|
-
/** 任务完成模式, 1 - 会签任务; 2 - 或签任务 */
|
|
410
|
-
mode?: number;
|
|
411
|
-
/** 是否是里程碑任务 */
|
|
412
|
-
is_milestone?: boolean;
|
|
413
|
-
/** 自定义字段值 */
|
|
414
|
-
custom_fields?: InputCustomFieldValue[];
|
|
415
|
-
/** 任务的新版云文档来源 */
|
|
416
|
-
docx_source?: DocxSource;
|
|
417
|
-
}
|
|
418
|
-
export interface CreateTaskV2Query {
|
|
419
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
420
|
-
user_id_type?: string;
|
|
421
|
-
}
|
|
422
|
-
export interface CreateTaskV2Response {
|
|
423
|
-
/** 产生的任务 */
|
|
424
|
-
task?: Task;
|
|
425
|
-
}
|
|
426
|
-
export interface GetTaskV2Query {
|
|
427
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
428
|
-
user_id_type?: string;
|
|
429
|
-
}
|
|
430
|
-
export interface GetTaskV2Response {
|
|
431
|
-
/** 获得的任务实体 */
|
|
432
|
-
task?: Task;
|
|
433
|
-
}
|
|
434
|
-
export interface PatchTaskV2Request {
|
|
435
|
-
/** 要更新的任务数据,只需要写明要更新的字段 */
|
|
436
|
-
task?: InputTask;
|
|
437
|
-
/** 要更新的字段名称。支持summary, description, due, start, completed_at, extra, repeat_rule, custom_complete, mode, is_milestone, custom_fields。 */
|
|
438
|
-
update_fields: string[];
|
|
439
|
-
}
|
|
440
|
-
export interface PatchTaskV2Query {
|
|
441
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
442
|
-
user_id_type?: string;
|
|
443
|
-
}
|
|
444
|
-
export interface PatchTaskV2Response {
|
|
445
|
-
/** 更新后的任务 */
|
|
446
|
-
task?: Task;
|
|
447
|
-
}
|
|
448
|
-
export interface AddMembersTaskV2Request {
|
|
449
|
-
/** 要添加的members列表 */
|
|
450
|
-
members: Member[];
|
|
451
|
-
/** 幂等token,如果提供则实现幂等行为 */
|
|
452
|
-
client_token?: string;
|
|
453
|
-
}
|
|
454
|
-
export interface AddMembersTaskV2Query {
|
|
455
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
456
|
-
user_id_type?: string;
|
|
457
|
-
}
|
|
458
|
-
export interface AddMembersTaskV2Response {
|
|
459
|
-
/** 更新完成后的任务实体数据 */
|
|
460
|
-
task?: Task;
|
|
461
|
-
}
|
|
462
|
-
export interface RemoveMembersTaskV2Request {
|
|
463
|
-
/** 要移除的member列表 */
|
|
464
|
-
members: Member[];
|
|
465
|
-
}
|
|
466
|
-
export interface RemoveMembersTaskV2Query {
|
|
467
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
468
|
-
user_id_type?: string;
|
|
469
|
-
}
|
|
470
|
-
export interface RemoveMembersTaskV2Response {
|
|
471
|
-
/** 移除成员后的任务数据 */
|
|
472
|
-
task?: Task;
|
|
473
|
-
}
|
|
474
|
-
export interface ListTaskV2Query extends Pagination {
|
|
475
|
-
/** 是否按任务完成进行过滤。不填写表示不过滤。 */
|
|
476
|
-
completed?: boolean;
|
|
477
|
-
/** 查询任务的范围 */
|
|
478
|
-
type?: string;
|
|
479
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
480
|
-
user_id_type?: string;
|
|
481
|
-
}
|
|
482
|
-
export interface TasklistsTaskV2Response {
|
|
483
|
-
/** 任务所在清单的摘要信息 */
|
|
484
|
-
tasklists?: TaskInTasklistInfo[];
|
|
485
|
-
}
|
|
486
|
-
export interface AddTasklistTaskV2Request {
|
|
487
|
-
/** 要添加到的清单的全局唯一ID */
|
|
488
|
-
tasklist_guid: string;
|
|
489
|
-
/** 要添加到清单的自定义分组全局唯一ID,如不填写表示添加到默认分组 */
|
|
490
|
-
section_guid?: string;
|
|
491
|
-
}
|
|
492
|
-
export interface AddTasklistTaskV2Query {
|
|
493
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
494
|
-
user_id_type?: string;
|
|
495
|
-
}
|
|
496
|
-
export interface AddTasklistTaskV2Response {
|
|
497
|
-
/** 添加后的任务详情 */
|
|
498
|
-
task?: Task;
|
|
499
|
-
}
|
|
500
|
-
export interface RemoveTasklistTaskV2Request {
|
|
501
|
-
/** 要移除的清单的全局唯一ID */
|
|
502
|
-
tasklist_guid: string;
|
|
503
|
-
}
|
|
504
|
-
export interface RemoveTasklistTaskV2Query {
|
|
505
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
506
|
-
user_id_type?: string;
|
|
507
|
-
}
|
|
508
|
-
export interface RemoveTasklistTaskV2Response {
|
|
509
|
-
/** 添加后的任务详情 */
|
|
510
|
-
task?: Task;
|
|
511
|
-
}
|
|
512
|
-
export interface AddRemindersTaskV2Request {
|
|
513
|
-
/** 要添加的reminder的列表 */
|
|
514
|
-
reminders: Reminder[];
|
|
515
|
-
}
|
|
516
|
-
export interface AddRemindersTaskV2Query {
|
|
517
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
518
|
-
user_id_type?: string;
|
|
519
|
-
}
|
|
520
|
-
export interface AddRemindersTaskV2Response {
|
|
521
|
-
/** 更新完成后的任务实体 */
|
|
522
|
-
task?: Task;
|
|
523
|
-
}
|
|
524
|
-
export interface RemoveRemindersTaskV2Request {
|
|
525
|
-
/** 要移除的reminder的id列表 */
|
|
526
|
-
reminder_ids: string[];
|
|
527
|
-
}
|
|
528
|
-
export interface RemoveRemindersTaskV2Query {
|
|
529
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
530
|
-
user_id_type?: string;
|
|
531
|
-
}
|
|
532
|
-
export interface RemoveRemindersTaskV2Response {
|
|
533
|
-
/** 移除提醒后的任务详情 */
|
|
534
|
-
task?: Task;
|
|
535
|
-
}
|
|
536
|
-
export interface AddDependenciesTaskV2Request {
|
|
537
|
-
/** 要添加的依赖 */
|
|
538
|
-
dependencies?: TaskDependency[];
|
|
539
|
-
}
|
|
540
|
-
export interface AddDependenciesTaskV2Response {
|
|
541
|
-
/** 被添加后任务的所有依赖 */
|
|
542
|
-
dependencies?: TaskDependency[];
|
|
543
|
-
}
|
|
544
|
-
export interface RemoveDependenciesTaskV2Request {
|
|
545
|
-
/** 要移除的依赖 */
|
|
546
|
-
dependencies: TaskDependency[];
|
|
547
|
-
}
|
|
548
|
-
export interface RemoveDependenciesTaskV2Response {
|
|
549
|
-
/** 移除之后的任务GUID */
|
|
550
|
-
dependencies?: TaskDependency[];
|
|
551
|
-
}
|
|
552
|
-
export interface CreateTaskV2TaskSubtaskRequest {
|
|
553
|
-
/** 任务标题 */
|
|
554
|
-
summary: string;
|
|
555
|
-
/** 任务描述 */
|
|
556
|
-
description?: string;
|
|
557
|
-
/** 任务截止时间戳(ms),截止时间戳和截止日期选择一个填写。 */
|
|
558
|
-
due?: Due;
|
|
559
|
-
/** 任务关联的第三方平台来源信息 */
|
|
560
|
-
origin?: Origin;
|
|
561
|
-
/** 调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。 */
|
|
562
|
-
extra?: string;
|
|
563
|
-
/** 任务的完成时刻时间戳(ms) */
|
|
564
|
-
completed_at?: string;
|
|
565
|
-
/** 任务成员列表 */
|
|
566
|
-
members?: Member[];
|
|
567
|
-
/** 如果设置,则该任务为“重复任务”。该字段表示了重复任务的重复规则。 */
|
|
568
|
-
repeat_rule?: string;
|
|
569
|
-
/** 如果设置,则将任务设计为“自定义完成”。用户在任务中心点击“完成”时,不会直接完成任务,而是跳转到第三方配置好的地址或者现实自定义提示。 */
|
|
570
|
-
custom_complete?: CustomComplete;
|
|
571
|
-
/** 任务所在清单的信息 */
|
|
572
|
-
tasklists?: TaskInTasklistInfo[];
|
|
573
|
-
/** 幂等token,如果填写则触发幂等行为。 */
|
|
574
|
-
client_token?: string;
|
|
575
|
-
/** 任务的开始时间(ms) */
|
|
576
|
-
start?: Start;
|
|
577
|
-
/** 任务提醒 */
|
|
578
|
-
reminders?: Reminder[];
|
|
579
|
-
/** 任务完成模式, 1 - 会签任务; 2 - 或签任务 */
|
|
580
|
-
mode?: number;
|
|
581
|
-
/** 是否是里程碑任务 */
|
|
582
|
-
is_milestone?: boolean;
|
|
583
|
-
/** 自定义字段值 */
|
|
584
|
-
custom_fields?: InputCustomFieldValue[];
|
|
585
|
-
/** 任务的新版云文档来源 */
|
|
586
|
-
docx_source?: DocxSource;
|
|
587
|
-
}
|
|
588
|
-
export interface CreateTaskV2TaskSubtaskQuery {
|
|
589
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
590
|
-
user_id_type?: string;
|
|
591
|
-
}
|
|
592
|
-
export interface CreateTaskV2TaskSubtaskResponse {
|
|
593
|
-
/** 创建的任务 */
|
|
594
|
-
subtask?: Task;
|
|
595
|
-
}
|
|
596
|
-
export interface ListTaskV2TaskSubtaskQuery extends Pagination {
|
|
597
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
598
|
-
user_id_type?: string;
|
|
599
|
-
}
|
|
600
|
-
export interface CreateTaskV2TasklistRequest {
|
|
601
|
-
/** 清单名称 */
|
|
602
|
-
name: string;
|
|
603
|
-
/** 清单的成员列表 */
|
|
604
|
-
members?: Member[];
|
|
605
|
-
}
|
|
606
|
-
export interface CreateTaskV2TasklistQuery {
|
|
607
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
608
|
-
user_id_type?: string;
|
|
609
|
-
}
|
|
610
|
-
export interface CreateTaskV2TasklistResponse {
|
|
611
|
-
/** 创建的清单数据 */
|
|
612
|
-
tasklist?: Tasklist;
|
|
613
|
-
}
|
|
614
|
-
export interface GetTaskV2TasklistQuery {
|
|
615
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
616
|
-
user_id_type?: string;
|
|
617
|
-
}
|
|
618
|
-
export interface GetTaskV2TasklistResponse {
|
|
619
|
-
/** 清单详情 */
|
|
620
|
-
tasklist?: Tasklist;
|
|
621
|
-
}
|
|
622
|
-
export interface PatchTaskV2TasklistRequest {
|
|
623
|
-
/** 要更新清单的数据 */
|
|
624
|
-
tasklist: InputTasklist;
|
|
625
|
-
/** 要更新的字段名,只支持更新"owner", "name"两个字段 */
|
|
626
|
-
update_fields: string[];
|
|
627
|
-
/** 该字段表示如果更新了新的负责人,则将原负责人设为指定的协作人角色。仅在update_fields包含owner字段时生效。根据清单的角色设计方式,不允许提前为清单的负责人添加其他角色,但负责人更新后,原有负责人会无法访问该清单。该字段可以帮助避免原负责人彻底退出清单。 */
|
|
628
|
-
origin_owner_to_role?: 'editor' | 'viewer' | 'none';
|
|
629
|
-
}
|
|
630
|
-
export interface PatchTaskV2TasklistQuery {
|
|
631
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
632
|
-
user_id_type?: string;
|
|
633
|
-
}
|
|
634
|
-
export interface PatchTaskV2TasklistResponse {
|
|
635
|
-
/** 修改后的任务清单 */
|
|
636
|
-
tasklist?: Tasklist;
|
|
637
|
-
}
|
|
638
|
-
export interface AddMembersTaskV2TasklistRequest {
|
|
639
|
-
/** 要添加的成员列表 */
|
|
640
|
-
members: Member[];
|
|
641
|
-
}
|
|
642
|
-
export interface AddMembersTaskV2TasklistQuery {
|
|
643
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
644
|
-
user_id_type?: string;
|
|
645
|
-
}
|
|
646
|
-
export interface AddMembersTaskV2TasklistResponse {
|
|
647
|
-
/** 完成更新后的清单实体 */
|
|
648
|
-
tasklist?: Tasklist;
|
|
649
|
-
}
|
|
650
|
-
export interface RemoveMembersTaskV2TasklistRequest {
|
|
651
|
-
/** 要移除的member列表 */
|
|
652
|
-
members: Member[];
|
|
653
|
-
}
|
|
654
|
-
export interface RemoveMembersTaskV2TasklistQuery {
|
|
655
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
656
|
-
user_id_type?: string;
|
|
657
|
-
}
|
|
658
|
-
export interface RemoveMembersTaskV2TasklistResponse {
|
|
659
|
-
/** 修改完成后的清单实体 */
|
|
660
|
-
tasklist?: Tasklist;
|
|
661
|
-
}
|
|
662
|
-
export interface TasksTaskV2TasklistQuery extends Pagination {
|
|
663
|
-
/** 只查看特定完成状态的任务,不填写表示不按完成状态过滤 */
|
|
664
|
-
completed?: boolean;
|
|
665
|
-
/** 任务创建的起始时间戳(ms),闭区间,不填写默认为首个任务的创建时间戳 */
|
|
666
|
-
created_from?: string;
|
|
667
|
-
/** 任务创建的结束时间戳(ms),闭区间,不填写默认为最后创建任务的创建时间戳 */
|
|
668
|
-
created_to?: string;
|
|
669
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
670
|
-
user_id_type?: string;
|
|
671
|
-
}
|
|
672
|
-
export interface ListTaskV2TasklistQuery extends Pagination {
|
|
673
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
674
|
-
user_id_type?: string;
|
|
675
|
-
}
|
|
676
|
-
export interface CreateTaskV2TasklistActivitySubscriptionRequest {
|
|
677
|
-
/** 订阅名称 */
|
|
678
|
-
name: string;
|
|
679
|
-
/** 订阅者列表 */
|
|
680
|
-
subscribers: Member[];
|
|
681
|
-
/** 订阅的事件key列表 */
|
|
682
|
-
include_keys: number[];
|
|
683
|
-
/** 该订阅是否为停用 */
|
|
684
|
-
disabled?: boolean;
|
|
685
|
-
}
|
|
686
|
-
export interface CreateTaskV2TasklistActivitySubscriptionQuery {
|
|
687
|
-
/** 用户ID类型 */
|
|
688
|
-
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
689
|
-
}
|
|
690
|
-
export interface CreateTaskV2TasklistActivitySubscriptionResponse {
|
|
691
|
-
/** 清单动态订阅 */
|
|
692
|
-
activity_subscription?: TasklistActivitySubscription;
|
|
693
|
-
}
|
|
694
|
-
export interface GetTaskV2TasklistActivitySubscriptionQuery {
|
|
695
|
-
/** 用户ID类型 */
|
|
696
|
-
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
697
|
-
}
|
|
698
|
-
export interface GetTaskV2TasklistActivitySubscriptionResponse {
|
|
699
|
-
/** 订阅详情 */
|
|
700
|
-
activity_subscription?: TasklistActivitySubscription;
|
|
701
|
-
}
|
|
702
|
-
export interface ListTaskV2TasklistActivitySubscriptionQuery {
|
|
703
|
-
/** 返回结果的最大数量 */
|
|
704
|
-
limit?: number;
|
|
705
|
-
/** 用户ID类型 */
|
|
706
|
-
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
707
|
-
}
|
|
708
|
-
export interface ListTaskV2TasklistActivitySubscriptionResponse {
|
|
709
|
-
/** 清单的动态订阅数据 */
|
|
710
|
-
items?: TasklistActivitySubscription[];
|
|
711
|
-
}
|
|
712
|
-
export interface PatchTaskV2TasklistActivitySubscriptionRequest {
|
|
713
|
-
/** 要更新的订阅数据 */
|
|
714
|
-
activity_subscription: TasklistActivitySubscription;
|
|
715
|
-
/** 要更新的字段 */
|
|
716
|
-
update_fields: ('name' | 'include_keys' | 'subscribers' | 'disabled')[];
|
|
717
|
-
}
|
|
718
|
-
export interface PatchTaskV2TasklistActivitySubscriptionQuery {
|
|
719
|
-
/** 用户ID类型 */
|
|
720
|
-
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
721
|
-
}
|
|
722
|
-
export interface PatchTaskV2TasklistActivitySubscriptionResponse {
|
|
723
|
-
/** 更新后的订阅 */
|
|
724
|
-
activity_subscription?: TasklistActivitySubscription;
|
|
725
|
-
}
|
|
726
|
-
export interface CreateTaskV2CommentRequest {
|
|
727
|
-
/** 评论内容 */
|
|
728
|
-
content: string;
|
|
729
|
-
/** 回复给评论的id */
|
|
730
|
-
reply_to_comment_id?: string;
|
|
731
|
-
/** 评论归属的资源类型 */
|
|
732
|
-
resource_type?: string;
|
|
733
|
-
/** 评论归属的资源ID */
|
|
734
|
-
resource_id?: string;
|
|
735
|
-
}
|
|
736
|
-
export interface CreateTaskV2CommentQuery {
|
|
737
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
738
|
-
user_id_type?: string;
|
|
739
|
-
}
|
|
740
|
-
export interface CreateTaskV2CommentResponse {
|
|
741
|
-
/** 创建的评论详情 */
|
|
742
|
-
comment?: Comment;
|
|
743
|
-
}
|
|
744
|
-
export interface GetTaskV2CommentQuery {
|
|
745
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
746
|
-
user_id_type?: string;
|
|
747
|
-
}
|
|
748
|
-
export interface GetTaskV2CommentResponse {
|
|
749
|
-
/** 评论详情 */
|
|
750
|
-
comment?: Comment;
|
|
751
|
-
}
|
|
752
|
-
export interface PatchTaskV2CommentRequest {
|
|
753
|
-
/** 要更新的评论数据,支持更新content, md_content */
|
|
754
|
-
comment: InputComment;
|
|
755
|
-
/** 要更新的字段 */
|
|
756
|
-
update_fields: string[];
|
|
757
|
-
}
|
|
758
|
-
export interface PatchTaskV2CommentQuery {
|
|
759
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
760
|
-
user_id_type?: string;
|
|
761
|
-
}
|
|
762
|
-
export interface PatchTaskV2CommentResponse {
|
|
763
|
-
/** 更新后的评论 */
|
|
764
|
-
comment?: Comment;
|
|
765
|
-
}
|
|
766
|
-
export interface ListTaskV2CommentQuery extends Pagination {
|
|
767
|
-
/** 要获取评论列表的资源类型 */
|
|
768
|
-
resource_type?: string;
|
|
769
|
-
/** 要获取评论的资源ID。例如要获取任务的评论列表,此处应该填写任务全局唯一ID */
|
|
770
|
-
resource_id: string;
|
|
771
|
-
/** 返回数据的排序方式 */
|
|
772
|
-
direction?: 'asc' | 'desc';
|
|
773
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
774
|
-
user_id_type?: string;
|
|
775
|
-
}
|
|
776
|
-
export interface UploadTaskV2AttachmentForm {
|
|
777
|
-
/** 附件归属资源的类型 */
|
|
778
|
-
resource_type?: string;
|
|
779
|
-
/** 附件要归属资源的id。例如,要给任务添加附件,这里要填入任务的全局唯一ID */
|
|
780
|
-
resource_id: string;
|
|
781
|
-
/** 要上传的文件 */
|
|
782
|
-
file: Blob;
|
|
783
|
-
}
|
|
784
|
-
export interface UploadTaskV2AttachmentQuery {
|
|
785
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
786
|
-
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
787
|
-
}
|
|
788
|
-
export interface UploadTaskV2AttachmentResponse {
|
|
789
|
-
/** 上传的附件列表 */
|
|
790
|
-
items?: Attachment[];
|
|
791
|
-
}
|
|
792
|
-
export interface ListTaskV2AttachmentQuery extends Pagination {
|
|
793
|
-
/** 附件归属的资源类型 */
|
|
794
|
-
resource_type?: string;
|
|
795
|
-
/** 附件归属资源的id,配合resource_type使用。例如希望获取任务的附件,需要设置 resource_type为task, resource_id为任务的全局唯一ID */
|
|
796
|
-
resource_id: string;
|
|
797
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
798
|
-
user_id_type?: string;
|
|
799
|
-
}
|
|
800
|
-
export interface GetTaskV2AttachmentQuery {
|
|
801
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
802
|
-
user_id_type?: string;
|
|
803
|
-
}
|
|
804
|
-
export interface GetTaskV2AttachmentResponse {
|
|
805
|
-
/** 附件详情 */
|
|
806
|
-
attachment?: Attachment;
|
|
807
|
-
}
|
|
808
|
-
export interface CreateTaskV2SectionRequest {
|
|
809
|
-
/** 自定义分组名称 */
|
|
810
|
-
name: string;
|
|
811
|
-
/** 自定义分组归属的资源类型,支持"tasklist"或者"my_tasks" */
|
|
812
|
-
resource_type: string;
|
|
813
|
-
/** 自定义分组要归属的资源id */
|
|
814
|
-
resource_id?: string;
|
|
815
|
-
/** 要将新分组插入到自定义分分组的前面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */
|
|
816
|
-
insert_before?: string;
|
|
817
|
-
/** 要将新分组插入到自定义分分组的后面的目标分组的guid。insert_before/insert_after二选一。也可以都不设置。都不设置时表示将新分组查到对应容器的最前面。 */
|
|
818
|
-
insert_after?: string;
|
|
819
|
-
}
|
|
820
|
-
export interface CreateTaskV2SectionQuery {
|
|
821
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
822
|
-
user_id_type?: string;
|
|
823
|
-
}
|
|
824
|
-
export interface CreateTaskV2SectionResponse {
|
|
825
|
-
/** 创建的自定义分组数据 */
|
|
826
|
-
section?: Section;
|
|
827
|
-
}
|
|
828
|
-
export interface GetTaskV2SectionQuery {
|
|
829
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
830
|
-
user_id_type?: string;
|
|
831
|
-
}
|
|
832
|
-
export interface GetTaskV2SectionResponse {
|
|
833
|
-
/** 获取的自定义分组详情 */
|
|
834
|
-
section?: Section;
|
|
835
|
-
}
|
|
836
|
-
export interface PatchTaskV2SectionRequest {
|
|
837
|
-
/** 要更新的自定义分组的数据,仅支持name, insert_after, insert_before */
|
|
838
|
-
section: InputSection;
|
|
839
|
-
/** 要更新的字段名 */
|
|
840
|
-
update_fields: string[];
|
|
841
|
-
}
|
|
842
|
-
export interface PatchTaskV2SectionQuery {
|
|
843
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
844
|
-
user_id_type?: string;
|
|
845
|
-
}
|
|
846
|
-
export interface PatchTaskV2SectionResponse {
|
|
847
|
-
/** 更新后的自定义分组 */
|
|
848
|
-
section?: Section;
|
|
849
|
-
}
|
|
850
|
-
export interface ListTaskV2SectionQuery extends Pagination {
|
|
851
|
-
/** 自定义分组所属的资源类型。支持"my_tasks"(我负责的)和"tasklist"(清单)。当使用"tasklist"时,需要用resource_id提供清单GUID。 */
|
|
852
|
-
resource_type: string;
|
|
853
|
-
/** 如`resource_type`为"tasklist",这里需要填写要列取自定义分组的清单的GUID。 */
|
|
854
|
-
resource_id?: string;
|
|
855
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
856
|
-
user_id_type?: string;
|
|
857
|
-
}
|
|
858
|
-
export interface TasksTaskV2SectionQuery extends Pagination {
|
|
859
|
-
/** 按照任务状态过滤,如果不填写则表示不按完成状态过滤 */
|
|
860
|
-
completed?: boolean;
|
|
861
|
-
/** 按照创建时间筛选的起始时间戳(ms),如不填写则为首个任务的创建时刻 */
|
|
862
|
-
created_from?: string;
|
|
863
|
-
/** 按照创建时间筛选的起始时间戳(ms),如不填写则为最后任务的创建时刻 */
|
|
864
|
-
created_to?: string;
|
|
865
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
866
|
-
user_id_type?: string;
|
|
867
|
-
}
|
|
868
|
-
export interface CreateTaskV2CustomFieldRequest {
|
|
869
|
-
/** 自定义字段要归属的资源类型,支持"tasklist" */
|
|
870
|
-
resource_type: string;
|
|
871
|
-
/** 自定义字段要归属的资源ID,可以填写清单的tasklist_guid */
|
|
872
|
-
resource_id: string;
|
|
873
|
-
/** 字段名称 */
|
|
874
|
-
name: string;
|
|
875
|
-
/** 自定义字段类型,支持"number", "datetime", "member", "single_select", "multi_select" */
|
|
876
|
-
type: 'number' | 'datetime' | 'member' | 'single_select' | 'multi_select' | 'text';
|
|
877
|
-
/** 数字类型的字段设置 */
|
|
878
|
-
number_setting?: NumberSetting;
|
|
879
|
-
/** 人员类型的字段设置 */
|
|
880
|
-
member_setting?: MemberSetting;
|
|
881
|
-
/** 时间日期类型的字段设置 */
|
|
882
|
-
datetime_setting?: DatetimeSetting;
|
|
883
|
-
/** 单选设置 */
|
|
884
|
-
single_select_setting?: SelectSetting;
|
|
885
|
-
/** 多选设置 */
|
|
886
|
-
multi_select_setting?: SelectSetting;
|
|
887
|
-
/** 文本类型 */
|
|
888
|
-
text_setting?: TextSetting;
|
|
889
|
-
}
|
|
890
|
-
export interface CreateTaskV2CustomFieldQuery {
|
|
891
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
892
|
-
user_id_type?: 'open_id' | 'user_id' | 'union_id';
|
|
893
|
-
}
|
|
894
|
-
export interface CreateTaskV2CustomFieldResponse {
|
|
895
|
-
/** 创建的自定义字段 */
|
|
896
|
-
custom_field?: CustomField;
|
|
897
|
-
}
|
|
898
|
-
export interface GetTaskV2CustomFieldQuery {
|
|
899
|
-
/** 表示user的ID的类型,支持open_id, user_id, union_id */
|
|
900
|
-
user_id_type?: 'open_id' | 'user_id' | 'union_id';
|
|
901
|
-
}
|
|
902
|
-
export interface GetTaskV2CustomFieldResponse {
|
|
903
|
-
/** 获取的自定义字段数据 */
|
|
904
|
-
custom_field?: CustomField;
|
|
905
|
-
}
|
|
906
|
-
export interface PatchTaskV2CustomFieldRequest {
|
|
907
|
-
/** 要修改的自定义字段数据 */
|
|
908
|
-
custom_field?: InputCustomField;
|
|
909
|
-
/** 要修改的自定义字段类型,支持name, member_setting, number_setting, datetime_setting, single_select_setting, multi_select_setting */
|
|
910
|
-
update_fields?: string[];
|
|
911
|
-
}
|
|
912
|
-
export interface PatchTaskV2CustomFieldQuery {
|
|
913
|
-
/** 用户ID格式 */
|
|
914
|
-
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
915
|
-
}
|
|
916
|
-
export interface PatchTaskV2CustomFieldResponse {
|
|
917
|
-
/** 修改后的自定义字段设置 */
|
|
918
|
-
custom_field?: CustomField;
|
|
919
|
-
}
|
|
920
|
-
export interface ListTaskV2CustomFieldQuery extends Pagination {
|
|
921
|
-
/** 用户ID格式,支持open_id, user_id, union_id */
|
|
922
|
-
user_id_type?: 'open_id' | 'user_id' | 'union_id';
|
|
923
|
-
/** 资源类型,如提供表示仅查询特定资源下的自定义字段。目前只支持tasklist。 */
|
|
924
|
-
resource_type?: string;
|
|
925
|
-
/** 要查询自定义字段的归属resource_id */
|
|
926
|
-
resource_id?: string;
|
|
927
|
-
}
|
|
928
|
-
export interface AddTaskV2CustomFieldRequest {
|
|
929
|
-
/** 要将自定义字段添加到一个资源的资源类型。目前只支持tasklist */
|
|
930
|
-
resource_type: string;
|
|
931
|
-
/** 要将自定义字段添加到的资源id,目前只支持tasklist_guid */
|
|
932
|
-
resource_id: string;
|
|
933
|
-
}
|
|
934
|
-
export interface RemoveTaskV2CustomFieldRequest {
|
|
935
|
-
/** 要从某个资源移除自定义字段的资源类型,目前只支持清单"tasklist"。 */
|
|
936
|
-
resource_type: string;
|
|
937
|
-
/** 要从某个资源移除自定义字段的资源id,`resource_type`为"tasklist"时,需填写清单的GUID */
|
|
938
|
-
resource_id: string;
|
|
939
|
-
}
|
|
940
|
-
export interface CreateTaskV2CustomFieldOptionRequest {
|
|
941
|
-
/** 选项名 */
|
|
942
|
-
name: string;
|
|
943
|
-
/** 颜色索引值,支持0~54中的一个数字。如果不填写,则会随机选一个。 */
|
|
944
|
-
color_index?: number;
|
|
945
|
-
/** 要放到某个option之前的option_guid */
|
|
946
|
-
insert_before?: string;
|
|
947
|
-
/** 要放到某个option之后的option_guid */
|
|
948
|
-
insert_after?: string;
|
|
949
|
-
/** 是否隐藏 */
|
|
950
|
-
is_hidden?: boolean;
|
|
951
|
-
}
|
|
952
|
-
export interface CreateTaskV2CustomFieldOptionResponse {
|
|
953
|
-
/** 创建的选项 */
|
|
954
|
-
option?: Option;
|
|
955
|
-
}
|
|
956
|
-
export interface PatchTaskV2CustomFieldOptionRequest {
|
|
957
|
-
/** 要更新的option数据 */
|
|
958
|
-
option?: InputOption;
|
|
959
|
-
/** 要更新的字段名,支持name,color,is_hidden,insert_before,insert_after */
|
|
960
|
-
update_fields?: string[];
|
|
961
|
-
}
|
|
962
|
-
export interface PatchTaskV2CustomFieldOptionResponse {
|
|
963
|
-
/** 更新后的option数据 */
|
|
964
|
-
option?: Option;
|
|
965
|
-
}
|
|
966
|
-
export interface CreateTaskV1Request {
|
|
967
|
-
/** 任务标题。创建任务时,如果没有标题填充,将其视为无主题的任务。 */
|
|
968
|
-
summary?: string;
|
|
969
|
-
/** 任务备注 */
|
|
970
|
-
description?: string;
|
|
971
|
-
/** 接入方可以自定义的附属信息二进制格式,采用 base64 编码,解析方式由接入方自己决定 */
|
|
972
|
-
extra?: string;
|
|
973
|
-
/** 任务的截止时间设置 */
|
|
974
|
-
due?: Due;
|
|
975
|
-
/** 任务关联的第三方平台来源信息 */
|
|
976
|
-
origin: Origin;
|
|
977
|
-
/** 此字段用于控制该任务在任务中心是否可编辑,默认为false,若为true则第三方需考虑是否需要接入事件来接收任务在任务中心的变更信息 */
|
|
978
|
-
can_edit?: boolean;
|
|
979
|
-
/** 此字段用于存储第三方需透传到端上的自定义数据,Json格式。取值举例中custom_complete字段存储「完成」按钮的跳转链接(href)或提示信息(tip),pc、ios、android三端均可自定义,其中tip字段的key为语言类型,value为提示信息,可自行增加或减少语言类型,支持的各地区语言名:it_it, th_th, ko_kr, es_es, ja_jp, zh_cn, id_id, zh_hk, pt_br, de_de, fr_fr, zh_tw, ru_ru, en_us, hi_in, vi_vn。href的优先级高于tip,href和tip同时不为空时只跳转不提示。链接和提示信息可自定义,其余的key需按举例中的结构传递 */
|
|
980
|
-
custom?: string;
|
|
981
|
-
/** 创建任务时添加的执行者用户id列表 */
|
|
982
|
-
collaborator_ids?: string[];
|
|
983
|
-
/** 创建任务时添加的关注者用户id列表 */
|
|
984
|
-
follower_ids?: string[];
|
|
985
|
-
/** 重复任务重复规则 */
|
|
986
|
-
repeat_rule?: string;
|
|
987
|
-
/** 富文本任务标题。创建任务时,如果没有标题填充,将其视为无主题的任务。 */
|
|
988
|
-
rich_summary?: string;
|
|
989
|
-
/** 富文本任务备注 */
|
|
990
|
-
rich_description?: string;
|
|
991
|
-
}
|
|
992
|
-
export interface CreateTaskV1Query {
|
|
993
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
994
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
995
|
-
}
|
|
996
|
-
export interface CreateTaskV1Response {
|
|
997
|
-
/** 返回创建好的任务 */
|
|
998
|
-
task?: Task;
|
|
999
|
-
}
|
|
1000
|
-
export interface PatchTaskV1Request {
|
|
1001
|
-
/** 被更新的任务实体基础信息 */
|
|
1002
|
-
task: Task;
|
|
1003
|
-
/** 指定需要更新的字段(目前可选更新的字段为:summary, description, due, extra),否则服务端将不知道更新哪些字段 */
|
|
1004
|
-
update_fields: string[];
|
|
1005
|
-
}
|
|
1006
|
-
export interface PatchTaskV1Query {
|
|
1007
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1008
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1009
|
-
}
|
|
1010
|
-
export interface PatchTaskV1Response {
|
|
1011
|
-
/** 返回修改后的任务详情 */
|
|
1012
|
-
task?: Task;
|
|
1013
|
-
}
|
|
1014
|
-
export interface GetTaskV1Query {
|
|
1015
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1016
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1017
|
-
}
|
|
1018
|
-
export interface GetTaskV1Response {
|
|
1019
|
-
/** 返回任务资源详情 */
|
|
1020
|
-
task?: Task;
|
|
1021
|
-
}
|
|
1022
|
-
export interface ListTaskV1Query extends Pagination {
|
|
1023
|
-
/** 范围查询任务时,查询的起始时间。不填时默认起始时间为第一个任务的创建时间。 */
|
|
1024
|
-
start_create_time?: string;
|
|
1025
|
-
/** 范围查询任务时,查询的结束时间。不填时默认结束时间为最后一个任务的创建时间。 */
|
|
1026
|
-
end_create_time?: string;
|
|
1027
|
-
/** 可用于查询时过滤任务完成状态。true表示只返回已完成的任务,false表示只返回未完成的任务。不填时表示同时返回两种完成状态的任务。 */
|
|
1028
|
-
task_completed?: boolean;
|
|
1029
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1030
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1031
|
-
}
|
|
1032
|
-
export interface CreateTaskV1TaskReminderRequest {
|
|
1033
|
-
/** 相对于截止时间的提醒时间(如提前 30 分钟,截止时间后 30 分钟,则为 -30) */
|
|
1034
|
-
relative_fire_minute: number;
|
|
1035
|
-
}
|
|
1036
|
-
export interface CreateTaskV1TaskReminderResponse {
|
|
1037
|
-
/** 返回创建成功的提醒时间 */
|
|
1038
|
-
reminder?: Reminder;
|
|
1039
|
-
}
|
|
1040
|
-
export interface CreateTaskV1TaskCommentRequest {
|
|
1041
|
-
/** 评论内容 */
|
|
1042
|
-
content?: string;
|
|
1043
|
-
/** 评论的父ID,创建评论时若不为空则为某条评论的回复,若为空则不是回复 */
|
|
1044
|
-
parent_id?: string;
|
|
1045
|
-
/** 评论创建的时间戳,单位为毫秒,用于展示,创建时不用填写 */
|
|
1046
|
-
create_milli_time?: string;
|
|
1047
|
-
/** 富文本评论内容 */
|
|
1048
|
-
rich_content?: string;
|
|
1049
|
-
}
|
|
1050
|
-
export interface CreateTaskV1TaskCommentQuery {
|
|
1051
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1052
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1053
|
-
}
|
|
1054
|
-
export interface CreateTaskV1TaskCommentResponse {
|
|
1055
|
-
/** 返回创建好的任务评论 */
|
|
1056
|
-
comment?: Comment;
|
|
1057
|
-
}
|
|
1058
|
-
export interface UpdateTaskV1TaskCommentRequest {
|
|
1059
|
-
/** 新的评论内容 */
|
|
1060
|
-
content?: string;
|
|
1061
|
-
/** 新的富文本评论内容(优先使用) */
|
|
1062
|
-
rich_content?: string;
|
|
1063
|
-
}
|
|
1064
|
-
export interface UpdateTaskV1TaskCommentQuery {
|
|
1065
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1066
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1067
|
-
}
|
|
1068
|
-
export interface UpdateTaskV1TaskCommentResponse {
|
|
1069
|
-
/** 返回修改后的任务评论详情 */
|
|
1070
|
-
comment?: Comment;
|
|
1071
|
-
}
|
|
1072
|
-
export interface GetTaskV1TaskCommentQuery {
|
|
1073
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1074
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1075
|
-
}
|
|
1076
|
-
export interface GetTaskV1TaskCommentResponse {
|
|
1077
|
-
/** 返回新的任务评论详情 */
|
|
1078
|
-
comment?: Comment;
|
|
1079
|
-
}
|
|
1080
|
-
export declare const enum ListTaskV1TaskCommentQueryListDirection {
|
|
1081
|
-
/** 按照回复时间从小到大查询 */
|
|
1082
|
-
Down = 0,
|
|
1083
|
-
/** 按照回复时间从大到小查询 */
|
|
1084
|
-
Up = 1
|
|
1085
|
-
}
|
|
1086
|
-
export interface ListTaskV1TaskCommentQuery extends Pagination {
|
|
1087
|
-
/** 评论排序标记,可按照评论时间从小到大查询,或者评论时间从大到小查询,不填默认按照从小到大 */
|
|
1088
|
-
list_direction?: ListTaskV1TaskCommentQueryListDirection;
|
|
1089
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1090
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1091
|
-
}
|
|
1092
|
-
export interface CreateTaskV1TaskFollowerRequest {
|
|
1093
|
-
/** 任务关注者 ID */
|
|
1094
|
-
id?: string;
|
|
1095
|
-
/** 要添加为关注人的user_id */
|
|
1096
|
-
id_list?: string[];
|
|
1097
|
-
}
|
|
1098
|
-
export interface CreateTaskV1TaskFollowerQuery {
|
|
1099
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1100
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1101
|
-
}
|
|
1102
|
-
export interface CreateTaskV1TaskFollowerResponse {
|
|
1103
|
-
/** 创建后的任务关注者 */
|
|
1104
|
-
follower: Follower;
|
|
1105
|
-
}
|
|
1106
|
-
export interface DeleteTaskV1TaskFollowerQuery {
|
|
1107
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1108
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1109
|
-
}
|
|
1110
|
-
export interface BatchDeleteFollowerTaskV1Request {
|
|
1111
|
-
/** 要添加为关注人的user_id */
|
|
1112
|
-
id_list?: string[];
|
|
1113
|
-
}
|
|
1114
|
-
export interface BatchDeleteFollowerTaskV1Query {
|
|
1115
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1116
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1117
|
-
}
|
|
1118
|
-
export interface BatchDeleteFollowerTaskV1Response {
|
|
1119
|
-
/** 实际删除的关注人用户ID列表 */
|
|
1120
|
-
followers?: string[];
|
|
1121
|
-
}
|
|
1122
|
-
export interface ListTaskV1TaskFollowerQuery extends Pagination {
|
|
1123
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1124
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1125
|
-
}
|
|
1126
|
-
export interface CreateTaskV1TaskCollaboratorRequest {
|
|
1127
|
-
/** 任务协作者的 ID */
|
|
1128
|
-
id?: string;
|
|
1129
|
-
/** 协作人的用户ID列表 */
|
|
1130
|
-
id_list?: string[];
|
|
1131
|
-
}
|
|
1132
|
-
export interface CreateTaskV1TaskCollaboratorQuery {
|
|
1133
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1134
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1135
|
-
}
|
|
1136
|
-
export interface CreateTaskV1TaskCollaboratorResponse {
|
|
1137
|
-
/** 返回创建成功后的任务协作者 */
|
|
1138
|
-
collaborator: Collaborator;
|
|
1139
|
-
}
|
|
1140
|
-
export interface DeleteTaskV1TaskCollaboratorQuery {
|
|
1141
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1142
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1143
|
-
}
|
|
1144
|
-
export interface BatchDeleteCollaboratorTaskV1Request {
|
|
1145
|
-
/** 协作人的用户ID列表 */
|
|
1146
|
-
id_list?: string[];
|
|
1147
|
-
}
|
|
1148
|
-
export interface BatchDeleteCollaboratorTaskV1Query {
|
|
1149
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1150
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1151
|
-
}
|
|
1152
|
-
export interface BatchDeleteCollaboratorTaskV1Response {
|
|
1153
|
-
/** 实际删除的执行人用户ID列表 */
|
|
1154
|
-
collaborators?: string[];
|
|
1155
|
-
}
|
|
1156
|
-
export interface ListTaskV1TaskCollaboratorQuery extends Pagination {
|
|
1157
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
1158
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
1159
1070
|
}
|