@satorijs/adapter-lark 3.10.6 → 3.11.0

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