@satorijs/adapter-lark 3.10.6 → 3.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. package/lib/content.d.ts +211 -93
  2. package/lib/index.cjs +2954 -2474
  3. package/lib/internal.d.ts +4 -4
  4. package/lib/message.d.ts +2 -3
  5. package/lib/types/acs.d.ts +212 -172
  6. package/lib/types/admin.d.ts +331 -291
  7. package/lib/types/aily.d.ts +331 -216
  8. package/lib/types/apaas.d.ts +646 -494
  9. package/lib/types/application.d.ts +559 -458
  10. package/lib/types/approval.d.ts +826 -791
  11. package/lib/types/attendance.d.ts +1094 -994
  12. package/lib/types/auth.d.ts +66 -61
  13. package/lib/types/authen.d.ts +221 -186
  14. package/lib/types/baike.d.ts +258 -233
  15. package/lib/types/base.d.ts +74 -0
  16. package/lib/types/bitable.d.ts +830 -770
  17. package/lib/types/board.d.ts +29 -14
  18. package/lib/types/calendar.d.ts +660 -605
  19. package/lib/types/cardkit.d.ts +149 -134
  20. package/lib/types/compensation.d.ts +84 -49
  21. package/lib/types/contact.d.ts +1279 -1204
  22. package/lib/types/corehr.d.ts +4982 -4526
  23. package/lib/types/directory.d.ts +447 -0
  24. package/lib/types/docs.d.ts +28 -18
  25. package/lib/types/document_ai.d.ts +347 -252
  26. package/lib/types/docx.d.ts +428 -383
  27. package/lib/types/drive.d.ts +1093 -1048
  28. package/lib/types/ehr.d.ts +66 -51
  29. package/lib/types/event.d.ts +16 -6
  30. package/lib/types/helpdesk.d.ts +816 -741
  31. package/lib/types/hire.d.ts +3955 -3589
  32. package/lib/types/human_authentication.d.ts +32 -22
  33. package/lib/types/im.d.ts +1420 -1295
  34. package/lib/types/index.d.ts +1422 -330
  35. package/lib/types/lingo.d.ts +279 -249
  36. package/lib/types/mail.d.ts +1032 -675
  37. package/lib/types/mdm.d.ts +105 -37
  38. package/lib/types/minutes.d.ts +73 -26
  39. package/lib/types/moments.d.ts +23 -13
  40. package/lib/types/okr.d.ts +266 -225
  41. package/lib/types/optical_char_recognition.d.ts +22 -12
  42. package/lib/types/passport.d.ts +58 -48
  43. package/lib/types/payroll.d.ts +210 -53
  44. package/lib/types/performance.d.ts +463 -414
  45. package/lib/types/personal_settings.d.ts +93 -82
  46. package/lib/types/report.d.ts +79 -58
  47. package/lib/types/search.d.ts +265 -235
  48. package/lib/types/security_and_compliance.d.ts +30 -19
  49. package/lib/types/sheets.d.ts +356 -321
  50. package/lib/types/speech_to_text.d.ts +44 -34
  51. package/lib/types/task.d.ts +998 -1087
  52. package/lib/types/tenant.d.ts +25 -15
  53. package/lib/types/translation.d.ts +42 -32
  54. package/lib/types/trust_party.d.ts +81 -0
  55. package/lib/types/vc.d.ts +1218 -1123
  56. package/lib/types/verification.d.ts +11 -6
  57. package/lib/types/wiki.d.ts +270 -235
  58. package/lib/types/workplace.d.ts +58 -38
  59. package/lib/utils.d.ts +2 -2
  60. package/package.json +4 -4
  61. package/src/bot.ts +15 -15
  62. package/src/content.ts +230 -107
  63. package/src/internal.ts +29 -12
  64. package/src/message.ts +82 -111
  65. package/src/types/acs.ts +234 -186
  66. package/src/types/admin.ts +353 -305
  67. package/src/types/aily.ts +375 -233
  68. package/src/types/apaas.ts +754 -568
  69. package/src/types/application.ts +633 -507
  70. package/src/types/approval.ts +914 -872
  71. package/src/types/attendance.ts +1226 -1104
  72. package/src/types/auth.ts +72 -66
  73. package/src/types/authen.ts +233 -191
  74. package/src/types/baike.ts +276 -246
  75. package/src/types/base.ts +93 -0
  76. package/src/types/bitable.ts +966 -894
  77. package/src/types/board.ts +34 -16
  78. package/src/types/calendar.ts +751 -685
  79. package/src/types/cardkit.ts +164 -146
  80. package/src/types/compensation.ts +97 -55
  81. package/src/types/contact.ts +1465 -1375
  82. package/src/types/corehr.ts +5664 -5077
  83. package/src/types/directory.ts +569 -0
  84. package/src/types/docs.ts +31 -19
  85. package/src/types/document_ai.ts +401 -287
  86. package/src/types/docx.ts +492 -438
  87. package/src/types/drive.ts +1266 -1213
  88. package/src/types/ehr.ts +71 -53
  89. package/src/types/event.ts +19 -7
  90. package/src/types/helpdesk.ts +930 -840
  91. package/src/types/hire.ts +4453 -4019
  92. package/src/types/human_authentication.ts +35 -23
  93. package/src/types/im.ts +1626 -1476
  94. package/src/types/index.ts +1532 -346
  95. package/src/types/lingo.ts +299 -263
  96. package/src/types/mail.ts +1231 -779
  97. package/src/types/mdm.ts +122 -39
  98. package/src/types/minutes.ts +88 -28
  99. package/src/types/moments.ts +26 -14
  100. package/src/types/okr.ts +286 -238
  101. package/src/types/optical_char_recognition.ts +25 -13
  102. package/src/types/passport.ts +62 -50
  103. package/src/types/payroll.ts +254 -57
  104. package/src/types/performance.ts +528 -467
  105. package/src/types/personal_settings.ts +101 -89
  106. package/src/types/report.ts +86 -62
  107. package/src/types/search.ts +285 -249
  108. package/src/types/security_and_compliance.ts +33 -21
  109. package/src/types/sheets.ts +421 -379
  110. package/src/types/speech_to_text.ts +48 -36
  111. package/src/types/task.ts +1152 -1260
  112. package/src/types/tenant.ts +29 -17
  113. package/src/types/translation.ts +46 -34
  114. package/src/types/trust_party.ts +110 -0
  115. package/src/types/vc.ts +1397 -1283
  116. package/src/types/verification.ts +13 -7
  117. package/src/types/wiki.ts +293 -251
  118. package/src/types/workplace.ts +65 -41
  119. package/src/utils.ts +3 -3
@@ -1,960 +1,1002 @@
1
- import { ApprovalConfig, ApprovalCreateExternal, ApprovalCreateViewers, ApprovalForm, ApprovalNode, ApprovalNodeInfo, ApprovalSetting, ApprovalViewerInfo, CcNode, CcSearchItem, Comment, CommentAtInfo, Count, ExteranlInstanceCheck, ExteranlInstanceCheckResponse, ExternalInstance, ExternalInstanceForm, ExternalInstanceLink, ExternalInstanceTaskNode, ExternalTaskList, I18nResource, InstanceComment, InstanceSearchItem, InstanceTask, InstanceTimeline, NodeApprover, NodeAutoApproval, NodeCc, PreviewNode, Task, TaskSearchItem, TrusteeshipInstanceCacheConfig, TrusteeshipUrls } from '.'
2
- import { Internal, Pagination } from '../internal'
1
+ import * as Lark from '.'
2
+ import { Internal, Paginated, Pagination } from '../internal'
3
3
 
