@satorijs/adapter-lark 3.8.6 → 3.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/bot.d.ts +1 -1
- package/lib/content.d.ts +433 -0
- package/lib/http.d.ts +1 -1
- package/lib/index.cjs +2792 -1719
- package/lib/index.d.ts +4 -2
- package/lib/internal.d.ts +37 -0
- package/lib/message.d.ts +2 -0
- package/lib/types/acs.d.ts +177 -0
- package/lib/types/admin.d.ts +270 -0
- package/lib/types/aily.d.ts +221 -0
- package/lib/types/apaas.d.ts +499 -0
- package/lib/types/application.d.ts +406 -0
- package/lib/types/approval.d.ts +779 -0
- package/lib/types/attendance.d.ts +957 -0
- package/lib/types/auth.d.ts +86 -0
- package/lib/types/authen.d.ts +191 -0
- package/lib/types/baike.d.ts +239 -0
- package/lib/types/bitable.d.ts +691 -0
- package/lib/types/board.d.ts +19 -0
- package/lib/types/calendar.d.ts +653 -0
- package/lib/types/cardkit.d.ts +139 -0
- package/lib/types/compensation.d.ts +54 -0
- package/lib/types/contact.d.ts +1137 -0
- package/lib/types/corehr.d.ts +4391 -0
- package/lib/types/docs.d.ts +23 -0
- package/lib/types/document_ai.d.ts +257 -0
- package/lib/types/docx.d.ts +380 -0
- package/lib/types/drive.d.ts +1053 -0
- package/lib/types/ehr.d.ts +32 -0
- package/lib/types/event.d.ts +9 -18
- package/lib/types/helpdesk.d.ts +746 -0
- package/lib/types/hire.d.ts +3150 -0
- package/lib/types/human_authentication.d.ts +27 -0
- package/lib/types/im.d.ts +1300 -0
- package/lib/types/index.d.ts +16432 -34
- package/lib/types/lingo.d.ts +254 -0
- package/lib/types/mail.d.ts +680 -0
- package/lib/types/mdm.d.ts +42 -0
- package/lib/types/minutes.d.ts +31 -0
- package/lib/types/moments.d.ts +18 -0
- package/lib/types/okr.d.ts +205 -0
- package/lib/types/optical_char_recognition.d.ts +17 -0
- package/lib/types/passport.d.ts +45 -0
- package/lib/types/payroll.d.ts +50 -0
- package/lib/types/performance.d.ts +413 -0
- package/lib/types/personal_settings.d.ts +87 -0
- package/lib/types/report.d.ts +57 -0
- package/lib/types/search.d.ts +216 -0
- package/lib/types/security_and_compliance.d.ts +24 -0
- package/lib/types/sheets.d.ts +326 -0
- package/lib/types/speech_to_text.d.ts +39 -0
- package/lib/types/task.d.ts +1153 -0
- package/lib/types/tenant.d.ts +23 -0
- package/lib/types/translation.d.ts +37 -0
- package/lib/types/vc.d.ts +948 -0
- package/lib/types/verification.d.ts +14 -0
- package/lib/types/wiki.d.ts +240 -0
- package/lib/types/workplace.d.ts +43 -0
- package/lib/utils.d.ts +143 -7
- package/package.json +6 -4
- package/src/bot.ts +19 -3
- package/src/{types/message/content.ts → content.ts} +1 -0
- package/src/http.ts +1 -3
- package/src/index.ts +4 -2
- package/src/internal.ts +143 -0
- package/src/message.ts +13 -11
- package/src/types/acs.ts +236 -0
- package/src/types/admin.ts +328 -0
- package/src/types/aily.ts +288 -0
- package/src/types/apaas.ts +646 -0
- package/src/types/application.ts +520 -0
- package/src/types/approval.ts +924 -0
- package/src/types/attendance.ts +1153 -0
- package/src/types/auth.ts +114 -0
- package/src/types/authen.ts +220 -0
- package/src/types/baike.ts +306 -0
- package/src/types/bitable.ts +879 -0
- package/src/types/board.ts +31 -0
- package/src/types/calendar.ts +817 -0
- package/src/types/cardkit.ts +182 -0
- package/src/types/compensation.ts +79 -0
- package/src/types/contact.ts +1411 -0
- package/src/types/corehr.ts +5297 -0
- package/src/types/docs.ts +33 -0
- package/src/types/document_ai.ts +352 -0
- package/src/types/docx.ts +471 -0
- package/src/types/drive.ts +1321 -0
- package/src/types/ehr.ts +43 -0
- package/src/types/event.ts +15 -21
- package/src/types/helpdesk.ts +925 -0
- package/src/types/hire.ts +3918 -0
- package/src/types/human_authentication.ts +38 -0
- package/src/types/im.ts +1605 -0
- package/src/types/index.ts +17754 -39
- package/src/types/lingo.ts +321 -0
- package/src/types/mail.ts +851 -0
- package/src/types/mdm.ts +57 -0
- package/src/types/minutes.ts +46 -0
- package/src/types/moments.ts +28 -0
- package/src/types/okr.ts +261 -0
- package/src/types/optical_char_recognition.ts +27 -0
- package/src/types/passport.ts +61 -0
- package/src/types/payroll.ts +69 -0
- package/src/types/performance.ts +524 -0
- package/src/types/personal_settings.ts +116 -0
- package/src/types/report.ts +77 -0
- package/src/types/search.ts +268 -0
- package/src/types/security_and_compliance.ts +33 -0
- package/src/types/sheets.ts +425 -0
- package/src/types/speech_to_text.ts +54 -0
- package/src/types/task.ts +1464 -0
- package/src/types/tenant.ts +36 -0
- package/src/types/translation.ts +52 -0
- package/src/types/vc.ts +1197 -0
- package/src/types/verification.ts +23 -0
- package/src/types/wiki.ts +313 -0
- package/src/types/workplace.ts +59 -0
- package/src/utils.ts +160 -8
- package/src/types/api.ts +0 -30848
- package/src/types/internal.ts +0 -84
- package/src/types/message/index.ts +0 -97
package/lib/index.d.ts
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { LarkBot } from './bot';
|
|
2
|
+
import { Internal } from './internal';
|
|
3
|
+
import { EventPayload } from './utils';
|
|
2
4
|
import * as Lark from './types';
|
|
3
5
|
export * from './bot';
|
|
4
6
|
export { Lark, Lark as Feishu };
|
|
5
7
|
export default LarkBot;
|
|
6
8
|
declare module '@satorijs/core' {
|
|
7
9
|
interface Session {
|
|
8
|
-
feishu:
|
|
9
|
-
lark:
|
|
10
|
+
feishu: Internal & EventPayload;
|
|
11
|
+
lark: Internal & EventPayload;
|
|
10
12
|
}
|
|
11
13
|
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { Dict, HTTP } from '@satorijs/core';
|
|
2
|
+
import { LarkBot } from './bot';
|
|
3
|
+
export interface Internal {
|
|
4
|
+
}
|
|
5
|
+
export interface BaseResponse {
|
|
6
|
+
/** error code. would be 0 if success, and non-0 if failed. */
|
|
7
|
+
code: number;
|
|
8
|
+
/** error message. would be 'success' if success. */
|
|
9
|
+
msg: string;
|
|
10
|
+
}
|
|
11
|
+
export type Paginated<T = any, ItemsKey extends string = 'items'> = Promise<{
|
|
12
|
+
[K in ItemsKey]: T[];
|
|
13
|
+
} & {
|
|
14
|
+
page_token?: string;
|
|
15
|
+
has_more: boolean;
|
|
16
|
+
}> & AsyncIterableIterator<T>;
|
|
17
|
+
export interface Pagination {
|
|
18
|
+
page_size?: number;
|
|
19
|
+
page_token?: string;
|
|
20
|
+
}
|
|
21
|
+
export interface InternalRoute {
|
|
22
|
+
name: string;
|
|
23
|
+
pagination?: {
|
|
24
|
+
argIndex: number;
|
|
25
|
+
itemsKey?: string;
|
|
26
|
+
tokenKey?: string;
|
|
27
|
+
};
|
|
28
|
+
multipart?: boolean;
|
|
29
|
+
type?: 'raw-json' | 'binary';
|
|
30
|
+
}
|
|
31
|
+
export declare class Internal {
|
|
32
|
+
private bot;
|
|
33
|
+
constructor(bot: LarkBot);
|
|
34
|
+
private _assertResponse;
|
|
35
|
+
private _buildData;
|
|
36
|
+
static define(routes: Dict<Partial<Record<HTTP.Method, string | InternalRoute>>>): void;
|
|
37
|
+
}
|
package/lib/message.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { Context, h, MessageEncoder } from '@satorijs/core';
|
|
2
2
|
import { LarkBot } from './bot';
|
|
3
|
+
import { EventPayload } from './utils';
|
|
3
4
|
export declare class LarkMessageEncoder<C extends Context = Context> extends MessageEncoder<C, LarkBot<C>> {
|
|
5
|
+
referrer?: EventPayload;
|
|
4
6
|
private quote;
|
|
5
7
|
private textContent;
|
|
6
8
|
private richContent;
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
import { AccessRecord, Device, Feature, Rule, User, UserExternal } from '.';
|
|
2
|
+
import { Pagination } from '../internal';
|
|
3
|
+
declare module '../internal' {
|
|
4
|
+
interface Internal {
|
|
5
|
+
/**
|
|
6
|
+
* 修改用户部分信息
|
|
7
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/patch
|
|
8
|
+
*/
|
|
9
|
+
patchAcsUser(user_id: string, body: PatchAcsUserRequest, query?: PatchAcsUserQuery): Promise<void>;
|
|
10
|
+
/**
|
|
11
|
+
* 获取单个用户信息
|
|
12
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/get
|
|
13
|
+
*/
|
|
14
|
+
getAcsUser(user_id: string, query?: GetAcsUserQuery): Promise<GetAcsUserResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* 获取用户列表
|
|
17
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user/list
|
|
18
|
+
*/
|
|
19
|
+
listAcsUser(query?: ListAcsUserQuery): Paginated<User>;
|
|
20
|
+
/**
|
|
21
|
+
* 上传人脸图片
|
|
22
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/update
|
|
23
|
+
*/
|
|
24
|
+
updateAcsUserFace(user_id: string, form: UpdateAcsUserFaceForm, query?: UpdateAcsUserFaceQuery): Promise<void>;
|
|
25
|
+
/**
|
|
26
|
+
* 下载人脸图片
|
|
27
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/user-face/get
|
|
28
|
+
*/
|
|
29
|
+
getAcsUserFace(user_id: string, query?: GetAcsUserFaceQuery): Promise<ArrayBuffer>;
|
|
30
|
+
/**
|
|
31
|
+
* 设备绑定权限组
|
|
32
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/device_bind
|
|
33
|
+
*/
|
|
34
|
+
deviceBindAcsRuleExternal(body: DeviceBindAcsRuleExternalRequest): Promise<void>;
|
|
35
|
+
/**
|
|
36
|
+
* 获取权限组信息
|
|
37
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/get
|
|
38
|
+
*/
|
|
39
|
+
getAcsRuleExternal(query?: GetAcsRuleExternalQuery): Promise<GetAcsRuleExternalResponse>;
|
|
40
|
+
/**
|
|
41
|
+
* 删除权限组
|
|
42
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/delete
|
|
43
|
+
*/
|
|
44
|
+
deleteAcsRuleExternal(query?: DeleteAcsRuleExternalQuery): Promise<void>;
|
|
45
|
+
/**
|
|
46
|
+
* 创建或更新权限组
|
|
47
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/rule_external/create
|
|
48
|
+
*/
|
|
49
|
+
createAcsRuleExternal(body: CreateAcsRuleExternalRequest, query?: CreateAcsRuleExternalQuery): Promise<CreateAcsRuleExternalResponse>;
|
|
50
|
+
/**
|
|
51
|
+
* 删除访客
|
|
52
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/delete
|
|
53
|
+
*/
|
|
54
|
+
deleteAcsVisitor(visitor_id: string, query?: DeleteAcsVisitorQuery): Promise<void>;
|
|
55
|
+
/**
|
|
56
|
+
* 添加访客
|
|
57
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/visitor/create
|
|
58
|
+
*/
|
|
59
|
+
createAcsVisitor(body: CreateAcsVisitorRequest, query?: CreateAcsVisitorQuery): Promise<CreateAcsVisitorResponse>;
|
|
60
|
+
/**
|
|
61
|
+
* 获取门禁设备列表
|
|
62
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/device/list
|
|
63
|
+
*/
|
|
64
|
+
listAcsDevice(): Promise<ListAcsDeviceResponse>;
|
|
65
|
+
/**
|
|
66
|
+
* 获取门禁记录列表
|
|
67
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record/list
|
|
68
|
+
*/
|
|
69
|
+
listAcsAccessRecord(query?: ListAcsAccessRecordQuery): Paginated<AccessRecord>;
|
|
70
|
+
/**
|
|
71
|
+
* 下载开门时的人脸识别图片
|
|
72
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/acs-v1/access_record-access_photo/get
|
|
73
|
+
*/
|
|
74
|
+
getAcsAccessRecordAccessPhoto(access_record_id: string): Promise<ArrayBuffer>;
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
export interface PatchAcsUserRequest {
|
|
78
|
+
/** 用户特征 */
|
|
79
|
+
feature?: Feature;
|
|
80
|
+
}
|
|
81
|
+
export interface PatchAcsUserQuery {
|
|
82
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
83
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
84
|
+
}
|
|
85
|
+
export interface GetAcsUserQuery {
|
|
86
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
87
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
88
|
+
}
|
|
89
|
+
export interface ListAcsUserQuery extends Pagination {
|
|
90
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
91
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
92
|
+
}
|
|
93
|
+
export interface UpdateAcsUserFaceForm {
|
|
94
|
+
/** 人脸图片内容 */
|
|
95
|
+
files: Blob;
|
|
96
|
+
/** 文件类型,可选的类型有jpg,png */
|
|
97
|
+
file_type: string;
|
|
98
|
+
/** 带后缀的文件名 */
|
|
99
|
+
file_name: string;
|
|
100
|
+
}
|
|
101
|
+
export interface UpdateAcsUserFaceQuery {
|
|
102
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
103
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
104
|
+
}
|
|
105
|
+
export interface GetAcsUserFaceQuery {
|
|
106
|
+
/** 裁剪图 */
|
|
107
|
+
is_cropped?: boolean;
|
|
108
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
109
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
110
|
+
}
|
|
111
|
+
export interface DeviceBindAcsRuleExternalRequest {
|
|
112
|
+
/** 设备id */
|
|
113
|
+
device_id: string;
|
|
114
|
+
/** 权限组id列表 */
|
|
115
|
+
rule_ids: string[];
|
|
116
|
+
}
|
|
117
|
+
export interface GetAcsRuleExternalQuery {
|
|
118
|
+
/** 设备id */
|
|
119
|
+
device_id?: string;
|
|
120
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
121
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
122
|
+
}
|
|
123
|
+
export interface DeleteAcsRuleExternalQuery {
|
|
124
|
+
/** 权限组id */
|
|
125
|
+
rule_id: string;
|
|
126
|
+
}
|
|
127
|
+
export interface CreateAcsRuleExternalRequest {
|
|
128
|
+
/** 权限组信息 */
|
|
129
|
+
rule: Rule;
|
|
130
|
+
}
|
|
131
|
+
export interface CreateAcsRuleExternalQuery {
|
|
132
|
+
/** 权限组id-为空创建,不为空则更新 */
|
|
133
|
+
rule_id?: string;
|
|
134
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
135
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
136
|
+
}
|
|
137
|
+
export interface DeleteAcsVisitorQuery {
|
|
138
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
139
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
140
|
+
}
|
|
141
|
+
export interface CreateAcsVisitorRequest {
|
|
142
|
+
/** 访客信息 */
|
|
143
|
+
user: UserExternal;
|
|
144
|
+
}
|
|
145
|
+
export interface CreateAcsVisitorQuery {
|
|
146
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
147
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
148
|
+
}
|
|
149
|
+
export interface ListAcsAccessRecordQuery extends Pagination {
|
|
150
|
+
/** 记录开始时间,单位秒 */
|
|
151
|
+
from: number;
|
|
152
|
+
/** 记录结束时间,单位秒,时间跨度不能超过30天 */
|
|
153
|
+
to: number;
|
|
154
|
+
/** 门禁设备 ID */
|
|
155
|
+
device_id?: string;
|
|
156
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
157
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
158
|
+
}
|
|
159
|
+
export interface GetAcsUserResponse {
|
|
160
|
+
/** 门禁用户信息 */
|
|
161
|
+
user?: User;
|
|
162
|
+
}
|
|
163
|
+
export interface GetAcsRuleExternalResponse {
|
|
164
|
+
/** 设备权限组信息 */
|
|
165
|
+
rules: Rule[];
|
|
166
|
+
}
|
|
167
|
+
export interface CreateAcsRuleExternalResponse {
|
|
168
|
+
/** 权限组id */
|
|
169
|
+
rule_id: string;
|
|
170
|
+
}
|
|
171
|
+
export interface CreateAcsVisitorResponse {
|
|
172
|
+
/** 访客的id */
|
|
173
|
+
visitor_id: string;
|
|
174
|
+
}
|
|
175
|
+
export interface ListAcsDeviceResponse {
|
|
176
|
+
items?: Device[];
|
|
177
|
+
}
|
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
import { AdminDeptStat, AdminUserStat, AuditInfo, Badge, Grant, I18n, Password, RuleDetail } from '.';
|
|
2
|
+
import { Pagination } from '../internal';
|
|
3
|
+
declare module '../internal' {
|
|
4
|
+
interface Internal {
|
|
5
|
+
/**
|
|
6
|
+
* 重置用户的企业邮箱密码
|
|
7
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/password/reset
|
|
8
|
+
*/
|
|
9
|
+
resetAdminPassword(body: ResetAdminPasswordRequest, query?: ResetAdminPasswordQuery): Promise<void>;
|
|
10
|
+
/**
|
|
11
|
+
* 获取部门维度的用户活跃和功能使用数据
|
|
12
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_dept_stat/list
|
|
13
|
+
*/
|
|
14
|
+
listAdminAdminDeptStat(query?: ListAdminAdminDeptStatQuery): Paginated<AdminDeptStat>;
|
|
15
|
+
/**
|
|
16
|
+
* 获取用户维度的用户活跃和功能使用数据
|
|
17
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list
|
|
18
|
+
*/
|
|
19
|
+
listAdminAdminUserStat(query?: ListAdminAdminUserStatQuery): Paginated<AdminUserStat>;
|
|
20
|
+
/**
|
|
21
|
+
* 创建勋章
|
|
22
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/create
|
|
23
|
+
*/
|
|
24
|
+
createAdminBadge(body: CreateAdminBadgeRequest): Promise<CreateAdminBadgeResponse>;
|
|
25
|
+
/**
|
|
26
|
+
* 修改勋章信息
|
|
27
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/update
|
|
28
|
+
*/
|
|
29
|
+
updateAdminBadge(badge_id: string, body: UpdateAdminBadgeRequest): Promise<UpdateAdminBadgeResponse>;
|
|
30
|
+
/**
|
|
31
|
+
* 上传勋章图片
|
|
32
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge_image/create
|
|
33
|
+
*/
|
|
34
|
+
createAdminBadgeImage(form: CreateAdminBadgeImageForm): Promise<CreateAdminBadgeImageResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* 获取勋章列表
|
|
37
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/list
|
|
38
|
+
*/
|
|
39
|
+
listAdminBadge(query?: ListAdminBadgeQuery): Paginated<Badge, 'badges'>;
|
|
40
|
+
/**
|
|
41
|
+
* 获取勋章详情
|
|
42
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge/get
|
|
43
|
+
*/
|
|
44
|
+
getAdminBadge(badge_id: string): Promise<GetAdminBadgeResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* 创建授予名单
|
|
47
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/create
|
|
48
|
+
*/
|
|
49
|
+
createAdminBadgeGrant(badge_id: string, body: CreateAdminBadgeGrantRequest, query?: CreateAdminBadgeGrantQuery): Promise<CreateAdminBadgeGrantResponse>;
|
|
50
|
+
/**
|
|
51
|
+
* 删除授予名单
|
|
52
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/delete
|
|
53
|
+
*/
|
|
54
|
+
deleteAdminBadgeGrant(badge_id: string, grant_id: string): Promise<void>;
|
|
55
|
+
/**
|
|
56
|
+
* 修改授予名单
|
|
57
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/update
|
|
58
|
+
*/
|
|
59
|
+
updateAdminBadgeGrant(badge_id: string, grant_id: string, body: UpdateAdminBadgeGrantRequest, query?: UpdateAdminBadgeGrantQuery): Promise<UpdateAdminBadgeGrantResponse>;
|
|
60
|
+
/**
|
|
61
|
+
* 获取授予名单列表
|
|
62
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/list
|
|
63
|
+
*/
|
|
64
|
+
listAdminBadgeGrant(badge_id: string, query?: ListAdminBadgeGrantQuery): Paginated<Grant, 'grants'>;
|
|
65
|
+
/**
|
|
66
|
+
* 获取授予名单详情
|
|
67
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/badge-grant/get
|
|
68
|
+
*/
|
|
69
|
+
getAdminBadgeGrant(badge_id: string, grant_id: string, query?: GetAdminBadgeGrantQuery): Promise<GetAdminBadgeGrantResponse>;
|
|
70
|
+
/**
|
|
71
|
+
* 获取行为审计日志数据
|
|
72
|
+
* @see https://open.feishu.cn/document/ukTMukTMukTM/uQjM5YjL0ITO24CNykjN/audit_log/audit_data_get
|
|
73
|
+
*/
|
|
74
|
+
listAdminAuditInfo(query?: ListAdminAuditInfoQuery): Paginated<AuditInfo>;
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
export interface ResetAdminPasswordRequest {
|
|
78
|
+
/** 需要重置的密码参数,不少于8个字符,字母、数字和符号,至少三选二 */
|
|
79
|
+
password: Password;
|
|
80
|
+
/** 待修改密码的用户ID,只针对邮箱登录凭证与企业邮箱(包括别名)相等的用户生效 */
|
|
81
|
+
user_id: string;
|
|
82
|
+
}
|
|
83
|
+
export interface ResetAdminPasswordQuery {
|
|
84
|
+
/** 用户ID类型 */
|
|
85
|
+
user_id_type: 'open_id' | 'union_id' | 'user_id';
|
|
86
|
+
}
|
|
87
|
+
export interface ListAdminAdminDeptStatQuery extends Pagination {
|
|
88
|
+
/** 部门ID类型 */
|
|
89
|
+
department_id_type: 'department_id' | 'open_department_id';
|
|
90
|
+
/** 起始日期(包含),格式是YYYY-mm-dd */
|
|
91
|
+
start_date: string;
|
|
92
|
+
/** 终止日期(包含),格式是YYYY-mm-dd,起止日期之间相差不能超过91天(包含91天) */
|
|
93
|
+
end_date: string;
|
|
94
|
+
/** 部门的 ID,取决于department_id_type,仅支持根部门及其下前4级子部门 */
|
|
95
|
+
department_id: string;
|
|
96
|
+
/** 是否包含子部门,如果该值为false,则只查出本部门直属用户活跃和功能使用数据;如果该值为true,则查出该部门以及其子部门(子部门层级最多不超过根部门下的前4级)的用户活跃和功能使用数据 */
|
|
97
|
+
contains_child_dept: boolean;
|
|
98
|
+
/** 跨域访问的geo */
|
|
99
|
+
target_geo?: string;
|
|
100
|
+
/** 是否返回分产品版本数据 */
|
|
101
|
+
with_product_version?: boolean;
|
|
102
|
+
}
|
|
103
|
+
export interface ListAdminAdminUserStatQuery extends Pagination {
|
|
104
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
105
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
106
|
+
/** 部门ID类型 */
|
|
107
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
108
|
+
/** 起始日期(包含),格式是YYYY-mm-dd */
|
|
109
|
+
start_date: string;
|
|
110
|
+
/** 终止日期(包含),格式是YYYY-mm-dd。起止日期之间相差不能超过31天(包含31天) */
|
|
111
|
+
end_date: string;
|
|
112
|
+
/** 部门的 ID,取决于department_id_type */
|
|
113
|
+
department_id?: string;
|
|
114
|
+
/** 用户的open_id,user_id或者union_id,取决于user_id_type */
|
|
115
|
+
user_id?: string;
|
|
116
|
+
/** 跨域访问的geo */
|
|
117
|
+
target_geo?: string;
|
|
118
|
+
}
|
|
119
|
+
export interface CreateAdminBadgeRequest {
|
|
120
|
+
/** 租户内唯一的勋章名称,最多30个字符。 */
|
|
121
|
+
name: string;
|
|
122
|
+
/** 勋章的描述文案,最多100个字符。 */
|
|
123
|
+
explanation?: string;
|
|
124
|
+
/** 企业勋章的详情图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
|
|
125
|
+
detail_image: string;
|
|
126
|
+
/** 企业勋章的头像挂饰图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
|
|
127
|
+
show_image: string;
|
|
128
|
+
/** 勋章的多语言名称,同name字段限制,最多30个字符。 */
|
|
129
|
+
i18n_name?: I18n;
|
|
130
|
+
/** 勋章的多语言描述文案,同explanation字段限制,最多100个字符。 */
|
|
131
|
+
i18n_explanation?: I18n;
|
|
132
|
+
}
|
|
133
|
+
export interface UpdateAdminBadgeRequest {
|
|
134
|
+
/** 租户内唯一的勋章名称,最多30个字符。 */
|
|
135
|
+
name: string;
|
|
136
|
+
/** 勋章的描述文案,最多100个字符。 */
|
|
137
|
+
explanation?: string;
|
|
138
|
+
/** 企业勋章的详情图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
|
|
139
|
+
detail_image: string;
|
|
140
|
+
/** 企业勋章的头像挂饰图Key。1.权限校验:非本租户上传的图片key,不能直接使用;2.时效校验:创建勋章,或者修改勋章图片key时,需使用1h内上传的图片key。 */
|
|
141
|
+
show_image: string;
|
|
142
|
+
/** 勋章的多语言名称,同name字段限制,最多30个字符。 */
|
|
143
|
+
i18n_name?: I18n;
|
|
144
|
+
/** 勋章的多语言描述文案,同explanation字段限制,最多100个字符。 */
|
|
145
|
+
i18n_explanation?: I18n;
|
|
146
|
+
}
|
|
147
|
+
export interface CreateAdminBadgeImageForm {
|
|
148
|
+
/** 勋章图片的文件,仅支持 PNG 格式,320 x 320 像素,大小不超过 1024 KB。 */
|
|
149
|
+
image_file: Blob;
|
|
150
|
+
/** 图片的类型 */
|
|
151
|
+
image_type: 1 | 2;
|
|
152
|
+
}
|
|
153
|
+
export interface ListAdminBadgeQuery extends Pagination {
|
|
154
|
+
/** 租户内唯一的勋章名称,精确匹配。 */
|
|
155
|
+
name?: string;
|
|
156
|
+
}
|
|
157
|
+
export interface CreateAdminBadgeGrantRequest {
|
|
158
|
+
/** 授予名单名称,最多100个字符。 */
|
|
159
|
+
name: string;
|
|
160
|
+
/** 勋章下唯一的授予事项 */
|
|
161
|
+
grant_type: 0 | 1;
|
|
162
|
+
/** 授予名单的生效时间对应的时区,用于检查RuleDetail的时间戳的取值是否规范,取值范围为TZ database name */
|
|
163
|
+
time_zone: string;
|
|
164
|
+
/** 规则详情 */
|
|
165
|
+
rule_detail: RuleDetail;
|
|
166
|
+
/** 是否授予给全员。1.为false时,需要关联1~500个用户群体。2.为true时,不可关联用户、用户组、部门。 */
|
|
167
|
+
is_grant_all: boolean;
|
|
168
|
+
/** 授予的用户ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
|
|
169
|
+
user_ids?: string[];
|
|
170
|
+
/** 授予的部门ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
|
|
171
|
+
department_ids?: string[];
|
|
172
|
+
/** 授予的用户组ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
|
|
173
|
+
group_ids?: string[];
|
|
174
|
+
}
|
|
175
|
+
export interface CreateAdminBadgeGrantQuery {
|
|
176
|
+
/** 用户 ID 类型 */
|
|
177
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
178
|
+
/** 此次调用中使用的部门ID的类型。 */
|
|
179
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
180
|
+
}
|
|
181
|
+
export interface UpdateAdminBadgeGrantRequest {
|
|
182
|
+
/** 授予名单名称,最多100个字符。 */
|
|
183
|
+
name: string;
|
|
184
|
+
/** 勋章下唯一的授予事项 */
|
|
185
|
+
grant_type: 0 | 1;
|
|
186
|
+
/** 授予名单的生效时间对应的时区,用于检查RuleDetail的时间戳的取值是否规范,取值范围为TZ database name */
|
|
187
|
+
time_zone: string;
|
|
188
|
+
/** 规则详情 */
|
|
189
|
+
rule_detail: RuleDetail;
|
|
190
|
+
/** 是否授予给全员。1.为false时,需要关联1~500个用户群体。2.为true时,不可关联用户、用户组、部门。 */
|
|
191
|
+
is_grant_all: boolean;
|
|
192
|
+
/** 授予的用户ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
|
|
193
|
+
user_ids?: string[];
|
|
194
|
+
/** 授予的部门ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
|
|
195
|
+
department_ids?: string[];
|
|
196
|
+
/** 授予的用户组ID列表,授予名单列表接口返回结果中不返回该字段,只在详情接口返回 */
|
|
197
|
+
group_ids?: string[];
|
|
198
|
+
}
|
|
199
|
+
export interface UpdateAdminBadgeGrantQuery {
|
|
200
|
+
/** 用户 ID 类型 */
|
|
201
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
202
|
+
/** 此次调用中使用的部门ID的类型。 */
|
|
203
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
204
|
+
}
|
|
205
|
+
export interface ListAdminBadgeGrantQuery extends Pagination {
|
|
206
|
+
/** 用户 ID 类型 */
|
|
207
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
208
|
+
/** 此次调用中使用的部门ID的类型。 */
|
|
209
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
210
|
+
/** 授予名单名称,精确匹配。 */
|
|
211
|
+
name?: string;
|
|
212
|
+
}
|
|
213
|
+
export interface GetAdminBadgeGrantQuery {
|
|
214
|
+
/** 用户 ID 类型 */
|
|
215
|
+
user_id_type?: 'open_id' | 'union_id' | 'user_id';
|
|
216
|
+
/** 此次调用中使用的部门ID的类型。 */
|
|
217
|
+
department_id_type?: 'department_id' | 'open_department_id';
|
|
218
|
+
}
|
|
219
|
+
export interface ListAdminAuditInfoQuery extends Pagination {
|
|
220
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
221
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
222
|
+
/** 日志时间范围: 结束时间. 格式: 秒级时间戳. 默认值: 此刻 */
|
|
223
|
+
latest?: number;
|
|
224
|
+
/** 日志时间范围: 起始时间. 格式: 秒级时间戳. 默认值: 30日前此刻 */
|
|
225
|
+
oldest?: number;
|
|
226
|
+
/** 事件名称 */
|
|
227
|
+
event_name?: string;
|
|
228
|
+
/** 过滤操作者: 操作者类型. 与 operator_value 配合使用 */
|
|
229
|
+
operator_type?: 'user' | 'bot';
|
|
230
|
+
/** 过滤操作者: 操作者ID. 与 operator_type 配合使用 */
|
|
231
|
+
operator_value?: string;
|
|
232
|
+
/** 过滤模块 */
|
|
233
|
+
event_module?: number;
|
|
234
|
+
/** 过滤用户类型. 仅当 operator_type=user 时生效 */
|
|
235
|
+
user_type?: 0 | 1 | 2;
|
|
236
|
+
/** 过滤操作对象: 操作对象类型. 与object_value配合使用 */
|
|
237
|
+
object_type?: number;
|
|
238
|
+
/** 过滤操作对象: 操作对象ID. 与object_type配合使用 */
|
|
239
|
+
object_value?: string;
|
|
240
|
+
/** 增强过滤操作对象: 操作对象ID,支持云文档侧泛token过滤。会覆盖object_type和object_value查询条件 */
|
|
241
|
+
ext_filter_object_by_ccm_token?: string;
|
|
242
|
+
}
|
|
243
|
+
export interface CreateAdminBadgeResponse {
|
|
244
|
+
/** 勋章的信息 */
|
|
245
|
+
badge?: Badge;
|
|
246
|
+
}
|
|
247
|
+
export interface UpdateAdminBadgeResponse {
|
|
248
|
+
/** 勋章信息 */
|
|
249
|
+
badge?: Badge;
|
|
250
|
+
}
|
|
251
|
+
export interface CreateAdminBadgeImageResponse {
|
|
252
|
+
/** 图片的key */
|
|
253
|
+
image_key?: string;
|
|
254
|
+
}
|
|
255
|
+
export interface GetAdminBadgeResponse {
|
|
256
|
+
/** 勋章信息 */
|
|
257
|
+
badge?: Badge;
|
|
258
|
+
}
|
|
259
|
+
export interface CreateAdminBadgeGrantResponse {
|
|
260
|
+
/** 授予名单的信息 */
|
|
261
|
+
grant?: Grant;
|
|
262
|
+
}
|
|
263
|
+
export interface UpdateAdminBadgeGrantResponse {
|
|
264
|
+
/** 授予名单 */
|
|
265
|
+
grant?: Grant;
|
|
266
|
+
}
|
|
267
|
+
export interface GetAdminBadgeGrantResponse {
|
|
268
|
+
/** 授予名单信息 */
|
|
269
|
+
grant?: Grant;
|
|
270
|
+
}
|