@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,646 +1,832 @@
1
- import { AllowedRollbaclkTaskItemType, AuditLogDetail, AuditLogEsField, Criterion, EnvironmentVariable, EnvironmentVariableFilter, ObjectMeta, RecordGroupByItem, RecordResult, RoleMember, SearchObjectParam, Sort, UserTask } from '.'
2
- import { Internal } from '../internal'
1
+ import * as Lark from '.'
2
+ import { Internal, Paginated, Pagination } from '../internal'
3
3
 
4
4
  declare module '../internal' {
5
5
  interface Internal {
6
- /**
7
- * 查询审计日志列表
8
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/audit_log_list
9
- */
10
- auditLogListApaasApplicationAuditLog(namespace: string, query?: AuditLogListApaasApplicationAuditLogQuery): Promise<AuditLogListApaasApplicationAuditLogResponse>
11
- /**
12
- * 查询审计日志详情
13
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/get
14
- */
15
- getApaasApplicationAuditLog(namespace: string, query?: GetApaasApplicationAuditLogQuery): Promise<GetApaasApplicationAuditLogResponse>
16
- /**
17
- * 批量删除角色成员授权
18
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/batch_remove_authorization
19
- */
20
- batchRemoveAuthorizationApaasApplicationRoleMember(namespace: string, role_api_name: string, body: BatchRemoveAuthorizationApaasApplicationRoleMemberRequest): Promise<void>
21
- /**
22
- * 批量创建角色成员授权
23
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/batch_create_authorization
24
- */
25
- batchCreateAuthorizationApaasApplicationRoleMember(namespace: string, role_api_name: string, body: BatchCreateAuthorizationApaasApplicationRoleMemberRequest): Promise<void>
26
- /**
27
- * 查询角色成员信息
28
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/get
29
- */
30
- getApaasApplicationRoleMember(namespace: string, role_api_name: string, query?: GetApaasApplicationRoleMemberQuery): Promise<GetApaasApplicationRoleMemberResponse>
31
- /**
32
- * 批量删除记录权限用户授权
33
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_remove_authorization
34
- */
35
- batchRemoveAuthorizationApaasApplicationRecordPermissionMember(namespace: string, record_permission_api_name: string, body: BatchRemoveAuthorizationApaasApplicationRecordPermissionMemberRequest): Promise<void>
36
- /**
37
- * 批量创建记录权限用户授权
38
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_create_authorization
39
- */
40
- batchCreateAuthorizationApaasApplicationRecordPermissionMember(namespace: string, record_permission_api_name: string, body: BatchCreateAuthorizationApaasApplicationRecordPermissionMemberRequest): Promise<void>
41
- /**
42
- * 执行 OQL
43
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object/oql_query
44
- */
45
- oqlQueryApaasApplicationObject(namespace: string, body: OqlQueryApaasApplicationObjectRequest): Promise<OqlQueryApaasApplicationObjectResponse>
46
- /**
47
- * 搜索记录
48
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object/search
49
- */
50
- searchApaasApplicationObject(namespace: string, body: SearchApaasApplicationObjectRequest): Promise<SearchApaasApplicationObjectResponse>
51
- /**
52
- * 获取记录详情
53
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/query
54
- */
55
- queryApaasApplicationObjectRecord(namespace: string, object_api_name: string, id: string, body: QueryApaasApplicationObjectRecordRequest): Promise<QueryApaasApplicationObjectRecordResponse>
56
- /**
57
- * 编辑记录
58
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/patch
59
- */
60
- patchApaasApplicationObjectRecord(namespace: string, object_api_name: string, id: string, body: PatchApaasApplicationObjectRecordRequest): Promise<void>
61
- /**
62
- * 删除记录
63
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/delete
64
- */
65
- deleteApaasApplicationObjectRecord(namespace: string, object_api_name: string, id: string): Promise<void>
66
- /**
67
- * 新建记录
68
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/create
69
- */
70
- createApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: CreateApaasApplicationObjectRecordRequest): Promise<CreateApaasApplicationObjectRecordResponse>
71
- /**
72
- * 批量编辑记录
73
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_update
74
- */
75
- batchUpdateApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: BatchUpdateApaasApplicationObjectRecordRequest): Promise<BatchUpdateApaasApplicationObjectRecordResponse>
76
- /**
77
- * 查询记录列表
78
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_query
79
- */
80
- batchQueryApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: BatchQueryApaasApplicationObjectRecordRequest): Promise<BatchQueryApaasApplicationObjectRecordResponse>
81
- /**
82
- * 批量删除记录
83
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_delete
84
- */
85
- batchDeleteApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: BatchDeleteApaasApplicationObjectRecordRequest): Promise<BatchDeleteApaasApplicationObjectRecordResponse>
86
- /**
87
- * 批量新建记录
88
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_create
89
- */
90
- batchCreateApaasApplicationObjectRecord(namespace: string, object_api_name: string, body: BatchCreateApaasApplicationObjectRecordRequest): Promise<BatchCreateApaasApplicationObjectRecordResponse>
91
- /**
92
- * 执行函数
93
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-function/invoke
94
- */
95
- invokeApaasApplicationFunction(namespace: string, function_api_name: string, body: InvokeApaasApplicationFunctionRequest): Promise<InvokeApaasApplicationFunctionResponse>
96
- /**
97
- * 查询环境变量列表
98
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-environment_variable/query
99
- */
100
- queryApaasApplicationEnvironmentVariable(namespace: string, body: QueryApaasApplicationEnvironmentVariableRequest): Promise<QueryApaasApplicationEnvironmentVariableResponse>
101
- /**
102
- * 查询环境变量详情
103
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-environment_variable/get
104
- */
105
- getApaasApplicationEnvironmentVariable(namespace: string, environment_variable_api_name: string): Promise<GetApaasApplicationEnvironmentVariableResponse>
106
- /**
107
- * 发起流程
108
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-flow/execute
109
- */
110
- executeApaasApplicationFlow(namespace: string, flow_id: string, body: ExecuteApaasApplicationFlowRequest): Promise<ExecuteApaasApplicationFlowResponse>
111
- /**
112
- * 查询人工任务
113
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/query
114
- */
115
- queryApaasUserTask(body: QueryApaasUserTaskRequest): Promise<QueryApaasUserTaskResponse>
116
- /**
117
- * 同意人工任务
118
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/agree
119
- */
120
- agreeApaasApprovalTask(approval_task_id: string, body: AgreeApaasApprovalTaskRequest): Promise<void>
121
- /**
122
- * 拒绝人工任务
123
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/reject
124
- */
125
- rejectApaasApprovalTask(approval_task_id: string, body: RejectApaasApprovalTaskRequest): Promise<void>
126
- /**
127
- * 转交人工任务
128
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/transfer
129
- */
130
- transferApaasApprovalTask(approval_task_id: string, body: TransferApaasApprovalTaskRequest): Promise<void>
131
- /**
132
- * 人工任务加签
133
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/add_assignee
134
- */
135
- addAssigneeApaasApprovalTask(approval_task_id: string, body: AddAssigneeApaasApprovalTaskRequest): Promise<void>
136
- /**
137
- * 抄送人工任务
138
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/cc
139
- */
140
- ccApaasUserTask(task_id: string, body: CcApaasUserTaskRequest): Promise<void>
141
- /**
142
- * 催办人工任务
143
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/expediting
144
- */
145
- expeditingApaasUserTask(task_id: string, body: ExpeditingApaasUserTaskRequest): Promise<void>
146
- /**
147
- * 撤销人工任务
148
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_instance/cancel
149
- */
150
- cancelApaasApprovalInstance(approval_instance_id: string, body: CancelApaasApprovalInstanceRequest): Promise<void>
151
- /**
152
- * 查询人工任务可退回的位置
153
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/rollback_points
154
- */
155
- rollbackPointsApaasUserTask(task_id: string, body: RollbackPointsApaasUserTaskRequest): Promise<RollbackPointsApaasUserTaskResponse>
156
- /**
157
- * 退回人工任务
158
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/rollback
159
- */
160
- rollbackApaasUserTask(task_id: string, body: RollbackApaasUserTaskRequest): Promise<void>
161
- /**
162
- * 基于人工任务发起群聊
163
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/chat_group
164
- */
165
- chatGroupApaasUserTask(task_id: string, body: ChatGroupApaasUserTaskRequest): Promise<ChatGroupApaasUserTaskResponse>
6
+ apaas: Apaas.Methods
166
7
  }