4
4
  declare module '../internal' {
5
5
  interface Internal {
6
+ approval: Approval.Methods
7
+ }
8
+ }
9
+
10
+ export namespace Approval {
11
+ export interface Methods {
12
+ instance: Instance.Methods
13
+ task: Task.Methods
14
+ externalApproval: ExternalApproval.Methods
15
+ externalInstance: ExternalInstance.Methods
16
+ externalTask: ExternalTask.Methods
6
17
  /**
7
18
  * 创建审批定义
8
19
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/create
9
20
  */
10
- createApproval(body: CreateApprovalRequest, query?: CreateApprovalQuery): Promise<CreateApprovalResponse>
21
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
11
22
  /**
12
23
  * 查看指定审批定义
13
24
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/get
14
25
  */
15
- getApproval(approval_code: string, query?: GetApprovalQuery): Promise<GetApprovalResponse>
16
- /**
17
- * 创建审批实例
18
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/create
19
- */
20
- createApprovalInstance(body: CreateApprovalInstanceRequest): Promise<CreateApprovalInstanceResponse>
21
- /**
22
- * 撤回审批实例
23
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cancel
24
- */
25
- cancelApprovalInstance(body: CancelApprovalInstanceRequest, query?: CancelApprovalInstanceQuery): Promise<void>
26
- /**
27
- * 抄送审批实例
28
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cc
29
- */
30
- ccApprovalInstance(body: CcApprovalInstanceRequest, query?: CcApprovalInstanceQuery): Promise<void>
31
- /**
32
- * 预览审批流程
33
- * @see https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-preview
34
- */
35
- previewApprovalInstance(body: PreviewApprovalInstanceRequest, query?: PreviewApprovalInstanceQuery): Promise<PreviewApprovalInstanceResponse>
36
- /**
37
- * 获取单个审批实例详情
38
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get
39
- */
40
- getApprovalInstance(instance_id: string, query?: GetApprovalInstanceQuery): Promise<GetApprovalInstanceResponse>
41
- /**
42
- * 批量获取审批实例 ID
43
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list
44
- */
45
- listApprovalInstance(query?: ListApprovalInstanceQuery): Paginated<string, 'instance_code_list'>
46
- /**
47
- * 同意审批任务
48
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/approve
49
- */
50
- approveApprovalTask(body: ApproveApprovalTaskRequest, query?: ApproveApprovalTaskQuery): Promise<void>
51
- /**
52
- * 拒绝审批任务
53
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/reject
54
- */
55
- rejectApprovalTask(body: RejectApprovalTaskRequest, query?: RejectApprovalTaskQuery): Promise<void>
56
- /**
57
- * 转交审批任务
58
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/transfer
59
- */
60
- transferApprovalTask(body: TransferApprovalTaskRequest, query?: TransferApprovalTaskQuery): Promise<void>
61
- /**
62
- * 退回审批任务
63
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback
64
- */
65
- specifiedRollbackApprovalInstance(body: SpecifiedRollbackApprovalInstanceRequest, query?: SpecifiedRollbackApprovalInstanceQuery): Promise<void>
66
- /**
67
- * 审批任务加签
68
- * @see https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-task-addsign
69
- */
70
- addSignApprovalInstance(body: AddSignApprovalInstanceRequest): Promise<void>
71
- /**
72
- * 重新提交审批任务
73
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/resubmit
74
- */
75
- resubmitApprovalTask(body: ResubmitApprovalTaskRequest, query?: ResubmitApprovalTaskQuery): Promise<void>
76
- /**
77
- * 创建评论
78
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/create
79
- */
80
- createApprovalInstanceComment(instance_id: string, body: CreateApprovalInstanceCommentRequest, query?: CreateApprovalInstanceCommentQuery): Promise<CreateApprovalInstanceCommentResponse>
81
- /**
82
- * 删除评论
83
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/delete
84
- */
85
- deleteApprovalInstanceComment(instance_id: string, comment_id: string, query?: DeleteApprovalInstanceCommentQuery): Promise<DeleteApprovalInstanceCommentResponse>
86
- /**
87
- * 清空评论
88
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/remove
89
- */
90
- removeApprovalInstanceComment(instance_id: string, query?: RemoveApprovalInstanceCommentQuery): Promise<RemoveApprovalInstanceCommentResponse>
91
- /**
92
- * 获取评论
93
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/list
94
- */
95
- listApprovalInstanceComment(instance_id: string, query?: ListApprovalInstanceCommentQuery): Promise<ListApprovalInstanceCommentResponse>
96
- /**
97
- * 创建三方审批定义
98
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/create
99
- */
100
- createApprovalExternalApproval(body: CreateApprovalExternalApprovalRequest, query?: CreateApprovalExternalApprovalQuery): Promise<CreateApprovalExternalApprovalResponse>
101
- /**
102
- * 查看指定三方审批定义
103
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/get
104
- */
105
- getApprovalExternalApproval(approval_code: string, query?: GetApprovalExternalApprovalQuery): Promise<GetApprovalExternalApprovalResponse>
106
- /**
107
- * 同步三方审批实例
108
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/create
109
- */
110
- createApprovalExternalInstance(body: CreateApprovalExternalInstanceRequest): Promise<CreateApprovalExternalInstanceResponse>
111
- /**
112
- * 校验三方审批实例
113
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/check
114
- */
115
- checkApprovalExternalInstance(body: CheckApprovalExternalInstanceRequest): Promise<CheckApprovalExternalInstanceResponse>
116
- /**
117
- * 获取三方审批任务状态
118
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list
119
- */
120
- listApprovalExternalTask(body: ListApprovalExternalTaskRequest, query?: Pagination): Paginated<ExternalTaskList, 'data'>
121
- /**
122
- * 查询实例列表
123
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query
124
- */
125
- queryApprovalInstance(body: QueryApprovalInstanceRequest, query?: QueryApprovalInstanceQuery): Promise<QueryApprovalInstanceResponse> & AsyncIterableIterator<InstanceSearchItem>
126
- /**
127
- * 查询抄送列表
128
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc
129
- */
130
- searchCcApprovalInstance(body: SearchCcApprovalInstanceRequest, query?: SearchCcApprovalInstanceQuery): Promise<SearchCcApprovalInstanceResponse> & AsyncIterableIterator<CcSearchItem>
131
- /**
132
- * 查询任务列表
133
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search
134
- */
135
- searchApprovalTask(body: SearchApprovalTaskRequest, query?: SearchApprovalTaskQuery): Promise<SearchApprovalTaskResponse> & AsyncIterableIterator<TaskSearchItem>
136
- /**
137
- * 查询用户的任务列表
138
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/query
139
- */
140
- queryApprovalTask(query?: QueryApprovalTaskQuery): Promise<QueryApprovalTaskResponse> & AsyncIterableIterator<Task>
26
+ get(approval_code: string, query?: GetQuery): Promise<GetResponse>
141
27
  /**
142
28
  * 订阅审批事件
143
29
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/subscribe
144
30
  */
145
- subscribeApproval(approval_code: string): Promise<void>
31
+ subscribe(approval_code: string): Promise<void>
146
32
  /**
147
33
  * 取消订阅审批事件
148
34
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/unsubscribe
149
35
  */
150
- unsubscribeApproval(approval_code: string): Promise<void>
36
+ unsubscribe(approval_code: string): Promise<void>
151
37
  }
152
- }
153
-
154
- export interface CreateApprovalRequest {
155
- /** 审批名称的国际化文案 Key,以 @i18n@ 开头,长度不得少于 9 个字符 */
156
- approval_name: string
157
- /** 传空表示新建 */
158
- approval_code?: string
159
- /** 审批描述的国际化文案 Key,以 @i18n@ 开头,长度不得少于 9 个字符 */
160
- description?: string
161
- /** viewers 字段指定了哪些人能从审批应用的前台发起该审批。 当 view_type 为 USER,需要填写viewer_user_id; 当 view_type 为DEPARTMENT,需要填写viewer_department_id; 当 view_type 为TENANT或NONE时,viewer_user_id和viewer_department_id无需填写 */
162
- viewers: ApprovalCreateViewers[]
163
- /** 审批定义表单内容,json 数组 */
164
- form: ApprovalForm
165
- /** 审批定义节点,需要将开始节点作为 list 第一个元素,结束节点作为最后一个元素 */
166
- node_list: ApprovalNode[]
167
- /** 审批定义其他设置 */
168
- settings?: ApprovalSetting
169
- /** 审批定义配置项,用于配置对应审批定义是否可以由用户在审批后台进行修改 */
170
- config?: ApprovalConfig
171
- /** 审批图标枚举,详见下方说明,默认为 0 */
172
- icon?: number
173
- /** 国际化文案 */
174
- i18n_resources: I18nResource[]
175
- /** 流程负责人 */
176
- process_manager_ids?: string[]
177
- }
178
-
179
- export interface CreateApprovalQuery {
180
- /** 此次调用中使用的部门ID的类型 */
181
- department_id_type?: 'department_id' | 'open_department_id'
182
- /** 此次调用中使用的用户ID的类型 */
183
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
184
- }
185
-
186
- export interface CreateApprovalResponse {
187
- /** 审批定义 Code */
188
- approval_code?: string
189
- /** 审批定义 id */
190
- approval_id?: string
191
- }
192
-
193
- export interface GetApprovalQuery {
194
- /** 语言可选值 */
195
- locale?: 'zh-CN' | 'en-US' | 'ja-JP'
196
- /** 可选是否返回有数据权限审批流程管理员ID列表 */
197
- with_admin_id?: boolean
198
- /** 此次调用中使用的用户ID的类型 */
199
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
200
- }
201
-
202
- export interface GetApprovalResponse {
203
- /** 审批名称 */
204
- approval_name: string
205
- /** 审批定义状态 */
206
- status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'UNKNOWN'
207
- /** 控件信息 */
208
- form: string
209
- /** 节点信息 */
210
- node_list: ApprovalNodeInfo[]
211
- /** 可见人列表 */
212
- viewers: ApprovalViewerInfo[]
213
- /** 有数据管理权限的审批流程管理员ID */
214
- approval_admin_ids?: string[]
215
- /** 组件之间值关联关系 */
216
- form_widget_relation?: string
217
- }
218
-
219
- export const enum CreateApprovalInstanceRequestTitleDisplayMethod {
220
- /** 如果都有title,展示approval 和instance的title,竖线分割。 */
221
- DisplayAll = 0,
222
- /** 如果都有title,只展示instance的title */
223
- DisplayInstanceTitle = 1,
224
- }
225
-
226
- export interface CreateApprovalInstanceRequest {
227
- /** 审批定义 code */
228
- approval_code: string
229
- /** 发起审批用户 */
230
- user_id?: string
231
- /** 发起审批用户 open id, 如果传了 user_id 则优先使用 user_id */
232
- open_id?: string
233
- /** 发起审批用户部门id,如果用户只属于一个部门,可以不填。如果属于多个部门,默认会选择部门列表第一个部门 */
234
- department_id?: string
235
- /** json 数组,控件值 */
236
- form: string
237
- /** 如果有发起人自选节点,则需要填写对应节点的审批人 */
238
- node_approver_user_id_list?: NodeApprover[]
239
- /** 审批人发起人自选 open id,与上述node_approver_user_id_list字段取并集 */
240
- node_approver_open_id_list?: NodeApprover[]
241
- /** 如果有发起人自选节点,则可填写对应节点的抄送人,单个节点最多选择20位抄送人 */
242
- node_cc_user_id_list?: NodeCc[]
243
- /** 抄送人发起人自选 open id 单个节点最多选择20位抄送人 */
244
- node_cc_open_id_list?: NodeCc[]
245
- /** 审批实例 uuid,用于幂等操作, 每个租户下面的唯一key,同一个 uuid 只能用于创建一个审批实例,如果冲突,返回错误码 60012 ,格式建议为 XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX,不区分大小写 */
246
- uuid?: string
247
- /** 可配置是否可以再次提交 */
248
- allow_resubmit?: boolean
249
- /** 可配置是否可以重新提交 */
250
- allow_submit_again?: boolean
251
- /** 配置bot是否取消通知结果 */
252
- cancel_bot_notification?: string
253
- /** 配置是否可以禁止撤销 */
254
- forbid_revoke?: boolean
255
- /** 国际化文案 */
256
- i18n_resources?: I18nResource[]
257
- /** 审批展示名称,如果填写了该字段,则审批列表中的审批名称使用该字段,如果不填该字段,则审批名称使用审批定义的名称 */
258
- title?: string
259
- /** 详情页title展示模式 */
260
- title_display_method?: CreateApprovalInstanceRequestTitleDisplayMethod
261
- /** 自动通过节点ID */
262
- node_auto_approval_list?: NodeAutoApproval[]
263
- }
264
-
265
- export interface CreateApprovalInstanceResponse {
266
- /** 审批实例 Code */
267
- instance_code: string
268
- }
269
-
270
- export interface CancelApprovalInstanceRequest {
271
- /** 审批定义Code */
272
- approval_code: string
273
- /** 审批实例Code */
274
- instance_code: string
275
- /** 操作用户, 根据user_id_type填写 */
276
- user_id: string
277
- }
278
-
279
- export interface CancelApprovalInstanceQuery {
280
- /** 此次调用中使用的用户ID的类型 */
281
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
282
- }
283
-
284
- export interface CcApprovalInstanceRequest {
285
- /** 审批定义 code */
286
- approval_code: string
287
- /** 审批实例 code */
288
- instance_code: string
289
- /** 根据user_id_type填写发起抄送的人的用户id */
290
- user_id: string
291
- /** 根据user_id_type填写被抄送人的 用户id 列表 */
292
- cc_user_ids: string[]
293
- /** 抄送留言 */
294
- comment?: string
295
- }
296
-
297
- export interface CcApprovalInstanceQuery {
298
- /** 此次调用中使用的用户ID的类型 */
299
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
300
- }
301
38
 
