@satorijs/adapter-lark 3.11.7 → 3.11.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.cjs +360 -47
- package/lib/types/aily.d.ts +3 -3
- package/lib/types/apaas.d.ts +38 -28
- package/lib/types/board.d.ts +39 -0
- package/lib/types/calendar.d.ts +55 -0
- package/lib/types/cardkit.d.ts +2 -2
- package/lib/types/compensation.d.ts +400 -0
- package/lib/types/corehr.d.ts +598 -2
- package/lib/types/directory.d.ts +3 -41
- package/lib/types/docx.d.ts +23 -0
- package/lib/types/drive.d.ts +88 -88
- package/lib/types/hire.d.ts +49 -0
- package/lib/types/im.d.ts +1 -1
- package/lib/types/index.d.ts +1008 -40
- package/lib/types/payroll.d.ts +117 -81
- package/lib/types/performance.d.ts +1 -1
- package/lib/types/security_and_compliance.d.ts +254 -1
- package/package.json +1 -1
- package/src/message.ts +11 -1
- package/src/types/aily.ts +3 -3
- package/src/types/apaas.ts +52 -38
- package/src/types/board.ts +53 -2
- package/src/types/calendar.ts +72 -0
- package/src/types/cardkit.ts +2 -2
- package/src/types/compensation.ts +485 -0
- package/src/types/corehr.ts +705 -2
- package/src/types/directory.ts +3 -53
- package/src/types/docx.ts +29 -0
- package/src/types/drive.ts +110 -110
- package/src/types/hire.ts +63 -0
- package/src/types/im.ts +1 -1
- package/src/types/index.ts +1063 -42
- package/src/types/payroll.ts +146 -103
- package/src/types/performance.ts +1 -1
- package/src/types/security_and_compliance.ts +292 -1
package/src/types/apaas.ts
CHANGED
|
@@ -9,6 +9,7 @@ declare module '../internal' {
|
|
|
9
9
|
|
|
10
10
|
export namespace Apaas {
|
|
11
11
|
export interface Methods {
|
|
12
|
+
app: App.Methods
|
|
12
13
|
seatAssignment: SeatAssignment.Methods
|
|
13
14
|
seatActivity: SeatActivity.Methods
|
|
14
15
|
application: Application.Methods
|
|
@@ -17,6 +18,16 @@ export namespace Apaas {
|
|
|
17
18
|
approvalInstance: ApprovalInstance.Methods
|
|
18
19
|
}
|
|
19
20
|
|
|
21
|
+
export namespace App {
|
|
22
|
+
export interface Methods {
|
|
23
|
+
/**
|
|
24
|
+
* 查看应用基本信息
|
|
25
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/app/list
|
|
26
|
+
*/
|
|
27
|
+
list(query?: Pagination): Paginated<Lark.App>
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
|
|
20
31
|
export namespace SeatAssignment {
|
|
21
32
|
export interface Methods {
|
|
22
33
|
/**
|
|
@@ -50,8 +61,8 @@ export namespace Apaas {
|
|
|
50
61
|
export namespace Application {
|
|
51
62
|
export interface Methods {
|
|
52
63
|
auditLog: AuditLog.Methods
|
|
53
|
-
role: Role.Methods
|
|
54
64
|
recordPermission: RecordPermission.Methods
|
|
65
|
+
role: Role.Methods
|
|
55
66
|
object: Object.Methods
|
|
56
67
|
function: Function.Methods
|
|
57
68
|
environmentVariable: EnvironmentVariable.Methods
|
|
@@ -167,6 +178,37 @@ export namespace Apaas {
|
|
|
167
178
|
}
|
|
168
179
|
}
|
|
169
180
|
|
|
181
|
+
export namespace RecordPermission {
|
|
182
|
+
export interface Methods {
|
|
183
|
+
member: Member.Methods
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
export namespace Member {
|
|
187
|
+
export interface Methods {
|
|
188
|
+
/**
|
|
189
|
+
* 批量删除记录权限用户授权
|
|
190
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_remove_authorization
|
|
191
|
+
*/
|
|
192
|
+
batchRemoveAuthorization(namespace: string, record_permission_api_name: string, body: BatchRemoveAuthorizationRequest): Promise<void>
|
|
193
|
+
/**
|
|
194
|
+
* 批量创建记录权限用户授权
|
|
195
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-record_permission-member/batch_create_authorization
|
|
196
|
+
*/
|
|
197
|
+
batchCreateAuthorization(namespace: string, record_permission_api_name: string, body: BatchCreateAuthorizationRequest): Promise<void>
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
export interface BatchRemoveAuthorizationRequest {
|
|
201
|
+
/** 需要删除的用户 ID 列表 */
|
|
202
|
+
user_ids?: string[]
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
export interface BatchCreateAuthorizationRequest {
|
|
206
|
+
/** 需要新增的用户 ID 列表 */
|
|
207
|
+
user_ids?: string[]
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
|
|
170
212
|
export namespace Role {
|
|
171
213
|
export interface Methods {
|
|
172
214
|
member: Member.Methods
|
|
@@ -219,37 +261,6 @@ export namespace Apaas {
|
|
|
219
261
|
}
|
|
220
262
|
}
|
|
221
263
|
|
|
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
264
|
export namespace Object {
|
|
254
265
|
export interface Methods {
|
|
255
266
|
record: Record.Methods
|
|
@@ -723,6 +734,9 @@ export namespace Apaas {
|
|
|
723
734
|
}
|
|
724
735
|
|
|
725
736
|
Internal.define({
|
|
737
|
+
'/apaas/v1/apps': {
|
|
738
|
+
GET: { name: 'apaas.app.list', pagination: { argIndex: 0 } },
|
|
739
|
+
},
|
|
726
740
|
'/apaas/v1/seat_assignments': {
|
|
727
741
|
GET: { name: 'apaas.seatAssignment.list', pagination: { argIndex: 0 } },
|
|
728
742
|
},
|
|
@@ -741,6 +755,12 @@ Internal.define({
|
|
|
741
755
|
'/apaas/v1/applications/{namespace}/audit_log/data_change_log_detail': {
|
|
742
756
|
GET: 'apaas.application.auditLog.dataChangeLogDetail',
|
|
743
757
|
},
|
|
758
|
+
'/apaas/v1/applications/{namespace}/record_permissions/{record_permission_api_name}/member/batch_remove_authorization': {
|
|
759
|
+
POST: 'apaas.application.recordPermission.member.batchRemoveAuthorization',
|
|
760
|
+
},
|
|
761
|
+
'/apaas/v1/applications/{namespace}/record_permissions/{record_permission_api_name}/member/batch_create_authorization': {
|
|
762
|
+
POST: 'apaas.application.recordPermission.member.batchCreateAuthorization',
|
|
763
|
+
},
|
|
744
764
|
'/apaas/v1/applications/{namespace}/roles/{role_api_name}/member/batch_remove_authorization': {
|
|
745
765
|
POST: 'apaas.application.role.member.batchRemoveAuthorization',
|
|
746
766
|
},
|
|
@@ -750,12 +770,6 @@ Internal.define({
|
|
|
750
770
|
'/apaas/v1/applications/{namespace}/roles/{role_api_name}/member': {
|
|
751
771
|
GET: 'apaas.application.role.member.get',
|
|
752
772
|
},
|
|
753
|
-
'/apaas/v1/applications/{namespace}/record_permissions/{record_permission_api_name}/member/batch_remove_authorization': {
|
|
754
|
-
POST: 'apaas.application.recordPermission.member.batchRemoveAuthorization',
|
|
755
|
-
},
|
|
756
|
-
'/apaas/v1/applications/{namespace}/record_permissions/{record_permission_api_name}/member/batch_create_authorization': {
|
|
757
|
-
POST: 'apaas.application.recordPermission.member.batchCreateAuthorization',
|
|
758
|
-
},
|
|
759
773
|
'/apaas/v1/applications/{namespace}/objects/oql_query': {
|
|
760
774
|
POST: 'apaas.application.object.oqlQuery',
|
|
761
775
|
},
|
package/src/types/board.ts
CHANGED
|
@@ -15,6 +15,16 @@ export namespace Board {
|
|
|
15
15
|
export namespace Whiteboard {
|
|
16
16
|
export interface Methods {
|
|
17
17
|
node: Node.Methods
|
|
18
|
+
/**
|
|
19
|
+
* 获取画板主题
|
|
20
|
+
* @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/theme
|
|
21
|
+
*/
|
|
22
|
+
theme(whiteboard_id: string): Promise<ThemeResponse>
|
|
23
|
+
/**
|
|
24
|
+
* 更新画板主题
|
|
25
|
+
* @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/update_theme
|
|
26
|
+
*/
|
|
27
|
+
updateTheme(whiteboard_id: string, body: UpdateThemeRequest): Promise<void>
|
|
18
28
|
/**
|
|
19
29
|
* 获取画板缩略图片
|
|
20
30
|
* @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/download_as_image
|
|
@@ -22,8 +32,23 @@ export namespace Board {
|
|
|
22
32
|
downloadAsImage(whiteboard_id: string): Promise<ArrayBuffer>
|
|
23
33
|
}
|
|
24
34
|
|
|
35
|
+
export interface ThemeResponse {
|
|
36
|
+
/** 主题 */
|
|
37
|
+
theme: 'classic' | 'minimalist_gray' | 'retro' | 'vibrant_color' | 'minimalist_blue' | 'default'
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export interface UpdateThemeRequest {
|
|
41
|
+
/** 主题名称 */
|
|
42
|
+
theme?: string
|
|
43
|
+
}
|
|
44
|
+
|
|
25
45
|
export namespace Node {
|
|
26
46
|
export interface Methods {
|
|
47
|
+
/**
|
|
48
|
+
* 创建节点
|
|
49
|
+
* @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/create
|
|
50
|
+
*/
|
|
51
|
+
create(whiteboard_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
|
|
27
52
|
/**
|
|
28
53
|
* 获取所有节点
|
|
29
54
|
* @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/list
|
|
@@ -31,6 +56,25 @@ export namespace Board {
|
|
|
31
56
|
list(whiteboard_id: string): Promise<ListResponse>
|
|
32
57
|
}
|
|
33
58
|
|
|
59
|
+
export interface CreateRequest {
|
|
60
|
+
/** 子节点数据 */
|
|
61
|
+
nodes?: Lark.WhiteboardNode[]
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export interface CreateQuery {
|
|
65
|
+
/** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作 */
|
|
66
|
+
client_token?: string
|
|
67
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
68
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export interface CreateResponse {
|
|
72
|
+
/** 所创建的节点 id 列表 */
|
|
73
|
+
ids: string[]
|
|
74
|
+
/** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
|
|
75
|
+
client_token?: string
|
|
76
|
+
}
|
|
77
|
+
|
|
34
78
|
export interface ListResponse {
|
|
35
79
|
/** 查询结果 */
|
|
36
80
|
nodes?: Lark.WhiteboardNode[]
|
|
@@ -40,10 +84,17 @@ export namespace Board {
|
|
|
40
84
|
}
|
|
41
85
|
|
|
42
86
|
Internal.define({
|
|
43
|
-
'/board/v1/whiteboards/{whiteboard_id}/
|
|
44
|
-
GET: 'board.whiteboard.
|
|
87
|
+
'/board/v1/whiteboards/{whiteboard_id}/theme': {
|
|
88
|
+
GET: 'board.whiteboard.theme',
|
|
89
|
+
},
|
|
90
|
+
'/board/v1/whiteboards/{whiteboard_id}/update_theme': {
|
|
91
|
+
POST: 'board.whiteboard.updateTheme',
|
|
45
92
|
},
|
|
46
93
|
'/board/v1/whiteboards/{whiteboard_id}/download_as_image': {
|
|
47
94
|
GET: { name: 'board.whiteboard.downloadAsImage', type: 'binary' },
|
|
48
95
|
},
|
|
96
|
+
'/board/v1/whiteboards/{whiteboard_id}/nodes': {
|
|
97
|
+
POST: 'board.whiteboard.node.create',
|
|
98
|
+
GET: 'board.whiteboard.node.list',
|
|
99
|
+
},
|
|
49
100
|
})
|
package/src/types/calendar.ts
CHANGED
|
@@ -30,11 +30,21 @@ export namespace Calendar {
|
|
|
30
30
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary
|
|
31
31
|
*/
|
|
32
32
|
primary(query?: PrimaryQuery): Promise<PrimaryResponse>
|
|
33
|
+
/**
|
|
34
|
+
* 批量获取主日历信息
|
|
35
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primarys
|
|
36
|
+
*/
|
|
37
|
+
primarys(body: PrimarysRequest, query?: PrimarysQuery): Promise<PrimarysResponse>
|
|
33
38
|
/**
|
|
34
39
|
* 查询日历信息
|
|
35
40
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get
|
|
36
41
|
*/
|
|
37
42
|
get(calendar_id: string): Promise<GetResponse>
|
|
43
|
+
/**
|
|
44
|
+
* 批量查询日历信息
|
|
45
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/mget
|
|
46
|
+
*/
|
|
47
|
+
mget(body: MgetRequest): Promise<MgetResponse>
|
|
38
48
|
/**
|
|
39
49
|
* 查询日历列表
|
|
40
50
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list
|
|
@@ -100,6 +110,21 @@ export namespace Calendar {
|
|
|
100
110
|
calendars?: Lark.UserCalendar[]
|
|
101
111
|
}
|
|
102
112
|
|
|
113
|
+
export interface PrimarysRequest {
|
|
114
|
+
/** 用户ID列表 */
|
|
115
|
+
user_ids: string[]
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
export interface PrimarysQuery {
|
|
119
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
120
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
export interface PrimarysResponse {
|
|
124
|
+
/** 主日历列表 */
|
|
125
|
+
calendars?: Lark.UserCalendar[]
|
|
126
|
+
}
|
|
127
|
+
|
|
103
128
|
export interface GetResponse {
|
|
104
129
|
/** 日历OpenId */
|
|
105
130
|
calendar_id: string
|
|
@@ -123,6 +148,16 @@ export namespace Calendar {
|
|
|
123
148
|
role?: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner'
|
|
124
149
|
}
|
|
125
150
|
|
|
151
|
+
export interface MgetRequest {
|
|
152
|
+
/** 日历ID列表 */
|
|
153
|
+
calendar_ids: string[]
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
export interface MgetResponse {
|
|
157
|
+
/** 日历列表 */
|
|
158
|
+
calendars?: Lark.Calendar[]
|
|
159
|
+
}
|
|
160
|
+
|
|
126
161
|
export interface ListQuery extends Pagination {
|
|
127
162
|
/** 上次请求Response返回的增量同步标记,分页请求未结束时为空 */
|
|
128
163
|
sync_token?: string
|
|
@@ -181,6 +216,11 @@ export namespace Calendar {
|
|
|
181
216
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/freebusy/list
|
|
182
217
|
*/
|
|
183
218
|
list(body: ListRequest, query?: ListQuery): Promise<ListResponse>
|
|
219
|
+
/**
|
|
220
|
+
* 批量查询主日历日程忙闲信息
|
|
221
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/freebusy/batch
|
|
222
|
+
*/
|
|
223
|
+
batch(body: BatchRequest, query?: BatchQuery): Promise<BatchResponse>
|
|
184
224
|
}
|
|
185
225
|
|
|
186
226
|
export interface ListRequest {
|
|
@@ -207,6 +247,29 @@ export namespace Calendar {
|
|
|
207
247
|
/** 日历上请求时间区间内的忙闲信息 */
|
|
208
248
|
freebusy_list?: Lark.Freebusy[]
|
|
209
249
|
}
|
|
250
|
+
|
|
251
|
+
export interface BatchRequest {
|
|
252
|
+
/** 获取忙闲信息的开始时间,RFC3339 date_time格式;time_min与time_max的时间区间不能超过3个月。 */
|
|
253
|
+
time_min: string
|
|
254
|
+
/** 获取忙闲信息的开始时间,RFC3339 date_time格式;time_min与time_max的时间区间不能超过3个月。 */
|
|
255
|
+
time_max: string
|
|
256
|
+
/** 用户ID列表 */
|
|
257
|
+
user_ids: string[]
|
|
258
|
+
/** 是否包含绑定的三方日历中的日程,不传默认为true,即包含。 */
|
|
259
|
+
include_external_calendar?: boolean
|
|
260
|
+
/** 是否包含标记为空闲的日程,不传默认为true,即包含空闲日程。 */
|
|
261
|
+
only_busy?: boolean
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
export interface BatchQuery {
|
|
265
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
266
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
export interface BatchResponse {
|
|
270
|
+
/** 用户忙闲信息列表 */
|
|
271
|
+
freebusy_lists?: Lark.UserFreebusy[]
|
|
272
|
+
}
|
|
210
273
|
}
|
|
211
274
|
|
|
212
275
|
export namespace Acl {
|
|
@@ -789,9 +852,18 @@ Internal.define({
|
|
|
789
852
|
'/calendar/v4/calendars/primary': {
|
|
790
853
|
POST: 'calendar.primary',
|
|
791
854
|
},
|
|
855
|
+
'/calendar/v4/calendars/primarys': {
|
|
856
|
+
POST: 'calendar.primarys',
|
|
857
|
+
},
|
|
858
|
+
'/calendar/v4/calendars/mget': {
|
|
859
|
+
POST: 'calendar.mget',
|
|
860
|
+
},
|
|
792
861
|
'/calendar/v4/freebusy/list': {
|
|
793
862
|
POST: 'calendar.freebusy.list',
|
|
794
863
|
},
|
|
864
|
+
'/calendar/v4/freebusy/batch': {
|
|
865
|
+
POST: 'calendar.freebusy.batch',
|
|
866
|
+
},
|
|
795
867
|
'/calendar/v4/calendars/search': {
|
|
796
868
|
POST: { name: 'calendar.search', pagination: { argIndex: 1 } },
|
|
797
869
|
},
|
package/src/types/cardkit.ts
CHANGED
|
@@ -21,12 +21,12 @@ export namespace Cardkit {
|
|
|
21
21
|
*/
|
|
22
22
|
create(body: CreateRequest): Promise<CreateResponse>
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* 更新卡片实体配置
|
|
25
25
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/settings
|
|
26
26
|
*/
|
|
27
27
|
settings(card_id: string, body: SettingsRequest): Promise<void>
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* 局部更新卡片实体
|
|
30
30
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/batch_update
|
|
31
31
|
*/
|
|
32
32
|
batchUpdate(card_id: string, body: BatchUpdateRequest): Promise<void>
|