167
8
  }
168
9
 
169
- export interface AuditLogListApaasApplicationAuditLogQuery {
170
- /** 分页大小 */
171
- page_size: string
172
- /** 翻页数量 */
173
- offset: string
174
- /** 模糊查询 */
175
- quick_query?: string
176
- /** 查询时间范围:开始时间 */
177
- from: string
178
- /** 查询时间范围:结束时间 */
179
- to: string
180
- /** 日志类型:10001-企业管理日志,10003-应用管理日志,10002-登录日志 */
181
- log_type: string
182
- /** 日志查询:筛选能力 */
183
- filter?: string
184
- /** 日志列表:选择展示行信息,例如["opTime","appName","eventName","clientIP","operator","status"] */
185
- columns?: string[]
186
- /** 查询排序字段:可选项为操作时间(opTime) */
187
- sort_by?: string
188
- /** 查询排序:按时间从小到大使用 asc */
189
- sort_order?: string
190
- /** 应用类型,0为apaas类型,1为aily类型 */
191
- app_type?: string
192
- }
193
-
194
- export interface AuditLogListApaasApplicationAuditLogResponse {
195
- /** 审计日志查询结果列表详情信息 */
196
- items?: AuditLogEsField[]
197
- /** 审计日志查询总条数 */
198
- total?: string
199
- }
200
-
201
- export interface GetApaasApplicationAuditLogQuery {
202
- /** 审计日志ID信息 */
203
- log_id: string
204
- }
205
-
206
- export interface GetApaasApplicationAuditLogResponse {
207
- /** 审计日志详情信息 */
208
- data?: AuditLogDetail
209
- }
210
-
211
- export interface BatchRemoveAuthorizationApaasApplicationRoleMemberRequest {
212
- /** 需要删除的用户 ID 列表 */
213
- user_ids?: string[]
214
- /** 需要删除的部门 ID 列表 */
215
- department_ids?: string[]
216
- }
217
-
218
- export interface BatchCreateAuthorizationApaasApplicationRoleMemberRequest {
219
- /** 需要新增的用户 ID 列表 */
220
- user_ids?: string[]
221
- /** 需要新增的部门 ID 列表 */
222
- department_ids?: string[]
223
- }
224
-
225
- export interface GetApaasApplicationRoleMemberQuery {
226
- /** 是否需要公式的展示名称,便于前端展示 */
227
- need_display_name?: boolean
228
- /** 是否使用 APIID字段作为出入参,默认值为 false */
229
- use_api_id?: boolean
230
- }
231
-
232
- export interface GetApaasApplicationRoleMemberResponse {
233
- /** 角色成员 */
234
- role_member?: RoleMember
235
- }
236
-
237
- export interface BatchRemoveAuthorizationApaasApplicationRecordPermissionMemberRequest {
238
- /** 需要删除的用户 ID 列表 */
239
- user_ids?: string[]
240
- }
241
-
242
- export interface BatchCreateAuthorizationApaasApplicationRecordPermissionMemberRequest {
243
- /** 需要新增的用户 ID 列表 */
244
- user_ids?: string[]
245
- }
246
-
247
- export interface OqlQueryApaasApplicationObjectRequest {
248
- /** 待执行的 OQL 语句(关于支持的关键词及操作符,详见查看) */
249
- query: string
250
- /** 用于指定 OQL 语句中匿名参数的具体值 */
251
- args?: string
252
- /** 用于指定 OQL 语句中具名参数的具体值 */
253
- named_args?: string
254
- }
255
-
256
- export interface OqlQueryApaasApplicationObjectResponse {
257
- /** 每一列的标题 */
258
- columns: string[]
259
- /** 每一行的值,以「key-value」的形式返回 */
260
- rows: string
261
- }
262
-
263
- export interface SearchApaasApplicationObjectRequest {
264
- /** 搜索词 */
265
- q?: string
266
- /** 搜索对象范围 */
267
- search_objects?: SearchObjectParam[]
268
- /** 分页参数,第一次搜索时为空,需要分页查询时使用 SearchRecordsResponse 中的结果 */
269
- page_token?: string
270
- /** 返回数量,默认为50,最大不超过2000 */
271
- page_size?: string
272
- /** 返回元数据枚举值 */
273
- metadata?: 'Label' | 'SearchLayout'
274
- }
275
-
276
- export interface SearchApaasApplicationObjectResponse {
277
- /** 搜索结果列表 */
278
- records?: string
279
- /** 是否还有更多数据 */
280
- has_more?: boolean
281
- /** 分页标记,当 HasMore 为 true 时,会同时返回新的 NextPageToken */
282
- next_page_token?: string
283
- /** 对象信息 */
284
- objects?: ObjectMeta[]
285
- }
286
-
287
- export interface QueryApaasApplicationObjectRecordRequest {
288
- /** 需要获取的字段,使用字段唯一标识符进行查询,关联字段可使用 . 进行下钻 */
289
- select?: string[]
290
- }
291
-
292
- export interface QueryApaasApplicationObjectRecordResponse {
293
- /** 记录详情,格式为 Map<string, ANY> */
294
- item: string
295
- }
296
-
297
- export interface PatchApaasApplicationObjectRecordRequest {
298
- /** 创建对象使用的数据,键为字段 API 名称,值为字段值,格式可参考字段值格式 */
299
- record: string
300
- }
301
-
302
- export interface CreateApaasApplicationObjectRecordRequest {
303
- /** 创建对象使用的数据,键为字段 API 名称,值为字段值,格式可参考字段值格式 */
304
- record: string
305
- }
306
-
307
- export interface CreateApaasApplicationObjectRecordResponse {
308
- /** 记录 ID */
309
- id?: string
310
- }
311
-
312
- export interface BatchUpdateApaasApplicationObjectRecordRequest {
313
- /** 记录详情列表,格式为 List<Map<string, ANY>>,操作记录数上限为 500 条 */
314
- records: string
315
- }
316
-
317
- export interface BatchUpdateApaasApplicationObjectRecordResponse {
318
- /** 处理结果 */
319
- items?: RecordResult[]
320
- }
321
-
322
- export interface BatchQueryApaasApplicationObjectRecordRequest {
323
- /** 需要获取的字段,使用字段唯一标识符进行查询,关联字段可使用「.」进行下钻 */
324
- select: string[]
325
- /** 筛选条件,通过 JSON 格式指定条件 */
326
- filter?: Criterion
327
- /** 排序参数,通过 JSON 格式指定条件。其中, field 为参与排序字段,direction 为排序方向,多个条件按其在数组中的顺序生效。 */
328
- order_by?: Sort[]
329
- /** 聚合参数,通过 JSON 格式指定条件。其中, field 为参与聚合的字段。 */
330
- group_by?: RecordGroupByItem[]
331
- /** 分页的 Token 值,由服务端生成,可从 Response 中的 next_page_token 参数中获取。注意:第一页需填写空字符串 "",且不能与 OFFSET 一起使用。 */
332
- page_token?: string
333
- /** 是否使用 page_token 功能。为 True 时将使用 page_token 的值作为起始位置查询记录,并且会在 Response 中返回 next_page_token 。默认为 False 。 */
334
- use_page_token?: boolean
335
- /** 期望服务端返回的记录条数,上限 500 条。不填则取默认值,默认值为 500。 */
336
- page_size?: number
337
- /** 返回记录的偏移量,默认为 0 ,即从查询到的第一条记录开始返回。offset 较大时查询性能较差,可能引起接口响应超时,拉取全部记录时建议使用 ID 游标分页,具体见 ID 游标分页说明 */
338
- offset?: number
339
- /** 是否返回符合条件的记录总数(Total)。默认为 False,不返回记录总数。 */
340
- need_total_count?: boolean
341
- }
342
-
343
- export interface BatchQueryApaasApplicationObjectRecordResponse {
344
- /** 符合条件的记录列表 */
345
- items: string
346
- /** 符合条件的记录数 */
347
- total?: number
348
- /** 下一页的起始位置 Token ,访问至末尾时不返回 */
349
- next_page_token?: string
350
- /** 是否还有数据 */
351
- has_more?: boolean
352
- }
353
-
354
- export interface BatchDeleteApaasApplicationObjectRecordRequest {
355
- /** 记录 ID 列表,操作记录数上限为 500 */
356
- ids: string[]
357
- }
358
-
359
- export interface BatchDeleteApaasApplicationObjectRecordResponse {
360
- /** 处理结果 */
361
- items?: RecordResult[]
362
- }
363
-
364
- export interface BatchCreateApaasApplicationObjectRecordRequest {
365
- /** 记录详情列表,格式为 List<Map<string, ANY>>,操作记录数上限为 500 条 */
366
- records: string
367
- }
368
-
369
- export interface BatchCreateApaasApplicationObjectRecordResponse {
370
- /** 处理结果 */
371
- items?: RecordResult[]
372
- }
373
-
374
- export interface InvokeApaasApplicationFunctionRequest {
375
- /** 函数输入参数(JSON 序列化后的字符串) */
376
- params?: string
377
- }
378
-
379
- export interface InvokeApaasApplicationFunctionResponse {
380
- /** 函数执行的返回结果(JSON 序列化后的字符串) */
381
- result?: string
382
- }
383
-
384
- export interface QueryApaasApplicationEnvironmentVariableRequest {
385
- /** 过滤条件 */
386
- filter?: EnvironmentVariableFilter
387
- /** 限制的条数,默认为 500,不可超过 500 */
388
- limit?: number
389
- /** 返回记录的偏移量,默认为 0,即从查询到的第一个记录开始返回 */
390
- offset?: number
391
- }
392
-
393
- export interface QueryApaasApplicationEnvironmentVariableResponse {
394
- /** 环境变量列表 */
395
- items?: EnvironmentVariable[]
396
- /** 符合查询条件的环境变量的总数 */
397
- total: number
398
- }
399
-
400
- export interface GetApaasApplicationEnvironmentVariableResponse {
401
- /** 环境变量详情 */
402
- item?: EnvironmentVariable
403
- }
404
-
405
- export interface ExecuteApaasApplicationFlowRequest {
406
- /** 是否异步执行 */
407
- is_async?: boolean
408
- /** 幂等信息 */
409
- idempotent_key?: string
410
- /** 循环信息 */
411
- loop_masks?: string[]
412
- /** 流程入参 */
413
- params?: string
414
- /** 操作人 */
415
- operator: string
416
- }
417
-
418
- export interface ExecuteApaasApplicationFlowResponse {
419
- /** 状态 */
420
- status?: string
421
- /** 输出参数 */
422
- out_params?: string
423
- /** 执行id */
424
- execution_id?: string
425
- /** 错误信息 */
426
- error_msg?: string
427
- /** code */
428
- code?: string
429
- }
430
-
431
- export interface QueryApaasUserTaskRequest {
432
- /** 类型 */
433
- type?: string
434
- /** 来源 */
435
- source?: string
436
- /** 获取条数 */
437
- limit?: string
438
- /** 起始位置 */
439
- offset?: string
440
- /** 开始时间 */
441
- start_time?: string
442
- /** 结束时间 */
443
- end_time?: string
444
- /** 流程apiid列表 */
445
- api_ids?: string[]
446
- /** kunlunUserID */
447
- kunlun_user_id: string
448
- }
449
-
450
- export interface QueryApaasUserTaskResponse {
451
- /** 总任务条数 */
452
- count?: string
453
- /** 任务信息 */
454
- tasks?: UserTask[]
455
- }
456
-
457
- export interface AgreeApaasApprovalTaskRequest {
458
- /** 操作人id */
459
- user_id: string
460
- /** 审批意见 */
461
- opinion?: string
462
- }
463
-
464
- export interface RejectApaasApprovalTaskRequest {
465
- /** 操作用户id */
466
- user_id: string
467
- /** 审批意见 */
468
- opinion?: string
469
- }
470
-
471
- export interface TransferApaasApprovalTaskRequest {
472
- /** 操作人id */
473
- user_id: string
474
- /** 原审批人id */
475
- from_user_ids?: string[]
476
- /** 新审批人id */
477
- to_user_ids?: string[]
478
- /** 审批意见 */
479
- opinion?: string
480
- }
481
-
482
- export interface AddAssigneeApaasApprovalTaskRequest {
483
- /** 操作人id */
484
- user_id: string
485
- /** 审批人列表 */
486
- approvers?: string[]
487
- /** 加签类型 */
488
- add_assignee_type?: string
489
- /** 加签原因 */
490
- opinion?: string
491
- }
492
-
493
- export interface CcApaasUserTaskRequest {
494
- /** 抄送人的kunlunID列表 */
495
- cc_user_ids: string[]
496
- /** 操作人kunlunUserID */
497
- operator_user_id: string
498
- }
499
-
500
- export interface ExpeditingApaasUserTaskRequest {
501
- /** 操作人kunlunUserID */
502
- operator_user_id: string
503
- /** 催办人的kunlunID列表 */
504
- expediting_user_ids: string[]
505
- /** 催办理由 */
506
- opinion?: string
507
- }
10
+ export namespace Apaas {
11
+ export interface Methods {
12
+ seatAssignment: SeatAssignment.Methods
13
+ seatActivity: SeatActivity.Methods
14
+ application: Application.Methods
15
+ userTask: UserTask.Methods
16
+ approvalTask: ApprovalTask.Methods
17
+ approvalInstance: ApprovalInstance.Methods
18
+ }
508
19
 
509
- export interface CancelApaasApprovalInstanceRequest {
510
- /** 操作用户id */
511
- user_id: string
512
- /** 撤销原因 */
513
- opinion: string
514
- }
20
+ export namespace SeatAssignment {
21
+ export interface Methods {
22
+ /**
23
+ * 查询席位分配详情
24
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/seat_assignment/list
25
+ */
26
+ list(query?: ListQuery): Paginated<Lark.SeatAssignment>
27
+ }
28
+
29
+ export interface ListQuery extends Pagination {
30
+ /** 席位类型,枚举值:1.平台席位 2. 应用访问席位 */
31
+ seat_type: 'per_user' | 'per_user_per_app'
32
+ }
33
+ }
515
34
 
516
- export interface RollbackPointsApaasUserTaskRequest {
517
- /** 操作人kunlunUserID */
518
- operator_user_id: string
519
- }
35
+ export namespace SeatActivity {
36
+ export interface Methods {
37
+ /**
38
+ * 查询席位活跃详情
39
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/seat_activity/list
40
+ */
41
+ list(query?: ListQuery): Paginated<Lark.SeatActivity>
42
+ }
43
+
44
+ export interface ListQuery extends Pagination {
45
+ /** 席位类型,枚举值:1. 平台席位2. 应用席位 */
46
+ seat_type: 'per_user' | 'per_user_per_app'
47
+ }
48
+ }
520
49
 
521
- export interface RollbackPointsApaasUserTaskResponse {
522
- /** 任务列表 */
523
- tasks?: AllowedRollbaclkTaskItemType[]
524
- }
50
+ export namespace Application {
51
+ export interface Methods {
52
+ auditLog: AuditLog.Methods
53
+ role: Role.Methods
54
+ recordPermission: RecordPermission.Methods
55
+ object: Object.Methods
56
+ function: Function.Methods
57
+ environmentVariable: EnvironmentVariable.Methods
58
+ flow: Flow.Methods
59
+ }
60
+
61
+ export namespace AuditLog {
62
+ export interface Methods {
63
+ /**
64
+ * 查询审计日志列表
65
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/audit_log_list
66
+ */
67
+ auditLogList(namespace: string, query?: AuditLogListQuery): Promise<AuditLogListResponse>
68
+ /**
69
+ * 查询审计日志详情
70
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/get
71
+ */
72
+ get(namespace: string, query?: GetQuery): Promise<GetResponse>
73
+ /**
74
+ * 查询数据变更日志列表
75
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/data_change_logs_list
76
+ */
77
+ dataChangeLogsList(namespace: string, query?: DataChangeLogsListQuery): Promise<DataChangeLogsListResponse>
78
+ /**
79
+ * 查询数据变更日志详情
80
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-audit_log/data_change_log_detail
81
+ */
82
+ dataChangeLogDetail(namespace: string, query?: DataChangeLogDetailQuery): Promise<DataChangeLogDetailResponse>
83
+ }
84
+
85
+ export interface AuditLogListQuery {
86
+ /** 分页大小 */
87
+ page_size: string
88
+ /** 翻页数量 */
89
+ offset: string
90
+ /** 模糊查询 */
91
+ quick_query?: string
92
+ /** 查询时间范围:开始时间 */
93
+ from: string
94
+ /** 查询时间范围:结束时间 */
95
+ to: string
96
+ /** 日志类型:10001-企业管理日志,10003-应用管理日志,10002-登录日志 */
97
+ log_type: string
98
+ /** 日志查询:筛选能力 */
99
+ filter?: string
100
+ /** 日志列表:选择展示行信息,例如["opTime","appName","eventName","clientIP","operator","status"] */
101
+ columns?: string[]
102
+ /** 查询排序字段:可选项为操作时间(opTime) */
103
+ sort_by?: string
104
+ /** 查询排序:按时间从小到大使用 asc */
105
+ sort_order?: string
106
+ /** 应用类型,0为apaas类型,1为aily类型 */
107
+ app_type?: string
108
+ }
109
+
110
+ export interface AuditLogListResponse {
111
+ /** 审计日志查询结果列表详情信息 */
112
+ items?: Lark.AuditLogEsField[]
113
+ /** 审计日志查询总条数 */
114
+ total?: string
115
+ }
116
+
117
+ export interface GetQuery {
118
+ /** 审计日志ID信息 */
119
+ log_id: string
120
+ }
121
+
122
+ export interface GetResponse {
123
+ /** 审计日志详情信息 */
124
+ data?: Lark.AuditLogDetail
125
+ }
126
+
127
+ export interface DataChangeLogsListQuery {
128
+ /** 模糊查询 */
129
+ quick_query?: string
130
+ /** 分页大小 */
131
+ page_size: string
132
+ /** 翻页数量 */
133
+ offset: string
134
+ /** 查询时间范围:开始时间 */
135
+ from?: string
136
+ /** 查询时间范围:结束时间 */
137
+ to?: string
138
+ /** 日志类型:10007-数据变更日志 */
139
+ log_type: string
140
+ /** 日志查询:筛选能力 */
141
+ filter?: string
142
+ /** 日志列表:选择展示行信息,例如["opTime","appName","eventName","clientIP","operator","status"] */
143
+ columns?: string[]
144
+ /** 查询排序字段:可选项为操作时间(opTime) */
145
+ sort_by?: string
146
+ /** 查询排序:按时间从小到大使用 asc */
147
+ sort_order?: string
148
+ /** 应用类型,0为apaas类型,1为aily类型 */
149
+ app_type?: string
150
+ }
151
+
152
+ export interface DataChangeLogsListResponse {
153
+ /** 数据变更日志查询结果列表详情信息 */
154
+ items?: Lark.AuditLogEsField[]
155
+ /** 数据变更日志查询总条数 */
156
+ total?: string
157
+ }
158
+
159
+ export interface DataChangeLogDetailQuery {
160
+ /** 数据变更日志ID信息 */
161
+ log_id: string
162
+ }
163
+
164
+ export interface DataChangeLogDetailResponse {
165
+ /** 数据变更日志详情信息 */
166
+ data?: Lark.AuditLogDetail
167
+ }
168
+ }
169
+
170
+ export namespace Role {
171
+ export interface Methods {
172
+ member: Member.Methods
173
+ }
174
+
175
+ export namespace Member {
176
+ export interface Methods {
177
+ /**
178
+ * 批量删除角色成员授权
179
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/batch_remove_authorization
180
+ */
181
+ batchRemoveAuthorization(namespace: string, role_api_name: string, body: BatchRemoveAuthorizationRequest): Promise<void>
182
+ /**
183
+ * 批量创建角色成员授权
184
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/batch_create_authorization
185
+ */
186
+ batchCreateAuthorization(namespace: string, role_api_name: string, body: BatchCreateAuthorizationRequest): Promise<void>
187
+ /**
188
+ * 查询角色成员信息
189
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-role-member/get
190
+ */
191
+ get(namespace: string, role_api_name: string, query?: GetQuery): Promise<GetResponse>
192
+ }
193
+
194
+ export interface BatchRemoveAuthorizationRequest {
195
+ /** 需要删除的用户 ID 列表 */
196
+ user_ids?: string[]
197
+ /** 需要删除的部门 ID 列表 */
198
+ department_ids?: string[]
199
+ }
200
+
201
+ export interface BatchCreateAuthorizationRequest {
202
+ /** 需要新增的用户 ID 列表 */
203
+ user_ids?: string[]
204
+ /** 需要新增的部门 ID 列表 */
205
+ department_ids?: string[]
206
+ }
207
+
208
+ export interface GetQuery {
209
+ /** 是否需要公式的展示名称,便于前端展示 */
210
+ need_display_name?: boolean
211
+ /** 是否使用 APIID字段作为出入参,默认值为 false */
212
+ use_api_id?: boolean
213
+ }
214
+
215
+ export interface GetResponse {
216
+ /** 角色成员 */
217
+ role_member?: Lark.RoleMember
218
+ }
219
+ }
220
+ }
221
+
222
+ export namespace RecordPermission {
223
+ export interface Methods {
224
+ member: Member.Methods
225
+ }
226
+
227
+ export namespace Member {
228
+ export interface Methods {
229
+ /**
230
+ * 批量删除记录权限用户授权
231
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_remove_authorization
232
+ */
233
+ batchRemoveAuthorization(namespace: string, record_permission_api_name: string, body: BatchRemoveAuthorizationRequest): Promise<void>
234
+ /**
235
+ * 批量创建记录权限用户授权
236
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_create_authorization
237
+ */
238
+ batchCreateAuthorization(namespace: string, record_permission_api_name: string, body: BatchCreateAuthorizationRequest): Promise<void>
239
+ }
240
+
241
+ export interface BatchRemoveAuthorizationRequest {
242
+ /** 需要删除的用户 ID 列表 */
243
+ user_ids?: string[]
244
+ }
245
+
246
+ export interface BatchCreateAuthorizationRequest {
247
+ /** 需要新增的用户 ID 列表 */
248
+ user_ids?: string[]
249
+ }
250
+ }
251
+ }
252
+
253
+ export namespace Object {
254
+ export interface Methods {
255
+ record: Record.Methods
256
+ /**
257
+ * 执行 OQL
258
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object/oql_query
259
+ */
260
+ oqlQuery(namespace: string, body: OqlQueryRequest): Promise<OqlQueryResponse>
261
+ /**
262
+ * 搜索记录
263
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object/search
264
+ */
265
+ search(namespace: string, body: SearchRequest): Promise<SearchResponse>
266
+ }
267
+
268
+ export interface OqlQueryRequest {
269
+ /** 待执行的 OQL 语句(关于支持的关键词及操作符,详见查看) */
270
+ query: string
271
+ /** 用于指定 OQL 语句中匿名参数的具体值 */
272
+ args?: string
273
+ /** 用于指定 OQL 语句中具名参数的具体值 */
274
+ named_args?: string
275
+ }
276
+
277
+ export interface OqlQueryResponse {
278
+ /** 每一列的标题 */
279
+ columns: string[]
280
+ /** 每一行的值,以「key-value」的形式返回 */
281
+ rows: string
282
+ }
283
+
284
+ export interface SearchRequest {
285
+ /** 搜索词 */
286
+ q?: string
287
+ /** 搜索对象范围 */
288
+ search_objects?: Lark.SearchObjectParam[]
289
+ /** 分页参数,第一次搜索时为空,需要分页查询时使用 SearchRecordsResponse 中的结果 */
290
+ page_token?: string
291
+ /** 返回数量,默认为50,最大不超过2000 */
292
+ page_size?: string
293
+ /** 返回元数据枚举值 */
294
+ metadata?: 'Label' | 'SearchLayout'
295
+ }
296
+
297
+ export interface SearchResponse {
298
+ /** 搜索结果列表 */
299
+ records?: string
300
+ /** 是否还有更多数据 */
301
+ has_more?: boolean
302
+ /** 分页标记,当 HasMore 为 true 时,会同时返回新的 NextPageToken */
303
+ next_page_token?: string
304
+ /** 对象信息 */
305
+ objects?: Lark.ObjectMeta[]
306
+ }
307
+
308
+ export namespace Record {
309
+ export interface Methods {
310
+ /**
311
+ * 获取记录详情
312
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/query
313
+ */
314
+ query(namespace: string, object_api_name: string, id: string, body: QueryRequest): Promise<QueryResponse>
315
+ /**
316
+ * 编辑记录
317
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/patch
318
+ */
319
+ patch(namespace: string, object_api_name: string, id: string, body: PatchRequest): Promise<void>
320
+ /**
321
+ * 删除记录
322
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/delete
323
+ */
324
+ delete(namespace: string, object_api_name: string, id: string): Promise<void>
325
+ /**
326
+ * 新建记录
327
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/create
328
+ */
329
+ create(namespace: string, object_api_name: string, body: CreateRequest): Promise<CreateResponse>
330
+ /**
331
+ * 批量编辑记录
332
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_update
333
+ */
334
+ batchUpdate(namespace: string, object_api_name: string, body: BatchUpdateRequest): Promise<BatchUpdateResponse>
335
+ /**
336
+ * 查询记录列表
337
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_query
338
+ */
339
+ batchQuery(namespace: string, object_api_name: string, body: BatchQueryRequest): Promise<BatchQueryResponse>
340
+ /**
341
+ * 批量删除记录
342
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_delete
343
+ */
344
+ batchDelete(namespace: string, object_api_name: string, body: BatchDeleteRequest): Promise<BatchDeleteResponse>
345
+ /**
346
+ * 批量新建记录
347
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_create
348
+ */
349
+ batchCreate(namespace: string, object_api_name: string, body: BatchCreateRequest): Promise<BatchCreateResponse>
350
+ }
351
+
352
+ export interface QueryRequest {
353
+ /** 需要获取的字段,使用字段唯一标识符进行查询,关联字段可使用 . 进行下钻 */
354
+ select?: string[]
355
+ }
356
+
357
+ export interface QueryResponse {
358
+ /** 记录详情,格式为 Map<string, ANY> */
359
+ item: string
360
+ }
361
+
362
+ export interface PatchRequest {
363
+ /** 创建对象使用的数据,键为字段 API 名称,值为字段值,格式可参考字段值格式 */
364
+ record: string
365
+ }
366
+
367
+ export interface CreateRequest {
368
+ /** 创建对象使用的数据,键为字段 API 名称,值为字段值,格式可参考字段值格式 */
369
+ record: string
370
+ }
371
+
372
+ export interface CreateResponse {
373
+ /** 记录 ID */
374
+ id?: string
375
+ }
376
+
377
+ export interface BatchUpdateRequest {
378
+ /** 记录详情列表,格式为 List<Map<string, ANY>>,操作记录数上限为 500 条 */
379
+ records: string
380
+ }
381
+
382
+ export interface BatchUpdateResponse {
383
+ /** 处理结果 */
384
+ items?: Lark.RecordResult[]
385
+ }
386
+
387
+ export interface BatchQueryRequest {
388
+ /** 需要获取的字段,使用字段唯一标识符进行查询,关联字段可使用「.」进行下钻 */
389
+ select: string[]
390
+ /** 筛选条件,通过 JSON 格式指定条件 */
391
+ filter?: Lark.Criterion
392
+ /** 排序参数,通过 JSON 格式指定条件。其中, field 为参与排序字段,direction 为排序方向,多个条件按其在数组中的顺序生效。 */
393
+ order_by?: Lark.Sort[]
394
+ /** 聚合参数,通过 JSON 格式指定条件。其中, field 为参与聚合的字段。 */
395
+ group_by?: Lark.RecordGroupByItem[]
396
+ /** 分页的 Token 值,由服务端生成,可从 Response 中的 next_page_token 参数中获取。注意:第一页需填写空字符串 "",且不能与 OFFSET 一起使用。 */
397
+ page_token?: string
398
+ /** 是否使用 page_token 功能。为 True 时将使用 page_token 的值作为起始位置查询记录,并且会在 Response 中返回 next_page_token 。默认为 False 。 */
399
+ use_page_token?: boolean
400
+ /** 期望服务端返回的记录条数,上限 500 条。不填则取默认值,默认值为 500。 */
401
+ page_size?: number
402
+ /** 返回记录的偏移量,默认为 0 ,即从查询到的第一条记录开始返回。offset 较大时查询性能较差,可能引起接口响应超时,拉取全部记录时建议使用 ID 游标分页,具体见 ID 游标分页说明 */
403
+ offset?: number
404
+ /** 是否返回符合条件的记录总数(Total)。默认为 False,不返回记录总数。 */
405
+ need_total_count?: boolean
406
+ }
407
+
408
+ export interface BatchQueryResponse {
409
+ /** 符合条件的记录列表 */
410
+ items: string
411
+ /** 符合条件的记录数 */
412
+ total?: number
413
+ /** 下一页的起始位置 Token ,访问至末尾时不返回 */
414
+ next_page_token?: string
415
+ /** 是否还有数据 */
416
+ has_more?: boolean
417
+ }
418
+
419
+ export interface BatchDeleteRequest {
420
+ /** 记录 ID 列表,操作记录数上限为 500 */
421
+ ids: string[]
422
+ }
423
+
424
+ export interface BatchDeleteResponse {
425
+ /** 处理结果 */
426
+ items?: Lark.RecordResult[]
427
+ }
428
+
429
+ export interface BatchCreateRequest {
430
+ /** 记录详情列表,格式为 List<Map<string, ANY>>,操作记录数上限为 500 条 */
431
+ records: string
432
+ }
433
+
434
+ export interface BatchCreateResponse {
435
+ /** 处理结果 */
436
+ items?: Lark.RecordResult[]
437
+ }
438
+ }
439
+ }
440
+
441
+ export namespace Function {
442
+ export interface Methods {
443
+ /**
444
+ * 执行函数
445
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-function/invoke
446
+ */
447
+ invoke(namespace: string, function_api_name: string, body: InvokeRequest): Promise<InvokeResponse>
448
+ }
449
+
450
+ export interface InvokeRequest {
451
+ /** 函数输入参数(JSON 序列化后的字符串) */
452
+ params?: string
453
+ }
454
+
455
+ export interface InvokeResponse {
456
+ /** 函数执行的返回结果(JSON 序列化后的字符串) */
457
+ result?: string
458
+ }
459
+ }
460
+
461
+ export namespace EnvironmentVariable {
462
+ export interface Methods {
463
+ /**
464
+ * 查询环境变量列表
465
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-environment_variable/query
466
+ */
467
+ query(namespace: string, body: QueryRequest): Promise<QueryResponse>
468
+ /**
469
+ * 查询环境变量详情
470
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-environment_variable/get
471
+ */
472
+ get(namespace: string, environment_variable_api_name: string): Promise<GetResponse>
473
+ }
474
+
475
+ export interface QueryRequest {
476
+ /** 过滤条件 */
477
+ filter?: Lark.EnvironmentVariableFilter
478
+ /** 限制的条数,默认为 500,不可超过 500 */
479
+ limit?: number
480
+ /** 返回记录的偏移量,默认为 0,即从查询到的第一个记录开始返回 */
481
+ offset?: number
482
+ }
483
+
484
+ export interface QueryResponse {
485
+ /** 环境变量列表 */
486
+ items?: Lark.EnvironmentVariable[]
487
+ /** 符合查询条件的环境变量的总数 */
488
+ total: number
489
+ }
490
+
491
+ export interface GetResponse {
492
+ /** 环境变量详情 */
493
+ item?: Lark.EnvironmentVariable
494
+ }
495
+ }
496
+
497
+ export namespace Flow {
498
+ export interface Methods {
499
+ /**
500
+ * 发起流程
501
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-flow/execute
502
+ */
503
+ execute(namespace: string, flow_id: string, body: ExecuteRequest): Promise<ExecuteResponse>
504
+ }
505
+
506
+ export interface ExecuteRequest {
507
+ /** 是否异步执行 */
508
+ is_async?: boolean
509
+ /** 幂等信息 */
510
+ idempotent_key?: string
511
+ /** 循环信息 */
512
+ loop_masks?: string[]
513
+ /** 流程入参 */
514
+ params?: string
515
+ /** 操作人 */
516
+ operator: string
517
+ }
518
+
519
+ export interface ExecuteResponse {
520
+ /** 状态 */
521
+ status?: string
522
+ /** 输出参数 */
523
+ out_params?: string
524
+ /** 执行id */
525
+ execution_id?: string
526
+ /** 错误信息 */
527
+ error_msg?: string
528
+ /** code */
529
+ code?: string
530
+ }
531
+ }
532
+ }
525
533
 
526
- export interface RollbackApaasUserTaskRequest {
527
- /** 操作人kunlunUserID */
528
- operator_user_id: string
529
- /** 退回到的任务ID */
530
- to_task_id: string
531
- /** 退回原因 */
532
- opinion: string
533
- }
534
+ export namespace UserTask {
535
+ export interface Methods {
536
+ /**
537
+ * 查询人工任务
538
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/query
539
+ */
540
+ query(body: QueryRequest): Promise<QueryResponse>
541
+ /**
542
+ * 抄送人工任务
543
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/cc
544
+ */
545
+ cc(task_id: string, body: CcRequest): Promise<void>
546
+ /**
547
+ * 催办人工任务
548
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/expediting
549
+ */
550
+ expediting(task_id: string, body: ExpeditingRequest): Promise<void>
551
+ /**
552
+ * 查询人工任务可退回的位置
553
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/rollback_points
554
+ */
555
+ rollbackPoints(task_id: string, body: RollbackPointsRequest): Promise<RollbackPointsResponse>
556
+ /**
557
+ * 退回人工任务
558
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/rollback
559
+ */
560
+ rollback(task_id: string, body: RollbackRequest): Promise<void>
561
+ /**
562
+ * 基于人工任务发起群聊
563
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/user_task/chat_group
564
+ */
565
+ chatGroup(task_id: string, body: ChatGroupRequest): Promise<ChatGroupResponse>
566
+ }
567
+
568
+ export interface QueryRequest {
569
+ /** 类型 */
570
+ type?: string
571
+ /** 来源 */
572
+ source?: string
573
+ /** 获取条数 */
574
+ limit?: string
575
+ /** 起始位置 */
576
+ offset?: string
577
+ /** 开始时间 */
578
+ start_time?: string
579
+ /** 结束时间 */
580
+ end_time?: string
581
+ /** 流程apiid列表 */
582
+ api_ids?: string[]
583
+ /** kunlunUserID */
584
+ kunlun_user_id: string
585
+ }
586
+
587
+ export interface QueryResponse {
588
+ /** 总任务条数 */
589
+ count?: string
590
+ /** 任务信息 */
591
+ tasks?: Lark.UserTask[]
592
+ }
593
+
594
+ export interface CcRequest {
595
+ /** 抄送人的kunlunID列表 */
596
+ cc_user_ids: string[]
597
+ /** 操作人kunlunUserID */
598
+ operator_user_id: string
599
+ }
600
+
601
+ export interface ExpeditingRequest {
602
+ /** 操作人kunlunUserID */
603
+ operator_user_id: string
604
+ /** 催办人的kunlunID列表 */
605
+ expediting_user_ids: string[]
606
+ /** 催办理由 */
607
+ opinion?: string
608
+ }
609
+
610
+ export interface RollbackPointsRequest {
611
+ /** 操作人kunlunUserID */
612
+ operator_user_id: string
613
+ }
614
+
615
+ export interface RollbackPointsResponse {
616
+ /** 任务列表 */
617
+ tasks?: Lark.AllowedRollbaclkTaskItemType[]
618
+ }
619
+
620
+ export interface RollbackRequest {
621
+ /** 操作人kunlunUserID */
622
+ operator_user_id: string
623
+ /** 退回到的任务ID */
624
+ to_task_id: string
625
+ /** 退回原因 */
626
+ opinion: string
627
+ }
628
+
629
+ export interface ChatGroupRequest {
630
+ /** 操作人kunlunUserID */
631
+ operator_user_id: string
632
+ /** 要邀请进群用户ID列表 */
633
+ invite_user_ids?: string[]
634
+ /** 要拉入的群ID,为空则新建群 */
635
+ chat_id?: string
636
+ /** 要加入的群名称,当chat_id为空时用该名称创建群聊 */
637
+ chat_name?: string
638
+ }
639
+
640
+ export interface ChatGroupResponse {
641
+ /** 创建的群聊ID */
642
+ chat_id?: string
643
+ }
644
+ }
534
645
 
535
- export interface ChatGroupApaasUserTaskRequest {
536
- /** 操作人kunlunUserID */
537
- operator_user_id: string
538
- /** 要邀请进群用户ID列表 */
539
- invite_user_ids?: string[]
540
- /** 要拉入的群ID,为空则新建群 */
541
- chat_id?: string
542
- /** 要加入的群名称,当chat_id为空时用该名称创建群聊 */
543
- chat_name?: string
544
- }
646
+ export namespace ApprovalTask {
647
+ export interface Methods {
648
+ /**
649
+ * 同意人工任务
650
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/agree
651
+ */
652
+ agree(approval_task_id: string, body: AgreeRequest): Promise<void>
653
+ /**
654
+ * 拒绝人工任务
655
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/reject
656
+ */
657
+ reject(approval_task_id: string, body: RejectRequest): Promise<void>
658
+ /**
659
+ * 转交人工任务
660
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/transfer
661
+ */
662
+ transfer(approval_task_id: string, body: TransferRequest): Promise<void>
663
+ /**
664
+ * 人工任务加签
665
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_task/add_assignee
666
+ */
667
+ addAssignee(approval_task_id: string, body: AddAssigneeRequest): Promise<void>
668
+ }
669
+
670
+ export interface AgreeRequest {
671
+ /** 操作人id */
672
+ user_id: string
673
+ /** 审批意见 */
674
+ opinion?: string
675
+ }
676
+
677
+ export interface RejectRequest {
678
+ /** 操作用户id */
679
+ user_id: string
680
+ /** 审批意见 */
681
+ opinion?: string
682
+ }
683
+
684
+ export interface TransferRequest {
685
+ /** 操作人id */
686
+ user_id: string
687
+ /** 原审批人id */
688
+ from_user_ids?: string[]
689
+ /** 新审批人id */
690
+ to_user_ids?: string[]
691
+ /** 审批意见 */
692
+ opinion?: string
693
+ }
694
+
695
+ export interface AddAssigneeRequest {
696
+ /** 操作人id */
697
+ user_id: string
698
+ /** 审批人列表 */
699
+ approvers?: string[]
700
+ /** 加签类型 */
701
+ add_assignee_type?: string
702
+ /** 加签原因 */
703
+ opinion?: string
704
+ }
705
+ }
545
706
 
546
- export interface ChatGroupApaasUserTaskResponse {
547
- /** 创建的群聊ID */
548
- chat_id?: string
707
+ export namespace ApprovalInstance {
708
+ export interface Methods {
709
+ /**
710
+ * 撤销人工任务
711
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/approval_instance/cancel
712
+ */
713
+ cancel(approval_instance_id: string, body: CancelRequest): Promise<void>
714
+ }
715
+
716
+ export interface CancelRequest {
717
+ /** 操作用户id */
718
+ user_id: string
719
+ /** 撤销原因 */
720
+ opinion: string
721
+ }
722
+ }
549
723
  }
550
724
 
551
725
  Internal.define({
726
+ '/apaas/v1/seat_assignments': {
727
+ GET: { name: 'apaas.seatAssignment.list', pagination: { argIndex: 0 } },
728
+ },
729
+ '/apaas/v1/seat_activities': {
730
+ GET: { name: 'apaas.seatActivity.list', pagination: { argIndex: 0 } },
731
+ },
552
732
  '/apaas/v1/applications/{namespace}/audit_log/audit_log_list': {
553
- GET: 'auditLogListApaasApplicationAuditLog',
733
+ GET: 'apaas.application.auditLog.auditLogList',
554
734
  },
555
735
  '/apaas/v1/applications/{namespace}/audit_log': {
556
- GET: 'getApaasApplicationAuditLog',
736
+ GET: 'apaas.application.auditLog.get',
737
+ },
738
+ '/apaas/v1/applications/{namespace}/audit_log/data_change_logs_list': {
739
+ GET: 'apaas.application.auditLog.dataChangeLogsList',
740
+ },
741
+ '/apaas/v1/applications/{namespace}/audit_log/data_change_log_detail': {
742
+ GET: 'apaas.application.auditLog.dataChangeLogDetail',
557
743
  },
558
744
  '/apaas/v1/applications/{namespace}/roles/{role_api_name}/member/batch_remove_authorization': {
559
- POST: 'batchRemoveAuthorizationApaasApplicationRoleMember',
745
+ POST: 'apaas.application.role.member.batchRemoveAuthorization',
560
746
  },
561
747
  '/apaas/v1/applications/{namespace}/roles/{role_api_name}/member/batch_create_authorization': {
562
- POST: 'batchCreateAuthorizationApaasApplicationRoleMember',
748
+ POST: 'apaas.application.role.member.batchCreateAuthorization',
563
749
  },
564
750
  '/apaas/v1/applications/{namespace}/roles/{role_api_name}/member': {
565
- GET: 'getApaasApplicationRoleMember',
751
+ GET: 'apaas.application.role.member.get',
566
752
  },
567
753
  '/apaas/v1/applications/{namespace}/record_permissions/{record_permission_api_name}/member/batch_remove_authorization': {
568
- POST: 'batchRemoveAuthorizationApaasApplicationRecordPermissionMember',
754
+ POST: 'apaas.application.recordPermission.member.batchRemoveAuthorization',
569
755
  },
570
756
  '/apaas/v1/applications/{namespace}/record_permissions/{record_permission_api_name}/member/batch_create_authorization': {
571
- POST: 'batchCreateAuthorizationApaasApplicationRecordPermissionMember',
757
+ POST: 'apaas.application.recordPermission.member.batchCreateAuthorization',
572
758
  },
573
759
  '/apaas/v1/applications/{namespace}/objects/oql_query': {
574
- POST: 'oqlQueryApaasApplicationObject',
760
+ POST: 'apaas.application.object.oqlQuery',
575
761
  },
576
762
  '/apaas/v1/applications/{namespace}/objects/search': {
577
- POST: 'searchApaasApplicationObject',
763
+ POST: 'apaas.application.object.search',
578
764
  },
579
765
  '/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/{id}/query': {
580
- POST: 'queryApaasApplicationObjectRecord',
766
+ POST: 'apaas.application.object.record.query',
581
767
  },
582
768
  '/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/{id}': {
583
- PATCH: 'patchApaasApplicationObjectRecord',
584
- DELETE: 'deleteApaasApplicationObjectRecord',
769
+ PATCH: 'apaas.application.object.record.patch',
770
+ DELETE: 'apaas.application.object.record.delete',
585
771
  },
586
772
  '/apaas/v1/applications/{namespace}/objects/{object_api_name}/records': {
587
- POST: 'createApaasApplicationObjectRecord',
773
+ POST: 'apaas.application.object.record.create',
588
774
  },
589
775
  '/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/batch_update': {
590
- PATCH: 'batchUpdateApaasApplicationObjectRecord',
776
+ PATCH: 'apaas.application.object.record.batchUpdate',
591
777
  },
592
778
  '/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/batch_query': {
593
- POST: 'batchQueryApaasApplicationObjectRecord',
779
+ POST: 'apaas.application.object.record.batchQuery',
594
780
  },
595
781
  '/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/batch_delete': {
596
- DELETE: 'batchDeleteApaasApplicationObjectRecord',
782
+ DELETE: 'apaas.application.object.record.batchDelete',
597
783
  },
598
784
  '/apaas/v1/applications/{namespace}/objects/{object_api_name}/records/batch_create': {
599
- POST: 'batchCreateApaasApplicationObjectRecord',
785
+ POST: 'apaas.application.object.record.batchCreate',
600
786
  },
601
787
  '/apaas/v1/applications/{namespace}/functions/{function_api_name}/invoke': {
602
- POST: 'invokeApaasApplicationFunction',
788
+ POST: 'apaas.application.function.invoke',
603
789
  },
604
790
  '/apaas/v1/applications/{namespace}/environment_variables/query': {
605
- POST: 'queryApaasApplicationEnvironmentVariable',
791
+ POST: 'apaas.application.environmentVariable.query',
606
792
  },
607
793
  '/apaas/v1/applications/{namespace}/environment_variables/{environment_variable_api_name}': {
608
- GET: 'getApaasApplicationEnvironmentVariable',
794
+ GET: 'apaas.application.environmentVariable.get',
609
795
  },
610
796
  '/apaas/v1/applications/{namespace}/flows/{flow_id}/execute': {
611
- POST: 'executeApaasApplicationFlow',
797
+ POST: 'apaas.application.flow.execute',
612
798
  },
613
799
  '/apaas/v1/user_task/query': {
614
- POST: 'queryApaasUserTask',
800
+ POST: 'apaas.userTask.query',
615
801
  },
616
802
  '/apaas/v1/approval_tasks/{approval_task_id}/agree': {
617
- POST: 'agreeApaasApprovalTask',
803
+ POST: 'apaas.approvalTask.agree',
618
804
  },
619
805
  '/apaas/v1/approval_tasks/{approval_task_id}/reject': {
620
- POST: 'rejectApaasApprovalTask',
806
+ POST: 'apaas.approvalTask.reject',
621
807
  },
622
808
  '/apaas/v1/approval_tasks/{approval_task_id}/transfer': {
623
- POST: 'transferApaasApprovalTask',
809
+ POST: 'apaas.approvalTask.transfer',
624
810
  },
625
811
  '/apaas/v1/approval_tasks/{approval_task_id}/add_assignee': {
626
- POST: 'addAssigneeApaasApprovalTask',
812
+ POST: 'apaas.approvalTask.addAssignee',
627
813
  },
628
814
  '/apaas/v1/user_tasks/{task_id}/cc': {
629
- POST: 'ccApaasUserTask',
815
+ POST: 'apaas.userTask.cc',
630
816
  },
631
817
  '/apaas/v1/user_tasks/{task_id}/expediting': {
632
- POST: 'expeditingApaasUserTask',
818
+ POST: 'apaas.userTask.expediting',
633
819
  },
634
820
  '/apaas/v1/approval_instances/{approval_instance_id}/cancel': {
635
- POST: 'cancelApaasApprovalInstance',
821
+ POST: 'apaas.approvalInstance.cancel',
636
822
  },
637
823
  '/apaas/v1/user_tasks/{task_id}/rollback_points': {
638
- POST: 'rollbackPointsApaasUserTask',
824
+ POST: 'apaas.userTask.rollbackPoints',
639
825
  },
640
826
  '/apaas/v1/user_tasks/{task_id}/rollback': {
641
- POST: 'rollbackApaasUserTask',
827
+ POST: 'apaas.userTask.rollback',
642
828
  },
643
829
  '/apaas/v1/user_tasks/{task_id}/chat_group': {
644
- POST: 'chatGroupApaasUserTask',
830
+ POST: 'apaas.userTask.chatGroup',
645
831
  },
646
832
  })