302
- export interface PreviewApprovalInstanceRequest {
303
- /** 用户id */
304
- user_id: string
305
- /** 审批定义code */
306
- approval_code?: string
307
- /** 部门id */
308
- department_id?: string
309
- /** 表单数据 */
310
- form?: string
311
- /** 审批实例code */
312
- instance_code?: string
313
- /** 语言类型 */
314
- locale?: string
315
- /** 任务id */
316
- task_id?: string
317
- }
318
-
319
- export interface PreviewApprovalInstanceQuery {
320
- /** open_id(ou_开头),union_id(on_开头),user_id(字符串)。user_id_type不填默认为open_id */
321
- user_id_type?: 'open_id' | 'user_id' | 'union_id'
322
- }
323
-
324
- export interface PreviewApprovalInstanceResponse {
325
- /** 预览节点信息 */
326
- preview_nodes?: PreviewNode[]
327
- }
328
-
329
- export interface GetApprovalInstanceQuery {
330
- /** 语言 */
331
- locale?: 'zh-CN' | 'en-US' | 'ja-JP'
332
- /** 发起审批用户id,仅自建应用可返回 */
333
- user_id?: string
334
- /** 此次调用中使用的用户ID的类型 */
335
- user_id_type?: 'user_id' | 'open_id' | 'union_id'
336
- }
337
-
338
- export interface GetApprovalInstanceResponse {
339
- /** 审批名称 */
340
- approval_name: string
341
- /** 审批创建时间 */
342
- start_time?: string
343
- /** 审批完成时间,未完成为 0 */
344
- end_time: string
345
- /** 发起审批用户 */
346
- user_id: string
347
- /** 发起审批用户 open id */
348
- open_id: string
349
- /** 审批单编号 */
350
- serial_number: string
351
- /** 发起审批用户所在部门 */
352
- department_id: string
353
- /** 审批实例状态 */
354
- status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED'
355
- /** 用户的唯一标识id */
356
- uuid: string
357
- /** json字符串,控件值 */
358
- form: string
359
- /** 审批任务列表 */
360
- task_list: InstanceTask[]
361
- /** 评论列表 */
362
- comment_list: InstanceComment[]
363
- /** 审批动态 */
364
- timeline: InstanceTimeline[]
365
- /** 修改的原实例 code,仅在查询修改实例时显示该字段 */
366
- modified_instance_code?: string
367
- /** 撤销的原实例 code,仅在查询撤销实例时显示该字段 */
368
- reverted_instance_code?: string
369
- /** 审批定义 Code */
370
- approval_code: string
371
- /** 单据是否被撤销 */
372
- reverted?: boolean
373
- /** 审批实例 Code */
374
- instance_code: string
375
- }
376
-
377
- export interface ListApprovalInstanceQuery extends Pagination {
378
- /** 审批定义唯一标识 */
379
- approval_code: string
380
- /** 审批实例创建时间区间(毫秒) */
381
- start_time: string
382
- /** 审批实例创建时间区间(毫秒) */
383
- end_time: string
384
- }
385
-
386
- export interface ApproveApprovalTaskRequest {
387
- /** 审批定义 Code */
388
- approval_code: string
389
- /** 审批实例 Code */
390
- instance_code: string
391
- /** 根据user_id_type填写操作用户id */
392
- user_id: string
393
- /** 意见 */
394
- comment?: string
395
- /** 任务 ID, 审批实例详情task_list中id */
396
- task_id: string
397
- /** json 数组,控件值 */
398
- form?: string
399
- }
400
-
401
- export interface ApproveApprovalTaskQuery {
402
- /** 此次调用中使用的用户ID的类型 */
403
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
404
- }
405
-
406
- export interface RejectApprovalTaskRequest {
407
- /** 审批定义 Code */
408
- approval_code: string
409
- /** 审批实例 Code */
410
- instance_code: string
411
- /** 根据user_id_type填写操作用户id */
412
- user_id: string
413
- /** 意见 */
414
- comment?: string
415
- /** 任务 ID, 审批实例详情task_list中id */
416
- task_id: string
417
- /** json 数组,控件值 */
418
- form?: string
419
- }
420
-
421
- export interface RejectApprovalTaskQuery {
422
- /** 此次调用中使用的用户ID的类型 */
423
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
424
- }
425
-
426
- export interface TransferApprovalTaskRequest {
427
- /** 审批定义 Code */
428
- approval_code: string
429
- /** 审批实例 Code */
430
- instance_code: string
431
- /** 根据user_id_type填写操作用户id */
432
- user_id: string
433
- /** 意见 */
434
- comment?: string
435
- /** 根据user_id_type填写被转交人唯一 ID */
436
- transfer_user_id: string
437
- /** 任务 ID, 审批实例详情task_list中id */
438
- task_id: string
439
- }
440
-
441
- export interface TransferApprovalTaskQuery {
442
- /** 此次调用中使用的用户ID的类型 */
443
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
444
- }
445
-
446
- export interface SpecifiedRollbackApprovalInstanceRequest {
447
- /** 用户ID */
448
- user_id: string
449
- /** 回退的任务ID */
450
- task_id: string
451
- /** 退回原因 */
452
- reason?: string
453
- /** 扩展字段 */
454
- extra?: string
455
- /** 退回到节点列表 */
456
- task_def_key_list: string[]
457
- }
458
-
459
- export interface SpecifiedRollbackApprovalInstanceQuery {
460
- /** 此次调用中使用的用户ID的类型 */
461
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
462
- }
463
-
464
- export const enum AddSignApprovalInstanceRequestAddSignType {
465
- /** 前加签 */
466
- AddSignPre = 1,
467
- /** 后加签 */
468
- AddSignPost = 2,
469
- /** 并加签 */
470
- AddSignParallel = 3,
471
- }
472
-
473
- export const enum AddSignApprovalInstanceRequestApprovalMethod {
474
- /** 或签 */
475
- OrSign = 1,
476
- /** 会签 */
477
- AddSign = 2,
478
- /** 依次审批 */
479
- SequentialSign = 3,
480
- }
481
-
482
- export interface AddSignApprovalInstanceRequest {
483
- /** 操作用户id */
484
- user_id: string
485
- /** 审批定义code */
486
- approval_code: string
487
- /** 审批实例code */
488
- instance_code: string
489
- /** 任务id */
490
- task_id: string
491
- /** 意见 */
492
- comment?: string
493
- /** 被加签人id */
494
- add_sign_user_ids: string[]
495
- /** 1/2/3分别代表前加签/后加签/并加签 */
496
- add_sign_type: AddSignApprovalInstanceRequestAddSignType
497
- /** 仅在前加签、后加签时需要填写,1/2 分别代表或签/会签 */
498
- approval_method?: AddSignApprovalInstanceRequestApprovalMethod
499
- }
500
-
501
- export interface ResubmitApprovalTaskRequest {
502
- /** 审批定义 Code */
503
- approval_code: string
504
- /** 审批实例 Code */
505
- instance_code: string
506
- /** 根据user_id_type填写操作用户id */
507
- user_id: string
508
- /** 意见 */
509
- comment?: string
510
- /** 任务 ID, 审批实例详情task_list中id */
511
- task_id: string
512
- /** json 数组,控件值 */
513
- form: string
514
- }
515
-
516
- export interface ResubmitApprovalTaskQuery {
517
- /** 此次调用中使用的用户ID的类型 */
518
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
519
- }
520
-
521
- export interface CreateApprovalInstanceCommentRequest {
522
- /** 评论内容,包含艾特人、附件等 */
523
- content?: string
524
- /** 评论中艾特人信息 */
525
- at_info_list?: CommentAtInfo[]
526
- /** 父评论ID,如果是回复评论,需要传 */
527
- parent_comment_id?: string
528
- /** 评论ID,如果是编辑、删除一条评论,需要传 */
529
- comment_id?: string
530
- /** disable_bot=true只同步数据,不触发bot */
531
- disable_bot?: boolean
532
- /** 附加字段 */
533
- extra?: string
534
- }
535
-
536
- export interface CreateApprovalInstanceCommentQuery {
537
- /** 用户ID类型,不填默认为open_id */
538
- user_id_type?: 'open_id' | 'user_id' | 'union_id'
539
- /** 用户ID */
540
- user_id: string
541
- }
542
-
543
- export interface CreateApprovalInstanceCommentResponse {
544
- /** 保存成功的comment_id */
545
- comment_id: string
546
- }
547
-
548
- export interface DeleteApprovalInstanceCommentQuery {
549
- /** 用户ID类型,不填默认为open_id */
550
- user_id_type?: 'open_id' | 'user_id' | 'union_id'
551
- /** 根据user_id_type填写用户ID */
552
- user_id: string
553
- }
554
-
555
- export interface DeleteApprovalInstanceCommentResponse {
556
- /** 删除的评论ID */
557
- comment_id?: string
558
- }
559
-
560
- export interface RemoveApprovalInstanceCommentQuery {
561
- /** 用户ID类型,不填默认为open_id */
562
- user_id_type?: 'open_id' | 'user_id' | 'union_id'
563
- /** 根据user_id_type填写用户ID */
564
- user_id?: string
565
- }
566
-
567
- export interface RemoveApprovalInstanceCommentResponse {
568
- /** 审批实例code */
569
- instance_id?: string
570
- /** 租户自定义审批实例ID */
571
- external_id?: string
572
- }
573
-
574
- export interface ListApprovalInstanceCommentQuery extends Pagination {
575
- /** 用户ID类型,不填默认为open_id */
576
- user_id_type?: 'open_id' | 'user_id' | 'union_id'
577
- /** 用户ID */
578
- user_id: string
579
- }
580
-
581
- export interface ListApprovalInstanceCommentResponse {
582
- /** 评论数据列表 */
583
- comments: Comment[]
584
- }
585
-
586
- export interface CreateApprovalExternalApprovalRequest {
587
- /** 审批定义名称,创建审批定义返回的值,表示该实例属于哪个流程;该字段会影响到列表中该实例的标题,标题取自对应定义的 name 字段。 */
588
- approval_name: string
589
- /** 审批定义 code,用户自定义,定义的唯一标识,如果不存在该 code,则创建,否则更新 */
590
- approval_code: string
591
- /** 审批定义所属审批分组,用户自定义; 如果group_code当前不存在,则会新建审批分组; 如果group_code已经存在,则会使用group_name更新审批分组名称 */
592
- group_code: string
593
- /** 分组名称,值的格式是 i18n key,文案放在 i18n_resource; 如果是 group_code 当前不存在,则该 group_name 必填,否则,如果填写了则会更新分组名称,不填则不更新分组名称; 审批发起页 审批定义的分组名称来自该字段 */
594
- group_name?: string
595
- /** 审批定义的说明,值的格式是 i18n key,文案放在 i18n_resource; 审批发起页 审批定义的说明内容来自该字段 */
596
- description?: string
597
- /** 三方审批相关 */
598
- external: ApprovalCreateExternal
599
- /** 可见人列表,可通知配置多个可见人,只有在配置的范围内用户可以在审批发起也看到该审批,默认不传,则是任何人不可见 */
600
- viewers?: ApprovalCreateViewers[]
601
- /** 国际化文案 */
602
- i18n_resources?: I18nResource[]
603
- /** 根据user_id_type填写流程管理员id */
604
- managers?: string[]
605
- }
606
-
607
- export interface CreateApprovalExternalApprovalQuery {
608
- /** 此次调用中使用的部门ID的类型 */
609
- department_id_type?: 'department_id' | 'open_department_id'
610
- /** 此次调用中使用的用户ID的类型 */
611
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
612
- }
613
-
614
- export interface CreateApprovalExternalApprovalResponse {
615
- /** 审批定义 code,用户自定义,定义的唯一标识 */
616
- approval_code: string
617
- }
618
-
619
- export interface GetApprovalExternalApprovalQuery {
620
- /** 此次调用中使用的用户ID的类型 */
621
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
622
- }
623
-
624
- export interface GetApprovalExternalApprovalResponse {
625
- /** 审批定义名称 */
626
- approval_name: string
627
- /** 审批定义code */
628
- approval_code: string
629
- /** 审批定义所属分组 */
630
- group_code: string
631
- /** 分组名称 */
632
- group_name?: string
633
- /** 审批定义的说明 */
634
- description?: string
635
- /** 三方审批定义相关 */
636
- external?: ApprovalCreateExternal
637
- /** 可见人列表 */
638
- viewers?: ApprovalCreateViewers[]
639
- /** 国际化文案 */
640
- i18n_resources?: I18nResource[]
641
- /** 流程管理员 */
642
- managers?: string[]
643
- }
644
-
645
- export interface CreateApprovalExternalInstanceRequest {
646
- /** 审批定义 code, 创建审批定义返回的值,表示该实例属于哪个流程;该字段会影响到列表中该实例的标题,标题取自对应定义的 name 字段 */
647
- approval_code: string
648
- /** 审批实例状态 */
649
- status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED' | 'HIDDEN' | 'TERMINATED'
650
- /** 审批实例扩展 JSON */
651
- extra?: string
652
- /** 审批实例唯一标识,用户自定义,需确保证租户、应用下唯一 */
653
- instance_id: string
654
- /** 审批实例链接集合 ,用于【已发起】列表的跳转,跳转回三方系统; pc_link 和 mobile_link 必须填一个,填写的是哪一端的链接,即会跳转到该链接,不受平台影响 */
655
- links: ExternalInstanceLink
656
- /** 审批展示名称,如果填写了该字段,则审批列表中的审批名称使用该字段,如果不填该字段,则审批名称使用审批定义的名称 */
657
- title?: string
658
- /** 用户提交审批时填写的表单数据,用于所有审批列表中展示。可传多个值,但审批中心pc展示前2个,移动端展示前3个,长度不超过2048字符 */
659
- form?: ExternalInstanceForm[]
660
- /** 审批发起人 user_id,发起人可在【已发起】列表中看到所有已发起的审批; 在【待审批】,【已审批】【抄送我】列表中,该字段展示审批是谁发起的。审批发起人 open id,和 user id 二选一。 */
661
- user_id?: string
662
- /** 审批发起人 用户名,如果发起人不是真实的用户(例如是某个部门),没有 user_id,则可以使用该字段传名称 */
663
- user_name?: string
664
- /** 审批发起人 open id,和 user id 二选一 */
665
- open_id?: string
666
- /** 发起人部门,用于列表中展示发起人所属部门。不传则不展示。如果用户没加入任何部门,传 "",将展示租户名称传 department_name 展示部门名称 */
667
- department_id?: string
668
- /** 审批发起人 部门,如果发起人不是真实的用户(例如是某个部门),没有 department_id,则可以使用该字段传名称 */
669
- department_name?: string
670
- /** 审批发起时间,Unix毫秒时间戳 */
671
- start_time: string
672
- /** 审批实例结束时间:未结束的审批为 0,Unix毫秒时间戳 */
673
- end_time: string
674
- /** 审批实例最近更新时间;用于推送数据版本控制如果 update_mode 值为 UPDATE,则只有传过来的 update_time 有变化时(变大),才会更新审批中心中的审批实例信息。使用该字段主要用来避免并发时老的数据更新了新的数据 */
675
- update_time: string
676
- /** 列表页打开审批实例的方式 */
677
- display_method?: 'BROWSER' | 'SIDEBAR' | 'NORMAL' | 'TRUSTEESHIP'
678
- /** 更新方式, 当 update_mode=REPLACE时,每次都以当前推送的数据为最终数据,会删掉审批中心中多余的任务、抄送数据(不在这次推送的数据中); 当 update_mode=UPDATE时,则不会删除审批中心的数据,而只是进行新增和更新实例、任务数据 */
679
- update_mode?: 'REPLACE' | 'UPDATE'
680
- /** 任务列表 */
681
- task_list?: ExternalInstanceTaskNode[]
682
- /** 抄送列表 */
683
- cc_list?: CcNode[]
684
- /** 国际化文案 */
685
- i18n_resources: I18nResource[]
686
- /** 单据托管认证token,托管回调会附带此token,帮助业务方认证 */
687
- trusteeship_url_token?: string
688
- /** 用户的类型,会影响请求参数用户标识域的选择,包括加签操作回传的目标用户, 目前仅支持 "user_id" */
689
- trusteeship_user_id_type?: string
690
- /** 单据托管回调接入方的接口的URL地址 */
691
- trusteeship_urls?: TrusteeshipUrls
692
- /** 托管预缓存策略 */
693
- trusteeship_cache_config?: TrusteeshipInstanceCacheConfig
694
- /** 资源所在地区, 内部统计用字段, 不需要填 */
695
- resource_region?: string
696
- }
697
-
698
- export interface CreateApprovalExternalInstanceResponse {
699
- /** 同步的实例数据 */
700
- data?: ExternalInstance
701
- }
702
-
703
- export interface CheckApprovalExternalInstanceRequest {
704
- /** 校验的实例信息 */
705
- instances: ExteranlInstanceCheck[]
706
- }
707
-
708
- export interface CheckApprovalExternalInstanceResponse {
709
- /** 更新时间不一致的实例信息 */
710
- diff_instances?: ExteranlInstanceCheckResponse[]
711
- }
712
-
713
- export interface ListApprovalExternalTaskRequest {
714
- /** 审批定义 Code,用于指定只获取这些定义下的数据 */
715
- approval_codes?: string[]
716
- /** 审批实例 ID, 用于指定只获取这些实例下的数据,最多支持 20 个 */
717
- instance_ids?: string[]
718
- /** 审批人 user_id,用于指定只获取这些用户的数据 */
719
- user_ids?: string[]
720
- /** 审批任务状态,用于指定获取该状态下的数据 */
721
- status?: 'PENDING' | 'APPROVED' | 'REJECTED' | 'TRANSFERRED' | 'DONE'
722
- }
723
-
724
- export interface QueryApprovalInstanceRequest {
725
- /** 根据x_user_type填写用户 id */
726
- user_id?: string
727
- /** 审批定义 code */
728
- approval_code?: string
729
- /** 审批实例 code */
730
- instance_code?: string
731
- /** 审批实例第三方 id 注:和 approval_code 取并集 */
732
- instance_external_id?: string
733
- /** 审批定义分组第三方 id 注:和 instance_code 取并集 */
734
- group_external_id?: string
735
- /** 审批实例标题(只有第三方审批有) */
736
- instance_title?: string
737
- /** 审批实例状态,注:若不在集合中,报错 */
738
- instance_status?: 'PENDING' | 'RECALL' | 'REJECT' | 'DELETED' | 'APPROVED' | 'ALL'
739
- /** 实例查询开始时间(unix毫秒时间戳) */
740
- instance_start_time_from?: string
741
- /** 实例查询结束时间 (unix毫秒时间戳) */
742
- instance_start_time_to?: string
743
- /** 地区 */
744
- locale?: 'zh-CN' | 'en-US' | 'ja-JP'
745
- }
746
-
747
- export interface QueryApprovalInstanceQuery extends Pagination {
748
- /** 此次调用中使用的用户ID的类型 */
749
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
750
- }
751
-
752
- export interface QueryApprovalInstanceResponse {
753
- /** 查询返回条数 */
754
- count?: number
755
- /** 审批实例列表 */
756
- instance_list?: InstanceSearchItem[]
757
- /** 翻页 Token */
758
- page_token?: string
759
- /** 是否有更多任务可供拉取 */
760
- has_more?: boolean
761
- }
39
+ export interface CreateRequest {
40
+ /** 审批名称的国际化文案 Key,以 @i18n@ 开头,长度不得少于 9 个字符 */
41
+ approval_name: string
42
+ /** 传空表示新建 */
43
+ approval_code?: string
44
+ /** 审批描述的国际化文案 Key,以 @i18n@ 开头,长度不得少于 9 个字符 */
45
+ description?: string
46
+ /** viewers 字段指定了哪些人能从审批应用的前台发起该审批。 当 view_type 为 USER,需要填写viewer_user_id; 当 view_type 为DEPARTMENT,需要填写viewer_department_id; 当 view_type 为TENANT或NONE时,viewer_user_id和viewer_department_id无需填写 */
47
+ viewers: Lark.ApprovalCreateViewers[]
48
+ /** 审批定义表单内容,json 数组 */
49
+ form: Lark.ApprovalForm
50
+ /** 审批定义节点,需要将开始节点作为 list 第一个元素,结束节点作为最后一个元素 */
51
+ node_list: Lark.ApprovalNode[]
52
+ /** 审批定义其他设置 */
53
+ settings?: Lark.ApprovalSetting
54
+ /** 审批定义配置项,用于配置对应审批定义是否可以由用户在审批后台进行修改 */
55
+ config?: Lark.ApprovalConfig
56
+ /** 审批图标枚举,详见下方说明,默认为 0 */
57
+ icon?: number
58
+ /** 国际化文案 */
59
+ i18n_resources: Lark.I18nResource[]
60
+ /** 流程负责人 */
61
+ process_manager_ids?: string[]
62
+ }
762
63
 
763
- export interface SearchCcApprovalInstanceRequest {
764
- /** 根据x_user_type填写用户 id */
765
- user_id?: string
766
- /** 审批定义 code */
767
- approval_code?: string
768
- /** 审批实例 code */
769
- instance_code?: string
770
- /** 审批实例第三方 id 注:和 approval_code 取并集 */
771
- instance_external_id?: string
772
- /** 审批定义分组第三方 id 注:和 instance_code 取并集 */
773
- group_external_id?: string
774
- /** 审批实例标题(只有第三方审批有) */
775
- cc_title?: string
776
- /** 审批抄送状态,注:若不在集合中,报错 */
777
- read_status?: 'READ' | 'UNREAD' | 'ALL'
778
- /** 实例查询开始时间(unix毫秒时间戳) */
779
- cc_create_time_from?: string
780
- /** 实例查询结束时间 (unix毫秒时间戳) */
781
- cc_create_time_to?: string
782
- /** 地区 */
783
- locale?: 'zh-CN' | 'en-US' | 'ja-JP'
784
- }
64
+ export interface CreateQuery {
65
+ /** 此次调用中使用的部门ID的类型 */
66
+ department_id_type?: 'department_id' | 'open_department_id'
67
+ /** 此次调用中使用的用户ID的类型 */
68
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
69
+ }
785
70
 
786
- export interface SearchCcApprovalInstanceQuery extends Pagination {
787
- /** 此次调用中使用的用户ID的类型 */
788
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
789
- }
71
+ export interface CreateResponse {
72
+ /** 审批定义 Code */
73
+ approval_code?: string
74
+ /** 审批定义 id */
75
+ approval_id?: string
76
+ }
790
77
 
791
- export interface SearchCcApprovalInstanceResponse {
792
- /** 查询返回条数 */
793
- count?: number
794
- /** 审批实例列表 */
795
- cc_list?: CcSearchItem[]
796
- /** 翻页 Token */
797
- page_token?: string
798
- /** 是否有更多任务可供拉取 */
799
- has_more?: boolean
800
- }
78
+ export interface GetQuery {
79
+ /** 语言可选值 */
80
+ locale?: 'zh-CN' | 'en-US' | 'ja-JP'
81
+ /** 可选是否返回有数据权限审批流程管理员ID列表 */
82
+ with_admin_id?: boolean
83
+ /** 此次调用中使用的用户ID的类型 */
84
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
85
+ }
801
86
 
802
- export const enum SearchApprovalTaskRequestOrder {
803
- /** 按update_time倒排 */
804
- UpdateTimeDESC = 0,
805
- /** 按update_time正排 */
806
- UpdateTimeASC = 1,
807
- /** 按start_time倒排 */
808
- StartTimeDESC = 2,
809
- /** 按start_time正排 */
810
- StartTimeASC = 3,
811
- }
87
+ export interface GetResponse {
88
+ /** 审批名称 */
89
+ approval_name: string
90
+ /** 审批定义状态 */
91
+ status: 'ACTIVE' | 'INACTIVE' | 'DELETED' | 'UNKNOWN'
92
+ /** 控件信息 */
93
+ form: string
94
+ /** 节点信息 */
95
+ node_list: Lark.ApprovalNodeInfo[]
96
+ /** 可见人列表 */
97
+ viewers: Lark.ApprovalViewerInfo[]
98
+ /** 有数据管理权限的审批流程管理员ID */
99
+ approval_admin_ids?: string[]
100
+ /** 组件之间值关联关系 */
101
+ form_widget_relation?: string
102
+ }
812
103
 
813
- export interface SearchApprovalTaskRequest {
814
- /** 根据x_user_type填写用户 id */
815
- user_id?: string
816
- /** 审批定义 code */
817
- approval_code?: string
818
- /** 审批实例 code */
819
- instance_code?: string
820
- /** 审批实例第三方 id 注:和 approval_code 取并集 */
821
- instance_external_id?: string
822
- /** 审批定义分组第三方 id 注:和 instance_code 取并集 */
823
- group_external_id?: string
824
- /** 审批任务标题(只有第三方审批有) */
825
- task_title?: string
826
- /** 审批任务状态,注:若不设置,查询全部状态 若不在集合中,报错 */
827
- task_status?: 'PENDING' | 'REJECTED' | 'APPROVED' | 'TRANSFERRED' | 'DONE' | 'RM_REPEAT' | 'PROCESSED' | 'ALL'
828
- /** 任务查询开始时间(unix毫秒时间戳) */
829
- task_start_time_from?: string
830
- /** 任务查询结束时间 (unix毫秒时间戳) */
831
- task_start_time_to?: string
832
- /** 地区 */
833
- locale?: 'zh-CN' | 'en-US' | 'ja-JP'
834
- /** 可选择task_status中的多个状态,当填写此参数时,task_status失效 */
835
- task_status_list?: string[]
836
- /** 按时间排序 */
837
- order?: SearchApprovalTaskRequestOrder
838
- }
104
+ export namespace Instance {
105
+ export interface Methods {
106
+ comment: Comment.Methods
107
+ /**
108
+ * 创建审批实例
109
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/create
110
+ */
111
+ create(body: CreateRequest): Promise<CreateResponse>
112
+ /**
113
+ * 撤回审批实例
114
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cancel
115
+ */
116
+ cancel(body: CancelRequest, query?: CancelQuery): Promise<void>
117
+ /**
118
+ * 抄送审批实例
119
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/cc
120
+ */
121
+ cc(body: CcRequest, query?: CcQuery): Promise<void>
122
+ /**
123
+ * 预览审批流程
124
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-preview
125
+ */
126
+ preview(body: PreviewRequest, query?: PreviewQuery): Promise<PreviewResponse>
127
+ /**
128
+ * 获取单个审批实例详情
129
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/get
130
+ */
131
+ get(instance_id: string, query?: GetQuery): Promise<GetResponse>
132
+ /**
133
+ * 批量获取审批实例 ID
134
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/list
135
+ */
136
+ list(query?: ListQuery): Paginated<string, 'instance_code_list'>
137
+ /**
138
+ * 退回审批任务
139
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback
140
+ */
141
+ specifiedRollback(body: SpecifiedRollbackRequest, query?: SpecifiedRollbackQuery): Promise<void>
142
+ /**
143
+ * 审批任务加签
144
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-task-addsign
145
+ */
146
+ addSign(body: AddSignRequest): Promise<void>
147
+ /**
148
+ * 查询实例列表
149
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query
150
+ */
151
+ query(body: QueryRequest, query?: QueryQuery): Promise<QueryResponse> & AsyncIterableIterator<Lark.InstanceSearchItem>
152
+ /**
153
+ * 查询抄送列表
154
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc
155
+ */
156
+ searchCc(body: SearchCcRequest, query?: SearchCcQuery): Promise<SearchCcResponse> & AsyncIterableIterator<Lark.CcSearchItem>
157
+ }
158
+
159
+ export const enum CreateRequestTitleDisplayMethod {
160
+ /** 如果都有title,展示approval 和instance的title,竖线分割。 */
161
+ DisplayAll = 0,
162
+ /** 如果都有title,只展示instance的title */
163
+ DisplayInstanceTitle = 1,
164
+ }
165
+
166
+ export interface CreateRequest {
167
+ /** 审批定义 code */
168
+ approval_code: string
169
+ /** 发起审批用户 */
170
+ user_id?: string
171
+ /** 发起审批用户 open id, 如果传了 user_id 则优先使用 user_id */
172
+ open_id?: string
173
+ /** 发起审批用户部门id,如果用户只属于一个部门,可以不填。如果属于多个部门,默认会选择部门列表第一个部门 */
174
+ department_id?: string
175
+ /** json 数组,控件值 */
176
+ form: string
177
+ /** 如果有发起人自选节点,则需要填写对应节点的审批人 */
178
+ node_approver_user_id_list?: Lark.NodeApprover[]
179
+ /** 审批人发起人自选 open id,与上述node_approver_user_id_list字段取并集 */
180
+ node_approver_open_id_list?: Lark.NodeApprover[]
181
+ /** 如果有发起人自选节点,则可填写对应节点的抄送人,单个节点最多选择20位抄送人 */
182
+ node_cc_user_id_list?: Lark.NodeCc[]
183
+ /** 抄送人发起人自选 open id 单个节点最多选择20位抄送人 */
184
+ node_cc_open_id_list?: Lark.NodeCc[]
185
+ /** 审批实例 uuid,用于幂等操作, 每个租户下面的唯一key,同一个 uuid 只能用于创建一个审批实例,如果冲突,返回错误码 60012 ,格式建议为 XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX,不区分大小写 */
186
+ uuid?: string
187
+ /** 可配置是否可以再次提交 */
188
+ allow_resubmit?: boolean
189
+ /** 可配置是否可以重新提交 */
190
+ allow_submit_again?: boolean
191
+ /** 配置bot是否取消通知结果 */
192
+ cancel_bot_notification?: string
193
+ /** 配置是否可以禁止撤销 */
194
+ forbid_revoke?: boolean
195
+ /** 国际化文案 */
196
+ i18n_resources?: Lark.I18nResource[]
197
+ /** 审批展示名称,如果填写了该字段,则审批列表中的审批名称使用该字段,如果不填该字段,则审批名称使用审批定义的名称 */
198
+ title?: string
199
+ /** 详情页title展示模式 */
200
+ title_display_method?: CreateRequestTitleDisplayMethod
201
+ /** 自动通过节点ID */
202
+ node_auto_approval_list?: Lark.NodeAutoApproval[]
203
+ }
204
+
205
+ export interface CreateResponse {
206
+ /** 审批实例 Code */
207
+ instance_code: string
208
+ }
209
+
210
+ export interface CancelRequest {
211
+ /** 审批定义Code */
212
+ approval_code: string
213
+ /** 审批实例Code */
214
+ instance_code: string
215
+ /** 操作用户, 根据user_id_type填写 */
216
+ user_id: string
217
+ }
218
+
219
+ export interface CancelQuery {
220
+ /** 此次调用中使用的用户ID的类型 */
221
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
222
+ }
223
+
224
+ export interface CcRequest {
225
+ /** 审批定义 code */
226
+ approval_code: string
227
+ /** 审批实例 code */
228
+ instance_code: string
229
+ /** 根据user_id_type填写发起抄送的人的用户id */
230
+ user_id: string
231
+ /** 根据user_id_type填写被抄送人的 用户id 列表 */
232
+ cc_user_ids: string[]
233
+ /** 抄送留言 */
234
+ comment?: string
235
+ }
236
+
237
+ export interface CcQuery {
238
+ /** 此次调用中使用的用户ID的类型 */
239
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
240
+ }
241
+
242
+ export interface PreviewRequest {
243
+ /** 用户id */
244
+ user_id: string
245
+ /** 审批定义code */
246
+ approval_code?: string
247
+ /** 部门id */
248
+ department_id?: string
249
+ /** 表单数据 */
250
+ form?: string
251
+ /** 审批实例code */
252
+ instance_code?: string
253
+ /** 语言类型 */
254
+ locale?: string
255
+ /** 任务id */
256
+ task_id?: string
257
+ }
258
+
259
+ export interface PreviewQuery {
260
+ /** open_id(ou_开头),union_id(on_开头),user_id(字符串)。user_id_type不填默认为open_id */
261
+ user_id_type?: 'open_id' | 'user_id' | 'union_id'
262
+ }
263
+
264
+ export interface PreviewResponse {
265
+ /** 预览节点信息 */
266
+ preview_nodes?: Lark.PreviewNode[]
267
+ }
268
+
269
+ export interface GetQuery {
270
+ /** 语言 */
271
+ locale?: 'zh-CN' | 'en-US' | 'ja-JP'
272
+ /** 发起审批用户id,仅自建应用可返回 */
273
+ user_id?: string
274
+ /** 此次调用中使用的用户ID的类型 */
275
+ user_id_type?: 'user_id' | 'open_id' | 'union_id'
276
+ }
277
+
278
+ export interface GetResponse {
279
+ /** 审批名称 */
280
+ approval_name: string
281
+ /** 审批创建时间 */
282
+ start_time?: string
283
+ /** 审批完成时间,未完成为 0 */
284
+ end_time: string
285
+ /** 发起审批用户 */
286
+ user_id: string
287
+ /** 发起审批用户 open id */
288
+ open_id: string
289
+ /** 审批单编号 */
290
+ serial_number: string
291
+ /** 发起审批用户所在部门 */
292
+ department_id: string
293
+ /** 审批实例状态 */
294
+ status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED'
295
+ /** 用户的唯一标识id */
296
+ uuid: string
297
+ /** json字符串,控件值 */
298
+ form: string
299
+ /** 审批任务列表 */
300
+ task_list: Lark.InstanceTask[]
301
+ /** 评论列表 */
302
+ comment_list: Lark.InstanceComment[]
303
+ /** 审批动态 */
304
+ timeline: Lark.InstanceTimeline[]
305
+ /** 修改的原实例 code,仅在查询修改实例时显示该字段 */
306
+ modified_instance_code?: string
307
+ /** 撤销的原实例 code,仅在查询撤销实例时显示该字段 */
308
+ reverted_instance_code?: string
309
+ /** 审批定义 Code */
310
+ approval_code: string
311
+ /** 单据是否被撤销 */
312
+ reverted?: boolean
313
+ /** 审批实例 Code */
314
+ instance_code: string
315
+ }
316
+
317
+ export interface ListQuery extends Pagination {
318
+ /** 审批定义唯一标识 */
319
+ approval_code: string
320
+ /** 审批实例创建时间区间(毫秒) */
321
+ start_time: string
322
+ /** 审批实例创建时间区间(毫秒) */
323
+ end_time: string
324
+ }
325
+
326
+ export interface SpecifiedRollbackRequest {
327
+ /** 用户ID */
328
+ user_id: string
329
+ /** 回退的任务ID */
330
+ task_id: string
331
+ /** 退回原因 */
332
+ reason?: string
333
+ /** 扩展字段 */
334
+ extra?: string
335
+ /** 退回到节点列表 */
336
+ task_def_key_list: string[]
337
+ }
338
+
339
+ export interface SpecifiedRollbackQuery {
340
+ /** 此次调用中使用的用户ID的类型 */
341
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
342
+ }
343
+
344
+ export const enum AddSignRequestAddSignType {
345
+ /** 前加签 */
346
+ AddSignPre = 1,
347
+ /** 后加签 */
348
+ AddSignPost = 2,
349
+ /** 并加签 */
350
+ AddSignParallel = 3,
351
+ }
352
+
353
+ export const enum AddSignRequestApprovalMethod {
354
+ /** 或签 */
355
+ OrSign = 1,
356
+ /** 会签 */
357
+ AddSign = 2,
358
+ /** 依次审批 */
359
+ SequentialSign = 3,
360
+ }
361
+
362
+ export interface AddSignRequest {
363
+ /** 操作用户id */
364
+ user_id: string
365
+ /** 审批定义code */
366
+ approval_code: string
367
+ /** 审批实例code */
368
+ instance_code: string
369
+ /** 任务id */
370
+ task_id: string
371
+ /** 意见 */
372
+ comment?: string
373
+ /** 被加签人id */
374
+ add_sign_user_ids: string[]
375
+ /** 1/2/3分别代表前加签/后加签/并加签 */
376
+ add_sign_type: AddSignRequestAddSignType
377
+ /** 仅在前加签、后加签时需要填写,1/2 分别代表或签/会签 */
378
+ approval_method?: AddSignRequestApprovalMethod
379
+ }
380
+
381
+ export interface QueryRequest {
382
+ /** 根据x_user_type填写用户 id */
383
+ user_id?: string
384
+ /** 审批定义 code */
385
+ approval_code?: string
386
+ /** 审批实例 code */
387
+ instance_code?: string
388
+ /** 审批实例第三方 id 注:和 approval_code 取并集 */
389
+ instance_external_id?: string
390
+ /** 审批定义分组第三方 id 注:和 instance_code 取并集 */
391
+ group_external_id?: string
392
+ /** 审批实例标题(只有第三方审批有) */
393
+ instance_title?: string
394
+ /** 审批实例状态,注:若不在集合中,报错 */
395
+ instance_status?: 'PENDING' | 'RECALL' | 'REJECT' | 'DELETED' | 'APPROVED' | 'ALL'
396
+ /** 实例查询开始时间(unix毫秒时间戳) */
397
+ instance_start_time_from?: string
398
+ /** 实例查询结束时间 (unix毫秒时间戳) */
399
+ instance_start_time_to?: string
400
+ /** 地区 */
401
+ locale?: 'zh-CN' | 'en-US' | 'ja-JP'
402
+ }
403
+
404
+ export interface QueryQuery extends Pagination {
405
+ /** 此次调用中使用的用户ID的类型 */
406
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
407
+ }
408
+
409
+ export interface QueryResponse {
410
+ /** 查询返回条数 */
411
+ count?: number
412
+ /** 审批实例列表 */
413
+ instance_list?: Lark.InstanceSearchItem[]
414
+ /** 翻页 Token */
415
+ page_token?: string
416
+ /** 是否有更多任务可供拉取 */
417
+ has_more?: boolean
418
+ }
419
+
420
+ export interface SearchCcRequest {
421
+ /** 根据x_user_type填写用户 id */
422
+ user_id?: string
423
+ /** 审批定义 code */
424
+ approval_code?: string
425
+ /** 审批实例 code */
426
+ instance_code?: string
427
+ /** 审批实例第三方 id 注:和 approval_code 取并集 */
428
+ instance_external_id?: string
429
+ /** 审批定义分组第三方 id 注:和 instance_code 取并集 */
430
+ group_external_id?: string
431
+ /** 审批实例标题(只有第三方审批有) */
432
+ cc_title?: string
433
+ /** 审批抄送状态,注:若不在集合中,报错 */
434
+ read_status?: 'READ' | 'UNREAD' | 'ALL'
435
+ /** 实例查询开始时间(unix毫秒时间戳) */
436
+ cc_create_time_from?: string
437
+ /** 实例查询结束时间 (unix毫秒时间戳) */
438
+ cc_create_time_to?: string
439
+ /** 地区 */
440
+ locale?: 'zh-CN' | 'en-US' | 'ja-JP'
441
+ }
442
+
443
+ export interface SearchCcQuery extends Pagination {
444
+ /** 此次调用中使用的用户ID的类型 */
445
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
446
+ }
447
+
448
+ export interface SearchCcResponse {
449
+ /** 查询返回条数 */
450
+ count?: number
451
+ /** 审批实例列表 */
452
+ cc_list?: Lark.CcSearchItem[]
453
+ /** 翻页 Token */
454
+ page_token?: string
455
+ /** 是否有更多任务可供拉取 */
456
+ has_more?: boolean
457
+ }
458
+
459
+ export namespace Comment {
460
+ export interface Methods {
461
+ /**
462
+ * 创建评论
463
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/create
464
+ */
465
+ create(instance_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
466
+ /**
467
+ * 删除评论
468
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/delete
469
+ */
470
+ delete(instance_id: string, comment_id: string, query?: DeleteQuery): Promise<DeleteResponse>
471
+ /**
472
+ * 清空评论
473
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/remove
474
+ */
475
+ remove(instance_id: string, query?: RemoveQuery): Promise<RemoveResponse>
476
+ /**
477
+ * 获取评论
478
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance-comment/list
479
+ */
480
+ list(instance_id: string, query?: ListQuery): Promise<ListResponse>
481
+ }
482
+
483
+ export interface CreateRequest {
484
+ /** 评论内容,包含艾特人、附件等 */
485
+ content?: string
486
+ /** 评论中艾特人信息 */
487
+ at_info_list?: Lark.CommentAtInfo[]
488
+ /** 父评论ID,如果是回复评论,需要传 */
489
+ parent_comment_id?: string
490
+ /** 评论ID,如果是编辑、删除一条评论,需要传 */
491
+ comment_id?: string
492
+ /** disable_bot=true只同步数据,不触发bot */
493
+ disable_bot?: boolean
494
+ /** 附加字段 */
495
+ extra?: string
496
+ }
497
+
498
+ export interface CreateQuery {
499
+ /** 用户ID类型,不填默认为open_id */
500
+ user_id_type?: 'open_id' | 'user_id' | 'union_id'
501
+ /** 用户ID */
502
+ user_id: string
503
+ }
504
+
505
+ export interface CreateResponse {
506
+ /** 保存成功的comment_id */
507
+ comment_id: string
508
+ }
509
+
510
+ export interface DeleteQuery {
511
+ /** 用户ID类型,不填默认为open_id */
512
+ user_id_type?: 'open_id' | 'user_id' | 'union_id'
513
+ /** 根据user_id_type填写用户ID */
514
+ user_id: string
515
+ }
516
+
517
+ export interface DeleteResponse {
518
+ /** 删除的评论ID */
519
+ comment_id?: string
520
+ }
521
+
522
+ export interface RemoveQuery {
523
+ /** 用户ID类型,不填默认为open_id */
524
+ user_id_type?: 'open_id' | 'user_id' | 'union_id'
525
+ /** 根据user_id_type填写用户ID */
526
+ user_id?: string
527
+ }
528
+
529
+ export interface RemoveResponse {
530
+ /** 审批实例code */
531
+ instance_id?: string
532
+ /** 租户自定义审批实例ID */
533
+ external_id?: string
534
+ }
535
+
536
+ export interface ListQuery extends Pagination {
537
+ /** 用户ID类型,不填默认为open_id */
538
+ user_id_type?: 'open_id' | 'user_id' | 'union_id'
539
+ /** 用户ID */
540
+ user_id: string
541
+ }
542
+
543
+ export interface ListResponse {
544
+ /** 评论数据列表 */
545
+ comments: Lark.Comment[]
546
+ }
547
+ }
548
+ }
839
549
 
840
- export interface SearchApprovalTaskQuery extends Pagination {
841
- /** 此次调用中使用的用户ID的类型 */
842
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
843
- }
550
+ export namespace Task {
551
+ export interface Methods {
552
+ /**
553
+ * 同意审批任务
554
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/approve
555
+ */
556
+ approve(body: ApproveRequest, query?: ApproveQuery): Promise<void>
557
+ /**
558
+ * 拒绝审批任务
559
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/reject
560
+ */
561
+ reject(body: RejectRequest, query?: RejectQuery): Promise<void>
562
+ /**
563
+ * 转交审批任务
564
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/transfer
565
+ */
566
+ transfer(body: TransferRequest, query?: TransferQuery): Promise<void>
567
+ /**
568
+ * 重新提交审批任务
569
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/resubmit
570
+ */
571
+ resubmit(body: ResubmitRequest, query?: ResubmitQuery): Promise<void>
572
+ /**
573
+ * 查询任务列表
574
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search
575
+ */
576
+ search(body: SearchRequest, query?: SearchQuery): Promise<SearchResponse> & AsyncIterableIterator<Lark.TaskSearchItem>
577
+ /**
578
+ * 查询用户的任务列表
579
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/query
580
+ */
581
+ query(query?: QueryQuery): Promise<QueryResponse> & AsyncIterableIterator<Lark.Task>
582
+ }
583
+
584
+ export interface ApproveRequest {
585
+ /** 审批定义 Code */
586
+ approval_code: string
587
+ /** 审批实例 Code */
588
+ instance_code: string
589
+ /** 根据user_id_type填写操作用户id */
590
+ user_id: string
591
+ /** 意见 */
592
+ comment?: string
593
+ /** 任务 ID, 审批实例详情task_list中id */
594
+ task_id: string
595
+ /** json 数组,控件值 */
596
+ form?: string
597
+ }
598
+
599
+ export interface ApproveQuery {
600
+ /** 此次调用中使用的用户ID的类型 */
601
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
602
+ }
603
+
604
+ export interface RejectRequest {
605
+ /** 审批定义 Code */
606
+ approval_code: string
607
+ /** 审批实例 Code */
608
+ instance_code: string
609
+ /** 根据user_id_type填写操作用户id */
610
+ user_id: string
611
+ /** 意见 */
612
+ comment?: string
613
+ /** 任务 ID, 审批实例详情task_list中id */
614
+ task_id: string
615
+ /** json 数组,控件值 */
616
+ form?: string
617
+ }
618
+
619
+ export interface RejectQuery {
620
+ /** 此次调用中使用的用户ID的类型 */
621
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
622
+ }
623
+
624
+ export interface TransferRequest {
625
+ /** 审批定义 Code */
626
+ approval_code: string
627
+ /** 审批实例 Code */
628
+ instance_code: string
629
+ /** 根据user_id_type填写操作用户id */
630
+ user_id: string
631
+ /** 意见 */
632
+ comment?: string
633
+ /** 根据user_id_type填写被转交人唯一 ID */
634
+ transfer_user_id: string
635
+ /** 任务 ID, 审批实例详情task_list中id */
636
+ task_id: string
637
+ }
638
+
639
+ export interface TransferQuery {
640
+ /** 此次调用中使用的用户ID的类型 */
641
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
642
+ }
643
+
644
+ export interface ResubmitRequest {
645
+ /** 审批定义 Code */
646
+ approval_code: string
647
+ /** 审批实例 Code */
648
+ instance_code: string
649
+ /** 根据user_id_type填写操作用户id */
650
+ user_id: string
651
+ /** 意见 */
652
+ comment?: string
653
+ /** 任务 ID, 审批实例详情task_list中id */
654
+ task_id: string
655
+ /** json 数组,控件值 */
656
+ form: string
657
+ }
658
+
659
+ export interface ResubmitQuery {
660
+ /** 此次调用中使用的用户ID的类型 */
661
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
662
+ }
663
+
664
+ export const enum SearchRequestOrder {
665
+ /** 按update_time倒排 */
666
+ UpdateTimeDESC = 0,
667
+ /** 按update_time正排 */
668
+ UpdateTimeASC = 1,
669
+ /** 按start_time倒排 */
670
+ StartTimeDESC = 2,
671
+ /** 按start_time正排 */
672
+ StartTimeASC = 3,
673
+ }
674
+
675
+ export interface SearchRequest {
676
+ /** 根据x_user_type填写用户 id */
677
+ user_id?: string
678
+ /** 审批定义 code */
679
+ approval_code?: string
680
+ /** 审批实例 code */
681
+ instance_code?: string
682
+ /** 审批实例第三方 id 注:和 approval_code 取并集 */
683
+ instance_external_id?: string
684
+ /** 审批定义分组第三方 id 注:和 instance_code 取并集 */
685
+ group_external_id?: string
686
+ /** 审批任务标题(只有第三方审批有) */
687
+ task_title?: string
688
+ /** 审批任务状态,注:若不设置,查询全部状态 若不在集合中,报错 */
689
+ task_status?: 'PENDING' | 'REJECTED' | 'APPROVED' | 'TRANSFERRED' | 'DONE' | 'RM_REPEAT' | 'PROCESSED' | 'ALL'
690
+ /** 任务查询开始时间(unix毫秒时间戳) */
691
+ task_start_time_from?: string
692
+ /** 任务查询结束时间 (unix毫秒时间戳) */
693
+ task_start_time_to?: string
694
+ /** 地区 */
695
+ locale?: 'zh-CN' | 'en-US' | 'ja-JP'
696
+ /** 可选择task_status中的多个状态,当填写此参数时,task_status失效 */
697
+ task_status_list?: string[]
698
+ /** 按时间排序 */
699
+ order?: SearchRequestOrder
700
+ }
701
+
702
+ export interface SearchQuery extends Pagination {
703
+ /** 此次调用中使用的用户ID的类型 */
704
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
705
+ }
706
+
707
+ export interface SearchResponse {
708
+ /** 查询返回条数 */
709
+ count?: number
710
+ /** 审批任务列表 */
711
+ task_list?: Lark.TaskSearchItem[]
712
+ /** 翻页 Token */
713
+ page_token?: string
714
+ /** 是否有更多任务可供拉取 */
715
+ has_more?: boolean
716
+ }
717
+
718
+ export interface QueryQuery extends Pagination {
719
+ /** 需要查询的 User ID */
720
+ user_id: string
721
+ /** 需要查询的任务分组主题,如「待办」、「已办」等 */
722
+ topic: '1' | '2' | '3' | '17' | '18'
723
+ /** 此次调用中使用的用户ID的类型 */
724
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
725
+ }
726
+
727
+ export interface QueryResponse {
728
+ /** 任务列表 */
729
+ tasks: Lark.Task[]
730
+ /** 翻页 Token */
731
+ page_token?: string
732
+ /** 是否有更多任务可供拉取 */
733
+ has_more?: boolean
734
+ /** 列表计数,只在分页第一页返回 */
735
+ count?: Lark.Count
736
+ }
737
+ }
844
738
 
845
- export interface SearchApprovalTaskResponse {
846
- /** 查询返回条数 */
847
- count?: number
848
- /** 审批任务列表 */
849
- task_list?: TaskSearchItem[]
850
- /** 翻页 Token */
851
- page_token?: string
852
- /** 是否有更多任务可供拉取 */
853
- has_more?: boolean
854
- }
739
+ export namespace ExternalApproval {
740
+ export interface Methods {
741
+ /**
742
+ * 创建三方审批定义
743
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/create
744
+ */
745
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
746
+ /**
747
+ * 查看指定三方审批定义
748
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_approval/get
749
+ */
750
+ get(approval_code: string, query?: GetQuery): Promise<GetResponse>
751
+ }
752
+
753
+ export interface CreateRequest {
754
+ /** 审批定义名称,创建审批定义返回的值,表示该实例属于哪个流程;该字段会影响到列表中该实例的标题,标题取自对应定义的 name 字段。 */
755
+ approval_name: string
756
+ /** 审批定义 code,用户自定义,定义的唯一标识,如果不存在该 code,则创建,否则更新 */
757
+ approval_code: string
758
+ /** 审批定义所属审批分组,用户自定义; 如果group_code当前不存在,则会新建审批分组; 如果group_code已经存在,则会使用group_name更新审批分组名称 */
759
+ group_code: string
760
+ /** 分组名称,值的格式是 i18n key,文案放在 i18n_resource; 如果是 group_code 当前不存在,则该 group_name 必填,否则,如果填写了则会更新分组名称,不填则不更新分组名称; 审批发起页 审批定义的分组名称来自该字段 */
761
+ group_name?: string
762
+ /** 审批定义的说明,值的格式是 i18n key,文案放在 i18n_resource; 审批发起页 审批定义的说明内容来自该字段 */
763
+ description?: string
764
+ /** 三方审批相关 */
765
+ external: Lark.ApprovalCreateExternal
766
+ /** 可见人列表,可通知配置多个可见人,只有在配置的范围内用户可以在审批发起也看到该审批,默认不传,则是任何人不可见 */
767
+ viewers?: Lark.ApprovalCreateViewers[]
768
+ /** 国际化文案 */
769
+ i18n_resources?: Lark.I18nResource[]
770
+ /** 根据user_id_type填写流程管理员id */
771
+ managers?: string[]
772
+ }
773
+
774
+ export interface CreateQuery {
775
+ /** 此次调用中使用的部门ID的类型 */
776
+ department_id_type?: 'department_id' | 'open_department_id'
777
+ /** 此次调用中使用的用户ID的类型 */
778
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
779
+ }
780
+
781
+ export interface CreateResponse {
782
+ /** 审批定义 code,用户自定义,定义的唯一标识 */
783
+ approval_code: string
784
+ }
785
+
786
+ export interface GetQuery {
787
+ /** 此次调用中使用的用户ID的类型 */
788
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
789
+ }
790
+
791
+ export interface GetResponse {
792
+ /** 审批定义名称 */
793
+ approval_name: string
794
+ /** 审批定义code */
795
+ approval_code: string
796
+ /** 审批定义所属分组 */
797
+ group_code: string
798
+ /** 分组名称 */
799
+ group_name?: string
800
+ /** 审批定义的说明 */
801
+ description?: string
802
+ /** 三方审批定义相关 */
803
+ external?: Lark.ApprovalCreateExternal
804
+ /** 可见人列表 */
805
+ viewers?: Lark.ApprovalCreateViewers[]
806
+ /** 国际化文案 */
807
+ i18n_resources?: Lark.I18nResource[]
808
+ /** 流程管理员 */
809
+ managers?: string[]
810
+ }
811
+ }
855
812
 
856
- export interface QueryApprovalTaskQuery extends Pagination {
857
- /** 需要查询的 User ID */
858
- user_id: string
859
- /** 需要查询的任务分组主题,如「待办」、「已办」等 */
860
- topic: '1' | '2' | '3' | '17' | '18'
861
- /** 此次调用中使用的用户ID的类型 */
862
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
863
- }
813
+ export namespace ExternalInstance {
814
+ export interface Methods {
815
+ /**
816
+ * 同步三方审批实例
817
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/create
818
+ */
819
+ create(body: CreateRequest): Promise<CreateResponse>
820
+ /**
821
+ * 校验三方审批实例
822
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_instance/check
823
+ */
824
+ check(body: CheckRequest): Promise<CheckResponse>
825
+ }
826
+
827
+ export interface CreateRequest {
828
+ /** 审批定义 code, 创建审批定义返回的值,表示该实例属于哪个流程;该字段会影响到列表中该实例的标题,标题取自对应定义的 name 字段 */
829
+ approval_code: string
830
+ /** 审批实例状态 */
831
+ status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELED' | 'DELETED' | 'HIDDEN' | 'TERMINATED'
832
+ /** 审批实例扩展 JSON */
833
+ extra?: string
834
+ /** 审批实例唯一标识,用户自定义,需确保证租户、应用下唯一 */
835
+ instance_id: string
836
+ /** 审批实例链接集合 ,用于【已发起】列表的跳转,跳转回三方系统; pc_link 和 mobile_link 必须填一个,填写的是哪一端的链接,即会跳转到该链接,不受平台影响 */
837
+ links: Lark.ExternalInstanceLink
838
+ /** 审批展示名称,如果填写了该字段,则审批列表中的审批名称使用该字段,如果不填该字段,则审批名称使用审批定义的名称 */
839
+ title?: string
840
+ /** 用户提交审批时填写的表单数据,用于所有审批列表中展示。可传多个值,但审批中心pc展示前2个,移动端展示前3个,长度不超过2048字符 */
841
+ form?: Lark.ExternalInstanceForm[]
842
+ /** 审批发起人 user_id,发起人可在【已发起】列表中看到所有已发起的审批; 在【待审批】,【已审批】【抄送我】列表中,该字段展示审批是谁发起的。审批发起人 open id,和 user id 二选一。 */
843
+ user_id?: string
844
+ /** 审批发起人 用户名,如果发起人不是真实的用户(例如是某个部门),没有 user_id,则可以使用该字段传名称 */
845
+ user_name?: string
846
+ /** 审批发起人 open id,和 user id 二选一 */
847
+ open_id?: string
848
+ /** 发起人部门,用于列表中展示发起人所属部门。不传则不展示。如果用户没加入任何部门,传 "",将展示租户名称传 department_name 展示部门名称 */
849
+ department_id?: string
850
+ /** 审批发起人 部门,如果发起人不是真实的用户(例如是某个部门),没有 department_id,则可以使用该字段传名称 */
851
+ department_name?: string
852
+ /** 审批发起时间,Unix毫秒时间戳 */
853
+ start_time: string
854
+ /** 审批实例结束时间:未结束的审批为 0,Unix毫秒时间戳 */
855
+ end_time: string
856
+ /** 审批实例最近更新时间;用于推送数据版本控制如果 update_mode 值为 UPDATE,则只有传过来的 update_time 有变化时(变大),才会更新审批中心中的审批实例信息。使用该字段主要用来避免并发时老的数据更新了新的数据 */
857
+ update_time: string
858
+ /** 列表页打开审批实例的方式 */
859
+ display_method?: 'BROWSER' | 'SIDEBAR' | 'NORMAL' | 'TRUSTEESHIP'
860
+ /** 更新方式, 当 update_mode=REPLACE时,每次都以当前推送的数据为最终数据,会删掉审批中心中多余的任务、抄送数据(不在这次推送的数据中); 当 update_mode=UPDATE时,则不会删除审批中心的数据,而只是进行新增和更新实例、任务数据 */
861
+ update_mode?: 'REPLACE' | 'UPDATE'
862
+ /** 任务列表 */
863
+ task_list?: Lark.ExternalInstanceTaskNode[]
864
+ /** 抄送列表 */
865
+ cc_list?: Lark.CcNode[]
866
+ /** 国际化文案 */
867
+ i18n_resources: Lark.I18nResource[]
868
+ /** 单据托管认证token,托管回调会附带此token,帮助业务方认证 */
869
+ trusteeship_url_token?: string
870
+ /** 用户的类型,会影响请求参数用户标识域的选择,包括加签操作回传的目标用户, 目前仅支持 "user_id" */
871
+ trusteeship_user_id_type?: string
872
+ /** 单据托管回调接入方的接口的URL地址 */
873
+ trusteeship_urls?: Lark.TrusteeshipUrls
874
+ /** 托管预缓存策略 */
875
+ trusteeship_cache_config?: Lark.TrusteeshipInstanceCacheConfig
876
+ /** 资源所在地区, 内部统计用字段, 不需要填 */
877
+ resource_region?: string
878
+ }
879
+
880
+ export interface CreateResponse {
881
+ /** 同步的实例数据 */
882
+ data?: Lark.ExternalInstance
883
+ }
884
+
885
+ export interface CheckRequest {
886
+ /** 校验的实例信息 */
887
+ instances: Lark.ExteranlInstanceCheck[]
888
+ }
889
+
890
+ export interface CheckResponse {
891
+ /** 更新时间不一致的实例信息 */
892
+ diff_instances?: Lark.ExteranlInstanceCheckResponse[]
893
+ }
894
+ }
864
895
 
865
- export interface QueryApprovalTaskResponse {
866
- /** 任务列表 */
867
- tasks: Task[]
868
- /** 翻页 Token */
869
- page_token?: string
870
- /** 是否有更多任务可供拉取 */
871
- has_more?: boolean
872
- /** 列表计数,只在分页第一页返回 */
873
- count?: Count
896
+ export namespace ExternalTask {
897
+ export interface Methods {
898
+ /**
899
+ * 获取三方审批任务状态
900
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/external_task/list
901
+ */
902
+ list(body: ListRequest, query?: Pagination): Paginated<Lark.ExternalTaskList, 'data'>
903
+ }
904
+
905
+ export interface ListRequest {
906
+ /** 审批定义 Code,用于指定只获取这些定义下的数据 */
907
+ approval_codes?: string[]
908
+ /** 审批实例 ID, 用于指定只获取这些实例下的数据,最多支持 20 个 */
909
+ instance_ids?: string[]
910
+ /** 审批人 user_id,用于指定只获取这些用户的数据 */
911
+ user_ids?: string[]
912
+ /** 审批任务状态,用于指定获取该状态下的数据 */
913
+ status?: 'PENDING' | 'APPROVED' | 'REJECTED' | 'TRANSFERRED' | 'DONE'
914
+ }
915
+ }
874
916
  }
875
917
 
876
918
  Internal.define({
877
919
  '/approval/v4/approvals': {
878
- POST: 'createApproval',
920
+ POST: 'approval.create',
879
921
  },
880
922
  '/approval/v4/approvals/{approval_code}': {
881
- GET: 'getApproval',
923
+ GET: 'approval.get',
882
924
  },
883
925
  '/approval/v4/instances': {
884
- POST: 'createApprovalInstance',
885
- GET: { name: 'listApprovalInstance', pagination: { argIndex: 0, itemsKey: 'instance_code_list' } },
926
+ POST: 'approval.instance.create',
927
+ GET: { name: 'approval.instance.list', pagination: { argIndex: 0, itemsKey: 'instance_code_list' } },
886
928
  },
887
929
  '/approval/v4/instances/cancel': {
888
- POST: 'cancelApprovalInstance',
930
+ POST: 'approval.instance.cancel',
889
931
  },
890
932
  '/approval/v4/instances/cc': {
891
- POST: 'ccApprovalInstance',
933
+ POST: 'approval.instance.cc',
892
934
  },
893
935
  '/approval/v4/instances/preview': {
894
- POST: 'previewApprovalInstance',
936
+ POST: 'approval.instance.preview',
895
937
  },
896
938
  '/approval/v4/instances/{instance_id}': {
897
- GET: 'getApprovalInstance',
939
+ GET: 'approval.instance.get',
898
940
  },
899
941
  '/approval/v4/tasks/approve': {
900
- POST: 'approveApprovalTask',
942
+ POST: 'approval.task.approve',
901
943
  },
902
944
  '/approval/v4/tasks/reject': {
903
- POST: 'rejectApprovalTask',
945
+ POST: 'approval.task.reject',
904
946
  },
905
947
  '/approval/v4/tasks/transfer': {
906
- POST: 'transferApprovalTask',
948
+ POST: 'approval.task.transfer',
907
949
  },
908
950
  '/approval/v4/instances/specified_rollback': {
909
- POST: 'specifiedRollbackApprovalInstance',
951
+ POST: 'approval.instance.specifiedRollback',
910
952
  },
911
953
  '/approval/v4/instances/add_sign': {
912
- POST: 'addSignApprovalInstance',
954
+ POST: 'approval.instance.addSign',
913
955
  },
914
956
  '/approval/v4/tasks/resubmit': {
915
- POST: 'resubmitApprovalTask',
957
+ POST: 'approval.task.resubmit',
916
958
  },
917
959
  '/approval/v4/instances/{instance_id}/comments': {
918
- POST: 'createApprovalInstanceComment',
919
- GET: 'listApprovalInstanceComment',
960
+ POST: 'approval.instance.comment.create',
961
+ GET: 'approval.instance.comment.list',
920
962
  },
921
963
  '/approval/v4/instances/{instance_id}/comments/{comment_id}': {
922
- DELETE: 'deleteApprovalInstanceComment',
964
+ DELETE: 'approval.instance.comment.delete',
923
965
  },
924
966
  '/approval/v4/instances/{instance_id}/comments/remove': {
925
- POST: 'removeApprovalInstanceComment',
967
+ POST: 'approval.instance.comment.remove',
926
968
  },
927
969
  '/approval/v4/external_approvals': {
928
- POST: 'createApprovalExternalApproval',
970
+ POST: 'approval.externalApproval.create',
929
971
  },
930
972
  '/approval/v4/external_approvals/{approval_code}': {
931
- GET: 'getApprovalExternalApproval',
973
+ GET: 'approval.externalApproval.get',
932
974
  },
933
975
  '/approval/v4/external_instances': {
934
- POST: 'createApprovalExternalInstance',
976
+ POST: 'approval.externalInstance.create',
935
977
  },
936
978
  '/approval/v4/external_instances/check': {
937
- POST: 'checkApprovalExternalInstance',
979
+ POST: 'approval.externalInstance.check',
938
980
  },
939
981
  '/approval/v4/external_tasks': {
940
- GET: { name: 'listApprovalExternalTask', pagination: { argIndex: 1, itemsKey: 'data' } },
982
+ GET: { name: 'approval.externalTask.list', pagination: { argIndex: 1, itemsKey: 'data' } },
941
983
  },
942
984
  '/approval/v4/instances/query': {
943
- POST: { name: 'queryApprovalInstance', pagination: { argIndex: 1, itemsKey: 'instance_list' } },
985
+ POST: { name: 'approval.instance.query', pagination: { argIndex: 1, itemsKey: 'instance_list' } },
944
986
  },
945
987
  '/approval/v4/instances/search_cc': {
946
- POST: { name: 'searchCcApprovalInstance', pagination: { argIndex: 1, itemsKey: 'cc_list' } },
988
+ POST: { name: 'approval.instance.searchCc', pagination: { argIndex: 1, itemsKey: 'cc_list' } },
947
989
  },
948
990
  '/approval/v4/tasks/search': {
949
- POST: { name: 'searchApprovalTask', pagination: { argIndex: 1, itemsKey: 'task_list' } },
991
+ POST: { name: 'approval.task.search', pagination: { argIndex: 1, itemsKey: 'task_list' } },
950
992
  },
951
993
  '/approval/v4/tasks/query': {
952
- GET: { name: 'queryApprovalTask', pagination: { argIndex: 0, itemsKey: 'tasks' } },
994
+ GET: { name: 'approval.task.query', pagination: { argIndex: 0, itemsKey: 'tasks' } },
953
995
  },
954
996
  '/approval/v4/approvals/{approval_code}/subscribe': {
955
- POST: 'subscribeApproval',
997
+ POST: 'approval.subscribe',
956
998
  },
957
999
  '/approval/v4/approvals/{approval_code}/unsubscribe': {
958
- POST: 'unsubscribeApproval',
1000
+ POST: 'approval.unsubscribe',
959
1001
  },
960
1002
  })